yoti_sandbox 1.0.0 → 1.4.0

data/lib/yoti_sandbox/doc_scan/request/check/id_document_comparison_check.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class IdDocumentComparisonCheck < Check
+          #
+          # @param [CheckResult] result
+          # @param [DocumentFilter] secondary_document_filter
+          #
+          def initialize(result, secondary_document_filter)
+            super(result)
+
+            Validation.assert_is_a(DocumentFilter, secondary_document_filter, 'secondary_document_filter', true)
+            @secondary_document_filter = secondary_document_filter
+          end
+
+          def as_json(*_args)
+            json = super
+            json[:secondary_document_filter] = @secondary_document_filter.as_json unless @secondary_document_filter.nil?
+            json
+          end
+
+          #
+          # @return [IdDocumentComparisonCheckBuilder]
+          #
+          def self.builder
+            IdDocumentComparisonCheckBuilder.new
+          end
+        end
+
+        class IdDocumentComparisonCheckBuilder < CheckBuilder
+          #
+          # @param [DocumentFilter] secondary_document_filter
+          #
+          # @return [self]
+          #
+          def with_secondary_document_filter(secondary_document_filter)
+            @secondary_document_filter = secondary_document_filter
+            self
+          end
+
+          #
+          # @return [IdDocumentComparisonCheck]
+          #
+          def build
+            report = CheckReport.new(@recommendation, @breakdowns)
+            result = CheckResult.new(report)
+            IdDocumentComparisonCheck.new(result, @secondary_document_filter)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/check/liveness_check.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class LivenessCheck < Check
+          #
+          # @param [CheckResult] result
+          # @param [String] liveness_type
+          #
+          def initialize(result, liveness_type)
+            raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(LivenessCheck)
+
+            super(result)
+
+            Validation.assert_is_a(String, liveness_type, 'liveness_type')
+            @liveness_type = liveness_type
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            super.merge(
+              liveness_type: @liveness_type
+            ).compact
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/check/report/breakdown.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class Breakdown
+          #
+          # @param [String] sub_check
+          # @param [String] result
+          # @param [Array<Detail>] details
+          #
+          def initialize(sub_check, result, details)
+            Validation.assert_is_a(String, sub_check, 'sub_check')
+            @sub_check = sub_check
+
+            Validation.assert_is_a(String, result, 'result')
+            @result = result
+
+            Validation.assert_is_a(Array, details, 'details')
+            @details = details
+          end
+
+          def as_json(*_args)
+            {
+              sub_check: @sub_check,
+              result: @result,
+              details: @details.map(&:as_json)
+            }
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          #
+          # @return [BreakdownBuilder]
+          #
+          def self.builder
+            BreakdownBuilder.new
+          end
+        end
+
+        class BreakdownBuilder
+          def initialize
+            @details = []
+          end
+
+          #
+          # @param [String] sub_check
+          #
+          # @return [self]
+          #
+          def with_sub_check(sub_check)
+            Validation.assert_is_a(String, sub_check, 'sub_check')
+            @sub_check = sub_check
+            self
+          end
+
+          #
+          # @param [String] result
+          #
+          # @return [self]
+          #
+          def with_result(result)
+            Validation.assert_is_a(String, result, 'result')
+            @result = result
+            self
+          end
+
+          #
+          # @param [String] name
+          # @param [String] value
+          #
+          # @return [self]
+          #
+          def with_detail(name, value)
+            Validation.assert_is_a(String, name, 'name')
+            Validation.assert_is_a(String, value, 'value')
+            @details.push(Detail.new(name, value))
+            self
+          end
+
+          #
+          # @return [Breakdown]
+          #
+          def build
+            Validation.assert_not_nil(@sub_check, 'sub_check')
+            Validation.assert_not_nil(@result, 'result')
+
+            Breakdown.new(@sub_check, @result, @details)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/check/report/detail.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class Detail
+          #
+          # @param [String] name
+          # @param [String] value
+          #
+          def initialize(name, value)
+            Validation.assert_is_a(String, name, 'name')
+            @name = name
+
+            Validation.assert_is_a(String, value, 'value')
+            @value = value
+          end
+
+          def as_json(*_args)
+            {
+              name: @name,
+              value: @value
+            }
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/check/report/recommendation.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class Recommendation
+          #
+          # @param [String] value
+          # @param [String] reason
+          # @param [String] recovery_suggestion
+          #
+          def initialize(value, reason, recovery_suggestion)
+            Validation.assert_is_a(String, value, 'value')
+            @value = value
+
+            Validation.assert_is_a(String, reason, 'reason', true)
+            @reason = reason
+
+            Validation.assert_is_a(String, recovery_suggestion, 'recovery_suggestion', true)
+            @recovery_suggestion = recovery_suggestion
+          end
+
+          def as_json(*_args)
+            {
+              value: @value,
+              reason: @reason,
+              recovery_suggestion: @recovery_suggestion
+            }.compact
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          #
+          # @return [RecommendationBuilder]
+          #
+          def self.builder
+            RecommendationBuilder.new
+          end
+        end
+
+        class RecommendationBuilder
+          #
+          # @param [String] value
+          #
+          # @return [self]
+          #
+          def with_value(value)
+            Validation.assert_is_a(String, value, 'value')
+            @value = value
+            self
+          end
+
+          #
+          # @param [String] reason
+          #
+          # @return [self]
+          #
+          def with_reason(reason)
+            Validation.assert_is_a(String, reason, 'reason')
+            @reason = reason
+            self
+          end
+
+          #
+          # @param [String] recovery_suggestion
+          #
+          # @return [self]
+          #
+          def with_recovery_suggestion(recovery_suggestion)
+            Validation.assert_is_a(String, recovery_suggestion, 'recovery_suggestion')
+            @recovery_suggestion = recovery_suggestion
+            self
+          end
+
+          #
+          # @return [Recommendation]
+          #
+          def build
+            Recommendation.new(@value, @reason, @recovery_suggestion)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/check/supplementary_document_text_data_check.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class SupplementaryDocumentTextDataCheck < DocumentCheck
+          #
+          # @return [SupplementaryDocumentTextDataCheckBuilder]
+          #
+          def self.builder
+            SupplementaryDocumentTextDataCheckBuilder.new
+          end
+        end
+
+        class SupplementaryDocumentTextDataCheckResult < CheckResult
+          #
+          # @param [CheckReport] report
+          # @param [Hash,nil] document_fields
+          #
+          def initialize(report, document_fields)
+            super(report)
+
+            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
+          end
+
+          def as_json(*_args)
+            super.merge(
+              document_fields: @document_fields
+            ).compact
+          end
+        end
+
+        class SupplementaryDocumentTextDataCheckBuilder < DocumentCheckBuilder
+          #
+          # @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
+
+          #
+          # @return [SupplementaryDocumentTextDataCheck]
+          #
+          def build
+            report = CheckReport.new(@recommendation, @breakdowns)
+            result = SupplementaryDocumentTextDataCheckResult.new(report, @document_fields)
+            SupplementaryDocumentTextDataCheck.new(result, @document_filter)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/check/zoom_liveness_check.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class ZoomLivenessCheck < LivenessCheck
+          #
+          # @param [CheckResult] result
+          #
+          def initialize(result)
+            super(result, Yoti::DocScan::Constants::ZOOM)
+          end
+
+          #
+          # @return [ZoomLivenessCheckBuilder]
+          #
+          def self.builder
+            ZoomLivenessCheckBuilder.new
+          end
+        end
+
+        class ZoomLivenessCheckBuilder < CheckBuilder
+          #
+          # @return [ZoomLivenessCheck]
+          #
+          def build
+            report = CheckReport.new(@recommendation, @breakdowns)
+            result = CheckResult.new(report)
+            ZoomLivenessCheck.new(result)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class CheckReports
+          #
+          # @param [Array<DocumentTextDataCheck>] document_text_data_checks
+          # @param [Array<DocumentAuthenticityCheck>] document_authenticity_checks
+          # @param [Array<LivenessCheck>] liveness_checks
+          # @param [Array<DocumentFaceMatchCheck>] document_face_match_checks
+          # @param [Integer] async_report_delay
+          # @param [Array<IdDocumentComparisonCheck>] id_document_comparison_checks
+          #
+          def initialize(
+            document_text_data_checks,
+            document_authenticity_checks,
+            liveness_checks,
+            document_face_match_checks,
+            async_report_delay,
+            id_document_comparison_checks = nil,
+            supplementary_document_text_data_checks = nil
+          )
+            Validation.assert_is_a(Array, document_text_data_checks, 'document_text_data_checks')
+            @document_text_data_checks = document_text_data_checks
+
+            Validation.assert_is_a(Array, document_authenticity_checks, 'document_authenticity_checks')
+            @document_authenticity_checks = document_authenticity_checks
+
+            Validation.assert_is_a(Array, liveness_checks, 'liveness_checks')
+            @liveness_checks = liveness_checks
+
+            Validation.assert_is_a(Array, document_face_match_checks, 'document_face_match_checks')
+            @document_face_match_checks = document_face_match_checks
+
+            Validation.assert_is_a(Integer, async_report_delay, 'async_report_delay', true)
+            @async_report_delay = async_report_delay
+
+            Validation.assert_is_a(Array, id_document_comparison_checks, 'id_document_comparison_checks', true)
+            @id_document_comparison_checks = id_document_comparison_checks
+
+            Validation.assert_is_a(
+              Array,
+              supplementary_document_text_data_checks,
+              'supplementary_document_text_data_checks',
+              true
+            )
+            @supplementary_document_text_data_checks = supplementary_document_text_data_checks
+          end
+
+          def self.builder
+            CheckReportsBuilder.new
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              ID_DOCUMENT_TEXT_DATA_CHECK: @document_text_data_checks,
+              ID_DOCUMENT_AUTHENTICITY: @document_authenticity_checks,
+              ID_DOCUMENT_FACE_MATCH: @document_face_match_checks,
+              LIVENESS: @liveness_checks,
+              ID_DOCUMENT_COMPARISON: @id_document_comparison_checks,
+              SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK: @supplementary_document_text_data_checks,
+              async_report_delay: @async_report_delay
+            }.compact
+          end
+        end
+
+        class CheckReportsBuilder
+          def initialize
+            @liveness_checks = []
+            @document_text_data_checks = []
+            @document_authenticity_checks = []
+            @document_face_match_checks = []
+            @id_document_comparison_checks = []
+            @supplementary_document_text_data_checks = []
+          end
+
+          #
+          # @param [LivenessCheck] liveness_check
+          #
+          # @return [self]
+          #
+          def with_liveness_check(liveness_check)
+            Validation.assert_is_a(LivenessCheck, liveness_check, 'liveness_check')
+            @liveness_checks << liveness_check
+            self
+          end
+
+          #
+          # @param [DocumentTextDataCheck] document_text_data_check
+          #
+          # @return [self]
+          #
+          def with_document_text_data_check(document_text_data_check)
+            Validation.assert_is_a(DocumentTextDataCheck, document_text_data_check, 'document_text_data_check')
+            @document_text_data_checks << document_text_data_check
+            self
+          end
+
+          #
+          # @param [DocumentAuthenticityCheck] document_authenticity_check
+          #
+          # @return [self]
+          #
+          def with_document_authenticity_check(document_authenticity_check)
+            Validation.assert_is_a(DocumentAuthenticityCheck, document_authenticity_check, 'document_authenticity_check')
+            @document_authenticity_checks << document_authenticity_check
+            self
+          end
+
+          #
+          # @param [DocumentFaceMatchCheck] document_face_match_check
+          #
+          # @return [self]
+          #
+          def with_document_face_match_check(document_face_match_check)
+            Validation.assert_is_a(DocumentFaceMatchCheck, document_face_match_check, 'document_face_match_check')
+            @document_face_match_checks << document_face_match_check
+            self
+          end
+
+          #
+          # @param [Integer] async_report_delay
+          #
+          # @return [self]
+          #
+          def with_async_report_delay(async_report_delay)
+            Validation.assert_is_a(Integer, async_report_delay, 'async_report_delay')
+            @async_report_delay = async_report_delay
+            self
+          end
+
+          #
+          # @param [IdDocumentComparisonCheck] id_document_comparison_check
+          #
+          # @return [self]
+          #
+          def with_id_document_comparison_check(id_document_comparison_check)
+            Validation.assert_is_a(IdDocumentComparisonCheck, id_document_comparison_check, 'id_document_comparison_check')
+            @id_document_comparison_checks << id_document_comparison_check
+            self
+          end
+
+          #
+          # @param [SupplementaryDocumentTextDataCheck] supplementary_document_text_data_check
+          #
+          # @return [self]
+          #
+          def with_supplementary_document_text_data_check(supplementary_document_text_data_check)
+            Validation.assert_is_a(
+              SupplementaryDocumentTextDataCheck,
+              supplementary_document_text_data_check,
+              'supplementary_document_text_data_check'
+            )
+            @supplementary_document_text_data_checks << supplementary_document_text_data_check
+            self
+          end
+
+          #
+          # @return [CheckReports]
+          #
+          def build
+            CheckReports.new(
+              @document_text_data_checks,
+              @document_authenticity_checks,
+              @liveness_checks,
+              @document_face_match_checks,
+              @async_report_delay,
+              @id_document_comparison_checks,
+              @supplementary_document_text_data_checks
+            )
+          end
+        end
+      end
+    end
+  end
+end