fusionauth_client 1.19.0 → 1.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d303bd307e78872200ef01bc1e844055b9ea1ae03d1b2d6511b3461d5c74982c
-  data.tar.gz: ca014231534dc88b074bf0b346f6816dda024c2f616084e9597384582d85504b
+  metadata.gz: d0f60f6be98ee612f4db6e561984edd34809cb28ffcf6067d48e2a1ffea002ca
+  data.tar.gz: 562ea8268599ee1d2ff67bc9861235f2da0f8d9d46d679ee8e076a3412ca8b93
 SHA512:
-  metadata.gz: aef780bb6cf6fc5c2e28f7f85eccdb374994e46ad23ce2114d21c22b4b24efc44e807164edace5cd804ac8d3a72f53567e6eb268ed881480d563138361137227
-  data.tar.gz: e4b5f5c4c42e8f9a957d504541f4484ef8edbe7f63566559e93a1695821406730e5b36ea844a2ba7351d7c179227b4b69cc051918c3c413097ff4ea313199623
+  metadata.gz: 1fd1072baa45440345d09b7210709aaf6281dfb1a4ff8ccef80c68c000325cf4c91f29cfa9f4dd6462c977fc6b078ba9a224218fb36d62af89462aaa677b1cd3
+  data.tar.gz: 24131b46825b6567f22f85bae91883700a0135885e8951fc8a0a012d25fcb2e656d4a49d20c1d233f79733c29b36416f78018a1b6648aaa22f9b79e9f9dbae29

data/.gitignore

@@ -8,4 +8,5 @@
 /spec/reports/
 /tmp/
 .rakeTasks
-/build
+/build
+**/.DS_Store

data/build.savant

@@ -16,7 +16,7 @@
 savantVersion = "1.0.0"
 
 pubVersion = ""
-project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.19.0", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.22.1", licenses: ["ApacheV2_0"]) {
   workflow {
     standard()
   }

data/fusionauth-ruby-client.iml

@@ -12,4 +12,4 @@
     <orderEntry type="library" scope="PROVIDED" name="minitest (v5.8.3, rbenv: 2.5.1) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, rbenv: 2.5.1) [gem]" level="application" />
   </component>
-</module>
+</module>

data/fusionauth_client.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'fusionauth_client'
-  spec.version       = '1.19.0'
+  spec.version       = '1.22.1'
   spec.authors       = ['Brian Pontarelli', 'Daniel DeGroff']
   spec.email         = %w(brian@fusionauth.io daniel@fusionauth.io)
 

data/lib/fusionauth/fusionauth_client.rb

@@ -652,6 +652,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Deletes the tenant for the given Id asynchronously.
+    # This method is helpful if you do not want to wait for the delete operation to complete.
+    #
+    # @param tenant_id [string] The Id of the tenant to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_tenant_async(tenant_id)
+      start.uri('/api/tenant')
+          .url_segment(tenant_id)
+          .url_parameter('async', true)
+          .delete()
+          .go()
+    end
+
     #
     # Deletes the theme for the given Id.
     #
@@ -779,7 +793,7 @@ module FusionAuth
 
     #
     # Exchanges an OAuth authorization code for an access token.
-    # If you will be using the Authorization Code grant, you will make a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token.
+    # Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token.
     #
     # @param code [string] The authorization code returned on the /oauth2/authorize response.
     # @param client_id [string] The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate.
@@ -800,6 +814,31 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Exchanges an OAuth authorization code and code_verifier for an access token.
+    # Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint and a code_verifier for an access token.
+    #
+    # @param code [string] The authorization code returned on the /oauth2/authorize response.
+    # @param client_id [string] (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
+    # @param client_secret [string] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
+    # @param redirect_uri [string] The URI to redirect to upon a successful request.
+    # @param code_verifier [string] The random string generated previously. Will be compared with the code_challenge sent previously, which allows the OAuth provider to authenticate your app.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def exchange_o_auth_code_for_access_token_using_pkce(code, client_id, client_secret, redirect_uri, code_verifier)
+      body = {
+        "code" => code,
+        "client_id" => client_id,
+        "client_secret" => client_secret,
+        "grant_type" => "authorization_code",
+        "redirect_uri" => redirect_uri,
+        "code_verifier" => code_verifier
+      }
+      startAnonymous.uri('/oauth2/token')
+          .body_handler(FusionAuth::FormDataBodyHandler.new(body))
+          .post()
+          .go()
+    end
+
     #
     # Exchange a Refresh Token for an Access Token.
     # If you will be using the Refresh Token Grant, you will make a request to the Token endpoint to exchange the user’s refresh token for an access token.
@@ -940,8 +979,8 @@ module FusionAuth
     # @param encoded_jwt [string] The encoded JWT (access token).
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def generate_two_factor_secret_using_jwt(encoded_jwt)
-      start.uri('/api/two-factor/secret')
-          .authorization('JWT ' + encoded_jwt)
+      startAnonymous.uri('/api/two-factor/secret')
+          .authorization('Bearer ' + encoded_jwt)
           .get()
           .go()
     end
@@ -1012,6 +1051,23 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Inspect an access token issued by FusionAuth.
+    #
+    # @param client_id [string] The unique client identifier. The client Id is the Id of the FusionAuth Application for which this token was generated.
+    # @param token [string] The access token returned by this OAuth provider as the result of a successful authentication.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def introspect_access_token(client_id, token)
+      body = {
+        "client_id" => client_id,
+        "token" => token
+      }
+      startAnonymous.uri('/oauth2/introspect')
+          .body_handler(FusionAuth::FormDataBodyHandler.new(body))
+          .post()
+          .go()
+    end
+
     #
     # Issue a new access token (JWT) for the requested Application after ensuring the provided JWT is valid. A valid
     # access token is properly signed and not expired.
@@ -1026,8 +1082,8 @@ module FusionAuth
     #     tokens enabled in order to receive a refresh token in the response.</p>
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def issue_jwt(application_id, encoded_jwt, refresh_token)
-      start.uri('/api/jwt/issue')
-          .authorization('JWT ' + encoded_jwt)
+      startAnonymous.uri('/api/jwt/issue')
+          .authorization('Bearer ' + encoded_jwt)
           .url_parameter('applicationId', application_id)
           .url_parameter('refreshToken', refresh_token)
           .get()
@@ -2327,6 +2383,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Call the UserInfo endpoint to retrieve User Claims from the access token issued by FusionAuth.
+    #
+    # @param encoded_jwt [string] The encoded JWT (access token).
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_user_info_from_access_token(encoded_jwt)
+      startAnonymous.uri('/oauth2/userinfo')
+          .authorization('Bearer ' + encoded_jwt)
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the login report between the two instants for a particular user by Id. If you specify an application id, it will only return the
     # login counts for that application.
@@ -2388,7 +2456,7 @@ module FusionAuth
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_user_using_jwt(encoded_jwt)
       startAnonymous.uri('/api/user')
-          .authorization('JWT ' + encoded_jwt)
+          .authorization('Bearer ' + encoded_jwt)
           .get()
           .go()
     end
@@ -2951,7 +3019,7 @@ module FusionAuth
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def validate_jwt(encoded_jwt)
       startAnonymous.uri('/api/jwt/validate')
-          .authorization('JWT ' + encoded_jwt)
+          .authorization('Bearer ' + encoded_jwt)
           .get()
           .go()
     end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fusionauth_client
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.22.1
 platform: ruby
 authors:
 - Brian Pontarelli
 - Daniel DeGroff
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.
@@ -36,7 +36,7 @@ licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -52,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: The Ruby client library for FusionAuth
 test_files: []