exfm

Flexible redirection plugin

npm install exfm
10 downloads in the last week
20 downloads in the last month

exfm for Node.js

exfm logo belongs to exfm. Node.js logo belongs to Node.js. This project is not an official exfm project and is not affliated with.

Connect to the ex.fm API, get information and stream music!

exfm.user("silvinci").loved(cb);
exfm.song("8ugg").pipe(fs.createWriteStream("never.mp3"));
exfm.song.search("Never Gonna Give You Up");

Installation

$ npm install exfm

Usage

The exfm API makes use of chaining. Who doesn't like chaining?

exfm.user(username, cb)

Get a user's profile information.

exfm.user("dan", function(err, user) {
  if(err) throw err;
  console.log(user.name); // "Dan Kantor"
});

exfm.user(username).loved(cb)

Get a user's loved songs.

exfm.user("dan").loved(function(err, songs) {
  if(err) throw err;
  console.log(songs); // [{ title: "Golden Light", ... }, ...]
});

exfm.user(username).followers(cb)

Get a user's followers.

exfm.user("dan").followers(function(err, users) {
  if(err) throw err;
  console.log(users); // [{ username: "silvinci", ... }, ...]
});

exfm.user(username).following(cb)

Get users a user is following.

exfm.user("dan").following(function(err, users) {
  if(err) throw err;
  console.log(users); // [{ username: "majman" ... }, ...]
});

exfm.user(username).followingIds(cb)

Get the IDs of the users the user is following.

exfm.user("dan").followingIds(function(err, ids) {
  if(err) throw err;
  console.log(ids); // ["majman", "chase", ...]
});

exfm.user(username).followingSites(cb)

Get sites the user is following.

exfm.user("dan").followingIds(function(err, sites) {
  if(err) throw err;
  console.log(sites); // [{ name: "Black Light Dinner Party" }, ...]
});

exfm.user(username).loveFeed(cb)

Get a feed of songs loved by users the user is following.

exfm.user("dan").loveFeed(function(err, songs) {
  if(err) throw err;
  console.log(songs); // [{ object: { title: "Where's The Time", ... }, ... }, ...]
});

exfm.user(username).activiy(cb)

Get a feed of a user's activity, including loved songs, shared songs, and followed users.

exfm.user("dan").activity(function(err, activities) {
  if(err) throw err;
  console.log(activities); // [{ object: { title: "Where's The Time", ... }, ... }, ...]
});

exfm.user(username).activityLove(cb)

Get a feed of a user's loved songs.

exfm.user("dan").activityLove(function(err, loves) {
  if(err) throw err;
  console.log(loves); // [{ object: { title: "Where's The Time", ... }, ... }, ...]
});

exfm.user(username).notifications(cb)

Get a feed of actions being perfomed on the user, such as loving of songs the user has loved (AKA relove) and following the user-

exfm.user("dan").notifications(function(err, msgs) {
  if(err) throw err;
  console.log(msgs); // [...]
});

Contributors

License

(The MIT License)

Copyright (c) 2013 Jan Buschtöns buschtoens@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you