yoti_sandbox 1.0.0 → 1.4.0

data/lib/yoti_sandbox/profile/third_party.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Yoti
+  module Sandbox
+    module Profile
+      #
+      # Provides attribute issuance details data entry
+      #
+      class AttributeIssuanceDetails < DataEntry
+        #
+        # @param [AttributeIssuanceDetailsValue] value
+        #
+        def initialize(value)
+          Validation.assert_is_a(AttributeIssuanceDetailsValue, value, 'value')
+          super('THIRD_PARTY_ATTRIBUTE', value)
+        end
+
+        #
+        # @return [AttributeIssuanceDetailsBuilder]
+        #
+        def self.builder
+          AttributeIssuanceDetailsBuilder.new
+        end
+      end
+
+      #
+      # Builder for AttributeIssuanceDetails
+      #
+      class AttributeIssuanceDetailsBuilder
+        def initialize
+          @definitions = []
+        end
+
+        #
+        # @param [String] issuance_token
+        #
+        # @return [self]
+        #
+        def with_issuance_token(issuance_token)
+          Validation.assert_is_a(String, issuance_token, 'issuance_token')
+          @issuance_token = issuance_token
+          self
+        end
+
+        #
+        # @param [Time, DateTime] expiry_date
+        #
+        # @return [self]
+        #
+        def with_expiry_date(expiry_date)
+          Validation.assert_respond_to(:to_time, expiry_date, 'expiry_date')
+          @expiry_date = expiry_date
+          self
+        end
+
+        #
+        # @param [String] definition
+        #
+        # @return [self]
+        #
+        def with_definition(definition)
+          @definitions << AttributeDefinition.new(definition)
+          self
+        end
+
+        #
+        # @return [AttributeIssuanceDetails]
+        #
+        def build
+          issuing_attributes = IssuingAttributes.new(@expiry_date, @definitions)
+          value = AttributeIssuanceDetailsValue.new(@issuance_token, issuing_attributes)
+          AttributeIssuanceDetails.new(value)
+        end
+      end
+
+      #
+      # Provides attribute issuance details value consisting of token and attributes.
+      #
+      class AttributeIssuanceDetailsValue
+        #
+        # @param [String] issuance_token
+        # @param [IssuingAttributes] issuing_attributes
+        #
+        def initialize(issuance_token, issuing_attributes)
+          Validation.assert_is_a(String, issuance_token, 'issuance_token')
+          @issuance_token = issuance_token
+
+          Validation.assert_is_a(IssuingAttributes, issuing_attributes, 'issuing_attributes')
+          @issuing_attributes = issuing_attributes
+        end
+
+        def to_json(*_args)
+          as_json.to_json
+        end
+
+        def as_json(*_args)
+          {
+            issuance_token: @issuance_token,
+            issuing_attributes: @issuing_attributes
+          }
+        end
+      end
+
+      #
+      # Provides issuing attributes, consisting of expiry date and list of definitions.
+      #
+      class IssuingAttributes
+        #
+        # @param [Time, DateTime] expiry_date
+        # @param [Array<AttributeDefinition>] definitions
+        #
+        def initialize(expiry_date, definitions)
+          Validation.assert_respond_to(:to_time, expiry_date, 'expiry_date')
+          @expiry_date = expiry_date
+
+          Validation.assert_is_a(Array, definitions, 'definitions')
+          @definitions = definitions
+        end
+
+        def to_json(*_args)
+          as_json.to_json
+        end
+
+        def as_json(*_args)
+          json = {}
+          json[:expiry_date] = @expiry_date.to_time.utc.strftime('%FT%T.%3NZ') unless @expiry_date.nil?
+          json[:definitions] = @definitions.map(&:as_json)
+          json
+        end
+      end
+
+      #
+      # Provides a single attribute definition.
+      #
+      class AttributeDefinition
+        #
+        # @param [String] name
+        #
+        def initialize(name)
+          Validation.assert_is_a(String, name, 'name')
+          @name = name
+        end
+
+        def to_json(*_args)
+          as_json.to_json
+        end
+
+        def as_json(*_args)
+          {
+            name: @name
+          }
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/profile/token_request.rb

@@ -14,12 +14,26 @@ module Yoti
       #
       class TokenRequest
         #
-        # @param [String] remember_me_id
+        # @param [String, nil] remember_me_id
         # @param [Array<Attribute>] attributes
+        # @param [ExtraData, nil] extra_data
         #
-        def initialize(remember_me_id, attributes)
+        def initialize(remember_me_id, attributes, extra_data = nil)
+          Validation.assert_is_a(String, remember_me_id, 'remember_me_id', true)
           @remember_me_id = remember_me_id
+
+          Validation.assert_is_a(Array, attributes, 'attributes')
           @attributes = attributes
+
+          Validation.assert_is_a(ExtraData, extra_data, 'extra_data', true)
+          @extra_data = extra_data
+        end
+
+        #
+        # @return [TokenRequestBuilder]
+        #
+        def self.builder
+          TokenRequestBuilder.new
         end
 
         #
@@ -28,8 +42,9 @@ module Yoti
         def as_json(*_args)
           {
             remember_me_id: @remember_me_id,
-            profile_attributes: @attributes.map(&:as_json)
-          }
+            profile_attributes: @attributes.map(&:as_json),
+            extra_data: @extra_data
+          }.compact
         end
 
         #
@@ -45,7 +60,6 @@ module Yoti
       #
       class TokenRequestBuilder
         def initialize
-          @remember_me_id = ''
           @attributes = []
         end
 
@@ -283,11 +297,38 @@ module Yoti
           )
         end
 
+        #
+        # @param [DocumentImages] document_images
+        # @param [Array<Anchor>] anchors
+        #
+        # @return [self]
+        #
+        def with_document_images(document_images, anchors: [])
+          with_attribute(
+            create_attribute(
+              name: Yoti::Attribute::DOCUMENT_IMAGES,
+              value: document_images.value,
+              anchors: anchors
+            )
+          )
+        end
+
+        #
+        # @param [ExtraData] extra_data
+        #
+        # @return [self]
+        #
+        def with_extra_data(extra_data)
+          Validation.assert_is_a(ExtraData, extra_data, 'extra_data')
+          @extra_data = extra_data
+          self
+        end
+
         #
         # @return [TokenRequest]
         #
         def build
-          TokenRequest.new(@remember_me_id, @attributes)
+          TokenRequest.new(@remember_me_id, @attributes, @extra_data)
         end
 
         private

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.4.0'
   spec.authors       = ['Yoti']
   spec.email         = ['websdk@yoti.com']
 
@@ -16,17 +16,30 @@ 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'
 
-  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.4.0
 platform: ruby
 authors:
 - Yoti
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2020-11-16 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
@@ -131,29 +131,49 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE.md"
-- ".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
+- lib/yoti_sandbox/doc_scan/errors.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/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
+- lib/yoti_sandbox/doc_scan/request/check/report/recommendation.rb
+- lib/yoti_sandbox/doc_scan/request/check/supplementary_document_text_data_check.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_id_photo.rb
+- lib/yoti_sandbox/doc_scan/request/task/document_text_data_extraction_task.rb
+- lib/yoti_sandbox/doc_scan/request/task/supplementary_document_text_data_extraction_task.rb
+- lib/yoti_sandbox/doc_scan/request/task/text_data_extraction_reason.rb
+- lib/yoti_sandbox/doc_scan/request/task/text_data_extraction_recommendation.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
 - lib/yoti_sandbox/profile/attribute.rb
 - lib/yoti_sandbox/profile/client.rb
+- lib/yoti_sandbox/profile/document_images.rb
+- 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:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -169,7 +189,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 Sandbox SDK for back-end integration.
 test_files: []

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/.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?--*