Merge pull request #7 from repo-utils/promise

Promise and thunk

Author: fengmk2

.gitignore

@@ -14,3 +14,4 @@ results
 
 node_modules
 npm-debug.log
+coverage/

.npmignore

@@ -5,3 +5,6 @@ Makefile
 .travis.yml
 logo.png
 .jshint*
+coverage/
+logo.png
+*.log

.travis.yml

@@ -1,4 +1,5 @@
 language: node_js
 node_js:
-  - '0.10'
-script: make test-coveralls
+  - '0.11'
+script: "npm run test-travis"
+after_script: "npm install coveralls@2 && cat ./coverage/lcov.info | coveralls"

LICENSE.txt

@@ -24,9 +24,7 @@ gitlab
 [download-image]: https://img.shields.io/npm/dm/node-gitlab.svg?style=flat-square
 [download-url]: https://npmjs.org/package/node-gitlab
 
-![logo](https://raw.github.com/repo-utils/gitlab/master/logo.png)
-
-Gitlab API nodejs client.
+Gitlab API Node.js client
 
 * [Gitlab API document](https://github.com/gitlabhq/gitlabhq/tree/master/doc/api)
 
@@ -45,9 +43,49 @@ var client = gitlab.create({
   api: 'https://gitlab.com/api/v3',
   privateToken: 'your private token'
 });
+
 client.milestones.list({id: 1}, function (err, milestones) {
-  console.log(milestones);
+  console.log(err, milestones);
+});
+```
+
+### Thunk way
+
+Require [co](https://github.com/visionmedia/co) and node >= `0.11.12`:
+
+```js
+var co = require('co');
+var gitlab = require('node-gitlab');
+
+var client = gitlab.createThunk({
+  api: 'https://gitlab.com/api/v3',
+  privateToken: 'your private token'
 });
+
+co(function* () {
+  var milestones = yield client.milestones.list({id: 1});
+})();
+```
+
+### Promise way
+
+Require node >= `0.11.13` or [bluebird](https://github.com/petkaantonov/bluebird):
+
+```js
+var gitlab = require('node-gitlab');
+
+var client = gitlab.createPromise({
+  api: 'https://gitlab.com/api/v3',
+  privateToken: 'your private token'
+});
+
+client.milestones.list({id: 1})
+  .then(function (milestones) {
+    console.log(milestones);
+  })
+  .catch(function (err) {
+    throw err;
+  });
 ```
 
 ## Document
@@ -259,7 +297,7 @@ Parameters:
 
 (The MIT License)
 
-Copyright (c) 2013 - 2014 fengmk2 <fengmk2@gmail.com>
+Copyright (c) 2013 - 2014 fengmk2 <fengmk2@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.md

@@ -1,28 +1,23 @@
-/*!
+/**!
  * gitlab - lib/gitlab.js
- * Copyright(c) 2012 - 2013 fengmk2 <[email protected]>
+ *
+ * Copyright(c) fengmk2 and other contributors.
  * MIT Licensed
+ *
+ * Authors:
+ *   fengmk2 <[email protected]> (http://fengmk2.github.com)
  */
 
-"use strict";
+'use strict';
 
 /**
  * Module dependencies.
  */
 
 var debug = require('debug')('gitlab');
-var restful = require('restful-client');
+var RESTFulClient = require('restful-client').RESTFulClient;
 var util = require('util');
-var Milestone = require('./milestone');
-var Project = require('./project');
-var Member = require('./member');
-var GlobalHook = require('./globalHook.js');
-var Issue = require('./issue');
-var User = require('./user');
-var Repository = require('./repository');
-var MergeRequest = require('./merge_request');
-var RepositoryFile = require('./repository_file');
-var Group = require('./group');
+var resources = require('./resources');
 
 module.exports = Gitlab;
 
@@ -36,39 +31,18 @@ module.exports = Gitlab;
 function Gitlab(options) {
   options = options || {};
   options.api = options.api || 'https://gitlab.com/api/v3';
-  restful.RESTFulClient.call(this, options);
-
+  RESTFulClient.call(this, options);
   this.privateToken = options.privateToken;
 
-  this.addResources({
-    projects: Project,
-    projectMembers: {
-      resourcePath: '/projects/:id/members',
-      idName: 'user_id',
-    },
-    repository: Repository,
-    repositoryFiles: RepositoryFile,
-    mergeRequests: MergeRequest,
-    users: User,
-    issues: Issue,
-    globalHooks: GlobalHook,
-    members: Member,
-    milestones: Milestone,
-    hooks: {
-      resourcePath: '/projects/:id/hooks',
-      idName: 'hook_id',
-    },
-    groupMembers: {
-      resourcePath: '/groups/:id/members',
-      idName: 'user_id',
-    },
-    groups: Group
-  });
+  this.addResources(resources);
 
+  // mergeRequests => merge_requests
   this.merge_requests = this.mergeRequests;
+  // members => projectMembers
+  this.members = this.projectMembers;
 }
 
-util.inherits(Gitlab, restful.RESTFulClient);
+util.inherits(Gitlab, RESTFulClient);
 
 Gitlab.prototype.setAuthentication = function (req) {
   req.params.data.private_token = req.params.data.private_token || this.privateToken;
@@ -78,3 +52,13 @@ Gitlab.prototype.setAuthentication = function (req) {
 Gitlab.create = function (options) {
   return new Gitlab(options);
 };
+
+Gitlab.createPromise = function (options) {
+  var client = Gitlab.create(options);
+  return require('./promisify')(client);
+};
+
+Gitlab.createThunk = function (options) {
+  var client = Gitlab.create(options);
+  return require('./thunkify')(client);
+};