bandcamp

Library for rocking out with Bandcamp's API

npm install bandcamp
11 downloads in the last week
22 downloads in the last month

Bandcamp Library for Node.js

A simple library to easily interact with the Bandcamp API.

Bandcamp is an awesome platform for musicians, both physically large and small. You could be, like, tiny... or HUGE. It doesn't matter how big you are as long as you can use a computer. Just visit Bandcamp to setup your account and start selling music to your fans. It also does not discriminate against large or small fans, you just need a computer to listen to and buy music from Bandcamp. If you're a nerd, you can get uncompressed formats. The musician gets a large cut.

Installation

npm install bandcamp

Usage

View test/test.js for examples for every method.

var key = 'yourbandcampAPIkey', // contact <support@bandcamp.com> to request one
    bandcamp = require('bandcamp')(key),
    i = require('util').inspect;

bandcamp.band.search('the internet', function(err, result, status) {
    console.log(i(result));
});

Most of the methods use the pattern: module.method('search parameter', callback, optVersionOverride)

See Bandcamp API Documentation for details on all the calls and view test/test.js for examples for every method.

Options

Bandcamp split up different parts of their API into modules:

  • Band
  • Album
  • Track
  • URL

Each module is versioned. You may pass a version object after your key to set custom versions of each module. In the future, I will update this library to always use the latest version of each module, so if you want to explicitly set the versions for your app and upgrade without fear, you can.

var versions = {
    band: 3,
    album: 2,
    track: 1,
    url: 1
};

var key = 'yourbandcampAPIkey', // contact <support@bandcamp.com> to request one
    bandcamp = require('bandcamp')(key, versions);

Partial application/Curry

You may pass an arbitrary number of arguments after the 3 default ones (searchParam, Callback, [version]). For example:

// Track module, default version (null), passed a URL
bandcamp.track.search('1269403107', function(err, result, status, url) {
    console.log(result, url);
}, null, 'http://bandcamp.com');

The fourth parameter passed to track.search() will be passed as the fourth parameter to the callback. In this case, I passed a URL http://bandcamp.com and the callback can access it via the fourth argument, url.

Optional version override

You may want to set your versions explicitly since I will update this library to always use the latest tested version of Bandcamp's API modules. They do not update them frequently, but just in case.

You may also include specific modules if you don't want to include all of them. The optional version parameter is a config object for individual modules.

// Set the "band" module to use version 2.
var band = require('bandcamp')('apikeygoeshere', { band: 2 }).band,
    bandcamp = require('bandcamp')('apikeygoeshere'); // uses default versions.

// Band module version 2
band.search('the internet', function(err, result, status) {
    console.log(result);
});

// Track module version 1, overridden by third parameter
bandcamp.track.search('1269403107', function(err, result, status) {
    console.log(result);
}, 1); // Override the track module version to 1 just for this call

License

tl;dr: Do whatever you want, as long as you keep this notice:

(The MIT License)

Copyright (c) 2011 Kelly Miyashiro <miyashiro.kelly@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