yoti_sandbox 1.0.0 → 1.1.0

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/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,136 @@
+# 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
+          #
+          def initialize(
+            document_text_data_checks,
+            document_authenticity_checks,
+            liveness_checks,
+            document_face_match_checks,
+            async_report_delay
+          )
+            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
+          end
+
+          def self.builder
+            CheckReportsBuilder.new
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              Yoti::DocScan::Constants::ID_DOCUMENT_TEXT_DATA_CHECK => @document_text_data_checks,
+              Yoti::DocScan::Constants::ID_DOCUMENT_AUTHENTICITY => @document_authenticity_checks,
+              Yoti::DocScan::Constants::ID_DOCUMENT_FACE_MATCH => @document_face_match_checks,
+              Yoti::DocScan::Constants::LIVENESS => @liveness_checks,
+              :async_report_delay => @async_report_delay
+            }
+          end
+        end
+
+        class CheckReportsBuilder
+          def initialize
+            @liveness_checks = []
+            @document_text_data_checks = []
+            @document_authenticity_checks = []
+            @document_face_match_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
+
+          #
+          # @return [CheckReports]
+          #
+          def build
+            CheckReports.new(
+              @document_text_data_checks,
+              @document_authenticity_checks,
+              @liveness_checks,
+              @document_face_match_checks,
+              @async_report_delay
+            )
+          end
+        end
+      end
+    end
+  end
+end

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