fitbyte 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 188fb792651e2f58e5b51a49dfb3bbe76e1041f5
-  data.tar.gz: 157ba5a0dc5568fa3ebab5fa928c8247a48af471
+  metadata.gz: f683b1fe97c314e07e53a983be399fff5ea30787
+  data.tar.gz: 8d9701b9aa3f08a74a05f76a81dfcbe212387dfa
 SHA512:
-  metadata.gz: fb907a686839076b47a7913a7aab8a1d55e02d3a081b7f758ad89eed182b9302ae6c8ffa99f7d0a96f142387b6769a9795ffaec05c915baaff2e24f019b18dbc
-  data.tar.gz: f4537f148799ef45a6e028cbbf74d3db11f5d887230145b59938bae90eb6a5e956ec75df732267cecb56953b871f06ba28e6675c2ae791b0a606860abba86f92
+  metadata.gz: 2cb40bea88a84370e8af28cc981750274f67521bfba24b84380435679b58b6de03cc3ccc02f045441e9012c6240d2af850131f4f98b75d5e02fe3fe675d7cb83
+  data.tar.gz: e19b133f2d0d4ed7276ca7e116e0e2934739c08e2a5e7b849a24977fa24760b2c29ab7e911ed98503a6ef33999d25d300b83e0a3bd2229479d7aff676f21d4d2

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.4.0
+-----
+- Remove FitStruct objects
+- The response's hash keys can now be transformed using the following options:
+  - `snake_case` - if set to true, all keys are formatted to snake_case
+  - `symbolize_keys` - if set to true, all keys are converted to symbols
+
 0.3.0
 -----
 - API endpoint support for the following actions:

data/README.md

@@ -5,8 +5,6 @@
 
 This gem allows interaction with [Fitbit's REST API](https://dev.fitbit.com/docs/basics/).
 
-**NOTE:** Fitbit's API is currently in beta, and is in active development. Breaking changes to certain endpoints may be introduced during early development of this gem, until Fitbit's API solidifies.
-
 ## Installation
 
 To install the latest release:
@@ -48,16 +46,14 @@ You're now authenticated and can make calls to Fitbit's API:
 
 ```ruby
 client.food_logs Date.today
-# => #<Fitbyte::FitStruct foods=[#<Fitbyte::FitStruct isFavorite=true, logDate="2015-06-26", logId=1820, loggedFood=#<Fitbyte::FitStruct accessLevel="PUBLIC", amount=132.57, brand="", calories=752, ...]
+# => { "foods" => [{ "isFavorite" => true, "logDate" => "2015-06-26", "logId" => 1820, "loggedFood" => { "accessLevel" => "PUBLIC", "amount" => 132.57, "brand" => "", "calories" => 752, ...}] }
 ```
 
-If your JSON library allows, the default format for resulting data returns OpenStruct-based FitStruct objects, allowing for more convenient method-like attribute access.
-
-To return the original JSON, `raw: true` can be specified as an option:
+To return the hash keys in snake_case format, the `snake_case: true` option can be specified:
 
 ```ruby
-client.food_logs Date.today, raw: true
-# => { :foods => [{ :isFavorite => true, :logDate => "2015-06-26", :logId => 1820, :loggedFood => { :accessLevel => "PUBLIC", :amount => 132.57, :brand => "", :calories => 752, ...}] }
+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, ...}] }
 ```
 
 ### Options
@@ -76,7 +72,10 @@ When initializing a `Fitbyte::Client` instance, you're given access to a handful
 - `: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")
 
 ---
-- `:raw_response` - Setting this option to `true` returns response values on subsequent calls as parsed JSON; by default, response values use FitStruct objects, for convenient method-like attribute access (default: false | available: true, false)
+- `:snake_case` - Transform returned object's keys to snake case format (default: false)
+
+---
+- `:symbolize_keys` - Transform returned object's keys to symbols (default: false)
 
 ---
 

data/lib/fitbyte/client.rb

@@ -1,4 +1,3 @@
-require "fitbyte/fitstruct"
 require "fitbyte/helpers"
 require "fitbyte/activities"
 require "fitbyte/goals"
@@ -13,7 +12,7 @@ require "fitbyte/water"
 
 module Fitbyte
   class Client
-    attr_accessor :api_version, :unit_system, :locale, :scope, :raw_response
+    attr_accessor :api_version, :unit_system, :locale, :scope, :snake_case, :symbolize_keys
 
     def initialize(opts)
       missing_args = [:client_id, :client_secret, :redirect_uri] - opts.keys
@@ -34,7 +33,8 @@ module Fitbyte
       @scope = format_scope(opts[:scope])
 
       @api_version = opts[:api_version]
-      @raw_response = opts[:raw_response]
+      @snake_case = opts[:snake_case]
+      @symbolize_keys = opts[:symbolize_keys]
 
       @client = OAuth2::Client.new(@client_id, @client_secret, site: @site_url,
                                    authorize_url: @authorize_url, token_url: @token_url)
@@ -71,21 +71,27 @@ module Fitbyte
     end
 
     def get(path, opts={})
-      raw = opts[:raw].nil? ? @raw_response : opts[:raw]
       response = token.get(("#{@api_version}/" + path), headers: request_headers).response
-      MultiJson.load(response.body, symbolize_keys: true, object_class: (FitStruct unless raw)) unless response.status == 204
+      object = MultiJson.load(response.body) unless response.status == 204
+      process_keys!(object, opts)
     end
 
     def post(path, opts={})
-      raw = opts[:raw].nil? ? @raw_response : opts[:raw]
       response = token.post(("#{@api_version}/" + path), body: opts, headers: request_headers).response
-      MultiJson.load(response.body, symbolize_keys: true, object_class: (FitStruct unless raw)) unless response.status == 204
+      object = MultiJson.load(response.body) unless response.status == 204
+      process_keys!(object, opts)
     end
 
     def delete(path, opts={})
-      raw = opts[:raw].nil? ? @raw_response : opts[:raw]
       response = token.delete(("#{@api_version}/" + path), headers: request_headers).response
-      MultiJson.load(response.body, symbolize_keys: true, object_class: (FitStruct unless raw)) unless response.status == 204
+      object = MultiJson.load(response.body) unless response.status == 204
+      process_keys!(object, opts)
+    end
+
+    def process_keys!(object, opts={})
+      deep_keys_to_snake_case!(object) if (opts[:snake_case] || snake_case)
+      deep_symbolize_keys!(object) if (opts[:symbolize_keys] || symbolize_keys)
+      return object
     end
 
     def defaults
@@ -97,7 +103,8 @@ module Fitbyte
         unit_system: "en_US",
         locale: "en_US",
         api_version: "1",
-        raw_response: false
+        snake_case: false,
+        symbolize_keys: false
       }
     end
   end

data/lib/fitbyte/helpers.rb

@@ -1,5 +1,6 @@
 module Fitbyte
   class Client
+
     def format_date(date)
       if [Date, Time, DateTime].include?(date.class)
         date.strftime("%Y-%m-%d")
@@ -17,5 +18,39 @@ module Fitbyte
     def format_scope(scope)
       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_symbolize_keys!(object)
+      deep_transform_keys!(object) { |key| key.to_sym rescue key }
+    end
+
+    def deep_transform_keys!(object, &block)
+      case object
+      when Hash
+        object.keys.each do |key|
+          value = object.delete(key)
+          object[yield(key)] = deep_transform_keys!(value) { |key| yield(key) }
+        end
+        object
+      when Array
+        object.map! { |e| deep_transform_keys!(e) { |key| yield(key) } }
+      else
+        object
+      end
+    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
+    end
+
   end
 end

data/lib/fitbyte/version.rb

@@ -1,4 +1,4 @@
 module Fitbyte
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
   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.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Zoran Pesic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-07 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -90,7 +90,6 @@ files:
 - lib/fitbyte/body.rb
 - lib/fitbyte/client.rb
 - lib/fitbyte/devices.rb
-- lib/fitbyte/fitstruct.rb
 - lib/fitbyte/food.rb
 - lib/fitbyte/friends.rb
 - lib/fitbyte/goals.rb
@@ -119,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: This gem allows interaction with Fitbit's REST API.

data/lib/fitbyte/fitstruct.rb

@@ -1,3 +0,0 @@
-module Fitbyte
-  class FitStruct < OpenStruct; end
-end