fitbit_api 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0199cc0ea15375afa47467c885ccf179c73955116fb9edf4a8f21bdfc4087867'
-  data.tar.gz: a394ad4302abe48783bc0bec9217a4132e5939cd067fc922d4e571cac7ea527e
+  metadata.gz: d49f9a31d98fa1fddb1ccffd11d15cbd197ccf9847e0170f2db23410b5cd6eff
+  data.tar.gz: b7d731600647e16ee1dad3e84371ae83fc2d38b6dd53d3ba88a796191d85e832
 SHA512:
-  metadata.gz: 112c2fa3669262d9e86b09a356147ba6665f768b16a7fc096beb1a36de39350c2c79c5258b850fbe0027bab8a78bf5de2c237d79311406f3c537fd0d82a8f83d
-  data.tar.gz: fc9c32427092a0f4f3ccafe15c2a53c486bf7d0e67810bb957d384bb1a83bcc899615bbcf63d9ad881fa30ddbdc1bd7b1cc555ac4246c5c9c5f89bb074cfe9d6
+  metadata.gz: 56ebf6e543e9c1c3bc7b7aa78018151e40fb3929447af8778adb0c7f65628e9d1ef9e17b2b2f11bd7c07c5f79c81018f8a27b25fa87a4f53a5e6ad20f79c9b54
+  data.tar.gz: 1b5c912d4e7d80e9c0b01f0e9c5346e0d8c7c506943d03df0c6ebd5fd33b5f1239c73b78b97b4f1036fc29def97037faa549fd41f25b93883113ffaeef4ffe4d

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,18 @@
+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.

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

@@ -133,9 +133,9 @@ 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
 

data/lib/fitbit_api/body.rb

@@ -3,11 +3,11 @@ module FitbitAPI
     BODY_RESOURCES = %w(bmi fat weight)
 
     def weight_logs(date=Date.today)
-      get("user/-/body/log/weight/date/#{format_date(date)}.json")
+      get("user/#{user_id}/body/log/weight/date/#{format_date(date)}.json")
     end
 
     def body_fat_logs(date=Date.today)
-      get("user/-/body/log/fat/date/#{format_date(date)}.json")
+      get("user/#{user_id}/body/log/fat/date/#{format_date(date)}.json")
     end
 
     def body_time_series(resource, opts={})

data/lib/fitbit_api/client.rb

@@ -7,6 +7,7 @@ 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'
@@ -47,16 +48,16 @@ module FitbitAPI
       @token
     end
 
-    def get(path, params={}, opts={})
-      request(:get, path, opts.merge(params: params))
+    def get(path, params={}, opts={}, &block)
+      request(:get, path, opts.merge(params: params), &block)
     end
 
-    def post(path, body={}, opts={})
-      request(:post, path, opts.merge(body: body))
+    def post(path, body={}, opts={}, &block)
+      request(:post, path, opts.merge(body: body), &block)
     end
 
-    def delete(path, params={}, opts={})
-      request(:delete, path, opts.merge(params: params))
+    def delete(path, params={}, opts={}, &block)
+      request(:delete, path, opts.merge(params: params), &block)
     end
 
     private
@@ -115,7 +116,7 @@ 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)
@@ -125,7 +126,7 @@ module FitbitAPI
 
       refresh_token! if auto_refresh_token && token.expired?
 
-      response = token.public_send(verb, request_path, request_options).response
+      response = token.public_send(verb, request_path, request_options, &block).response
       response_body = MultiJson.load(response.body) unless response.status == 204
 
       process_keys!(response_body)

data/lib/fitbit_api/food.rb

@@ -6,6 +6,14 @@ module FitbitAPI
       get("user/#{user_id}/foods/log/date/#{format_date(date)}.json")
     end
 
+    # 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
@@ -18,8 +26,59 @@ module FitbitAPI
       get("user/#{user_id}/foods/log/favorite.json")
     end
 
-    def food_goals
-      get("user/#{user_id}/foods/log/goal.json")
+    # 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
+
+    # 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={})
@@ -48,5 +107,17 @@ module FitbitAPI
       # 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/goals.rb

@@ -6,34 +6,52 @@ module FitbitAPI
     # Retrieves a user's current weight goal.
 
     def weight_goal
-      get("user/-/body/log/weight/goal.json")
+      get("user/#{user_id}/body/log/weight/goal.json")
     end
 
     # Retrieves a user's current body fat percentage goal.
 
     def body_fat_goal
-      get("user/-/body/log/fat/goal.json")
+      get("user/#{user_id}/body/log/fat/goal.json")
     end
 
     # Retrieves a user's current daily activity goals.
 
-    def daily_goals
+    def daily_activity_goals
       get("user/#{user_id}/activities/goals/daily.json")
     end
 
     # Retrieves a user's current weekly activity goals.
 
-    def weekly_goals
+    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
+
+    # 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
+
     # 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.
     #
-    #   create_or_update_daily_goals(calories_out: 2000, active_minutes: 90, floors: 5)
+    #   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
@@ -41,14 +59,14 @@ module FitbitAPI
     # @param distance [Integer, Float] Distance goal value
     # @param steps [Integer] Steps goal value
 
-    def create_or_update_daily_goals(body={})
+    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(active_minutes: 300, floors: 20)
+    #   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
@@ -56,8 +74,47 @@ module FitbitAPI
     # @param distance [Integer, Float] Distance goal value
     # @param steps [Integer] Steps goal value
 
-    def create_or_update_weekly_goals(body={})
+    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 body [Hash] the POST request body
+
+    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

@@ -42,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/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,10 +3,45 @@ module FitbitAPI
     SLEEP_RESOURCES = %w(startTime timeInBed minutesAsleep awakeningsCount
                          minutesAwake minutesToFallAsleep minutesAfterWakeup efficiency)
 
+    # 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 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)
+
+    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={})
       start_date = opts[:start_date]
       end_date   = opts[:end_date] || Date.today

data/lib/fitbit_api/version.rb

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

data/lib/fitbit_api/water.rb

@@ -1,7 +1,32 @@
 module FitbitAPI
   class Client
+    # 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.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Zoran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-07 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,6 +109,7 @@ 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

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