Beads Land > WWW-Simpy-1.015 > WWW::Simpy

Download:
WWW-Simpy-1.015.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.015   Source  

NAME ^

WWW::Simpy - Perl interface to Simpy social bookmarking service

SYNOPSIS ^

  use Simpy;

  my $sim = new Simpy;

  my $cred = { user => "demo", pass => "demo" };

  my $opts = { limit => 10 }; 
  my $tags = $sim->GetTags($cred, $opts) || die $sim->status;

  foreach my $k (keys %{$tags}) {
    print "tag $k has a count of " . $tags->{$k} . "\n";
  }

  my $opts = { limit => 10, q = "search" };
  my $links = $sim->GetTags($cred, $opts) || die $sim->status;

  foreach my $k (keys %{$links}) {
    print "url $k was added " . $links->{$k}->{addDate} . "\n";
  }

  my $opts = { fromTag => 'rose', toTag => 'another name' };
  $sim->RenameTag($cred, $opts) || die $sim->status;

  print $sim->message . "\n";

DESCRIPTION ^

This module provides a Perl interface to the Simpy social bookmarking service. See http://www.simpy.com/simpy/service/api/rest/

THIS IS AN ALPHA RELEASE. This module should not be relied on for any purpose, beyond serving as an indication that a reliable version will be forthcoming at some point the future.

This module is being developed as part of the "mesh pooling" component ofthe Transpartisan Meshworks project ( http://www.transpartisanmeshworks.org ). The mesh pool will integrate social bookmarking and collaborative content development in a single application.

EXPORT

accessorType

The accessorType property of a link may be PUBLIC or PRIVATE.

code

The Simpy status code may be any of the following constants.

   # SUCCESS                    - Success
   # PARAMETER_MISSING          - Required parameter missing
   # NONEXISTENT_ENTITY         - Non-existent entity
   # TRANSIENT_ERROR            - Transient data retrieval error
   # STORAGE_ERROR              - Entity storage error
   # QUOTA_REACHED              - Storage quota exceeded

METHODS ^

Constructor Method

Simpy object constructor method.

  my $s = new Simpy;

Accessor Methods

Return status information from API method calls.

status

Return the HTTP status of the last call to the Simpy REST server, or syntax errors from the XML::Parser module, if any, or error from Simpy REST API, if any.

message

Return the message string, if any, returned by the last Simpy REST method.

code

Return the Simpy error code, if any, returned by the last Simpy REST method.

REST API Methods

See http://www.simpy.com/simpy/service/api/rest/ for more information about required and optional parameters for these methods.

GetTags

Returns a hash reference of tag/count pairs.

   my $tags = $s->GetTags($cred, $opts);
   print "The tag 'dolphin' has a count of " . $tags->{dolphin};

RemoveTag

Removes a tag via the Simpy API. Returns a true result if successful.

RenameTag

Renames a tag via the Simpy API. Returns a true result if successful.

RenameTag

Merges two tags via the Simpy API. Returns a true result if successful.

SplitTag

Splits a tag via the Simpy API. Returns a true result if successful.

GetLinks

Returns an hash reference of links, keyed by url. Each link is in turn a hash reference of link properties, keyed by property name. The value of the 'tags' property keys is an array reference of tags. All other properties tag a scalar value.

The exported constants PUBLIC and PRIVATE can be used to check the value of the accessType property.

SaveLink

Saves a link via the Simpy API. Returns a true result if successful.

CAVEATS ^

This is an early alpha release. Not all methods of the API are implemented, nor have the sub-modules defining data types for those API methods been developed.

SEE ALSO ^

http://simpytools.sourceforge.net

http://www.transpartisanmeshworks.org

AUTHOR ^

Beads Land, beads@beadsland.com

COPYRIGHT AND LICENSE ^

Copyright (C) 2006 by Beads Land

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.6.1 or, at your option, any later version of Perl you may have available.

syntax highlighting: