fusionauth_client 1.17.0 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f91a54dc500875d697bca113a8dfd213c8c4de1f4ac8b4cc8ee3eb605b83d98d
-  data.tar.gz: 05d4ed2eb2a09ee56a4d995115682d8661964b70b403bb88304a1bfcf5e4e810
+  metadata.gz: a2112fbc16e044c2716b50a04c2a720acc7616e99e0119bc494c721947282504
+  data.tar.gz: 902dcf9aa23e9ea20ec66636d9cdb30d210adc6735cc56e60058c6c8eb643235
 SHA512:
-  metadata.gz: 1570fbff542d1f5d7a4ed1c6168ac5a8264e6e97bdd7eaa560257ce6796ff7562cf81bbbe74310a0e997f016e055d7911d1e541d784f5048ea14ad4c851c8f80
-  data.tar.gz: d46ff0619da3c0d70ae9093f3a338216390286048b731ee336e785bab72b726d80c4e50230ebe8e847e708f98ffeeaa5f5dfd1339ecac0f28db743c7af1a28b9
+  metadata.gz: 3c754dbde8485f89dc21b9b746b8ca4880ea8135612af8dcf056798ff92c0d98267b981d78fe1643574348cd4e4b8892df6b0807ff34581fcbfb89e403c266e1
+  data.tar.gz: 240debc7317d5c870636dcccf5aea0380b98dfe95ec10db183992658b8eb140970ac8c5084366ff013b7fcf09412d69b1e9fb2a5d9e3143935e06559004e5a9b

data/.gitignore

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

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.5.1

data/Gemfile

@@ -13,7 +13,7 @@
 # language governing permissions and limitations under the License.
 
 source 'https://rubygems.org'
-ruby '2.3.1'
+ruby '2.5.1'
 
 gem "rake",  "12.3.3"
 gem "minitest",  "5.8.3"

data/README.md

@@ -33,7 +33,7 @@ client = FusionAuth::FusionAuthClient.new(
 
 # Create a user + registration
 id = SecureRandom.uuid
-client.register!(id, {
+client.register(id, {
     :user => {
         :firstName => 'Ruby',
         :lastName => 'Client',
@@ -51,12 +51,12 @@ client.register!(id, {
 })
 
 # Authenticate the user
-response = client.login!({
+response = client.login({
     :loginId => 'ruby.client.test@fusionauth.io',
     :password => 'password',
     :applicationId => application_id
 })
-user = response.user
+user = response.success.response.user
 ```
 
 ## Contributing

data/build.savant

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

data/fusionauth-ruby-client.iml

@@ -6,10 +6,10 @@
       <sourceFolder url="file://$MODULE_DIR$/lib" isTestSource="false" />
       <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
     </content>
-    <orderEntry type="jdk" jdkName="rbenv: 2.3.1" jdkType="RUBY_SDK" />
+    <orderEntry type="jdk" jdkName="rbenv: 2.5.1" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.0.2, rbenv: 2.3.1) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.8.3, rbenv: 2.3.1) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, rbenv: 2.3.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.1.4, rbenv: 2.5.1) [gem]" level="application" />
+    <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>

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.17.0'
+  spec.version       = '1.21.0'
   spec.authors       = ['Brian Pontarelli', 'Daniel DeGroff']
   spec.email         = %w(brian@fusionauth.io daniel@fusionauth.io)
 

data/lib/fusionauth/fusionauth_client.rb

@@ -170,6 +170,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Creates a connector.  You can optionally specify an Id for the connector, if not provided one will be generated.
+    #
+    # @param connector_id [string] (Optional) The Id for the connector. If not provided a secure random UUID will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the connector.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def create_connector(connector_id, request)
+      start.uri('/api/connector')
+          .url_segment(connector_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated.
     #
@@ -213,6 +227,34 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Creates a form.  You can optionally specify an Id for the form, if not provided one will be generated.
+    #
+    # @param form_id [string] (Optional) The Id for the form. If not provided a secure random UUID will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the form.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def create_form(form_id, request)
+      start.uri('/api/form')
+          .url_segment(form_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Creates a form field.  You can optionally specify an Id for the form, if not provided one will be generated.
+    #
+    # @param field_id [string] (Optional) The Id for the form field. If not provided a secure random UUID will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the form field.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def create_form_field(field_id, request)
+      start.uri('/api/form/field')
+          .url_segment(field_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.
     #
@@ -464,6 +506,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Deletes the connector for the given Id.
+    #
+    # @param connector_id [string] The Id of the connector to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_connector(connector_id)
+      start.uri('/api/connector')
+          .url_segment(connector_id)
+          .delete()
+          .go()
+    end
+
     #
     # Deletes the consent for the given Id.
     #
@@ -488,6 +542,30 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Deletes the form for the given Id.
+    #
+    # @param form_id [string] The Id of the form to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_form(form_id)
+      start.uri('/api/form')
+          .url_segment(form_id)
+          .delete()
+          .go()
+    end
+
+    #
+    # Deletes the form field for the given Id.
+    #
+    # @param field_id [string] The Id of the form field to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_form_field(field_id)
+      start.uri('/api/form/field')
+          .url_segment(field_id)
+          .delete()
+          .go()
+    end
+
     #
     # Deletes the group for the given Id.
     #
@@ -527,11 +605,11 @@ module FusionAuth
     #
     # Deletes the key for the given Id.
     #
-    # @param key_od [string] The Id of the key to delete.
+    # @param key_id [string] The Id of the key to delete.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
-    def delete_key(key_od)
+    def delete_key(key_id)
       start.uri('/api/key')
-          .url_segment(key_od)
+          .url_segment(key_id)
           .delete()
           .go()
     end
@@ -701,11 +779,11 @@ 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] (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 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.
+    # @param client_secret [string] (Optional) The client secret. This value will be required if client authentication is enabled.
     # @param redirect_uri [string] The URI to redirect to upon a successful request.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def exchange_o_auth_code_for_access_token(code, client_id, client_secret, redirect_uri)
@@ -722,6 +800,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.
@@ -862,8 +965,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
@@ -897,9 +1000,33 @@ module FusionAuth
     end
 
     #
-    # Bulk imports multiple users. This does some validation, but then tries to run batch inserts of users. This reduces
-    # latency when inserting lots of users. Therefore, the error response might contain some information about failures,
-    # but it will likely be pretty generic.
+    # Bulk imports refresh tokens. This request performs minimal validation and runs batch inserts of refresh tokens with the
+    # expectation that each token represents a user that already exists and is registered for the corresponding FusionAuth
+    # Application. This is done to increases the insert performance.
+    # 
+    # Therefore, if you encounter an error due to a database key violation, the response will likely offer a generic
+    # explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response
+    # body with specific validation errors. This will slow the request down but will allow you to identify the cause of
+    # the failure. See the validateDbConstraints request parameter.
+    #
+    # @param request [OpenStruct, Hash] The request that contains all of the information about all of the refresh tokens to import.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def import_refresh_tokens(request)
+      start.uri('/api/user/refresh-token/import')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Bulk imports users. This request performs minimal validation and runs batch inserts of users with the expectation
+    # that each user does not yet exist and each registration corresponds to an existing FusionAuth Application. This is done to
+    # increases the insert performance.
+    # 
+    # Therefore, if you encounter an error due to a database key violation, the response will likely offer
+    # a generic explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response
+    # body with specific validation errors. This will slow the request down but will allow you to identify the cause of the failure. See
+    # the validateDbConstraints request parameter.
     #
     # @param request [OpenStruct, Hash] The request that contains all of the information about all of the users to import.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -910,6 +1037,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.
@@ -920,12 +1064,12 @@ module FusionAuth
     # @param application_id [string] The Application Id for which you are requesting a new access token be issued.
     # @param encoded_jwt [string] The encoded JWT (access token).
     # @param refresh_token [string] (Optional) An existing refresh token used to request a refresh token in addition to a JWT in the response.
-    #     <p>The target application represented by the applicationid request parameter must have refresh 
+    #     <p>The target application represented by the applicationId request parameter must have refresh
     #     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()
@@ -1055,6 +1199,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Updates, via PATCH, the connector with the given Id.
+    #
+    # @param connector_id [string] The Id of the connector to update.
+    # @param request [OpenStruct, Hash] The request that contains just the new connector information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_connector(connector_id, request)
+      start.uri('/api/connector')
+          .url_segment(connector_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .patch()
+          .go()
+    end
+
     #
     # Updates, via PATCH, the consent with the given Id.
     #
@@ -1355,6 +1513,21 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Re-sends the verification email to the user. If the Application has configured a specific email template this will be used
+    # instead of the tenant configuration.
+    #
+    # @param application_id [string] The unique Application Id to used to resolve an application specific email template.
+    # @param email [string] The email address of the user that needs a new verification email.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def resend_email_verification_with_application_template(application_id, email)
+      start.uri('/api/user/verify-email')
+          .url_parameter('applicationId', application_id)
+          .url_parameter('email', email)
+          .put()
+          .go()
+    end
+
     #
     # Re-sends the application registration verification email to the user.
     #
@@ -1455,6 +1628,28 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves the connector with the given Id.
+    #
+    # @param connector_id [string] The Id of the connector.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_connector(connector_id)
+      start.uri('/api/connector')
+          .url_segment(connector_id)
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieves all of the connectors.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_connectors()
+      start.uri('/api/connector')
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the Consent for the given Id.
     #
@@ -1566,6 +1761,50 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves the form with the given Id.
+    #
+    # @param form_id [string] The Id of the form.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_form(form_id)
+      start.uri('/api/form')
+          .url_segment(form_id)
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieves the form field with the given Id.
+    #
+    # @param field_id [string] The Id of the form field.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_form_field(field_id)
+      start.uri('/api/form/field')
+          .url_segment(field_id)
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieves all of the forms fields
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_form_fields()
+      start.uri('/api/form/field')
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieves all of the forms.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_forms()
+      start.uri('/api/form')
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the group for the given Id.
     #
@@ -2130,6 +2369,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.
@@ -2191,7 +2442,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
@@ -2467,6 +2718,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Updates the connector with the given Id.
+    #
+    # @param connector_id [string] The Id of the connector to update.
+    # @param request [OpenStruct, Hash] The request object that contains all of the new connector information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_connector(connector_id, request)
+      start.uri('/api/connector')
+          .url_segment(connector_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put()
+          .go()
+    end
+
     #
     # Updates the consent with the given Id.
     #
@@ -2495,6 +2760,34 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Updates the form with the given Id.
+    #
+    # @param form_id [string] The Id of the form to update.
+    # @param request [OpenStruct, Hash] The request object that contains all of the new form information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_form(form_id, request)
+      start.uri('/api/form')
+          .url_segment(form_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put()
+          .go()
+    end
+
+    #
+    # Updates the form field with the given Id.
+    #
+    # @param field_id [string] The Id of the form field to update.
+    # @param request [OpenStruct, Hash] The request object that contains all of the new form field information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_form_field(field_id, request)
+      start.uri('/api/form/field')
+          .url_segment(field_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put()
+          .go()
+    end
+
     #
     # Updates the group with the given Id.
     #
@@ -2712,7 +3005,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.17.0
+  version: 1.21.0
 platform: ruby
 authors:
 - Brian Pontarelli
 - Daniel DeGroff
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-11-10 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
@@ -51,8 +51,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: The Ruby client library for FusionAuth
 test_files: []