nodedelicious
v0.0.2
Published
Library to access Delicious API
Downloads
2
Readme
Node Delicious
Library to access Delicious API.
Installation
Via npm on Node:
npm install nodedelicious
Usage
Reference in your program:
var nodedelicious = require('nodedelicious');
Authentication
The library uses these environment variables:
- DELICIOUS_USER
- DELICIOUS_PASSWORD
You must set them with the values of your Delicious account.
Date Formats
The date format is YYYY-MM-DD
. You can specify a datestamp using the format YYYY-MM-DDTHH:MM:SSZ
.
Requires a LITERAL �T� and �Z� like in ISO8601 at
http://www.cl.cam.ac.uk/~mgk25/iso�time.html for Example: "1984�09�01T14:21:31Z".
If you specify a from date, no datestamp, it will expanded to YYYY-MM-DDT00:00:00Z
. A to date will
be expanded to YYYY-MM-DDT23:59:59Z
.
The library validates dates, before sending a request to the API endpoints.
Get All Posts
nodedelicious.getAllPosts(tag, options, function (err, data) { ... } );
tag
is a string.
NOTE: if you specify a tag, only the posts with that tag in FIRST POSITION are returned. So, maybe you prefere to retrieve all items and them, search your tag in the returned result. See Get All Posts sample.
options
is an optional object with properties:
fromDate
: date or datestamptoDate
: date or datestampstart
: count of links to be skippedresults
: max count of links to be retrieved
The data returned is the XML returned by Delicious API but converted to a JavaScript object using xml2js conventions.
Development
git clone git://github.com/ajlopez/NodeDelicious.git
cd NodeDelicious
npm install
npm test
The tests are written using Delicious data I have in my account. My account is not specified, but maybe some tests will fail because the expected data was not found.
Samples
- Get All Posts: Get all posts of a tag or list of tags, with optional date range.
References
API
The library uses v1 Delicious API described at Developing for Delicious.
Inception
After the second big rewrite of Delicious site (January 2013, second week), I found that the pagination of my links were thrown away. I used Delicious not as a feed, but as an archive and reference, so it's important to me to have easy access to old tagged items. Apparently, the only way to have date range is using API v1: Delicious feeds doesn't have filter by date range, AFAIK.
To do
TBD ;-)
Versions
0.0.1: Published, 2013-01-13, with getAllPost. 0.0.2: Published, 2015-04-04. Added: getRecent, getDates, getTags. Fix API entry point.
Contribution
Feel free to file issues and submit pull requests � contributions are welcome.
If you submit a pull request, please be sure to add or update corresponding
test cases, and ensure that npm test
continues to pass.