Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bahamas10/node-ampache
Communicate to an Ampache server using the API
https://github.com/bahamas10/node-ampache
Last synced: about 2 months ago
JSON representation
Communicate to an Ampache server using the API
- Host: GitHub
- URL: https://github.com/bahamas10/node-ampache
- Owner: bahamas10
- Created: 2012-08-10T07:30:29.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2013-03-16T06:28:30.000Z (almost 12 years ago)
- Last Synced: 2024-04-14T00:17:48.233Z (8 months ago)
- Language: JavaScript
- Size: 119 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Ampache
=======
Communicate to an Ampache server using the API
Usage
-----
``` js
var AmpacheSession = require('ampache');
var conn = new AmpacheSession('user', 'pass', 'http://example.com/server/xml.server.php');
```
Examples
--------
#### Authenticate to an ampache server (assumes `conn` is set from the above usage)
``` js
conn.authenticate(function(err, body) {
console.log(body);
});
```
yields
``` json
{
"auth": "510b0a5f0f0e076ebab1df731acbbaeb",
"api": 350001,
"update": "2012-05-23T03:32:01+00:00",
"add": "2012-08-07T09:32:17+00:00",
"clean": "2012-08-07T09:32:29+00:00",
"songs": 8043,
"albums": 862,
"artists": 372,
"playlists": 0,
"videos": 9
}
```
The dates in the above examples are JavaScript `Date` objects
#### Get a list of artists
``` js
conn.get_artists(function(err, body) {
console.log(body);
});
```
yields
``` json
{
"391": {
"@": {
"id": "391"
},
"name": "The American Dollar",
"tag": {
"#": "Post-Rock",
"@": {
"id": "7",
"count": ""
}
},
"albums": "2",
"songs": "24",
"preciserating": {},
"rating": "0"
},
"392": {...},
}
```
#### Query the Ampache server for a given artist id
``` js
conn.get_artist(249, function(err, body) {
console.log(body);
});
```
yields
``` json
{
"@": {
"id": "249"
},
"name": "Lights",
"tag": {
"#": "Pop",
"@": {
"id": "11",
"count": ""
}
},
"albums": "1",
"songs": "13",
"preciserating": {},
"rating": "0"
}
```
#### Ping the ampache server to prolong your session
``` js
conn.ping(function(err, body) {
console.log(body);
});
```
yields
``` json
{
"session_expire": "Fri, 10 Aug 2012 07:05:09 +0000",
"server": "3.6-Alpha1-DEV",
"version": 350001,
"compatible": 350001
}
```
The date in the above example is a JavaScript `Date` object
#### Send an api call
Circumvent the built-in convenience methods and hit the api directly
``` js
conn.call_api({'action':'playlists'}, function(err, body) {
console.log(body);
});
```
yields
``` json
{
"1": {
"@": {
"id": "1"
},
"name": "AILD - Decas",
"owner": "Administrator",
"items": "12",
"type": "public"
},
"2": {
"@": {
"id": "2"
},
"name": "AILD - The Powerless Rise",
"owner": "Administrator",
"items": "11",
"type": "public"
}
}
```
Functions
---------
### new AmpacheServer(user, pass, url, [opts])
Create a new `AmpacheServer` object. `opts` is an object with the following keys.
`opts.debug`: `boolean` - defaults to false - whether to write debug messages to stderr
---
The following functions require an `AmpacheServer` object to run
Callbacks will return an error object if applicable as the first argument,
and an object representing the server response as the second.
All callbacks are optional
### conn.authenticate(function(err, body))
Authenticate to the server, storing the auth data in the object, and return
the body
### conn.ping(function(err, body))
Extend the session on the server by sending a keep-alive
### conn.get\_artists, conn.get\_albums, conn.get\_songs([search], function(err, body))
Get a list of all artists/albums/songs on the server, returns a list of objects
`search` is an optional string to filter the results
### conn.get\_artist, conn.get\_album, conn.get\_song(id, function(err, body))
Get a single artist/album/song by its ID on the server
### conn.call\_api(values, function(err, body))
Call the API directly with a given set of values to pass in
ex.
``` js
conn.call_api({'action':'ping'}, function(err, body) {});
```
The `auth` parameter will be provided by the function if not provided
Install
-------
npm install ampache
Tests
-----
To test this module, you must copy the `config.json.dist` file in the tests/ folder
to `config.json`, and populate it with your Ampache server credentials.
cp tests/config.json{.dist,}
$EDITOR tests/config.json
And then you can run the tests manually
npm test
License
-------
MIT Licensed