yoti 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e34d2dbc6a002d6ea68375d1e0d0ba861587db16a7502e597aaacac5f97799f4
-  data.tar.gz: 81e54ccb7d6b3270efea24d7e1a632d4719f604eccd7da49f101ff6e565ca99d
+  metadata.gz: 62813310617665f67200974ba737f52d7c9bd2c1b139657b5ec672253ab3d133
+  data.tar.gz: 474d9dff07562499e19ec35d261dadbc056dbe7818bf35620ba7247ea7169569
 SHA512:
-  metadata.gz: 4433d2b8ac27da64991fe3f1f0d2271feb3c1ad41f43b50c49d9ec0615a75714042e63ef343fb93f4f8ae98860f93a4534f2128eafe1af7813ceba6d88458620
-  data.tar.gz: 0a2338a401a97000ba2a4999347c3e4471bfa896565653d87ac2b548c11b8eae73c86a1241cad5293ef3e19922e97caa7c67658df603c7704ced9965a806abc7
+  metadata.gz: 5c9c3ddc325973e5da3598c289428f01ccb7964ef7faed15b56faa7d9067b5f34f20a2b3336e1b357fb388898810595ccdc1bc2b2665213c44513b9ef493cf90
+  data.tar.gz: eb86020139c4e892f289f70a5eb9dfa15b8f2daee955d67ff16a3d93e6eab57e2847eac54f57545b9430b6c6373185fdf485c6fe726831d63b24c5e982b4931c

data/README.md

@@ -129,7 +129,6 @@ heroku config:add YOTI_KEY ="$(cat your-access-security.pem)"
 The Yoti SDK can be used for the following products, follow the links for more information about each:
 1) [Yoti app integration](/docs/PROFILE.md) - Connect with already-verified customers.
 1) [Yoti Doc Scan](/docs/DOCSCAN.md) - Identity verification embedded in your website or app.
-1) [Yoti AML](/docs/AML.md) - Anti-Money Laundering check service to allow a deeper KYC process, preventing fraud
 
 ## Support
 

data/lib/yoti.rb

@@ -56,6 +56,7 @@ require_relative 'yoti/doc_scan/errors'
 require_relative 'yoti/doc_scan/session/create/create_session_result'
 require_relative 'yoti/doc_scan/session/create/requested_check'
 require_relative 'yoti/doc_scan/session/create/requested_document_authenticity_check'
+require_relative 'yoti/doc_scan/session/create/requested_id_document_comparison_check'
 require_relative 'yoti/doc_scan/session/create/requested_face_match_check'
 require_relative 'yoti/doc_scan/session/create/requested_liveness_check'
 require_relative 'yoti/doc_scan/session/create/requested_task'
@@ -72,6 +73,7 @@ require_relative 'yoti/doc_scan/session/create/session_specification'
 require_relative 'yoti/doc_scan/session/retrieve/check_response'
 require_relative 'yoti/doc_scan/session/retrieve/resource_response'
 require_relative 'yoti/doc_scan/session/retrieve/authenticity_check_response'
+require_relative 'yoti/doc_scan/session/retrieve/id_document_comparison_check_response'
 require_relative 'yoti/doc_scan/session/retrieve/breakdown_response'
 require_relative 'yoti/doc_scan/session/retrieve/details_response'
 require_relative 'yoti/doc_scan/session/retrieve/document_fields_response'

data/lib/yoti/doc_scan/constants.rb

@@ -4,6 +4,7 @@ module Yoti
   module DocScan
     class Constants
       ID_DOCUMENT_AUTHENTICITY = 'ID_DOCUMENT_AUTHENTICITY'
+      ID_DOCUMENT_COMPARISON = 'ID_DOCUMENT_COMPARISON'
       ID_DOCUMENT_TEXT_DATA_CHECK = 'ID_DOCUMENT_TEXT_DATA_CHECK'
       ID_DOCUMENT_FACE_MATCH = 'ID_DOCUMENT_FACE_MATCH'
       LIVENESS = 'LIVENESS'

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

@@ -30,8 +30,18 @@ module Yoti
         # The configuration applied when creating a {RequestedDocumentAuthenticityCheck}
         #
         class RequestedDocumentAuthenticityCheckConfig
+          #
+          # @param [String] manual_check
+          #
+          def initialize(manual_check)
+            Validation.assert_is_a(String, manual_check, 'manual_check', true)
+            @manual_check = manual_check
+          end
+
           def as_json(*_args)
-            {}
+            {
+              manual_check: @manual_check
+            }.compact
           end
         end
 
@@ -39,11 +49,43 @@ module Yoti
         # Builder to assist the creation of {RequestedDocumentAuthenticityCheck}
         #
         class RequestedDocumentAuthenticityCheckBuilder
+          #
+          # Requires that a manual follow-up check is always performed
+          #
+          # @return [self]
+          #
+          def with_manual_check_always
+            @manual_check = Constants::ALWAYS
+            self
+          end
+
+          #
+          # Requires that a manual follow-up check is performed only on failed checks,
+          # and those with a low level of confidence
+          #
+          # @return [self]
+          #
+          def with_manual_check_fallback
+            @manual_check = Constants::FALLBACK
+            self
+          end
+
+          #
+          # Requires that only an automated check is performed.  No manual follow-up
+          # Check will ever be initiated
+          #
+          # @return [self]
+          #
+          def with_manual_check_never
+            @manual_check = Constants::NEVER
+            self
+          end
+
           #
           # @return [RequestedDocumentAuthenticityCheck]
           #
           def build
-            config = RequestedDocumentAuthenticityCheckConfig.new
+            config = RequestedDocumentAuthenticityCheckConfig.new(@manual_check)
             RequestedDocumentAuthenticityCheck.new(config)
           end
         end

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

@@ -63,7 +63,7 @@ module Yoti
           end
 
           #
-          # Requires that a manual follow-up check is performed only on failed Checks,
+          # Requires that a manual follow-up check is performed only on failed checks,
           # and those with a low level of confidence
           #
           # @return [self]
@@ -74,7 +74,7 @@ module Yoti
           end
 
           #
-          # Requires that only an automated Check is performed.  No manual follow-up
+          # Requires that only an automated check is performed.  No manual follow-up
           # Check will ever be initiated
           #
           # @return [self]

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Create
+        #
+        # Requests creation of an ID Document Comparison Check
+        #
+        class RequestedIdDocumentComparisonCheck < RequestedCheck
+          def initialize(config)
+            Validation.assert_is_a(
+              RequestedIdDocumentComparisonCheckConfig,
+              config,
+              'config'
+            )
+
+            super(Constants::ID_DOCUMENT_COMPARISON, config)
+          end
+
+          #
+          # @return [RequestedIdDocumentComparisonCheckBuilder]
+          #
+          def self.builder
+            RequestedIdDocumentComparisonCheckBuilder.new
+          end
+        end
+
+        #
+        # The configuration applied when creating a {RequestedIdDocumentComparisonCheck}
+        #
+        class RequestedIdDocumentComparisonCheckConfig
+          def as_json(*_args)
+            {}
+          end
+        end
+
+        #
+        # Builder to assist the creation of {RequestedIdDocumentComparisonCheck}
+        #
+        class RequestedIdDocumentComparisonCheckBuilder
+          #
+          # @return [RequestedIdDocumentComparisonCheck]
+          #
+          def build
+            config = RequestedIdDocumentComparisonCheckConfig.new
+            RequestedIdDocumentComparisonCheck.new(config)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,6 +14,7 @@ module Yoti
           # @param [Array<RequestedTask>] requested_tasks
           # @param [SdkConfig] sdk_config
           # @param [Array<RequiredDocument>] required_documents
+          # @param [Boolean] block_biometric_consent
           #
           def initialize(
             client_session_token_ttl,
@@ -23,7 +24,8 @@ module Yoti
             requested_checks,
             requested_tasks,
             sdk_config,
-            required_documents
+            required_documents,
+            block_biometric_consent = nil
           )
             Validation.assert_is_a(Integer, client_session_token_ttl, 'client_session_token_ttl', true)
             @client_session_token_ttl = client_session_token_ttl
@@ -48,6 +50,8 @@ module Yoti
 
             Validation.assert_is_a(Array, required_documents, 'required_documents', true)
             @required_documents = required_documents
+
+            @block_biometric_consent = block_biometric_consent
           end
 
           def to_json(*_args)
@@ -63,7 +67,8 @@ module Yoti
               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)
+              required_documents: @required_documents.map(&:as_json),
+              block_biometric_consent: @block_biometric_consent
             }.compact
           end
 
@@ -181,6 +186,18 @@ module Yoti
             self
           end
 
+          #
+          # Whether or not to block the collection of biometric consent
+          #
+          # @param [Boolean] block_biometric_consent
+          #
+          # @return [self]
+          #
+          def with_block_biometric_consent(block_biometric_consent)
+            @block_biometric_consent = block_biometric_consent
+            self
+          end
+
           #
           # @return [SessionSpecification]
           #
@@ -193,7 +210,8 @@ module Yoti
               @requested_checks,
               @requested_tasks,
               @sdk_config,
-              @required_documents
+              @required_documents,
+              @block_biometric_consent
             )
           end
         end

data/lib/yoti/doc_scan/session/retrieve/get_session_result.rb

@@ -26,6 +26,9 @@ module Yoti
           # @return [ResourceContainer]
           attr_reader :resources
 
+          # @return [DateTime]
+          attr_reader :biometric_consent_timestamp
+
           #
           # @param [Hash] response
           #
@@ -53,6 +56,8 @@ module Yoti
             end
 
             @resources = ResourceContainer.new(response['resources']) unless response['resources'].nil?
+
+            @biometric_consent_timestamp = DateTime.parse(response['biometric_consent']) unless response['biometric_consent'].nil?
           end
 
           #
@@ -83,6 +88,13 @@ module Yoti
             @checks.select { |check| check.is_a?(LivenessCheckResponse) }
           end
 
+          #
+          # @return [Array<IdDocumentComparisonCheckResponse>]
+          #
+          def id_document_comparison_checks
+            @checks.select { |check| check.is_a?(IdDocumentComparisonCheckResponse) }
+          end
+
           private
 
           #
@@ -95,6 +107,8 @@ module Yoti
               case check['type']
               when Constants::ID_DOCUMENT_AUTHENTICITY
                 AuthenticityCheckResponse.new(check)
+              when Constants::ID_DOCUMENT_COMPARISON
+                IdDocumentComparisonCheckResponse.new(check)
               when Constants::ID_DOCUMENT_FACE_MATCH
                 FaceMatchCheckResponse.new(check)
               when Constants::ID_DOCUMENT_TEXT_DATA_CHECK

data/lib/yoti/doc_scan/session/retrieve/id_document_comparison_check_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class IdDocumentComparisonCheckResponse < CheckResponse
+        end
+      end
+    end
+  end
+end

data/lib/yoti/version.rb

@@ -1,4 +1,4 @@
 module Yoti
   # @return [String] the gem's current version
-  VERSION = '1.8.0'.freeze
+  VERSION = '1.9.0'.freeze
 end

data/yoti.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   exclude_patterns = [
     '^(test|spec|features|examples|docs|.github)/',
     '^.gitignore$',
+    '^.pre-commit-config.yaml$',
     '^sonar-project.properties$',
     '^.dependabot/config.yml$',
     '^.travis.yml$',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yoti
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Yoti
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -193,6 +193,7 @@ files:
 - lib/yoti/doc_scan/session/create/requested_check.rb
 - lib/yoti/doc_scan/session/create/requested_document_authenticity_check.rb
 - lib/yoti/doc_scan/session/create/requested_face_match_check.rb
+- lib/yoti/doc_scan/session/create/requested_id_document_comparison_check.rb
 - lib/yoti/doc_scan/session/create/requested_liveness_check.rb
 - lib/yoti/doc_scan/session/create/requested_task.rb
 - lib/yoti/doc_scan/session/create/requested_text_extraction_task.rb
@@ -213,6 +214,7 @@ files:
 - lib/yoti/doc_scan/session/retrieve/generated_media.rb
 - lib/yoti/doc_scan/session/retrieve/generated_text_data_check_response.rb
 - lib/yoti/doc_scan/session/retrieve/get_session_result.rb
+- lib/yoti/doc_scan/session/retrieve/id_document_comparison_check_response.rb
 - lib/yoti/doc_scan/session/retrieve/id_document_resource_response.rb
 - lib/yoti/doc_scan/session/retrieve/liveness_check_response.rb
 - lib/yoti/doc_scan/session/retrieve/liveness_resource_response.rb
@@ -268,7 +270,7 @@ homepage: https://github.com/getyoti/yoti-ruby-sdk
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -284,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Yoti Ruby SDK for back-end integration.
 test_files: []