fitbit_api 0.14.0 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32eab4ca789fa776fe5d1ddacf58dd51f43d01d12c049b2b4c5080c5969f902d
-  data.tar.gz: 4f83878440ed7f152f5a5eb3d101447972847c578adaf05b704d201565513189
+  metadata.gz: 417f3489c6b33f4acc4d8eebf14048c5a50b4f86905679f04a436472aea67bd7
+  data.tar.gz: 01ebe9bcc0db08753267015b0ac50a4950c8394c1f7b8563298d2b7657544007
 SHA512:
-  metadata.gz: de894373c47758b4c7530ce3a4559a8284f3c2e2390f3925841015bced821a2c9370657199c527ac9a5416a597019c3bcf1d3a8dcb135fc0bda875aae4baea77
-  data.tar.gz: 3c03846f5f25e1117a88acbfb09e78903ec425deb663e7371154cbc3e57b8a70d43f17c5171bf41ee9c19a584fa932ad009a2171c1a2458637f01893c7b7e013
+  metadata.gz: 66c83ce386d49728e5ec75f4e343c18a015f776c6cc8b8721ff1c4e2700098ece8f1c6b2c3788a7cc1521d3f1302319f25552ea7a1a70b0b9a93ffd0d8e47d52
+  data.tar.gz: 4e97184f094af8aed5a1fd8ea427a9be8c128ebbe439990a8c933a3463c7b8ddb0b31b64ce512d5998118a8f1988aa0ed56ad6009f6045e282d06fc131723bc3

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+0.14.2
+------
+- Add documentation for more methods
+
+0.14.1
+------
+- Add documentation for several methods
+
 0.14.0
 ------
 - Add support for the following endpoints:

data/lib/fitbit_api/breathing_rate.rb

@@ -1,5 +1,17 @@
 module FitbitAPI
   class Client
+    # Returns the average breathing rate data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   breathing_rate_summary(date: Date.parse('2021-04-16'))
+    #   breathing_rate_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def breathing_rate_summary(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]
@@ -23,6 +35,18 @@ module FitbitAPI
       result.values[0]
     end
 
+    # Returns the intraday breathing rate data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   breathing_rate_intraday(date: Date.parse('2021-04-16'))
+    #   breathing_rate_intraday(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def breathing_rate_intraday(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]

data/lib/fitbit_api/cardio_score.rb

@@ -1,5 +1,17 @@
 module FitbitAPI
   class Client
+    # Returns the cardio fitness score data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   cardio_score_summary(date: Date.parse('2021-04-16'))
+    #   cardio_score_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def cardio_score_summary(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]

data/lib/fitbit_api/client.rb

@@ -31,10 +31,16 @@ module FitbitAPI
       establish_token(opts)
     end
 
+    # Returns the authorize endpoint URL of the OAuth2 provider.
+
     def auth_url
       @client.auth_code.authorize_url(redirect_uri: @redirect_uri, scope: @scope)
     end
 
+    # Returns an OAuth2::AccessToken instance obtained from the given authorization code.
+    #
+    # @param auth_code [String] An authorization code
+
     def get_token(auth_code)
       @token = @client.auth_code.get_token(
         auth_code,
@@ -45,6 +51,8 @@ module FitbitAPI
       @token
     end
 
+    # Refreshes the current Access Token.
+
     def refresh_token!
       @token = @token.refresh!(headers: auth_headers)
       @user_id ||= @token.params['user_id']
@@ -53,6 +61,8 @@ module FitbitAPI
       @token
     end
 
+    # Revokes the user's authorizations and all associated tokens.
+
     def revoke_token!
       body = { token: token.token }
       headers = default_request_headers.merge(auth_headers)
@@ -61,14 +71,32 @@ module FitbitAPI
       process_keys!(MultiJson.load(response.body))
     end
 
+    # Performs an authorized GET request to the configured API namespace.
+    #
+    # @param path [String] The request path
+    # @param params [Hash] The query parameters
+    # @param opts [Hash] Additional request options (e.g. headers)
+
     def get(path, params={}, opts={}, &block)
       request(:get, path, opts.merge(params: params), &block)
     end
 
+    # Performs an authorized POST request to the configured API namespace.
+    #
+    # @param path [String] The request path
+    # @param body [Hash] The request body
+    # @param opts [Hash] Additional request options (e.g. headers)
+
     def post(path, body={}, opts={}, &block)
       request(:post, path, opts.merge(body: body), &block)
     end
 
+    # Performs an authorized DELETE request to the configured API namespace.
+    #
+    # @param path [String] The request path
+    # @param params [Hash] The query parameters
+    # @param opts [Hash] Additional request options (e.g. headers)
+
     def delete(path, params={}, opts={}, &block)
       request(:delete, path, opts.merge(params: params), &block)
     end

data/lib/fitbit_api/heart_rate_variability.rb

@@ -1,5 +1,17 @@
 module FitbitAPI
   class Client
+    # Returns the heart rate variability data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   heart_rate_variability_summary(date: Date.parse('2021-04-16'))
+    #   heart_rate_variability_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def heart_rate_variability_summary(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]
@@ -23,6 +35,18 @@ module FitbitAPI
       result.values[0]
     end
 
+    # Returns the heart rate variability intraday data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   heart_rate_variability_intraday(date: Date.parse('2021-04-16'))
+    #   heart_rate_variability_intraday(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def heart_rate_variability_intraday(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]

data/lib/fitbit_api/oxygen_saturation.rb

@@ -1,5 +1,17 @@
 module FitbitAPI
   class Client
+    # Returns the oxygen saturation summary data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   oxygen_saturation_summary(date: Date.parse('2021-04-16'))
+    #   oxygen_saturation_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def oxygen_saturation_summary(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]
@@ -20,6 +32,18 @@ module FitbitAPI
       end
     end
 
+    # Returns the oxygen saturation intraday data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   oxygen_saturation_intraday(date: Date.parse('2021-04-16'))
+    #   oxygen_saturation_intraday(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def oxygen_saturation_intraday(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]

data/lib/fitbit_api/temperature.rb

@@ -1,5 +1,17 @@
 module FitbitAPI
   class Client
+    # Returns the core temperature data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   core_temperature_summary(date: Date.parse('2021-04-16'))
+    #   core_temperature_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def core_temperature_summary(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]
@@ -23,6 +35,18 @@ module FitbitAPI
       result.values[0]
     end
 
+    # Returns the skin temperature data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   skin_temperature_summary(date: Date.parse('2021-04-16'))
+    #   skin_temperature_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def skin_temperature_summary(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]

data/lib/fitbit_api/version.rb

@@ -1,3 +1,3 @@
 module FitbitAPI
-  VERSION = '0.14.0'
+  VERSION = '0.14.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitbit_api
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.2
 platform: ruby
 authors:
 - Zoran
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-05 00:00:00.000000000 Z
+date: 2022-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2