fitbit_api 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cced5004604fd14351b0539ffe29efc102d6297f0a73e6d64edd6e4f18b24975
-  data.tar.gz: 66a12b7d4b92c0c75e0958b5f69ddbb87f376bc4196bebd8884804df09bf33d7
+  metadata.gz: '03139ae4b7cbf7a8243f05b155cd4795c4dd2d3f02b86adadc27cebed83be9d8'
+  data.tar.gz: 9d2396e266cfa26e8e869e492c74d37605065eecb743ee5e8a64d59a1a13c8bb
 SHA512:
-  metadata.gz: 2d3b0ee2261afc4a254dc3673796198e9dc832e78a21241b84a7c11a0f39d396fc8647abf6826a0c4aa3a3be731a63b812dcf4d0de9a45c3fb6ccae9b9297612
-  data.tar.gz: 67526aba18a4fe518d5d0b05e8a48979009fc3435ed627c59bff341872e6917387c14ae83709d2ae84c0ff5e16000bf2fca55a89870a436f41b5a389b6b33a2a
+  metadata.gz: 65750c1625faf8f7118120f8db01e1a80438baa496cce74c10aa6bc920692899595ad91973ecea3a1e63ffbb7d5b454f7f40f6433d2b1f08fdae40df4b4580ec
+  data.tar.gz: 95db8df54a789b5ab0a1fdfa1a8906d7d8d4818d9af4fe33f41fcd5a156bd3fd90006bd927c233cee67f0714eeabbd41d5162a6b7171f2ef40d03b73774cf9e8

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+0.13.0
+------
+- Add support for token revocation via `revoke_token!`.
+
+0.12.2
+------
+- Fix docs formatting
+
 0.12.1
 ------
 - Some docs improvements

data/fitbit_api.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/zokioki/fitbit_api'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|test|spec|features)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']

data/lib/fitbit_api/alarms.rb

@@ -2,7 +2,7 @@ module FitbitAPI
   class Client
     # 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
+    # @param tracker_id [Integer] The ID of the tracker for which the data is returned
 
     def alarms(tracker_id)
       get("user/#{user_id}/devices/tracker/#{tracker_id}/alarms.json")

data/lib/fitbit_api/client.rb

@@ -48,6 +48,14 @@ module FitbitAPI
       @token
     end
 
+    def revoke_token!
+      body = { token: token.token }
+      headers = default_request_headers.merge(auth_headers)
+      response = token.post('oauth2/revoke', { headers: headers, body: body }).response
+
+      process_keys!(MultiJson.load(response.body))
+    end
+
     def get(path, params={}, opts={}, &block)
       request(:get, path, opts.merge(params: params), &block)
     end

data/lib/fitbit_api/food.rb

@@ -8,7 +8,7 @@ module FitbitAPI
 
     # Retrieves a list of public foods from the Fitbit foods database and private foods the user created
     #
-    # @params query [String] The search query
+    # @param query [String] The search query
 
     def search_foods(params)
       get("foods/search.json", params)
@@ -28,7 +28,7 @@ module FitbitAPI
 
     # Creates a new private food for a user
     #
-    # @params body [Hash] The POST request body
+    # @param body [Hash] The POST request body
 
     def create_food(body)
       post("user/#{user_id}/foods.json", body)
@@ -36,7 +36,7 @@ module FitbitAPI
 
     # Deletes a custom food created by the user
     #
-    # @params food_id [Integer] The ID of the food to be deleted
+    # @param food_id [Integer] The ID of the food to be deleted
 
     def delete_food(food_id)
       delete("user/#{user_id}/foods/#{food_id}.json")
@@ -44,7 +44,7 @@ module FitbitAPI
 
     # Creates a food log entry
     #
-    # @params body [Hash] The POST request body
+    # @param body [Hash] The POST request body
 
     def create_food_log(body)
       post("user/#{user_id}/foods/log.json", body)
@@ -52,8 +52,8 @@ module FitbitAPI
 
     # 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
+    # @param food_log_id [Integer] The ID of the food log to edit
+    # @param 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)
@@ -61,7 +61,7 @@ module FitbitAPI
 
     # Deletes a user's food log entry using the given log ID
     #
-    # @params food_log_id [Integer] The id of the food log entry
+    # @param 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")
@@ -75,7 +75,7 @@ module FitbitAPI
 
     # 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
+    # @param 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")

data/lib/fitbit_api/meals.rb

@@ -8,7 +8,7 @@ module FitbitAPI
 
     # 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
+    # @param meal_id [Integer] The ID of the meal
 
     def meal(meal_id)
       get("user/#{user_id}/meals/#{meal_id}.json")
@@ -16,7 +16,7 @@ module FitbitAPI
 
     # Creates a meal with the given food
     #
-    # @params body [Hash] The POST request body
+    # @param body [Hash] The POST request body
 
     def create_meal(body)
       post("user/#{user_id}/meals.json", body)
@@ -24,8 +24,8 @@ module FitbitAPI
 
     # 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
+    # @param meal_id [Integer] The ID of the meal
+    # @param body [Hash] The POST request body
 
     def update_meal(meal_id, body)
       post("user/#{user_id}/meals/#{meal_id}.json", body)
@@ -33,7 +33,7 @@ module FitbitAPI
 
     # Deletes an existing meal of the given meal ID
     #
-    # @params meal_id [Integer] The ID of the meal
+    # @param meal_id [Integer] The ID of the meal
 
     def delete_meal(meal_id)
       delete("user/#{user_id}/meals/#{meal_id}.json")

data/lib/fitbit_api/sleep.rb

@@ -7,7 +7,7 @@ module FitbitAPI
     # 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
+    # @param 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")

data/lib/fitbit_api/user.rb

@@ -14,7 +14,7 @@ module FitbitAPI
 
     # Modifies a user's profile data.
     #
-    # @params body [Hash] The POST request body
+    # @param body [Hash] The POST request body
 
     def update_profile(body)
       post("user/#{user_id}/profile.json", body)

data/lib/fitbit_api/version.rb

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

data/lib/fitbit_api/water.rb

@@ -18,8 +18,8 @@ module FitbitAPI
 
     # 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
+    # @param water_log_id [Integer] The ID of the water log to be updated
+    # @param 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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitbit_api
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Zoran
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-21 00:00:00.000000000 Z
+date: 2022-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -80,8 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.11'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -119,7 +119,7 @@ homepage: https://github.com/zokioki/fitbit_api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,8 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.13
-signing_key: 
+rubygems_version: 3.3.24
+signing_key:
 specification_version: 4
 summary: A Ruby interface to the Fitbit Web API.
 test_files: []