yoti 1.6.1 → 1.7.1

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

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Create
+        class SdkConfig
+          #
+          # @param [String] allowed_capture_methods
+          # @param [String] primary_colour
+          # @param [String] secondary_colour
+          # @param [String] font_colour
+          # @param [String] locale
+          # @param [String] preset_issuing_country
+          # @param [String] success_url
+          # @param [String] error_url
+          #
+          def initialize(
+            allowed_capture_methods,
+            primary_colour,
+            secondary_colour,
+            font_colour,
+            locale,
+            preset_issuing_country,
+            success_url,
+            error_url
+          )
+            Validation.assert_is_a(String, allowed_capture_methods, 'allowed_capture_methods', true)
+            @allowed_capture_methods = allowed_capture_methods
+
+            Validation.assert_is_a(String, primary_colour, 'primary_colour', true)
+            @primary_colour = primary_colour
+
+            Validation.assert_is_a(String, secondary_colour, 'secondary_colour', true)
+            @secondary_colour = secondary_colour
+
+            Validation.assert_is_a(String, font_colour, 'font_colour', true)
+            @font_colour = font_colour
+
+            Validation.assert_is_a(String, locale, 'locale', true)
+            @locale = locale
+
+            Validation.assert_is_a(String, preset_issuing_country, 'preset_issuing_country', true)
+            @preset_issuing_country = preset_issuing_country
+
+            Validation.assert_is_a(String, success_url, 'success_url', true)
+            @success_url = success_url
+
+            Validation.assert_is_a(String, error_url, 'error_url', true)
+            @error_url = error_url
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              allowed_capture_methods: @allowed_capture_methods,
+              primary_colour: @primary_colour,
+              secondary_colour: @secondary_colour,
+              font_colour: @font_colour,
+              locale: @locale,
+              preset_issuing_country: @preset_issuing_country,
+              success_url: @success_url,
+              error_url: @error_url
+            }.compact
+          end
+
+          #
+          # @return [SdkConfigBuilder]
+          #
+          def self.builder
+            SdkConfigBuilder.new
+          end
+        end
+
+        #
+        # Builder to assist in the creation of {SdkConfig}.
+        #
+        class SdkConfigBuilder
+          def initialize
+            @topics = []
+          end
+
+          #
+          # Sets the allowed capture method to "CAMERA"
+          #
+          # @return [self]
+          #
+          def with_allows_camera
+            with_allowed_capture_methods(Constants::CAMERA)
+          end
+
+          #
+          # Sets the allowed capture method to "CAMERA_AND_UPLOAD"
+          #
+          # @return [self]
+          #
+          def with_allows_camera_and_upload
+            with_allowed_capture_methods(Constants::CAMERA_AND_UPLOAD)
+          end
+
+          #
+          # Sets the allowed capture method
+          #
+          # @param [String] allowed_capture_methods
+          #
+          # @return [self]
+          #
+          def with_allowed_capture_methods(allowed_capture_methods)
+            @allowed_capture_methods = allowed_capture_methods
+            self
+          end
+
+          #
+          # Sets the primary colour to be used by the web/native client
+          #
+          # @param [String] primary_colour
+          #
+          # @return [self]
+          #
+          def with_primary_colour(primary_colour)
+            @primary_colour = primary_colour
+            self
+          end
+
+          #
+          # Sets the secondary colour to be used by the web/native client (used on the button)
+          #
+          # @param [String] secondary_colour
+          #
+          # @return [self]
+          #
+          def with_secondary_colour(secondary_colour)
+            @secondary_colour = secondary_colour
+            self
+          end
+
+          #
+          # Sets the font colour to be used by the web/native client (used on the button)
+          #
+          # @param [String] font_colour
+          #
+          # @return [self]
+          #
+          def with_font_colour(font_colour)
+            @font_colour = font_colour
+            self
+          end
+
+          #
+          # Sets the locale on the builder
+          #
+          # @param [String] locale
+          #
+          # @return [self]
+          #
+          def with_locale(locale)
+            @locale = locale
+            self
+          end
+
+          #
+          # Sets the preset issuing country on the builder
+          #
+          # @param [String] preset_issuing_country
+          #
+          # @return [self]
+          #
+          def with_preset_issuing_country(preset_issuing_country)
+            @preset_issuing_country = preset_issuing_country
+            self
+          end
+
+          #
+          # Sets the success URL for the redirect that follows the web/native client
+          # uploading documents successfully
+          #
+          # @param [String] success_url
+          #
+          # @return [self]
+          #
+          def with_success_url(success_url)
+            @success_url = success_url
+            self
+          end
+
+          #
+          # Sets the error URL for the redirect that follows the web/native client
+          # uploading documents unsuccessfully
+          #
+          # @param [String] error_url
+          #
+          # @return [self]
+          #
+          def with_error_url(error_url)
+            @error_url = error_url
+            self
+          end
+
+          #
+          # @return [SdkConfig]
+          #
+          def build
+            SdkConfig.new(
+              @allowed_capture_methods,
+              @primary_colour,
+              @secondary_colour,
+              @font_colour,
+              @locale,
+              @preset_issuing_country,
+              @success_url,
+              @error_url
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,203 @@
+# 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
+          #
+          def initialize(
+            client_session_token_ttl,
+            resources_ttl,
+            user_tracking_id,
+            notifications,
+            requested_checks,
+            requested_tasks,
+            sdk_config,
+            required_documents
+          )
+            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
+          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)
+            }.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
+
+          #
+          # @return [SessionSpecification]
+          #
+          def build
+            SessionSpecification.new(
+              @client_session_token_ttl,
+              @resources_ttl,
+              @user_tracking_id,
+              @notifications,
+              @requested_checks,
+              @requested_tasks,
+              @sdk_config,
+              @required_documents
+            )
+          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