fitbit_api 0.8.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c18d864ec416bee1e27c1b468d524bb8404e63076ba7652917270271d1eea58
-  data.tar.gz: 6487033355317ece6cbac6eb43a2b744e975d48b524d88dd4c4378221b96e7e8
+  metadata.gz: c6ad0b176146542cb288467849f95e477cd0345b3eb500a83ca13a47423d8ac2
+  data.tar.gz: dd8e47b54fc7210cc30ad347664c8e67ed555e1a64597e5cd012d896e31769d3
 SHA512:
-  metadata.gz: 3146e0990d97885808beb6db94a877003af2ed3847ee135ceea082199d8623fdb54301fd66218e5e7b52629d513d70e53231a0a3deb23e229e98af0ce762b1fb
-  data.tar.gz: 0b94b009192e261dde7ba9e98119dbc942290b12792113d858af621b34158a96f7f206d9cb35b0ba2334dc7f4cfd0b836e30c59102ce4e12d38e14c71bfc18a0
+  metadata.gz: 6c313975d4d22141af31553b129dfcbcf901847bc92191e2e5d559c633f245e5522ae72de893bf67fe0b6ebf3179ae0b3edabdf416da937a31d4025112f89e9c
+  data.tar.gz: 5d4c95b142fbe3ba5f7561c1c08e821a64c0dbd7fdafe3d5070b876363a0b2af1f5df1c1359bb54262ac5850ffc8104ca0c63e040e87dee9c45edbeade64d123

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.9.0
+-----
+- Rework client to accept existing access tokens.
+- Fix argument parsing in `FitbitAPI::Client` to respect fallback values passed to `#configure`.
+- Add `byebug` as development dependency.
+
 0.8.3
 -----
 - Fix bug regarding optional `params` parsing for GET requests.

data/README.md

@@ -27,12 +27,15 @@ You can reference the [fitbit_api_rails](https://github.com/zokioki/fitbit_api_r
 
 ### Quickstart
 
-If you already have access to a user's stored refresh token, you can instantiate a client instance like so:
+If you already have a user's token data and Fitbit user_id:
 
 ```ruby
 client = FitbitAPI::Client.new(client_id: 'XXXXXX',
                                client_secret: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
-                               refresh_token: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
+                               access_token: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+                               refresh_token: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+                               expires_at: 1234567890,
+                               user_id: 'XXXXXX')
 ```
 
 ### OAuth 2.0 Authorization Flow
@@ -62,14 +65,14 @@ You're now authorized and can make calls to Fitbit's API.
 
 ### Interacting with the API
 
-Once a valid token has been generated, you're able to make API calls from the client object, like so:
+Once a valid token has been generated, you're able to make API calls via the client object:
 
 ```ruby
 client.food_logs Date.today
 # => { "foods" => [{ "isFavorite" => true, "logDate" => "2015-06-26", "logId" => 1820, "loggedFood" => { "accessLevel" => "PUBLIC", "amount" => 132.57, "brand" => "", "calories" => 752, ...}] }
 ```
 
-To make responses more easily suited for attribute-assignment, they can be parsed to return a hash whose keys are in snake_case format. This can be done by setting the client's `snake_case_keys` option to `true`, like so:
+To make responses more easily suited for attribute-assignment, they can be parsed to return a hash whose keys are in snake_case format. This can be done by setting the client's `snake_case_keys` option to `true`:
 
 ```ruby
 client.snake_case_keys = true
@@ -104,6 +107,19 @@ When initializing a `FitbitAPI::Client` instance, you're given access to a handf
 
 - `:symbolize_keys` - Transform returned object's keys to symbols (default: false)
 
+If using this library in Rails, you can configure your options using an initializer:
+
+```ruby
+# config/initializers/fitbit_api.rb
+
+FitbitAPI.configure do |config|
+  config.client_id       = 'XXXX'
+  config.client_secret   = 'xxxx'
+  config.snake_case_keys = true
+  config.symbolize_keys  = true
+end
+```
+
 ## License
 
 This gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/fitbit_api.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency     'oauth2', '~> 1.0'
 
+  spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'

data/lib/fitbit_api/client.rb

@@ -13,22 +13,15 @@ require 'fitbit_api/water'
 
 module FitbitAPI
   class Client
-    attr_accessor :api_version, :unit_system, :locale, :scope, :snake_case_keys, :symbolize_keys
+    attr_accessor :api_version, :unit_system, :locale, :scope,
+                  :snake_case_keys, :symbolize_keys
     attr_reader   :user_id
 
-    def initialize(opts)
-      missing_args = [:client_id, :client_secret] - opts.keys
-      raise FitbitAPI::InvalidArgumentError, "Required arguments: #{missing_args.join(', ')}" if missing_args.size > 0
-
-      %w(client_id client_secret redirect_uri site_url authorize_url token_url
-      unit_system locale scope api_version snake_case_keys symbolize_keys).each do |attr|
-        instance_variable_set("@#{attr}", (opts[attr.to_sym] || FitbitAPI.send(attr)))
-      end
-
-      @client = OAuth2::Client.new(@client_id, @client_secret, site: @site_url,
-                                   authorize_url: @authorize_url, token_url: @token_url)
-
-      restore_token(opts[:refresh_token]) if opts[:refresh_token]
+    def initialize(opts={})
+      validate_args(opts)
+      assign_attrs(opts)
+      set_client
+      establish_token(opts)
     end
 
     def auth_url
@@ -36,23 +29,23 @@ module FitbitAPI
     end
 
     def get_token(auth_code)
-      @token = @client.auth_code.get_token(auth_code, redirect_uri: @redirect_uri, headers: auth_header)
-      @user_id = @token.params['user_id']
-      return @token
-    end
-
-    def restore_token(refresh_token)
-      @token = OAuth2::AccessToken.from_hash(@client, refresh_token: refresh_token).refresh!(headers: auth_header)
+      @token = @client.auth_code.get_token(
+        auth_code,
+        redirect_uri: @redirect_uri,
+        headers: auth_header
+      )
       @user_id = @token.params['user_id']
-      return @token
+      @token
     end
 
     def token
-      @token.expired? ? refresh_token : @token
+      @token.expired? ? refresh_token! : @token
     end
 
-    def refresh_token
+    def refresh_token!
       @token = @token.refresh!(headers: auth_header)
+      @user_id ||= @token.params['user_id']
+      @token
     end
 
     def auth_header
@@ -91,5 +84,60 @@ module FitbitAPI
       deep_symbolize_keys!(object) if (opts[:symbolize_keys] || symbolize_keys)
       return object
     end
+
+    private
+
+    def validate_args(opts)
+      required_args = %i[client_id client_secret].freeze
+      missing_args = []
+
+      required_args.each do |arg|
+        missing_args << arg if (opts[arg] || FitbitAPI.send(arg)).nil?
+      end
+
+      return if missing_args.empty?
+      raise FitbitAPI::InvalidArgumentError,
+            "Required arguments: #{missing_args.join(', ')}"
+    end
+
+    def assign_attrs(opts)
+      attrs = %i[client_id client_secret redirect_uri site_url
+                 authorize_url token_url unit_system locale scope
+                 api_version snake_case_keys symbolize_keys].freeze
+
+      attrs.each do |attr|
+        instance_variable_set("@#{attr}", (opts[attr] || FitbitAPI.send(attr)))
+      end
+
+      @user_id = opts[:user_id]
+    end
+
+    def set_client
+      @client = OAuth2::Client.new(
+        @client_id,
+        @client_secret,
+        site: @site_url,
+        authorize_url: @authorize_url,
+        token_url: @token_url
+      )
+    end
+
+    def establish_token(opts)
+      return unless opts[:access_token] || opts[:refresh_token]
+
+      if opts[:access_token] && !opts[:user_id]
+        raise FitbitAPI::InvalidArgumentError,
+              'user_id is required if using existing access token'
+      end
+
+      @token = OAuth2::AccessToken.new(
+        @client,
+        opts[:access_token],
+        refresh_token: opts[:refresh_token],
+        expires_at: opts[:expires_at]
+      )
+
+      refresh_token! if @token.token.empty?
+    end
   end
 end

data/lib/fitbit_api/helpers/utils.rb

@@ -1,7 +1,7 @@
 module FitbitAPI
   class Client
 
-    PERIODS = %w(1d 7d 30d 1w 1m 3m 6m 1y max)
+    PERIODS = %w(1d 7d 30d 1w 1m 3m 6m 1y max).freeze
 
     def format_date(date)
       if [Date, Time, DateTime].include?(date.class)

data/lib/fitbit_api/version.rb

@@ -1,4 +1,4 @@
 module FitbitAPI
-  VERSION = '0.8.3'
+  VERSION = '0.9.0'
   REPO_URL = 'https://github.com/zokioki/fitbit_api'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitbit_api
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Zoran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-17 00:00:00.000000000 Z
+date: 2018-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement