yoti 1.6.3 → 1.9.0

data/lib/yoti/protobuf/main.rb

@@ -94,7 +94,7 @@ module Yoti
         proto_multi_value = Yoti::Protobuf::Attrpubapi::MultiValue.decode(value)
         items = []
         proto_multi_value.values.each do |item|
-          items.append value_based_on_content_type(item.data, item.content_type)
+          items << value_based_on_content_type(item.data, item.content_type)
         end
         MultiValue.new(items)
       end

data/lib/yoti/ssl.rb

@@ -32,7 +32,7 @@ module Yoti
       end
 
       # Extracts the public key from pem key, converts it to a DER base 64 encoded value
-      # @return [String] base 64 encoded anthentication key
+      # @return [String] base 64 encoded authentication key
       def auth_key_from_pem
         public_key = private_key.public_key
         Base64.strict_encode64(public_key.to_der)
@@ -48,7 +48,7 @@ module Yoti
 
       # Uses the decrypted receipt key and the current user's iv to decode the text
       # @param key [String] base 64 decoded key
-      # @param iv [String] base 64 decoded iv
+      # @param user_iv [String] base 64 decoded iv
       # @param text [String] base 64 decoded cyphered text
       # @return [String] base 64 decoded deciphered text
       def decipher(key, user_iv, text)

data/lib/yoti/util/anchor_processor.rb

@@ -7,7 +7,7 @@ module Yoti
   #
   class AnchorProcessor
     #
-    # @param [Array<Yoti::Protobuf::Attrpubapi::Anchor>]
+    # @param [Array<Yoti::Protobuf::Attrpubapi::Anchor>] anchors_list
     #
     def initialize(anchors_list)
       @anchors_list = anchors_list

data/lib/yoti/util/validation.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Yoti
+  class Validation
+    #
+    # @param value
+    # @param [String] name
+    #
+    def self.assert_not_nil(value, name)
+      return unless value.nil?
+
+      raise(ArgumentError, "#{name} must not be nil")
+    end
+
+    #
+    # @param [Class] type
+    # @param value
+    # @param [String] name
+    # @param [Boolean] nilable
+    #
+    def self.assert_is_a(type, value, name, nilable = false)
+      return if nilable && value.nil?
+      return if value.is_a?(type)
+
+      raise(ArgumentError, "#{name} must be a #{type.name}")
+    end
+
+    #
+    # @param [Symbol] method
+    # @param value
+    # @param [String] name
+    #
+    def self.assert_respond_to(method, value, name)
+      assert_not_nil(value, name)
+
+      return if value.respond_to?(method)
+
+      raise(ArgumentError, "#{name} must respond to #{method}")
+    end
+  end
+end

data/lib/yoti/version.rb

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

data/yoti.gemspec

@@ -5,8 +5,8 @@ require 'yoti/version'
 Gem::Specification.new do |spec|
   spec.name          = 'yoti'
   spec.version       = Yoti::VERSION
-  spec.authors       = ['Sebastian Zaremba']
-  spec.email         = ['tech@yoti.com']
+  spec.authors       = ['Yoti']
+  spec.email         = ['websdk@yoti.com']
 
   spec.summary       = 'Yoti Ruby SDK for back-end integration.'
   spec.description = <<-DESC
@@ -18,22 +18,32 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/getyoti/yoti-ruby-sdk'
   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 'activesupport', '~> 5.0' # Pin activesupport library to 5.x for Ruby 2.4 support
-  spec.add_dependency 'google-protobuf', '~> 3.7', '>= 3.7.0'
-  spec.add_dependency 'protobuf', '~> 3.6'
+  spec.add_dependency 'google-protobuf', '~> 3.7'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'coveralls', '~> 0.8'
   spec.add_development_dependency 'dotenv', '~> 2.2'
   spec.add_development_dependency 'generator_spec', '~> 0.9'
-  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,36 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: yoti
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.9.0
 platform: ruby
 authors:
-- Sebastian Zaremba
-autorequire: 
+- Yoti
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.7.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
@@ -38,26 +21,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.7.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: protobuf
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -120,14 +72,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
@@ -148,14 +100,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
@@ -203,19 +155,14 @@ description: |2
       with Yoti, so that your users can share their identity details with your
       application in a secure and trusted way.
 email:
-- tech@yoti.com
+- websdk@yoti.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE.md"
-- ".gitignore"
-- CONTRIBUTING.md
 - Gemfile
-- Guardfile
 - LICENSE.md
 - README.md
-- Rakefile
 - lib/generators/yoti/install/install_generator.rb
 - lib/generators/yoti/install/templates/yoti.rb
 - lib/yoti.rb
@@ -231,9 +178,57 @@ files:
 - lib/yoti/data_type/image.rb
 - lib/yoti/data_type/image_jpeg.rb
 - lib/yoti/data_type/image_png.rb
+- lib/yoti/data_type/media.rb
 - lib/yoti/data_type/multi_value.rb
 - lib/yoti/data_type/profile.rb
 - lib/yoti/data_type/signed_time_stamp.rb
+- lib/yoti/doc_scan/client.rb
+- lib/yoti/doc_scan/constants.rb
+- lib/yoti/doc_scan/errors.rb
+- lib/yoti/doc_scan/session/create/create_session_result.rb
+- lib/yoti/doc_scan/session/create/document_filter.rb
+- lib/yoti/doc_scan/session/create/document_restrictions_filter.rb
+- lib/yoti/doc_scan/session/create/notification_config.rb
+- lib/yoti/doc_scan/session/create/orthogonal_restrictions_filter.rb
+- 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
+- lib/yoti/doc_scan/session/create/required_document.rb
+- lib/yoti/doc_scan/session/create/required_id_document.rb
+- lib/yoti/doc_scan/session/create/sdk_config.rb
+- lib/yoti/doc_scan/session/create/session_specification.rb
+- lib/yoti/doc_scan/session/retrieve/authenticity_check_response.rb
+- lib/yoti/doc_scan/session/retrieve/breakdown_response.rb
+- lib/yoti/doc_scan/session/retrieve/check_response.rb
+- lib/yoti/doc_scan/session/retrieve/details_response.rb
+- lib/yoti/doc_scan/session/retrieve/document_fields_response.rb
+- lib/yoti/doc_scan/session/retrieve/document_id_photo_response.rb
+- lib/yoti/doc_scan/session/retrieve/face_map_response.rb
+- lib/yoti/doc_scan/session/retrieve/face_match_check_response.rb
+- lib/yoti/doc_scan/session/retrieve/frame_response.rb
+- lib/yoti/doc_scan/session/retrieve/generated_check_response.rb
+- 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
+- lib/yoti/doc_scan/session/retrieve/media_response.rb
+- lib/yoti/doc_scan/session/retrieve/page_response.rb
+- lib/yoti/doc_scan/session/retrieve/recommendation_response.rb
+- lib/yoti/doc_scan/session/retrieve/report_response.rb
+- lib/yoti/doc_scan/session/retrieve/resource_container.rb
+- lib/yoti/doc_scan/session/retrieve/resource_response.rb
+- lib/yoti/doc_scan/session/retrieve/task_response.rb
+- lib/yoti/doc_scan/session/retrieve/text_data_check_response.rb
+- lib/yoti/doc_scan/session/retrieve/text_extraction_task_response.rb
+- lib/yoti/doc_scan/session/retrieve/zoom_liveness_resource_response.rb
+- lib/yoti/doc_scan/support/supported_documents.rb
 - lib/yoti/dynamic_share_service/dynamic_scenario.rb
 - lib/yoti/dynamic_share_service/extension/extension.rb
 - lib/yoti/dynamic_share_service/extension/location_constraint_extension.rb
@@ -268,16 +263,14 @@ files:
 - lib/yoti/util/age_processor.rb
 - lib/yoti/util/anchor_processor.rb
 - lib/yoti/util/log.rb
+- lib/yoti/util/validation.rb
 - lib/yoti/version.rb
-- login_flow.png
-- rubocop.yml
-- yardstick.yml
 - yoti.gemspec
 homepage: https://github.com/getyoti/yoti-ruby-sdk
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -293,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: []

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,39 +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
-
-## 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
-
-# Ignore Yardstick measurement files
-/measurement
-examples/rails/public/*.jpeg
-examples/sinatra/public/*.jpeg

data/CONTRIBUTING.md

@@ -1,127 +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
-
-## Dependencies
-
-Although this gem supports Ruby 2.0.0, in order to use the latest development dependencies you have to use at least Ruby 2.2.2.
-
-If you wish to compile `.proto` definitions to Ruby, you will need to install [Google's Protocol Buffers](http://code.google.com/p/protobuf).
-
-### OSX
-
-```shell
-brew install protobuf
-```
-
-### Ubuntu
-
-```shell
-sudo apt-get install -y protobuf
-```
-
-This gem relies heavily on the [Ruby Protobuf][] gem. For more information on how Google Protobuf works, please see the [Wiki pages][].
-
-Compiling the common and attribute `.proto` definitions can be done with the following commands:
-
-```shell
-cd lib/yoti/protobuf/v1
-protoc -I definitions/attribute-public-api/attrpubapi_v1 --ruby_out ./attribute_public_api definitions/attribute-public-api/attrpubapi_v1/*.proto
-protoc -I definitions/common-public-api/compubapi_v1/ --ruby_out ./common_public_api definitions/common-public-api/compubapi_v1/*.proto
-```
-
-These commands will overwrite the current protobuf Ruby modules, which have been modified. If the protobuf files have to be updated, a good idea would be to change them manually, or generate the files in a new location, and compare the content.
-
-[Ruby Protobuf]: https://github.com/ruby-protobuf/protobuf/
-[Wiki Pages]:    https://github.com/ruby-protobuf/protobuf/wiki
-
-## Requirements
-
-### 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
-```
-
-### Documentation
-
-The documentation uses the [Yard][] format. Please ensure all new classes and methods are fully documented.
-
-There are a few Rake tasks to handle documentation:
-
-```shell
-bundle exec rake measurement
-```
-
-Verifies the documentation with [Yardstick][] and generates the `measurement/report.txt` file, containing tips on how to improve the documentation coverage.
-
-```shell
-bundle exec rake yard
-```
-
-Generates [YARD][] documentation in the doc folder.
-
-### Git
-
-Commit messages should ideally start with one of the following verbs:
-
-* Add
-* Merge
-* Fix
-* Remove
-* Improve
-* Use
-
-[SimpleCov]:   https://github.com/colszowka/simplecov
-[Yard]:        http://yardoc.org/
-[Yardstick]:   https://github.com/dkubb/yardstick
-
-## Publishing a new release
-
-* Create a new release on [GitHub](https://github.com/getyoti/yoti-ruby-sdk/releases)
-* Build the gem and push it to [RubyGems](https://rubygems.org/gems/yoti)
-
-```shell
-rake build
-gem push pkg/yoti-[version].gem
-```
-
-## Submitting a pull request
-
-1. [Fork the repository.][fork]
-2. [Create a topic branch.][branch]
-3. Add specs for your unimplemented feature or bug fix.
-4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
-5. Implement your feature or bug fix.
-6. Run `bundle exec rake`. If your specs fail, return to step 5.
-7. Run `open coverage/index.html`. If your changes are not completely covered
-   by your tests, return to step 3.
-8. If Rubocop warns you about styling errors, correct them based on the guidelines and run `bundle exec rake rubocop` to make sure all offences are gone.
-9. Add documentation for your feature or bug fix.
-10. Commit and push your changes.
-11. [Submit a pull request.][pr]
-
-[fork]: http://help.github.com/fork-a-repo/
-[branch]: http://learn.github.com/p/branching.html
-[pr]: http://help.github.com/send-pull-requests/