fusionauth_client 1.36.0 → 1.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f821148b188a2af1ed2e36d1c24b0fdae610792f4ebabe404e226bd6964d451
-  data.tar.gz: a98b63e213361a0f0f7d759ca14294b8350596c9f8c27107baaf6ba1a4c36107
+  metadata.gz: 5eb61cb704a42c5bd5a998859c6ffb26b9b289c58c45c9b75efe733c665ebc8b
+  data.tar.gz: 740ac46b4224832c35d25d4b17b5f1a85154db828e5fcec345cbd54c9b84fc0d
 SHA512:
-  metadata.gz: 063a4e86f5c39639528877e9b0d2e041d0324e004465e3ad7b7232fe2ae663105c758f91a000f15c911399daf3ab5c60cf13a57458abcb880b12d56d7d0b99b7
-  data.tar.gz: 76cfedf73cff40f2383f9448e1db57bbed078c8b9fab7fbf526fd1f82885bab44c322a122e5918ac72d32f1269b98ce526bbefc58357161cc71cad9706cbdb96
+  metadata.gz: caee0c1e79f338f05ec359edf332fc5432e29bf382e3a04c0130921e0c9785cf99f8d082affa9f49e00b4fff1904fbdf861b4f355c40db235e0b9539a9136459
+  data.tar.gz: 9186f9f3784eca040d3da2e2a949fb424d89a7ba9da258c01f532aa9f1dea1ce268920788b8216cd9b1fe26f833ebd7fbfd9cccb1040741fa87826424ea89fac

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fusionauth_client (1.36.0)
+    fusionauth_client (1.37.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -20,44 +20,9 @@ Or install it yourself as:
 
 ## Usage
 
-Once the gem is installed, you can call FusionAuth APIs like this:
+Once the gem is installed, you can call FusionAuth APIs.
 
-```ruby
-require 'fusionauth/fusionauth_client'
-
-# Construct the FusionAuth Client
-client = FusionAuth::FusionAuthClient.new(
-    '<YOUR_API_KEY>', 
-    'http://localhost:9011'
-)
-
-# Create a user + registration
-id = SecureRandom.uuid
-client.register(id, {
-    :user => {
-        :firstName => 'Ruby',
-        :lastName => 'Client',
-        :email => 'ruby.client.test@fusionauth.io',
-        :password => 'password'
-    },
-    :registration => {
-        :applicationId => application_id,
-        :data => {
-            :foo => 'bar'
-        },
-        :preferredLanguages => %w(en fr),
-        :roles => %w(user)
-    }
-})
-
-# Authenticate the user
-response = client.login({
-    :loginId => 'ruby.client.test@fusionauth.io',
-    :password => 'password',
-    :applicationId => application_id
-})
-user = response.success.response.user
-```
+See examples in the `examples` directory.
 
 ## Questions and support
 

data/build.savant

@@ -16,7 +16,7 @@
 savantVersion = "1.0.0"
 
 pubVersion = ""
-project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.36.0", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.37.0", licenses: ["ApacheV2_0"]) {
   workflow {
     fetch {
       cache()

data/examples/create_user.rb

@@ -0,0 +1,35 @@
+require 'fusionauth/fusionauth_client'
+require 'securerandom'
+
+# Construct the FusionAuth Client
+client = FusionAuth::FusionAuthClient.new(
+    'APIKEY', 
+    'http://localhost:9011'
+)
+
+application_id = '20ce6dac-b985-4c77-bb59-6369249f884b'
+
+# Create a user + registration
+id = SecureRandom.uuid
+response = client.register(id, {
+    :user => {
+        :firstName => 'Ruby',
+        :lastName => 'Client',
+        :email => 'ruby.client.test@fusionauth.io',
+        :password => 'password'
+    },
+    :registration => {
+        :applicationId => application_id,
+        :data => {
+            :foo => 'bar'
+        },
+        :preferredLanguages => %w(en fr),
+        :roles => %w(user)
+    }
+})
+
+unless response.success_response
+  print response.error_response
+  exit
+end
+

data/examples/login.rb

@@ -0,0 +1,24 @@
+require 'fusionauth/fusionauth_client'
+require 'securerandom'
+
+# Construct the FusionAuth Client
+client = FusionAuth::FusionAuthClient.new(
+    'APIKEY', 
+    'http://localhost:9011'
+)
+
+application_id = '20ce6dac-b985-4c77-bb59-6369249f884b'
+
+# Authenticate a user
+response = client.login({
+    :loginId => 'ruby.client.test@fusionauth.io',
+    :password => 'password',
+    :applicationId => application_id
+})
+
+if response.success_response
+  user = response.success_response.user
+  print user.id
+else 
+  print response.error_response
+end

data/fusionauth-ruby-client.iml

@@ -16,16 +16,16 @@
     <option name="myRootTask">
       <RakeTaskImpl id="rake">
         <subtasks>
-          <RakeTaskImpl description="Build fusionauth_client-1.28.1.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl description="Build fusionauth_client-1.37.0.gem into the pkg directory" fullCommand="build" id="build" />
           <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
           <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
-          <RakeTaskImpl description="Build and install fusionauth_client-1.28.1.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl description="Build and install fusionauth_client-1.37.0.gem into system gems" fullCommand="install" id="install" />
           <RakeTaskImpl id="install">
             <subtasks>
-              <RakeTaskImpl description="Build and install fusionauth_client-1.28.1.gem into system gems without network access" fullCommand="install:local" id="local" />
+              <RakeTaskImpl description="Build and install fusionauth_client-1.37.0.gem into system gems without network access" fullCommand="install:local" id="local" />
             </subtasks>
           </RakeTaskImpl>
-          <RakeTaskImpl description="Create tag v1.28.1 and build and push fusionauth_client-1.28.1.gem to https://rubygems.org" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="Create tag v1.37.0 and build and push fusionauth_client-1.37.0.gem to https://rubygems.org" fullCommand="release[remote]" id="release[remote]" />
           <RakeTaskImpl description="Run tests" fullCommand="test" id="test" />
           <RakeTaskImpl description="" fullCommand="default" id="default" />
           <RakeTaskImpl description="" fullCommand="release" id="release" />

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

data/lib/fusionauth/fusionauth_client.rb

@@ -2,7 +2,7 @@ require 'ostruct'
 require 'fusionauth/rest_client'
 
 #
-# Copyright (c) 2018-2019, FusionAuth, All Rights Reserved
+# Copyright (c) 2018-2022, FusionAuth, All Rights Reserved
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -130,9 +130,9 @@ module FusionAuth
     #
     # Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
     # When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
-    # your password, you must obtain a Truest Token by completing a Two-Factor Step-Up authentication.
+    # your password, you must obtain a Trust Token by completing a Two-Factor Step-Up authentication.
     # 
-    # An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
+    # An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API.
     #
     # @param change_password_id [string] The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -146,9 +146,9 @@ module FusionAuth
     #
     # Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
     # When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
-    # your password, you must obtain a Truest Token by completing a Two-Factor Step-Up authentication.
+    # your password, you must obtain a Trust Token by completing a Two-Factor Step-Up authentication.
     # 
-    # An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
+    # An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API.
     #
     # @param encoded_jwt [string] The encoded JWT (access token).
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -162,9 +162,9 @@ module FusionAuth
     #
     # Check to see if the user must obtain a Trust Request Id in order to complete a change password request.
     # When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
-    # your password, you must obtain a Truest Request Id by completing a Two-Factor Step-Up authentication.
+    # your password, you must obtain a Trust Request Id by completing a Two-Factor Step-Up authentication.
     # 
-    # An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
+    # An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API.
     #
     # @param login_id [string] The loginId of the User that you intend to change the password for.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -1511,6 +1511,21 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Sends a ping to FusionAuth indicating that the user was automatically logged into an application. When using
+    # FusionAuth's SSO or your own, you should call this if the user is already logged in centrally, but accesses an
+    # application where they no longer have a session. This helps correctly track login counts, times and helps with
+    # reporting.
+    #
+    # @param request [OpenStruct, Hash] The login request that contains the user credentials used to log them in.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def login_ping_with_request(request)
+      start.uri('/api/login')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put()
+          .go()
+    end
+
     #
     # The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the
     # client and revoke the refresh token stored. This API does nothing if the request does not contain an access
@@ -2780,13 +2795,13 @@ module FusionAuth
     end
 
     #
-    # Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token, if you have that, you already have what you need..
+    # Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token. If you have that, you already have what you need.
     #
-    # @param user_id [string] The Id of the user.
+    # @param token_id [string] The Id of the token.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
-    def retrieve_refresh_token_by_id(user_id)
+    def retrieve_refresh_token_by_id(token_id)
       start.uri('/api/jwt/refresh')
-          .url_segment(user_id)
+          .url_segment(token_id)
           .get()
           .go()
     end
@@ -2922,6 +2937,25 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieve a user's two-factor status.
+    # 
+    # This can be used to see if a user will need to complete a two-factor challenge to complete a login,
+    # and optionally identify the state of the two-factor trust across various applications.
+    #
+    # @param user_id [string] The user Id to retrieve the Two-Factor status.
+    # @param application_id [string] The optional applicationId to verify.
+    # @param two_factor_trust_id [string] The optional two-factor trust Id to verify.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_two_factor_status(user_id, application_id, two_factor_trust_id)
+      start.uri('/api/two-factor/status')
+          .url_parameter('userId', user_id)
+          .url_parameter('applicationId', application_id)
+          .url_segment(two_factor_trust_id)
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the user for the given Id.
     #
@@ -4151,6 +4185,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Administratively verify a user's email address. Use this method to bypass email verification for the user.
+    # 
+    # The request body will contain the userId to be verified. An API key is required when sending the userId in the request body.
+    #
+    # @param request [OpenStruct, Hash] The request that contains the userId to verify.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def verify_email_address_by_user_id(request)
+      start.uri('/api/user/verify-email')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Confirms an application registration. The Id given is usually from an email sent to the user.
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fusionauth_client
 version: !ruby/object:Gem::Version
-  version: 1.36.0
+  version: 1.37.0
 platform: ruby
 authors:
 - Brian Pontarelli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-08 00:00:00.000000000 Z
+date: 2022-08-11 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.
@@ -28,6 +28,8 @@ files:
 - README.md
 - Rakefile
 - build.savant
+- examples/create_user.rb
+- examples/login.rb
 - fusionauth-ruby-client.iml
 - fusionauth_client.gemspec
 - lib/fusionauth/fusionauth_client.rb