lastfm

lastfm-node

Read and write to users recent plays on Last.fm.

Installation

npm install lastfm

Usage

var LastFmNode = require('lastfm').LastFmNode;

var lastfm = new LastFmNode({
  api_key: 'apikey',    // sign-up for a key at http://www.last.fm/api
  secret: 'secret',
  useragent: 'appname/vX.X MyApp' // optional. defaults to lastfm-node.
});

Documentation

LastFmRequest

lastfm.request(method, options);

Returns a LastFmRequest instance.

Send request to Last.fm. Requests automatically include the API key and are signed and/or sent via POST as described in the Last.fm API documentation.

Methods:

Accepts any Last.fm API method name, eg "artist.getInfo".

Options:

All options are passed through to Last.fm with the exception of the following.

• write

    Force request to act as a write method. Write methods are signed and sent via POST. Useful for new methods not yet recognised by lastfm-node.
  

• signed

    Force request to be signed. See Last.fm API docs for signature details. Useful for new methods not yet recognised by lastfm-node.
  

• handlers

    Default event handlers to attach to the request object on creation.
  

Events:

• success(json)

    JSON response from Last.fm
  

• error(error)

    Ruh-roh. Either a error returned by Last.fm or a transmission error.
  

RecentTracksStream

lastfm.stream(username);

Returns: a RecentTracksStream instance

Methods:

• start()

    Start streaming recent track info.
  

• stop()

    Stop streaming recent track info.
  

• isStreaming()

    Boolean. True is nowplaying/recent track data is being actively fetched.
  

• on(event, listener)

    Adds a listener for the specified event.
  

• removeListener(event, listener)

    Removes the listener for the specified event.
  

Options:

• autostart

    Start streaming automatically. Defaults to false.
  

• handlers

    Default event handlers to attach to the request object on creation.
  

• lastPlayed, nowPlaying, scrobbled, stoppedPlaying, error

    **Deprecated:** Event listeners.
  

Events:

• lastPlayed(track)

    The user's last scrobbled track.
  

• nowPlaying(track)

    Track the user is currently listening to.
  

• scrobbled(track)

    Now playing track has been scrobbled.
  

• stoppedPlaying(track)

    User stopped listening to current track.
  

• error(error)

    Ruh-roh.
  

LastFmSession

lastfm.session([user], [key]);

Returns: a LastFmSession instance.

If no key is supplied then the authorise() method must be used before the session can be used to make authenticated calls. See the last.fm API documentation for more info.

Public properties:

• user

    The username of the Last.fm user associated with the session.
  

• key

    The session key. Either passed in or generated using authorise().
  

Methods:

• authorise(token, [options])

    Authorises user with Last.fm api. See last.fm documentation. Options argument has handlers property that has default event handlers to attach to the LastFmSession instance.
  

• on(event, handler)

    Adds a listener for the specified event.
  

• removeListener(event, handler)

    Removes the listener for the specified event.
  

• isAuthorised()

    Returns true if the session has been authorised or a key was specified in the constructor.
  

Events:

• authorised(session)

    Authorisation of session was successful.
    Note: Only emitted after a call to authorise(). Keys supplied in the constructor are assumed to be valid.
  

• error(track, error)

    Ruh-roh.
  

LastFmUpdate

lastfm.update(method, session, options);

Returns a LastFmUpdate instance.

Valid methods are 'nowplaying' and 'scrobble'.

An authorised LastFmSession instance is required to make a successful update.

Options:

Accepts all parameters used by track.updateNowPlaying and user.scrobble (see Last.Fm API) as well as:

• track

    Track for nowplaying and scrobble requests. Uses same format as returned by `RecentTracksStream` events.
  

• timestamp

    Required for scrobble requests. Timestamp is in unix time (seconds since 01-01-1970 and is in UTC time).
  

• handlers

    Default event handlers to attach to the request object on creation.
  

• success

    **Deprecated:** Listener for `success` event.
  

• error

    **Deprecated:** Listener for `error` event.
  

Events:

• success(track)

   Update request was successful. 
  

• error(track, error)

    Ruh-roh.
  

LastFmInfo

lastfm.info(itemtype, [options]);

Returns: a LastFmInfo instance.

Gets extended info about specified item.

Public properties:

• itemtype

    Any Last.fm item with a getInfo method. eg user, track, artist, etc.
  

Options:

• handlers

    Event handlers to attach to object at creation.
  

• various

   Params as specified in Last.fm API, eg user: "username"
  

• success

   **Deprecated:** Listener for `success` event.
  

• error

   **Deprecated:** Listener for `error` event.
  

Special cases:

When requesting track info the track param can be either the track name or a track object as returned by RecentTracksStream.

Example

var LastFmNode = require('lastfm').LastFmNode;

var lastfm = new LastFmNode({
  api_key: 'abc',
  secret: 'secret'
});

var trackStream = lastfm.stream('username');

trackStream.on('lastPlayed', function(track) {
  console.log('Last played: ' + track.name);
});

trackStream.on('nowPlaying', function(track) {
  console.log('Now playing: ' + track.name);
});

trackStream.on('scrobbled', function(track) {
  console.log('Scrobbled: ' + track.name);
});

trackStream.on('stoppedPlaying', function(track) {
  console.log('Stopped playing: ' + track.name);
});

trackStream.on('error', function(error) {
  console.log('Error: '  + error.message);
});

trackStream.start();

var session = lastfm.session();
session.authorise(token, {
   handlers: {
      authorised: function(session) {
         lastfm.update('nowplaying', session, { track: track } );
         lastfm.update('scrobble', session, { track: track, timestamp: 12345678 });
      }
   }
});

var request = lastfm.request("artist.getInfo", {
    artist: "The Mae Shi",
    handlers: {
        success: function(data) {
            console.log("Success: " + data);
        },
        error: function(error) {
            console.log("Error: " + error.message);
        }
    }
});

Influences

Heavily drawn from technoweenie's twitter-node
http://github.com/technoweenie/twitter-node

Changelog

0.7.0

Breaking changes

• The success event on lastfm.request now emits parsed JSON rather than raw text.
• RecentTracksStream.isStreaming has been removed in favour of RecentTracksStream.isStreaming().