initial commit

Author: gustavo.marin

.gitignore

@@ -0,0 +1,31 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Node template
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://docs.npmjs.com/misc/faq#should-i-check-my-node-modules-folder-into-git
+node_modules
+
+.idea

README.md

@@ -0,0 +1,47 @@
+# Fitbit client
+
+An OAuth 2.0 client to consume [Fitbit's API](http://www.fitbit.com/). 
+
+## Usage
+
+### Using an existing user token
+
+```
+var FitbitClient = require('fitbit-client-oauth2');
+
+var client = new FitbitClient(<YOUR_FITBIT_API_KEY>, <YOUR_FITBIT_API_SECRET> );
+
+// retrieve previously saved user's token from db
+client.setTokens(access_token, refresh_token, expires_in);
+
+client.getTimeSeries().then(function(res) {
+
+    console.log('results: ', res);
+
+}).catch(function(err) {
+    console.log('error getting user data', err);
+});
+
+```
+
+### Refreshing an expired user token
+
+```
+    client.refreshAccessToken().then(function(token) {
+    
+        // save new token data to db
+        // do more stuff here.
+    
+    }).catch(function(err) {
+      console.log('error refreshing user token', err);
+    });
+
+```
+
+## TODO
+
+ * Implement full OAuth authorization code flow. (now it relays on [passport-fitbit-oauth2](https://github.com/IGZgustavomarin/passport-fitbit-oauth2)).
+ * Cover more of the Fitbit API endpoints
+ * Add token expiration event to the client (EventEmitter).
+ * Implement automatic retries on token expiration errors
+

package.json

@@ -0,0 +1,21 @@
+{
+  "name": "fitbit-client-oauth2",
+  "version": "1.0.0",
+  "description": "A fitbit client using OAuth 2.0 authentication.",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type" : "git",
+    "url" : "https://github.com/IGZgustavomarin/fitbit-client-oauth2.git"
+  },
+  "author": "Gustavo Marin",
+  "license": "MIT",
+  "dependencies": {
+    "object-assign": "^3.0.0",
+    "promise": "^7.0.3",
+    "request-promise": "^0.4.3",
+    "simple-oauth2": "^0.2.1"
+  }
+}

src/client.js

@@ -0,0 +1,72 @@
+var oauth2 = require('simple-oauth2');
+var Promise = require('promise');
+
+var helper = require('./helpers');
+var config = require('./config');
+
+var proto;
+
+var FitbitClient = function(clientId, consumerSecret) {
+
+  // Set the client credentials and the OAuth2 server
+  this.oauth2 = oauth2({
+    clientID: clientId,
+    clientSecret: consumerSecret,
+    site: config.FITBIT_BASE_API_URL,
+    authorizationPath: config.FITBIT_AUTH_PATH,
+    tokenPath: config.FITBIT_TOKEN_PATH,
+    useBasicAuthorizationHeader: true
+  });
+
+};
+
+proto = FitbitClient.prototype;
+
+proto.setTokens = function(accessToken, refreshToken, expiresIn) {
+  this.token = this.oauth2.accessToken.create({
+    access_token: accessToken,
+    refresh_token: refreshToken,
+    expires_in: expiresIn
+  });
+};
+
+proto.refreshAccessToken = function(options) {
+  var _this = this;
+  options = options || {};
+
+  if( !this.token.expired() && !options.forceRefresh) {
+    return Promise.resolve(this.token);
+  }
+
+  return new Promise(function(resolve, reject) {
+
+    _this.token.refresh(function(err, token) {
+
+      if (err) {
+        return reject(err);
+      }
+
+      _this.token = token;
+      return resolve(token);
+    });
+
+  });
+};
+
+proto.getTimeSeries = function(options) {
+  options = helper.buildTimeSeriesOptions(options);
+
+  //TODO: improve this way of getting the token
+  options.access_token = this.token.token.access_token;
+  return helper.createRequestPromise(options);
+
+};
+
+proto.getIntradayTimeSeries = function(options) {
+  options = helper.buildIntradayTimeSeriesOptions(options);
+
+  options.access_token = this.token.token.access_token;
+  return helper.createRequestPromise(options);
+};
+
+module.exports = FitbitClient;

src/config.js

@@ -0,0 +1,9 @@
+const FITBIT_BASE_API_URL = 'https://api.fitbit.com';
+const FITBIT_AUTH_PATH = '/oauth2/authorize';
+const FITBIT_TOKEN_PATH = '/oauth2/token';
+
+module.exports = {
+  FITBIT_BASE_API_URL: FITBIT_BASE_API_URL,
+  FITBIT_AUTH_PATH: FITBIT_AUTH_PATH,
+  FITBIT_TOKEN_PATH: FITBIT_TOKEN_PATH
+};

src/helpers.js

@@ -0,0 +1,75 @@
+var assign = require('object-assign');
+var request = require('request-promise');
+
+var config = require('./config');
+
+module.exports = {
+  createRequestPromise: createRequestPromise,
+  buildTimeSeriesOptions: buildTimeSeriesOptions,
+  buildIntradayTimeSeriesOptions: buildIntradayTimeSeriesOptions
+};
+
+function createRequestPromise(options) {
+  return request.get({
+    url: options.url,
+    method: 'GET',
+    json: true,
+    headers: {
+      Authorization: 'Bearer ' + options.access_token
+    }
+  }).then(function(res) {
+    res.requestedResource = options.resourcePath.replace('/', '-');
+    return res;
+  });
+}
+
+function buildTimeSeriesOptions(options) {
+  var url = config.FITBIT_BASE_API_URL + '/1/user/{userId}/{resourcePath}/date/{baseDate}/{period}.json';
+
+  options = assign({
+    userId: '-',
+    resourcePath: 'activities/steps',
+    baseDate: 'today',
+    period: '1d'
+  }, options);
+
+  if (options.endDate) {
+    delete options.period;
+  }
+
+  options.url = url.replace('{userId}', options.userId)
+    .replace('{resourcePath}', options.resourcePath)
+    .replace('{baseDate}', options.baseDate)
+    .replace('{period}', options.endDate ? options.endDate : options.period);
+
+  return options;
+}
+
+function buildIntradayTimeSeriesOptions(options) {
+  var url = config.FITBIT_BASE_API_URL + '/1/user/{userId}/{resourcePath}/date/{startDate}/{endDate}/{detailLevel}{extra}.json';
+
+  var extra = '/time/{startTime}/{endTime}';
+
+  options = assign({
+    userId: '-',
+    resourcePath: 'activities/steps',
+    startDate: 'today',
+    endDate: 'today',
+    detailLevel: '1min'
+  }, options);
+
+  if (options.startTime && options.endTime) {
+    url.replace('{extra}', extra);
+  }
+
+  options.url = url.replace('{userId}', options.userId)
+    .replace('{resourcePath}', options.resourcePath)
+    .replace('{startDate}', options.startDate)
+    .replace('{endDate}', options.endDate)
+    .replace('{detailLevel}', options.detailLevel)
+    .replace('{extra}', '')
+    .replace('{startTime}', options.startTime)
+    .replace('{endTime}', options.endTime);
+
+  return options;
+}

src/index.js

@@ -0,0 +1,2 @@
+
+module.exports = require('./client');