fitbyte 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f683b1fe97c314e07e53a983be399fff5ea30787
-  data.tar.gz: 8d9701b9aa3f08a74a05f76a81dfcbe212387dfa
+  metadata.gz: 4fc521fa00248d4a2349cbf48840ca97bc567e5d
+  data.tar.gz: e7d534a59e218901e7c81b36e4ad8cf4a2a7712c
 SHA512:
-  metadata.gz: 2cb40bea88a84370e8af28cc981750274f67521bfba24b84380435679b58b6de03cc3ccc02f045441e9012c6240d2af850131f4f98b75d5e02fe3fe675d7cb83
-  data.tar.gz: e19b133f2d0d4ed7276ca7e116e0e2934739c08e2a5e7b849a24977fa24760b2c29ab7e911ed98503a6ef33999d25d300b83e0a3bd2229479d7aff676f21d4d2
+  metadata.gz: 3af70dae21133cf999be7567e23859fa5d16edf7179f7cb86c55a3be0287737edb3ee1789261df5d6c472a57731d5ad10a08c9bdef46272e2eabfd3bdbdb89a9
+  data.tar.gz: 172a7eff592f180bcf973d949d67aa934b026df2ab300adfbf4b855f00fc9afe4c617f61cd37f583cd43918eb096666bd97315a059d358f86d5612fcd1e4c169

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.4.1
+-----
+- Users can now provide either snake_cased or camelCased param attribute keys when POSTing data to Fitbit. Keys are automatically converted to camelCase before a request is sent to Fitbit's API.
+
 0.4.0
 -----
 - Remove FitStruct objects

data/README.md

@@ -3,7 +3,9 @@
 [![Gem Version](https://badge.fury.io/rb/fitbyte.svg)](https://badge.fury.io/rb/fitbyte)
 [![Build Status](https://travis-ci.org/zokioki/fitbyte.svg?branch=master)](https://travis-ci.org/zokioki/fitbyte)
 
-This gem allows interaction with [Fitbit's REST API](https://dev.fitbit.com/docs/basics/).
+Fitbyte allows interaction with [Fitbit's REST API](https://dev.fitbit.com/docs/basics/).
+
+It was started as a small personal project to provide a Ruby API interface using OAuth2, after Fitbit announced the eventual drop of OAuth1 support for the developer API.
 
 ## Installation
 
@@ -36,7 +38,7 @@ client.auth_page_link
 # => https://fitbit.com/oauth2/authorize?client_id=123XYZ&redirect_uri=...
 ```
 
-- Follow 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 approving 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)
@@ -49,35 +51,39 @@ client.food_logs Date.today
 # => { "foods" => [{ "isFavorite" => true, "logDate" => "2015-06-26", "logId" => 1820, "loggedFood" => { "accessLevel" => "PUBLIC", "amount" => 132.57, "brand" => "", "calories" => 752, ...}] }
 ```
 
-To return the hash keys in snake_case format, the `snake_case: true` option can be specified:
+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 `snake_case` option to `true`, like so:
 
 ```ruby
 client.food_logs Date.today, snake_case: true
 # => { "foods" => [{ "is_favorite" => true, "log_date" => "2015-06-26", "log_id" => 1820, "logged_food" => { "access_level" => "PUBLIC", "amount" => 132.57, "brand" => "", "calories" => 752, ...}] }
 ```
 
+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
+client.log_activity activity_id: 12345, duration_millis: "50000"
+client.log_activity activityId: 54321, durationMillis: "44100"
+# If for some reason you had to mix snake and camel case like below,
+# Fitbyte would make sure the result is a validly formatted request
+client.log_activity activity_id: 12345, durationMillis: "683300"
+```
+
 ### Options
 
 When initializing a `Fitbyte::Client` instance, you're given access to a handful of options:
 
 - `:api_version` - API version to be used when making requests (default: "1")
 
----
 - `:unit_system` - The measurement unit system to use for response values (default: "en_US" | available: "en_US", "en_GB", and "any" for metric)
 
----
 - `:locale` - The locale to use for response values (default: "en_US" | available: "en_US", "fr_FR", "de_DE", "es_ES", "en_GB", "en_AU", "en_NZ" and "ja_JP")
 
----
 - `:scope` - A space-delimited list of the permissions you are requesting (default: "activity nutrition profile settings sleep social weight" | available: "activity", "heartrate", "location", "nutrition", "profile", "settings" "sleep", "social" and "weight")
 
----
 - `:snake_case` - Transform returned object's keys to snake case format (default: false)
 
----
 - `:symbolize_keys` - Transform returned object's keys to symbols (default: false)
 
----
 
 ## License
 

data/fitbyte.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Zoran Pesic"]
   spec.email         = ["zoran1991@gmail.com"]
 
-  spec.summary       = %q{This gem allows interaction with Fitbit's REST API.}
+  spec.summary       = %q{A Ruby interface to the Fitbit API, using OAuth2.}
   spec.homepage      = Fitbyte::REPO_URL
   spec.license       = "MIT"
 

data/lib/fitbyte/client.rb

@@ -77,7 +77,7 @@ module Fitbyte
     end
 
     def post(path, opts={})
-      response = token.post(("#{@api_version}/" + path), body: opts, headers: request_headers).response
+      response = token.post(("#{@api_version}/" + path), body: deep_keys_to_camel_case!(opts), headers: request_headers).response
       object = MultiJson.load(response.body) unless response.status == 204
       process_keys!(object, opts)
     end

data/lib/fitbyte/helpers.rb

@@ -19,16 +19,19 @@ module Fitbyte
       scope.is_a?(Array) ? scope.join(" ") : scope
     end
 
-    # Borrowing from Rails
-
     def deep_keys_to_snake_case!(object)
       deep_transform_keys!(object) { |key| to_snake_case(key) }
     end
 
+    def deep_keys_to_camel_case!(object)
+      deep_transform_keys!(object) { |key| to_camel_case(key, lower: true) }
+    end
+
     def deep_symbolize_keys!(object)
       deep_transform_keys!(object) { |key| key.to_sym rescue key }
     end
 
+    # Inspired by ActiveSupport's implementation
     def deep_transform_keys!(object, &block)
       case object
       when Hash
@@ -45,11 +48,19 @@ module Fitbyte
     end
 
     def to_snake_case(word)
-      word = word.to_s.dup
-      return word.downcase if word.match(/\A[A-Z]+\z/)
-      word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-      word.gsub!(/([a-z])([A-Z])/, '\1_\2')
-      word.downcase
+      string = word.to_s.dup
+      return string.downcase if string.match(/\A[A-Z]+\z/)
+      string.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      string.gsub!(/([a-z])([A-Z])/, '\1_\2')
+      string.downcase
+    end
+
+    def to_camel_case(word, opts={})
+      string = word.to_s
+      return string if string.match(/[A-Z]|[a-z]([A-Z0-9]*[a-z][a-z0-9]*[A-Z]|[a-z0-9]*[A-Z][A-Z0-9]*[a-z])[A-Za-z0-9]*/)
+      string = word.to_s.split("_").collect(&:capitalize).join
+      string.gsub!(/^\w{1}/) { |word| word.downcase } if opts[:lower]
+      return string
     end
 
   end

data/lib/fitbyte/version.rb

@@ -1,4 +1,4 @@
 module Fitbyte
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
   REPO_URL = "https://github.com/zokioki/fitbyte"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitbyte
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Zoran Pesic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -121,5 +121,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: This gem allows interaction with Fitbit's REST API.
+summary: A Ruby interface to the Fitbit API, using OAuth2.
 test_files: []