oauth2_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: faf99318fa6e905188159c8c8acc3f342dcb45af
+  data.tar.gz: 324ee6e1be1144b814cc16762f77de8e5f2dc57d
+SHA512:
+  metadata.gz: db2340bbe42c9f302c172b959ce73f05f730bdc940b875a58394190cd2fbd716c4898fe8d600d602e4c643baef3911f6350864f01a1569d7eb0aaeefdf024bb7
+  data.tar.gz: f242b72e1e1727a4d57c57e528eabe9b972dca703540565ec2e72bb15a2d1afade4bdd544a0a11bab5390245366ad6645b482b0a6808002ba9248914785767c8

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in oauth2_rails.gemspec
+gemspec

data/README.md

@@ -0,0 +1,28 @@
+# Oauth2Rails
+
+A gem that currently provides support for the Fitbit API using Oauth2 protocol.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oauth2_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oauth2_rails
+
+## Contributing
+One project I would be very interested in is extracting this to a more general framework, that works with most clients on rails. For example, I'm sure the Fitbit flow is a little different, so it would not work always with other providers.
+
+1. Fork it ( https://github.com/[my-github-username]/oauth2_rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oauth2_rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/oauth2_rails.rb

@@ -0,0 +1,16 @@
+require 'oauth2_rails/version'
+require 'oauth2_rails/base'
+require 'oauth2_rails/auth'
+require 'oauth2_rails/errors'
+require 'oauth2_rails/fitbit'
+require 'oauth2_rails/response'
+require 'oauth2_rails/user'
+require 'faraday'
+require 'base64'
+
+module Oauth2Rails
+  extend self
+  def new(user, options = {})
+    Client.new(user, options = {})
+  end
+end

data/lib/oauth2_rails/auth.rb

@@ -0,0 +1,32 @@
+require 'oauth2_rails/base'
+
+module Oauth2Rails
+  class Auth < Base
+
+    def initialize(options = {})
+      @state = options[:state]
+      super(options)
+    end
+
+    # SAMPLE AUTHORIZATION REQUEST
+    # GET: https://www.fitbit.com/oauth2/authorize?response_type=code&client_id=22942C&
+    #       redirect_uri=http%3A%2F%2Fexample.com%2Fcallback&
+    #       scope=activity%20nutrition%20heartrate
+    def authorize_url
+      body = { response_type: 'code', client_id: @oauth_id, redirect_uri: @redirect_uri, scope: @scope, state: @state }
+      connection(@authorize_site).build_url(@authorize_path, body).to_s
+    end
+
+    # SAMPLE POST REQUEST
+    # POST:     https://api.fitbit.com/oauth2/token
+    # BODY:     client_id=22942C&grant_type=authorization_code&redirect_uri=http%3A%2F%2Fexample.com%2Fcallback&code=1234567890
+    # HEADERS:  Authorization: Basic Y2xpZW50X2lkOmNsaWVudCBzZWNyZXQ=
+    #           Content-Type: application/x-www-form-urlencoded
+    def get_token(code)
+      body = { grant_type: 'authorization_code', client_id: @oauth_id, redirect_uri: @redirect_uri, code: code }
+      tokens  = call(:post, @token_path, body: body)
+      User.new(tokens.json_body)
+    end
+
+  end
+end

data/lib/oauth2_rails/base.rb

@@ -0,0 +1,57 @@
+require 'oauth2_rails/errors'
+
+module Oauth2Rails
+  class Base
+
+    def initialize(options = {})
+      @oauth_id       = options[:oauth_id]       || OAUTH2_RAILS_ID
+      @oauth_secret   = options[:oauth_secret]   || OAUTH2_RAILS_SECRET
+      @redirect_uri   = options[:redirect_uri]   || 'http://localhost:3000/oauth2_callbacks/fitbit'
+      @authorize_site = options[:authorize_site] || 'https://www.fitbit.com'
+      @authorize_path = options[:authorize_path] || '/oauth2/authorize'
+      @api_site       = options[:api_site]       || 'https://api.fitbit.com'
+      @token_path     = options[:token_path]     || '/oauth2/token'
+      @scope          = options[:scope]          || 'heartrate'
+    end
+
+    def connection(url)
+      Faraday.new(url: url) do |faraday|
+        faraday.request  :url_encoded
+        faraday.response :logger
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+
+    def call(action, destination, options = {})
+      user = options[:user]
+      site = options[:site] || @api_site
+
+      if user
+        auth_header = "Bearer #{user}"
+      else
+        encoded = Base64.strict_encode64("#{@oauth_id}:#{@oauth_secret}")
+        auth_header = "Basic #{encoded}"
+      end
+
+      call = connection(site).send(action) do |req|
+        req.url destination
+        req.headers['Content-Type']   = 'application/x-www-form-urlencoded'
+        req.headers['Authorization']  = auth_header
+        req.body = options[:body]
+      end
+
+      response = Response.new(call)
+      case response.status
+        when 400 ; raise Oauth2Rails::Errors::BadRequest,      "400 #{response.error_message}"
+        when 404 ; raise Oauth2Rails::Errors::NotFound,        "404 #{response.error_message}"
+        when 409 ; raise Oauth2Rails::Errors::Conflict,        "409 #{response.error_message}"
+        when 500 ; raise Oauth2Rails::Errors::InternalServer,  "500 #{response.error_message}"
+        when 502 ; raise Oauth2Rails::Errors::BadGateway,      "502 #{response.error_message}"
+        when 401 ; raise Oauth2Rails::Errors::Unauthorized,    "401 #{response.error_message}"
+        else ; response
+      end
+
+    end
+
+  end
+end

data/lib/oauth2_rails/client.rb

@@ -0,0 +1,30 @@
+require 'oauth2_rails/base'
+require 'oauth2_rails/user'
+
+module Oauth2Rails
+  class Client < Base
+
+    def initialize(user, options = {})
+      super(options)
+      @user = user
+    end
+
+    def api_call(destination)
+      begin
+        call(:get, destination, user: @user.access_token)
+      rescue Oauth2Rails::Errors::Unauthorized
+        refresh
+        call(:get, destination, user: @user.access_token)
+      end
+    end
+
+    def refresh
+      response = call(:post, "#{@token_path}?grant_type=refresh_token&refresh_token=#{@user.refresh_token}")
+      @user.update!(
+        access_token: response.access_token, refresh_token: response.refresh_token,
+        expiry: Time.now + response.expires_every
+      )
+    end
+
+  end
+end

data/lib/oauth2_rails/errors.rb

@@ -0,0 +1,40 @@
+module Oauth2Rails
+  module Errors
+    # 400 Bad Request    | Any case where either endpoint doesn't exist,
+    #                    |  resource path parameters are invalid, POST request
+    #                    |  parameters are invalid or no Authentication header provided.
+    #                    |  This doesn't include invalid specific resource ids
+    # 401 Unauthorized   | The OAuth Authorization header provided and is invalid
+    #                    |  (consider looking in response body). Client or authorized
+    #                    |  user have no privilege to view requested data (for example,
+    #                    |  requested resource's owner has privacy permission "You" or "Friends"
+    #                    |  for requested resource)
+    # 404 Not Found      | The resource with given id doesn't exist
+    # 409 Conflict       | Either you hit the rate limiting quota for the client or
+    #                    |  for the viewer, or you trying to create conflicting resources (consider looking at errorType)
+    # 500 Internal Error | Something is terribly wrong on our side (and we are working on it). Try your request later
+    # 502 Bad Gateway    | We will be back soon. Maintenance!
+
+    class BadRequest < StandardError
+    end
+
+    class Unauthorized < StandardError
+    end
+
+    class NotFound < StandardError
+    end
+
+    class Conflict < StandardError
+    end
+
+    class InternalServer < StandardError
+    end
+
+    class BadGateway < StandardError
+    end
+
+    class InvalidArgument < StandardError
+    end
+
+  end
+end

data/lib/oauth2_rails/fitbit.rb

@@ -0,0 +1,65 @@
+require 'oauth2_rails/base'
+require 'oauth2_rails/client'
+require 'oauth2_rails/user'
+
+module Oauth2Rails
+  class Fitbit < Client
+    ## => PROFILE
+    # https://api.fitbit.com/1/user/-/profile.json
+    def profile
+      Profile.new(api_call('/1/user/-/profile.json').json_body)
+    end
+
+    def raw_profile
+      api_call('/1/user/-/profile.json')
+    end
+
+    ## => HEART DATA
+    # https://api.fitbit.com/1/user/-/activities/heart/date/today/1d.json
+    def daily_heart(start_date)
+      api_call("/1/user/-/activities/heart/date/#{start_date}/1d.json")
+    end
+
+    # https://api.fitbit.com/1/user/-/activities/heart/date/2015-05-07/1d/1sec/time/12:20/12:45.json
+    def minute_heart(days, seconds, start_date, start_time, end_time)
+      api_call("/1/user/-/activities/heart/date/#{start_date}/#{days}d/#{seconds}sec/time/#{start_time}/#{end_time}.json")
+    end
+
+    ## => SLEEP DATA
+    # Simple get sleep
+    def sleep(date)
+      api_call("/1/user/-/sleep/date/#{date}.json")
+    end
+
+    # Sleep time series
+    # /1/user/-/sleep/minutesAsleep/date/today/2010-08-27.json
+    # sleep/startTime ; sleep/timeInBed ; sleep/minutesAsleep
+    # sleep/awakeningsCount ; sleep/minutesAwake ; sleep/minutesToFallAsleep
+    # sleep/minutesAfterWakeup ; sleep/efficiency
+    def time_asleep(start_date, end_date)
+      api_call("/1/user/-/sleep/minutesAsleep/date/#{start_date}/#{end_date}.json")
+    end
+
+    def sleep_start(start_date, end_date)
+      api_call("/1/user/-/sleep/startTime/date/#{start_date}/#{end_date}.json")
+    end
+
+    def sleep_efficiency(start_date, end_date)
+      api_call("/1/user/-/sleep/efficiency/date/#{start_date}/#{end_date}.json")
+    end
+
+    def sleep_total_time(start_date, end_date)
+      api_call("/1/user/-/sleep/minutesAsleep/date/#{start_date}/#{end_date}.json")
+    end
+
+    ## => BODY INFORMATION
+    def body_weight(date)
+      api_call("/1/user/-/body/log/weight/date/#{date}.json")
+    end
+
+    ## => ACTIVITIES
+    def recent_activites
+      api_call("/1/user/-/activities/recent.json")
+    end
+  end
+end

data/lib/oauth2_rails/response.rb

@@ -0,0 +1,43 @@
+require 'json'
+
+module Oauth2Rails
+  class Response
+
+    def initialize(response)
+      @far_resp = response
+    end
+
+    def status
+      @far_resp.status
+    end
+
+    def headers
+      @far_resp.headers
+    end
+
+    def body
+      @far_resp.body
+    end
+
+    def json_body
+      JSON.parse @far_resp.body
+    end
+
+    def errors
+      json_body['errors'][0] if status != 200
+    end
+
+    def error_message
+      errors['message'] if errors
+    end
+
+    def refresh_token
+      json_body['access_token']
+    end
+
+    def access_token
+      json_body['access_token']
+    end
+
+  end
+end

data/lib/oauth2_rails/user.rb

@@ -0,0 +1,65 @@
+module Oauth2Rails
+  class Profile
+    def initialize(profile)
+      @profile = profile
+    end
+
+    def json_response
+      @profile
+    end
+
+    def id
+      @profile['user']['encodedId']
+    end
+
+    def full_name
+      @profile['user']['fullName']
+    end
+
+    def display_name
+      @profile['user']['displayName']
+    end
+
+    def country
+      @profile['user']['country']
+    end
+
+    def state
+      @profile['user']['state']
+    end
+
+    def city
+      @profile['user']['city']
+    end
+
+    def about_me
+      @profile['user']['aboutMe']
+    end
+  end
+
+  class User
+    def initialize(auth)
+      @token = auth
+    end
+
+    def json_response
+      @token
+    end
+
+    def id
+      @token['user_id']
+    end
+
+    def access_token
+      @token['access_token']
+    end
+
+    def refresh_token
+      @token['refresh_token']
+    end
+
+    def expires_every
+      @token['expires_in']
+    end
+  end
+end

data/lib/oauth2_rails/version.rb

@@ -0,0 +1,3 @@
+module Oauth2Rails
+  VERSION = "0.1.0"
+end

data/oauth2_rails.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oauth2_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oauth2_rails"
+  spec.version       = Oauth2Rails::VERSION
+  spec.authors       = ["Colin Walker"]
+  spec.email         = ["cjwalker@sfu.ca"]
+
+  spec.summary       = %q{Oauth2 Rails based client for Fitbit specifically.}
+  spec.homepage      = "https://github.com/ColDog/oauth2-fitbit-rails"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", ">= 0.7.0"
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: oauth2_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Colin Walker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- cjwalker@sfu.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/oauth2_rails.rb
+- lib/oauth2_rails/auth.rb
+- lib/oauth2_rails/base.rb
+- lib/oauth2_rails/client.rb
+- lib/oauth2_rails/errors.rb
+- lib/oauth2_rails/fitbit.rb
+- lib/oauth2_rails/response.rb
+- lib/oauth2_rails/user.rb
+- lib/oauth2_rails/version.rb
+- oauth2_rails.gemspec
+homepage: https://github.com/ColDog/oauth2-fitbit-rails
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Oauth2 Rails based client for Fitbit specifically.
+test_files: []