trusona 2.2.0 → 2.5.2

data/lib/trusona/resources/paired_tru_code.rb

@@ -2,6 +2,7 @@
 
 module Trusona
   module Resources
+    ## A Paired Trucode
     class PairedTruCode < BaseResource
       attr_reader :identifier
 

data/lib/trusona/resources/tru_code.rb

@@ -19,7 +19,7 @@ module Trusona
         raise ArgumentError unless validate
       end
 
-      def to_json
+      def to_json(*_args)
         JSON(to_h)
       end
 
@@ -35,6 +35,7 @@ module Trusona
 
       def validate
         return false unless present?(@relying_party_id)
+
         true
       end
     end

data/lib/trusona/resources/trusonafication.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/ClassLength
 module Trusona
   module Resources
     ##
@@ -11,13 +12,14 @@ module Trusona
       attr_accessor :device_identifier, :user_identifier, :trucode_id,
                     :resource, :action, :level, :id, :email,
                     :accepted_level, :trusona_id, :expires_at,
-                    :user_presence, :prompt, :custom_fields
+                    :user_presence, :prompt, :custom_fields, :callback_url
 
       # rubocop:disable Metrics/AbcSize
       # rubocop:disable Metrics/MethodLength
       def initialize(params = {})
         @params = normalize_keys(params)
         return if @params.nil?
+
         self.accepted_level    = determine_accepted_level(@params)
         self.action            = @params[:action]
         self.device_identifier = @params[:device_identifier]
@@ -32,6 +34,7 @@ module Trusona
         self.prompt            = defaulting_to(true, @params[:prompt])
         self.user_presence     = defaulting_to(true, @params[:user_presence])
         self.custom_fields     = @params[:custom_fields]
+        self.callback_url      = @params[:callback_url]
 
         @status = @params[:status]
       end
@@ -43,27 +46,31 @@ module Trusona
       end
 
       # rubocop:disable Metrics/MethodLength
-      def to_json
-        JSON(device_identifier: device_identifier,
-             user_identifier: user_identifier,
-             trucode_id: trucode_id,
-             trusona_id: trusona_id,
-             email: email,
-             resource: resource,
-             action: action,
-             desired_level: level,
-             id: id,
-             status: @status,
-             prompt: prompt,
-             user_presence: user_presence,
-             custom_fields: custom_fields,
-             expires_at: expires_at&.iso8601)
+      def to_json(*_args)
+        JSON(
+          device_identifier: device_identifier,
+          user_identifier: user_identifier,
+          trucode_id: trucode_id,
+          trusona_id: trusona_id,
+          email: email,
+          resource: resource,
+          action: action,
+          desired_level: level,
+          id: id,
+          status: @status,
+          prompt: prompt,
+          user_presence: user_presence,
+          custom_fields: custom_fields,
+          expires_at: expires_at&.iso8601,
+          callback_url: callback_url
+        )
       end
       # rubocop:enable Metrics/MethodLength
 
       def accepted?
         return true if status == :accepted
         return true if status == :accepted_at_higher_level
+
         false
       end
 
@@ -75,8 +82,8 @@ module Trusona
         attributes_present && attributes_filled
       end
 
-      # rubocop:disable MethodLength
-      # rubocop:disable CyclomaticComplexity
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/CyclomaticComplexity
       def status
         case @status
         when 'INVALID_TRUSONA_ID'
@@ -99,14 +106,15 @@ module Trusona
           :invalid
         end
       end
-      # rubocop:enable CyclomaticComplexity
-      # rubocop:enable MethodLength
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/MethodLength
 
       private
 
       def defaulting_to(value, param)
         return value if param.nil?
         return value if param.respond_to?(:empty?) && param.empty?
+
         param
       end
 
@@ -137,3 +145,4 @@ module Trusona
     end
   end
 end
+# rubocop:enable Metrics/ClassLength

data/lib/trusona/resources/user_account.rb

@@ -38,12 +38,12 @@ module Trusona
         @emails     = parse_emails(params_with_symbol_keys[:emails])
         @max_level  = parse_max_level(params_with_symbol_keys[:metadata])
 
-        @params     = params_with_symbol_keys
+        @params = params_with_symbol_keys
       end
       # rubocop:enable Metrics/MethodLength
       # rubocop:enable Metrics/AbcSize
 
-      def to_json
+      def to_json(*_args)
         JSON(to_h)
       end
 
@@ -52,20 +52,24 @@ module Trusona
       def determine_status(status)
         return Status::INACTIVE if status == 'inactive'
         return Status::ACTIVE if status == 'active'
+
         Status::UNKNOWN
       end
 
       def parse_emails(emails)
         return [] if emails.nil? || emails.empty?
+
         emails.map { |e| UserAccountEmail.new(e) }
       end
 
       def parse_max_level(metadata)
         return Level::ENTRY unless metadata
+
         level = metadata['max_level'] || metadata[:max_level]
 
         return Level::ESSENTIAL if level == 'essential'
         return Level::EXECUTIVE if level == 'executive'
+
         Level::ENTRY
       end
 

data/lib/trusona/resources/user_identifier.rb

@@ -19,7 +19,7 @@ module Trusona
         @params
       end
 
-      def to_json
+      def to_json(*_args)
         JSON(to_h)
       end
 
@@ -36,12 +36,14 @@ module Trusona
       def attributes_present
         return false unless @params.key?(:identifier)
         return false unless @params.key?(:trusona_id)
+
         true
       end
 
       def attributes_filled
         return false if @params.fetch(:identifier).empty?
         return false if @params.fetch(:trusona_id).empty?
+
         true
       end
     end

data/lib/trusona/resources/validators.rb

@@ -7,6 +7,7 @@ module Trusona
     module Validators
       def present?(item)
         return false if item.nil? || item.to_s.empty?
+
         true
       end
 

data/lib/trusona/services/base_service.rb

@@ -21,21 +21,25 @@ module Trusona
 
       def get(resource)
         raise Trusona::InvalidResourceError unless resource.id
+
         handle(@client.get(member_path(resource)), resource)
       end
 
       def create(resource)
         raise Trusona::InvalidResourceError unless resource.valid?
+
         handle(@client.post(collection_path, resource.to_json), resource)
       end
 
       def update(resource)
         raise Trusona::InvalidResourceError unless resource.id
+
         handle(@client.patch(member_path(resource), resource.to_json), resource)
       end
 
       def delete(resource)
         raise Trusona::InvalidResourceError unless resource.id
+
         handle(@client.delete(member_path(resource)), resource)
       end
 
@@ -53,12 +57,13 @@ module Trusona
         raise Trusona::SigningError unless response.verified?
       end
 
-      # rubocop:disable MethodLength
+      # rubocop:disable Metrics/MethodLength
       # rubocop:disable Metrics/CyclomaticComplexity
       def handle(response, resource = {})
         @response = response
 
         raise if resource.nil?
+
         case response.code
         when 200..299
           success(response, resource)
@@ -78,7 +83,7 @@ module Trusona
           raise Trusona::RequestError, readable_error
         end
       end
-      # rubocop:enable MethodLength
+      # rubocop:enable Metrics/MethodLength
       # rubocop:enable Metrics/CyclomaticComplexity
 
       def success(response, resource)
@@ -113,10 +118,12 @@ module Trusona
       def readable_error
         default = '[UNKNOWN] Error - An unknown error has occurred.'
         return default unless @response
+
         body = @response.to_h
         msg = []
         msg << "[#{body['error']}] #{body['message']} - #{body['description']}"
         return msg.join("\n") unless body['field_errors']
+
         body['field_errors'].each do |field|
           msg << "\t #{field.join(' => ')}"
         end

data/lib/trusona/services/device_user_bindings_service.rb

@@ -6,9 +6,9 @@ module Trusona
     ## Device User Bindings Service
     class DeviceUserBindingsService < BaseService
       def initialize(
-          client: Trusona::Api::HTTPClient.new(Trusona.config.api_host),
-          mapper: Trusona::Mappers::DeviceUserBindingMapper.new
-        )
+        client: Trusona::Api::HTTPClient.new(Trusona.config.api_host),
+        mapper: Trusona::Mappers::DeviceUserBindingMapper.new
+      )
         @client = client
         @mapper = mapper
         @resource_path = '/api/v2/user_devices'

data/lib/trusona/services/identity_documents_service.rb

@@ -6,9 +6,9 @@ module Trusona
     ## Identity Documents Service
     class IdentityDocumentsService < BaseService
       def initialize(
-          client: Trusona::Api::HTTPClient.new(Trusona.config.api_host),
-          mapper: Trusona::Mappers::IdentityDocumentMapper.new
-        )
+        client: Trusona::Api::HTTPClient.new(Trusona.config.api_host),
+        mapper: Trusona::Mappers::IdentityDocumentMapper.new
+      )
         @client = client
         @mapper = mapper
         @resource_path = '/api/v2/identity_documents'

data/lib/trusona/services/paired_tru_code_service.rb

@@ -2,6 +2,7 @@
 
 module Trusona
   module Services
+    ## Paired trucode service
     class PairedTruCodeService < BaseService
       def initialize(client: Trusona::Api::HTTPClient.new)
         super(client: client, mapper: Trusona::Mappers::PairedTruCodeMapper.new)

data/lib/trusona/trusonafication.rb

@@ -28,6 +28,29 @@ module Trusona
       Trusona::Workers::TrusonaficationFinder.new.find(trusonafication_id)
     end
 
+    ##
+    # Cancels existing IN_PROGRESS Trusonafications using their ID. Once
+    # canceled the trusonafication can no longer be acted upon.
+    #
+    # @param trusonafication_id [String] the ID of an existing Trusonafication
+    # @raise [Trusona::InvalidRecordIdentifier] if the +trusonafication_id+ is
+    #   empty or nil.
+    # @raise [Trusona::ResourceNotFoundError] if the resource does not exist
+    #   in the Trusona API
+    # @raise [Trusona::UnprocessableEntityError] if the resource could not be
+    #   cancel because it was not IN_PROGRESS
+    #
+    # @example
+    #   Trusona::Trusonafication.cancel('756c1034-2159-4cf9-bd48-662a60a7afff')
+    #
+    def self.cancel(trusonafication_id)
+      if trusonafication_id.nil? || trusonafication_id.strip.empty?
+        raise Trusona::InvalidRecordIdentifier, 'Trusonafication ID is missing'
+      end
+
+      Trusona::Workers::TrusonaficationCanceler.new.cancel(trusonafication_id)
+    end
+
     ##
     # Creates a Trusonafication using the supplied options
     #
@@ -55,12 +78,18 @@ module Trusona
     #  Accept or Reject this Trusonafication?
     # @option params [String] :expires_at ('90 seconds') The ISO-8601 UTC
     #  timestamp of the Trusonafication's expiration.
-    # @param timeout [Int] (30) The max amount of time, in seconds, to wait
-    #  for a response from the Trusona API when polling for a Trusonafication
-    #  result
     # @option params [Hash] :custom_fields Optional data to be associated with
     #  this Trusonafication and can be used to constomize any UX elements. Total
     #  size of data is limited to 1MB.
+    # @option params [String] :callback_url A HTTPS URL to POST to call when the
+    #  trusonafication has been completed (accepted, rejected, or expired).
+    #
+    #  NOTE: The URL should include a randomized segment so it cannot be guessed
+    #  and abused by third-parties e.g. https://your.domain.com/completed_authentications/f8abe61d-4e51-493f-97b1-464c157624f2.
+    #
+    # @param timeout [Int] (30) The max amount of time, in seconds, to wait
+    #  for a response from the Trusona API when polling for a Trusonafication
+    #  result
     # @yield [Trusona::Resources::Trusonafication] Yields the completed
     #  Trusonafication to the block
     # @raise [Trusona::InvalidResourceError] if the resource is not +valid?+

data/lib/trusona/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Trusona
-  VERSION = '2.2.0'
+  VERSION = '2.5.2'
 end

data/lib/trusona/workers/device_finder.rb

@@ -11,6 +11,7 @@ module Trusona
 
       def find(id = nil)
         raise(ArgumentError, 'A device identifier is required.') unless id
+
         @service.get(Trusona::Resources::Device.new(id: id))
       end
     end

data/lib/trusona/workers/identity_document_finder.rb

@@ -18,6 +18,7 @@ module Trusona
 
       def find(id = nil)
         raise(ArgumentError, 'An Identity Document id is required.') unless id
+
         @service.get(Trusona::Resources::IdentityDocument.new(id: id))
       end
     end

data/lib/trusona/workers/paired_tru_code_finder.rb

@@ -2,6 +2,7 @@
 
 module Trusona
   module Workers
+    # A Paired Trucode Finder
     class PairedTruCodeFinder
       def initialize(service: Trusona::Services::PairedTruCodeService.new)
         @service = service

data/lib/trusona/workers/tru_code_finder.rb

@@ -11,6 +11,7 @@ module Trusona
 
       def find(id)
         raise ArgumentError, 'Missing TruCode Id' unless id
+
         resource = Trusona::Resources::BaseResource.new(id: id)
         @service.get(resource)
       end

data/lib/trusona/workers/trusonafication_canceler.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Workers
+    #
+    ## Cancel a Trusonafication
+    class TrusonaficationCanceler
+      def initialize(service: nil)
+        @service = service || Trusona::Services::TrusonaficationService.new
+      end
+
+      def cancel(trusonafication_id)
+        if trusonafication_id.nil? || trusonafication_id.strip.empty?
+          raise(
+            Trusona::InvalidResourceError,
+            'Trusonafication Id cannot be empty or nil'
+          )
+        end
+
+        resource = Trusona::Resources::Trusonafication.new(
+          id: trusonafication_id
+        )
+        @service.delete(resource)
+      end
+    end
+  end
+end

data/lib/trusona/workers/trusonafication_creator.rb

@@ -14,6 +14,7 @@ module Trusona
       def create(params: {}, timeout: nil, &block)
         raise ArgumentError, 'Missing or empty params hash' if
           params.nil? || params.empty?
+
         resource = Trusona::Resources::Trusonafication.new(params)
         trusonafication = @service.create(resource)
         return trusonafication unless block_given?
@@ -43,4 +44,4 @@ module Trusona
       # rubocop:enable Metrics/MethodLength
     end
   end
-end
+end

data/lib/trusona/workers/trusonafication_finder.rb

@@ -24,4 +24,4 @@ module Trusona
       end
     end
   end
-end
+end