Net::FluidDB - A Perl interface to FluidDB
use Net::FluidDB; # Predefined FluidDB client for playing around, points # to the sandbox with user test/test $fdb = Net::FluidDB->new_for_testing; $fdb = Net::FluidDB->new_for_testing(trace_http => 1); # FluidDB client pointing to production $fdb = Net::FluidDB->new(username => 'username', password => 'password'); # FluidDB taking credentials from environment variables # FLUIDDB_USERNAME and FLUIDDB_PASSWORD $fdb = Net::FluidDB->new; # Content-MD5 headers with checksums for requests with payload $fdb = Net::FluidDB->new(md5 => 1) # Resource getters $object = $fdb->get_object_by_id($id, about => 1); $object = $fdb->get_object_by_about($about); $ns = $fdb->get_namespace($path, description => 1); $tag = $fdb->get_tag($path, description => 1); $policy = $fdb->get_policy($user, $category, $action); $permission = $fdb->get_permission($category, $path, $action); $user = $fdb->get_user($username); # Object search @ids = $fdb->search("has fxn/rating");
Net::FluidDB provides an interface to the FluidDB API.
Net::FluidDB
The documentation of Net::FluidDB does not explain FluidDB, though there are links to relevant pages in the documentation of each class.
If you want to get familiar with FluidDB please check these pages:
http://doc.fluidinfo.com/fluidDB/
http://doc.fluidinfo.com/fluidDB/api/
http://api.fluidinfo.com/fluidDB/api/*/*/*
http://blogs.fluidinfo.com/fluidDB/category/essence/
Returns an object for communicating with FluidDB.
This is a wrapper around LWP::UserAgent and does not validate credentials in the very constructor. If they are wrong requests will fail when performed.
Attributes and options are:
Your username in FluidDB. If not present uses the value of the environment variable FLUIDDB_USERNAME.
Your password in FluidDB. If not present uses the value of the environment variable FLUIDDB_PASSWORD.
Either 'HTTP' or 'HTTPS'. Defaults to 'HTTP'.
The FluidDB host. Defaults to fluiddb.fluidinfo.com.
If this flag is true requests with payload get a Content-MD5 header with a checksum.
A flag, logs all HTTP requests if true.
A flag, logs all HTTP responses if true.
A flag, logs all HTTP requests and responses if true. (Shorthand for enabling the two above.)
Returns a Net::FluidDB instance pointing to the sandbox with "test"/"test". The host of the sandbox can be checked in the package variable $Net::FluidDB::SANDBOX_HOST.
$Net::FluidDB::SANDBOX_HOST
Gets/sets the username.
Gets/sets the password.
Gets/sets the protocol, either 'HTTP' or 'HTTPS'.
Returns the instance of LWP::UserAgent used to communicate with FluidDB.
Returns the user on behalf of whom fdb is doing calls. This attribute is lazy loaded.
Convenience shortcut for Net::FluidDB::Object::get_by_id, see Net::FluidDB::Object.
Net::FluidDB::Object::get_by_id
Convenience shortcut for Net::FluidDB::Object::get_by_about, see Net::FluidDB::Object.
Net::FluidDB::Object::get_by_about
Convenience shortcut for Net::FluidDB::Object::search, see Net::FluidDB::Object.
Net::FluidDB::Object::search
Convenience shortcut for Net::FluidDB::Namespace::get, see Net::FluidDB::Namespace.
Net::FluidDB::Namespace::get
Convenience shortcut for Net::FluidDB::Tag::get, see Net::FluidDB::Tag.
Net::FluidDB::Tag::get
Convenience shortcut for Net::FluidDB::Policy::get, see Net::FluidDB::Policy.
Net::FluidDB::Policy::get
Convenience shortcut for Net::FluidDB::Permission::get, see Net::FluidDB::Permission.
Net::FluidDB::Permission::get
Convenience shortcut for Net::FluidDB::User::get, see Net::FluidDB::User.
Net::FluidDB::User::get
Xavier Noria (FXN), <fxn@cpan.org>
Copyright (C) 2009-2011 Xavier Noria
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
1 POD Error
The following errors were encountered while parsing the POD:
You forgot a '=back' before '=head1'
To install Net::FluidDB, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::FluidDB
CPAN shell
perl -MCPAN -e shell install Net::FluidDB
For more information on module installation, please visit the detailed CPAN module installation guide.