fitbit_api 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1330316b8f0703f202ab1d680fe07e2eb276c5bddf3d3f5288b4a704b10aa2c5
-  data.tar.gz: 303cc5c8797d6943c02a81a1eed2bc83acc4a3785823bdb4a5ef065951d983b3
+  metadata.gz: e098773d09205d1ea4a0232df914bec3fe7032ffd81339b8551294c3c5495059
+  data.tar.gz: d8fb56568661230c2bd6893b41324b24b41439cdcb9b8d93fa7134f7e54c0f38
 SHA512:
-  metadata.gz: 7191b08e34492465e193bf59e147e7de3602e0dfd81633f4b365f87661bb0fb5cab924a542f40bf12d72f31ed03d4690918bef08fb034ae5f3acd32341827b43
-  data.tar.gz: 9dca14668d515aa6094c1d28c5aa5b01b16e31f9ddbe54b88921dfc0d306ffe94f17413209ed89ce1806fcb8719f18d05fde38266be23cac12fc22b27ca69cb8
+  metadata.gz: 2ec11c165d17e279cb7621f6b22fd1cb8ae172d7f8af4d57b38899c37e0e1b2f7fb605c9c27f200278086df331651f635ab79e20c7a61ed5a9359a54e25cb400
+  data.tar.gz: 8270fc77279f80209d47bb7769cbc5640379d2908c36f265999da820a7189c57c9a01efe4f0452d7e414464b8fade3a6fecd7972361ae28b55d17effa6771457

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+1.1.0
+-----
+- Add Irregular Rhythm Notifications (IRN) endpoint support
+
 1.0.1
 -----
 - Remove unused values from default params for the following:

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 electrocardiogram]` |
+| `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 irregular_rhythm_notifications]` |
 | `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/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 electrocardiogram]
+                                      temperature electrocardiogram irregular_rhythm_notifications]
 
   define_setting :api_version,     '1'
 

data/lib/fitbit_api/client.rb

@@ -8,6 +8,7 @@ require 'fitbit_api/cardio_score'
 require 'fitbit_api/electrocardiogram'
 require 'fitbit_api/heart_rate'
 require 'fitbit_api/heart_rate_variability'
+require 'fitbit_api/irregular_rhythm_notifications'
 require 'fitbit_api/goals'
 require 'fitbit_api/alarms'
 require 'fitbit_api/body'

data/lib/fitbit_api/irregular_rhythm_notifications.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FitbitAPI
+  class Client
+    # Retrieves a paginated list of Irregular Rhythm Notifications (IRN) alerts,
+    # as well as all of the alert tachograms.
+    #
+    #   irn_alerts_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 irn_alerts_list(params = {})
+      default_params = { before_date: Date.today, sort: 'desc', limit: 10, offset: 0 }
+      get("user/#{user_id}/irn/alerts/list.json", default_params.merge(params))
+    end
+
+    # Retrieves the user state for Irregular Rhythm Notifications (IRN).
+
+    def irn_profile
+      get("user/#{user_id}/irn/profile.json")
+    end
+  end
+end

data/lib/fitbit_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitbit_api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Zoran
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-07 00:00:00.000000000 Z
+date: 2024-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -108,6 +108,7 @@ files:
 - lib/fitbit_api/helpers/configuration.rb
 - lib/fitbit_api/helpers/exceptions.rb
 - lib/fitbit_api/helpers/utils.rb
+- lib/fitbit_api/irregular_rhythm_notifications.rb
 - lib/fitbit_api/meals.rb
 - lib/fitbit_api/oxygen_saturation.rb
 - lib/fitbit_api/sleep.rb
@@ -121,8 +122,8 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/zokioki/fitbit_api
-  changelog_uri: https://github.com/zokioki/fitbit_api/blob/v1.0.1/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/fitbit_api/1.0.1
+  changelog_uri: https://github.com/zokioki/fitbit_api/blob/v1.1.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/fitbit_api/1.1.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []