fitbit_api 0.10.2 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0a38e6d977a2507680f2ab421d438f1ce5450a2e3346b197f7fe854096278fc
-  data.tar.gz: '090c11c75f82f5bb6b9ac56ce4d2bd0f55d19693cf201c3d3ad9b776151aa4da'
+  metadata.gz: cced5004604fd14351b0539ffe29efc102d6297f0a73e6d64edd6e4f18b24975
+  data.tar.gz: 66a12b7d4b92c0c75e0958b5f69ddbb87f376bc4196bebd8884804df09bf33d7
 SHA512:
-  metadata.gz: adb8632ad6260887b6bd93c5ec1230cad1bc144c9408f1c8fc8c52f2aae463b08d63361cbd1e33bb0f804c813c90abe9c6b45168b02fd649df1cd93cc3961d19
-  data.tar.gz: 5aa550aee293be92bd8f417ca270ee37151543db933c853d2874ea2ff56181b6aeb1279bca208c6bf5fe865fdd867a1bb19da70be22d1a31dffb7983dc60b6f4
+  metadata.gz: 2d3b0ee2261afc4a254dc3673796198e9dc832e78a21241b84a7c11a0f39d396fc8647abf6826a0c4aa3a3be731a63b812dcf4d0de9a45c3fb6ccae9b9297612
+  data.tar.gz: 67526aba18a4fe518d5d0b05e8a48979009fc3435ed627c59bff341872e6917387c14ae83709d2ae84c0ff5e16000bf2fca55a89870a436f41b5a389b6b33a2a

data/.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Test
+
+on:
+  - push
+  - pull_request
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+          - 2.6
+          - 2.7
+          - 3.0
+          - 3.1
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+0.12.1
+------
+- Some docs improvements
+
+0.12.0
+------
+- Expand endpont support for foods (searching foods, creating custom foods, updating/deleting logs).
+- Expand endpoint support for water logging (create, update, delete water logs).
+- Expand endpoint support for sleep (list sleep logs, create/delete sleep logs).
+- Expand endpoint support for goals (food, sleep, water goals).
+- Add endpoint support for meals.
+- Allow `get`, `post`, and `delete` methods to accept blocks.
+- Switch to Github Actions for CI.
+- Rename a few methods for better accuracy/clarity:
+  - daily_goals -> daily_activity_goals
+  - weekly_goals -> weekly_activity_goals
+  - create_or_update_daily_goals -> update_daily_activity_goals
+  - create_or_update_weekly_goals -> update_weekly_activity_goals
+
+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

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)
-[![Build Status](https://travis-ci.org/zokioki/fitbit_api.svg?branch=master)](https://travis-ci.org/zokioki/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)
 
 FitbitAPI provides a Ruby interface to the [Fitbit Web API](https://dev.fitbit.com/reference/web-api).
 

data/fitbit_api.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency     'oauth2', '~> 1.0'
 
-  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'byebug', '~> 11.0'
   spec.add_development_dependency 'bundler', '~> 2.3'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.11'
 end

data/lib/fitbit_api/activities.rb

@@ -11,41 +11,38 @@ 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.
 
-    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.
+    # Retrieves a list of a user's frequent activities.
 
-    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)
+    # 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
 
     # 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 +51,17 @@ 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)
-
-    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 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 }
+      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 +78,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 +100,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
@@ -139,31 +132,30 @@ module FitbitAPI
       end
 
       if (start_time && end_time)
-        get("user/-/activities/#{resource}/date/#{format_date(date)}/1d/#{detail_level}/time/#{format_time(start_time)}/#{format_time(end_time)}.json")
+        get("user/#{user_id}/activities/#{resource}/date/#{format_date(date)}/1d/#{detail_level}/time/#{format_time(start_time)}/#{format_time(end_time)}.json")
       else
-        get("user/-/activities/#{resource}/date/#{format_date(date)}/1d/#{detail_level}.json")
+        get("user/#{user_id}/activities/#{resource}/date/#{format_date(date)}/1d/#{detail_level}.json")
       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(body: { activity_id: 90013, manual_calories: 300, duration_millis: 6000000 })
+    #   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
-
-    def log_activity(opts)
-      post("user/#{user_id}/activities.json", opts)
+    # @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)
     end
 
     # Adds the activity with the given ID to user's list of favorite activities.
@@ -174,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,57 +1,50 @@
 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
 
-    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
-    # ===========
-
     # Adds the alarm settings to a given ID for a given device.
     #
-    #   add_alarm(123, body: { time: "07:15-08:00", 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
+    # @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, 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, body: { week_days: "TUESDAY,SUNDAY" })
+    #   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
-    #
-    # @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, opts={})
-      post("user/#{user_id}/devices/tracker/#{tracker_id}/alarms/#{alarm_id}.json", opts)
+    # @param body [Hash] The POST request body.
+    #
+    # @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)
@@ -59,8 +52,8 @@ module FitbitAPI
     # @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/#{user_id}/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/#{user_id}/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

@@ -7,7 +7,9 @@ require 'fitbit_api/body'
 require 'fitbit_api/devices'
 require 'fitbit_api/food'
 require 'fitbit_api/friends'
+require 'fitbit_api/meals'
 require 'fitbit_api/sleep'
+require 'fitbit_api/subscriptions'
 require 'fitbit_api/user'
 require 'fitbit_api/water'
 
@@ -46,16 +48,16 @@ module FitbitAPI
       @token
     end
 
-    def get(path, opts={})
-      request(:get, path, opts)
+    def get(path, params={}, opts={}, &block)
+      request(:get, path, opts.merge(params: params), &block)
     end
 
-    def post(path, opts={})
-      request(:post, path, opts)
+    def post(path, body={}, opts={}, &block)
+      request(:post, path, opts.merge(body: body), &block)
     end
 
-    def delete(path, opts={})
-      request(:delete, path, opts)
+    def delete(path, params={}, opts={}, &block)
+      request(:delete, path, opts.merge(params: params), &block)
     end
 
     private
@@ -114,8 +116,9 @@ module FitbitAPI
       refresh_token! if @token.token.empty?
     end
 
-    def request(verb, path, opts={})
+    def request(verb, path, opts={}, &block)
       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])
@@ -123,17 +126,17 @@ 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 = token.public_send(verb, request_path, request_options, &block).response
+      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 +144,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,9 @@
 module FitbitAPI
   class Client
-    def devices(opts={})
-      get("user/#{user_id}/devices.json", opts)
+    # Retrieves a list of Fitbit devices paired to a user's account.
+
+    def devices
+      get("user/#{user_id}/devices.json")
     end
   end
 end

data/lib/fitbit_api/food.rb

@@ -2,24 +2,83 @@ 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)
+    # Retrieves a list of public foods from the Fitbit foods database and private foods the user created
+    #
+    # @params query [String] The search query
+
+    def search_foods(params)
+      get("foods/search.json", params)
+    end
+
+    def recent_foods
+      get("user/#{user_id}/foods/log/recent.json")
+    end
+
+    def frequent_foods
+      get("user/#{user_id}/foods/log/frequent.json")
     end
 
-    def frequent_foods(opts={})
-      get("user/#{user_id}/foods/log/frequent.json", opts)
+    def favorite_foods
+      get("user/#{user_id}/foods/log/favorite.json")
     end
 
-    def favorite_foods(opts={})
-      get("user/#{user_id}/foods/log/favorite.json", opts)
+    # Creates a new private food for a user
+    #
+    # @params body [Hash] The POST request body
+
+    def create_food(body)
+      post("user/#{user_id}/foods.json", body)
     end
 
-    def food_goals(opts={})
-      get("user/#{user_id}/foods/log/goal.json", opts)
+    # Deletes a custom food created by the user
+    #
+    # @params food_id [Integer] The ID of the food to be deleted
+
+    def delete_food(food_id)
+      delete("user/#{user_id}/foods/#{food_id}.json")
+    end
+
+    # Creates a food log entry
+    #
+    # @params body [Hash] The POST request body
+
+    def create_food_log(body)
+      post("user/#{user_id}/foods/log.json", body)
+    end
+
+    # Updates the quantity or calories consumed for a user's food log entry with the given Food Log ID
+    #
+    # @params food_log_id [Integer] The ID of the food log to edit
+    # @params body [Hash] The POST request body
+
+    def update_food_log(food_log_id, body)
+      post("user/#{user_id}/foods/log/#{food_log_id}.json", body)
+    end
+
+    # Deletes a user's food log entry using the given log ID
+    #
+    # @params food_log_id [Integer] The id of the food log entry
+
+    def delete_food_log(food_log_id)
+      delete("user/#{user_id}/foods/log/#{food_log_id}.json")
+    end
+
+    # Adds a food with the given ID to the user's list of favorite foods
+
+    def add_favorite_food(food_id)
+      post("user/#{user_id}/foods/log/favorite/#{food_id}.json")
+    end
+
+    # Deletes a food with the given ID from the user's list of favorite foods
+    #
+    # @params food_id [Integer] The ID of the food to delete from the user's favorites
+
+    def delete_favorite_food(food_id)
+      delete("user/#{user_id}/foods/log/favorite/#{food_id}.json")
     end
 
     def food_time_series(resource, opts={})
@@ -40,12 +99,25 @@ 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
+
+    # Retrieves the food locales used to search, log or create food
+
+    def food_locales
+      get("foods/locales.json")
+    end
+
+    # Retrieves a list of all valid Fitbit food units
+
+    def food_units
+      get("foods/units.json")
+    end
   end
 end

data/lib/fitbit_api/friends.rb

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

data/lib/fitbit_api/goals.rb

@@ -1,63 +1,118 @@
 module FitbitAPI
   class Client
-    # GET Goals
-    # =========
-
     # Retrieves a user's current weight goal.
 
-    def weight_goal(opts={})
-      get("user/-/body/log/weight/goal.json", opts)
+    def weight_goal
+      get("user/#{user_id}/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/#{user_id}/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_activity_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_activity_goals
+      get("user/#{user_id}/activities/goals/weekly.json")
+    end
+
+    # Retrieves a user's current sleep goal.
+
+    def sleep_goal
+      get("user/#{user_id}/sleep/goal.json")
     end
 
-    # POST Goals
-    # ==========
+    # Retrieves the user's current daily calorie consumption goal and/or food plan.
+
+    def food_goals
+      get("user/#{user_id}/foods/log/goal.json")
+    end
+
+    # Retrieves a user's daily water consumption goal.
+
+    def water_goal
+      get("user/#{user_id}/foods/log/water/goal.json")
+    end
 
     # 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})
+    #   update_daily_activity_goals(calories_out: 2000, active_minutes: 90, floors: 5)
+    #
+    # @param body [Hash] The POST request body
     #
-    # @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
+    # @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 create_or_update_daily_goals(opts={})
-      post("user/#{user_id}/activities/goals/daily.json", opts)
+    def update_daily_activity_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 })
+    #   update_weekly_activity_goals(active_minutes: 300, floors: 20)
+    #
+    # @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)
+    end
+
+    # Creates or updates a user's weight goal.
+    #
+    # @param body [Hash] the POST request body
+    def update_weight_goal(body)
+      post("user/#{user_id}/body/log/weight/goal.json", body)
+    end
+
+    # Creates or updates a user's body fat goal.
+    #
+    # @param body [Hash] the POST request body
+
+    def update_body_fat_goal(body)
+      post("user/#{user_id}/body/log/fat/goal.json", body)
+    end
+
+    # Create or update a user's sleep goal.
+    #
+    # @param body [Hash] the POST request body
+
+    def update_sleep_goal(body)
+      post("user/#{user_id}/sleep/goal.json", body)
+    end
+
+    # Creates or updates a user's daily calorie consumption or food plan goals.
+    #
+    # @param body [Hash] the POST request body
+
+    def update_food_goals(body)
+      post("user/#{user_id}/foods/log/goal.json", body)
+    end
+
+    # Creates or updates a user's daily water consumption goal.
     #
-    # @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
 
-    def create_or_update_weekly_goals(opts={})
-      post("user/#{user_id}/activities/goals/weekly.json", opts)
+    def update_water_goal(body)
+      post("user/#{user_id}/foods/log/water/goal.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
@@ -41,9 +42,9 @@ module FitbitAPI
       end
 
       if (start_time && end_time)
-        get("user/-/activities/heart/date/#{format_date(date)}/1d/#{detail_level}/time/#{format_time(start_time)}/#{format_time(end_time)}.json")
+        get("user/#{user_id}/activities/heart/date/#{format_date(date)}/1d/#{detail_level}/time/#{format_time(start_time)}/#{format_time(end_time)}.json")
       else
-        get("user/-/activities/heart/date/#{format_date(date)}/1d/#{detail_level}.json")
+        get("user/#{user_id}/activities/heart/date/#{format_date(date)}/1d/#{detail_level}.json")
       end
     end
   end

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/meals.rb

@@ -0,0 +1,42 @@
+module FitbitAPI
+  class Client
+    # Retrieves a list of meals created by the user from their food log
+
+    def meals
+      get("user/#{user_id}/meals.json")
+    end
+
+    # Retrieves a single meal created by the user from their food log given the meal id
+    #
+    # @params meal_id [Integer] The ID of the meal
+
+    def meal(meal_id)
+      get("user/#{user_id}/meals/#{meal_id}.json")
+    end
+
+    # Creates a meal with the given food
+    #
+    # @params body [Hash] The POST request body
+
+    def create_meal(body)
+      post("user/#{user_id}/meals.json", body)
+    end
+
+    # Updates an existing meal with the contents of the request
+    #
+    # @params meal_id [Integer] The ID of the meal
+    # @params body [Hash] The POST request body
+
+    def update_meal(meal_id, body)
+      post("user/#{user_id}/meals/#{meal_id}.json", body)
+    end
+
+    # Deletes an existing meal of the given meal ID
+    #
+    # @params meal_id [Integer] The ID of the meal
+
+    def delete_meal(meal_id)
+      delete("user/#{user_id}/meals/#{meal_id}.json")
+    end
+  end
+end

data/lib/fitbit_api/sleep.rb

@@ -3,8 +3,45 @@ 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)
+    # Returns a list of a user's sleep log entries for a given date. The data returned can include sleep
+    # periods that began on the previous date. For example, if you request a Sleep Log for 2021-12-22,
+    # it may return a log entry that began the previous night on 2021-12-21, but ended on 2021-12-22.
+    #
+    # @params date [Date, String] The date for the sleep log to be returned in the format yyyy-MM-dd
+
+    def sleep_logs(date=Date.today)
+      get("user/#{user_id}/sleep/date/#{format_date(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
+    # started the previous night on 2018-10-20.
+    #
+    #   sleep_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: 100)
+
+    def sleep_logs_list(params={})
+      default_params = { before_date: Date.today, after_date: nil, sort: 'desc', limit: 20, offset: 0 }
+      get("user/#{user_id}/sleep/list.json", default_params.merge(params))
+    end
+
+    # Creates a log entry for a sleep event
+
+    def create_sleep_log(body)
+      post("user/#{user_id}/sleep.json", body)
+    end
+
+    # Deletes a sleep log with the given log ID
+    def delete_sleep_log(sleep_log_id)
+      delete("user/#{user_id}/sleep/#{sleep_log_id}.json")
     end
 
     def sleep_time_series(resource, opts={})
@@ -25,10 +62,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,23 @@
 module FitbitAPI
   class Client
-    def profile(opts={})
-      get("user/#{user_id}/profile.json", opts)
+    # Retrieves the user's profile data.
+
+    def profile
+      get("user/#{user_id}/profile.json")
     end
 
-    def badges(opts={})
-      get("user/#{user_id}/badges.json", opts)
+    # Retrieves a list of the user's badges.
+
+    def badges
+      get("user/#{user_id}/badges.json")
     end
 
-    def update_profile(opts)
-      post("user/#{user_id}/profile.json", opts)
+    # 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
   end
 end

data/lib/fitbit_api/version.rb

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

data/lib/fitbit_api/water.rb

@@ -1,7 +1,36 @@
 module FitbitAPI
   class Client
-    def water_logs(date=Date.today, opts={})
-      get("user/#{user_id}/foods/log/water/date/#{format_date(date)}.json", opts)
+    # 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
+
+    # 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
+
+    # Updates the quantity consumed for a user's water log entry with the given log ID
+    #
+    # @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
+
+    # 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
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitbit_api
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.12.1
 platform: ruby
 authors:
 - Zoran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-05 00:00:00.000000000 Z
+date: 2022-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -28,16 +28,16 @@ dependencies:
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -56,39 +56,39 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.11'
 description: 
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -109,7 +109,9 @@ files:
 - 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/sleep.rb
+- lib/fitbit_api/subscriptions.rb
 - lib/fitbit_api/user.rb
 - lib/fitbit_api/version.rb
 - lib/fitbit_api/water.rb

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-rvm:
-  - 2.7.2
-  - 2.6.6
-  - 2.5.1
-  - 2.4.2
-  - 2.3.5
-before_install: gem install bundler -v 1.10.3