fitbit_client 0.1.0

data/lib/fitbit_client/error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FitbitClient
+  class Error < StandardError
+    attr_accessor :response
+
+    def initialize(message, response = nil)
+      @message = message
+      @response = response
+    end
+
+    def json_response
+      @json_response ||= JSON.parse(response.body) if response
+    end
+
+    def to_s
+      if response
+        "#{@message}, HTTP_STATUS: #{response.status}, HTTP_BODY: #{response.body}, HTTP_URL: #{response.response.env.url}"
+      else
+        @message.to_s
+      end
+    end
+  end
+end

data/lib/fitbit_client/network/request.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module FitbitClient
+  module Network
+    module Request
+      def get_json(path, params = {}, headers = {})
+        parse_response(get(path, params, headers))
+      end
+
+      def get(path, params = {}, headers = {})
+        request(:get, path, headers: headers, params: params)
+      end
+
+      def post_json(path, params = {}, headers = {})
+        parse_response(post(path, params, headers))
+      end
+
+      def post(path, params = {}, headers = {})
+        request(:post, path, headers: headers, params: params)
+      end
+
+      def delete_json(path, params = {}, headers = {})
+        parse_response(delete(path, params, headers))
+      end
+
+      def delete(path, params = {}, headers = {})
+        request(:delete, path, headers: headers, params: params)
+      end
+
+      def successful_post?(response)
+        response.status == 201 && response.body == '{}'
+      end
+
+      def successful_delete?(response)
+        response.status == 204 && response.body.empty?
+      end
+
+      private
+
+      def request(method, path, opts = {})
+        attempt = 0
+        begin
+          default_request_headers(opts)
+          oauth2_access_token.request(method, path, opts)
+        rescue OAuth2::Error => e # Handle refresh token issue automagically
+          attempt += 1
+          if expired_token_error?(e.response)
+            oauth2_refresh_token!
+            retry if attempt < 2
+          end
+          raise FitbitClient::Error.new('Error during OAuth2 request', e.response)
+        end
+      end
+
+      def default_request_headers(opts)
+        opts[:headers]['User-Agent'] = "FitbitClient v#{::FitbitClient::VERSION}"
+        opts[:headers]['Accept-Language'] = opts.fetch(:language, ::FitbitClient.default_language)
+        opts[:headers]['Accept-Locale'] = opts.fetch(:locale, ::FitbitClient.default_locale)
+      end
+
+      def parse_response(response)
+        return {} if response.nil? || response.body.nil? || response.body.empty?
+        JSON.parse response.body
+      end
+
+      def expired_token_error?(response)
+        json_response = parse_response(response)
+        json_response.dig('errors', 0, 'errorType') == 'expired_token'
+      end
+
+      def oauth2_refresh_token!
+        @oauth2_access_token = oauth2_access_token.refresh!
+        refresh_token_callback!(@oauth2_access_token)
+      rescue OAuth2::Error => e
+        raise FitbitClient::Error.new('Error during oauth2_refresh_token! attempt', e.response)
+      end
+
+      def oauth2_access_token
+        @oauth2_access_token ||= OAuth2::AccessToken.new(oauth2_client, access_token, refresh_token: refresh_token)
+      end
+
+      def oauth2_client
+        @oauth2_client ||= OAuth2::Client.new(client_id, client_secret, FitbitClient::OAUTH2_CLIENT_OPTIONS)
+      end
+    end
+  end
+end

data/lib/fitbit_client/resources.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module FitbitClient
+  # This module is used to include all resources (endpoints)
+  module Resources
+    include FitbitClient::Util
+    include FitbitClient::Network::Request
+    include FitbitClient::Resources::Common
+    include FitbitClient::Resources::Activity
+    include FitbitClient::Resources::BodyAndWeight
+    include FitbitClient::Resources::Devices
+    include FitbitClient::Resources::Sleep
+    include FitbitClient::Resources::Subscription
+  end
+end

data/lib/fitbit_client/resources/activity.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module FitbitClient
+  module Resources
+    module Activity
+      # The Get Lifetime Stats endpoint retrieves the user's activity statistics
+      # in the format requested using units in the unit system which corresponds
+      # to the Accept-Language header provided.
+      #
+      # Activity statistics includes Lifetime and Best achievement values
+      # from the My Achievements tile on the website dashboard.
+      #
+      # Response contains both statistics from the tracker device and
+      # total numbers including tracker data and manual activity log entries
+      # as seen on the Fitbit website dashboard.
+      def lifetime_stats(options = {})
+        get_json(path_user_version('/activities', options))
+      end
+
+      # The Get Daily Activity Summary endpoint retrieves a summary and list
+      # of a user's activities and activity log entries for a given day in the
+      # format requested using units in the unit system which corresponds to
+      # the Accept-Language header provided.
+      def daily_activity_summary(date, options = {})
+        get_json(path_user_version("/activities/date/#{iso_date(date)}", options))
+      end
+
+      # The Get Activity Time Series endpoint returns time series data in
+      # the specified range for a given resource in the format requested
+      # using units in the unit system that corresponds to
+      # the Accept-Language header provided.
+      def activity_time_series(resource, date, period_or_end_date, options = {})
+        period = period_or_date_param(period_or_end_date)
+        path = "/activities/#{resource}/date/#{iso_date(date)}/#{period}"
+        get_json(path_user_version(path, options))
+      end
+
+      # Get a tree of all valid Fitbit public activities from the activities
+      # catalog as well as private custom activities the user created in the
+      # format requested.
+      #
+      # If the activity has levels, also get a list of activity level details.
+      def browse_activity_types(options = {})
+        skip_user_options!(options)
+        get_json(path_user_version('/activities', options))
+      end
+
+      # Returns the details of a specific activity in the Fitbit activities
+      # database in the format requested. If activity has levels, also returns
+      # a list of activity level details.
+      #
+      #   activity_id : The activity id
+      def activity_type(activity_id, options = {})
+        skip_user_options!(options)
+        get_json(path_user_version("/activities/#{activity_id}", options))
+      end
+
+      # The Get Recent Activity Types endpoint retrieves a list of a user's
+      # recent activities types logged with some details of the last activity
+      # log of that type using units in the unit system which corresponds to
+      # the Accept-Language header provided.
+      #
+      # The record retrieved can be used to log the activity via the
+      # Log Activity endpoint with the same or adjusted values for distance
+      # and duration.
+      def recent_activity_types(options = {})
+        get_json(path_user_version('/activities/recent', options))
+      end
+
+      # The Get Favorite Activities endpoint returns a list of a user's
+      # favorite activities.
+      def favorite_activities
+        get_json(path_user_version('/activities/favorite'))
+      end
+
+      # The Add Favorite Activity endpoint adds the activity with the given ID
+      # to user's list of favorite activities.
+      #
+      #   activity_id : The ID of the activity to add to user's favorites.
+      def add_favorite_activity(activity_id)
+        successful_post?(post(path_user_version("/activities/favorite/#{activity_id}")))
+      end
+
+      # The Delete Favorite Activity removes the activity with the given ID
+      # from a user's list of favorite activities.
+      #
+      #   activity_id : The ID of the activity to be removed.
+      def delete_favorite_activity(activity_id)
+        successful_delete?(delete(path_user_version("/activities/favorite/#{activity_id}")))
+      end
+    end
+  end
+end

data/lib/fitbit_client/resources/body_and_weight.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module FitbitClient
+  module Resources
+    module BodyAndWeight
+      # The Get Weight Logs API retrieves a list of all user's body weight log
+      # entries for a given day using units in the unit systems which
+      # corresponds to the Accept-Language header provided.
+      #
+      # Body weight log entries are available only to authorized user.
+      #
+      # Body weight log entries in response are sorted exactly the same as they
+      # are presented on the Fitbit website.
+      def weight_logs(date, _options = {})
+        get_json(path_user_version("/body/log/weight/date/#{iso_date(date)}"))
+      end
+
+      # The Log Weight API creates log entry for a body weight using units in
+      # the unit systems that corresponds to the Accept-Language header provided
+      # and get a response in the format requested.
+      #
+      # <b>Note:</b> The returned Weight Log IDs are unique to the user,
+      # but not globally unique.
+      #
+      #   weight : Weight in the format X.XX
+      #   date   : Date of the measurement
+      #   time   : Time of the measurement
+      def log_weight(weight, date, time = nil, options = {})
+        params = key_value_date_time_params('weight', weight, date, time)
+        post_json(path_user_version('/body/log/weight', options), params)
+      end
+
+      # The Delete Weight Log API deletes a user's body weight log entry with
+      # the given ID.
+      def delete_weight_log(body_weight_log_id, options = {})
+        path = "/body/log/weight/#{body_weight_log_id}"
+        successful_delete?(delete(path_user_version(path, options)))
+      end
+
+      # Retrieves a user's current body fat percentage or weight goal using
+      # units in the unit systems that corresponds to the Accept-Language header
+      # provided in the format requested.
+      #
+      #   goal_type : can be weight or fat
+      def body_goals(goal_type, options = {})
+        get_json(path_user_version("/body/log/#{goal_type}/goal", options))
+      end
+
+      # The Update Body Fat Goal API creates or updates user's fat percentage
+      # goal.
+      #
+      #   fat : Target body fat percentage in the format X.XX
+      def update_body_fat_goal(fat, options = {})
+        post_json(path_user_version('/body/log/fat/goal', options), 'fat' => fat)
+      end
+
+      # The Update Weight Goal API creates or updates user's fat or weight goal
+      # using units in the unit systems that corresponds to the Accept-Language
+      # header provided in the format requested.
+      #
+      #   startDate   : Weight goal start date
+      #   startWeight : Weight goal start weight; in the format X.XX
+      #   weight      : Weight goal target weight; in the format X.XX, in the
+      #                 unit systems that corresponds to the Accept-Language
+      #                 header provided; required if user doesn't have an existing
+      #                 weight goal.
+      def update_body_weight_goal(start_date, start_weight, weight = nil, options = {})
+        params = update_body_weight_goal_params(start_date, start_weight, weight)
+        post_json(path_user_version('/body/log/weight/goal', options), params)
+      end
+
+      # The Get Body Time Series API returns time series data in the specified
+      # range for a given resource in the format requested using units in the
+      # unit systems that corresponds to the Accept-Language header provided.
+      #
+      # <b>Note:</b> If you provide earlier dates in the request, the response
+      # retrieves only data since the user's join date or the first log entry
+      # date for the requested collection.
+      #
+      #   resource           : Can be "bmi", "fat", or "weight".
+      #   date               : The range start date or end date of the period specified
+      #   period_or_end_date : One of  1d, 7d, 30d, 1w, 1m, 3m, 6m, 1y, max or the end date of the range
+      def body_time_series(resource, date, period_or_end_date, options = {})
+        end_limit = period_or_date_param(period_or_end_date)
+        path = time_series_path('body', resource, date, end_limit)
+        get_json(path_user_version(path, options))
+      end
+
+      # The Get Body Fat Logs API retrieves a list of all user's body fat log
+      # entries for a given day in the format requested. Body fat log entries
+      # are available only to authorized user.
+      #
+      # If you need to fetch only the most recent entry, you can use the
+      # Get Body Measurements endpoint.
+      #
+      #   date               : base or start date
+      #   period_or_end_date : One of 1d, 7d, 1w, 1m or a Date object
+      #
+      # <b>Note:</b> The range should not be longer than 31 days.
+      def body_fat_logs(date, period_or_end_date = nil, options = {})
+        if period_or_end_date
+          end_limit = period_or_date_param(period_or_end_date)
+          path = "/body/log/fat/date/#{iso_date(date)}/#{end_limit}"
+        else
+          path = "/body/log/fat/date/#{iso_date(date)}"
+        end
+        get_json(path_user_version(path, options))
+      end
+
+      # The Log Body Fat API creates a log entry for body fat and returns a
+      # response in the format requested.
+      #
+      # <b>Note:</b> The returned Body Fat Log IDs are unique to the user, but
+      # not globally unique.
+      #
+      #   fat  : Body fat; in the format X.XX
+      #   date : Log entry date
+      #   time : Time of the measurement
+      def log_body_fat(fat, date, time = nil, options = {})
+        params = key_value_date_time_params('fat', fat, date, time)
+        post_json(path_user_version('/body/log/fat', options), params)
+      end
+
+      # The Delete Body Fat Log API deletes a user's body fat log entry with
+      # the given ID.
+      def delete_body_fat_log(body_fat_log_id, options = {})
+        successful_delete?(delete(path_user_version("/body/log/fat/#{body_fat_log_id}", options)))
+      end
+
+      private
+
+      def key_value_date_time_params(key, value, date, time)
+        params = { key => value, 'date' => iso_date(date) }
+        params['time'] = iso_time_with_seconds(time) if time
+        params
+      end
+
+      def update_body_weight_goal_params(start_date, start_weight, weight)
+        params = { 'startDate' => iso_date(start_date), 'startWeight' => start_weight }
+        params['weight'] = weight if weight
+        params
+      end
+    end
+  end
+end

data/lib/fitbit_client/resources/common.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FitbitClient
+  module Resources
+    module Common
+      def skip_user_options!(options)
+        options[:skip_user] = true
+        options.delete![:user_id] if options.key?(:user_id)
+      end
+
+      def time_series_path(type, resource, date, end_limit)
+        "/#{type}/#{resource}/date/#{iso_date(date)}/#{end_limit}"
+      end
+
+      def period_or_date_param(period_or_date)
+        period_or_date.is_a?(Date) ? iso_date(period_or_date) : period_or_date
+      end
+    end
+  end
+end

data/lib/fitbit_client/resources/devices.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module FitbitClient
+  module Resources
+    module Devices
+      # The Get Device endpoint returns a list of the Fitbit devices connected
+      # to a user's account.
+      #
+      # Third-party applications can check when a Fitbit device last synced
+      # with Fitbit's servers using this endpoint.
+      def devices(options = {})
+        get_json(path_user_version('/devices', options))
+      end
+
+      # Returns a list of the set alarms connected to a user's account.
+      #   tracker_id : The ID of the tracker for which data is returned. The tracker-id value is found via the Get Devices endpoint.
+      def alarms(tracker_id, options = {})
+        get_json(path_user_version("/devices/tracker/#{tracker_id}/alarms", options))
+      end
+    end
+  end
+end

data/lib/fitbit_client/resources/sleep.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module FitbitClient
+  module Resources
+    module Sleep
+      # The Get Sleep Time Series endpoint returns time series data in the
+      # specified range for a given resource in the format requested using units
+      # in the unit system that corresponds to the Accept-Language header provided.
+      #
+      # API Version: 1
+      #
+      # <b>Note:</b> This API has been <b>deprecated</b> with the introduction
+      # of version 1.2 of the \Sleep APIs described above. \Sleep Stages data
+      # cannot be retrieved with this API. If your application requires data
+      # consistency while you transition over to the version 1.2 \Sleep APIs,
+      # you can get this data through the version 1 Get Sleep Logs by Date
+      # endpoint.
+      #
+      #   resource           : startTime | timeInBed | minutesAsleep |
+      #                        awakeningsCount | minutesAwake | minutesToFallAsleep
+      #                        minutesAfterWakeup | efficiency
+      #   date               : The start date for a range or end date of the period specified
+      #   period_or_end_date : One of  1d, 7d, 30d, 1w, 1m, 3m, 6m, 1y, max or the end date of the range
+      def sleep_time_series(resource, date, period_or_end_date, options = {})
+        end_limit = period_or_date_param(period_or_end_date)
+        path = time_series_path('sleep', resource, date, end_limit)
+        get_json(path_user_version(path, options))
+      end
+
+      # The Get Sleep Logs by Date endpoint returns a summary and list
+      # of a user's sleep log entries (including naps) as well as detailed sleep
+      # entry data for a given day.
+      #
+      # This endpoint supports two kinds of sleep data:
+      # - stages: Levels data is returned with 30-second granularity. 'Sleep Stages' levels include deep, light, rem, and wake.
+      # - classic: Levels data returned with 60-second granularity. 'Sleep Pattern' levels include asleep, restless, and awake.
+      #
+      # The response could be a mix of classic and stages sleep logs.
+      #
+      # <b>Note:</b> shortData is only included for stages sleep logs and
+      # includes wake periods that are 3 minutes or less in duration.
+      #
+      # This distinction is to simplify graphically distinguishing short wakes
+      # from longer wakes, but they are physiologically equivalent.
+      def sleep_logs_by_date(date, options = {})
+        path = "/sleep/date/#{iso_date(date)}"
+        sleep_default_version!(options)
+        get_json(path_user_version(path, options))
+      end
+
+      # The Get Sleep Logs by Date Range endpoint returns a list of a user's
+      # sleep log entries (including naps) as well as detailed sleep entry data
+      # for a given date range (inclusive of start and end dates).
+      #
+      # This endpoint supports two kinds of sleep data:
+      # - stages : Levels data is returned with 30-second granularity. 'Sleep Stages' levels include deep, light, rem, and wake.
+      # - classic : Levels data returned with 60-second granularity. 'Sleep Pattern' levels include asleep, restless, and awake.
+      #
+      # The response could be a mix of classic and stages sleep logs.
+      #
+      # <b>Note:</b> shortData is only included for stages sleep logs and
+      # includes wake periods that are 3 minutes or less in duration.
+      #
+      # This distinction is to simplify graphically distinguishing short wakes
+      # from longer wakes, but they are physiologically equivalent.
+      def sleep_logs_by_date_range(start_date, end_date, options = {})
+        path = "/sleep/date/#{iso_date(start_date)}/#{iso_date(end_date)}"
+        sleep_default_version!(options)
+        get_json(path_user_version(path, options))
+      end
+
+      # The Get Sleep Logs List endpoint returns a list of a user's sleep logs
+      # (including naps) before or after a given day with offset, limit, and sort order.
+      #
+      # This endpoint supports two kinds of sleep data:
+      # - stages : Levels data is returned with 30-second granularity. 'Sleep Stages' levels include deep, light, rem, and wake.
+      # - classic : Levels data returned with 60-second granularity. 'Sleep Pattern' levels include asleep, restless, and awake.
+      #
+      # The response could be a mix of classic and stages sleep logs.
+      #
+      # <b>Note:</b> shortData is only included for stages sleep logs and
+      # includes wake periods that are 3 minutes or less in duration.
+      #
+      # This distinction is to simplify graphically distinguishing short wakes
+      # from longer wakes, but they are physiologically equivalent.
+      #
+      #   before_date : Either beforeDate or afterDate must be specified.
+      #                 Set sort to desc when using beforeDate.
+      #   after_date  : Either beforeDate or afterDate must be specified.
+      #                 Set sort to asc when using afterDate.
+      def sleep_logs_list(before_date, after_date, sort, limit, options = {})
+        raise 'Before date and Atfer date cannot both be specified' if before_date && after_date
+        if before_date
+          params = { 'beforeDate' => iso_date(before_date), 'sort' => sort, 'limit' => limit, 'offset' => 0 }
+        elsif after_date
+          params = { 'afterDate' => iso_date(after_date), 'sort' => sort, 'limit' => limit, 'offset' => 0 }
+        end
+        sleep_default_version!(options)
+        get_json(path_user_version('/sleep/list', options), params)
+      end
+
+      # The Log Sleep endpoint creates a log entry for a sleep event and
+      # returns a response in the format requested. Keep in mind that it is NOT
+      # possible to create overlapping log entries.
+      #
+      # The dateOfSleep in the response for the sleep log is the date on which
+      # the sleep event ends.
+
+      # It requires read & write access
+      def log_sleep(start_time, duration_milliseconds, date, options = {})
+        params = { 'date' => iso_date(date), 'startTime' => start_time.strftime('%H:%M'), 'duration' => duration_milliseconds }
+        sleep_default_version!(options)
+        post_json(path_user_version('/sleep'), params)
+      end
+
+      # The Delete Sleep Log endpoint deletes a user's sleep log entry with the
+      # given ID.
+      def delete_sleep_log(log_id)
+        successful_delete?(delete(path_user_version("/sleep/#{log_id}")))
+      end
+
+      # The Get Sleep Goal endpoint returns a user's current sleep goal using
+      # unit in the unit system that corresponds to the Accept-Language header
+      # provided in the format requested.
+      def sleep_goals
+        get_json(path_user_version('/sleep/goal'))
+      end
+
+      # Creates or updates a user's sleep goal and get a response in the in the
+      # format requested.
+      #
+      # Access Type: Read & Write
+      #
+      #   min_duration_minutes : The target sleep duration is in minutes
+      def update_sleep_goals(min_duration_minutes)
+        post_json(path_user_version('/sleep/goal'), 'minDuration' => min_duration_minutes)
+      end
+
+      private
+
+      def sleep_default_version!(options)
+        if options[:version] == '1'
+          warn '[DEPRECATION] These endpoints are deprecated and support for them may end unexpectedly. If your application does not depend on the sleep as calculated by these endpoints, please use the new v1.2 sleep endpoints.'
+        else
+          options[:version] = '1.2'
+        end
+      end
+    end
+  end
+end