yoti 1.6.0 → 1.7.0

data/lib/yoti/http/signed_request.rb

@@ -3,6 +3,11 @@ require 'base64'
 module Yoti
   # Converts a basic Net::HTTP request into a Yoti Signed Request
   class SignedRequest
+    #
+    # @param [Net::HTTPRequest] unsigned_request
+    # @param [String] path
+    # @param [#to_json,String] payload
+    #
     def initialize(unsigned_request, path, payload = {})
       @http_req = unsigned_request
       @path = path
@@ -10,6 +15,9 @@ module Yoti
       @auth_key = Yoti::SSL.auth_key_from_pem
     end
 
+    #
+    # @return [Net::HTTPRequest]
+    #
     def sign
       @http_req['X-Yoti-Auth-Digest'] = message_signature
       @http_req['X-Yoti-SDK'] = Yoti.configuration.sdk_identifier
@@ -20,18 +28,19 @@ module Yoti
     private
 
     def message_signature
-      @message_signature ||= Yoti::SSL.get_secure_signature("#{http_method}&#{@path}#{payload_string}")
+      @message_signature ||= Yoti::SSL.get_secure_signature("#{http_method}&#{@path}#{base64_payload}")
     end
 
     def http_method
       @http_req.method
     end
 
-    # Create the base64 encoded request body
-    def payload_string
+    def base64_payload
       return '' unless @payload
 
-      '&' + Base64.strict_encode64(@payload.to_json)
+      payload_string = @payload.is_a?(String) ? @payload : @payload.to_json
+
+      '&' + Base64.strict_encode64(payload_string)
     end
   end
 end

data/lib/yoti/protobuf/main.rb

@@ -44,9 +44,9 @@ module Yoti
       end
 
       def extra_data(receipt)
-        return nil unless valid_receipt?(receipt)
+        return nil if receipt['extra_data_content'].nil? || receipt['extra_data_content'] == ''
 
-        decipher_profile(receipt['extra_data'], receipt['wrapped_receipt_key']) if receipt['extra_data']
+        decipher_extra_data(receipt['extra_data_content'], receipt['wrapped_receipt_key'])
       end
 
       def attribute_list(data)
@@ -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
@@ -111,11 +111,21 @@ module Yoti
       end
 
       def decipher_profile(profile_content, wrapped_key)
-        encrypted_data = decode_profile(profile_content)
-        unwrapped_key = Yoti::SSL.decrypt_token(wrapped_key)
-        decrypted_data = Yoti::SSL.decipher(unwrapped_key, encrypted_data.iv, encrypted_data.cipher_text)
+        decrypted_data = decipher_data(profile_content, wrapped_key)
         Protobuf.attribute_list(decrypted_data)
       end
+
+      def decipher_extra_data(extra_data_content, wrapped_key)
+        decrypted_data = decipher_data(extra_data_content, wrapped_key)
+        proto = Yoti::Protobuf::Sharepubapi::ExtraData.decode(decrypted_data)
+        Share::ExtraData.new(proto)
+      end
+
+      def decipher_data(encrypted_content, wrapped_key)
+        encrypted_data = decode_profile(encrypted_content)
+        unwrapped_key = Yoti::SSL.decrypt_token(wrapped_key)
+        Yoti::SSL.decipher(unwrapped_key, encrypted_data.iv, encrypted_data.cipher_text)
+      end
     end
   end
 end

data/lib/yoti/share/attribute_issuance_details.rb

@@ -28,7 +28,7 @@ module Yoti
       # @param [Yoti::Protobuf::Sharepubapi::ThirdPartyAttribute] data_entry
       #
       def initialize(data_entry)
-        @token = Base64.encode64(data_entry.issuance_token)
+        @token = Base64.strict_encode64(data_entry.issuance_token)
         begin
           @expiry_date = DateTime.parse(data_entry.issuing_attributes.expiry_date)
         rescue ArgumentError

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)
@@ -60,6 +60,7 @@ module Yoti
       end
 
       # Reset and reload the Private Key used for SSL functions
+      # @deprecated 2.0.0
       def reload!
         @private_key = nil
         @pem = nil

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.0'.freeze
+  VERSION = '1.7.0'.freeze
 end

data/rubocop.yml

@@ -4,6 +4,8 @@ AllCops:
   TargetRubyVersion: 2.4
   Exclude:
     - 'examples/rails/config/**/*'
+    - 'examples/doc_scan/config/**/*'
+    - 'examples/doc_scan/bin/**/*'
     - 'lib/yoti/protobuf/attrpubapi/*'
     - 'lib/yoti/protobuf/compubapi/*'
     - 'lib/yoti/protobuf/sharepubapi/*'
@@ -26,7 +28,7 @@ Metrics/ClassLength:
   Enabled: false
   Max: 115
 
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
 
 Metrics/MethodLength:
@@ -55,3 +57,9 @@ Naming/MethodName:
 Naming/PredicateName:
   Exclude:
     - lib/yoti/util/age_processor.rb
+
+Metrics/ParameterLists:
+  Exclude:
+    - lib/yoti/doc_scan/session/create/sdk_config.rb
+    - lib/yoti/doc_scan/session/create/session_specification.rb
+    - spec/yoti/doc_scan/client_spec.rb

data/yoti.gemspec

@@ -23,17 +23,14 @@ Gem::Specification.new do |spec|
 
   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 '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,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: yoti
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Sebastian Zaremba
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-15 00:00:00.000000000 Z
+date: 2020-06-12 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
@@ -31,9 +17,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,23 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.7.0
-- !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
@@ -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
@@ -208,6 +160,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE.md"
 - ".gitignore"
 - CONTRIBUTING.md
 - Gemfile
@@ -230,9 +183,53 @@ 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/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_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/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_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
@@ -261,18 +258,13 @@ files:
 - lib/yoti/protobuf/sharepubapi/ExtraData_pb.rb
 - lib/yoti/protobuf/sharepubapi/IssuingAttributes_pb.rb
 - lib/yoti/protobuf/sharepubapi/ThirdPartyAttribute_pb.rb
-- lib/yoti/sandbox.rb
-- lib/yoti/sandbox/anchor.rb
-- lib/yoti/sandbox/attribute.rb
-- lib/yoti/sandbox/profile.rb
-- lib/yoti/sandbox/sandbox.rb
-- lib/yoti/sandbox/sandbox_client.rb
 - lib/yoti/share/attribute_issuance_details.rb
 - lib/yoti/share/extra_data.rb
 - lib/yoti/ssl.rb
 - 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
@@ -297,8 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Yoti Ruby SDK for back-end integration.

data/lib/yoti/sandbox.rb

@@ -1,5 +0,0 @@
-require_relative 'sandbox/anchor'
-require_relative 'sandbox/attribute'
-require_relative 'sandbox/profile'
-require_relative 'sandbox/sandbox_client'
-require_relative 'sandbox/sandbox'

data/lib/yoti/sandbox/anchor.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module Sandbox
-  # Anchor describes an anchor on a Sandbox Attribute
-  class Anchor
-    attr_reader :type
-    attr_reader :value
-    attr_reader :sub_type
-    attr_reader :timestamp
-
-    def initialize(type:, value:, sub_type: '', timestamp: Time.now)
-      @type = type
-      @value = value
-      @sub_type = sub_type
-      @timestamp = timestamp
-    end
-
-    def as_json(*_args)
-      {
-        type: @type,
-        value: @value,
-        sub_type: @sub_type,
-        timestamp: @timestamp.to_i
-      }
-    end
-
-    def to_json(*args)
-      as_json.to_json(*args)
-    end
-
-    def self.source(value, sub_type: '', timestamp: Time.now)
-      Anchor.new(
-        type: 'SOURCE',
-        value: value,
-        sub_type: sub_type,
-        timestamp: timestamp
-      )
-    end
-
-    def self.verifier(value, sub_type: '', timestamp: Time.now)
-      Anchor.new(
-        type: 'VERIFIER',
-        value: value,
-        sub_type: sub_type,
-        timestamp: timestamp
-      )
-    end
-  end
-end