yoti 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 691432df23cdd73c562aedd1f85ea6077ce38508
-  data.tar.gz: ba22b06a08a95aaff4c3309e1e7c1db4195f4a10
+SHA256:
+  metadata.gz: 02fe8b8e97eb660a8f100add12f7a07591fd78c39a0b476ce386b01af9d8c18e
+  data.tar.gz: b37386c172ecf56164d5e8b18129c41698444459e4611b35e8aeda4da9176287
 SHA512:
-  metadata.gz: b8fba42c58a939ffbd6f66d97e2970cc34a705e1b3f04ccffb5fddba494a8f273de9aadb6d9c88b5c3cd6be8a673655c23347f35da303f7f408c74cc22747155
-  data.tar.gz: de2c82706cd19db939a182e45134c3d0aaf282cb1b0785e443e8691cf419b76250921ad0507f84987206c3075fdf127fa4b2d1b554d499764dc95f1db43c86cd
+  metadata.gz: 36f47a7c8728ccdde726c67d7ecde1282051f128e63ffd685c6981634d660bba98ff7de9c0aed53dee950112a392978c5ffce44d3a130d16d7487eb5fd22431c
+  data.tar.gz: bbbee64ecc44ce41a204c8109fb673339972886d5818db20d3952009b76fedf12222e705b7eb090c4da0fb0f9c8375fc4402e0ed9c595a8a72974e3f37ea5397

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,17 @@
+---
+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/CONTRIBUTING.md

@@ -16,35 +16,6 @@ bundle exec guard
 
 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

data/README.md

@@ -1,6 +1,10 @@
 # Yoti Ruby SDK
 
 [![Build Status](https://travis-ci.com/getyoti/yoti-ruby-sdk.svg?branch=master)](https://travis-ci.com/getyoti/yoti-ruby-sdk)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Aruby&metric=coverage)](https://sonarcloud.io/dashboard?id=getyoti%3Aruby)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Aruby&metric=bugs)](https://sonarcloud.io/dashboard?id=getyoti%3Aruby)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Aruby&metric=code_smells)](https://sonarcloud.io/dashboard?id=getyoti%3Aruby)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Aruby&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=getyoti%3Aruby)
 
 Welcome to the Yoti Ruby SDK. This repository contains the tools you need to quickly integrate your Ruby back-end with Yoti so that your users can share their identity details with your application in a secure and trusted way.
 

data/Rakefile

@@ -6,16 +6,13 @@ require 'yaml'
 # Tests                        #
 ################################
 
-RSpec::Core::RakeTask.new
-task test: :spec
-
-################################
-# Coveralls                    #
-################################
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = ['spec/yoti']
+end
 
-require 'coveralls/rake/task'
-Coveralls::RakeTask.new
-task test_with_coveralls: [:spec, 'coveralls:push']
+RSpec::Core::RakeTask.new(:test_generators) do |t|
+  t.pattern = ['spec/generators']
+end
 
 ################################
 # Rubocop                      #
@@ -46,4 +43,4 @@ end
 # Defaults                     #
 ################################
 
-task default: %i[spec rubocop]
+task default: %i[spec test_generators rubocop]

data/lib/yoti.rb

@@ -18,6 +18,7 @@ require_relative 'yoti/data_type/application_profile'
 require_relative 'yoti/data_type/profile'
 require_relative 'yoti/data_type/attribute'
 require_relative 'yoti/data_type/signed_time_stamp'
+require_relative 'yoti/data_type/media'
 require_relative 'yoti/data_type/image'
 require_relative 'yoti/data_type/image_jpeg'
 require_relative 'yoti/data_type/image_png'
@@ -26,7 +27,8 @@ require_relative 'yoti/data_type/document_details'
 
 require_relative 'yoti/util/age_processor'
 require_relative 'yoti/util/anchor_processor'
-require_relative 'yoti/util/log.rb'
+require_relative 'yoti/util/log'
+require_relative 'yoti/util/validation'
 
 require_relative 'yoti/activity_details'
 require_relative 'yoti/client'
@@ -47,6 +49,53 @@ require_relative 'yoti/dynamic_share_service/extension/thirdparty_attribute_exte
 require_relative 'yoti/share/extra_data'
 require_relative 'yoti/share/attribute_issuance_details'
 
+require_relative 'yoti/doc_scan/client'
+require_relative 'yoti/doc_scan/constants'
+
+require_relative 'yoti/doc_scan/session/create/create_session_result'
+require_relative 'yoti/doc_scan/session/create/requested_check'
+require_relative 'yoti/doc_scan/session/create/requested_document_authenticity_check'
+require_relative 'yoti/doc_scan/session/create/requested_face_match_check'
+require_relative 'yoti/doc_scan/session/create/requested_liveness_check'
+require_relative 'yoti/doc_scan/session/create/requested_task'
+require_relative 'yoti/doc_scan/session/create/requested_text_extraction_task'
+require_relative 'yoti/doc_scan/session/create/document_filter'
+require_relative 'yoti/doc_scan/session/create/document_restrictions_filter'
+require_relative 'yoti/doc_scan/session/create/orthogonal_restrictions_filter'
+require_relative 'yoti/doc_scan/session/create/required_document'
+require_relative 'yoti/doc_scan/session/create/required_id_document'
+require_relative 'yoti/doc_scan/session/create/sdk_config'
+require_relative 'yoti/doc_scan/session/create/notification_config'
+require_relative 'yoti/doc_scan/session/create/session_specification'
+
+require_relative 'yoti/doc_scan/session/retrieve/check_response'
+require_relative 'yoti/doc_scan/session/retrieve/resource_response'
+require_relative 'yoti/doc_scan/session/retrieve/authenticity_check_response'
+require_relative 'yoti/doc_scan/session/retrieve/breakdown_response'
+require_relative 'yoti/doc_scan/session/retrieve/details_response'
+require_relative 'yoti/doc_scan/session/retrieve/document_fields_response'
+require_relative 'yoti/doc_scan/session/retrieve/face_map_response'
+require_relative 'yoti/doc_scan/session/retrieve/face_match_check_response'
+require_relative 'yoti/doc_scan/session/retrieve/frame_response'
+require_relative 'yoti/doc_scan/session/retrieve/generated_check_response'
+require_relative 'yoti/doc_scan/session/retrieve/generated_media'
+require_relative 'yoti/doc_scan/session/retrieve/generated_text_data_check_response'
+require_relative 'yoti/doc_scan/session/retrieve/get_session_result'
+require_relative 'yoti/doc_scan/session/retrieve/id_document_resource_response'
+require_relative 'yoti/doc_scan/session/retrieve/liveness_check_response'
+require_relative 'yoti/doc_scan/session/retrieve/liveness_resource_response'
+require_relative 'yoti/doc_scan/session/retrieve/media_response'
+require_relative 'yoti/doc_scan/session/retrieve/page_response'
+require_relative 'yoti/doc_scan/session/retrieve/recommendation_response'
+require_relative 'yoti/doc_scan/session/retrieve/report_response'
+require_relative 'yoti/doc_scan/session/retrieve/resource_container'
+require_relative 'yoti/doc_scan/session/retrieve/task_response'
+require_relative 'yoti/doc_scan/session/retrieve/text_data_check_response'
+require_relative 'yoti/doc_scan/session/retrieve/text_extraction_task_response'
+require_relative 'yoti/doc_scan/session/retrieve/zoom_liveness_resource_response'
+
+require_relative 'yoti/doc_scan/support/supported_documents'
+
 # The main module namespace of the Yoti gem
 module Yoti
   class << self

data/lib/yoti/activity_details.rb

@@ -1,4 +1,5 @@
 require 'net/http'
+require 'time'
 
 module Yoti
   #
@@ -93,6 +94,9 @@ module Yoti
     #
     # @param receipt [Hash] the receipt from the API request
     # @param decrypted_profile [Object] Protobuf AttributeList decrypted object containing the profile attributes
+    # @param decrypted_application_profile [Object] Protobuf AttributeList decrypted object containing profile attributes for the application profile
+    # @param extra_data [Yoti::Share::ExtraData|nil] Processed extra data object or nil
+    #   if absent from the receipt
     #
     def initialize(receipt, decrypted_profile = nil, decrypted_application_profile = nil, extra_data = nil)
       @remember_me_id = receipt['remember_me_id']
@@ -103,7 +107,7 @@ module Yoti
       @timestamp = receipt['timestamp'] ? Time.parse(receipt['timestamp']) : nil
       @extended_user_profile = process_decrypted_profile(decrypted_profile)
       @extended_application_profile = process_decrypted_profile(decrypted_application_profile)
-      @extra_data = Share::ExtraData.new(extra_data) if extra_data
+      @extra_data = extra_data
       @user_profile = @extended_user_profile.map do |name, attribute|
         [name, attribute.value]
       end.to_h

data/lib/yoti/client.rb

@@ -1,15 +1,17 @@
 module Yoti
   #
-  # Handles all the publicly accesible Yoti methods for
-  # geting data using an encrypted connect token
+  # Handles all the publicly accessible Yoti methods for
+  # getting data using an encrypted connect token
   #
   module Client
     #
     # Performs all the steps required to get the decrypted profile from an API request
     #
-    # @param encrypted_connect_token [String] token provided as a base 64 string
+    # @param [String] encrypted_connect_token
+    #   Token provided as a base 64 string
     #
-    # @return [Object] an ActivityDetails instance encapsulating the user profile
+    # @return [ActivityDetails]
+    #   An ActivityDetails instance encapsulating the user profile
     #
     def self.get_activity_details(encrypted_connect_token)
       receipt = Yoti::ProfileRequest.new(encrypted_connect_token).receipt
@@ -22,6 +24,13 @@ module Yoti
       ActivityDetails.new(receipt, user_profile, application_profile, extra_data)
     end
 
+    #
+    # Perform AML check
+    #
+    # @param [AmlProfile] aml_profile
+    #
+    # @return [<Hash>]
+    #
     def self.aml_check(aml_profile)
       Yoti::AmlCheckRequest.new(aml_profile).response
     end

data/lib/yoti/configuration.rb

@@ -3,7 +3,7 @@ module Yoti
     attr_accessor :client_sdk_id, :key_file_path, :key, :sdk_identifier,
                   :api_url, :api_port, :api_version
 
-    attr_writer :api_endpoint
+    attr_writer :api_endpoint, :doc_scan_api_endpoint
 
     # Set config variables by using a configuration block
     def initialize
@@ -18,7 +18,12 @@ module Yoti
 
     # @return [String] the API endpoint for the selected API version
     def api_endpoint
-      @api_endpoint ||= "#{@api_url}/api/#{@api_version}"
+      @api_endpoint ||= ENV['YOTI_API_URL'] || "#{@api_url}/api/#{@api_version}"
+    end
+
+    # @return [String] the Doc Scan API endpoint
+    def doc_scan_api_endpoint
+      @doc_scan_api_endpoint ||= ENV['YOTI_DOC_SCAN_API_URL'] || "#{@api_url}/idverify/#{@api_version}"
     end
 
     # Validates the configuration values set in instance variables

data/lib/yoti/data_type/age_verification.rb

@@ -37,7 +37,7 @@ module Yoti
     attr_reader :age
 
     #
-    # @param [Yoti::Attribute]
+    # @param [Yoti::Attribute] attribute
     #
     def initialize(attribute)
       raise(ArgumentError, "'#{attribute.name}' is not a valid age verification") unless /^[^:]+:(?!.*:)[0-9]+$/.match?(attribute.name)

data/lib/yoti/data_type/base_profile.rb

@@ -37,7 +37,7 @@ module Yoti
     #
     # @param [String] name
     #
-    # @returns [Array]
+    # @return [Array]
     #
     def find_attributes_starting_with(name)
       @attributes.select { |key| key.to_s.start_with?(name) }

data/lib/yoti/data_type/document_details.rb

@@ -1,10 +1,10 @@
 module Yoti
   class DocumentDetails
     #
-    # The values of the Document Details are in the format and order as defined in this pattern
-    # e.g PASS_CARD GBR 22719564893 - CITIZENCARD, the last two are optionals
+    # @deprecated 2.0.0 pattern is no longer used for validation.
     #
     VALIDATION_PATTERN = '^([A-Za-z_]*) ([A-Za-z]{3}) ([A-Za-z0-9]{1}).*$'
+
     TYPE_INDEX = 0
     COUNTRY_INDEX = 1
     NUMBER_INDEX = 2
@@ -51,28 +51,20 @@ module Yoti
     # @param [String] value
     #
     def initialize(value)
-      validate_value(value)
       parse_value(value)
     end
 
     private
 
-    #
-    # Asserts provided matches VALIDATION_PATTERN
-    #
-    # @param [String] value
-    #
-    def validate_value(value)
-      raise(ArgumentError, "Invalid value for #{self.class.name}") unless /#{VALIDATION_PATTERN}/.match?(value)
-    end
-
     #
     # Parses provided value into separate attributes
     #
     # @param [String] value
     #
     def parse_value(value)
-      attributes = value.split(' ')
+      attributes = value.split(/ /)
+      raise(ArgumentError, "Invalid value for #{self.class.name}") if attributes.length < 3 || attributes.include?('')
+
       @type = attributes[TYPE_INDEX]
       @issuing_country = attributes[COUNTRY_INDEX]
       @document_number = attributes[NUMBER_INDEX]

data/lib/yoti/data_type/image.rb

@@ -1,19 +1,11 @@
-require 'base64'
+# frozen_string_literal: true
 
 module Yoti
-  class Image
-    attr_reader :content
-    attr_reader :mime_type
-
+  class Image < Media
     def initialize(content, mime_type)
-      raise(TypeError, 'Image is an abstract class, so cannot be instantiated') if self.class == Yoti::Image
-
-      @content = content
-      @mime_type = mime_type
-    end
+      raise(TypeError, "#{self.class} is an abstract class, so cannot be instantiated") if self.class == Image
 
-    def base64_content
-      "data:#{mime_type};base64,#{Base64.strict_encode64(content)}"
+      super(content, mime_type)
     end
   end
 end

data/lib/yoti/data_type/image_jpeg.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Yoti
   class ImageJpeg < Image
     def initialize(content)

data/lib/yoti/data_type/image_png.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Yoti
   class ImagePng < Image
     def initialize(content)

data/lib/yoti/data_type/media.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module Yoti
+  class Media
+    attr_reader :content
+    attr_reader :mime_type
+
+    def initialize(content, mime_type)
+      @content = content
+      @mime_type = mime_type
+    end
+
+    def base64_content
+      "data:#{mime_type};base64,#{Base64.strict_encode64(content)}"
+    end
+  end
+end

data/lib/yoti/doc_scan/client.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    class Client
+      class << self
+        #
+        # Creates a Doc Scan session using the supplied session specification
+        #
+        # @param [Yoti::DocScan::Session::Create::SessionSpecification] session_specification
+        #
+        # @return [Yoti::DocScan::Session::Create::CreateSessionResult]
+        #
+        def create_session(session_specification)
+          Validation.assert_is_a(
+            Yoti::DocScan::Session::Create::SessionSpecification,
+            session_specification,
+            'session_specification'
+          )
+
+          response = create_request
+                     .with_http_method('POST')
+                     .with_endpoint('sessions')
+                     .with_payload(session_specification)
+                     .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                     .build
+                     .execute
+
+          Yoti::DocScan::Session::Create::CreateSessionResult.new(JSON.parse(response.body))
+        end
+
+        #
+        # Retrieves the state of a previously created Yoti Doc Scan session
+        #
+        # @param [String] session_id
+        #
+        # @return [Yoti::DocScan::Session::Retrieve::GetSessionResult]
+        #
+        def get_session(session_id)
+          Validation.assert_is_a(String, session_id, 'session_id')
+
+          response = create_request
+                     .with_http_method('GET')
+                     .with_endpoint(session_path(session_id))
+                     .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                     .build
+                     .execute
+
+          Yoti::DocScan::Session::Retrieve::GetSessionResult.new(JSON.parse(response.body))
+        end
+
+        #
+        # Deletes a previously created Yoti Doc Scan session and all
+        # of its related resources
+        #
+        # @param [String] session_id
+        #
+        def delete_session(session_id)
+          Validation.assert_is_a(String, session_id, 'session_id')
+
+          create_request
+            .with_http_method('DELETE')
+            .with_endpoint(session_path(session_id))
+            .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+            .build
+            .execute
+        end
+
+        #
+        # Retrieves media related to a Yoti Doc Scan session based
+        # on the supplied media ID
+        #
+        # @param [String] session_id
+        # @param [String] media_id
+        #
+        # @return [Yoti::Media]
+        #
+        def get_media_content(session_id, media_id)
+          Validation.assert_is_a(String, session_id, 'session_id')
+          Validation.assert_is_a(String, media_id, 'media_id')
+
+          response = create_request
+                     .with_http_method('GET')
+                     .with_endpoint(media_path(session_id, media_id))
+                     .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                     .build
+                     .execute
+
+          Yoti::Media.new(
+            response.body,
+            response.get_fields('content-type')[0]
+          )
+        end
+
+        #
+        # Deletes media related to a Yoti Doc Scan session based
+        # on the supplied media ID
+        #
+        # @param [String] session_id
+        # @param [String] media_id
+        #
+        def delete_media_content(session_id, media_id)
+          Validation.assert_is_a(String, session_id, 'session_id')
+          Validation.assert_is_a(String, media_id, 'media_id')
+
+          create_request
+            .with_http_method('DELETE')
+            .with_endpoint(media_path(session_id, media_id))
+            .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+            .build
+            .execute
+        end
+
+        #
+        # Gets a list of supported documents.
+        #
+        # @return [Yoti::DocScan::Support::SupportedDocumentsResponse]
+        #
+        def supported_documents
+          response = create_request
+                     .with_http_method('GET')
+                     .with_endpoint('supported-documents')
+                     .build
+                     .execute
+
+          Yoti::DocScan::Support::SupportedDocumentsResponse.new(JSON.parse(response.body))
+        end
+
+        private
+
+        #
+        # @param [String] session_id
+        #
+        # @return [String]
+        #
+        def session_path(session_id)
+          "sessions/#{session_id}"
+        end
+
+        #
+        # @param [String] session_id
+        # @param [String] media_id
+        #
+        # @return [String]
+        #
+        def media_path(session_id, media_id)
+          "#{session_path(session_id)}/media/#{media_id}/content"
+        end
+
+        #
+        # Create a base Doc Scan request
+        #
+        # @return [Yoti::Request]
+        #
+        def create_request
+          Yoti::Request
+            .builder
+            .with_base_url(Yoti.configuration.doc_scan_api_endpoint)
+        end
+      end
+    end
+  end
+end