yoti_sandbox 1.0.0 → 1.1.0

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class ResponseConfig
+          #
+          # @param [TaskResults,nil] task_results
+          # @param [CheckReports] check_reports
+          #
+          def initialize(
+            task_results,
+            check_reports
+          )
+            Validation.assert_is_a(TaskResults, task_results, 'task_results', true)
+            @task_results = task_results
+
+            Validation.assert_is_a(CheckReports, check_reports, 'check_reports')
+            @check_reports = check_reports
+          end
+
+          def self.builder
+            ResponseConfigBuilder.new
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              task_results: @task_results,
+              check_reports: @check_reports
+            }.compact
+          end
+        end
+
+        class ResponseConfigBuilder
+          #
+          # @param [TaskResults] task_results
+          #
+          # @return [self]
+          #
+          def with_task_results(task_results)
+            Validation.assert_is_a(TaskResults, task_results, 'task_results')
+            @task_results = task_results
+            self
+          end
+
+          #
+          # @param [CheckReports] check_reports
+          #
+          # @return [self]
+          #
+          def with_check_reports(check_reports)
+            Validation.assert_is_a(CheckReports, check_reports, 'check_reports')
+            @check_reports = check_reports
+            self
+          end
+
+          #
+          # @return [ResponseConfig]
+          #
+          def build
+            ResponseConfig.new(
+              @task_results,
+              @check_reports
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/task/document_text_data_extraction_task.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class DocumentTextDataExtractionTask
+          #
+          # @param [DocumentTextDataExtractionTaskResult] result
+          # @param [DocumentFilter] document_filter
+          #
+          def initialize(result, document_filter)
+            raise(TypeError, "#{self.class} cannot be instantiated") if self.class == DocumentCheck
+
+            Validation.assert_is_a(DocumentTextDataExtractionTaskResult, result, 'result')
+            @result = result
+
+            Validation.assert_is_a(DocumentFilter, document_filter, 'document_filter', true)
+            @document_filter = document_filter
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            json = {
+              result: @result.as_json
+            }
+            json[:document_filter] = @document_filter.as_json unless @document_filter.nil?
+            json
+          end
+
+          #
+          # @return [DocumentTextDataExtractionTaskBuilder]
+          #
+          def self.builder
+            DocumentTextDataExtractionTaskBuilder.new
+          end
+        end
+
+        class DocumentTextDataExtractionTaskResult
+          #
+          # @param [Hash] document_fields
+          #
+          def initialize(document_fields)
+            Validation.assert_is_a(Hash, document_fields, 'document_fields')
+            document_fields.each { |_k, v| Validation.assert_is_a(String, v, 'document_fields value') }
+            @document_fields = document_fields
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              document_fields: @document_fields
+            }
+          end
+        end
+
+        class DocumentTextDataExtractionTaskBuilder
+          def initialize
+            @document_fields = {}
+          end
+
+          #
+          # @param [String] key
+          # @param [String] value
+          #
+          # @return [self]
+          #
+          def with_document_field(key, value)
+            Validation.assert_is_a(String, key, 'key')
+            Validation.assert_is_a(String, value, 'value')
+            @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
+
+          #
+          # @param [DocumentFilter] document_filter
+          #
+          # @return [self]
+          #
+          def with_document_filter(document_filter)
+            @document_filter = document_filter
+            self
+          end
+
+          #
+          # @return [DocumentTextDataExtractionTask]
+          #
+          def build
+            result = DocumentTextDataExtractionTaskResult.new(@document_fields)
+            DocumentTextDataExtractionTask.new(result, @document_filter)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class TaskResults
+          #
+          # @param [Array<DocumentTextDataExtractionTask>] document_text_data_extraction_tasks
+          #
+          def initialize(document_text_data_extraction_tasks)
+            Validation.assert_is_a(
+              Array,
+              document_text_data_extraction_tasks,
+              'document_text_data_extraction_tasks'
+            )
+            @document_text_data_extraction_tasks = document_text_data_extraction_tasks
+          end
+
+          def self.builder
+            TaskResultsBuilder.new
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              Yoti::DocScan::Constants::ID_DOCUMENT_TEXT_DATA_EXTRACTION => @document_text_data_extraction_tasks
+            }
+          end
+        end
+
+        class TaskResultsBuilder
+          def initialize
+            @document_text_data_extraction_tasks = []
+          end
+
+          #
+          # @param [DocumentTextDataExtractionTask] document_text_data_extraction_task
+          #
+          # @return [self]
+          #
+          def with_document_text_data_extraction_task(document_text_data_extraction_task)
+            Validation.assert_is_a(
+              DocumentTextDataExtractionTask,
+              document_text_data_extraction_task,
+              'document_text_data_extraction_task'
+            )
+            @document_text_data_extraction_tasks << document_text_data_extraction_task
+            self
+          end
+
+          #
+          # @return [TaskResults]
+          #
+          def build
+            TaskResults.new(@document_text_data_extraction_tasks)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/profile.rb

@@ -1,3 +1,5 @@
+require 'yoti'
+
 require_relative 'profile/age_verification'
 require_relative 'profile/anchor'
 require_relative 'profile/attribute'

data/lib/yoti_sandbox/profile/age_verification.rb

@@ -25,6 +25,13 @@ module Yoti
           @anchors = anchors
         end
 
+        #
+        # @return [AgeVerificationBuilder]
+        #
+        def self.builder
+          AgeVerificationBuilder.new
+        end
+
         #
         # @return [Attribute]
         #

data/lib/yoti_sandbox/profile/client.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'yoti'
-require 'securerandom'
-
 module Yoti
   module Sandbox
     module Profile
@@ -23,30 +20,15 @@ module Yoti
         # @return [String]
         #
         def setup_sharing_profile(token_request)
-          endpoint = "/apps/#{Yoti.configuration.client_sdk_id}/tokens?\
-nonce=#{SecureRandom.uuid}&timestamp=#{Time.now.to_i}"
-          uri = URI(
-            "#{@base_url}#{endpoint}"
-          )
-
-          response = Net::HTTP.start(
-            uri.hostname,
-            uri.port,
-            use_ssl: true
-          ) do |http|
-            unsigned = Net::HTTP::Post.new uri
-            unsigned.body = token_request.to_json
-            signed_request = Yoti::SignedRequest.new(
-              unsigned,
-              endpoint,
-              token_request
-            ).sign
-            http.request signed_request
-          end
-
-          raise "Failed to share profile #{response.code}: #{response.body}" unless response.code == '201'
+          request = Yoti::Request
+                    .builder
+                    .with_base_url(@base_url)
+                    .with_endpoint("apps/#{Yoti.configuration.client_sdk_id}/tokens")
+                    .with_http_method('POST')
+                    .with_payload(token_request)
+                    .build
 
-          JSON.parse(response.body)['token']
+          JSON.parse(request.execute.body)['token']
         end
       end
     end

data/lib/yoti_sandbox/profile/token_request.rb

@@ -22,6 +22,13 @@ module Yoti
           @attributes = attributes
         end
 
+        #
+        # @return [TokenRequestBuilder]
+        #
+        def self.builder
+          TokenRequestBuilder.new
+        end
+
         #
         # @return [Hash]
         #

data/rubocop.yml

@@ -16,12 +16,13 @@ Metrics/ClassLength:
   Enabled: false
   Max: 115
 
+Metrics/ModuleLength:
+  Exclude:
+    - examples/doc_scan/**/*.rb
+
 Metrics/CyclomaticComplexity:
   Max: 9
 
-Metrics/LineLength:
-  Enabled: false
-
 Metrics/MethodLength:
   Enabled: false
   CountComments: false
@@ -39,6 +40,9 @@ Style/NumericLiterals:
 Style/MutableConstant:
   Enabled: false
 
+Layout/LineLength:
+  Enabled: false
+
 Layout/MultilineMethodCallIndentation:
   Exclude:
     - examples/**/*.rb

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.0.0'
+  spec.version       = '1.1.0'
   spec.authors       = ['Yoti']
   spec.email         = ['websdk@yoti.com']
 
@@ -21,12 +21,12 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.4'
 
-  spec.add_dependency 'yoti', '~> 1.6'
+  spec.add_dependency 'yoti', '~> 1.7'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.5'
-  spec.add_development_dependency 'simplecov', '~> 0.13'
+  spec.add_development_dependency 'simplecov', '~> 0.17.1'
   spec.add_development_dependency 'webmock', '~> 3.3'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'yardstick', '~> 0.9'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yoti_sandbox
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yoti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yoti
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +140,23 @@ files:
 - README.md
 - Rakefile
 - lib/yoti_sandbox.rb
+- lib/yoti_sandbox/doc_scan.rb
+- lib/yoti_sandbox/doc_scan/client.rb
+- lib/yoti_sandbox/doc_scan/request/check/check.rb
+- lib/yoti_sandbox/doc_scan/request/check/document_authenticity_check.rb
+- 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/liveness_check.rb
+- lib/yoti_sandbox/doc_scan/request/check/report/breakdown.rb
+- lib/yoti_sandbox/doc_scan/request/check/report/detail.rb
+- lib/yoti_sandbox/doc_scan/request/check/report/recommendation.rb
+- lib/yoti_sandbox/doc_scan/request/check/zoom_liveness_check.rb
+- lib/yoti_sandbox/doc_scan/request/check_reports.rb
+- lib/yoti_sandbox/doc_scan/request/document_filter.rb
+- lib/yoti_sandbox/doc_scan/request/response_config.rb
+- lib/yoti_sandbox/doc_scan/request/task/document_text_data_extraction_task.rb
+- lib/yoti_sandbox/doc_scan/request/task_results.rb
 - lib/yoti_sandbox/profile.rb
 - lib/yoti_sandbox/profile/age_verification.rb
 - lib/yoti_sandbox/profile/anchor.rb