yoti 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e5b60947899ea06491577de1490e6d380779ee74a3fd31dea4a794cd23ab775
-  data.tar.gz: 9838261227d5aa667b9c91be67ad0002a87df137fdebd5505dcf2bcd5f912993
+  metadata.gz: e50de3d515cbe593c45eee88ea0d684d0a1eafa59d0df31e4f52977f802a0773
+  data.tar.gz: 7e3aad79f573318e00328341abb2e162b8d438c232b488eb6bade1ac8b38151a
 SHA512:
-  metadata.gz: f5ccf44832dda707634563ace8d07a19653c19588582b3936ae71fda45ae7a181739e6faf2df2e1cf1da17c9048afb4fa78fa1ff33c6bc1cff05a3a0e8621d9b
-  data.tar.gz: 1912aaf2ae74af86ce3457037b79f59683fcc1bf6b8707e97f024c2b4fdc8d7a1d0f7439d7fb72e917eca942d71adbf747fcc938cc56be13d509ad0eaf58ad08
+  metadata.gz: 2c229fc49f7ca7bb4b3868395dd3e01742b08b6371eab0e9c8f085ac23e2c653260b6e06e5f858a59e596e8cec4b2d541f008ea391a0bec9e8388cd29f4bca8f
+  data.tar.gz: df7636a39d76928759337e949384c9e118a299da275f06aa47918819aa9012795bd6a494056b7bb49825dc920677c3e8db9385d339557436c4361f242cd87b0c

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+
+git:
+  depth: 1
+
+before_install:
+  - gem install bundler
+
+install:
+  - bundle install
+
+script:
+  - bundle exec rake

data/Gemfile

@@ -5,5 +5,6 @@ gem 'guard-rspec'
 gem 'pry'
 gem 'pry-byebug'
 gem 'rubocop'
+gem 'rubocop-performance'
 
 gemspec

data/README.md

@@ -1,5 +1,7 @@
 # Yoti Ruby SDK
 
+[![Build Status](https://travis-ci.com/getyoti/yoti-ruby-sdk.svg?branch=master)](https://travis-ci.com/getyoti/yoti-ruby-sdk)
+
 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.
 
 ## Table of Contents
@@ -303,7 +305,8 @@ Visiting `https://localhost:4567/` should show a Yoti Connect button
 ## API Coverage
 
 * Activity Details
-  * [X] User ID `user_id`
+  * [X] Remember Me ID `remember_me_id`
+  * [X] Parent Remember Me ID `parent_remember_me_id`
   * [X] Base64 Selfie URI `base64_selfie_uri`
   * [X] Age verified `age_verified`
   * [X] Profile `profile`

data/lib/generators/yoti/install/install_generator.rb

@@ -1,7 +1,7 @@
 module Yoti
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path('./templates', __dir__)
 
       desc 'This generator creates an Yoti initializer file at config/initializers'
 

data/lib/yoti/activity_details.rb

@@ -6,9 +6,16 @@ module Yoti
     # @return [String] the outcome of the profile request, eg: SUCCESS
     attr_reader :outcome
 
+    # @deprecated replaced by :remember_me_id
     # @return [String] the Yoti ID
     attr_reader :user_id
 
+    # @return [String] the Remember Me ID
+    attr_reader :remember_me_id
+
+    # @return [String] the Parent Remember Me ID
+    attr_reader :parent_remember_me_id
+
     # @return [Hash] the decoded profile attributes
     attr_reader :user_profile
 
@@ -21,41 +28,58 @@ module Yoti
     # @param receipt [Hash] the receipt from the API request
     # @param decrypted_profile [Object] Protobuf AttributeList decrypted object containing the profile attributes
     def initialize(receipt, decrypted_profile = nil)
-      @decrypted_profile = decrypted_profile
+      @remember_me_id = receipt['remember_me_id']
+      @user_id = @remember_me_id
+      @parent_remember_me_id = receipt['parent_remember_me_id']
+      @outcome = receipt['sharing_outcome']
       @user_profile = {}
       @extended_profile = {}
+      process_decrypted_profile(decrypted_profile)
+    end
 
-      if @decrypted_profile.is_a?(Object) && @decrypted_profile.respond_to?(:attributes)
-        @decrypted_profile.attributes.each do |field|
-          @user_profile[field.name] = Yoti::Protobuf.value_based_on_content_type(field.value, field.content_type)
-          anchor_processor = Yoti::AnchorProcessor.new(field.anchors)
-          anchors_list = anchor_processor.process
+    # @return [Hash] a JSON of the address
+    def structured_postal_address
+      @user_profile['structured_postal_address']
+    end
 
-          if field.name == 'selfie'
-            @base64_selfie_uri = Yoti::Protobuf.image_uri_based_on_content_type(field.value, field.content_type)
-          end
+    # @return [Profile] of Yoti user
+    def profile
+      Yoti::Profile.new(@extended_profile)
+    end
 
+    protected
 
-          if Yoti::AgeProcessor.is_age_verification(field.name)
-            @age_verified = field.value == 'true'
-          end
+    def process_decrypted_profile(decrypted_profile)
+      return nil unless decrypted_profile.is_a?(Object)
+      return nil unless decrypted_profile.respond_to?(:attributes)
 
-          @extended_profile[field.name] = Yoti::Attribute.new(field.name, field.value, anchors_list['sources'], anchors_list['verifiers'])
+      decrypted_profile.attributes.each do |attribute|
+        begin
+          process_attribute(attribute)
+          process_age_verified(attribute)
+        rescue StandardError => e
+          Yoti::Log.logger.warn("#{e.message} (Attribute: #{attribute.name})")
         end
       end
-
-      @user_id = receipt['remember_me_id']
-      @outcome = receipt['sharing_outcome']
     end
 
-    # @return [Hash] a JSON of the address
-    def structured_postal_address
-        @user_profile['structured_postal_address']
+    def process_attribute(attribute)
+      attr_value = Yoti::Protobuf.value_based_on_content_type(attribute.value, attribute.content_type)
+      attr_value = Yoti::Protobuf.value_based_on_attribute_name(attr_value, attribute.name)
+
+      # Handle selfies for backwards compatibility.
+      if attribute.name == Yoti::Attribute::SELFIE && attr_value.is_a?(Yoti::Image)
+        @base64_selfie_uri = attr_value.base64_content
+        attr_value = attr_value.content
+      end
+
+      anchors_list = Yoti::AnchorProcessor.new(attribute.anchors).process
+      @extended_profile[attribute.name] = Yoti::Attribute.new(attribute.name, attr_value, anchors_list['sources'], anchors_list['verifiers'])
+      @user_profile[attribute.name] = attr_value
     end
 
-    # @return [Profile] of Yoti user
-    def profile
-        return Yoti::Profile.new(@extended_profile)
+    def process_age_verified(attribute)
+      @age_verified = attribute.value == 'true' if Yoti::AgeProcessor.is_age_verification(attribute.name)
     end
   end
 end

data/lib/yoti/data_type/anchor.rb

@@ -4,10 +4,10 @@ module Yoti
     attr_reader :value, :sub_type, :signed_time_stamp, :origin_server_certs
 
     def initialize(value, sub_type, signed_time_stamp, origin_server_certs)
-        @value = value
-        @sub_type = sub_type
-        @signed_time_stamp = signed_time_stamp
-        @origin_server_certs = origin_server_certs
+      @value = value
+      @sub_type = sub_type
+      @signed_time_stamp = signed_time_stamp
+      @origin_server_certs = origin_server_certs
     end
   end
-end
+end

data/lib/yoti/data_type/attribute.rb

@@ -1,25 +1,26 @@
 module Yoti
   # Encapsulates profile attribute
   class Attribute
-    FAMILY_NAME = 'family_name';
-    GIVEN_NAMES = 'given_names';
-    FULL_NAME = 'full_name';
-    DATE_OF_BIRTH = 'date_of_birth';
-    GENDER = 'gender';
-    NATIONALITY = 'nationality';
-    PHONE_NUMBER = 'phone_number';
-    SELFIE = 'selfie';
-    EMAIL_ADDRESS = 'email_address';
-    POSTAL_ADDRESS = 'postal_address';
-    STRUCTURED_POSTAL_ADDRESS = 'structured_postal_address';
+    FAMILY_NAME = 'family_name'
+    GIVEN_NAMES = 'given_names'
+    FULL_NAME = 'full_name'
+    DATE_OF_BIRTH = 'date_of_birth'
+    GENDER = 'gender'
+    NATIONALITY = 'nationality'
+    PHONE_NUMBER = 'phone_number'
+    SELFIE = 'selfie'
+    EMAIL_ADDRESS = 'email_address'
+    POSTAL_ADDRESS = 'postal_address'
+    STRUCTURED_POSTAL_ADDRESS = 'structured_postal_address'
+    DOCUMENT_IMAGES = 'document_images'
 
     attr_reader :name, :value, :sources, :verifiers
 
     def initialize(name, value, sources, verifiers)
-        @name = name
-        @value = value
-        @sources = sources
-        @verifiers = verifiers
+      @name = name
+      @value = value
+      @sources = sources
+      @verifiers = verifiers
     end
   end
 end

data/lib/yoti/data_type/image.rb

@@ -0,0 +1,19 @@
+require 'base64'
+
+module Yoti
+  class Image
+    attr_reader :content
+    attr_reader :mime_type
+
+    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
+
+    def base64_content
+      "data:#{mime_type};base64,#{Base64.strict_encode64(content)}"
+    end
+  end
+end

data/lib/yoti/data_type/image_jpeg.rb

@@ -0,0 +1,7 @@
+module Yoti
+  class ImageJpeg < Image
+    def initialize(content)
+      super(content, 'image/jpeg')
+    end
+  end
+end

data/lib/yoti/data_type/image_png.rb

@@ -0,0 +1,7 @@
+module Yoti
+  class ImagePng < Image
+    def initialize(content)
+      super(content, 'image/png')
+    end
+  end
+end

data/lib/yoti/data_type/multi_value.rb

@@ -0,0 +1,48 @@
+module Yoti
+  class MultiValue
+    def initialize(items)
+      raise(TypeError, "Arrays must be passed to #{self.class.name}") unless items.is_a?(Array)
+
+      @original_items = items
+      @items = items.dup
+      @filters = []
+    end
+
+    def allow_type(type)
+      filter { |value| value.is_a?(type) }
+      self
+    end
+
+    def filter(&callback)
+      @filters.push(callback)
+      apply_filters
+      self
+    end
+
+    def items
+      apply_filters
+      @items.clone.freeze
+    end
+
+    private
+
+    def apply_filters
+      @items = @original_items.dup
+
+      if @filters.count.positive?
+        @items.keep_if do |item|
+          match = @filters.select { |callback| callback.call(item) }
+          match.count.positive?
+        end
+      end
+
+      @items.each do |item|
+        next unless item.is_a?(MultiValue)
+
+        @filters.each do |callback|
+          item.filter { |value| callback.call(value) }
+        end
+      end
+    end
+  end
+end

data/lib/yoti/data_type/profile.rb

@@ -1,77 +1,81 @@
 module Yoti
   # Encapsulates Yoti user profile
   class Profile
-
     def initialize(profile_data)
-        if !profile_data.is_a? Object
-            profile_data = Hash.new
-        end
-        @profile_data = profile_data
+      profile_data = {} unless profile_data.is_a? Object
+      @profile_data = profile_data
     end
 
     def selfie
-        return get_attribute(Yoti::Attribute::SELFIE)
+      get_attribute(Yoti::Attribute::SELFIE)
     end
 
     def family_name
-        return get_attribute(Yoti::Attribute::FAMILY_NAME)
+      get_attribute(Yoti::Attribute::FAMILY_NAME)
     end
 
     def given_names
-        return get_attribute(Yoti::Attribute::GIVEN_NAMES)
+      get_attribute(Yoti::Attribute::GIVEN_NAMES)
     end
 
     def full_name
-        return get_attribute(Yoti::Attribute::FULL_NAME)
+      get_attribute(Yoti::Attribute::FULL_NAME)
     end
 
     def phone_number
-        return get_attribute(Yoti::Attribute::PHONE_NUMBER)
+      get_attribute(Yoti::Attribute::PHONE_NUMBER)
     end
 
     def email_address
-        return get_attribute(Yoti::Attribute::EMAIL_ADDRESS)
+      get_attribute(Yoti::Attribute::EMAIL_ADDRESS)
     end
 
     def date_of_birth
-        return get_attribute(Yoti::Attribute::DATE_OF_BIRTH)
+      get_attribute(Yoti::Attribute::DATE_OF_BIRTH)
     end
 
     def gender
-        return get_attribute(Yoti::Attribute::GENDER)
+      get_attribute(Yoti::Attribute::GENDER)
     end
 
     def nationality
-        return get_attribute(Yoti::Attribute::NATIONALITY)
+      get_attribute(Yoti::Attribute::NATIONALITY)
+    end
+
+    def document_images
+      get_attribute(Yoti::Attribute::DOCUMENT_IMAGES)
     end
 
     def postal_address
-        postal_address = get_attribute(Yoti::Attribute::POSTAL_ADDRESS)
+      postal_address = get_attribute(Yoti::Attribute::POSTAL_ADDRESS)
+      return postal_address unless postal_address.nil?
 
-        return postal_address unless postal_address.nil?
-        return get_formatted_address
+      attribute_from_formatted_address
     end
 
     def structured_postal_address
-        return get_attribute(Yoti::Attribute::STRUCTURED_POSTAL_ADDRESS)
+      get_attribute(Yoti::Attribute::STRUCTURED_POSTAL_ADDRESS)
     end
 
     # @return attribute value by name
     def get_attribute(attr_name)
-        if @profile_data.has_key? attr_name then
-            return @profile_data[attr_name]
-        end
-        return nil
+      return nil unless @profile_data.key? attr_name
+
+      @profile_data[attr_name]
     end
 
     protected
 
-        def get_formatted_address
-            full_address = structured_postal_address
-            if !full_address.nil? && full_address.has_key?('formatted_address')
-                return full_address['formatted_address']
-            end
-            return nil
-        end
+    def attribute_from_formatted_address
+      return nil if structured_postal_address.nil?
+      return nil unless structured_postal_address.value.key?('formatted_address')
+
+      Yoti::Attribute.new(
+        Yoti::Attribute::POSTAL_ADDRESS,
+        structured_postal_address.value['formatted_address'],
+        structured_postal_address.sources,
+        structured_postal_address.verifiers
+      )
+    end
   end
-end
+end

data/lib/yoti/data_type/signed_time_stamp.rb

@@ -1,11 +1,11 @@
 module Yoti
-    # Encapsulates anchor signed time stamp
-    class SignedTimeStamp
-        attr_reader :version, :time_stamp
+  # Encapsulates anchor signed time stamp
+  class SignedTimeStamp
+    attr_reader :version, :time_stamp
 
-        def initialize(version, time_stamp)
-            @version = version
-            @time_stamp = time_stamp
-        end
+    def initialize(version, time_stamp)
+      @version = version
+      @time_stamp = time_stamp
     end
+  end
 end

data/lib/yoti/http/request.rb

@@ -26,6 +26,7 @@ module Yoti
       end
 
       raise RequestError, "Unsuccessful Yoti API call: #{res.message}" unless res.code == '200'
+
       res.body
     end
 
@@ -71,6 +72,7 @@ module Yoti
 
     def token
       return '' unless @encrypted_connect_token
+
       Yoti::SSL.decrypt_token(@encrypted_connect_token)
     end
 

data/lib/yoti/protobuf/attrpubapi/Attribute_pb.rb

@@ -0,0 +1,40 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: Attribute.proto
+
+require 'google/protobuf'
+
+require 'ContentType_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "attrpubapi_v1.Attribute" do
+    optional :name, :string, 1
+    optional :value, :bytes, 2
+    optional :content_type, :enum, 3, "attrpubapi_v1.ContentType"
+    repeated :anchors, :message, 4, "attrpubapi_v1.Anchor"
+  end
+  add_message "attrpubapi_v1.Anchor" do
+    optional :artifact_link, :bytes, 1
+    repeated :origin_server_certs, :bytes, 2
+    optional :artifact_signature, :bytes, 3
+    optional :sub_type, :string, 4
+    optional :signature, :bytes, 5
+    optional :signed_time_stamp, :bytes, 6
+  end
+  add_message "attrpubapi_v1.MultiValue" do
+    repeated :values, :message, 1, "attrpubapi_v1.MultiValue.Value"
+  end
+  add_message "attrpubapi_v1.MultiValue.Value" do
+    optional :content_type, :enum, 1, "attrpubapi_v1.ContentType"
+    optional :data, :bytes, 2
+  end
+end
+
+module Yoti
+  module Protobuf
+    module Attrpubapi
+      Attribute = Google::Protobuf::DescriptorPool.generated_pool.lookup("attrpubapi_v1.Attribute").msgclass
+      Anchor = Google::Protobuf::DescriptorPool.generated_pool.lookup("attrpubapi_v1.Anchor").msgclass
+      MultiValue = Google::Protobuf::DescriptorPool.generated_pool.lookup("attrpubapi_v1.MultiValue").msgclass
+      MultiValue::Value = Google::Protobuf::DescriptorPool.generated_pool.lookup("attrpubapi_v1.MultiValue.Value").msgclass
+    end
+  end
+end

data/lib/yoti/protobuf/attrpubapi/ContentType_pb.rb

@@ -0,0 +1,25 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: ContentType.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_enum "attrpubapi_v1.ContentType" do
+    value :UNDEFINED, 0
+    value :STRING, 1
+    value :JPEG, 2
+    value :DATE, 3
+    value :PNG, 4
+    value :JSON, 5
+    value :MULTI_VALUE, 6
+    value :INT, 7
+  end
+end
+
+module Yoti
+  module Protobuf
+    module Attrpubapi
+      ContentType = Google::Protobuf::DescriptorPool.generated_pool.lookup("attrpubapi_v1.ContentType").enummodule
+    end
+  end
+end

data/lib/yoti/protobuf/attrpubapi/List_pb.rb

@@ -0,0 +1,28 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: List.proto
+
+require 'google/protobuf'
+
+require 'Attribute_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "attrpubapi_v1.AttributeAndId" do
+    optional :attribute, :message, 1, "attrpubapi_v1.Attribute"
+    optional :attribute_id, :bytes, 2
+  end
+  add_message "attrpubapi_v1.AttributeAndIdList" do
+    repeated :attribute_and_id_list, :message, 1, "attrpubapi_v1.AttributeAndId"
+  end
+  add_message "attrpubapi_v1.AttributeList" do
+    repeated :attributes, :message, 1, "attrpubapi_v1.Attribute"
+  end
+end
+
+module Yoti
+  module Protobuf
+    module Attrpubapi
+      AttributeAndId = Google::Protobuf::DescriptorPool.generated_pool.lookup("attrpubapi_v1.AttributeAndId").msgclass
+      AttributeAndIdList = Google::Protobuf::DescriptorPool.generated_pool.lookup("attrpubapi_v1.AttributeAndIdList").msgclass
+      AttributeList = Google::Protobuf::DescriptorPool.generated_pool.lookup("attrpubapi_v1.AttributeList").msgclass
+    end
+  end
+end

data/lib/yoti/protobuf/{v3/attrpubapi/signing_pb.rb → attrpubapi/Signing_pb.rb}

@@ -1,14 +1,14 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: signing.proto
+# source: Signing.proto
 
 require 'google/protobuf'
 
-require_relative 'attribute_pb'
+require 'ContentType_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_message "Yoti.Protobuf.attrpubapi_v3.AttributeSigning" do
+  add_message "attrpubapi_v1.AttributeSigning" do
     optional :name, :string, 1
     optional :value, :bytes, 2
-    optional :content_type, :enum, 3, "Yoti.Protobuf.attrpubapi_v3.ContentType"
+    optional :content_type, :enum, 3, "attrpubapi_v1.ContentType"
     optional :artifact_signature, :bytes, 4
     optional :sub_type, :string, 5
     optional :signed_time_stamp, :bytes, 6
@@ -17,8 +17,8 @@ end
 
 module Yoti
   module Protobuf
-    module AttrpubapiV3
-      AttributeSigning = Google::Protobuf::DescriptorPool.generated_pool.lookup("Yoti.Protobuf.attrpubapi_v3.AttributeSigning").msgclass
+    module Attrpubapi
+      AttributeSigning = Google::Protobuf::DescriptorPool.generated_pool.lookup("attrpubapi_v1.AttributeSigning").msgclass
     end
   end
 end

data/lib/yoti/protobuf/{v3/compubapi/encrypted_data_pb.rb → compubapi/EncryptedData_pb.rb}

@@ -1,10 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: encrypted_data.proto
+# source: EncryptedData.proto
 
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_message "Yoti.Protobuf.compubapi_v3.EncryptedData" do
+  add_message "compubapi_v1.EncryptedData" do
     optional :iv, :bytes, 1
     optional :cipher_text, :bytes, 2
   end
@@ -12,8 +12,8 @@ end
 
 module Yoti
   module Protobuf
-    module CompubapiV3
-      EncryptedData = Google::Protobuf::DescriptorPool.generated_pool.lookup("Yoti.Protobuf.compubapi_v3.EncryptedData").msgclass
+    module Compubapi
+      EncryptedData = Google::Protobuf::DescriptorPool.generated_pool.lookup("compubapi_v1.EncryptedData").msgclass
     end
   end
 end

data/lib/yoti/protobuf/{v3/compubapi/signed_time_stamp_pb.rb → compubapi/SignedTimestamp_pb.rb}

@@ -1,10 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: signed_time_stamp.proto
+# source: SignedTimestamp.proto
 
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_message "Yoti.Protobuf.compubapi_v3.SignedTimestamp" do
+  add_message "compubapi_v1.SignedTimestamp" do
     optional :version, :int32, 1
     optional :timestamp, :uint64, 2
     optional :message_digest, :bytes, 3
@@ -16,8 +16,8 @@ end
 
 module Yoti
   module Protobuf
-    module CompubapiV3
-      SignedTimestamp = Google::Protobuf::DescriptorPool.generated_pool.lookup("Yoti.Protobuf.compubapi_v3.SignedTimestamp").msgclass
+    module Compubapi
+      SignedTimestamp = Google::Protobuf::DescriptorPool.generated_pool.lookup("compubapi_v1.SignedTimestamp").msgclass
     end
   end
 end