fitgem_oauth2 1.3.0 → 2.0.1

data/lib/fitgem_oauth2/friends.rb

@@ -1,44 +1,44 @@
-module FitgemOauth2
-  class Client
-    # retrieves list of friends for the current user
-    def friends
-      get_call("user/#{user_id}/friends.json")
-    end
-
-    # retrieves leaderboard for the user
-    def friends_leaderboard
-      get_call("user/#{user_id}/friends/leaderboard.json")
-    end
-
-    # ==================================
-    #   Friend Invitations
-    # ==================================
-
-    # send an invitation to a friend
-    # @param params POST parameters for sending friend invite.
-    def invite_friend(params)
-      post_call("user/#{user_id}/friends/invitations.json", params)
-    end
-
-    # retrieve list of friend invitations
-    def friend_invitations
-      get_call("user/#{user_id}/friends/invitations.json")
-    end
-
-    # respond to a friend invite
-    # @param from_user_id the ID of the friend
-    # @param params POST parameters for responding to the invite.
-    def respond_to_invitation(from_user_id, params)
-      post_call("user/#{user_id}/friends/invitations/#{from_user_id}.json", params)
-    end
-
-    # ==================================
-    #   Badges
-    # ==================================
-
-    # retrieve badges for the user
-    def badges
-      get_call("user/#{user_id}/badges.json")
-    end
-  end
-end
+module FitgemOauth2
+  class Client
+    # retrieves list of friends for the current user
+    def friends
+      get_call("user/#{user_id}/friends.json")
+    end
+
+    # retrieves leaderboard for the user
+    def friends_leaderboard
+      get_call("user/#{user_id}/friends/leaderboard.json")
+    end
+
+    # ==================================
+    #   Friend Invitations
+    # ==================================
+
+    # send an invitation to a friend
+    # @param params POST parameters for sending friend invite.
+    def invite_friend(params)
+      post_call("user/#{user_id}/friends/invitations.json", params)
+    end
+
+    # retrieve list of friend invitations
+    def friend_invitations
+      get_call("user/#{user_id}/friends/invitations.json")
+    end
+
+    # respond to a friend invite
+    # @param from_user_id the ID of the friend
+    # @param params POST parameters for responding to the invite.
+    def respond_to_invitation(from_user_id, params)
+      post_call("user/#{user_id}/friends/invitations/#{from_user_id}.json", params)
+    end
+
+    # ==================================
+    #   Badges
+    # ==================================
+
+    # retrieve badges for the user
+    def badges
+      get_call("user/#{user_id}/badges.json")
+    end
+  end
+end

data/lib/fitgem_oauth2/heartrate.rb

@@ -1,85 +1,85 @@
-module FitgemOauth2
-  class Client
-
-    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)
-      validate_end_date(end_date)
-
-      url = ['user', user_id, 'activities/heart/date', format_date(start_date), format_date(end_date)].join('/')
-      get_call(url + '.json')
-    end
-
-    def hr_series_for_period(start_date, period)
-      validate_start_date(start_date)
-      validate_hr_period(period)
-
-      url = ['user', user_id, 'activities/heart/date', format_date(start_date), period].join('/')
-      get_call(url + '.json')
-    end
-
-    # 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.'
-
-      regular_time_series_guard(
-        start_date: start_date,
-        end_date: end_date,
-        period: period
-      )
-
-      second = period || format_date(end_date)
-
-      url = ['user', user_id, 'activities/heart/date', format_date(start_date), second].join('/')
-
-      get_call(url + '.json')
-    end
-
-    # retrieve intraday series for heartrate
-    def intraday_heartrate_time_series(start_date: nil, end_date: nil, detail_level: nil, start_time: nil, end_time: nil)
-      intraday_series_guard(
-        start_date: start_date,
-        end_date: end_date,
-        detail_level: detail_level,
-        start_time: start_time,
-        end_time: end_time
-      )
-
-      end_date = format_date(end_date) || '1d'
-
-      url = ['user', user_id, 'activities/heart/date', format_date(start_date), end_date, detail_level].join('/')
-
-      if start_time && end_time
-        url = [url, 'time', format_time(start_time), format_time(end_time)].join('/')
-      end
-
-      get_call(url + '.json')
-    end
-
-    private
-
-    def validate_hr_period(period)
-      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)
-
-      raise FitgemOauth2::InvalidArgumentError, 'Both end_date and period specified. Specify only one.' if end_date && period
-
-      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:)
-      raise FitgemOauth2::InvalidArgumentError, 'Start date not provided.' unless  start_date
-
-      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)
-
-      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
+module FitgemOauth2
+  class Client
+
+    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)
+      validate_end_date(end_date)
+
+      url = ['user', user_id, 'activities/heart/date', format_date(start_date), format_date(end_date)].join('/')
+      get_call(url + '.json')
+    end
+
+    def hr_series_for_period(start_date, period)
+      validate_start_date(start_date)
+      validate_hr_period(period)
+
+      url = ['user', user_id, 'activities/heart/date', format_date(start_date), period].join('/')
+      get_call(url + '.json')
+    end
+
+    # 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.'
+
+      regular_time_series_guard(
+        start_date: start_date,
+        end_date: end_date,
+        period: period
+      )
+
+      second = period || format_date(end_date)
+
+      url = ['user', user_id, 'activities/heart/date', format_date(start_date), second].join('/')
+
+      get_call(url + '.json')
+    end
+
+    # retrieve intraday series for heartrate
+    def intraday_heartrate_time_series(start_date: nil, end_date: nil, detail_level: nil, start_time: nil, end_time: nil)
+      intraday_series_guard(
+        start_date: start_date,
+        end_date: end_date,
+        detail_level: detail_level,
+        start_time: start_time,
+        end_time: end_time
+      )
+
+      end_date = format_date(end_date) || '1d'
+
+      url = ['user', user_id, 'activities/heart/date', format_date(start_date), end_date, detail_level].join('/')
+
+      if start_time && end_time
+        url = [url, 'time', format_time(start_time), format_time(end_time)].join('/')
+      end
+
+      get_call(url + '.json')
+    end
+
+    private
+
+    def validate_hr_period(period)
+      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)
+
+      raise FitgemOauth2::InvalidArgumentError, 'Both end_date and period specified. Specify only one.' if end_date && period
+
+      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:)
+      raise FitgemOauth2::InvalidArgumentError, 'Start date not provided.' unless  start_date
+
+      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)
+
+      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

@@ -1,86 +1,86 @@
-module FitgemOauth2
-
-  class Client
-
-    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
-    def sleep_logs(date)
-      get_call_1_2("user/#{user_id}/sleep/date/#{format_date(date)}.json")
-    end
-
-    def sleep_logs_by_date_range(start_date, end_date)
-      get_call_1_2("user/#{user_id}/sleep/date/#{format_date(start_date)}/#{format_date(end_date)}.json")
-    end
-
-    def sleep_logs_list(date, sort, limit)
-      date_param = format_date(date)
-      if sort == 'asc'
-        date_param = "afterDate=#{date_param}"
-      elsif sort == 'desc'
-        date_param = "beforeDate=#{date_param}"
-      else
-        raise FitgemOauth2::InvalidArgumentError, "sort can either be asc or desc"
-      end
-      get_call_1_2("user/#{user_id}/sleep/list.json?#{date_param}&offset=0&sort=#{sort}&limit=#{limit}")
-    end
-
-    # retrieve sleep goal for the user
-    def sleep_goal
-      get_call("user/#{user_id}/sleep/goal.json")
-    end
-
-    # update sleep goal
-    # @param params POST parameters for updating sleep goal
-    def update_sleep_goal(params)
-      post_call("user/#{user_id}/sleep/goal.json", params)
-    end
-
-    # retrieve time series data for sleep
-    # @param resource sleep resource to be requested
-    # @param start_date starting date for sleep time series
-    # @param end_date ending date for sleep time series
-    # @param period period for sleep time series
-    def sleep_time_series(resource: nil, start_date: nil, end_date: nil, period: nil)
-      unless start_date
-        raise FitgemOauth2::InvalidArgumentError, 'Start date not provided.'
-      end
-
-      unless resource && SLEEP_RESOURCES.include?(resource)
-        raise FitgemOauth2::InvalidArgumentError, "Invalid resource: #{resource}. Valid resources are #{SLEEP_RESOURCES}."
-      end
-
-      if period && end_date
-        raise FitgemOauth2::InvalidArgumentError, 'Both end_date and period specified. Specify only one.'
-      end
-
-      if period && !SLEEP_PERIODS.include?(period)
-        raise FitgemOauth2::InvalidArgumentError, "Invalid period: #{period}. Valid periods are #{SLEEP_PERIODS}."
-      end
-
-      second = period || format_date(end_date)
-
-      url = ['user', user_id, 'sleep', resource, 'date', format_date(start_date), second].join('/')
-
-      get_call(url + '.json')
-    end
-
-    # log sleep
-    # @param params POST params for creating sleep log
-    def log_sleep(params)
-      post_call_1_2("user/#{user_id}/sleep.json", params)
-    end
-
-    # deleted sleep log
-    # @param log_id ID of the sleep log that needs to be removed.
-    def delete_logged_sleep(log_id)
-      delete_call("user/#{user_id}/sleep/#{log_id}.json")
-    end
-  end
-end
+module FitgemOauth2
+
+  class Client
+
+    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
+    def sleep_logs(date)
+      get_call_1_2("user/#{user_id}/sleep/date/#{format_date(date)}.json")
+    end
+
+    def sleep_logs_by_date_range(start_date, end_date)
+      get_call_1_2("user/#{user_id}/sleep/date/#{format_date(start_date)}/#{format_date(end_date)}.json")
+    end
+
+    def sleep_logs_list(date, sort, limit)
+      date_param = format_date(date)
+      if sort == 'asc'
+        date_param = "afterDate=#{date_param}"
+      elsif sort == 'desc'
+        date_param = "beforeDate=#{date_param}"
+      else
+        raise FitgemOauth2::InvalidArgumentError, "sort can either be asc or desc"
+      end
+      get_call_1_2("user/#{user_id}/sleep/list.json?#{date_param}&offset=0&sort=#{sort}&limit=#{limit}")
+    end
+
+    # retrieve sleep goal for the user
+    def sleep_goal
+      get_call("user/#{user_id}/sleep/goal.json")
+    end
+
+    # update sleep goal
+    # @param params POST parameters for updating sleep goal
+    def update_sleep_goal(params)
+      post_call("user/#{user_id}/sleep/goal.json", params)
+    end
+
+    # retrieve time series data for sleep
+    # @param resource sleep resource to be requested
+    # @param start_date starting date for sleep time series
+    # @param end_date ending date for sleep time series
+    # @param period period for sleep time series
+    def sleep_time_series(resource: nil, start_date: nil, end_date: nil, period: nil)
+      unless start_date
+        raise FitgemOauth2::InvalidArgumentError, 'Start date not provided.'
+      end
+
+      unless resource && SLEEP_RESOURCES.include?(resource)
+        raise FitgemOauth2::InvalidArgumentError, "Invalid resource: #{resource}. Valid resources are #{SLEEP_RESOURCES}."
+      end
+
+      if period && end_date
+        raise FitgemOauth2::InvalidArgumentError, 'Both end_date and period specified. Specify only one.'
+      end
+
+      if period && !SLEEP_PERIODS.include?(period)
+        raise FitgemOauth2::InvalidArgumentError, "Invalid period: #{period}. Valid periods are #{SLEEP_PERIODS}."
+      end
+
+      second = period || format_date(end_date)
+
+      url = ['user', user_id, 'sleep', resource, 'date', format_date(start_date), second].join('/')
+
+      get_call(url + '.json')
+    end
+
+    # log sleep
+    # @param params POST params for creating sleep log
+    def log_sleep(params)
+      post_call_1_2("user/#{user_id}/sleep.json", params)
+    end
+
+    # deleted sleep log
+    # @param log_id ID of the sleep log that needs to be removed.
+    def delete_logged_sleep(log_id)
+      delete_call("user/#{user_id}/sleep/#{log_id}.json")
+    end
+  end
+end

data/lib/fitgem_oauth2/subscriptions.rb

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