chore(*): es6, promise based API

Write tests, move to es6, promise based API

BREAKING CHANGE: phone_search -> phoneSearch

Author: olalonde

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": [ "es2015" ]
+}

.eslintrc

@@ -0,0 +1,7 @@
+// Use this file as a starting point for your project's .eslintrc.
+// Copy this file, and add rule overrides as needed.
+{
+  "extends": "airbnb/base",
+  "parser": "babel-eslint"
+}
+

.gitignore

@@ -1,2 +1,3 @@
 node_modules/
 npm-debug.log
+.envrc

.travis.yml

@@ -0,0 +1,8 @@
+language: node_js
+node_js:
+  - "4.1"
+  - "4.0"
+  - "0.12"
+  - "0.11"
+  - "0.10"
+  - "iojs"

README.md

@@ -1,42 +1,66 @@
-[![NPM version](https://badge.fury.io/js/yelp.png)](http://badge.fury.io/js/yelp)
+[![Build Status](https://travis-ci.org/olalonde/node-yelp.svg?branch=master)](https://travis-ci.org/olalonde/node-yelp) [![NPM version](https://badge.fury.io/js/yelp.png)](http://badge.fury.io/js/yelp)
 
-Node.js module for interfacing with [Yelp](http://www.yelp.com)'s API v2.0
+Node.js module for interfacing with [Yelp](http://www.yelp.com)'s API
+v2.0. Supports both promises and callbacks.
 
-# Install #
+# Install
 
-    npm install --save yelp
+```
+npm install --save yelp
+```
 
-# Usage #
+# Usage
 
 ```javascript
 // Request API access: http://www.yelp.com/developers/getting_started/api_access
+var Yelp = require('yelp');
 
-var yelp = require("yelp").createClient({
-  consumer_key: "consumer-key", 
-  consumer_secret: "consumer-secret",
-  token: "token",
-  token_secret: "token-secret"
+var yelp = new Yelp({
+  consumer_key: 'consumer-key',
+  consumer_secret: 'consumer-secret',
+  token: 'token',
+  token_secret: 'token-secret',
 });
 
 // See http://www.yelp.com/developers/documentation/v2/search_api
-yelp.search({term: "food", location: "Montreal"}, function(error, data) {
-  console.log(error);
+yelp.search({ term: 'food', location: 'Montreal' })
+.then(function (data) {
   console.log(data);
+})
+.catch(function (err) {
+  console.error(err);
 });
 
 // See http://www.yelp.com/developers/documentation/v2/business
-yelp.business("yelp-san-francisco", function(error, data) {
-  console.log(error);
+yelp.business('yelp-san-francisco')
+  .then(console.log)
+  .catch(console.error);
+
+yelp.phoneSearch({ phone: '+15555555555' })
+  .then(console.log)
+  .catch(console.error);
+
+// A callback based API is also available:
+yelp.business('yelp-san-francisco', function(err, data) {
+  if (err) return console.log(error);
   console.log(data);
 });
 ```
 
-# References #
+See [./test](./test) for more usage examples.
+
+# References
 
 - [Search API](http://www.yelp.com/developers/documentation/v2/search_api)
 - [Business API](http://www.yelp.com/developers/documentation/v2/business)
 
-# License #
+# Test
+
+```bash
+CONSUMER_KEY="" CONSUMER_SECRET="" TOKEN="" TOKEN_SECRET="" npm test
+```
+
+# License
 
 Copyright (c) 2012 Olivier Lalonde <[email protected]>
 

demo/.gitignore

@@ -0,0 +1,84 @@
+'use strict';
+
+var _createClass = (function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; })();
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _querystring = require('querystring');
+
+var _querystring2 = _interopRequireDefault(_querystring);
+
+var _oauth = require('oauth');
+
+var _oauth2 = _interopRequireDefault(_oauth);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+var OAuth = _oauth2.default.OAuth;
+
+var baseUrl = 'http://api.yelp.com/v2/';
+
+var Yelp = (function () {
+  function Yelp(opts) {
+    _classCallCheck(this, Yelp);
+
+    this.oauthToken = opts.token;
+    this.oauthTokenSecret = opts.token_secret;
+    this.oauth = new OAuth(null, null, opts.consumer_key, opts.consumer_secret, opts.version || '1.0', null, 'HMAC-SHA1');
+  }
+
+  _createClass(Yelp, [{
+    key: 'get',
+    value: function get(resource, params, cb) {
+      var _this = this;
+
+      var promise = new Promise(function (resolve, reject) {
+        var debug = params.debug;
+        delete params.debug;
+
+        _this.oauth.get(baseUrl + resource + '?' + _querystring2.default.stringify(params), _this.oauthToken, _this.oauthTokenSecret, function (err, _data, response) {
+          if (err) return reject(err);
+          var data = JSON.parse(_data);
+          if (debug) return resolve([data, response]);
+          resolve(data);
+        });
+      });
+      if (typeof cb === 'function') {
+        promise.then(function (res) {
+          return cb(null, res);
+        }).catch(cb);
+        return null;
+      }
+      return promise;
+    }
+  }, {
+    key: 'search',
+    value: function search(params, callback) {
+      return this.get('search', params, callback);
+    }
+  }, {
+    key: 'business',
+    value: function business(id, callback) {
+      return this.get('business/' + id, null, callback);
+    }
+
+    /**
+     * Exampe:
+     * yelp.phone_search({phone: "+12223334444"}, function(error, data) {});
+     */
+
+  }, {
+    key: 'phoneSearch',
+    value: function phoneSearch(params, callback) {
+      return this.get('phone_search', params, callback);
+    }
+  }]);
+
+  return Yelp;
+})();
+
+exports.default = Yelp;

demo/yelp.js

@@ -1,62 +1,84 @@
-var querystring = require('querystring');
-var OAuth = require('oauth').OAuth;
-
-var Client = function(oauth_config) {
-  this.oauthToken = oauth_config.token;
-  this.oauthTokenSecret = oauth_config.token_secret;
-  
-  this.oauth = new OAuth(
-    null,
-    null,
-    oauth_config.consumer_key,
-    oauth_config.consumer_secret,
-    oauth_config.version || "1.0",
-    null,
-    'HMAC-SHA1'
-  );
-
-  return this;
-};
-
-var base_url = "http://api.yelp.com/v2/";
-
-Client.prototype.get = function(resource, params, callback) {
-  return this.oauth.get(
-    base_url + resource + '?' + querystring.stringify(params), 
-    this.oauthToken, 
-    this.oauthTokenSecret, 
-    function(error, data, response) {
-      if(!error) data = JSON.parse(data);
-      callback(error, data, response);
+'use strict';
+
+var _createClass = (function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; })();
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _querystring = require('querystring');
+
+var _querystring2 = _interopRequireDefault(_querystring);
+
+var _oauth = require('oauth');
+
+var _oauth2 = _interopRequireDefault(_oauth);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+var OAuth = _oauth2.default.OAuth;
+
+var baseUrl = 'http://api.yelp.com/v2/';
+
+var Yelp = (function () {
+  function Yelp(opts) {
+    _classCallCheck(this, Yelp);
+
+    this.oauthToken = opts.token;
+    this.oauthTokenSecret = opts.token_secret;
+    this.oauth = new OAuth(null, null, opts.consumer_key, opts.consumer_secret, opts.version || '1.0', null, 'HMAC-SHA1');
+  }
+
+  _createClass(Yelp, [{
+    key: 'get',
+    value: function get(resource, params, cb) {
+      var _this = this;
+
+      var promise = new Promise(function (resolve, reject) {
+        var debug = params.debug;
+        delete params.debug;
+
+        _this.oauth.get(baseUrl + resource + '?' + _querystring2.default.stringify(params), _this.oauthToken, _this.oauthTokenSecret, function (err, _data, response) {
+          if (err) return reject(err);
+          var data = JSON.parse(_data);
+          if (debug) return resolve([data, response]);
+          resolve(data);
+        });
+      });
+      if (typeof cb === 'function') {
+        promise.then(function (res) {
+          return cb(null, res);
+        }).catch(cb);
+        return null;
+      }
+      return promise;
+    }
+  }, {
+    key: 'search',
+    value: function search(params, callback) {
+      return this.get('search', params, callback);
+    }
+  }, {
+    key: 'business',
+    value: function business(id, callback) {
+      return this.get('business/' + id, null, callback);
     }
-  );
-}
-
-/*
-Exampe:
-yelp.search({term: "food", location: "Montreal"}, function(error, data) {});
-*/
-Client.prototype.search = function(params, callback) {
-  return this.get('search', params, callback);
-}
-
-/*
-Example:
-yelp.business("yelp-san-francisco", function(error, data) {});
-*/
-Client.prototype.business = function(id, callback) {
-  return this.get('business/' + id, null, callback);
-}
-
-/*
-Exampe:
-yelp.phone_search({phone: "+12223334444"}, function(error, data) {});
-*/
-Client.prototype.phone_search = function(params, callback) {
-  return this.get('phone_search', params, callback);
-}
-
-// @see http://www.yelp.com/developers/documentation/v2/authentication
-module.exports.createClient = function(oauth_config) {
-  return new Client(oauth_config);
-};
+
+    /**
+     * Exampe:
+     * yelp.phone_search({phone: "+12223334444"}, function(error, data) {});
+     */
+
+  }, {
+    key: 'phoneSearch',
+    value: function phoneSearch(params, callback) {
+      return this.get('phone_search', params, callback);
+    }
+  }]);
+
+  return Yelp;
+})();
+
+exports.default = Yelp;