yoti_sandbox 1.0.0 → 1.4.0

data/lib/yoti_sandbox/doc_scan/request/document_filter.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class DocumentFilter
+          #
+          # @param [Array<String>] document_types
+          # @param [Array<String>] country_codes
+          #
+          def initialize(document_types, country_codes)
+            Validation.assert_is_a(Array, document_types, 'document_types')
+            @document_types = document_types
+
+            Validation.assert_is_a(Array, country_codes, 'country_codes')
+            @country_codes = country_codes
+          end
+
+          def as_json(*_args)
+            {
+              document_types: @document_types,
+              country_codes: @country_codes
+            }
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          #
+          # @return [DocumentFilterBuilder]
+          #
+          def self.builder
+            DocumentFilterBuilder.new
+          end
+        end
+
+        class DocumentFilterBuilder
+          def initialize
+            @document_types = []
+            @country_codes = []
+          end
+
+          #
+          # @param [String] country_code
+          #
+          # @return [self]
+          #
+          def with_country_code(country_code)
+            Validation.assert_is_a(String, country_code, 'country_code')
+            @country_codes.push(country_code)
+            self
+          end
+
+          #
+          # @param [String] document_type
+          #
+          # @return [self]
+          #
+          def with_document_type(document_type)
+            Validation.assert_is_a(String, document_type, 'country_code')
+            @document_types.push(document_type)
+            self
+          end
+
+          #
+          # @return [DocumentFilter]
+          #
+          def build
+            DocumentFilter.new(@document_types, @country_codes)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/response_config.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class ResponseConfig
+          #
+          # @param [TaskResults,nil] task_results
+          # @param [CheckReports] check_reports
+          #
+          def initialize(
+            task_results,
+            check_reports
+          )
+            Validation.assert_is_a(TaskResults, task_results, 'task_results', true)
+            @task_results = task_results
+
+            Validation.assert_is_a(CheckReports, check_reports, 'check_reports')
+            @check_reports = check_reports
+          end
+
+          def self.builder
+            ResponseConfigBuilder.new
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              task_results: @task_results,
+              check_reports: @check_reports
+            }.compact
+          end
+        end
+
+        class ResponseConfigBuilder
+          #
+          # @param [TaskResults] task_results
+          #
+          # @return [self]
+          #
+          def with_task_results(task_results)
+            Validation.assert_is_a(TaskResults, task_results, 'task_results')
+            @task_results = task_results
+            self
+          end
+
+          #
+          # @param [CheckReports] check_reports
+          #
+          # @return [self]
+          #
+          def with_check_reports(check_reports)
+            Validation.assert_is_a(CheckReports, check_reports, 'check_reports')
+            @check_reports = check_reports
+            self
+          end
+
+          #
+          # @return [ResponseConfig]
+          #
+          def build
+            ResponseConfig.new(
+              @task_results,
+              @check_reports
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/task/document_id_photo.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class DocumentIdPhoto
+          #
+          # @param [String] content_type
+          # @param [bin] data
+          #
+          def initialize(content_type, data)
+            Validation.assert_is_a(String, content_type, 'content_type')
+            @content_type = content_type
+
+            @data = data
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              content_type: @content_type,
+              data: Base64.strict_encode64(@data)
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/task/document_text_data_extraction_task.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class DocumentTextDataExtractionTask
+          #
+          # @param [DocumentTextDataExtractionTaskResult] result
+          # @param [DocumentFilter] document_filter
+          #
+          def initialize(result, document_filter)
+            Validation.assert_is_a(DocumentTextDataExtractionTaskResult, result, 'result')
+            @result = result
+
+            Validation.assert_is_a(DocumentFilter, document_filter, 'document_filter', true)
+            @document_filter = document_filter
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            json = {
+              result: @result.as_json
+            }
+            json[:document_filter] = @document_filter.as_json unless @document_filter.nil?
+            json
+          end
+
+          #
+          # @return [DocumentTextDataExtractionTaskBuilder]
+          #
+          def self.builder
+            DocumentTextDataExtractionTaskBuilder.new
+          end
+        end
+
+        class DocumentTextDataExtractionTaskResult
+          #
+          # @param [Hash,nil] document_fields
+          # @param [DocumentIdPhoto,nil] document_id_photo
+          # @param [String,nil] detected_country
+          # @param [TextDataExtractionRecommendation,nil] recommendation
+          #
+          def initialize(
+            document_fields,
+            document_id_photo = nil,
+            detected_country = nil,
+            recommendation = nil
+          )
+            unless document_fields.nil?
+              Validation.assert_is_a(Hash, document_fields, 'document_fields')
+              document_fields.each { |_k, v| Validation.assert_respond_to(:to_json, v, 'document_fields value') }
+            end
+            @document_fields = document_fields
+
+            Validation.assert_is_a(DocumentIdPhoto, document_id_photo, 'document_id_photo', true)
+            @document_id_photo = document_id_photo
+
+            Validation.assert_is_a(String, detected_country, 'detected_country', true)
+            @detected_country = detected_country
+
+            Validation.assert_is_a(TextDataExtractionRecommendation, recommendation, 'recommendation', true)
+            @recommendation = recommendation
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              document_fields: @document_fields,
+              document_id_photo: @document_id_photo,
+              detected_country: @detected_country,
+              recommendation: @recommendation
+            }.compact
+          end
+        end
+
+        class DocumentTextDataExtractionTaskBuilder
+          #
+          # @param [String] key
+          # @param [#to_json] value
+          #
+          # @return [self]
+          #
+          def with_document_field(key, value)
+            Validation.assert_is_a(String, key, 'key')
+            Validation.assert_respond_to(:to_json, value, 'value')
+            @document_fields ||= {}
+            @document_fields[key] = value
+            self
+          end
+
+          #
+          # @param [Hash] document_fields
+          #
+          # @return [self]
+          #
+          def with_document_fields(document_fields)
+            Validation.assert_is_a(Hash, document_fields, 'document_fields')
+            @document_fields = document_fields
+            self
+          end
+
+          #
+          # @param [DocumentFilter] document_filter
+          #
+          # @return [self]
+          #
+          def with_document_filter(document_filter)
+            @document_filter = document_filter
+            self
+          end
+
+          #
+          # @param [String] content_type
+          # @param [bin] data
+          #
+          # @return [self]
+          #
+          def with_document_id_photo(content_type, data)
+            @document_id_photo = DocumentIdPhoto.new(content_type, data)
+            self
+          end
+
+          #
+          # @param [TextDataExtractionRecommendation] recommendation
+          #
+          # @return [self]
+          #
+          def with_recommendation(recommendation)
+            Validation.assert_is_a(TextDataExtractionRecommendation, recommendation, 'recommendation')
+            @recommendation = recommendation
+            self
+          end
+
+          #
+          # @param [String] detected_country
+          #
+          # @return [self]
+          #
+          def with_detected_country(detected_country)
+            Validation.assert_is_a(String, detected_country, 'detected_country')
+            @detected_country = detected_country
+            self
+          end
+
+          #
+          # @return [DocumentTextDataExtractionTask]
+          #
+          def build
+            result = DocumentTextDataExtractionTaskResult.new(
+              @document_fields,
+              @document_id_photo,
+              @detected_country,
+              @recommendation
+            )
+            DocumentTextDataExtractionTask.new(result, @document_filter)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/task/supplementary_document_text_data_extraction_task.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class SupplementaryDocumentTextDataExtractionTask
+          #
+          # @param [SupplementaryDocumentTextDataExtractionTaskResult] result
+          # @param [DocumentFilter] document_filter
+          #
+          def initialize(result, document_filter)
+            Validation.assert_is_a(SupplementaryDocumentTextDataExtractionTaskResult, result, 'result')
+            @result = result
+
+            Validation.assert_is_a(DocumentFilter, document_filter, 'document_filter', true)
+            @document_filter = document_filter
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            json = {
+              result: @result.as_json
+            }
+            json[:document_filter] = @document_filter.as_json unless @document_filter.nil?
+            json
+          end
+
+          #
+          # @return [SupplementaryDocumentTextDataExtractionTaskBuilder]
+          #
+          def self.builder
+            SupplementaryDocumentTextDataExtractionTaskBuilder.new
+          end
+        end
+
+        class SupplementaryDocumentTextDataExtractionTaskResult
+          #
+          # @param [Hash,nil] document_fields
+          # @param [String,nil] detected_country
+          # @param [TextDataExtractionRecommendation,nil] recommendation
+          #
+          def initialize(
+            document_fields,
+            detected_country = nil,
+            recommendation = nil
+          )
+            unless document_fields.nil?
+              Validation.assert_is_a(Hash, document_fields, 'document_fields')
+              document_fields.each { |_k, v| Validation.assert_respond_to(:to_json, v, 'document_fields value') }
+            end
+            @document_fields = document_fields
+
+            Validation.assert_is_a(String, detected_country, 'detected_country', true)
+            @detected_country = detected_country
+
+            Validation.assert_is_a(TextDataExtractionRecommendation, recommendation, 'recommendation', true)
+            @recommendation = recommendation
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              document_fields: @document_fields,
+              detected_country: @detected_country,
+              recommendation: @recommendation
+            }.compact
+          end
+        end
+
+        class SupplementaryDocumentTextDataExtractionTaskBuilder
+          #
+          # @param [String] key
+          # @param [#to_json] value
+          #
+          # @return [self]
+          #
+          def with_document_field(key, value)
+            Validation.assert_is_a(String, key, 'key')
+            Validation.assert_respond_to(:to_json, value, 'value')
+            @document_fields ||= {}
+            @document_fields[key] = value
+            self
+          end
+
+          #
+          # @param [Hash] document_fields
+          #
+          # @return [self]
+          #
+          def with_document_fields(document_fields)
+            Validation.assert_is_a(Hash, document_fields, 'document_fields')
+            @document_fields = document_fields
+            self
+          end
+
+          #
+          # @param [DocumentFilter] document_filter
+          #
+          # @return [self]
+          #
+          def with_document_filter(document_filter)
+            @document_filter = document_filter
+            self
+          end
+
+          #
+          # @param [TextDataExtractionRecommendation] recommendation
+          #
+          # @return [self]
+          #
+          def with_recommendation(recommendation)
+            Validation.assert_is_a(TextDataExtractionRecommendation, recommendation, 'recommendation')
+            @recommendation = recommendation
+            self
+          end
+
+          #
+          # @param [String] detected_country
+          #
+          # @return [self]
+          #
+          def with_detected_country(detected_country)
+            Validation.assert_is_a(String, detected_country, 'detected_country')
+            @detected_country = detected_country
+            self
+          end
+
+          #
+          # @return [SupplementaryDocumentTextDataExtractionTask]
+          #
+          def build
+            result = SupplementaryDocumentTextDataExtractionTaskResult.new(
+              @document_fields,
+              @detected_country,
+              @recommendation
+            )
+            SupplementaryDocumentTextDataExtractionTask.new(result, @document_filter)
+          end
+        end
+      end
+    end
+  end
+end