fitbit_api 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d49f9a31d98fa1fddb1ccffd11d15cbd197ccf9847e0170f2db23410b5cd6eff
-  data.tar.gz: b7d731600647e16ee1dad3e84371ae83fc2d38b6dd53d3ba88a796191d85e832
+  metadata.gz: cced5004604fd14351b0539ffe29efc102d6297f0a73e6d64edd6e4f18b24975
+  data.tar.gz: 66a12b7d4b92c0c75e0958b5f69ddbb87f376bc4196bebd8884804df09bf33d7
 SHA512:
-  metadata.gz: 56ebf6e543e9c1c3bc7b7aa78018151e40fb3929447af8778adb0c7f65628e9d1ef9e17b2b2f11bd7c07c5f79c81018f8a27b25fa87a4f53a5e6ad20f79c9b54
-  data.tar.gz: 1b5c912d4e7d80e9c0b01f0e9c5346e0d8c7c506943d03df0c6ebd5fd33b5f1239c73b78b97b4f1036fc29def97037faa549fd41f25b93883113ffaeef4ffe4d
+  metadata.gz: 2d3b0ee2261afc4a254dc3673796198e9dc832e78a21241b84a7c11a0f39d396fc8647abf6826a0c4aa3a3be731a63b812dcf4d0de9a45c3fb6ccae9b9297612
+  data.tar.gz: 67526aba18a4fe518d5d0b05e8a48979009fc3435ed627c59bff341872e6917387c14ae83709d2ae84c0ff5e16000bf2fca55a89870a436f41b5a389b6b33a2a

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.12.1
+------
+- Some docs improvements
+
 0.12.0
 ------
 - Expand endpont support for foods (searching foods, creating custom foods, updating/deleting logs).

data/lib/fitbit_api/activities.rb

@@ -11,12 +11,7 @@ module FitbitAPI
 
     ACTIVITY_INTRADAY_RESOURCES = %w(calories steps distance floors elevation)
 
-    # GET Activities
-    # ==============
-
-    # 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.
+    # Retrieves a summary and list of a user's activities and activity log entries for a given day.
     #
     # @param date [Date] The date for which to retrieve the activity data.
 
@@ -24,13 +19,15 @@ module FitbitAPI
       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.
+    # Retrieves a list of a user's frequent activities.
 
     def frequent_activities
       get("user/#{user_id}/activities/frequent.json")
     end
 
+    # Retrieves a list of a user's recent activities types logged with some details
+    # of the last activity log of that type.
+
     def recent_activities
       get("user/#{user_id}/activities/recent.json")
     end
@@ -54,11 +51,13 @@ module FitbitAPI
     #
     #   activity_logs_list(before_date: Date.parse('2021-05-24'), limit: 5)
     #
-    # @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)
+    # @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: 20)
 
     def activity_logs_list(params={})
       default_params = { before_date: Date.today, after_date: nil, sort: 'desc', limit: 20, offset: 0 }
@@ -139,22 +138,21 @@ module FitbitAPI
       end
     end
 
-    # POST Activities
-    # ===============
-
     # 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(activity_id: 90013, manual_calories: 300, duration_millis: 6000000)
     #
-    # @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
+    # @param body [Hash] The POST request body
+    #
+    # @option body :activity_id [Integer, String] The activity ID
+    # @option body :activity_name [String] Custom activity name. Either activity ID or activity_name must be provided
+    # @option body :manual_calories [Integer] Calories burned, specified manually. Required with activity_name, otherwise optional
+    # @option body :start_time [String] Activity start time; formatted in HH:mm:ss
+    # @option body :duration_millis [Integer] Duration in milliseconds
+    # @option body :date [String] Log entry date; formatted in yyyy-MM-dd
+    # @option body :distance [Integer] Distance; required for logging directory activity
+    # @option body :distance_unit [String] Distance measurement unit
 
     def log_activity(body)
       post("user/#{user_id}/activities.json", body)
@@ -168,9 +166,6 @@ module FitbitAPI
       post("user/#{user_id}/activities/favorite/#{activity_id}.json")
     end
 
-    # DELETE Activities
-    # =================
-
     # Deletes a user's activity log entry with the given ID.
     #
     # @param activity_log_id [Integer] The ID of the activity log entry

data/lib/fitbit_api/alarms.rb

@@ -1,8 +1,5 @@
 module FitbitAPI
   class Client
-    # GET Alarms
-    # ==========
-
     # Returns a list of the set alarms connected to a user's account.
     #
     # @params tracker_id [Integer] The ID of the tracker for which the data is returned
@@ -11,19 +8,17 @@ module FitbitAPI
       get("user/#{user_id}/devices/tracker/#{tracker_id}/alarms.json")
     end
 
-    # POST Alarms
-    # ===========
-
     # Adds the alarm settings to a given ID for a given device.
     #
     #   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
+    # @param body [Hash] The POST request body
     #
-    # @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)
+    # @option body :time [String] Time of day that the alarm vibrates with a UTC timezone offset, e.g. 07:15-08:00
+    # @option body :enabled [Boolean] If false, alarm does not vibrate until enabled is set to true
+    # @option body :recurring [Boolean] If false, the alarm is a single event
+    # @option body :week_days [String] Comma separated list of days of the week on which the alarm vibrates (MONDAY,TUESDAY)
 
     def add_alarm(tracker_id, body={})
       post("user/#{user_id}/devices/tracker/#{tracker_id}/alarms.json", body)
@@ -35,23 +30,21 @@ module FitbitAPI
     #
     # @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
+    # @param body [Hash] The POST request body.
     #
-    # @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)
+    # @option body :time [String] Time of day that the alarm vibrates with a UTC timezone offset, e.g. 07:15-08:00
+    # @option body :enabled [Boolean] If false, alarm does not vibrate until enabled is set to true
+    # @option body :recurring [Boolean] If false, the alarm is a single event
+    # @option body :week_days [String] Comma separated list of days of the week on which the alarm vibrates (MONDAY,TUESDAY)
+    # @option body :snooze_length [Integer] Minutes between alarms
+    # @option body :snooze_count [Integer] Maximum snooze count
+    # @option body :label [String] Label for alarm
+    # @option body :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
-    # =============
-
     # Deletes the user's device alarm entry with the given ID for a given device.
     #
     #   delete_alarm(123, 987)

data/lib/fitbit_api/devices.rb

@@ -1,5 +1,7 @@
 module FitbitAPI
   class Client
+    # Retrieves a list of Fitbit devices paired to a user's account.
+
     def devices
       get("user/#{user_id}/devices.json")
     end

data/lib/fitbit_api/friends.rb

@@ -1,9 +1,13 @@
 module FitbitAPI
   class Client
+    # Retrieves a list of the Fitbit user's friends.
+
     def friends
       get("user/#{user_id}/friends.json")
     end
 
+    # Retrieves the user's friends leaderboard.
+
     def friends_leaderboard
       get("user/#{user_id}/friends/leaderboard.json")
     end

data/lib/fitbit_api/goals.rb

@@ -1,8 +1,5 @@
 module FitbitAPI
   class Client
-    # GET Goals
-    # =========
-
     # Retrieves a user's current weight goal.
 
     def weight_goal
@@ -45,19 +42,18 @@ module FitbitAPI
       get("user/#{user_id}/foods/log/water/goal.json")
     end
 
-    # POST Goals
-    # ==========
-
     # 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.
     #
     #   update_daily_activity_goals(calories_out: 2000, active_minutes: 90, floors: 5)
     #
-    # @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
+    # @param body [Hash] The POST request body
+    #
+    # @option body :calories_out [Integer] Calories output goal value
+    # @option body :active_minutes [Integer] Active minutes goal value
+    # @option body :floors [Integer] Floor goal value
+    # @option body :distance [Integer, Float] Distance goal value
+    # @option body :steps [Integer] Steps goal value
 
     def update_daily_activity_goals(body={})
       post("user/#{user_id}/activities/goals/daily.json", body)
@@ -68,11 +64,13 @@ module FitbitAPI
     #
     #   update_weekly_activity_goals(active_minutes: 300, floors: 20)
     #
-    # @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
+    # @param body [Hash] The POST request body
+    #
+    # @option body :calories_out [Integer] Calories output goal value
+    # @option body :active_minutes [Integer] Active minutes goal value
+    # @option body :floors [Integer] Floor goal value
+    # @option body :distance [Integer, Float] Distance goal value
+    # @option body :steps [Integer] Steps goal value
 
     def update_weekly_activity_goals(body={})
       post("user/#{user_id}/activities/goals/weekly.json", body)

data/lib/fitbit_api/helpers/utils.rb

@@ -1,6 +1,5 @@
 module FitbitAPI
   class Client
-
     PERIODS = %w(1d 7d 30d 1w 1m 3m 6m 1y max).freeze
 
     def format_date(date)
@@ -79,6 +78,5 @@ module FitbitAPI
       string.gsub!(/^\w{1}/) { |word| word.downcase } if opts[:lower]
       return string
     end
-
   end
 end

data/lib/fitbit_api/sleep.rb

@@ -20,11 +20,13 @@ module FitbitAPI
     #
     #   sleep_logs_list(before_date: Date.parse('2021-05-24'), limit: 5)
     #
-    # @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: 100)
+    # @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: 100)
 
     def sleep_logs_list(params={})
       default_params = { before_date: Date.today, after_date: nil, sort: 'desc', limit: 20, offset: 0 }

data/lib/fitbit_api/user.rb

@@ -1,13 +1,21 @@
 module FitbitAPI
   class Client
+    # Retrieves the user's profile data.
+
     def profile
       get("user/#{user_id}/profile.json")
     end
 
+    # Retrieves a list of the user's badges.
+
     def badges
       get("user/#{user_id}/badges.json")
     end
 
+    # Modifies a user's profile data.
+    #
+    # @params body [Hash] The POST request body
+
     def update_profile(body)
       post("user/#{user_id}/profile.json", body)
     end

data/lib/fitbit_api/version.rb

@@ -1,3 +1,3 @@
 module FitbitAPI
-  VERSION = '0.12.0'
+  VERSION = '0.12.1'
 end

data/lib/fitbit_api/water.rb

@@ -3,6 +3,7 @@ module FitbitAPI
     # Retrieves a summary and list of a user's water log entries for a given day
     #
     # @param date [Date] The date for which entries are to be returned
+
     def water_logs(date=Date.today)
       get("user/#{user_id}/foods/log/water/date/#{format_date(date)}.json")
     end
@@ -10,6 +11,7 @@ module FitbitAPI
     # Create a user's water log entry
     #
     # @param body [Hash] The POST request body for creating the water log entry
+
     def log_water(body)
       post("user/#{user_id}/foods/log/water.json", body)
     end
@@ -18,6 +20,7 @@ module FitbitAPI
     #
     # @params water_log_id [Integer] The ID of the water log to be updated
     # @params body [Hash] The POST request body for updating the water log
+
     def update_water_log(water_log_id, body)
       post("user/#{user_id}/foods/log/water/#{water_log_id}.json", body)
     end
@@ -25,6 +28,7 @@ module FitbitAPI
     # Deleted a user's water log entry using the given log ID
     #
     # @param water_log_id [Integer] The id of the water log entry
+
     def delete_water_log(water_log_id)
       delete("user/#{user_id}/foods/log/water/#{water_log_id}.json")
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fitbit_api
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Zoran