fitbit_api 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 303b1eda2135541723313d505d4c34292e94b473c2a87cff32119bd8de97b0ea
-  data.tar.gz: c526445b8815cbe19ce92f6b762036aae9bbf57cfccea2cba9131ed63788307e
+  metadata.gz: '0199cc0ea15375afa47467c885ccf179c73955116fb9edf4a8f21bdfc4087867'
+  data.tar.gz: a394ad4302abe48783bc0bec9217a4132e5939cd067fc922d4e571cac7ea527e
 SHA512:
-  metadata.gz: d7cc3ae62f509e40a0c58bc31f5ffc75865909d482e862401afa0737fc6138ea226c3a9909721903b86f00febd1a8eea46ac01b1d93d2c9dbd0d706b6c201938
-  data.tar.gz: d0d6328a931c8d3fe931f6e31b283681092b31d4b50d5186aeb1a7b8efe885dbf828d0c058a5296c4a4abe9b7e8b13b183482d1f6dc6102aac38a98284d9f3ec
+  metadata.gz: 112c2fa3669262d9e86b09a356147ba6665f768b16a7fc096beb1a36de39350c2c79c5258b850fbe0027bab8a78bf5de2c237d79311406f3c537fd0d82a8f83d
+  data.tar.gz: fc9c32427092a0f4f3ccafe15c2a53c486bf7d0e67810bb957d384bb1a83bcc899615bbcf63d9ad881fa30ddbdc1bd7b1cc555ac4246c5c9c5f89bb074cfe9d6

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+0.11.0
+------
+- Add support for subscriptions endpoints.
+- Make `get` and `post` methods more ergonomic (can pass params & body directly instead of via nested object).
+- Allow `delete` request method to specify query params.
+- Remove per-request response payload transformations (can be set per-client).
+
+0.10.2
+------
+- Fix docs for examples
+
+0.10.1
+------
+- Fix docs for listed options
+
 0.10.0
 ------
 - Add `auto_refresh_token` config to make token auto-refreshing configurable (defaults to true).

data/lib/fitbit_api/activities.rb

@@ -20,32 +20,32 @@ module FitbitAPI
     #
     # @param date [Date] The date for which to retrieve the activity data.
 
-    def daily_activity_summary(date=Date.today, opts={})
-      get("user/#{user_id}/activities/date/#{format_date(date)}.json", opts)
+    def daily_activity_summary(date=Date.today)
+      get("user/#{user_id}/activities/date/#{format_date(date)}.json")
     end
 
     # Retrieves a list of a user's frequent activities in the format requested using
     # units in the unit system which corresponds to the Accept-Language header provided.
 
-    def frequent_activities(opts={})
-      get("user/#{user_id}/activities/frequent.json", opts)
+    def frequent_activities
+      get("user/#{user_id}/activities/frequent.json")
     end
 
-    def recent_activities(opts={})
-      get("user/#{user_id}/activities/recent.json", opts)
+    def recent_activities
+      get("user/#{user_id}/activities/recent.json")
     end
 
     # Returns a list of a user's favorite activities.
 
-    def favorite_activities(opts={})
-      get("user/#{user_id}/activities/favorite.json", opts)
+    def favorite_activities
+      get("user/#{user_id}/activities/favorite.json")
     end
 
-    # Gets a tree of all valid Fitbit public activities from the activities catalog
+    # Gets a list of all valid Fitbit public activities from the activities catalog
     # as well as private custom activities the user created.
 
-    def all_activities(opts={})
-      get('activities.json', opts)
+    def all_activities
+      get('activities.json')
     end
 
     # Retrieves a list of a user's activity log entries before or after a given day
@@ -54,22 +54,15 @@ module FitbitAPI
     #
     #   activity_logs_list(before_date: Date.parse('2021-05-24'), limit: 5)
     #
-    # @option before_date [Date] Specify when filtering entries that occured before the given date
-    # @option after_date [Date] Specify when filtering entries that occured after the given date
-    # @option sort [String] the Sort order of entries by date (asc or desc)
-    # @option offset [Integer] The offset number of entries. Must always be 0
-    # @option limit [Integer] The max of the number of entries returned (max: 20)
-
-    def activity_logs_list(opts={})
-      opts[:params] = {}
-      param_defaults = { before_date: Date.today, after_date: nil, sort: 'desc', limit: 20, offset: 0 }
-
-      # move param values from top-level opts into :params sub-hash
-      param_defaults.each do |key, default_val|
-        opts[:params][key] = opts.delete(key) || default_val
-      end
-
-      get("user/#{user_id}/activities/list.json", opts)
+    # @param before_date [Date] Specify when filtering entries that occured before the given date
+    # @param after_date [Date] Specify when filtering entries that occured after the given date
+    # @param sort [String] the Sort order of entries by date (asc or desc)
+    # @param offset [Integer] The offset number of entries. Must always be 0
+    # @param limit [Integer] The max of the number of entries returned (max: 20)
+
+    def activity_logs_list(params={})
+      default_params = { before_date: Date.today, after_date: nil, sort: 'desc', limit: 20, offset: 0 }
+      get("user/#{user_id}/activities/list.json", default_params.merge(params))
     end
 
     # Returns the details of a specific activity in the Fitbit activities database in the format requested.
@@ -86,8 +79,8 @@ module FitbitAPI
     # Activity statistics includes Lifetime and Best achievement values from the
     # My Achievements tile on the website dashboard.
 
-    def lifetime_stats(opts={})
-      get("user/#{user_id}/activities.json", opts)
+    def lifetime_stats
+      get("user/#{user_id}/activities.json")
     end
 
     def activity_time_series(resource, opts={})
@@ -108,10 +101,11 @@ module FitbitAPI
       end
 
       if period
-        result = get("user/#{user_id}/activities/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
+        result = get("user/#{user_id}/activities/#{resource}/date/#{format_date(end_date)}/#{period}.json")
       else
-        result = get("user/#{user_id}/activities/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
+        result = get("user/#{user_id}/activities/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json")
       end
+
       # remove root key from response
       result.values[0]
     end
@@ -151,19 +145,19 @@ module FitbitAPI
     # Creates log entry for an activity or user's private custom activity using units
     # in the unit system which corresponds to the Accept-Language header provided.
     #
-    #   log_activity(body: { activity_id: 90013, manual_calories: 300, duration_millis: 6000000 })
+    #   log_activity(activity_id: 90013, manual_calories: 300, duration_millis: 6000000)
     #
-    # @option activity_id [Integer, String] The activity ID
-    # @option activity_name [String] Custom activity name. Either activity ID or activity_name must be provided
-    # @option manual_calories [Integer] Calories burned, specified manually. Required with activity_name, otherwise optional
-    # @option start_time [String] Activity start time; formatted in HH:mm:ss
-    # @option duration_millis [Integer] Duration in milliseconds
-    # @option date [String] Log entry date; formatted in yyyy-MM-dd
-    # @option distance [Integer] Distance; required for logging directory activity
-    # @option distance_unit [String] Distance measurement unit
-
-    def log_activity(opts)
-      post("user/#{user_id}/activities.json", opts)
+    # @param activity_id [Integer, String] The activity ID
+    # @param activity_name [String] Custom activity name. Either activity ID or activity_name must be provided
+    # @param manual_calories [Integer] Calories burned, specified manually. Required with activity_name, otherwise optional
+    # @param start_time [String] Activity start time; formatted in HH:mm:ss
+    # @param duration_millis [Integer] Duration in milliseconds
+    # @param date [String] Log entry date; formatted in yyyy-MM-dd
+    # @param distance [Integer] Distance; required for logging directory activity
+    # @param distance_unit [String] Distance measurement unit
+
+    def log_activity(body)
+      post("user/#{user_id}/activities.json", body)
     end
 
     # Adds the activity with the given ID to user's list of favorite activities.

data/lib/fitbit_api/alarms.rb

@@ -7,8 +7,8 @@ module FitbitAPI
     #
     # @params tracker_id [Integer] The ID of the tracker for which the data is returned
 
-    def alarms(tracker_id, opts={})
-      get("user/#{user_id}/devices/tracker/#{tracker_id}/alarms.json", opts)
+    def alarms(tracker_id)
+      get("user/#{user_id}/devices/tracker/#{tracker_id}/alarms.json")
     end
 
     # POST Alarms
@@ -16,35 +16,37 @@ module FitbitAPI
 
     # Adds the alarm settings to a given ID for a given device.
     #
-    #   add_alarm(body: { time: "07:15-08:00", enabled: true, recurring: true, week_days: "MONDAY,FRIDAY,SATURDAY" })
+    #   add_alarm(123, time: "07:15-08:00", recurring: true, week_days: "MONDAY,FRIDAY,SATURDAY")
     #
     # @param tracker_id [Integer] The ID of the tracker for which the alarm is created
     #
-    # @option time [String] Time of day that the alarm vibrates with a UTC timezone offset, e.g. 07:15-08:00
-    # @option enabled [Boolean] If false, alarm does not vibrate until enabled is set to true
-    # @option recurring [Boolean] If false, the alarm is a single event
-    # @option week_days [String] Comma separated list of days of the week on which the alarm vibrates (MONDAY,TUESDAY)
+    # @param time [String] Time of day that the alarm vibrates with a UTC timezone offset, e.g. 07:15-08:00
+    # @param enabled [Boolean] If false, alarm does not vibrate until enabled is set to true
+    # @param recurring [Boolean] If false, the alarm is a single event
+    # @param week_days [String] Comma separated list of days of the week on which the alarm vibrates (MONDAY,TUESDAY)
 
-    def add_alarm(tracker_id, opts={})
-      post("user/#{user_id}/devices/tracker/#{tracker_id}/alarms.json", opts)
+    def add_alarm(tracker_id, body={})
+      post("user/#{user_id}/devices/tracker/#{tracker_id}/alarms.json", body)
     end
 
     # Updates the alarm entry with a given ID for a given device.
     #
+    #   update_alarm(123, 987, week_days: "TUESDAY,SUNDAY")
+    #
     # @param tracker_id [Integer] The ID of the tracker for which the alarm is created
     # @param alarm_id [Integer] The ID of the alarm to be updated
     #
-    # @option time [String] Time of day that the alarm vibrates with a UTC timezone offset, e.g. 07:15-08:00
-    # @option enabled [Boolean] If false, alarm does not vibrate until enabled is set to true
-    # @option recurring [Boolean] If false, the alarm is a single event
-    # @option week_days [String] Comma separated list of days of the week on which the alarm vibrates (MONDAY,TUESDAY)
-    # @option snooze_length [Integer] Minutes between alarms
-    # @option snooze_count [Integer] Maximum snooze count
-    # @option label [String] Label for alarm
-    # @option vibe [String] Vibe pattern; only one value for now (DEFAULT)
-
-    def update_alarm(tracker_id, alarm_id, opts={})
-      post("user/#{user_id}/devices/tracker/#{tracker_id}/alarms/#{alarm_id}.json", opts)
+    # @param time [String] Time of day that the alarm vibrates with a UTC timezone offset, e.g. 07:15-08:00
+    # @param enabled [Boolean] If false, alarm does not vibrate until enabled is set to true
+    # @param recurring [Boolean] If false, the alarm is a single event
+    # @param week_days [String] Comma separated list of days of the week on which the alarm vibrates (MONDAY,TUESDAY)
+    # @param snooze_length [Integer] Minutes between alarms
+    # @param snooze_count [Integer] Maximum snooze count
+    # @param label [String] Label for alarm
+    # @param vibe [String] Vibe pattern; only one value for now (DEFAULT)
+
+    def update_alarm(tracker_id, alarm_id, body={})
+      post("user/#{user_id}/devices/tracker/#{tracker_id}/alarms/#{alarm_id}.json", body)
     end
 
     # DELETE Alarms
@@ -52,11 +54,13 @@ module FitbitAPI
 
     # Deletes the user's device alarm entry with the given ID for a given device.
     #
+    #   delete_alarm(123, 987)
+    #
     # @param tracker_id [Integer] The ID of the tracker for which the alarm is to be deleted
     # @param alarm_id [Integer] The ID of the alarm to be deleted
 
-    def delete_alarm(tracker_id, alarm_id, opts={})
-      delete("user/#{user_id}/devices/tracker/#{tracker_id}/alarms/#{alarm_id}.json", opts)
+    def delete_alarm(tracker_id, alarm_id)
+      delete("user/#{user_id}/devices/tracker/#{tracker_id}/alarms/#{alarm_id}.json")
     end
   end
 end

data/lib/fitbit_api/body.rb

@@ -2,12 +2,12 @@ module FitbitAPI
   class Client
     BODY_RESOURCES = %w(bmi fat weight)
 
-    def weight_logs(date=Date.today, opts={})
-      get("user/-/body/log/weight/date/#{format_date(date)}.json", opts)
+    def weight_logs(date=Date.today)
+      get("user/-/body/log/weight/date/#{format_date(date)}.json")
     end
 
-    def body_fat_logs(date=Date.today, opts={})
-      get("user/-/body/log/fat/date/#{format_date(date)}.json", opts)
+    def body_fat_logs(date=Date.today)
+      get("user/-/body/log/fat/date/#{format_date(date)}.json")
     end
 
     def body_time_series(resource, opts={})
@@ -28,28 +28,29 @@ module FitbitAPI
       end
 
       if period
-        result = get("user/#{user_id}/body/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
+        result = get("user/#{user_id}/body/#{resource}/date/#{format_date(end_date)}/#{period}.json")
       else
-        result = get("user/#{user_id}/body/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
+        result = get("user/#{user_id}/body/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json")
       end
+
       # remove root key from response
       result.values[0]
     end
 
-    def log_weight(opts)
-      post("user/#{user_id}/body/log/weight.json", opts)
+    def log_weight(body)
+      post("user/#{user_id}/body/log/weight.json", body)
     end
 
-    def delete_weight_log(weight_log_id, opts={})
-      delete("user/#{user_id}/body/log/weight/#{weight_log_id}.json", opts)
+    def delete_weight_log(weight_log_id)
+      delete("user/#{user_id}/body/log/weight/#{weight_log_id}.json")
     end
 
-    def log_body_fat(opts)
-      post("user/#{user_id}/body/log/fat.json", opts)
+    def log_body_fat(body)
+      post("user/#{user_id}/body/log/fat.json", body)
     end
 
-    def delete_body_fat_log(body_fat_log_id, opts={})
-      delete("user/#{user_id}/body/log/fat/#{body_fat_log_id}.json", opts)
+    def delete_body_fat_log(body_fat_log_id)
+      delete("user/#{user_id}/body/log/fat/#{body_fat_log_id}.json")
     end
   end
 end

data/lib/fitbit_api/client.rb

@@ -8,6 +8,7 @@ require 'fitbit_api/devices'
 require 'fitbit_api/food'
 require 'fitbit_api/friends'
 require 'fitbit_api/sleep'
+require 'fitbit_api/subscriptions'
 require 'fitbit_api/user'
 require 'fitbit_api/water'
 
@@ -46,16 +47,16 @@ module FitbitAPI
       @token
     end
 
-    def get(path, opts={})
-      request(:get, path, opts)
+    def get(path, params={}, opts={})
+      request(:get, path, opts.merge(params: params))
     end
 
-    def post(path, opts={})
-      request(:post, path, opts)
+    def post(path, body={}, opts={})
+      request(:post, path, opts.merge(body: body))
     end
 
-    def delete(path, opts={})
-      request(:delete, path, opts)
+    def delete(path, params={}, opts={})
+      request(:delete, path, opts.merge(params: params))
     end
 
     private
@@ -116,6 +117,7 @@ module FitbitAPI
 
     def request(verb, path, opts={})
       request_path = "#{@api_version}/#{path}"
+      request_headers = default_request_headers.merge(opts[:headers] || {})
       request_options = opts.merge(headers: request_headers)
 
       deep_keys_to_camel_case!(request_options[:params])
@@ -124,16 +126,16 @@ module FitbitAPI
       refresh_token! if auto_refresh_token && token.expired?
 
       response = token.public_send(verb, request_path, request_options).response
-      object = MultiJson.load(response.body) unless response.status == 204
+      response_body = MultiJson.load(response.body) unless response.status == 204
 
-      process_keys!(object, opts)
+      process_keys!(response_body)
     end
 
     def auth_headers
       { 'Authorization' => ('Basic ' + Base64.encode64(@client_id + ':' + @client_secret)) }
     end
 
-    def request_headers
+    def default_request_headers
       {
         'User-Agent' => "fitbit_api gem (v#{FitbitAPI::VERSION})",
         'Accept-Language' => @unit_system,
@@ -141,10 +143,11 @@ module FitbitAPI
       }
     end
 
-    def process_keys!(object, opts={})
-      deep_keys_to_snake_case!(object) if (opts[:snake_case_keys] || snake_case_keys)
-      deep_symbolize_keys!(object) if (opts[:symbolize_keys] || symbolize_keys)
-      return object
+    def process_keys!(object)
+      deep_keys_to_snake_case!(object) if snake_case_keys
+      deep_symbolize_keys!(object) if symbolize_keys
+
+      object
     end
   end
 end

data/lib/fitbit_api/devices.rb

@@ -1,7 +1,7 @@
 module FitbitAPI
   class Client
-    def devices(opts={})
-      get("user/#{user_id}/devices.json", opts)
+    def devices
+      get("user/#{user_id}/devices.json")
     end
   end
 end

data/lib/fitbit_api/food.rb

@@ -2,24 +2,24 @@ module FitbitAPI
   class Client
     FOOD_RESOURCES = %w(caloriesIn water)
 
-    def food_logs(date=Date.today, opts={})
-      get("user/#{user_id}/foods/log/date/#{format_date(date)}.json", opts)
+    def food_logs(date=Date.today)
+      get("user/#{user_id}/foods/log/date/#{format_date(date)}.json")
     end
 
-    def recent_foods(opts={})
-      get("user/#{user_id}/foods/log/recent.json", opts)
+    def recent_foods
+      get("user/#{user_id}/foods/log/recent.json")
     end
 
-    def frequent_foods(opts={})
-      get("user/#{user_id}/foods/log/frequent.json", opts)
+    def frequent_foods
+      get("user/#{user_id}/foods/log/frequent.json")
     end
 
-    def favorite_foods(opts={})
-      get("user/#{user_id}/foods/log/favorite.json", opts)
+    def favorite_foods
+      get("user/#{user_id}/foods/log/favorite.json")
     end
 
-    def food_goals(opts={})
-      get("user/#{user_id}/foods/log/goal.json", opts)
+    def food_goals
+      get("user/#{user_id}/foods/log/goal.json")
     end
 
     def food_time_series(resource, opts={})
@@ -40,10 +40,11 @@ module FitbitAPI
       end
 
       if period
-        result = get("user/#{user_id}/foods/log/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
+        result = get("user/#{user_id}/foods/log/#{resource}/date/#{format_date(end_date)}/#{period}.json")
       else
-        result = get("user/#{user_id}/foods/log/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
+        result = get("user/#{user_id}/foods/log/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json")
       end
+
       # remove root key from response
       result.values[0]
     end

data/lib/fitbit_api/friends.rb

@@ -1,11 +1,11 @@
 module FitbitAPI
   class Client
-    def friends(opts={})
-      get("user/#{user_id}/friends.json", opts)
+    def friends
+      get("user/#{user_id}/friends.json")
     end
 
-    def friends_leaderboard(opts={})
-      get("user/#{user_id}/friends/leaderboard.json", opts)
+    def friends_leaderboard
+      get("user/#{user_id}/friends/leaderboard.json")
     end
   end
 end

data/lib/fitbit_api/goals.rb

@@ -5,26 +5,26 @@ module FitbitAPI
 
     # Retrieves a user's current weight goal.
 
-    def weight_goal(opts={})
-      get("user/-/body/log/weight/goal.json", opts)
+    def weight_goal
+      get("user/-/body/log/weight/goal.json")
     end
 
     # Retrieves a user's current body fat percentage goal.
 
-    def body_fat_goal(opts={})
-      get("user/-/body/log/fat/goal.json", opts)
+    def body_fat_goal
+      get("user/-/body/log/fat/goal.json")
     end
 
     # Retrieves a user's current daily activity goals.
 
-    def daily_goals(opts={})
-      get("user/#{user_id}/activities/goals/daily.json", opts)
+    def daily_goals
+      get("user/#{user_id}/activities/goals/daily.json")
     end
 
     # Retrieves a user's current weekly activity goals.
 
-    def weekly_goals(opts={})
-      get("user/#{user_id}/activities/goals/weekly.json", opts)
+    def weekly_goals
+      get("user/#{user_id}/activities/goals/weekly.json")
     end
 
     # POST Goals
@@ -33,31 +33,31 @@ module FitbitAPI
     # Creates or updates a user's daily activity goals and returns a response using units
     # in the unit system which corresponds to the Accept-Language header provided.
     #
-    #   create_or_update_daily_goals(body: {calories_out: 2000, active_minutes: 90, floors: 5})
+    #   create_or_update_daily_goals(calories_out: 2000, active_minutes: 90, floors: 5)
     #
-    # @option calories_out [Integer] Calories output goal value
-    # @option active_minutes [Integer] Active minutes goal value
-    # @option floors [Integer] Floor goal value
-    # @option distance [Integer, Float] Distance goal value
-    # @option steps [Integer] Steps goal value
-
-    def create_or_update_daily_goals(opts={})
-      post("user/#{user_id}/activities/goals/daily.json", opts)
+    # @param calories_out [Integer] Calories output goal value
+    # @param active_minutes [Integer] Active minutes goal value
+    # @param floors [Integer] Floor goal value
+    # @param distance [Integer, Float] Distance goal value
+    # @param steps [Integer] Steps goal value
+
+    def create_or_update_daily_goals(body={})
+      post("user/#{user_id}/activities/goals/daily.json", body)
     end
 
     # Creates or updates a user's weekly activity goals and returns a response using units
     # in the unit system which corresponds to the Accept-Language header provided.
     #
-    #   create_or_update_weekly_goals(body: { active_minutes: 300, floors: 20 })
+    #   create_or_update_weekly_goals(active_minutes: 300, floors: 20)
     #
-    # @option calories_out [Integer] Calories output goal value
-    # @option active_minutes [Integer] Active minutes goal value
-    # @option floors [Integer] Floor goal value
-    # @option distance [Integer, Float] Distance goal value
-    # @option steps [Integer] Steps goal value
-
-    def create_or_update_weekly_goals(opts={})
-      post("user/#{user_id}/activities/goals/weekly.json", opts)
+    # @param calories_out [Integer] Calories output goal value
+    # @param active_minutes [Integer] Active minutes goal value
+    # @param floors [Integer] Floor goal value
+    # @param distance [Integer, Float] Distance goal value
+    # @param steps [Integer] Steps goal value
+
+    def create_or_update_weekly_goals(body={})
+      post("user/#{user_id}/activities/goals/weekly.json", body)
     end
   end
 end

data/lib/fitbit_api/heart_rate.rb

@@ -14,10 +14,11 @@ module FitbitAPI
       end
 
       if period
-        result = get("user/#{user_id}/activities/heart/date/#{format_date(end_date)}/#{period}.json", opts)
+        result = get("user/#{user_id}/activities/heart/date/#{format_date(end_date)}/#{period}.json")
       else
-        result = get("user/#{user_id}/activities/heart/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
+        result = get("user/#{user_id}/activities/heart/date/#{format_date(start_date)}/#{format_date(end_date)}.json")
       end
+
       # remove root key from response
       result.values[0]
     end

data/lib/fitbit_api/sleep.rb

@@ -3,8 +3,8 @@ module FitbitAPI
     SLEEP_RESOURCES = %w(startTime timeInBed minutesAsleep awakeningsCount
                          minutesAwake minutesToFallAsleep minutesAfterWakeup efficiency)
 
-    def sleep_logs(date=Date.today, opts={})
-      get("user/#{user_id}/sleep/date/#{format_date(date)}.json", opts)
+    def sleep_logs(date=Date.today)
+      get("user/#{user_id}/sleep/date/#{format_date(date)}.json")
     end
 
     def sleep_time_series(resource, opts={})
@@ -25,10 +25,11 @@ module FitbitAPI
       end
 
       if period
-        result = get("user/#{user_id}/sleep/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
+        result = get("user/#{user_id}/sleep/#{resource}/date/#{format_date(end_date)}/#{period}.json")
       else
-        result = get("user/#{user_id}/sleep/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
+        result = get("user/#{user_id}/sleep/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json")
       end
+
       # remove root key from response
       result.values[0]
     end

data/lib/fitbit_api/subscriptions.rb

@@ -0,0 +1,38 @@
+module FitbitAPI
+  class Client
+    # Retrieves a list of subscriptions created by your application for a specific user.
+    # You can either fetch subscriptions for a specific collection or the entire list
+    # of subscriptions for the user.
+    #
+    # @param collection_path [String] Collection of data to retrieve notifications
+
+    def subscriptions(collection_path=nil)
+      get("#{subscriptions_path(collection_path)}.json")
+    end
+
+    # Creates a subscription to notify the application when a user has new data available.
+    #
+    # @param collection_path [String] Collection of data to retrieve notifications
+    # @param subscription_id [Integer] The unique ID of the subscription created by the API client application
+
+    def create_subscription(collection_path=nil, subscription_id)
+      post("#{subscriptions_path(collection_path)}/#{subscription_id}.json")
+    end
+
+    # Deletes a subscription for a specific user.
+    #
+    # @param collection_path [String] Collection of data to retrieve notifications
+    # @param subscription_id [Integer] The unique ID of the subscription created by the API client application
+
+    def delete_subscription(collection_path=nil, subscription_id)
+      delete("#{subscriptions_path(collection_path)}/#{subscription_id}.json")
+    end
+
+    private
+
+    def subscriptions_path(collection_path=nil)
+      collection_path = "#{collection_path}/" if collection_path
+      "user/#{user_id}/#{collection_path}apiSubscriptions"
+    end
+  end
+end

data/lib/fitbit_api/user.rb

@@ -1,15 +1,15 @@
 module FitbitAPI
   class Client
-    def profile(opts={})
-      get("user/#{user_id}/profile.json", opts)
+    def profile
+      get("user/#{user_id}/profile.json")
     end
 
-    def badges(opts={})
-      get("user/#{user_id}/badges.json", opts)
+    def badges
+      get("user/#{user_id}/badges.json")
     end
 
-    def update_profile(opts)
-      post("user/#{user_id}/profile.json", opts)
+    def update_profile(body)
+      post("user/#{user_id}/profile.json", body)
     end
   end
 end

data/lib/fitbit_api/version.rb

@@ -1,3 +1,3 @@
 module FitbitAPI
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

data/lib/fitbit_api/water.rb

@@ -1,7 +1,7 @@
 module FitbitAPI
   class Client
-    def water_logs(date=Date.today, opts={})
-      get("user/#{user_id}/foods/log/water/date/#{format_date(date)}.json", opts)
+    def water_logs(date=Date.today)
+      get("user/#{user_id}/foods/log/water/date/#{format_date(date)}.json")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitbit_api
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Zoran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-05 00:00:00.000000000 Z
+date: 2022-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -110,6 +110,7 @@ files:
 - lib/fitbit_api/helpers/exceptions.rb
 - lib/fitbit_api/helpers/utils.rb
 - lib/fitbit_api/sleep.rb
+- lib/fitbit_api/subscriptions.rb
 - lib/fitbit_api/user.rb
 - lib/fitbit_api/version.rb
 - lib/fitbit_api/water.rb