yoti_sandbox 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b28e95307ea6fccc695c859deaf4511bd06e56db00da5ee3064663e45f3548a3
-  data.tar.gz: f99002f1962e15be43e1eff62b594af8fdfb45beb43148df8bf648758ba6c299
+  metadata.gz: 3dca617f8f85c6d5f3f8cab50bbbaed9d25d02400fe57d92fa79e96741910460
+  data.tar.gz: 5ff037daed4c3c10499c2fdb707359ee12fb8f498806f207842009a9012ec138
 SHA512:
-  metadata.gz: 5b459b8d299a31fe540ec5cdc38264ac1d11dafa0313cce0c82befd9816f76b184f0a2db7c3733a1435e889719441975e28d90840e5bdeceac6ea4663403845e
-  data.tar.gz: bab62a807f2afe3693c09536438e1203c0a586ee924f3de55137520eb9bd6c802fe77194fe441bc1abb3b17179cc03c39084a07fa8204de2519202f9b1870eae
+  metadata.gz: cd19939c2a54cb656244b367c75ab362cd931aaf533f324c3b5c309c8ed61a5fc44d310f49f1295ccea98f70aa392e4276ffa4f3edfc2776603d61324168ee59
+  data.tar.gz: 2702371dbc5dd6caf8ddfce5c7eaf06d110f217d314d2c402ece5d5d87b63430eb1a52ffb98427e47ead8eadd4984ae3b5fa04ede3845e3daf10fefaa6134362

data/lib/yoti_sandbox/doc_scan.rb

@@ -9,6 +9,7 @@ require_relative 'doc_scan/request/document_filter'
 require_relative 'doc_scan/request/check/check'
 require_relative 'doc_scan/request/check/document_check'
 require_relative 'doc_scan/request/check/document_authenticity_check'
+require_relative 'doc_scan/request/check/id_document_comparison_check'
 require_relative 'doc_scan/request/check/document_face_match_check'
 require_relative 'doc_scan/request/check/document_text_data_check'
 require_relative 'doc_scan/request/check/liveness_check'

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_reports.rb

@@ -11,13 +11,15 @@ module Yoti
           # @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
+            async_report_delay,
+            id_document_comparison_checks = nil
           )
             Validation.assert_is_a(Array, document_text_data_checks, 'document_text_data_checks')
             @document_text_data_checks = document_text_data_checks
@@ -33,6 +35,9 @@ module Yoti
 
             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
           end
 
           def self.builder
@@ -45,12 +50,13 @@ module Yoti
 
           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
-            }
+              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,
+              async_report_delay: @async_report_delay
+            }.compact
           end
         end
 
@@ -60,6 +66,7 @@ module Yoti
             @document_text_data_checks = []
             @document_authenticity_checks = []
             @document_face_match_checks = []
+            @id_document_comparison_checks = []
           end
 
           #
@@ -117,6 +124,17 @@ module Yoti
             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
+
           #
           # @return [CheckReports]
           #
@@ -126,7 +144,8 @@ module Yoti
               @document_authenticity_checks,
               @liveness_checks,
               @document_face_match_checks,
-              @async_report_delay
+              @async_report_delay,
+              @id_document_comparison_checks
             )
           end
         end

data/yoti_sandbox.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'yoti_sandbox'
-  spec.version       = '1.2.1'
+  spec.version       = '1.3.0'
   spec.authors       = ['Yoti']
   spec.email         = ['websdk@yoti.com']
 
@@ -16,7 +16,20 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/getyoti/yoti-ruby-sdk-sandbox'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|examples)/|^sonar-project.properties$|^.dependabot/config.yml$|^.travis.yml$}) }
+  exclude_patterns = [
+    '^(test|spec|features|examples|docs|.github)/',
+    '^.gitignore$',
+    '^.pre-commit-config.yaml$',
+    '^sonar-project.properties$',
+    '^.dependabot/config.yml$',
+    '^.travis.yml$',
+    '^CONTRIBUTING.md$',
+    '^Guardfile$',
+    '^Rakefile$',
+    '^yardstick.yml$',
+    '^rubocop.yml$'
+  ]
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(/#{exclude_patterns.join('|')}/) }
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.4'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yoti_sandbox
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Yoti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-13 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yoti
@@ -131,15 +131,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE.md"
-- ".github/dependabot.yml"
-- ".gitignore"
-- CONTRIBUTING.md
 - Gemfile
-- Guardfile
 - LICENSE
 - README.md
-- Rakefile
 - lib/yoti_sandbox.rb
 - lib/yoti_sandbox/doc_scan.rb
 - lib/yoti_sandbox/doc_scan/client.rb
@@ -149,6 +143,7 @@ files:
 - lib/yoti_sandbox/doc_scan/request/check/document_check.rb
 - lib/yoti_sandbox/doc_scan/request/check/document_face_match_check.rb
 - lib/yoti_sandbox/doc_scan/request/check/document_text_data_check.rb
+- lib/yoti_sandbox/doc_scan/request/check/id_document_comparison_check.rb
 - lib/yoti_sandbox/doc_scan/request/check/liveness_check.rb
 - lib/yoti_sandbox/doc_scan/request/check/report/breakdown.rb
 - lib/yoti_sandbox/doc_scan/request/check/report/detail.rb
@@ -168,8 +163,6 @@ files:
 - lib/yoti_sandbox/profile/extra_data.rb
 - lib/yoti_sandbox/profile/third_party.rb
 - lib/yoti_sandbox/profile/token_request.rb
-- rubocop.yml
-- yardstick.yml
 - yoti_sandbox.gemspec
 homepage: https://github.com/getyoti/yoti-ruby-sdk-sandbox
 licenses:

data/.github/ISSUE_TEMPLATE.md

@@ -1,17 +0,0 @@
----
-name: Custom issue template
-about: " There's a better way to get help!"
-title: ''
-labels: ''
-assignees: ''
-
----
-
-#
-# Wait ✋
-#
-# There's a better way to get help!
-#
-# Send your questions or issues to sdksupport@yoti.com
-#
-#

data/.github/dependabot.yml

@@ -1,13 +0,0 @@
-version: 2
-updates:
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 3
-  target-branch: development
-  reviewers:
-  - echarrod
-  - davidgrayston
-  assignees:
-  - davidgrayston

data/.gitignore

@@ -1,56 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-.env
-
-# Ignore Byebug command history file.
-.byebug_history
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-.ruby-version
-.ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*

data/CONTRIBUTING.md

@@ -1,30 +0,0 @@
-# Contributing
-
-After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake spec` to run the tests. To install this gem onto your local machine, run `bundle exec rake install`.
-
-You can use [Guard][] to automatically run the tests every time a file in the `lib` or `spec` folder changes.
-
-Run Guard through Bundler with:
-
-```shell
-bundle exec guard
-```
-
-[Guard]: https://github.com/guard/guard
-
-## Code coverage
-
-The 100% code coverage requirement must be met before submitting new code.
-This can be checked by opening the generated [SimpleCov][] files:
-
- ```shell
-open coverage/index.html
- ```
-
-## Style guide
-
-The Ruby style guide is configured in the [rubocop.yml](rubocop.yml) file and can be checked by running:
-
-```shell
-bundle exec rake rubocop
-```

data/Guardfile

@@ -1,11 +0,0 @@
-guard :rspec, cmd: 'bundle exec rspec -c -f doc' do
-  # watch /lib/ files
-  watch(%r{^lib/(.+).rb$}) do |m|
-    "spec/#{m[1]}_spec.rb"
-  end
-
-  # watch /spec/ files
-  watch(%r{^spec/(.+).rb$}) do |m|
-    "spec/#{m[1]}.rb"
-  end
-end

data/Rakefile

@@ -1,41 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'yaml'
-
-################################
-# Tests                        #
-################################
-
-RSpec::Core::RakeTask.new
-task test: :spec
-
-################################
-# Rubocop                      #
-################################
-
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new(:rubocop) do |t|
-  t.options = ['--config', 'rubocop.yml']
-end
-
-################################
-# Documentation                #
-################################
-
-require 'yard'
-YARD::Rake::YardocTask.new do |t|
-  t.stats_options = ['--list-undoc']
-end
-
-yardstick_options = YAML.load_file('yardstick.yml')
-
-require 'yardstick/rake/measurement'
-Yardstick::Rake::Measurement.new(:measurement, yardstick_options) do |measurement|
-  measurement.output = 'measurement/report.txt'
-end
-
-################################
-# Defaults                     #
-################################
-
-task default: %i[spec rubocop]

data/rubocop.yml

@@ -1,44 +0,0 @@
-AllCops:
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  TargetRubyVersion: 2.4
-
-Metrics/AbcSize:
-  Enabled: false
-  Max: 23
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/**/*.rb
-    - examples/**/*.rb
-
-Metrics/ClassLength:
-  Enabled: false
-  Max: 115
-
-Metrics/ModuleLength:
-  Exclude:
-    - examples/doc_scan/**/*.rb
-
-Metrics/CyclomaticComplexity:
-  Max: 9
-
-Metrics/MethodLength:
-  Enabled: false
-  CountComments: false
-  Max: 19
-
-Style/Documentation:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/NumericLiterals:
-  Enabled: false
-
-Style/MutableConstant:
-  Enabled: false
-
-Layout/LineLength:
-  Enabled: false

data/yardstick.yml

@@ -1,9 +0,0 @@
-rules:
-  ApiTag::Presence:
-    enabled: false
-  ApiTag::Inclusion:
-    enabled: false
-  ApiTag::PrivateMethod:
-    enabled: false
-  ExampleTag:
-    enabled: false