youku-client
Version:
Youku API client library for node.js
175 lines (130 loc) • 5.63 kB
Markdown
# Youku for Node.js
An asyncronous client library for the Youku REST api.
[](https://travis-ci.org/SJAnderson/youku-client) [](https://badge.fury.io/js/youku-client)
```js
var Youku = require('youku');
var client = new Youku({
client_id: ''
client_secret: ''
redirect_uri: ''
});
client.get('videos/by_user', {
user_id: 77296796
}, function(error, data, response){
if (error) {
return console.log("Error: " + error);
}
console.log(data);
});
```
### Installation
`npm install youku-client`
### Quick Start
You will need a developer `client_id` from Youku, which can be obtained [here](http://open.youku.com/). If using chrome and you don't speak chinese, right-click anywhere on the page and select "Translate to (your language)".
I highly recommend placing your credentials somewhere private and safe.
```js
var config = require('/keys/youku.json');
var client = new Youku({
client_id: config.client_id,
client_secret: config.client_secret
});
```
To make GET and POST requests:
```js
client.get(path, params, callback);
client.post(path, params, callback);
```
### Making Requests
Youku API documentation can be found [here](http://open.youku.com/docs). Though youku provides an english language version of the site, it's incomplete. I'll be adding API documentation to this repository when I get around to it.
Get data about a video:
```js
client.get('videos/show', {
video_id: XODkyODA3MjI4
}, function(err, video, resp) {
if (err) {
return console.log("Error: " + err);
}
console.log(video);
return console.log(resp);
});
```
Follow user:
```js
client.post('users/show', {
user_name: "Ｈ＆Ｍ"
}, function(err, user, resp) {
if (err) {
return console.log("Error: " + err);
}
console.log(user);
return console.log(resp);
});
```
### OAuth2 Authorization
- In order for you to make requests on a user's behalf, you'll need to ubtain an `access_token` through Youku's oauth authentication flow.
`getAuthorizationUrl`: use this to build a URL that will redirect your user to the youku login screen. It takes an optional argument, the `redirect_uri`. If a `redirect_uri` is not passed in, it'll use the `redirect_uri` that was provided when the Youku instance was created
`authorizeUrl`: when Youku redirects back to your `redirect_uri`, they will send `code` as a GET parameter. Pass `code` into `authorizeUrl` and a callback takes two parameters, `err` and `result` in that order. If the call is successful, `result` will be populated with authorization data.
`refreshUrl`: Takes `refresh_token` and a callback. When you receive an authorization object from Youku, you receive a `refresh_token`. Pass this into `refreshUrl` to receive a fresh token.
Below is an example of how one might authenticate a user within an ExpressJS app.
```js
var http = require('http');
var express = require('express');
var Youku = require('youku-client');
var app = express();
var client = new Youku({
client_id: "YOUR_CLIENT_ID",
client_secret: "YOUR_CLIENT_SECRET",
redirect_uri: 'http://www.example.com/handleauth'
});
// Send your users here first to authorize
app.get('/authorize_user', function (res) {
var youku_login_url = client.getAuthorizationUrl();
res.redirect(youku_login_url);
});
// This is your redirect URI
app.get('/handleauth', function (req, res) {
client.authorizeUser(req.query.code, function (err, result) {
if (err) {
console.log("Auth Failed");
res.send(err);
} else {
console.log("Auth Successful");
console.log("Access Token: " + result.access_token);
res.send(result);
}
});
});
http.createServer(app).listen(app.get('port'), function () {
console.log("Express server listening on port " + app.get('port'));
});
```
### Documentation
I've included Youku API documentation in english [here](https://github.com/SJAnderson/youku-client/blob/master/YOUKU_DOCUMENTATION.md) for your convenience. Youku provides english documentation on their site, but it's incomplete.
### Examples
Examples will go here.
### Testing
Add `YOUKU_CLIENT_ID` and `YOUKU_CLIENT_SECRET` as environment variables.
to test if developing in the CoffeeScript source file:
`cake build; mocha test/test.js`
to test if developing in compiled JavaScript:
`mocha test/test.js`
### Contributors
Authored and maintained by [@sjanderson](http://www.github.com/sjanderson).
### License
The MIT License (MIT)
youku-client: Copyright (c) 2015 Steve Anderson
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.