fitbyte 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fc521fa00248d4a2349cbf48840ca97bc567e5d
-  data.tar.gz: e7d534a59e218901e7c81b36e4ad8cf4a2a7712c
+  metadata.gz: 224202239ccc8345b4cced0077f4f6deb3aac0e6
+  data.tar.gz: 172d0d9768c89d91514612791138db1a16471ef6
 SHA512:
-  metadata.gz: 3af70dae21133cf999be7567e23859fa5d16edf7179f7cb86c55a3be0287737edb3ee1789261df5d6c472a57731d5ad10a08c9bdef46272e2eabfd3bdbdb89a9
-  data.tar.gz: 172a7eff592f180bcf973d949d67aa934b026df2ab300adfbf4b855f00fc9afe4c617f61cd37f583cd43918eb096666bd97315a059d358f86d5612fcd1e4c169
+  metadata.gz: 1a31ebbfaec0c459045ab8c7d7a358ec8e2abc52e980f9f3d31162ff7177ac044aef48d2cc99efe816e52b70265490a1a617f2e537d6865c03e045d6c3b2cd72
+  data.tar.gz: 3d301be5aa02e6800c2715212187654e208aa5e8f4644f88e3d784f7a497108a75a49be57d0675876a4a1915288801403d803d3f38f0255c7e3b2a3dbab63236

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.5.0
+-----
+- Add Heart Rate endpoint support. Add support for Time Series endpoints.
+- Minor improvements to some helper functions
+
 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.

data/README.md

@@ -51,9 +51,10 @@ 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 `snake_case` option to `true`, like so:
+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` option to `true`, like so:
 
 ```ruby
+client.snake_case = true
 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, ...}] }
 ```
@@ -78,7 +79,7 @@ When initializing a `Fitbyte::Client` instance, you're given access to a handful
 
 - `: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")
+- `:scope` - A space-delimited list of the permissions you are requesting (default: "activity nutrition profile settings sleep social weight heartrate" | available: "activity", "heartrate", "location", "nutrition", "profile", "settings" "sleep", "social" and "weight")
 
 - `:snake_case` - Transform returned object's keys to snake case format (default: false)
 

data/lib/fitbyte/activities.rb

@@ -1,5 +1,14 @@
 module Fitbyte
   class Client
+
+    ACTIVITY_RESOURCES = %w(calories caloriesBMR steps distance floors elevation
+                            minutesSedentary minutesLightlyActive minutesFairlyActive
+                            minutesVeryActive activityCalories tracker/calories
+                            tracker/steps tracker/distance tracker/floors
+                            tracker/elevation tracker/minutesSedentary
+                            tracker/minutesLightlyActive tracker/minutesFairlyActive
+                            tracker/minutesVeryActive tracker/activityCalories)
+
     # GET Activities
     # ==============
 
@@ -64,6 +73,38 @@ module Fitbyte
       get("user/#{@user_id}/activities.json", opts)
     end
 
+    def activity_time_series(resource, opts={})
+      start_date = opts[:start_date]
+      end_date   = opts[:end_date] || Date.today
+      period     = opts[:period]
+
+      unless ACTIVITY_RESOURCES.include?(resource)
+        raise Fitbyte::InvalidArgumentError, "Invalid resource: \"#{resource}\". Please provide one of the following: #{ACTIVITY_RESOURCES}."
+      end
+
+      if [period, start_date].none?
+        raise Fitbyte::InvalidArgumentError, "A start_date or period is required."
+      end
+
+      if period && !PERIODS.include?(period)
+        raise Fitbyte::InvalidArgumentError, "Invalid period: \"#{period}\". Please provide one of the following: #{PERIODS}."
+      end
+
+      if period
+        result = get("user/#{@user_id}/activities/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
+      else
+        result = get("user/#{@user_id}/activities/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
+      end
+      # remove root key from response
+      result.values[0]
+    end
+
+    # ACTIVITY_RESOURCES.each do |resource_path|
+    #   define_method("activity_#{to_snake_case(resource_path).gsub('/', '_')}_series") do |opts={}|
+    #     activity_time_series(resource_path, opts={})
+    #   end
+    # end
+
     # POST Activities
     # ===============
 

data/lib/fitbyte/body.rb

@@ -1,5 +1,7 @@
 module Fitbyte
   class Client
+    BODY_RESOURCES = %w(bmi fat weight)
+
     def weight_logs(date=Date.today, opts={})
       get("user/-/body/log/weight/date/#{format_date(date)}.json", opts)
     end
@@ -15,5 +17,31 @@ module Fitbyte
     def body_fat_goals(opts={})
       get("user/-/body/log/fat/goal.json", opts)
     end
+
+    def body_time_series(resource, opts={})
+      start_date = opts[:start_date]
+      end_date   = opts[:end_date] || Date.today
+      period     = opts[:period]
+
+      unless BODY_RESOURCES.include?(resource)
+        raise Fitbyte::InvalidArgumentError, "Invalid resource: \"#{resource}\". Please provide one of the following: #{BODY_RESOURCES}."
+      end
+
+      if [period, start_date].none?
+        raise Fitbyte::InvalidArgumentError, "A start_date or period is required."
+      end
+
+      if period && !PERIODS.include?(period)
+        raise Fitbyte::InvalidArgumentError, "Invalid period: \"#{period}\". Please provide one of the following: #{PERIODS}."
+      end
+
+      if period
+        result = get("user/#{@user_id}/body/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
+      else
+        result = get("user/#{@user_id}/body/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
+      end
+      # remove root key from response
+      result.values[0]
+    end
   end
 end

data/lib/fitbyte/client.rb

@@ -1,5 +1,7 @@
 require "fitbyte/helpers"
+require "fitbyte/exceptions"
 require "fitbyte/activities"
+require "fitbyte/heart_rate"
 require "fitbyte/goals"
 require "fitbyte/alarms"
 require "fitbyte/body"
@@ -16,7 +18,7 @@ module Fitbyte
 
     def initialize(opts)
       missing_args = [:client_id, :client_secret, :redirect_uri] - opts.keys
-      raise ArgumentError, "Required arguments: #{missing_args.join(', ')}" if missing_args.size > 0
+      raise Fitbyte::InvalidArgumentError, "Required arguments: #{missing_args.join(', ')}" if missing_args.size > 0
 
       opts = defaults.merge(opts)
 
@@ -99,7 +101,7 @@ module Fitbyte
         site_url: "https://api.fitbit.com",
         authorize_url: "https://www.fitbit.com/oauth2/authorize",
         token_url: "https://api.fitbit.com/oauth2/token",
-        scope: "activity nutrition profile settings sleep social weight",
+        scope: "activity nutrition profile settings sleep social weight heartrate",
         unit_system: "en_US",
         locale: "en_US",
         api_version: "1",

data/lib/fitbyte/exceptions.rb

@@ -0,0 +1,4 @@
+module Fitbyte
+  class InvalidArgumentError < ArgumentError
+  end
+end

data/lib/fitbyte/food.rb

@@ -1,5 +1,7 @@
 module Fitbyte
   class Client
+    FOOD_RESOURCES = %w(caloriesIn water)
+
     def food_logs(date=Date.today, opts={})
       get("user/#{@user_id}/foods/log/date/#{format_date(date)}.json", opts)
     end
@@ -19,5 +21,31 @@ module Fitbyte
     def food_goals(opts={})
       get("user/#{@user_id}/foods/log/goal.json", opts)
     end
+
+    def food_time_series(resource, opts={})
+      start_date = opts[:start_date]
+      end_date   = opts[:end_date] || Date.today
+      period     = opts[:period]
+
+      unless FOOD_RESOURCES.include?(resource)
+        raise Fitbyte::InvalidArgumentError, "Invalid resource: \"#{resource}\". Please provide one of the following: #{FOOD_RESOURCES}."
+      end
+
+      if [period, start_date].none?
+        raise Fitbyte::InvalidArgumentError, "A start_date or period is required."
+      end
+
+      if period && !PERIODS.include?(period)
+        raise Fitbyte::InvalidArgumentError, "Invalid period: \"#{period}\". Please provide one of the following: #{PERIODS}."
+      end
+
+      if period
+        result = get("user/#{@user_id}/foods/log/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
+      else
+        result = get("user/#{@user_id}/foods/log/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
+      end
+      # remove root key from response
+      result.values[0]
+    end
   end
 end

data/lib/fitbyte/heart_rate.rb

@@ -0,0 +1,25 @@
+module Fitbyte
+  class Client
+    def heart_rate_time_series(opts={})
+      start_date = opts[:start_date]
+      end_date   = opts[:end_date] || Date.today
+      period     = opts[:period]
+
+      if [period, start_date].none?
+        raise Fitbyte::InvalidArgumentError, "A start_date or period is required."
+      end
+
+      if period && !PERIODS.include?(period)
+        raise Fitbyte::InvalidArgumentError, "Invalid period: \"#{period}\". Please provide one of the following: #{PERIODS}."
+      end
+
+      if period
+        result = get("user/#{@user_id}/activities/heart/date/#{format_date(end_date)}/#{period}.json", opts)
+      else
+        result = get("user/#{@user_id}/activities/heart/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
+      end
+      # remove root key from response
+      result.values[0]
+    end
+  end
+end

data/lib/fitbyte/helpers.rb

@@ -1,6 +1,8 @@
 module Fitbyte
   class Client
 
+    PERIODS = %w(1d 7d 30d 1w 1m 3m 6m 1y max)
+
     def format_date(date)
       if [Date, Time, DateTime].include?(date.class)
         date.strftime("%Y-%m-%d")
@@ -8,10 +10,10 @@ module Fitbyte
         if date =~ /\d{4}\-\d{2}\-\d{2}/
           date
         else
-          raise ArgumentError, "Invalid argument [\"#{date}\"] - string must follow yyyy-MM-dd format."
+          raise Fitbyte::InvalidArgumentError, "Invalid argument [\"#{date}\"] - string must follow yyyy-MM-dd format."
         end
       else
-        raise ArgumentError, "Invalid type [#{date.class}] - provide a Date/Time/DateTime or a String(yyyy-MM-dd format)."
+        raise Fitbyte::InvalidArgumentError, "Invalid type [#{date.class}] - provide a Date/Time/DateTime or a String(yyyy-MM-dd format)."
       end
     end
 
@@ -20,7 +22,7 @@ module Fitbyte
     end
 
     def deep_keys_to_snake_case!(object)
-      deep_transform_keys!(object) { |key| to_snake_case(key) }
+      deep_transform_keys!(object) { |key| to_snake_case(key, replace_dashes: true) }
     end
 
     def deep_keys_to_camel_case!(object)
@@ -47,11 +49,12 @@ module Fitbyte
       end
     end
 
-    def to_snake_case(word)
+    def to_snake_case(word, opts={})
       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.gsub!("-", "_") if opts[:replace_dashes]
       string.downcase
     end
 

data/lib/fitbyte/sleep.rb

@@ -1,7 +1,36 @@
 module Fitbyte
   class Client
+    SLEEP_RESOURCES = %w(startTime timeInBed minutesAsleep awakeningsCount
+                         minutesAwake minutesToFallAsleep minutesAfterWakeup efficiency)
+
     def sleep_logs(date=Date.today, opts={})
       get("user/#{@user_id}/sleep/date/#{format_date(date)}.json", opts)
     end
+
+    def sleep_time_series(resource, opts={})
+      start_date = opts[:start_date]
+      end_date   = opts[:end_date] || Date.today
+      period     = opts[:period]
+
+      unless SLEEP_RESOURCES.include?(resource)
+        raise Fitbyte::InvalidArgumentError, "Invalid resource: \"#{resource}\". Please provide one of the following: #{SLEEP_RESOURCES}."
+      end
+
+      if [period, start_date].none?
+        raise Fitbyte::InvalidArgumentError, "A start_date or period is required."
+      end
+
+      if period && !PERIODS.include?(period)
+        raise Fitbyte::InvalidArgumentError, "Invalid period: \"#{period}\". Please provide one of the following: #{PERIODS}."
+      end
+
+      if period
+        result = get("user/#{@user_id}/activities/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
+      else
+        result = get("user/#{@user_id}/activities/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
+      end
+      # remove root key from response
+      result.values[0]
+    end
   end
 end

data/lib/fitbyte/version.rb

@@ -1,4 +1,4 @@
 module Fitbyte
-  VERSION = "0.4.1"
+  VERSION = "0.5.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.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Zoran Pesic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-05 00:00:00.000000000 Z
+date: 2016-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -90,9 +90,11 @@ files:
 - lib/fitbyte/body.rb
 - lib/fitbyte/client.rb
 - lib/fitbyte/devices.rb
+- lib/fitbyte/exceptions.rb
 - lib/fitbyte/food.rb
 - lib/fitbyte/friends.rb
 - lib/fitbyte/goals.rb
+- lib/fitbyte/heart_rate.rb
 - lib/fitbyte/helpers.rb
 - lib/fitbyte/sleep.rb
 - lib/fitbyte/user.rb