yoti 1.6.4 → 1.10.0

data/lib/yoti/doc_scan/session/create/session_specification.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Create
+        class SessionSpecification
+          #
+          # @param [Integer] client_session_token_ttl
+          # @param [Integer] resources_ttl
+          # @param [String] user_tracking_id
+          # @param [NotificationConfig] notifications
+          # @param [Array<RequestedCheck>] requested_checks
+          # @param [Array<RequestedTask>] requested_tasks
+          # @param [SdkConfig] sdk_config
+          # @param [Array<RequiredDocument>] required_documents
+          # @param [Boolean] block_biometric_consent
+          #
+          def initialize(
+            client_session_token_ttl,
+            resources_ttl,
+            user_tracking_id,
+            notifications,
+            requested_checks,
+            requested_tasks,
+            sdk_config,
+            required_documents,
+            block_biometric_consent = nil
+          )
+            Validation.assert_is_a(Integer, client_session_token_ttl, 'client_session_token_ttl', true)
+            @client_session_token_ttl = client_session_token_ttl
+
+            Validation.assert_is_a(Integer, resources_ttl, 'resources_ttl', true)
+            @resources_ttl = resources_ttl
+
+            Validation.assert_is_a(String, user_tracking_id, 'user_tracking_id', true)
+            @user_tracking_id = user_tracking_id
+
+            Validation.assert_is_a(NotificationConfig, notifications, 'notifications', true)
+            @notifications = notifications
+
+            Validation.assert_is_a(Array, requested_checks, 'requested_checks', true)
+            @requested_checks = requested_checks
+
+            Validation.assert_is_a(Array, requested_tasks, 'requested_tasks', true)
+            @requested_tasks = requested_tasks
+
+            Validation.assert_is_a(SdkConfig, sdk_config, 'sdk_config', true)
+            @sdk_config = sdk_config
+
+            Validation.assert_is_a(Array, required_documents, 'required_documents', true)
+            @required_documents = required_documents
+
+            @block_biometric_consent = block_biometric_consent
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              client_session_token_ttl: @client_session_token_ttl,
+              resources_ttl: @resources_ttl,
+              user_tracking_id: @user_tracking_id,
+              notifications: @notifications,
+              requested_checks: @requested_checks.map(&:as_json),
+              requested_tasks: @requested_tasks.map(&:as_json),
+              sdk_config: @sdk_config,
+              required_documents: @required_documents.map(&:as_json),
+              block_biometric_consent: @block_biometric_consent
+            }.compact
+          end
+
+          #
+          # @return [SessionSpecificationBuilder]
+          #
+          def self.builder
+            SessionSpecificationBuilder.new
+          end
+        end
+
+        class SessionSpecificationBuilder
+          def initialize
+            @requested_checks = []
+            @requested_tasks = []
+            @required_documents = []
+          end
+
+          #
+          # Client-session-token time-to-live to apply to the created session
+          #
+          # @param [Integer] client_session_token_ttl
+          #
+          # @return [self]
+          #
+          def with_client_session_token_ttl(client_session_token_ttl)
+            @client_session_token_ttl = client_session_token_ttl
+            self
+          end
+
+          #
+          # Time-to-live used for all Resources created in the course of the session
+          #
+          # @param [Integer] resources_ttl
+          #
+          # @return [self]
+          #
+          def with_resources_ttl(resources_ttl)
+            @resources_ttl = resources_ttl
+            self
+          end
+
+          #
+          # User tracking id, for the Relying Business to track returning users
+          #
+          # @param [String] user_tracking_id
+          #
+          # @return [self]
+          #
+          def with_user_tracking_id(user_tracking_id)
+            @user_tracking_id = user_tracking_id
+            self
+          end
+
+          #
+          # For configuring call-back messages
+          #
+          # @param [NotificationConfig] notifications
+          #
+          # @return [self]
+          #
+          def with_notifications(notifications)
+            @notifications = notifications
+            self
+          end
+
+          #
+          # The check to be performed on each Document
+          #
+          # @param [RequestedCheck] requested_check
+          #
+          # @return [self]
+          #
+          def with_requested_check(requested_check)
+            Validation.assert_is_a(RequestedCheck, requested_check, 'requested_check')
+            @requested_checks.push(requested_check)
+            self
+          end
+
+          #
+          # The task to be performed on each Document
+          #
+          # @param [RequestedTask] requested_task
+          #
+          # @return [self]
+          #
+          def with_requested_task(requested_task)
+            Validation.assert_is_a(RequestedTask, requested_task, 'requested_task')
+            @requested_tasks.push(requested_task)
+            self
+          end
+
+          #
+          # The SDK configuration set on the session specification
+          #
+          # @param [SdkConfig] sdk_config
+          #
+          # @return [self]
+          #
+          def with_sdk_config(sdk_config)
+            @sdk_config = sdk_config
+            self
+          end
+
+          #
+          # Adds a RequiredDocument to the list documents required from the client
+          #
+          # @param [RequiredDocument] required_document
+          #
+          # @return [self]
+          #
+          def with_required_document(required_document)
+            Validation.assert_is_a(RequiredDocument, required_document, 'required_document')
+            @required_documents.push(required_document)
+            self
+          end
+
+          #
+          # Whether or not to block the collection of biometric consent
+          #
+          # @param [Boolean] block_biometric_consent
+          #
+          # @return [self]
+          #
+          def with_block_biometric_consent(block_biometric_consent)
+            @block_biometric_consent = block_biometric_consent
+            self
+          end
+
+          #
+          # @return [SessionSpecification]
+          #
+          def build
+            SessionSpecification.new(
+              @client_session_token_ttl,
+              @resources_ttl,
+              @user_tracking_id,
+              @notifications,
+              @requested_checks,
+              @requested_tasks,
+              @sdk_config,
+              @required_documents,
+              @block_biometric_consent
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/authenticity_check_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class AuthenticityCheckResponse < CheckResponse
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/breakdown_response.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class BreakdownResponse
+          # @return [String]
+          attr_reader :sub_check
+
+          # @return [String]
+          attr_reader :result
+
+          # @return [Array<DetailsResponse>]
+          attr_reader :details
+
+          #
+          # @param [Hash] breakdown
+          #
+          def initialize(breakdown)
+            Validation.assert_is_a(String, breakdown['sub_check'], 'sub_check', true)
+            @sub_check = breakdown['sub_check']
+
+            Validation.assert_is_a(String, breakdown['result'], 'result', true)
+            @result = breakdown['result']
+
+            if breakdown['details'].nil?
+              @details = []
+            else
+              Validation.assert_is_a(Array, breakdown['details'], 'details')
+              @details = breakdown['details'].map { |details| DetailsResponse.new(details) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/check_response.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class CheckResponse
+          # @return [String]
+          attr_reader :type
+
+          # @return [String]
+          attr_reader :id
+
+          # @return [String]
+          attr_reader :state
+
+          # @return [Array<String>]
+          attr_reader :resources_used
+
+          # @return [Array<GeneratedMedia>]
+          attr_reader :generated_media
+
+          # @return [<ReportResponse>]
+          attr_reader :report
+
+          # @return [<DateTime>]
+          attr_reader :created
+
+          # @return [<DateTime>]
+          attr_reader :last_updated
+
+          #
+          # @param [Hash] check
+          #
+          def initialize(check)
+            Validation.assert_is_a(String, check['type'], 'type', true)
+            @type = check['type']
+
+            Validation.assert_is_a(String, check['id'], 'id', true)
+            @id = check['id']
+
+            Validation.assert_is_a(String, check['state'], 'state', true)
+            @state = check['state']
+
+            Validation.assert_is_a(Array, check['resources_used'], 'resources_used', true)
+            @resources_used = check['resources_used']
+
+            if check['generated_media'].nil?
+              @generated_media = []
+            else
+              Validation.assert_is_a(Array, check['generated_media'], 'generated_media')
+              @generated_media = check['generated_media'].map { |media| GeneratedMedia.new(media) }
+            end
+
+            @report = ReportResponse.new(check['report']) unless check['report'].nil?
+            @created = DateTime.parse(check['created']) unless check['created'].nil?
+            @last_updated = DateTime.parse(check['last_updated']) unless check['last_updated'].nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/details_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class DetailsResponse
+          # @return [String]
+          attr_reader :name
+
+          # @return [String]
+          attr_reader :value
+
+          #
+          # @param [Hash] details
+          #
+          def initialize(details)
+            Validation.assert_is_a(String, details['name'], 'name', true)
+            @name = details['name']
+
+            Validation.assert_is_a(String, details['value'], 'value', true)
+            @value = details['value']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/document_fields_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class DocumentFieldsResponse
+          # @return [MediaResponse]
+          attr_reader :media
+
+          #
+          # @param [Hash] document_fields
+          #
+          def initialize(document_fields)
+            @media = MediaResponse.new(document_fields['media']) unless document_fields['media'].nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/document_id_photo_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class DocumentIdPhotoResponse
+          # @return [MediaResponse]
+          attr_reader :media
+
+          #
+          # @param [Hash] document_id_photo
+          #
+          def initialize(document_id_photo)
+            @media = MediaResponse.new(document_id_photo['media']) unless document_id_photo['media'].nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/face_map_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class FaceMapResponse
+          # @return [MediaResponse]
+          attr_reader :media
+
+          #
+          # @param [Hash] facemap
+          #
+          def initialize(facemap)
+            @media = MediaResponse.new(facemap['media']) unless facemap['media'].nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/face_match_check_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class FaceMatchCheckResponse < CheckResponse
+        end
+      end
+    end
+  end
+end