fitgem_oauth2 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ae7eec9fd825f4fc19feafe55ca51d3b6e176fdd
-  data.tar.gz: 0b1d4f6fb319465919049c96c8d4e2f731ad22c8
+SHA256:
+  metadata.gz: fd9d0f60ab3531d3ee135513c6e6ef7bf584978ee2aa760112ae317528bce9f4
+  data.tar.gz: a65d59a4e239ae99f068d1886166fbc81c04d544bcf1cc03acda2703d1e7497c
 SHA512:
-  metadata.gz: 49b06536b0b23e8645666d85c67081a047ca2b125b1398fa1cde532f441a65cdd10c1f5d2c657df14fed795e6ffaccbbb6690a92d81f77039616e960a1000931
-  data.tar.gz: '0691da40e4d1dcf14757ecd6656a5b391d537223bb00f09d8028327b7f79e201711d71f0538619578cc1d467a50041ddb428366c6ab73200ed3abda847baa7c5'
+  metadata.gz: 0a747382a12149b6aa73fab4df12672fde5be3a35ce1c33ab8bd9ee969146c2ca6368b5667f7c94cfbd0ae7c09a30a0d051870c766149afaf37f7658fd0e33b7
+  data.tar.gz: 3400e8170f577dd2414bce4cea863ee02a97d68c49e2dff03ba1af3c8f1616634d4c35acf5e4111dce08692c87d96bd4427cc6d8408ec9bf45e98bd471f245dd

data/lib/fitgem_oauth2.rb

@@ -1,5 +1,6 @@
 require 'fitgem_oauth2/client.rb'
 
+# Top level module for the classes for this gem
 module FitgemOauth2
 
 end

data/lib/fitgem_oauth2/activity.rb

@@ -1,9 +1,16 @@
 module FitgemOauth2
   class Client
 
-    ACTIVITY_RESOURCES = %w(calories caloriesBMR steps distance floors elevation minutesSedentary minutesLightlyActive minutesFairlyActive minutesVeryActive activityCaloriestracker/calories tracker/steps tracker/distance tracker/floors tracker/elevation tracker/minutesSedentary tracker/minutesLightlyActive tracker/minutesFairlyActive tracker/minutesVeryActive tracker/activityCalories)
-
-    ACTIVITY_PERIODS = %w(1d 7d 30d 1w 1m 3m 6m 1y max)
+    ACTIVITY_RESOURCES = %w[
+      calories caloriesBMR steps distance floors elevation minutesSedentary
+      minutesLightlyActive minutesFairlyActive minutesVeryActive
+      activityCaloriestracker/calories tracker/steps tracker/distance
+      tracker/floors tracker/elevation tracker/minutesSedentary
+      tracker/minutesLightlyActive tracker/minutesFairlyActive
+      tracker/minutesVeryActive tracker/activityCalories
+    ].freeze
+
+    ACTIVITY_PERIODS = %w[1d 7d 30d 1w 1m 3m 6m 1y max].freeze
 
     # retrieves daily activity summary for a date
     # @param date the date for which the summary is retrieved

data/lib/fitgem_oauth2/food.rb

@@ -1,190 +1,21 @@
+require 'fitgem_oauth2/food/collection.rb'
+require 'fitgem_oauth2/food/series.rb'
+require 'fitgem_oauth2/food/metadata.rb'
+
 module FitgemOauth2
   class Client
 
-    FOOD_SERIES_RESOURCES = %w( caloriesIn water )
-    FOOD_SERIES_PERIODS = %w( 1d 7d 30d 1w 1m 3m 6m 1y max )
-
-
-    # ==================================
-    #   Food or Water Series
-    # ==================================
-
-    def food_series_for_date_range(start_date, end_date)
-      validate_start_date(start_date)
-      validate_end_date(end_date)
-      get_call(food_series_url(user_id, format_date(start_date), format_date(end_date)))
-    end
-
-    def food_series_for_period(start_date, period)
-      validate_start_date(start_date)
-      validate_food_series_period(period)
-      get_call(food_series_url(user_id, format_date(start_date), period))
-    end
-
-    def water_series_for_date_range(start_date, end_date)
-      validate_start_date(start_date)
-      validate_end_date(end_date)
-      get_call(water_series_url(user_id, format_date(start_date), format_date(end_date)))
-    end
-
-    def water_series_for_period(start_date, period)
-      validate_start_date(start_date)
-      validate_food_series_period(period)
-      get_call(water_series_url(user_id, format_date(start_date), period))
-    end
-
-    def food_series(resource: nil, start_date: nil, end_date: nil, period: nil)
-      warn '[DEPRECATED] use `food_series_for_date_range`, `food_series_for_period`, `water_series_for_date_range`, or `water_series_for_period` instead.'
-      unless FOOD_SERIES_RESOURCES.include?(resource)
-        raise FitgemOauth2::InvalidArgumentError, "Invalid resource: #{resource}. Specify a valid resource from #{FOOD_SERIES_RESOURCES}"
-      end
-
-      if end_date && period
-        raise FitgemOauth2::InvalidArgumentError, 'Provide only one of end_date and period.'
-      end
-
-      if !end_date && !period
-        raise FitgemOauth2::InvalidArgumentError, 'Provide at least one of end_date and period.'
-      end
-
-      url = ['user', user_id, 'foods/log', resource, 'date', start_date].join('/')
-
-      if period
-        unless FOOD_SERIES_PERIODS.include?(period)
-          raise FitgemOauth2::InvalidArgumentError, "Invalid period: #{period}. Specify a valid period from #{FOOD_SERIES_PERIODS}"
-        end
-      end
-
-      second = period || format_date(end_date)
-      url = [url, second].join('/')
-
-      get_call(url + '.json')
-    end
-
-    # ==================================
-    #   Collection data
-    # ==================================
-
-    def food_goals
-      get_call("user/#{user_id}/foods/log/goal.json")
-    end
-
-    def food_logs(date)
-      get_call("user/#{user_id}/foods/log/date/#{format_date(date)}.json")
-    end
-
-    def water_logs(date)
-      get_call("user/#{user_id}/foods/log/water/date/#{format_date(date)}.json")
-    end
-
-    def water_goal
-      get_call("user/#{user_id}/foods/log/water/goal.json")
-    end
-
-    def log_food(params)
-      post_call("user/#{user_id}/foods/log.json", params)
-    end
-
-    def update_food_log(food_log_id, params)
-      post_call("user/#{user_id}/foods/log/#{food_log_id}.json", params)
-    end
-
-    def log_water(params)
-      post_call("user/#{user_id}/foods/log/water.json", params)
-    end
-
-    def update_food_goal(params)
-      post_call("user/#{user_id}/foods/log/goal.json", params)
-    end
-
-    def update_water_goal(params)
-      post_call("user/#{user_id}/foods/log/water/goal.json", params)
-    end
-
-    def delete_food_log(food_log_id)
-      delete_call("user/#{user_id}/foods/log/#{food_log_id}.json")
-    end
-
-    def update_water_log(water_log_id, params)
-      post_call("user/#{user_id}/foods/log/water/#{water_log_id}.json", params)
-    end
-
-    def delete_water_log(water_log_id)
-      delete_call("user/#{user_id}/foods/log/water/#{water_log_id}.json")
-    end
-
-    # ==================================
-    #   Collection Metadata
-    # ==================================
-
-    def add_favorite_food(food_id)
-      post_call("user/#{user_id}/foods/log/favorite/#{food_id}.json")
-    end
-
-    def delete_favorite_food(food_id)
-      delete_call("user/#{user_id}/foods/log/favorite/#{food_id}.json")
-    end
-
-    def recent_foods
-      get_call("user/#{user_id}/foods/recent.json")
-    end
-
-    def favorite_foods
-      get_call("user/#{user_id}/foods/log/favorite.json")
-    end
-
-    def frequent_foods
-      get_call("user/#{user_id}/foods/log/frequent.json")
-    end
-
-    def meals
-      get_call("user/#{user_id}/meals.json")
-    end
-
-    def create_meal(params)
-      post_call("user/#{user_id}/meals.json", params)
-    end
-
-    def meal(meal_id)
-      get_call("user/#{user_id}/meals/#{meal_id}.json")
-    end
-
-    def update_meal(meal_id, params)
-      post_call("user/#{user_id}/meals/#{meal_id}.json", params)
-    end
-
-    def delete_meal(meal_id)
-      delete_call("user/#{user_id}/meals/#{meal_id}.json")
-    end
-
-    def create_food(params)
-      post_call("user/#{user_id}/foods.json", params)
-    end
-
-    def delete_food(food_id)
-      delete_call("user/#{user_id}/foods/#{food_id}.json")
-    end
-
-    def food(id)
-      get_call("foods/#{id}.json")
-    end
-
-    def food_units
-      get_call('foods/units.json')
-    end
-
-    def search_foods(params)
-      post_call('foods/search.json', params)
-    end
+    FOOD_SERIES_RESOURCES = %w[caloriesIn water].freeze
+    FOOD_SERIES_PERIODS = %w[1d 7d 30d 1w 1m 3m 6m 1y max].freeze
 
     private
+
     def validate_food_series_period(period)
       unless FOOD_SERIES_PERIODS.include?(period)
         raise FitgemOauth2::InvalidArgumentError, "Invalid period: #{period}. Specify a valid period from #{FOOD_SERIES_PERIODS}"
       end
     end
 
-
     def food_series_url(user_id, start_date, end_date_or_period)
       ['user', user_id, 'foods/log/caloriesIn', 'date', start_date, end_date_or_period].join('/') + '.json'
     end

data/lib/fitgem_oauth2/food/collection.rb

@@ -0,0 +1,51 @@
+module FitgemOauth2
+  class Client
+    def food_goals
+      get_call("user/#{user_id}/foods/log/goal.json")
+    end
+
+    def food_logs(date)
+      get_call("user/#{user_id}/foods/log/date/#{format_date(date)}.json")
+    end
+
+    def water_logs(date)
+      get_call("user/#{user_id}/foods/log/water/date/#{format_date(date)}.json")
+    end
+
+    def water_goal
+      get_call("user/#{user_id}/foods/log/water/goal.json")
+    end
+
+    def log_food(params)
+      post_call("user/#{user_id}/foods/log.json", params)
+    end
+
+    def update_food_log(food_log_id, params)
+      post_call("user/#{user_id}/foods/log/#{food_log_id}.json", params)
+    end
+
+    def log_water(params)
+      post_call("user/#{user_id}/foods/log/water.json", params)
+    end
+
+    def update_food_goal(params)
+      post_call("user/#{user_id}/foods/log/goal.json", params)
+    end
+
+    def update_water_goal(params)
+      post_call("user/#{user_id}/foods/log/water/goal.json", params)
+    end
+
+    def delete_food_log(food_log_id)
+      delete_call("user/#{user_id}/foods/log/#{food_log_id}.json")
+    end
+
+    def update_water_log(water_log_id, params)
+      post_call("user/#{user_id}/foods/log/water/#{water_log_id}.json", params)
+    end
+
+    def delete_water_log(water_log_id)
+      delete_call("user/#{user_id}/foods/log/water/#{water_log_id}.json")
+    end
+  end
+end

data/lib/fitgem_oauth2/food/metadata.rb

@@ -0,0 +1,63 @@
+module FitgemOauth2
+  class Client
+    def add_favorite_food(food_id)
+      post_call("user/#{user_id}/foods/log/favorite/#{food_id}.json")
+    end
+
+    def delete_favorite_food(food_id)
+      delete_call("user/#{user_id}/foods/log/favorite/#{food_id}.json")
+    end
+
+    def recent_foods
+      get_call("user/#{user_id}/foods/recent.json")
+    end
+
+    def favorite_foods
+      get_call("user/#{user_id}/foods/log/favorite.json")
+    end
+
+    def frequent_foods
+      get_call("user/#{user_id}/foods/log/frequent.json")
+    end
+
+    def meals
+      get_call("user/#{user_id}/meals.json")
+    end
+
+    def create_meal(params)
+      post_call("user/#{user_id}/meals.json", params)
+    end
+
+    def meal(meal_id)
+      get_call("user/#{user_id}/meals/#{meal_id}.json")
+    end
+
+    def update_meal(meal_id, params)
+      post_call("user/#{user_id}/meals/#{meal_id}.json", params)
+    end
+
+    def delete_meal(meal_id)
+      delete_call("user/#{user_id}/meals/#{meal_id}.json")
+    end
+
+    def create_food(params)
+      post_call("user/#{user_id}/foods.json", params)
+    end
+
+    def delete_food(food_id)
+      delete_call("user/#{user_id}/foods/#{food_id}.json")
+    end
+
+    def food(id)
+      get_call("foods/#{id}.json")
+    end
+
+    def food_units
+      get_call('foods/units.json')
+    end
+
+    def search_foods(params)
+      post_call('foods/search.json', params)
+    end
+  end
+end

data/lib/fitgem_oauth2/food/series.rb

@@ -0,0 +1,55 @@
+module FitgemOauth2
+  class Client
+    def food_series_for_date_range(start_date, end_date)
+      validate_start_date(start_date)
+      validate_end_date(end_date)
+      get_call(food_series_url(user_id, format_date(start_date), format_date(end_date)))
+    end
+
+    def food_series_for_period(start_date, period)
+      validate_start_date(start_date)
+      validate_food_series_period(period)
+      get_call(food_series_url(user_id, format_date(start_date), period))
+    end
+
+    def water_series_for_date_range(start_date, end_date)
+      validate_start_date(start_date)
+      validate_end_date(end_date)
+      get_call(water_series_url(user_id, format_date(start_date), format_date(end_date)))
+    end
+
+    def water_series_for_period(start_date, period)
+      validate_start_date(start_date)
+      validate_food_series_period(period)
+      get_call(water_series_url(user_id, format_date(start_date), period))
+    end
+
+    def food_series(resource: nil, start_date: nil, end_date: nil, period: nil)
+      warn '[DEPRECATED] use `food_series_for_date_range`, `food_series_for_period`, `water_series_for_date_range`, or `water_series_for_period` instead.'
+      unless FOOD_SERIES_RESOURCES.include?(resource)
+        raise FitgemOauth2::InvalidArgumentError, "Invalid resource: #{resource}. Specify a valid resource from #{FOOD_SERIES_RESOURCES}"
+      end
+
+      if end_date && period
+        raise FitgemOauth2::InvalidArgumentError, 'Provide only one of end_date and period.'
+      end
+
+      if !end_date && !period
+        raise FitgemOauth2::InvalidArgumentError, 'Provide at least one of end_date and period.'
+      end
+
+      url = ['user', user_id, 'foods/log', resource, 'date', start_date].join('/')
+
+      if period
+        unless FOOD_SERIES_PERIODS.include?(period)
+          raise FitgemOauth2::InvalidArgumentError, "Invalid period: #{period}. Specify a valid period from #{FOOD_SERIES_PERIODS}"
+        end
+      end
+
+      second = period || format_date(end_date)
+      url = [url, second].join('/')
+
+      get_call(url + '.json')
+    end
+  end
+end

data/lib/fitgem_oauth2/heartrate.rb

@@ -1,8 +1,8 @@
 module FitgemOauth2
   class Client
 
-    HR_PERIODS = %w(1d 7d 30d 1w 1m)
-    HR_DETAIL_LEVELS = %w(1sec 1min)
+    HR_PERIODS = %w[1d 7d 30d 1w 1m].freeze
+    HR_DETAIL_LEVELS = %w[1sec 1min].freeze
 
     def hr_series_for_date_range(start_date, end_date)
       validate_start_date(start_date)
@@ -22,7 +22,7 @@ module FitgemOauth2
 
     # retrieve heartrate time series
     def heartrate_time_series(start_date: nil, end_date: nil, period: nil)
-      warn "[DEPRECATION] `heartrate_time_series` is deprecated.  Please use `hr_series_for_date_range` or `hr_series_for_period` instead."
+      warn '[DEPRECATION] `heartrate_time_series` is deprecated.  Please use `hr_series_for_date_range` or `hr_series_for_period` instead.'
 
       regular_time_series_guard(
         start_date: start_date,
@@ -59,39 +59,27 @@ module FitgemOauth2
     end
 
     private
+
     def validate_hr_period(period)
-      unless period && HR_PERIODS.include?(period)
-        raise FitgemOauth2::InvalidArgumentError, "Invalid period: #{period}. Valid periods are #{HR_PERIODS}."
-      end
+      raise FitgemOauth2::InvalidArgumentError, "Invalid period: #{period}. Valid periods are #{HR_PERIODS}." unless period && HR_PERIODS.include?(period)
     end
 
     def regular_time_series_guard(start_date:, end_date:, period:)
       validate_start_date(start_date)
 
-      if end_date && period
-        raise FitgemOauth2::InvalidArgumentError, 'Both end_date and period specified. Specify only one.'
-      end
+      raise FitgemOauth2::InvalidArgumentError, 'Both end_date and period specified. Specify only one.' if end_date && period
 
-      if !end_date && !period
-        raise FitgemOauth2::InvalidArgumentError, 'Neither end_date nor period specified. Specify at least one.'
-      end
+      raise FitgemOauth2::InvalidArgumentError, 'Neither end_date nor period specified. Specify at least one.' if !end_date && !period
 
       validate_hr_period(period) if period
     end
 
-
     def intraday_series_guard(start_date:, end_date:, detail_level:, start_time:, end_time:)
-      unless start_date
-        raise FitgemOauth2::InvalidArgumentError, 'Start date not provided.'
-      end
+      raise FitgemOauth2::InvalidArgumentError, 'Start date not provided.' unless  start_date
 
-      unless detail_level && HR_DETAIL_LEVELS.include?(detail_level)
-        raise FitgemOauth2::InvalidArgumentError, "Please specify the defail level. Detail level should be one of #{HR_DETAIL_LEVELS}."
-      end
+      raise FitgemOauth2::InvalidArgumentError, "Please specify the defail level. Detail level should be one of #{HR_DETAIL_LEVELS}." unless detail_level && HR_DETAIL_LEVELS.include?(detail_level)
 
-      if (start_time && !end_time) || (end_time && !start_time)
-        raise FitgemOauth2::InvalidArgumentError, 'Either specify both the start_time and end_time or specify neither.'
-      end
+      raise FitgemOauth2::InvalidArgumentError, 'Either specify both the start_time and end_time or specify neither.' if (start_time && !end_time) || (end_time && !start_time)
     end
   end
 end

data/lib/fitgem_oauth2/sleep.rb

@@ -2,8 +2,12 @@ module FitgemOauth2
 
   class Client
 
-    SLEEP_RESOURCES = %w(startTime  timeInBed  minutesAsleep  awakeningsCount  minutesAwake  minutesToFallAsleep  minutesAfterWakeup  efficiency)
-    SLEEP_PERIODS = %w(1d 7d 30d 1w 1m 3m 6m 1y max)
+    SLEEP_RESOURCES = %w[
+      startTime timeInBed minutesAsleep awakeningsCount minutesAwake
+      minutesToFallAsleep minutesAfterWakeup efficiency
+    ].freeze
+
+    SLEEP_PERIODS = %w[1d 7d 30d 1w 1m 3m 6m 1y max].freeze
 
     # retrieve sleep logs for a date
     # @param date date for which sleep logs needs to be accessed
@@ -17,9 +21,9 @@ module FitgemOauth2
 
     def sleep_logs_list(date, sort, limit)
       date_param = format_date(date)
-      if sort == "asc"
+      if sort == 'asc'
         date_param = "afterDate=#{date_param}"
-      elsif sort == "desc"
+      elsif sort == 'desc'
         date_param = "beforeDate=#{date_param}"
       else
         raise FitgemOauth2::InvalidArgumentError, "sort can either be asc or desc"

data/lib/fitgem_oauth2/subscriptions.rb

@@ -1,7 +1,7 @@
 module FitgemOauth2
   class Client
 
-    SUBSCRIBABLE_TYPES = [:sleep, :body, :activities, :foods, :all]
+    SUBSCRIBABLE_TYPES = %i[sleep body activities foods all].freeze
 
     def subscriptions(opts)
       get_call(subscription_url(opts))
@@ -18,15 +18,15 @@ module FitgemOauth2
     protected
 
     def subscription_url(opts)
-      type = opts[ :type ] || :all
+      type = opts[:type] || :all
       subscription_id = opts[:subscription_id]
 
-      url = [ 'user', user_id ]
+      url = ['user', user_id]
       url << type unless type == :all
       url << 'apiSubscriptions'
       url << subscription_id if subscription_id
 
-      return url.join('/') + '.json'
+      url.join('/') + '.json'
     end
   end
-end
+end

data/lib/fitgem_oauth2/users.rb

@@ -1,6 +1,6 @@
 module FitgemOauth2
   class Client
-    def user_info()
+    def user_info
       get_call("user/#{user_id}/profile.json")
     end
   end

data/lib/fitgem_oauth2/utils.rb

@@ -1,18 +1,16 @@
 module FitgemOauth2
   class Client
-
     def format_date(date)
-      if !date
-        return nil
-      end
 
-      valid_semantic_date = %w(today yesterday).include? date
-      valid_date_string = ((date =~ /\d{4}\-\d{2}\-\d{2}/) == 0)
+      return nil if date.nil?
+
+      valid_semantic_date = %w[today yesterday].include? date
+      valid_date_string = (date =~ /\d{4}\-\d{2}\-\d{2}/) == 0
       if valid_date_string
         date
       elsif valid_semantic_date
         date_from_semantic(date)
-      elsif Date === date || Time === date || DateTime === date
+      elsif date.is_a?(Date) || date.is_a?(Time) || date.is_a?(DateTime)
         date.strftime('%Y-%m-%d')
       else
         raise FitgemOauth2::InvalidDateArgument, "Date used must be a date/time object or a string in the format YYYY-MM-DD; supplied argument is a #{date.class}"
@@ -20,9 +18,9 @@ module FitgemOauth2
     end
 
     def format_time(time)
-      if ( (time =~ /\d{2}:\d{2}/) == 0)
+      if (time =~ /\d{2}:\d{2}/) == 0
         time
-      elsif DateTime === time || Time === time
+      elsif time.is_a?(DateTime) || time.is_a?(Time)
         time.strftime('%H:%M')
       else
         raise FitgemOauth2::InvalidTimeArgument, "Time used must be a DateTime/Time object or a string in the format hh:mm; supplied argument is a #{time.class}"
@@ -30,21 +28,18 @@ module FitgemOauth2
     end
 
     def validate_start_date(start_date)
-      unless start_date
-        raise FitgemOauth2::InvalidArgumentError, 'Please specify a valid start date.'
-      end
+      raise FitgemOauth2::InvalidArgumentError, 'Please specify a valid start date.' unless start_date
     end
 
     def validate_end_date(end_date)
-      unless end_date
-        raise FitgemOauth2::InvalidArgumentError, 'Please specify a valid end date.'
-      end
+      raise FitgemOauth2::InvalidArgumentError, 'Please specify a valid end date.' unless end_date
     end
 
     private
+
     def date_from_semantic(semantic)
       if semantic === 'yesterday'
-        (Date.today-1).strftime('%Y-%m-%d')
+        (Date.today - 1).strftime('%Y-%m-%d')
       elsif semantic == 'today'
         Date.today.strftime('%Y-%m-%d')
       end

data/lib/fitgem_oauth2/version.rb

@@ -1,3 +1,3 @@
 module FitgemOauth2
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fitgem_oauth2
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Ankit Gupta
@@ -80,6 +80,9 @@ files:
 - lib/fitgem_oauth2/devices.rb
 - lib/fitgem_oauth2/errors.rb
 - lib/fitgem_oauth2/food.rb
+- lib/fitgem_oauth2/food/collection.rb
+- lib/fitgem_oauth2/food/metadata.rb
+- lib/fitgem_oauth2/food/series.rb
 - lib/fitgem_oauth2/friends.rb
 - lib/fitgem_oauth2/heartrate.rb
 - lib/fitgem_oauth2/sleep.rb
@@ -107,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Fitbit API client library