Ricardo SIGNES > Net-Delicious-1.14 > Net::Delicious::Config

Download:
Net-Delicious-1.14.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Module Version: 1.14   Source  

NAME ^

Net::Delicious::Config - config handler for Net::Delicious.

SYNOPSIS

Config handler for Net::Delicious.

DESCRIPTION ^

Internally, Net::Delicious uses an "ini" style Config::Simple object to keep track of its various settings. These include user credentials, endpoints as well as API request and response parameters.

While there is no expectation that a user will ever need to change anything than their basic login information, it is possible to override any of the default configuration options. If, you know, you're in to that kind of thing.

The only caveat is that in order to override default configuaration for request and response properties you will need to pass the Net::Delicious object constructor a Config::Simple object or the path to a valid "ini" style config file. (Arguments passed to the constructor as a hash reference are assumed to be part of the default delicious configs.)

It is important to remember that these config options, and definitions, are not meant to be a complete web services description nor do they play one on TV. They are some bare-bones glue to allow users the ability to define their own settings in the event that this package falls out of sync with the API or they've dreampt up some wacky project that uses Net::Delicious.

DEFAULT CONFIGS ^

These are outlined in the POD for the Net::Delicious object constructor. They are basically anything define in the [delicious] block.

Default API response configs are defined in Net::Delicious::Constants::Config::DELICIOUS_CFG_STD.

API CALL CONFIGS ^

API call configs are the set of allowable parameters that may be sent to del.icio.us with a given method call along with flags to indicate whether an argument is required or needs some special magic DWIM munging.

The basic syntax for block names is the string delicious, the lower-case name of the API class (posts, user, etc.) followed by the lower-case name of the method all joined by underbars.

The basic syntax for block arguments is the name of the API parameter followed by a single string containing multiple options separated by semi-colons. As of this writing, there aren't very many options. The first is the string required if (drumroll) the parameter is required. The only other recognized option is the string no which will tell the argument parser to DWIM if the user passes boolean true or false.

For example :

 [delicious_posts_add]
 url="required"
 description=""
 extended=""
 tags=""
 dt=""
 shared=";no"
 replace=";no"

If a method class is nested, the syntax requires that all / strings be replaced by underbars. For example tags/bundles/set is defined as :

 [delicious_tags_bundles_set]
 bundle="required"
 tags="required"

Default API response configs are defined in Net::Delicious::Constants::Config::DELICIOUS_CFG_API.

API RESPONSE CONFIGS ^

API response configs define the properties that are expected to be returned in a given method call and mapped to object methods.

As of this writings, all properites are defined in the delicious_properties block.

The basic syntax for block arguments is the lower-case name of the Net::Delicious object class followed by a comma-separated list of properties/methods. Unless already defined in their parent package, "get" methods for each property will be automagically created.

 [delicious_properties]
 date="tag,date,count,user"
 post="description,extended,href,time,parent,tag,others,shared"
 bundle="name,tag"
 user="name"
 subscriptions="user,tag"
 tag="tag,count"

Default API response configs are defined in Net::Delicious::Constants::Config::DELICIOUS_CFG_PROPERTIES.

VERSION ^

1.13

DATE ^

$Date: 2008/03/03 16:55:04 $

AUTHOR ^

Aaron Straup Cope <ascope@cpan.org>

LICENSE ^

Copyright (c) 2004-2008 Aaron Straup Cope. All rights reserved.

This is free software, you may use it and distribute it under the same terms as Perl itself.

syntax highlighting: