fitbit_api 0.15.3 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35ca25eddb9d20edb608f8ba914c32b0056484d730c9b1c671385af4348320f0
-  data.tar.gz: c79bc99fda06b0f6ad0f2ad321acf371ed619353c13c44d8225efa2263929358
+  metadata.gz: 71eacdb0827044b2e9395689f0e0466672d7ff64477f9ffe9c68b2e2059ea06b
+  data.tar.gz: ec29770679170f5996d246c008f1537e994e9131c7b8388aa8a27f83652778b3
 SHA512:
-  metadata.gz: 5c35f3405ae380230338376184bda00152619b94bbc91a4eba3075b3dee0c4906da2327967733c17fd5cf3097dbf75ff123e6e8c55f15159a4476e4085573a46
-  data.tar.gz: 5e136456daf9ec21fbb2fd89fb5b8ab001c3a99cce3b51ebd007fd320a79d1dcd530463d51b6976057541c6b39cfe152509c5829a160ac7bf7d9cade23f8c41e
+  metadata.gz: 16f0aab91afabb265db2f52ba4a8b6b897c952b2f467267d63a9387bbeee266aceaa4a2ea53b40978b8f6ecc7b49f0b02420bb26e15fb0878e1486a5208e6e1f
+  data.tar.gz: 3d051c0e8b1022e62bee715119f5747f34282ebd3044a825c5456b67696afc15ec4b8cff175de2397550a20f1ad32040eee6f324194bff949697e65e5ecadbe1

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+0.17.0
+------
+
+- Add ECG endpoint support
+- Add Active Zone Minutes endpoint support
+
+0.16.0
+------
+- Add Sleep Log by Date Range endpoint support
+
 0.15.3
 ------
 - Use strict encoding for auth tokens

data/README.md

@@ -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 | `"1"` |
 | `unit_system`        | The measurement unit system to use for response values | `"en_US"` |
 | `locale`             | The locale to use for response values | `"en_US"` |
-| `scope`              | A list of permissions being requested (array or space-delimited string) | `%w[activity nutrition profile settings sleep social weight heartrate respiratory_rate oxygen_saturation cardio_fitness temperature]` |
+| `scope`              | A list of permissions being requested (array or space-delimited string) | `%w[activity nutrition profile settings sleep social weight heartrate respiratory_rate oxygen_saturation cardio_fitness temperature electrocardiogram]` |
 | `snake_case_keys`    | Transform response payload's keys to snake case format | `false` |
 | `symbolize_keys`     | Transform response payload's keys to symbols | `false` |
 | `auto_refresh_token` | Automatically refreshes the access token once expired | `true` |

data/lib/fitbit_api/active_zone_minutes.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module FitbitAPI
+  class Client
+    # Returns the daily summary Active Zone Minutes (AZM) values over a specified date range or period.
+    #
+    #   active_zone_minutes_time_series(start_date: Date.parse('2021-04-16'), period: '7d')
+    #   active_zone_minutes_time_series(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param opts [Hash] The request parameters
+    #
+    # @option opts :start_date [Date] The start of the date range
+    # @option opts :end_date [Date] The end of the date range
+    # @option opts :period [String] The range for which data will be returned
+
+    def active_zone_minutes_time_series(opts = {})
+      start_date = opts[:start_date]
+      end_date   = opts[:end_date] || Date.today
+      period     = opts[:period]
+
+      raise FitbitAPI::InvalidArgumentError, 'A start_date or period is required.' if [period, start_date].none?
+
+      if period && !PERIODS.include?(period)
+        raise FitbitAPI::InvalidArgumentError,
+              "Invalid period: \"#{period}\". Please provide one of the following: #{PERIODS}."
+      end
+
+      result = if period
+                 get("user/#{user_id}/activities/active-zone-minutes/date/#{format_date(end_date)}/#{period}.json")
+               else
+                 get("user/#{user_id}/activities/active-zone-minutes/date/#{format_date(start_date)}/#{format_date(end_date)}.json")
+               end
+
+      strip_root_key(result)
+    end
+
+    # Retrieves the Active Zone Minutes (AZM) intraday time series data for a specific date or 24 hour period.
+    #
+    # @param opts [Hash] The request parameters
+    #
+    # @option opts :date [Date] The date for which to retrieve the data
+    # @option opts :detail_level [String] Number of data poins to include
+    # @option opts :start_time [String] The time in the format HH:mm
+    # @option opts :end_time [String] The time in the format HH:mm
+
+    def active_zone_minutes_intraday_time_series(opts = {})
+      date         = opts[:date] || Date.today
+      detail_level = opts[:detail_level]
+      start_time   = opts[:start_time]
+      end_time     = opts[:end_time]
+
+      if [date, detail_level].any?(&:nil?)
+        raise FitbitAPI::InvalidArgumentError, 'A date and detail_level are required.'
+      end
+
+      unless %(1min 5min 15min).include? detail_level
+        raise FitbitAPI::InvalidArgumentError,
+              "Invalid detail_level: \"#{detail_level}\". Please provide one of the following: \"1min\", \"5min\" or \"15min\"."
+      end
+
+      if (start_time || end_time) && !(start_time && end_time)
+        raise FitbitAPI::InvalidArgumentError, 'Both start_time and end_time are required if time is being specified.'
+      end
+
+      path = "user/#{user_id}/activities/active-zone-minutes/date/#{format_date(date)}/1d/#{detail_level}"
+      path += "/time/#{format_time(start_time)}/#{format_time(end_time)}" if start_time && end_time
+
+      get("#{path}.json")
+    end
+  end
+end

data/lib/fitbit_api/base.rb

@@ -19,7 +19,7 @@ module FitbitAPI
   define_setting :locale,          'en_US'
   define_setting :scope,           %w[activity nutrition profile settings sleep social weight
                                       heartrate respiratory_rate oxygen_saturation cardio_fitness
-                                      temperature]
+                                      temperature electrocardiogram]
 
   define_setting :api_version,     '1'
 

data/lib/fitbit_api/client.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require 'fitbit_api/base'
+require 'fitbit_api/active_zone_minutes'
 require 'fitbit_api/activities'
 require 'fitbit_api/breathing_rate'
 require 'fitbit_api/cardio_score'
+require 'fitbit_api/electrocardiogram'
 require 'fitbit_api/heart_rate'
 require 'fitbit_api/heart_rate_variability'
 require 'fitbit_api/goals'

data/lib/fitbit_api/electrocardiogram.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module FitbitAPI
+  class Client
+    # This endpoint retrieves a list of the user's Electrocardiogram
+    # (ECG) log entries before or after a given day.
+    #
+    #   ecg_logs_list(before_date: Date.parse('2021-05-24'), limit: 5)
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :before_date [Date] Specify when filtering entries that occured before the given date
+    # @option params :after_date [Date] Specify when filtering entries that occured after the given date
+    # @option params :sort [String] the Sort order of entries by date (asc or desc)
+    # @option params :offset [Integer] The offset number of entries. Must always be 0
+    # @option params :limit [Integer] The max of the number of entries returned (max: 10)
+
+    def ecg_logs_list(params = {})
+      default_params = { before_date: Date.today, after_date: nil, sort: 'desc', limit: 10, offset: 0 }
+      get("user/#{user_id}/ecg/list.json", default_params.merge(params))
+    end
+  end
+end

data/lib/fitbit_api/sleep.rb

@@ -15,6 +15,25 @@ module FitbitAPI
       get("user/#{user_id}/sleep/date/#{format_date(date)}.json")
     end
 
+    # Returns a list of a user's sleep log entries for a given date range. The data returned for either date
+    # can include a sleep period that ended that date but began on the previous date. For example, if you
+    # request a Sleep Log between 2021-12-22 and 2021-12-26, it may return log entries that span 2021-12-21
+    # and 2021-12-22, as well as 2021-12-25 and 2021-12-26.
+    #
+    # @param opts [Hash] The request options
+    #
+    # @option opts :start_date [Date] The start of the date range
+    # @option opts :end_date [Date] The end of the date range
+
+    def sleep_logs_by_date_range(opts = {})
+      start_date = opts[:start_date]
+      end_date = opts[:end_date]
+
+      raise FitbitAPI::InvalidArgumentError, 'A start_date and end_date are required.' unless start_date && end_date
+
+      get("user/#{user_id}/sleep/date/#{format_date(start_date)}/#{format_date(end_date)}.json")
+    end
+
     # Returns a list of a user's sleep log entries before or after a given date, and specifying offset,
     # limit and sort order. The data returned for different dates can include sleep periods that began
     # on the previous date. For example, a sleep log entry for 2018-10-21 may have ended that day but

data/lib/fitbit_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FitbitAPI
-  VERSION = '0.15.3'
+  VERSION = '0.17.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitbit_api
 version: !ruby/object:Gem::Version
-  version: 0.15.3
+  version: 0.17.0
 platform: ruby
 authors:
 - Zoran
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-19 00:00:00.000000000 Z
+date: 2023-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -90,6 +90,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/fitbit_api.rb
+- lib/fitbit_api/active_zone_minutes.rb
 - lib/fitbit_api/activities.rb
 - lib/fitbit_api/alarms.rb
 - lib/fitbit_api/base.rb
@@ -98,6 +99,7 @@ files:
 - lib/fitbit_api/cardio_score.rb
 - lib/fitbit_api/client.rb
 - lib/fitbit_api/devices.rb
+- lib/fitbit_api/electrocardiogram.rb
 - lib/fitbit_api/food.rb
 - lib/fitbit_api/friends.rb
 - lib/fitbit_api/goals.rb
@@ -119,8 +121,8 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/zokioki/fitbit_api
-  changelog_uri: https://github.com/zokioki/fitbit_api/blob/v0.15.3/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/fitbit_api/0.15.3
+  changelog_uri: https://github.com/zokioki/fitbit_api/blob/v0.17.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/fitbit_api/0.17.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []