fitgem_oauth2 1.3.0 → 2.0.1

data/lib/fitgem_oauth2/body_measurements.rb

@@ -1,163 +1,163 @@
-module FitgemOauth2
-  class Client
-    FAT_PERIODS = %w(1d 7d 1w 1m)
-    WEIGHT_PERIODS = %w(1d 7d 30d 1w 1m)
-    BODY_GOALS = %w(fat weight)
-    BODY_TIME_SERIES_PERIODS = %w(1d 7d 30d 1w 1m 3m 6m 1y max)
-
-    # ======================================
-    #      Boday Fat
-    # ======================================
-
-    # retrieves a list of all user's body fat log entries
-    # note: provide either end_date or period
-    # @param start_date start date for the logs
-    # @param end_date (optional)end date for the logs
-    # @param period (optional) period for the logs
-    def body_fat_logs(start_date: nil, end_date: nil, period: nil)
-      unless start_date
-        raise FitgemOauth2::InvalidArgumentError, 'must specify start_date'
-      end
-      url = ['user', user_id, 'body/log/fat/date', format_date(start_date)].join('/')
-      if end_date
-        url = [url, format_date(end_date)].join('/')
-      end
-
-      if period
-        if FAT_PERIODS.include?(period)
-          url = [url, period].join('/')
-        else
-          raise FitgemOauth2::InvalidArgumentError, "period must be one in #{FAT_PERIODS}"
-        end
-      end
-
-      url = url + '.json'
-
-      get_call(url)
-    end
-
-    # logs body fat
-    # @param params POST parameters for logging body fat
-    def log_body_fat(params)
-      post_call("user/#{user_id}/body/log/fat.json", params)
-    end
-
-    # delete logged body fat
-    # @param id ID of the log to be deleted.
-    def delete_logged_body_fat(id)
-      delete_call("user/#{user_id}/body/log/fat/#{id}.json")
-    end
-
-
-    # ==================================
-    #   Body Time Series
-    # ==================================
-
-    # retrieve body time series for the user; provide at least one of end_date and period
-    # @param resource (required)the resource requested ['bmi', 'fat', or 'weight']
-    # @param start_date (required)the start date for the series
-    # @param end_date (optional)the end date for the series
-    # @param period (optional)period for the time series. valid periods are BODY_TIME_SERIES_PERIODS
-    def body_time_series(resource: nil, start_date: nil, end_date: nil, period: nil)
-      unless resource && start_date
-        raise FitgemOauth2::InvalidArgumentError, 'resource and start_date are required parameters. Please specify both.'
-      end
-
-      url = ['user', user_id, 'body', resource, 'date', format_date(start_date)].join('/')
-
-      second = ''
-      if end_date && period
-        raise FitgemOauth2::InvalidArgumentError, 'Please specify either period or end date, not both.'
-      end
-
-      if period
-        if BODY_TIME_SERIES_PERIODS.include?(period)
-          second = period
-        else
-          raise FitgemOauth2::InvalidArgumentError, "Invalid Period. Body time series period must be in #{BODY_TIME_SERIES_PERIODS}"
-        end
-      end
-
-      if end_date
-        second = format_date(end_date)
-      end
-
-      url = [url, second].join('/')
-
-      get_call(url + '.json')
-    end
-
-
-    # ======================================
-    #      Body Goals
-    # ======================================
-
-    # retrieves body goals based on the type specified
-    # @param type 'fat' or 'weight'
-    def body_goals(type)
-      if type && BODY_GOALS.include?(type)
-        get_call("user/#{user_id}/body/log/#{type}/goal.json")
-      else
-        raise FitgemOauth2::InvalidArgumentError, "invalid goal type : #{type}. must be one of #{BODY_GOALS}"
-      end
-    end
-
-    # update body fat goal
-    # @param params POST params for updating body fat goal
-    def update_body_fat_goal(params)
-      post_call("user/#{user_id}/body/log/fat/goal.json", params)
-    end
-
-    # update weight goal
-    # @param params POST params for updating weight goal
-    def update_weight_goal(params)
-      post_call("user/#{user_id}/body/log/weight/goal.json", params)
-    end
-
-    # ======================================
-    #      Body Weight
-    # ======================================
-
-    # retrieve weight logs; specify either the end_date or period
-    # @param start_date start date for the logs
-    # @param end_date (optional)end_date for the logs
-    # @param period (optional)period for the logs
-    def weight_logs(start_date: nil, end_date: nil, period: nil)
-      unless start_date
-        raise FitgemOauth2::InvalidArgumentError, 'start_date not specified.'
-      end
-
-      if period && end_date
-        raise FitgemOauth2::InvalidArgumentError, 'both end_date and period specified. please provide only one.'
-      end
-
-      if period
-        unless WEIGHT_PERIODS.include?(period)
-          raise FitgemOauth2::InvalidArgumentError, "valid period not specified. please choose a period from #{WEIGHT_PERIODS}"
-        end
-      end
-
-      first = format_date(start_date)
-      url = ['user', user_id, 'body/log/weight/date', first].join('/')
-      if period || end_date
-        second = period || format_date(end_date)
-        url = [url, second].join('/')
-      end
-
-      get_call(url + '.json')
-    end
-
-    # logs weight for the user
-    # @param params POST message for logging weight
-    def log_weight(params)
-      post_call("user/#{user_id}/body/log/weight.json", params)
-    end
-
-    # delete logged weight
-    # @param id ID of the weight log to be deleted
-    def delete_logged_weight(id)
-      delete_call("user/#{user_id}/body/log/weight/#{id}.json")
-    end
-
-  end
-end
+module FitgemOauth2
+  class Client
+    FAT_PERIODS = %w(1d 7d 1w 1m)
+    WEIGHT_PERIODS = %w(1d 7d 30d 1w 1m)
+    BODY_GOALS = %w(fat weight)
+    BODY_TIME_SERIES_PERIODS = %w(1d 7d 30d 1w 1m 3m 6m 1y max)
+
+    # ======================================
+    #      Boday Fat
+    # ======================================
+
+    # retrieves a list of all user's body fat log entries
+    # note: provide either end_date or period
+    # @param start_date start date for the logs
+    # @param end_date (optional)end date for the logs
+    # @param period (optional) period for the logs
+    def body_fat_logs(start_date: nil, end_date: nil, period: nil)
+      unless start_date
+        raise FitgemOauth2::InvalidArgumentError, 'must specify start_date'
+      end
+      url = ['user', user_id, 'body/log/fat/date', format_date(start_date)].join('/')
+      if end_date
+        url = [url, format_date(end_date)].join('/')
+      end
+
+      if period
+        if FAT_PERIODS.include?(period)
+          url = [url, period].join('/')
+        else
+          raise FitgemOauth2::InvalidArgumentError, "period must be one in #{FAT_PERIODS}"
+        end
+      end
+
+      url = url + '.json'
+
+      get_call(url)
+    end
+
+    # logs body fat
+    # @param params POST parameters for logging body fat
+    def log_body_fat(params)
+      post_call("user/#{user_id}/body/log/fat.json", params)
+    end
+
+    # delete logged body fat
+    # @param id ID of the log to be deleted.
+    def delete_logged_body_fat(id)
+      delete_call("user/#{user_id}/body/log/fat/#{id}.json")
+    end
+
+
+    # ==================================
+    #   Body Time Series
+    # ==================================
+
+    # retrieve body time series for the user; provide at least one of end_date and period
+    # @param resource (required)the resource requested ['bmi', 'fat', or 'weight']
+    # @param start_date (required)the start date for the series
+    # @param end_date (optional)the end date for the series
+    # @param period (optional)period for the time series. valid periods are BODY_TIME_SERIES_PERIODS
+    def body_time_series(resource: nil, start_date: nil, end_date: nil, period: nil)
+      unless resource && start_date
+        raise FitgemOauth2::InvalidArgumentError, 'resource and start_date are required parameters. Please specify both.'
+      end
+
+      url = ['user', user_id, 'body', resource, 'date', format_date(start_date)].join('/')
+
+      second = ''
+      if end_date && period
+        raise FitgemOauth2::InvalidArgumentError, 'Please specify either period or end date, not both.'
+      end
+
+      if period
+        if BODY_TIME_SERIES_PERIODS.include?(period)
+          second = period
+        else
+          raise FitgemOauth2::InvalidArgumentError, "Invalid Period. Body time series period must be in #{BODY_TIME_SERIES_PERIODS}"
+        end
+      end
+
+      if end_date
+        second = format_date(end_date)
+      end
+
+      url = [url, second].join('/')
+
+      get_call(url + '.json')
+    end
+
+
+    # ======================================
+    #      Body Goals
+    # ======================================
+
+    # retrieves body goals based on the type specified
+    # @param type 'fat' or 'weight'
+    def body_goals(type)
+      if type && BODY_GOALS.include?(type)
+        get_call("user/#{user_id}/body/log/#{type}/goal.json")
+      else
+        raise FitgemOauth2::InvalidArgumentError, "invalid goal type : #{type}. must be one of #{BODY_GOALS}"
+      end
+    end
+
+    # update body fat goal
+    # @param params POST params for updating body fat goal
+    def update_body_fat_goal(params)
+      post_call("user/#{user_id}/body/log/fat/goal.json", params)
+    end
+
+    # update weight goal
+    # @param params POST params for updating weight goal
+    def update_weight_goal(params)
+      post_call("user/#{user_id}/body/log/weight/goal.json", params)
+    end
+
+    # ======================================
+    #      Body Weight
+    # ======================================
+
+    # retrieve weight logs; specify either the end_date or period
+    # @param start_date start date for the logs
+    # @param end_date (optional)end_date for the logs
+    # @param period (optional)period for the logs
+    def weight_logs(start_date: nil, end_date: nil, period: nil)
+      unless start_date
+        raise FitgemOauth2::InvalidArgumentError, 'start_date not specified.'
+      end
+
+      if period && end_date
+        raise FitgemOauth2::InvalidArgumentError, 'both end_date and period specified. please provide only one.'
+      end
+
+      if period
+        unless WEIGHT_PERIODS.include?(period)
+          raise FitgemOauth2::InvalidArgumentError, "valid period not specified. please choose a period from #{WEIGHT_PERIODS}"
+        end
+      end
+
+      first = format_date(start_date)
+      url = ['user', user_id, 'body/log/weight/date', first].join('/')
+      if period || end_date
+        second = period || format_date(end_date)
+        url = [url, second].join('/')
+      end
+
+      get_call(url + '.json')
+    end
+
+    # logs weight for the user
+    # @param params POST message for logging weight
+    def log_weight(params)
+      post_call("user/#{user_id}/body/log/weight.json", params)
+    end
+
+    # delete logged weight
+    # @param id ID of the weight log to be deleted
+    def delete_logged_weight(id)
+      delete_call("user/#{user_id}/body/log/weight/#{id}.json")
+    end
+
+  end
+end

data/lib/fitgem_oauth2/client.rb

@@ -1,125 +1,126 @@
-require 'fitgem_oauth2/activity.rb'
-require 'fitgem_oauth2/body_measurements.rb'
-require 'fitgem_oauth2/devices.rb'
-require 'fitgem_oauth2/errors.rb'
-require 'fitgem_oauth2/food.rb'
-require 'fitgem_oauth2/friends.rb'
-require 'fitgem_oauth2/heartrate.rb'
-require 'fitgem_oauth2/sleep.rb'
-require 'fitgem_oauth2/subscriptions.rb'
-require 'fitgem_oauth2/users.rb'
-require 'fitgem_oauth2/utils.rb'
-require 'fitgem_oauth2/version.rb'
-
-require 'base64'
-require 'faraday'
-
-module FitgemOauth2
-  class Client
-
-    DEFAULT_USER_ID = '-'
-    API_VERSION = '1'
-
-    attr_reader :client_id
-    attr_reader :client_secret
-    attr_reader :token
-    attr_reader :user_id
-    attr_reader :unit_system
-
-    def initialize(opts)
-      missing = [:client_id, :client_secret, :token] - opts.keys
-      if missing.size > 0
-        raise FitgemOauth2::InvalidArgumentError, "Missing required options: #{missing.join(',')}"
-      end
-
-      @client_id = opts[:client_id]
-      @client_secret = opts[:client_secret]
-      @token = opts[:token]
-      @user_id = (opts[:user_id] || DEFAULT_USER_ID)
-      @unit_system = opts[:unit_system]
-      @connection = Faraday.new('https://api.fitbit.com')
-    end
-
-    def refresh_access_token(refresh_token)
-      response = connection.post('/oauth2/token') do |request|
-        encoded = Base64.strict_encode64("#{@client_id}:#{@client_secret}")
-        request.headers['Authorization'] = "Basic #{encoded}"
-        request.headers['Content-Type'] = 'application/x-www-form-urlencoded'
-        request.params['grant_type'] = 'refresh_token'
-        request.params['refresh_token'] = refresh_token
-      end
-      JSON.parse(response.body)
-    end
-
-    def get_call(url)
-      url = "#{API_VERSION}/#{url}"
-      response = connection.get(url) { |request| set_headers(request) }
-      parse_response(response)
-    end
-
-    # This method is a helper method (like get_call) for 1.2 version of the API_VERSION
-    # This method is needed because Fitbit API supports both versions as of current
-    # date (Nov 5, 2017)
-    def get_call_1_2(url)
-      url = "1.2/#{url}"
-      response = connection.get(url) {|request| set_headers(request)}
-      parse_response(response)
-    end
-
-    def post_call(url, params = {})
-      url = "#{API_VERSION}/#{url}"
-      response = connection.post(url, params) { |request| set_headers(request) }
-      parse_response(response)
-    end
-
-    def post_call_1_2(url, params = {})
-      url = "1.2/#{url}"
-      response = connection.post(url, params) { |request| set_headers(request) }
-      parse_response(response)
-    end
-
-    def delete_call(url)
-      url = "#{API_VERSION}/#{url}"
-      response = connection.delete(url) { |request| set_headers(request) }
-      parse_response(response)
-    end
-
-    private
-    attr_reader :connection
-
-    def set_headers(request)
-      request.headers['Authorization'] = "Bearer #{token}"
-      request.headers['Content-Type'] = 'application/x-www-form-urlencoded'
-      request.headers['Accept-Language'] = unit_system unless unit_system == nil
-    end
-
-    def parse_response(response)
-      headers_to_keep = %w(fitbit-rate-limit-limit fitbit-rate-limit-remaining fitbit-rate-limit-reset)
-
-      error_handler = {
-          200 => lambda {
-            body = JSON.parse(response.body)
-            body = {body: body} if body.is_a?(Array)
-            headers = response.headers.to_hash.keep_if { |k,v|
-              headers_to_keep.include? k
-            }
-            body.merge!(headers)
-          },
-          201 => lambda { },
-          204 => lambda { },
-          400 => lambda { raise FitgemOauth2::BadRequestError },
-          401 => lambda { raise FitgemOauth2::UnauthorizedError },
-          403 => lambda { raise FitgemOauth2::ForbiddenError },
-          404 => lambda { raise FitgemOauth2::NotFoundError },
-          500..599 => lambda { raise FitgemOauth2::ServerError }
-      }
-
-      fn = error_handler.detect { |k, _| k === response.status }
-      if fn === nil
-        raise StandardError, "Unexpected response status #{response.status}"
-      else
-        fn.last.call
-      end
-    end
-  end
-end
+require 'fitgem_oauth2/activity.rb'
+require 'fitgem_oauth2/body_measurements.rb'
+require 'fitgem_oauth2/devices.rb'
+require 'fitgem_oauth2/errors.rb'
+require 'fitgem_oauth2/food.rb'
+require 'fitgem_oauth2/friends.rb'
+require 'fitgem_oauth2/heartrate.rb'
+require 'fitgem_oauth2/sleep.rb'
+require 'fitgem_oauth2/subscriptions.rb'
+require 'fitgem_oauth2/users.rb'
+require 'fitgem_oauth2/utils.rb'
+require 'fitgem_oauth2/version.rb'
+
+require 'base64'
+require 'faraday'
+
+module FitgemOauth2
+  class Client
+
+    DEFAULT_USER_ID = '-'
+    API_VERSION = '1'
+
+    attr_reader :client_id
+    attr_reader :client_secret
+    attr_reader :token
+    attr_reader :user_id
+    attr_reader :unit_system
+
+    def initialize(opts)
+      missing = [:client_id, :client_secret, :token] - opts.keys
+      if missing.size > 0
+        raise FitgemOauth2::InvalidArgumentError, "Missing required options: #{missing.join(',')}"
+      end
+
+      @client_id = opts[:client_id]
+      @client_secret = opts[:client_secret]
+      @token = opts[:token]
+      @user_id = (opts[:user_id] || DEFAULT_USER_ID)
+      @unit_system = opts[:unit_system]
+      @connection = Faraday.new('https://api.fitbit.com')
+    end
+
+    def refresh_access_token(refresh_token)
+      response = connection.post('/oauth2/token') do |request|
+        encoded = Base64.strict_encode64("#{@client_id}:#{@client_secret}")
+        request.headers['Authorization'] = "Basic #{encoded}"
+        request.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+        request.params['grant_type'] = 'refresh_token'
+        request.params['refresh_token'] = refresh_token
+      end
+      JSON.parse(response.body)
+    end
+
+    def get_call(url)
+      url = "#{API_VERSION}/#{url}"
+      response = connection.get(url) { |request| set_headers(request) }
+      parse_response(response)
+    end
+
+    # This method is a helper method (like get_call) for 1.2 version of the API_VERSION
+    # This method is needed because Fitbit API supports both versions as of current
+    # date (Nov 5, 2017)
+    def get_call_1_2(url)
+      url = "1.2/#{url}"
+      response = connection.get(url) {|request| set_headers(request)}
+      parse_response(response)
+    end
+
+    def post_call(url, params = {})
+      url = "#{API_VERSION}/#{url}"
+      response = connection.post(url, params) { |request| set_headers(request) }
+      parse_response(response)
+    end
+
+    def post_call_1_2(url, params = {})
+      url = "1.2/#{url}"
+      response = connection.post(url, params) { |request| set_headers(request) }
+      parse_response(response)
+    end
+
+    def delete_call(url)
+      url = "#{API_VERSION}/#{url}"
+      response = connection.delete(url) { |request| set_headers(request) }
+      parse_response(response)
+    end
+
+    private
+    attr_reader :connection
+
+    def set_headers(request)
+      request.headers['Authorization'] = "Bearer #{token}"
+      request.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+      request.headers['Accept-Language'] = unit_system unless unit_system == nil
+    end
+
+    def parse_response(response)
+      headers_to_keep = %w(fitbit-rate-limit-limit fitbit-rate-limit-remaining fitbit-rate-limit-reset)
+
+      error_handler = {
+          200 => lambda {
+            body = JSON.parse(response.body)
+            body = {body: body} if body.is_a?(Array)
+            headers = response.headers.to_hash.keep_if { |k,v|
+              headers_to_keep.include? k
+            }
+            body.merge!(headers)
+          },
+          201 => lambda { },
+          204 => lambda { },
+          400 => lambda { raise FitgemOauth2::BadRequestError },
+          401 => lambda { raise FitgemOauth2::UnauthorizedError },
+          403 => lambda { raise FitgemOauth2::ForbiddenError },
+          404 => lambda { raise FitgemOauth2::NotFoundError },
+          429 => lambda { raise FitgemOauth2::ApiLimitError },
+          500..599 => lambda { raise FitgemOauth2::ServerError }
+      }
+
+      fn = error_handler.detect { |k, _| k === response.status }
+      if fn === nil
+        raise StandardError, "Unexpected response status #{response.status}"
+      else
+        fn.last.call
+      end
+    end
+  end
+end