yoti 1.6.4 → 1.10.0

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Create
+        #
+        # Requests creation of a Task to be performed on each document
+        #
+        class RequestedTask
+          #
+          # @param [String] type The type of the Task to create
+          # @param [#as_json] config Configuration to apply to the Task
+          #
+          def initialize(type, config)
+            raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(RequestedTask)
+
+            Validation.assert_is_a(String, type, 'type')
+            @type = type
+
+            Validation.assert_respond_to(:as_json, config, 'config')
+            @config = config
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              type: @type,
+              config: @config.as_json
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Create
+        class RequestedTextExtractionTask < RequestedTask
+          #
+          # @param [RequestedTextExtractionTaskConfig] config
+          #
+          def initialize(config)
+            Validation.assert_is_a(
+              RequestedTextExtractionTaskConfig,
+              config,
+              'config'
+            )
+
+            super(Constants::ID_DOCUMENT_TEXT_DATA_EXTRACTION, config)
+          end
+
+          #
+          # @return [RequestedTextExtractionTaskBuilder]
+          #
+          def self.builder
+            RequestedTextExtractionTaskBuilder.new
+          end
+        end
+
+        #
+        # The configuration applied when creating each TextExtractionTask
+        #
+        class RequestedTextExtractionTaskConfig
+          #
+          # @param [String] manual_check
+          #   Describes the manual fallback behaviour applied to each Task
+          # @param [String, nil] chip_data
+          #   Describes the chip data requirement for each Task
+          #
+          def initialize(manual_check, chip_data)
+            Validation.assert_is_a(String, manual_check, 'manual_check')
+            @manual_check = manual_check
+
+            Validation.assert_is_a(String, chip_data, 'chip_data', true)
+            @chip_data = chip_data
+          end
+
+          def as_json(*_args)
+            {
+              manual_check: @manual_check,
+              chip_data: @chip_data
+            }.compact
+          end
+        end
+
+        #
+        # Builder to assist creation of {RequestedTextExtractionTask}
+        #
+        class RequestedTextExtractionTaskBuilder
+          #
+          # Requires that the Task is always followed by a manual TextDataCheck
+          #
+          # @return [self]
+          #
+          def with_manual_check_always
+            @manual_check = Constants::ALWAYS
+            self
+          end
+
+          #
+          # Requires that only failed Tasks are followed by a manual TextDataCheck
+          #
+          # @return [self]
+          #
+          def with_manual_check_fallback
+            @manual_check = Constants::FALLBACK
+            self
+          end
+
+          #
+          # The TextExtractionTask will never fallback to a manual TextDataCheck
+          #
+          # @return [self]
+          #
+          def with_manual_check_never
+            @manual_check = Constants::NEVER
+            self
+          end
+
+          #
+          # @return [self]
+          #
+          def with_chip_data_desired
+            @chip_data = Constants::DESIRED
+            self
+          end
+
+          #
+          # @return [self]
+          #
+          def with_chip_data_ignore
+            @chip_data = Constants::IGNORE
+            self
+          end
+
+          #
+          # @return [RequestedTextExtractionTask]
+          #
+          def build
+            config = RequestedTextExtractionTaskConfig.new(@manual_check, @chip_data)
+            RequestedTextExtractionTask.new(config)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Create
+        class RequiredDocument
+          #
+          # @param [String] type
+          #
+          def initialize(type)
+            raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(RequiredDocument)
+
+            Validation.assert_is_a(String, type, 'type')
+            @type = type
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              type: @type
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Create
+        class RequiredIdDocument < RequiredDocument
+          #
+          # @param [DocumentFilter] filter
+          #
+          def initialize(filter = nil)
+            super(Constants::ID_DOCUMENT)
+
+            Validation.assert_is_a(DocumentFilter, filter, 'filter', true)
+            @filter = filter
+          end
+
+          def as_json(*_args)
+            json = super
+            json[:filter] = @filter.as_json unless @filter.nil?
+            json
+          end
+
+          #
+          # @return [RequiredIdDocumentBuilder]
+          #
+          def self.builder
+            RequiredIdDocumentBuilder.new
+          end
+        end
+
+        class RequiredIdDocumentBuilder
+          #
+          # @param [DocumentFilter] filter
+          #
+          # @return [self]
+          #
+          def with_filter(filter)
+            @filter = filter
+            self
+          end
+
+          #
+          # @return [RequiredIdDocument]
+          #
+          def build
+            RequiredIdDocument.new(@filter)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Create
+        class RequiredSupplementaryDocument < RequiredDocument
+          #
+          # @param [Objective] objective
+          # @param [Array<String>] document_types
+          # @param [Array<String>] country_codes
+          #
+          def initialize(objective, document_types, country_codes)
+            super(Constants::SUPPLEMENTARY_DOCUMENT)
+
+            Validation.assert_is_a(Objective, objective, 'objective')
+            @objective = objective
+
+            Validation.assert_is_a(Array, document_types, 'document_types', true)
+            @document_types = document_types
+
+            Validation.assert_is_a(Array, country_codes, 'country_codes', true)
+            @country_codes = country_codes
+          end
+
+          def as_json(*_args)
+            json = super
+            json[:objective] = @objective.as_json
+            json[:document_types] = @document_types unless @document_types.nil?
+            json[:country_codes] = @country_codes unless @country_codes.nil?
+            json
+          end
+
+          #
+          # @return [RequiredSupplementaryDocumentBuilder]
+          #
+          def self.builder
+            RequiredSupplementaryDocumentBuilder.new
+          end
+        end
+
+        class RequiredSupplementaryDocumentBuilder
+          #
+          # @param [Objective] objective
+          #
+          # @return [self]
+          #
+          def with_objective(objective)
+            Validation.assert_is_a(Objective, objective, 'objective')
+            @objective = objective
+            self
+          end
+
+          #
+          # @param [Array<String>] country_codes
+          #
+          # @return [self]
+          #
+          def with_country_codes(country_codes)
+            Validation.assert_is_a(Array, country_codes, 'country_codes')
+            @country_codes = country_codes
+            self
+          end
+
+          #
+          # @param [Array<String>] document_types
+          #
+          # @return [self]
+          #
+          def with_document_types(document_types)
+            Validation.assert_is_a(Array, document_types, 'document_types')
+            @document_types = document_types
+            self
+          end
+
+          #
+          # @return [RequiredSupplementaryDocument]
+          #
+          def build
+            RequiredSupplementaryDocument.new(
+              @objective,
+              @document_types,
+              @country_codes
+            )
+          end
+        end
+      end
+    end
+  end
+end

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