fitbyte 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c55138f26ae4e67ce728f81f7458c9fd951f67d
-  data.tar.gz: 5b31cb0811d68f489ea338266d269aefbd316b46
+  metadata.gz: 0e21658fcc86e8fea16b6de219039f1cdbd4a022
+  data.tar.gz: 54ed78187bf46a6dfcbbeab65537227d704c2aca
 SHA512:
-  metadata.gz: 4606b123efddc148d64d238926f26cde4e6c304b66a32e57553f6f1ceeaffebde098932e8fe242ea9539dc6e2d6a094e0538585957260349809b3ad6f7cc7647
-  data.tar.gz: 580553b0ccca421ee1d0a6adfdf7f6e25cb7ff74d5ddef4d4050b2ea44334ac84c64f64b84408c2f2f7dc82e1f5607c028843b30c1aecc2cfc8b811f87510b67
+  metadata.gz: ca64fab63f6ee50794649ac29a9d64741769c281724505a650eefcefe8012757d4f92bf61fe08068ff0297cbd82e5772b13042d635f98d24665514cd9a31c1b8
+  data.tar.gz: 830fed104faba746e6c341470d4e23b8add1dba28d8a97c8c6d66c30573b959e508188144bf7144aefb21506cbaeb9a6790621c9c6b548e83d440df09cae3da9

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.2.4
+-----
+- Default result format for `get` calls now return OpenStruct objects, allowing for more convenient method-like attribute access. Specifying `raw: true` returns original JSON.
+
 0.2.3
 -----
 - Remove `require 'json'`

data/README.md

@@ -2,9 +2,9 @@
 
 [![Gem Version](https://badge.fury.io/rb/fitbyte.svg)](https://badge.fury.io/rb/fitbyte)
 
-This gem allows interaction with [Fitbit's REST API](https://dev.fitbit.com/docs/basics/), using the OAuth 2.0 protocol for user authorization.
+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/rapid development. Breaking changes to certain endpoints may be introduced during early development of this gem, until Fitbit's API solidifies.
+**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
 
@@ -46,10 +46,19 @@ client.get_token(auth_code)
 You're now authenticated and can make calls to Fitbit's API:
 
 ```ruby
-client.food_logs
+client.food_logs Date.today
+# => #<OpenStruct foods=[#<OpenStruct isFavorite=true, logDate="2015-06-26", logId=1820, loggedFood=#<OpenStruct accessLevel="PUBLIC", amount=132.57, brand="", calories=752, ...]
+```
+
+If your available JSON library allows, the default format for resulting data returns OpenStruct objects, allowing for more convenient method-like attribute access.
+
+To return the original JSON, `raw: true` can be specified as an option:
+
+```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, ...}] }
 ```
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+This gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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, using OAuth2 for user authorization.}
+  spec.summary       = %q{This gem allows interaction with Fitbit's REST API.}
   spec.homepage      = Fitbyte::REPO_URL
   spec.license       = "MIT"
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency     "oauth2", "~> 1.0.0"
+  spec.add_runtime_dependency     "oauth2", "~> 1.0"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/fitbyte/activities.rb

@@ -1,31 +1,31 @@
 module Fitbyte
   class Client
-    def daily_activity_summary(date=Date.today)
-      get("user/#{@user_id}/activities/date/#{format_date(date)}.json")
+    def daily_activity_summary(date=Date.today, opts={})
+      get("user/#{@user_id}/activities/date/#{format_date(date)}.json", opts)
     end
 
-    def frequent_activities
-      get("user/#{@user_id}/activities/frequent.json")
+    def frequent_activities(opts={})
+      get("user/#{@user_id}/activities/frequent.json", opts)
     end
 
-    def favorite_activities
-      get("user/#{@user_id}/activities/favorite.json")
+    def favorite_activities(opts={})
+      get("user/#{@user_id}/activities/favorite.json", opts)
     end
 
-    def all_activities
-      get("activities.json")
+    def all_activities(opts={})
+      get("activities.json", opts)
     end
 
-    def lifetime_stats
-      get("user/#{@user_id}/activities.json")
+    def lifetime_stats(opts={})
+      get("user/#{@user_id}/activities.json", opts)
     end
 
-    def daily_goals
-      get("user/#{@user_id}/activities/goals/daily.json")
+    def daily_goals(opts={})
+      get("user/#{@user_id}/activities/goals/daily.json", opts)
     end
 
-    def weekly_goals
-      get("user/#{@user_id}/activities/goals/weekly.json")
+    def weekly_goals(opts={})
+      get("user/#{@user_id}/activities/goals/weekly.json", opts)
     end
   end
 end

data/lib/fitbyte/alarms.rb

@@ -1,7 +1,7 @@
 module Fitbyte
   class Client
-    def alarms(tracker_id)
-      get("user/#{@user_id}/devices/tracker/#{tracker_id}/alarms.json")
+    def alarms(tracker_id, opts={})
+      get("user/#{@user_id}/devices/tracker/#{tracker_id}/alarms.json", opts)
     end
   end
 end

data/lib/fitbyte/body.rb

@@ -1,19 +1,19 @@
 module Fitbyte
   class Client
-    def weight_logs(date=Date.today)
-      get("user/-/body/log/weight/date/#{format_date(date)}.json")
+    def weight_logs(date=Date.today, opts={})
+      get("user/-/body/log/weight/date/#{format_date(date)}.json", opts)
     end
 
-    def body_fat_logs(date=Date.today)
-      get("user/-/body/log/fat/date/#{format_date(date)}.json")
+    def body_fat_logs(date=Date.today, opts={})
+      get("user/-/body/log/fat/date/#{format_date(date)}.json", opts)
     end
 
-    def weight_goals
-      get("user/-/body/log/weight/goal.json")
+    def weight_goals(opts={})
+      get("user/-/body/log/weight/goal.json", opts)
     end
 
-    def body_fat_goals
-      get("user/-/body/log/fat/goal.json")
+    def body_fat_goals(opts={})
+      get("user/-/body/log/fat/goal.json", opts)
     end
   end
 end

data/lib/fitbyte/client.rb

@@ -13,22 +13,22 @@ module Fitbyte
   class Client
     attr_accessor :api_version, :unit_system, :locale, :scope
 
-    def initialize(options)
-      missing_args = [:client_id, :client_secret, :redirect_uri] - options.keys
+    def initialize(opts)
+      missing_args = [:client_id, :client_secret, :redirect_uri] - opts.keys
 
       raise ArgumentError, "Required arguments: #{missing.join(', ')}" if missing_args.size > 0
 
-      @client_id = options[:client_id]
-      @client_secret = options[:client_secret]
+      @client_id = opts[:client_id]
+      @client_secret = opts[:client_secret]
 
-      @redirect_uri = options[:redirect_uri]
-      @site_url = options[:site_url] || defaults[:site_url]
-      @authorize_url = options[:authorize_url] || defaults[:authorize_url]
-      @token_url = options[:token_url] || defaults[:token_url]
+      @redirect_uri = opts[:redirect_uri]
+      @site_url = opts[:site_url] || defaults[:site_url]
+      @authorize_url = opts[:authorize_url] || defaults[:authorize_url]
+      @token_url = opts[:token_url] || defaults[:token_url]
 
-      @scope = format_scope(options[:scope]) || defaults[:scope]
-      @unit_system = options[:unit_system] || defaults[:unit_system]
-      @locale = options[:locale] || defaults[:locale]
+      @scope = format_scope(opts[:scope]) || defaults[:scope]
+      @unit_system = opts[:unit_system] || defaults[:unit_system]
+      @locale = opts[:locale] || defaults[:locale]
       @api_version = "1"
 
       @client = OAuth2::Client.new(@client_id, @client_secret, site: @site_url,
@@ -65,8 +65,9 @@ module Fitbyte
       }
     end
 
-    def get(path)
-      MultiJson.load(token.get(("#{@api_version}/" + path), headers: request_headers).response.body, symbolize_keys: true)
+    def get(path, opts={})
+      MultiJson.load(token.get(("#{@api_version}/" + path), headers: request_headers).response.body,
+                     symbolize_keys: true, object_class: (OpenStruct unless opts[:raw]))
     end
 
     def defaults

data/lib/fitbyte/devices.rb

@@ -1,7 +1,7 @@
 module Fitbyte
   class Client
-    def devices
-      get("user/#{@user_id}/devices.json")
+    def devices(opts={})
+      get("user/#{@user_id}/devices.json", opts)
     end
   end
 end

data/lib/fitbyte/food.rb

@@ -1,23 +1,23 @@
 module Fitbyte
   class Client
-    def food_logs(date=Date.today)
-      get("user/#{@user_id}/foods/log/date/#{format_date(date)}.json")
+    def food_logs(date=Date.today, opts={})
+      get("user/#{@user_id}/foods/log/date/#{format_date(date)}.json", opts)
     end
 
-    def recent_foods
-      get("user/#{@user_id}/foods/recent.json")
+    def recent_foods(opts={})
+      get("user/#{@user_id}/foods/log/recent.json", opts)
     end
 
-    def frequent_foods
-      get("user/#{@user_id}/foods/log/frequent.json")
+    def frequent_foods(opts={})
+      get("user/#{@user_id}/foods/log/frequent.json", opts)
     end
 
-    def favorite_foods
-      get("user/#{@user_id}/foods/log/favorite.json")
+    def favorite_foods(opts={})
+      get("user/#{@user_id}/foods/log/favorite.json", opts)
     end
 
-    def food_goals
-      get("user/#{@user_id}/foods/log/goal.json")
+    def food_goals(opts={})
+      get("user/#{@user_id}/foods/log/goal.json", opts)
     end
   end
 end

data/lib/fitbyte/friends.rb

@@ -1,11 +1,11 @@
 module Fitbyte
   class Client
-    def friends
-      get("user/#{@user_id}/friends.json")
+    def friends(opts={})
+      get("user/#{@user_id}/friends.json", opts)
     end
 
-    def friends_leaderboard
-      get("user/#{@user_id}/friends/leaderboard.json")
+    def friends_leaderboard(opts={})
+      get("user/#{@user_id}/friends/leaderboard.json", opts)
     end
   end
 end

data/lib/fitbyte/sleep.rb

@@ -1,7 +1,7 @@
 module Fitbyte
   class Client
-    def sleep_logs(date=Date.today)
-      get("user/#{@user_id}/sleep/date/#{format_date(date)}.json")
+    def sleep_logs(date=Date.today, opts={})
+      get("user/#{@user_id}/sleep/date/#{format_date(date)}.json", opts)
     end
   end
 end

data/lib/fitbyte/user.rb

@@ -1,11 +1,11 @@
 module Fitbyte
   class Client
-    def profile
-      get("user/#{@user_id}/profile.json")
+    def profile(opts={})
+      get("user/#{@user_id}/profile.json", opts)
     end
 
-    def badges
-      get("user/#{@user_id}/badges.json")
+    def badges(opts={})
+      get("user/#{@user_id}/badges.json", opts)
     end
   end
 end

data/lib/fitbyte/version.rb

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

data/lib/fitbyte/water.rb

@@ -1,7 +1,7 @@
 module Fitbyte
   class Client
-    def water_logs(date=Date.today)
-      get("user/#{@user_id}/foods/log/water/date/#{format_date(date)}.json")
+    def water_logs(date=Date.today, opts={})
+      get("user/#{@user_id}/foods/log/water/date/#{format_date(date)}.json", opts)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitbyte
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Zoran Pesic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-13 00:00:00.000000000 Z
+date: 2015-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +120,5 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: This gem allows interaction with Fitbit's REST API, using OAuth2 for user
-  authorization.
+summary: This gem allows interaction with Fitbit's REST API.
 test_files: []