fitbit_api 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c0f7cfa7bd01601218b28a91cfc320c5d2e116b5
-  data.tar.gz: 21808cc90a6c101e5deee4f2f2928f6e771ce20f
+SHA256:
+  metadata.gz: a3e997f500cb5e13f629c70ee4a960e449204dd4c0568721277b3adeb397277f
+  data.tar.gz: 6b5168a42468309c215a56d988166ff4fb32398df29790c52c28b04c8c6a9423
 SHA512:
-  metadata.gz: 6a03d7fcd126de4537b06a898643805d1c32f01222421d1944fdbce72244fe3399b9ec2dc3e727d6fd7bbbd87ecf11739122229c4b69dc7d426833015daee2df
-  data.tar.gz: d76d0351df16e25d0659a0c8422fa5bd5c06af0b1f0fe0406b4ce2d9b35a30046f0e5362393951fd9e7acae178fed40d629b160a483185c144698f43e032bdaf
+  metadata.gz: 5b864be3c323e0c912b26e4d45af8a5c7827e0d1d5431a68712ccc169a63e3c063b6fc0040e6d76fa2675a1ea4a10b7ac2b577683d670d21f0aee8f65de6ecc0
+  data.tar.gz: 7f35266d3f1454f61e3f207b2f709400643b2adcb31a29a8b783b2fbbf72805feb05948df48bebedc1c3ec4e3d6746da72ee7f3c78389184c5ed071c72c402b2

data/.travis.yml

@@ -1,7 +1,9 @@
 language: ruby
 rvm:
+  - 2.5.1
+  - 2.4.2
+  - 2.3.5
   - 2.2.2
   - 2.1.6
   - 2.0.0
-  - 1.9.3
 before_install: gem install bundler -v 1.10.3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.8.1
+-----
+- Fix `#activity_logs_list` to allow passing in expected URL params.
+
 0.8.1
 -----
 - Post install cleanup

data/README.md

@@ -17,45 +17,59 @@ To include in a Rails project, add it to the Gemfile:
 gem 'fitbit_api'
 ```
 
-## Usage
+## Getting Started
 
-To use the Fitbit API, you must register your application at [dev.fitbit.com](https://dev.fitbit.com/apps). After registering, you should have access to **CLIENT ID**, **CLIENT SECRET**, and **REDIRECT URI (Callback URL)** values for use in instantiating a *FitbitAPI::Client* object.
+To use the Fitbit API, you must register your application at [dev.fitbit.com](https://dev.fitbit.com/apps). After registering, you should have access to the **CLIENT ID** and **CLIENT SECRET** values for use in instantiating a *FitbitAPI::Client* object.
 
 ### Rails
 
-Please reference the [fitbit_api_rails repo](https://github.com/zokioki/fitbit_api_rails) as an example of how to use this gem within Rails.
+You can reference the [fitbit_api_rails](https://github.com/zokioki/fitbit_api_rails) repo as a simple example of how to use this gem within a Rails project.
 
-### Standalone
+### Quickstart
 
-- Create a client instance:
+If you already have access to a user's stored refresh token, you can instantiate a client instance like so:
 
 ```ruby
 client = FitbitAPI::Client.new(client_id: 'XXXXXX',
-                             client_secret: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
-                             redirect_uri: 'http://example.com/handle/callback')
+                               client_secret: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+                               refresh_token: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
 ```
 
-- Generate a link for the Fitbit authorization page:
+### OAuth 2.0 Authorization Flow
+
+- Create a client instance (ensure that `redirect_uri` is passed in):
+
+```ruby
+client = FitbitAPI::Client.new(client_id: 'XXXXXX',
+                               client_secret: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+                               redirect_uri: 'http://example.com/handle/callback')
+```
+
+- Generate a link for your app's Fitbit authorization page:
 
 ```ruby
 client.auth_url
 # => https://fitbit.com/oauth2/authorize?client_id=123XYZ&redirect_uri=...
 ```
 
-- Follow the generated link to Fitbit's authorization page. After approving your app, you're sent to the `redirect_uri`, with an appended authorization `code` param, which you'll exchange for an access token:
+- Follow the generated link to Fitbit's authorization page. After granting permission for your app, you're sent to the `redirect_uri`, with an appended authorization `code` param, which you'll exchange for an access token:
 
 ```ruby
 client.get_token(auth_code)
 ```
 
-You're now authenticated and can make calls to Fitbit's API:
+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:
 
 ```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 the response more easily suited for attribute-assignment, it 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`, like so:
 
 ```ruby
 client.snake_case_keys = true
@@ -66,10 +80,11 @@ client.food_logs Date.today
 Similarly, all arguments passed in through a POST request are automatically converted to camelCase before they hit Fitbit's API, making it easy to keep your codebase stylistically consistent. For example, all of the following would result in valid API calls:
 
 ```ruby
+# options with snake_cased keys
 client.log_activity activity_id: 12345, duration_millis: '50000'
+# options with camelCased keys
 client.log_activity activityId: 54321, durationMillis: '44100'
-# If for some reason you had to mix snake and camel case like below,
-# FitbitAPI would make sure the result is a validly formatted request
+# options with mixed snake and camel cased keys
 client.log_activity activity_id: 12345, durationMillis: '683300'
 ```
 
@@ -89,7 +104,6 @@ When initializing a `FitbitAPI::Client` instance, you're given access to a handf
 
 - `:symbolize_keys` - Transform returned object's keys to symbols (default: false)
 
-
 ## License
 
 This gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/fitbit_api/activities.rb

@@ -48,15 +48,22 @@ module FitbitAPI
     # Retrieves a list of a user's activity log entries before or after a given day with
     #   offset and limit using units in the unit system which corresponds to the Accept-Language header provided.
 
-    # ==== Parameters
+    # ==== URL Parameters
     # * +:beforeDate+ - the date; formatted in yyyy-MM-ddTHH:mm:ss
     # * +:afterDate+ - the date; formatted in yyyy-MM-ddTHH:mm:ss
     # * +:sort+ - the sort order of entries by date (asc or desc)
-    # * +:offset+ - the offset number of entries
-    # * +:limit+ - the max of the number of entries returned (max: 100)
+    # * +:offset+ - the offset number of entries. Must always be 0
+    # * +:limit+ - the max of the number of entries returned (max: 20)
 
     def activity_logs_list(opts={})
-      get("user/#{user_id}/activities/list.json", opts)
+      params = {}
+      param_defaults = { before_date: Date.today, after_date: nil, sort: 'desc', limit: 20, offset: 0 }
+
+      # merge defaults without overwriting specified values, then split params from options
+      opts.merge!(param_defaults) { |_key, val, _default| val }
+      param_defaults.keys.each { |i| params[i] = opts.delete(i) }
+
+      get("user/#{user_id}/activities/list.json", opts, params: params)
     end
 
     # Returns the details of a specific activity in the Fitbit activities database in the format requested.

data/lib/fitbit_api/client.rb

@@ -67,8 +67,8 @@ module FitbitAPI
       }
     end
 
-    def get(path, opts={})
-      response = token.get(("#{@api_version}/" + path), headers: request_headers).response
+    def get(path, opts={}, params: {})
+      response = token.get(("#{@api_version}/" + path), params: deep_keys_to_camel_case!(params), headers: request_headers).response
       object = MultiJson.load(response.body) unless response.status == 204
       process_keys!(object, opts)
     end

data/lib/fitbit_api/helpers/utils.rb

@@ -5,7 +5,7 @@ module FitbitAPI
 
     def format_date(date)
       if [Date, Time, DateTime].include?(date.class)
-        date.strftime("%Y-%m-%d")
+        date.strftime('%Y-%m-%d')
       elsif date.is_a? String
         if date =~ /\d{4}\-\d{2}\-\d{2}/
           date

data/lib/fitbit_api/version.rb

@@ -1,4 +1,4 @@
 module FitbitAPI
-  VERSION = '0.8.1'
+  VERSION = '0.8.2'
   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.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Zoran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-17 00:00:00.000000000 Z
+date: 2018-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -119,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A Ruby interface to the Fitbit Web API.