fitbit_api 0.13.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '03139ae4b7cbf7a8243f05b155cd4795c4dd2d3f02b86adadc27cebed83be9d8'
-  data.tar.gz: 9d2396e266cfa26e8e869e492c74d37605065eecb743ee5e8a64d59a1a13c8bb
+  metadata.gz: 35736e8dc53586ada210b2dc0431c619eed07d79001e5211283561f3922a2a2d
+  data.tar.gz: 36001c0eceb88dac465f1eabe2af276b009e504eef1ad39cdbcb105077b51df0
 SHA512:
-  metadata.gz: 65750c1625faf8f7118120f8db01e1a80438baa496cce74c10aa6bc920692899595ad91973ecea3a1e63ffbb7d5b454f7f40f6433d2b1f08fdae40df4b4580ec
-  data.tar.gz: 95db8df54a789b5ab0a1fdfa1a8906d7d8d4818d9af4fe33f41fcd5a156bd3fd90006bd927c233cee67f0714eeabbd41d5162a6b7171f2ef40d03b73774cf9e8
+  metadata.gz: 114303eb86c474c7e5e8c7338d5ff40e0febfb2c56fd85988cadd1a87c26babb535fa0829692f2582505f99e0a5434dae557f91b5a2a09f0be5ef06495db520d
+  data.tar.gz: 67594641c25ca473c4aa0edb6f96a84616805a0b1fbd4272483645d3e0f167d05be2412ae4b0fa996a1ceab88387b8701d1466bef554226ca3ee0d3fa134e1f5

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+0.14.1
+------
+- Add documentation for several methods
+
+0.14.0
+------
+- Add support for the following endpoints:
+  - Breathing Rate
+  - Oxygen Saturation (SpO2)
+  - Cardio Score (VO2 Max)
+  - Heart Rate Variability
+  - Temperature (Core & Skin)
+
 0.13.0
 ------
 - Add support for token revocation via `revoke_token!`.

data/README.md

@@ -1,7 +1,7 @@
 # FitbitAPI
 
-[![Gem Version](https://badge.fury.io/rb/fitbit_api.svg)](https://badge.fury.io/rb/fitbit_api)
-[![Test Workflow](https://github.com/zokioki/fitbit_api/actions/workflows/test.yml/badge.svg)](https://github.com/zokioki/fitbit_api/actions/workflows/test.yml)
+[![Gem Version](https://img.shields.io/gem/v/fitbit_api)](https://rubygems.org/gems/fitbit_api)
+[![Test Workflow](https://img.shields.io/github/workflow/status/zokioki/fitbit_api/Test)](https://github.com/zokioki/fitbit_api/actions/workflows/test.yml)
 
 FitbitAPI provides a Ruby interface to the [Fitbit Web API](https://dev.fitbit.com/reference/web-api).
 
@@ -100,7 +100,7 @@ When initializing a `FitbitAPI::Client` instance, you're given access to a handf
 | api_version        | API version to be used when making requests (default: "1") |
 | unit_system        | The measurement unit system to use for response values (default: "en_US") |
 | locale             | The locale to use for response values (default: "en_US") |
-| scope              | A space-delimited list of permissions being requested (default: "activity nutrition profile settings sleep social weight heartrate") |
+| scope              | A space-delimited list of permissions being requested (default: "activity nutrition profile settings sleep social weight heartrate respiratory_rate oxygen_saturation cardio_fitness temperature") |
 | snake_case_keys    | Transform response payload's keys to snake case format (default: false) |
 | symbolize_keys     | Transform response payload's keys to symbols (default: false) |
 | auto_refresh_token | Automatically refreshes the access token once expired (default: true) |

data/lib/fitbit_api/base.rb

@@ -15,7 +15,7 @@ module FitbitAPI
 
   define_setting :unit_system,     'en_US'
   define_setting :locale,          'en_US'
-  define_setting :scope,           'activity nutrition profile settings sleep social weight heartrate'
+  define_setting :scope,           'activity nutrition profile settings sleep social weight heartrate respiratory_rate oxygen_saturation cardio_fitness temperature'
 
   define_setting :api_version,     '1'
 

data/lib/fitbit_api/breathing_rate.rb

@@ -0,0 +1,73 @@
+module FitbitAPI
+  class Client
+    # Returns the average breathing rate data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   breathing_rate_summary(date: Date.parse('2021-04-16'))
+    #   breathing_rate_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
+    def breathing_rate_summary(opts={})
+      date       = opts[:date] || Date.today
+      start_date = opts[:start_date]
+      end_date   = opts[:end_date]
+
+      if start_date && !end_date
+        end_date = Date.today
+      end
+
+      unless date || start_date
+        raise FitbitAPI::InvalidArgumentError, 'A date or start_date and end_date are required.'
+      end
+
+      if start_date
+        result = get("user/#{user_id}/br/date/#{format_date(start_date)}/#{format_date(end_date)}.json")
+      else
+        result = get("user/#{user_id}/br/date/#{format_date(date)}.json")
+      end
+
+      # remove root key from response
+      result.values[0]
+    end
+
+    # Returns the intraday breathing rate data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   breathing_rate_intraday(date: Date.parse('2021-04-16'))
+    #   breathing_rate_intraday(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
+    def breathing_rate_intraday(opts={})
+      date       = opts[:date] || Date.today
+      start_date = opts[:start_date]
+      end_date   = opts[:end_date]
+
+      if start_date && !end_date
+        end_date = Date.today
+      end
+
+      unless date || start_date
+        raise FitbitAPI::InvalidArgumentError, 'A date or start_date and end_date are required.'
+      end
+
+      if start_date
+        result = get("user/#{user_id}/br/date/#{format_date(start_date)}/#{format_date(end_date)}/all.json")
+      else
+        result = get("user/#{user_id}/br/date/#{format_date(date)}/all.json")
+      end
+
+      # remove root key from response
+      result.values[0]
+    end
+  end
+end

data/lib/fitbit_api/cardio_score.rb

@@ -0,0 +1,38 @@
+module FitbitAPI
+  class Client
+    # Returns the cardio fitness score data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   cardio_score_summary(date: Date.parse('2021-04-16'))
+    #   cardio_score_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
+    def cardio_score_summary(opts={})
+      date       = opts[:date] || Date.today
+      start_date = opts[:start_date]
+      end_date   = opts[:end_date]
+
+      if start_date && !end_date
+        end_date = Date.today
+      end
+
+      unless date || start_date
+        raise FitbitAPI::InvalidArgumentError, 'A date or start_date and end_date are required.'
+      end
+
+      if start_date
+        result = get("user/#{user_id}/cardioscore/date/#{format_date(start_date)}/#{format_date(end_date)}.json")
+      else
+        result = get("user/#{user_id}/cardioscore/date/#{format_date(date)}.json")
+      end
+
+      # remove root key from response
+      result.values[0]
+    end
+  end
+end

data/lib/fitbit_api/client.rb

@@ -1,6 +1,9 @@
 require 'fitbit_api/base'
 require 'fitbit_api/activities'
+require 'fitbit_api/breathing_rate'
+require 'fitbit_api/cardio_score'
 require 'fitbit_api/heart_rate'
+require 'fitbit_api/heart_rate_variability'
 require 'fitbit_api/goals'
 require 'fitbit_api/alarms'
 require 'fitbit_api/body'
@@ -8,8 +11,10 @@ require 'fitbit_api/devices'
 require 'fitbit_api/food'
 require 'fitbit_api/friends'
 require 'fitbit_api/meals'
+require 'fitbit_api/oxygen_saturation'
 require 'fitbit_api/sleep'
 require 'fitbit_api/subscriptions'
+require 'fitbit_api/temperature'
 require 'fitbit_api/user'
 require 'fitbit_api/water'
 

data/lib/fitbit_api/heart_rate_variability.rb

@@ -0,0 +1,73 @@
+module FitbitAPI
+  class Client
+    # Returns the heart rate variability data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   heart_rate_variability_summary(date: Date.parse('2021-04-16'))
+    #   heart_rate_variability_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
+    def heart_rate_variability_summary(opts={})
+      date       = opts[:date] || Date.today
+      start_date = opts[:start_date]
+      end_date   = opts[:end_date]
+
+      if start_date && !end_date
+        end_date = Date.today
+      end
+
+      unless date || start_date
+        raise FitbitAPI::InvalidArgumentError, 'A date or start_date and end_date are required.'
+      end
+
+      if start_date
+        result = get("user/#{user_id}/hrv/date/#{format_date(start_date)}/#{format_date(end_date)}.json")
+      else
+        result = get("user/#{user_id}/hrv/date/#{format_date(date)}.json")
+      end
+
+      # remove root key from response
+      result.values[0]
+    end
+
+    # Returns the heart rate variability intraday data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   heart_rate_variability_intraday(date: Date.parse('2021-04-16'))
+    #   heart_rate_variability_intraday(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
+    def heart_rate_variability_intraday(opts={})
+      date       = opts[:date] || Date.today
+      start_date = opts[:start_date]
+      end_date   = opts[:end_date]
+
+      if start_date && !end_date
+        end_date = Date.today
+      end
+
+      unless date || start_date
+        raise FitbitAPI::InvalidArgumentError, 'A date or start_date and end_date are required.'
+      end
+
+      if start_date
+        result = get("user/#{user_id}/hrv/date/#{format_date(start_date)}/#{format_date(end_date)}/all.json")
+      else
+        result = get("user/#{user_id}/hrv/date/#{format_date(date)}/all.json")
+      end
+
+      # remove root key from response
+      result.values[0]
+    end
+  end
+end

data/lib/fitbit_api/oxygen_saturation.rb

@@ -0,0 +1,67 @@
+module FitbitAPI
+  class Client
+    # Returns the oxygen saturation summary data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   oxygen_saturation_summary(date: Date.parse('2021-04-16'))
+    #   oxygen_saturation_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
+    def oxygen_saturation_summary(opts={})
+      date       = opts[:date] || Date.today
+      start_date = opts[:start_date]
+      end_date   = opts[:end_date]
+
+      if start_date && !end_date
+        end_date = Date.today
+      end
+
+      unless date || start_date
+        raise FitbitAPI::InvalidArgumentError, 'A date or start_date and end_date are required.'
+      end
+
+      if start_date
+        get("user/#{user_id}/spo2/date/#{format_date(start_date)}/#{format_date(end_date)}.json")
+      else
+        get("user/#{user_id}/spo2/date/#{format_date(date)}.json")
+      end
+    end
+
+    # Returns the oxygen saturation intraday data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   oxygen_saturation_intraday(date: Date.parse('2021-04-16'))
+    #   oxygen_saturation_intraday(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
+    def oxygen_saturation_intraday(opts={})
+      date       = opts[:date] || Date.today
+      start_date = opts[:start_date]
+      end_date   = opts[:end_date]
+
+      if start_date && !end_date
+        end_date = Date.today
+      end
+
+      unless date || start_date
+        raise FitbitAPI::InvalidArgumentError, 'A date or start_date and end_date are required.'
+      end
+
+      if start_date
+        get("user/#{user_id}/spo2/date/#{format_date(start_date)}/#{format_date(end_date)}/all.json")
+      else
+        get("user/#{user_id}/spo2/date/#{format_date(date)}/all.json")
+      end
+    end
+  end
+end

data/lib/fitbit_api/temperature.rb

@@ -0,0 +1,73 @@
+module FitbitAPI
+  class Client
+    # Returns the core temperature data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   core_temperature_summary(date: Date.parse('2021-04-16'))
+    #   core_temperature_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
+    def core_temperature_summary(opts={})
+      date       = opts[:date] || Date.today
+      start_date = opts[:start_date]
+      end_date   = opts[:end_date]
+
+      if start_date && !end_date
+        end_date = Date.today
+      end
+
+      unless date || start_date
+        raise FitbitAPI::InvalidArgumentError, 'A date or start_date and end_date are required.'
+      end
+
+      if start_date
+        result = get("user/#{user_id}/temp/core/date/#{format_date(start_date)}/#{format_date(end_date)}.json")
+      else
+        result = get("user/#{user_id}/temp/core/date/#{format_date(date)}.json")
+      end
+
+      # remove root key from response
+      result.values[0]
+    end
+
+    # Returns the skin temperature data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   skin_temperature_summary(date: Date.parse('2021-04-16'))
+    #   skin_temperature_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
+    def skin_temperature_summary(opts={})
+      date       = opts[:date] || Date.today
+      start_date = opts[:start_date]
+      end_date   = opts[:end_date]
+
+      if start_date && !end_date
+        end_date = Date.today
+      end
+
+      unless date || start_date
+        raise FitbitAPI::InvalidArgumentError, 'A date or start_date and end_date are required.'
+      end
+
+      if start_date
+        result = get("user/#{user_id}/temp/skin/date/#{format_date(start_date)}/#{format_date(end_date)}.json")
+      else
+        result = get("user/#{user_id}/temp/skin/date/#{format_date(date)}.json")
+      end
+
+      # remove root key from response
+      result.values[0]
+    end
+  end
+end

data/lib/fitbit_api/version.rb

@@ -1,3 +1,3 @@
 module FitbitAPI
-  VERSION = '0.13.0'
+  VERSION = '0.14.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitbit_api
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Zoran
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-31 00:00:00.000000000 Z
+date: 2022-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -100,18 +100,23 @@ files:
 - lib/fitbit_api/alarms.rb
 - lib/fitbit_api/base.rb
 - lib/fitbit_api/body.rb
+- lib/fitbit_api/breathing_rate.rb
+- lib/fitbit_api/cardio_score.rb
 - lib/fitbit_api/client.rb
 - lib/fitbit_api/devices.rb
 - lib/fitbit_api/food.rb
 - lib/fitbit_api/friends.rb
 - lib/fitbit_api/goals.rb
 - lib/fitbit_api/heart_rate.rb
+- lib/fitbit_api/heart_rate_variability.rb
 - lib/fitbit_api/helpers/configuration.rb
 - lib/fitbit_api/helpers/exceptions.rb
 - lib/fitbit_api/helpers/utils.rb
 - lib/fitbit_api/meals.rb
+- lib/fitbit_api/oxygen_saturation.rb
 - lib/fitbit_api/sleep.rb
 - lib/fitbit_api/subscriptions.rb
+- lib/fitbit_api/temperature.rb
 - lib/fitbit_api/user.rb
 - lib/fitbit_api/version.rb
 - lib/fitbit_api/water.rb