yoti_sandbox 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee3b93e52cfe923f7311c9fb4e426c82f543d335d77986afce33a156020ebd49
-  data.tar.gz: c364243f9462bce1e2d115b4d538353b34c764412109e5fdbde6587e90e07ad3
+  metadata.gz: 50664707d70da0ad9d28f183b68074c795f74ef59c05dbf4fbd1a0cef280d819
+  data.tar.gz: 6bae10a1f1675592f178d9ae1f47fdf3992196f1480a03e6a736b177a7638ea9
 SHA512:
-  metadata.gz: 942ea35d3fb25a5d7b7cf9dc70c8bef7e61b15109295de0c56fabbb5ae15d8cf10fbb202a54b879cda88980ef940ceed2293fe0c0db3506a2318dce9c213f58d
-  data.tar.gz: 965241d45bb97c05cd45c3d2a88c5ac843655ce427787c76b5a4b84c57fd4d9d2501f8a8f7a8317e7a55e81c780a768dd172e167e38623346acfb2522d20990d
+  metadata.gz: fe42559fa4b25d2a3f5d239471bfe86a0f1b59e00cb6c4bcb52cd895b52f2e2a4bf8087ce710d50be5514cf745e804204e245dac7f8bdf1dccf6157c9092efa1
+  data.tar.gz: 8de1edf888b5ede3604532ed62dd4210f7a55aa3de899c79062fefa980c37bd7d1ebf4045a40e9d879b5c87e83b3f2331d79985d7ecc447c1224a28f836afef7

data/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 gem 'guard'
 gem 'guard-rspec'
-gem 'rubocop'
+gem 'rubocop', '~> 1.1', require: false
 gem 'rubocop-performance'
 
 gemspec

data/README.md

@@ -1,5 +1,11 @@
 # Yoti Ruby Sandbox SDK
 
+[![Build Status](https://travis-ci.com/getyoti/yoti-ruby-sdk-sandbox.svg?branch=master)](https://travis-ci.com/getyoti/yoti-ruby-sdk-sandbox)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Aruby-sandbox&metric=coverage)](https://sonarcloud.io/dashboard?id=getyoti%3Aruby-sandbox)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Aruby-sandbox&metric=bugs)](https://sonarcloud.io/dashboard?id=getyoti%3Aruby-sandbox)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Aruby-sandbox&metric=code_smells)](https://sonarcloud.io/dashboard?id=getyoti%3Aruby-sandbox)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Aruby-sandbox&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=getyoti%3Aruby-sandbox)
+
 This repository contains the tools you need to test your Yoti integration.
 
 ## Installing the Sandbox
@@ -42,4 +48,5 @@ end
 
 ## Examples
 
-- See [examples/profile](examples/profile) for a general example of how to use the Profile Sandbox in your tests.
+- [Profile Sandbox](examples/profile)
+- [Doc Scan Sandbox](examples/doc_scan)

data/lib/yoti_sandbox.rb

@@ -1 +1,2 @@
 require_relative 'yoti_sandbox/profile'
+require_relative 'yoti_sandbox/doc_scan'

data/lib/yoti_sandbox/doc_scan.rb

@@ -0,0 +1,25 @@
+require 'yoti'
+
+require_relative 'doc_scan/client'
+require_relative 'doc_scan/errors'
+require_relative 'doc_scan/request/task_results'
+require_relative 'doc_scan/request/check_reports'
+require_relative 'doc_scan/request/response_config'
+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/supplementary_document_text_data_check'
+require_relative 'doc_scan/request/check/liveness_check'
+require_relative 'doc_scan/request/check/zoom_liveness_check'
+require_relative 'doc_scan/request/check/report/breakdown'
+require_relative 'doc_scan/request/check/report/recommendation'
+require_relative 'doc_scan/request/check/report/detail'
+require_relative 'doc_scan/request/task/document_text_data_extraction_task'
+require_relative 'doc_scan/request/task/supplementary_document_text_data_extraction_task'
+require_relative 'doc_scan/request/task/document_id_photo'
+require_relative 'doc_scan/request/task/text_data_extraction_recommendation'
+require_relative 'doc_scan/request/task/text_data_extraction_reason'

data/lib/yoti_sandbox/doc_scan/client.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      #
+      # Client for the Doc Scan sandbox service
+      #
+      class Client
+        #
+        # @param [String] base_url
+        #
+        def initialize(base_url: nil)
+          @base_url = base_url || "#{Yoti.configuration.api_url}/sandbox/idverify/v1"
+        end
+
+        #
+        # @param [String] session_id
+        # @param [Yoti::SandboxDocScan::Request::ResponseConfig] response_config
+        #
+        def configure_session_response(session_id, response_config)
+          request = Yoti::Request
+                    .builder
+                    .with_http_method('PUT')
+                    .with_base_url(@base_url)
+                    .with_endpoint("sessions/#{session_id}/response-config")
+                    .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                    .with_payload(response_config)
+                    .build
+
+          begin
+            request.execute
+          rescue Yoti::RequestError => e
+            raise Yoti::Sandbox::DocScan::Error.wrap(e)
+          end
+        end
+
+        #
+        # @param [Yoti::SandboxDocScan::Request::ResponseConfig] response_config
+        #
+        def configure_application_response(response_config)
+          request = Yoti::Request
+                    .builder
+                    .with_http_method('PUT')
+                    .with_base_url(@base_url)
+                    .with_endpoint("apps/#{Yoti.configuration.client_sdk_id}/response-config")
+                    .with_payload(response_config)
+                    .build
+
+          begin
+            request.execute
+          rescue Yoti::RequestError => e
+            raise Yoti::Sandbox::DocScan::Error.wrap(e)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/errors.rb

@@ -0,0 +1,83 @@
+require 'json'
+
+module Yoti
+  module Sandbox
+    module DocScan
+      #
+      # Raises exceptions related to Doc Scan Sandbox API requests
+      #
+      class Error < RequestError
+        def initialize(msg = nil, response = nil)
+          super(msg, response)
+
+          @default_message = msg
+        end
+
+        def message
+          @message ||= format_message
+        end
+
+        #
+        # Wraps an existing error
+        #
+        # @param [Error] error
+        #
+        # @return [self]
+        #
+        def self.wrap(error)
+          new(error.message, error.response)
+        end
+
+        private
+
+        #
+        # Formats error message from response.
+        #
+        # @return [String]
+        #
+        def format_message
+          return @default_message if @response.nil? || @response['Content-Type'] != 'application/json'
+
+          json = JSON.parse(@response.body)
+          format_response(json) || @default_message
+        end
+
+        #
+        # Format JSON error response.
+        #
+        # @param [Hash] json
+        #
+        # @return [String, nil]
+        #
+        def format_response(json)
+          return nil if json['code'].nil? || json['message'].nil?
+
+          code_message = "#{json['code']} - #{json['message']}"
+
+          unless json['errors'].nil?
+            property_errors = format_property_errors(json['errors'])
+
+            return "#{code_message}: #{property_errors.compact.join(', ')}" if property_errors.count.positive?
+          end
+
+          code_message
+        end
+
+        #
+        # Format property errors.
+        #
+        # @param [Array<Hash>] errors
+        #
+        # @return [Array<String>]
+        #
+        def format_property_errors(errors)
+          errors
+            .map do |e|
+              "#{e['property']} \"#{e['message']}\"" if e['property'] && e['message']
+            end
+            .compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class Check
+          #
+          # @param [CheckResult] result
+          #
+          def initialize(result)
+            raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(Check)
+
+            Validation.assert_is_a(CheckResult, result, 'result')
+            @result = result
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              result: @result.as_json
+            }
+          end
+        end
+
+        class CheckBuilder
+          def initialize
+            @breakdowns = []
+          end
+
+          #
+          # @param [Recommendation] recommendation
+          #
+          # @return [self]
+          #
+          def with_recommendation(recommendation)
+            Validation.assert_is_a(Recommendation, recommendation, 'recommendation')
+            @recommendation = recommendation
+            self
+          end
+
+          #
+          # @param [Breakdown] breakdown
+          #
+          # @return [self]
+          #
+          def with_breakdown(breakdown)
+            Validation.assert_is_a(Breakdown, breakdown, 'breakdown')
+            @breakdowns.push(breakdown)
+            self
+          end
+
+          #
+          # @param [Array<Breakdown>] breakdowns
+          #
+          # @return [self]
+          #
+          def with_breakdowns(breakdowns)
+            Validation.assert_is_a(Array, breakdowns, 'breakdown')
+            @breakdowns = breakdowns
+            self
+          end
+        end
+
+        class CheckResult
+          #
+          # @param [CheckReport] report
+          #
+          def initialize(report)
+            Validation.assert_is_a(CheckReport, report, 'report')
+            @report = report
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              report: @report.as_json
+            }
+          end
+        end
+
+        class CheckReport
+          #
+          # @param [Recommendation] recommendation
+          # @param [Breakdown] breakdowns
+          #
+          def initialize(recommendation, breakdowns)
+            Validation.assert_is_a(Recommendation, recommendation, 'recommendation')
+            @recommendation = recommendation
+
+            Validation.assert_is_a(Array, breakdowns, 'breakdowns')
+            @breakdowns = breakdowns
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              recommendation: @recommendation.as_json,
+              breakdown: @breakdowns.map(&:as_json)
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class DocumentAuthenticityCheck < DocumentCheck
+          #
+          # @return [DocumentAuthenticityCheckBuilder]
+          #
+          def self.builder
+            DocumentAuthenticityCheckBuilder.new
+          end
+        end
+
+        class DocumentAuthenticityCheckBuilder < DocumentCheckBuilder
+          #
+          # @return [DocumentAuthenticityCheck]
+          #
+          def build
+            report = CheckReport.new(@recommendation, @breakdowns)
+            result = CheckResult.new(report)
+            DocumentAuthenticityCheck.new(result, @document_filter)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class DocumentCheck < Check
+          #
+          # @param [CheckResult] result
+          # @param [DocumentFilter] document_filter
+          #
+          def initialize(result, document_filter)
+            raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(DocumentCheck)
+
+            super(result)
+
+            Validation.assert_is_a(DocumentFilter, document_filter, 'document_filter', true)
+            @document_filter = document_filter
+          end
+
+          def as_json(*_args)
+            json = super
+            json[:document_filter] = @document_filter.as_json unless @document_filter.nil?
+            json
+          end
+        end
+
+        class DocumentCheckBuilder < CheckBuilder
+          def initialize
+            raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(DocumentCheckBuilder)
+
+            super
+          end
+
+          #
+          # @param [DocumentFilter] document_filter
+          #
+          # @return [self]
+          #
+          def with_document_filter(document_filter)
+            @document_filter = document_filter
+            self
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class DocumentFaceMatchCheck < DocumentCheck
+          #
+          # @return [DocumentFaceMatchCheckBuilder]
+          #
+          def self.builder
+            DocumentFaceMatchCheckBuilder.new
+          end
+        end
+
+        class DocumentFaceMatchCheckBuilder < DocumentCheckBuilder
+          #
+          # @return [DocumentFaceMatchCheck]
+          #
+          def build
+            report = CheckReport.new(@recommendation, @breakdowns)
+            result = CheckResult.new(report)
+            DocumentFaceMatchCheck.new(result, @document_filter)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class DocumentTextDataCheck < DocumentCheck
+          #
+          # @return [DocumentTextDataCheckBuilder]
+          #
+          def self.builder
+            DocumentTextDataCheckBuilder.new
+          end
+        end
+
+        class DocumentTextDataCheckResult < 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 DocumentTextDataCheckBuilder < 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 [DocumentTextDataCheck]
+          #
+          def build
+            report = CheckReport.new(@recommendation, @breakdowns)
+            result = DocumentTextDataCheckResult.new(report, @document_fields)
+            DocumentTextDataCheck.new(result, @document_filter)
+          end
+        end
+      end
+    end
+  end
+end