fitbit_api 0.14.1 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35736e8dc53586ada210b2dc0431c619eed07d79001e5211283561f3922a2a2d
-  data.tar.gz: 36001c0eceb88dac465f1eabe2af276b009e504eef1ad39cdbcb105077b51df0
+  metadata.gz: 417f3489c6b33f4acc4d8eebf14048c5a50b4f86905679f04a436472aea67bd7
+  data.tar.gz: 01ebe9bcc0db08753267015b0ac50a4950c8394c1f7b8563298d2b7657544007
 SHA512:
-  metadata.gz: 114303eb86c474c7e5e8c7338d5ff40e0febfb2c56fd85988cadd1a87c26babb535fa0829692f2582505f99e0a5434dae557f91b5a2a09f0be5ef06495db520d
-  data.tar.gz: 67594641c25ca473c4aa0edb6f96a84616805a0b1fbd4272483645d3e0f167d05be2412ae4b0fa996a1ceab88387b8701d1466bef554226ca3ee0d3fa134e1f5
+  metadata.gz: 66c83ce386d49728e5ec75f4e343c18a015f776c6cc8b8721ff1c4e2700098ece8f1c6b2c3788a7cc1521d3f1302319f25552ea7a1a70b0b9a93ffd0d8e47d52
+  data.tar.gz: 4e97184f094af8aed5a1fd8ea427a9be8c128ebbe439990a8c933a3463c7b8ddb0b31b64ce512d5998118a8f1988aa0ed56ad6009f6045e282d06fc131723bc3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.14.2
+------
+- Add documentation for more methods
+
 0.14.1
 ------
 - Add documentation for several methods

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

@@ -1,3 +1,3 @@
 module FitbitAPI
-  VERSION = '0.14.1'
+  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.1
+  version: 0.14.2
 platform: ruby
 authors:
 - Zoran
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-06 00:00:00.000000000 Z
+date: 2022-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2