{"_id":"node-directededge","_rev":"5-41ef323a1e50371e3672d136c552b456","name":"node-directededge","description":"A DirectedEdge Node.js Client","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"node-directededge","description":"A DirectedEdge Node.js Client","keywords":["directededge","recommendations"],"version":"0.1.0","homepage":"https://github.com/JoshSmith/node-directededge","author":{"name":"Josh Smith","email":"joshdotsmith@gmail.com"},"contributors":[{"name":"Josh Smith","email":"joshdotsmith@gmail.com"}],"dependencies":{"xmlbuilder":">= 0.2.0","xml2js":">= 0.1.12","request":">= 2.2.5"},"main":"lib/directededge.js","directories":{"lib":"lib"},"repository":{"type":"git","url":"git://github.com/JoshSmith/node-directededge.git"},"engines":{"node":">=0.4.0"},"_npmUser":{"name":"joshsmith","email":"joshdotsmith@gmail.com"},"_id":"node-directededge@0.1.0","devDependencies":{},"_engineSupported":true,"_npmVersion":"1.0.106","_nodeVersion":"v0.4.11","_defaultsLoaded":true,"dist":{"shasum":"240e2fdefc40b49e885babe08508dd1b1973a03d","tarball":"https://registry.npmjs.org/node-directededge/-/node-directededge-0.1.0.tgz","integrity":"sha512-9XttbI45qAeTK68g7t/CEqYQSItqSwwbsJPQABdbO+Uf1+msKr0jEFVrf1T1Z70dgzUYyGAXctDa1aB2nFrNVQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDK1pZVGXUpn4rGzDMj56IZ5nFAa/1Ud02nX3zliPlYDAiEA6njXrvz56G3MmBNCUs3EtaaOEAO3nDp09DTExVxwwxw="}]},"maintainers":[{"name":"joshsmith","email":"joshdotsmith@gmail.com"}]}},"readme":"# node-directededge\n\nA client implementation of Directed Edge's REST API in Node.js. \n\n## What is Directed Edge?\nDirected Edge (http://directededge.com) helps you find related stuff.\n\nIt's a recommendations engine that plugs into your site to deliver Amazon-like recommendations. You can show your users personalized recommendations and similar content or products based on data you're already collecting.\n\n## Installation\n\n### Installing node-directededge\n``` bash\n  $ npm install node-directedge\n```\n\n## Examples\n\n### Example 1\n\n#### Get 5 new recommended interests for a user\n\n``` javascript\n  var de = new DirectedEdge('username', 'password');\n\n  var params = {\n  \texcludeLinked: true,\n  \tmaxResults: 5,\n  \ttags: 'interest'\n  }\n\n  de.getRecommended('user1', params, function(err, data, res) {\n  \tconsole.log(data);\n  });\n\n  // Outputs:\n  // {\"@\":{\"version\":\"0.1\"},\"item\":{\"@\":{\"id\":\"user1\"},\"count\":\"5\",\n  // \"recommended\":[\"interest2014\",\"interest2098\",\"interest1989\",\"interest1932\",\"interest1977\"]}}\n```\n\n### Example 2\n\n#### Update an item\n\n``` javascript\n  var de = new DirectedEdge('username', 'password');\n\n  // Params for puts are object literals with arrays, and\n  // in the case of weighted_links, nested arrays\n  var params = {\n    links: ['interest1', 'interest2'], // Creates links\n    weighted_links: [ ['interest3', 10], ['interest4', 0] ], // Creates links with weights\n  \ttags: ['user'] // Creates tags\n  }\n\n  de.putItem('user1', 'add', params, function(err, data, res) {\n  \t// Updates the item\n  });\n```\n\n### Example 3\n\n#### Remove from an item\n\n``` javascript\n  var de = new DirectedEdge('username', 'password');\n\n  // We'll remove the links and tags created in Example 2\n  var params = {\n    links: ['interest1', 'interest2'], // Creates links\n    weighted_links: [ ['interest3', 10], ['interest4', 0] ], // Creates links with weights\n  \ttags: ['user'] // Creates tags\n  }\n\n  de.putItem('user1', 'remove', params, function(err, data, res) {\n  \t// Removes from the item\n  });\n```\n\n### Example 4\n\n#### Overwrite an item\n\n``` javascript\n  var de = new DirectedEdge('username', 'password');\n\n  // We'll remove the links and tags created in Example 2\n  var params = {\n    links: ['interest5', 'interest6'] // Creates links\n  }\n\n  de.putItem('user1', 'overwrite', params, function(err, data, res) {\n  \t// Overwrites the item by passing in the overwrite method\n  });\n```\n\n### Example 5\n\n#### Delete a resource\n``` javascript\n  var de = new DirectedEdge('username', 'password');\n\n  de.deleteItem('user1', function(err, data, res) {\n    // This deletes user1 from DE\n  });\n```","maintainers":[{"name":"joshsmith","email":"joshdotsmith@gmail.com"}],"time":{"modified":"2022-06-21T13:43:52.340Z","created":"2011-11-28T17:44:28.260Z","0.1.0":"2011-11-28T17:44:28.938Z"},"author":{"name":"Josh Smith","email":"joshdotsmith@gmail.com"},"repository":{"type":"git","url":"git://github.com/JoshSmith/node-directededge.git"}}