yoti 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d5dc8fd313619013f57321a1985b0d2607f3bbc5
-  data.tar.gz: 3e98fe0494e17a488e856d1bfc2b93e0c3d607a1
+SHA256:
+  metadata.gz: 0d128d9ffcee98658286382a901ee16fe544be243b1e7907acf2bc439238881b
+  data.tar.gz: 476f3130e46d8aa61084b838bafc112d8986ff65b35e9cc9cacef1321355ffdc
 SHA512:
-  metadata.gz: 133fc1ba66c1efd09208b923e3bda7c84976bd80c14ce0c5e355ed054c642cf73283f748095dfbde5c01e109e1510f980fece42220db44fcb9cd7ae2d4c92007
-  data.tar.gz: 843e8284b64707b094392bc88ddb3ad67548ef86df2837e32990e2d0bb8e12c79bc271624bb9c84d9f0ff879b0602f6af49629436b1975b92414139484dd6ebe
+  metadata.gz: b896c3b2e481570dc3eef74ccf2fe22b24aab97e36f7b4f1896d8336227f4ca6b248e3dc6577dda89870415128a69fed32dc83a770857b3d0c93e48ead3dd138
+  data.tar.gz: 1d67d39257f8c6752ee3d8c957293e082a2d2b9d57b343ef93c863b38767e412a82ebbbb3f777a6d13367aeb7d019c960ff1ee277c04d6d6b838eb3872e5ebd1

data/CONTRIBUTING.md

@@ -99,7 +99,6 @@ Commit messages should ideally start with one of the following verbs:
 
 ## Publishing a new release
 
-* Update the [changelog](CHANGELOG.md) and the [lib/yoti/version.rb](lib/yoti/version.rb) file
 * 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)
 

data/README.md

@@ -8,7 +8,7 @@ Welcome to the Yoti Ruby SDK. This repository contains the tools you need to qui
 1. [Requirements](#requirements) - Everything you need to get started
 1. [Installing the SDK](#installing-the-sdk) - How to install our SDK
 1. [Configuration](#configuration) - Configuring the SDK
-1. [Profile Retrieval](#profile-retrieval) - How to retrieve a Yoti profile using the token
+1. [Profile Retrieval](#profile-retrieval) - How to retrieve a Yoti profile using the one time use token
 1. [AML Integration](#aml-integration) - How to integrate with Yoti's AML (Anti Money Laundering) service
 1. [Running the Examples](#running-the-examples) - How to run the example projects provided
 1. [API Coverage](#api-coverage) - Attributes defined
@@ -17,7 +17,7 @@ Welcome to the Yoti Ruby SDK. This repository contains the tools you need to qui
 ## An Architectural view
 
 To integrate your application with Yoti, your back-end must expose a GET endpoint that Yoti will use to forward tokens.
-The endpoint can be configured in your Yoti Dashboard when you create/update your application. It can be found in the Integration section under the Callback URL name.
+The endpoint is configured in the [Yoti Dashboard](https://www.yoti.com/dashboard) where you create/update your application. To see an example of how this is configured, see the [Running the Examples](#running-the-examples) section.
 
 The image below shows how your application back-end and Yoti integrate into the context of a Login flow.
 Yoti SDK carries out for you steps 6, 7, 8 and the profile decryption in step 9.
@@ -40,7 +40,7 @@ Yoti also allows you to enable user details verification from your mobile app by
 
 ## Requirements
 
-The Yoti gem requires at least Ruby 2.0.0.
+The Yoti gem requires at least Ruby `2.4.0`.
 If you're using a version of Ruby lower than 2.2.2 you might encounter issues when [Bundler][] tries to install the [Active Support][] gem. This can be avoided by manually requiring activesupport 4.2.
 
 ```ruby
@@ -140,23 +140,26 @@ heroku config:add YOTI_KEY ="$(cat your-access-security.pem)"
 
 ## Profile Retrieval
 
-When your application receives a token via the exposed endpoint (it will be assigned to a query string parameter named `token`), you can easily retrieve the user profile:
+When your application receives a one time use token via the exposed endpoint (it will be assigned to a query string parameter named `token`), you can easily retrieve the user profile:
 
 ```ruby
-yoti_activity_details = Yoti::Client.get_activity_details(params[:token])
+one_time_use_token = params[:token]
+yoti_activity_details = Yoti::Client.get_activity_details(one_time_use_token)
 ```
 
 Before you inspect the user profile, you might want to check whether the user validation was successful. This is done as follows:
 
 ```ruby
 if yoti_activity_details.outcome == 'SUCCESS'
-  user_profile = yoti_activity_details.user_profile
+  profile = yoti_activity_details.profile
+  given_names = profile.given_names.value
+  family_name = profile.family_name.value
 else
   # handle unhappy path
 end
 ```
 
-The `user_profile` object provides a set of attributes corresponding to user attributes. Whether the attributes are present or not depends on the settings you have applied to your app on Yoti Dashboard.
+The `profile` object provides a set of attributes corresponding to user attributes. Whether the attributes are present or not depends on the settings you have applied to your app on Yoti Dashboard.
 
 ### Handling Users
 
@@ -168,11 +171,16 @@ Here is an example of how this works:
 ```ruby
 if yoti_activity_details.outcome == 'SUCCESS'
   user = your_user_search_function(yoti_activity_details.user_id)
+  profile = yoti_activity_details.profile
 
   if user
     # handle login
+    email = profile.email_address.value
   else
     # handle registration
+    given_names = profile.given_names.value
+    family_name = profile.family_name.value
+    email = profile.email_address.value
   end
 else
   # handle unhappy path
@@ -181,6 +189,30 @@ end
 
 Where `your_user_search_function` is a piece of logic in your app that is supposed to find a user, given a user_id. Regardless of whether the user is a new or an existing one, Yoti will always provide their profile, so you don't necessarily need to store it.
 
+You can retrieve the sources and verifiers for each attribute as follows:
+
+```ruby
+given_names_sources = profile.given_names.sources // list of anchors
+given_names_verifiers = profile.given_names.verifiers // list of anchors
+```
+You can also retrieve further properties from these respective anchors in the following way:
+
+```ruby
+// Retrieving properties of the first anchor
+value = given_names_sources[0].value // string
+sub_type = given_names_sources[0].sub_type // string
+time_stamp = given_names_sources[0].signed_time_stamp.time_stamp // DateTime object
+origin_server_certs = given_names_sources[0].origin_server_certs // list of X509 certificates
+```
+
+In case you want to prove the sources and verifiers of the helper`ActivityDetails.age_verified` on `Age Over 18` set as age derivation, please retrieve it's original attribute from the profile as follow:
+
+```ruby
+age_attribute = profile.get_attribute('age_over:18')
+sources = age_attribute.sources
+verifiers = age_attribute.verifiers
+```
+
 ## AML Integration
 
 Yoti provides an AML (Anti Money Laundering) check service to allow a deeper KYC process to prevent fraud. This is a chargeable service, so please contact [sdksupport@yoti.com](mailto:sdksupport@yoti.com) for more information.
@@ -191,7 +223,7 @@ Yoti will provide a boolean result on the following checks:
 * Fraud list - Verify against  US Social Security Administration Fraud (SSN Fraud) list
 * Watch list - Verify against watch lists from the Office of Foreign Assets Control
 
-To use this functionality you must ensure your application is assigned to your organisation in the Yoti Dashboard - please see here for further information.
+To use this functionality you must ensure your application is assigned to your organisation in the Yoti Dashboard - please see [here](https://www.yoti.com/developers/documentation/#1-creating-an-organisation) for further information.
 
 For the AML check you will need to provide the following:
 
@@ -228,26 +260,31 @@ puts Yoti::Client.aml_check(aml_profile)
 
 ## Running the Examples
 
-The examples can be found in the [examples folder](examples).
-For them to work you will need a working callback URL that your browser can redirect to. The callback URL for both examples will be: `http://your-local-url.domain/profile`.
-
-The examples also use the `YOTI_APPLICATION_ID` environment variable to display the Yoti Connect button. This value can be found in your Yoti account, on the *Keys* settings page.
+The examples can be found in the [examples folder](examples). 
 
 ### Ruby on Rails
 
-* rename the [.env.example](examples/rails/.env.example) file to `.env` and fill in the required configuration values
-* install the dependencies with `bundle install`
-* start the server `rails server`
+1. Create your application in the [Yoti Dashboard](https://www.yoti.com/dashboard/applications)
+1. Set the application domain of your app to `localhost:3000`
+1. Set the scenario callback URL to `/profile`
+1. Rename the [.env.example](examples/rails/.env.example) file to `.env` 
+1. Fill in the environment variables in this file with the ones specific to your application (mentioned in the [Configuration](#configuration) section)
+1. Install the dependencies with `bundle install`
+1. Start the server `rails server`
 
-Visiting the `http://your-local-url.domain` should show a Yoti Connect button
+Visiting `http://localhost:3000/` should show a Yoti Connect button
 
 ### Sinatra
 
-* rename the [.env.example](examples/sinatra/.env.example) file to `.env` and fill in the required configuration values
-* install the dependencies with `bundle install`
-* start the server `ruby ./app.rb`
+1. Create your application in the [Yoti Dashboard](https://www.yoti.com/dashboard/applications)
+1. Set the application domain of your app to `localhost:4567`
+1. Set the scenario callback URL to `/profile`
+1. Rename the [.env.example](examples/sinatra/.env.example) file to `.env`
+1. Fill in the environment variables in this file with the ones specific to your application (mentioned in the [Configuration](#configuration) section)
+1. Install the dependencies with `bundle install`
+1. Start the server `ruby ./app.rb`
 
-Visiting the `http://your-local-url.domain` should show a Yoti Connect button
+Visiting `http://localhost:4567/` should show a Yoti Connect button
 
 ### AML Check
 
@@ -259,7 +296,9 @@ Visiting the `http://your-local-url.domain` should show a Yoti Connect button
 
 * Activity Details
   * [X] User ID `user_id`
-  * [X] Profile
+  * [X] Base64 Selfie URI `base64_selfie_uri`
+  * [X] Age verified `age_verified`
+  * [X] Profile `profile`
     * [X] Selfie `selfie`
     * [X] Full Name `full_name`
     * [X] Given Names `given_names`
@@ -267,12 +306,9 @@ Visiting the `http://your-local-url.domain` should show a Yoti Connect button
     * [X] Mobile Number `phone_number`
     * [X] Email Address `email_address`
     * [X] Age / Date of Birth `date_of_birth`
-    * [X] Age / Verify Condition `age_[over|under]:[1-999]`
     * [X] Address `postal_address`
     * [X] Gender `gender`
     * [X] Nationality `nationality`
-  * [X] Base64 Selfie URI `base64_selfie_uri`
-  * [X] Age verified `age_verified`
 
 ## Support
 

data/lib/yoti.rb

@@ -11,9 +11,18 @@ require_relative 'yoti/http/signed_request'
 require_relative 'yoti/http/profile_request'
 require_relative 'yoti/http/request'
 
+require_relative 'yoti/data_type/anchor'
+require_relative 'yoti/data_type/profile'
+require_relative 'yoti/data_type/attribute'
+require_relative 'yoti/data_type/signed_time_stamp'
+
+require_relative 'yoti/util/age_processor'
+require_relative 'yoti/util/anchor_processor'
+
 require_relative 'yoti/activity_details'
 require_relative 'yoti/client'
-require_relative 'yoti/protobuf/v1/protobuf'
+
+require_relative 'yoti/protobuf/main'
 
 # The main module namespace of the Yoti gem
 module Yoti

data/lib/yoti/activity_details.rb

@@ -23,24 +23,39 @@ module Yoti
     def initialize(receipt, decrypted_profile = nil)
       @decrypted_profile = decrypted_profile
       @user_profile = {}
+      @extended_profile = {}
 
-      if !@decrypted_profile.nil? && @decrypted_profile.respond_to_has_and_present?(:attributes)
+      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
 
           if field.name == 'selfie'
             @base64_selfie_uri = Yoti::Protobuf.image_uri_based_on_content_type(field.value, field.content_type)
           end
 
-          # check if the key matches the format age_[over|under]:[1-999]
-          if /age_(over|under):[1-9][0-9]?[0-9]?/.match?(field.name)
+
+          if Yoti::AgeProcessor.is_age_verification(field.name)
             @age_verified = field.value == 'true'
           end
+
+          @extended_profile[field.name] = Yoti::Attribute.new(field.name, field.value, anchors_list['sources'], anchors_list['verifiers'])
         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']
+    end
+
+    # @return [Profile] of Yoti user
+    def profile
+        return Yoti::Profile.new(@extended_profile)
+    end
   end
 end

data/lib/yoti/data_type/anchor.rb

@@ -0,0 +1,13 @@
+module Yoti
+  # Encapsulates attribute anchor
+  class Anchor
+    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
+    end
+  end
+end

data/lib/yoti/data_type/attribute.rb

@@ -0,0 +1,25 @@
+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';
+
+    attr_reader :name, :value, :sources, :verifiers
+
+    def initialize(name, value, sources, verifiers)
+        @name = name
+        @value = value
+        @sources = sources
+        @verifiers = verifiers
+    end
+  end
+end

data/lib/yoti/data_type/profile.rb

@@ -0,0 +1,77 @@
+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
+    end
+
+    def selfie
+        return get_attribute(Yoti::Attribute::SELFIE)
+    end
+
+    def family_name
+        return get_attribute(Yoti::Attribute::FAMILY_NAME)
+    end
+
+    def given_names
+        return get_attribute(Yoti::Attribute::GIVEN_NAMES)
+    end
+
+    def full_name
+        return get_attribute(Yoti::Attribute::FULL_NAME)
+    end
+
+    def phone_number
+        return get_attribute(Yoti::Attribute::PHONE_NUMBER)
+    end
+
+    def email_address
+        return get_attribute(Yoti::Attribute::EMAIL_ADDRESS)
+    end
+
+    def date_of_birth
+        return get_attribute(Yoti::Attribute::DATE_OF_BIRTH)
+    end
+
+    def gender
+        return get_attribute(Yoti::Attribute::GENDER)
+    end
+
+    def nationality
+        return get_attribute(Yoti::Attribute::NATIONALITY)
+    end
+
+    def postal_address
+        postal_address = get_attribute(Yoti::Attribute::POSTAL_ADDRESS)
+
+        return postal_address unless postal_address.nil?
+        return get_formatted_address
+    end
+
+    def structured_postal_address
+        return 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
+    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
+  end
+end

data/lib/yoti/data_type/signed_time_stamp.rb

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

data/lib/yoti/errors.rb

@@ -13,4 +13,7 @@ module Yoti
 
   # Raises exceptions related to AML actions
   class AmlError < StandardError; end
+
+  # Raises exceptions related to Profile actions
+  class ProfileError < StandardError; end
 end

data/lib/yoti/protobuf/{v1/definitions/attribute-public-api/attrpubapi_v1 → definitions/attrpubapi}/attribute.proto

@@ -1,8 +1,8 @@
-//syntax = "proto2";
+syntax = "proto3";
 
-package attrpubapi_v1;
+package Yoti.Protobuf.attrpubapi_v3;
 
-option java_package = "com.yoti.attrpubapi_v1";
+option java_package = "com.yoti.attrpubapi_v3";
 option java_outer_classname = "AttrProto";
 
 
@@ -27,26 +27,26 @@ enum ContentType {
 
 
 message Attribute {
-	optional string name = 1;
+	string name = 1;
 
-	optional bytes value = 2;
+	bytes value = 2;
 
-	optional ContentType content_type = 3;
+	ContentType content_type = 3;
 
 	repeated Anchor anchors = 4;
 }
 
 
 message Anchor {
-	optional bytes artifact_link = 1;
+	bytes artifact_link = 1;
 
 	repeated bytes origin_server_certs = 2;
 
-	optional bytes artifact_signature = 3;
+	bytes artifact_signature = 3;
 
-	optional string sub_type = 4;
+	string sub_type = 4;
 
-	optional bytes signature = 5;
+	bytes signature = 5;
 
-	optional bytes signed_time_stamp = 6;
+	bytes signed_time_stamp = 6;
 }

data/lib/yoti/protobuf/{v1/definitions/attribute-public-api/attrpubapi_v1 → definitions/attrpubapi}/list.proto

@@ -1,23 +1,23 @@
-//syntax = "proto2";
+syntax = "proto3";
 
-package attrpubapi_v1;
+package Yoti.Protobuf.attrpubapi_v3;
 
 import "Attribute.proto";
 
-option java_package = "com.yoti.attrpubapi_v1";
+option java_package = "com.yoti.attrpubapi_v3";
 option java_outer_classname = "AttrProto";
 
 
 // AttributeAndId is a simple container for holding an attribute's value
 // alongside its ID.
 message AttributeAndId {
-	optional Attribute attribute = 1;
+	Attribute attribute = 1;
 
-	optional bytes attribute_id = 2;
+	bytes attribute_id = 2;
 }
 
 
-message AttributeAndIdList{
+message AttributeAndIdList {
     repeated AttributeAndId attribute_and_id_list = 1;
 }
 

data/lib/yoti/protobuf/definitions/attrpubapi/signing.proto

@@ -0,0 +1,23 @@
+syntax = "proto3";
+
+package Yoti.Protobuf.attrpubapi_v3;
+
+import "Attribute.proto";
+
+option java_package = "com.yoti.attrpubapi_v3";
+option java_outer_classname = "AttrProto";
+
+
+message AttributeSigning {
+	string name = 1;
+
+	bytes value = 2;
+
+	ContentType content_type = 3;
+
+	bytes artifact_signature = 4;
+
+	string sub_type = 5;
+
+	bytes signed_time_stamp = 6;
+}

data/lib/yoti/protobuf/{v1/definitions/common-public-api/compubapi_v1 → definitions/compubapi}/encrypted_data.proto

@@ -1,15 +1,15 @@
-// syntax = "proto2";
+syntax = "proto3";
 
-package compubapi_v1;
+package Yoti.Protobuf.compubapi_v3;
 
-option java_package = "com.yoti.compubapi_v1";
+option java_package = "com.yoti.compubapi_v3";
 option java_outer_classname = "EncryptedDataProto";
 
 message EncryptedData {
     // the iv will be used in conjunction with the secret key
     // received via other channel in order to decrypt the cipher_text
-    optional bytes iv = 1;
+    bytes iv = 1;
 
     // block of bytes to be decrypted
-    optional bytes cipher_text = 2;
+    bytes cipher_text = 2;
 }

data/lib/yoti/protobuf/definitions/compubapi/signed_time_stamp.proto

@@ -0,0 +1,43 @@
+syntax = "proto3";
+
+package Yoti.Protobuf.compubapi_v3;
+
+option java_package = "com.yoti.compubapi_v3";
+option java_outer_classname = "SignedTimestampProto";
+
+// SignedTimestamp is a timestamp associated with a message that has a
+// cryptographic signature proving that it was issued by the correct authority.
+message SignedTimestamp {
+	// Version indicates how the digests within this object are calculated.
+	int32 version = 1;
+
+	// Timestamp is the time this SignedTimestamp was issued. It is in UTC,
+	// as µseconds elapsed since the epoch (µs from 1970-01-01T00:00:00Z).
+	uint64 timestamp = 2;
+
+	// MessageDigest is the digest of the message this timestamp is
+	// associated with. The first step in verifying the timestamp is
+	// ensuring the MessageDigest matches the original message data.
+	//
+	// For version 1 objects, the message digest algorithm is SHA-512/224.
+	bytes message_digest = 3;
+
+	// ChainDigest is the digest of the previous SignedTimestamp message
+	// in the chain. The second step in verifying the timestamp is walking
+	// back over the chain and checking each SignedTimestamp's ChainDigest
+	// field. The SignedTimestamp at the beginning of the chain has this
+	// field set to a specific, publish value.
+	//
+	// For version 1 objects, the chain digest algorithm is HMAC-SHA-512/224,
+	// with the secret being equal to the MessageDigest field.
+	bytes chain_digest = 4;
+
+	// ChainDigestSkip1 is only populated once every 500 nodes. It is the
+	// ChainDigest value of the timestamp 500 nodes previously.
+	bytes chain_digest_skip1 = 5;
+
+	// ChainDigestSkip2 is only populated once every 250000 nodes (or once
+	// every 500 nodes that have ChainDigestSkip1 populated). It is the
+	// ChainDigest value of the timestamp 250000 nodes previously.
+	bytes chain_digest_skip2 = 6;
+}

data/lib/yoti/protobuf/{v1/protobuf.rb → main.rb}

@@ -1,36 +1,39 @@
-require 'protobuf'
-require_relative 'attribute_public_api/list.pb'
-require_relative 'common_public_api/encrypted_data.pb'
+require 'google/protobuf'
+require 'json'
+require_relative 'v3/attrpubapi/list_pb.rb'
+require_relative 'v3/compubapi/encrypted_data_pb.rb'
+require_relative 'v3/compubapi/signed_time_stamp_pb.rb'
 
 module Yoti
   module Protobuf
     class << self
-      CT_UNDEFINED = 0 # should not be seen, and is used as an error placeholder
-      CT_STRING = 1 # UTF-8 encoded text.
-      CT_JPEG = 2 # standard .jpeg image.
-      CT_DATE = 3 # string in RFC3339 format (YYYY-MM-DD)
-      CT_PNG = 4 # standard .png image
+      CT_UNDEFINED = :UNDEFINED # should not be seen, and is used as an error placeholder
+      CT_STRING = :STRING # UTF-8 encoded text.
+      CT_JPEG = :JPEG # standard .jpeg image.
+      CT_DATE = :DATE # string in RFC3339 format (YYYY-MM-DD)
+      CT_PNG = :PNG # standard .png image
+      CT_JSON = :JSON # json_string
 
       def current_user(receipt)
         return nil unless valid_receipt?(receipt)
 
         profile_content = receipt['other_party_profile_content']
         decoded_profile_content = Base64.decode64(profile_content)
-        V1::Compubapi::EncryptedData.decode(decoded_profile_content)
+        Yoti::Protobuf::CompubapiV3::EncryptedData.decode(decoded_profile_content)
       end
 
       def attribute_list(data)
-        V1::Attrpubapi::AttributeList.decode(data)
+        Yoti::Protobuf::AttrpubapiV3::AttributeList.decode(data)
       end
 
       def value_based_on_content_type(value, content_type = nil)
         case content_type
         when CT_UNDEFINED
           raise ProtobufError, 'The content type is invalid.'
-        when CT_STRING
-          value.encode('utf-8')
-        when CT_DATE
+        when CT_STRING, CT_DATE
           value.encode('utf-8')
+        when CT_JSON
+           JSON.parse(value)
         else
           value
         end

data/lib/yoti/protobuf/v3/attrpubapi/attribute_pb.rb

@@ -0,0 +1,39 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: attribute.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "Yoti.Protobuf.attrpubapi_v3.Attribute" do
+    optional :name, :string, 1
+    optional :value, :bytes, 2
+    optional :content_type, :enum, 3, "Yoti.Protobuf.attrpubapi_v3.ContentType"
+    repeated :anchors, :message, 4, "Yoti.Protobuf.attrpubapi_v3.Anchor"
+  end
+  add_message "Yoti.Protobuf.attrpubapi_v3.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_enum "Yoti.Protobuf.attrpubapi_v3.ContentType" do
+    value :UNDEFINED, 0
+    value :STRING, 1
+    value :JPEG, 2
+    value :DATE, 3
+    value :PNG, 4
+    value :JSON, 5
+  end
+end
+
+module Yoti
+  module Protobuf
+    module AttrpubapiV3
+      Attribute = Google::Protobuf::DescriptorPool.generated_pool.lookup("Yoti.Protobuf.attrpubapi_v3.Attribute").msgclass
+      Anchor = Google::Protobuf::DescriptorPool.generated_pool.lookup("Yoti.Protobuf.attrpubapi_v3.Anchor").msgclass
+      ContentType = Google::Protobuf::DescriptorPool.generated_pool.lookup("Yoti.Protobuf.attrpubapi_v3.ContentType").enummodule
+    end
+  end
+end

data/lib/yoti/protobuf/v3/attrpubapi/list_pb.rb

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

data/lib/yoti/protobuf/v3/attrpubapi/signing_pb.rb

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

data/lib/yoti/protobuf/v3/compubapi/encrypted_data_pb.rb

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

data/lib/yoti/protobuf/v3/compubapi/signed_time_stamp_pb.rb

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

data/lib/yoti/util/age_processor.rb

@@ -0,0 +1,11 @@
+module Yoti
+  # Process age attribute
+  class AgeProcessor
+    AGE_PATTERN = "age_(over|under):[1-9][0-9]?[0-9]?"
+
+    # check if the key matches the format age_[over|under]:[1-999]
+    def self.is_age_verification(age_field)
+        return /#{AGE_PATTERN}/.match?(age_field)
+    end
+  end
+end

data/lib/yoti/util/anchor_processor.rb

@@ -0,0 +1,100 @@
+require 'openssl'
+require 'date'
+
+module Yoti
+  # Parse attribute anchors
+  class AnchorProcessor
+    # Define whether the search function get_anchor_value_by_oid
+    # should return the next value in the array
+    attr_reader :get_next
+
+    protected :get_next
+
+    def initialize(anchors_list)
+        @anchors_list = anchors_list
+        @get_next = false
+    end
+
+    def process
+        result_data = { "sources" => [], "verifiers" => [] }
+        anchor_types = self.anchor_types
+
+        @anchors_list.each do |anchor|
+            x509_certs_list = convert_certs_list_to_X509(anchor.origin_server_certs)
+            yoti_signed_time_stamp = process_signed_time_stamp(anchor.signed_time_stamp)
+
+            anchor.origin_server_certs.each do |cert|
+                anchor_types.each do |type, oid|
+                    yotiAnchor = get_anchor_by_oid(cert, oid, anchor.sub_type, yoti_signed_time_stamp, x509_certs_list)
+                    if !yotiAnchor.nil? then
+                        result_data[type].push(yotiAnchor)
+                    end
+                end
+            end
+        end
+
+        return result_data
+    end
+
+    def convert_certs_list_to_X509(certs_list)
+        x509_certs_list = []
+        certs_list.each do |cert|
+           x509_cert = OpenSSL::X509::Certificate.new cert
+           x509_certs_list.push x509_cert
+        end
+
+        return x509_certs_list
+    end
+
+    def process_signed_time_stamp(signed_time_stamp_binary)
+        signed_time_stamp = Yoti::Protobuf::CompubapiV3::SignedTimestamp.decode(signed_time_stamp_binary)
+        time_in_sec = signed_time_stamp.timestamp/1000000
+        date_time = DateTime.parse(Time.at(time_in_sec).to_s)
+        return Yoti::SignedTimeStamp.new(signed_time_stamp.version, date_time)
+    end
+
+    def get_anchor_by_oid(cert, oid, sub_type, signed_time_stamp, x509_certs_list)
+        asn1Obj = OpenSSL::ASN1.decode(cert)
+        anchorValue = get_anchor_value_by_oid(asn1Obj, oid)
+
+        return nil unless !anchorValue.nil?
+
+        return Yoti::Anchor.new(anchorValue, sub_type, signed_time_stamp, x509_certs_list)
+    end
+
+    def get_anchor_value_by_oid(obj, oid)
+
+        case obj
+        when OpenSSL::ASN1::Sequence, Array
+            obj.each do |child_obj|
+                result = get_anchor_value_by_oid(child_obj, oid)
+                if result != nil
+                    return result
+                end
+            end
+        when OpenSSL::ASN1::ASN1Data
+            if obj.value.respond_to?(:to_s) && obj.value === oid
+                @get_next = true
+            elsif obj.value.respond_to?(:to_s) && @get_next
+                rawValue = OpenSSL::ASN1.decode(obj.value)
+                anchorValue = rawValue.value[0].value
+                @get_next = false
+                return anchorValue
+            end
+
+            return get_anchor_value_by_oid(obj.value, oid)
+        else
+            return nil
+        end
+
+        # In case it's not a valid object
+        return nil
+    end
+
+    def anchor_types
+        return { "sources" => '1.3.6.1.4.1.47127.1.1.1',
+                 "verifiers" => '1.3.6.1.4.1.47127.1.1.2',
+               }
+    end
+  end
+end

data/lib/yoti/version.rb

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

data/yoti.gemspec

@@ -21,9 +21,10 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|examples)/}) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2'
+  spec.required_ruby_version = '>= 2.4'
 
   spec.add_dependency 'protobuf', '~> 3.6'
+  spec.add_dependency 'google-protobuf', '~> 3.6.1'
 
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'dotenv', '~> 2.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yoti
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Sebastian Zaremba
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-06 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protobuf
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -161,7 +175,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - Guardfile
@@ -174,6 +187,10 @@ files:
 - lib/yoti/activity_details.rb
 - lib/yoti/client.rb
 - lib/yoti/configuration.rb
+- lib/yoti/data_type/anchor.rb
+- lib/yoti/data_type/attribute.rb
+- lib/yoti/data_type/profile.rb
+- lib/yoti/data_type/signed_time_stamp.rb
 - lib/yoti/errors.rb
 - lib/yoti/http/aml_check_request.rb
 - lib/yoti/http/payloads/aml_address.rb
@@ -181,16 +198,20 @@ files:
 - lib/yoti/http/profile_request.rb
 - lib/yoti/http/request.rb
 - lib/yoti/http/signed_request.rb
-- lib/yoti/protobuf/v1/attribute_public_api/attribute.pb.rb
-- lib/yoti/protobuf/v1/attribute_public_api/list.pb.rb
-- lib/yoti/protobuf/v1/attribute_public_api/signing.pb.rb
-- lib/yoti/protobuf/v1/common_public_api/encrypted_data.pb.rb
-- lib/yoti/protobuf/v1/definitions/attribute-public-api/attrpubapi_v1/attribute.proto
-- lib/yoti/protobuf/v1/definitions/attribute-public-api/attrpubapi_v1/list.proto
-- lib/yoti/protobuf/v1/definitions/attribute-public-api/attrpubapi_v1/signing.proto
-- lib/yoti/protobuf/v1/definitions/common-public-api/compubapi_v1/encrypted_data.proto
-- lib/yoti/protobuf/v1/protobuf.rb
+- lib/yoti/protobuf/definitions/attrpubapi/attribute.proto
+- lib/yoti/protobuf/definitions/attrpubapi/list.proto
+- lib/yoti/protobuf/definitions/attrpubapi/signing.proto
+- lib/yoti/protobuf/definitions/compubapi/encrypted_data.proto
+- lib/yoti/protobuf/definitions/compubapi/signed_time_stamp.proto
+- lib/yoti/protobuf/main.rb
+- lib/yoti/protobuf/v3/attrpubapi/attribute_pb.rb
+- lib/yoti/protobuf/v3/attrpubapi/list_pb.rb
+- lib/yoti/protobuf/v3/attrpubapi/signing_pb.rb
+- lib/yoti/protobuf/v3/compubapi/encrypted_data_pb.rb
+- lib/yoti/protobuf/v3/compubapi/signed_time_stamp_pb.rb
 - lib/yoti/ssl.rb
+- lib/yoti/util/age_processor.rb
+- lib/yoti/util/anchor_processor.rb
 - lib/yoti/version.rb
 - login_flow.png
 - rubocop.yml
@@ -208,7 +229,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -216,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Yoti Ruby SDK for back-end integration.

data/CHANGELOG.md

@@ -1,40 +0,0 @@
-# Change Log
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/)
-and this project adheres to [Semantic Versioning](http://semver.org/).
-
-## 1.2.1 - 2018-03-06
-### Added
-- `user_profile.age_verified` helper returns a boolean value of the age validation
-
-## 1.2.0 - 2018-02-28
-### Added
-- AML (Anti Money Laundering) check service
-
-## 1.1.0 - 2017-10-24
-### Changed
-- `user_profile['selfie']` will return image data instead of an image URI
-
-### Added
-- `user_profile.base64_selfie_uri` helper returns the base64 selfie URI
-
-## 1.0.3 - 2017-10-17
-### Changed
-- Switched from proprietary to MIT license
-
-## 1.0.2 - 2017-03-15
-### Added
-- Allow empty profiles
-
-## 1.0.1 - 2016-11-28
-### Added
-- Yoti proprietary license
-
-## 1.0.0 - 2016-11-14
-### Added
-- This is an initial public release.
-
-## 0.1.0 - 2016-09-14
-### Added
-- This is an initial private release.

data/lib/yoti/protobuf/v1/attribute_public_api/attribute.pb.rb

@@ -1,45 +0,0 @@
-require 'protobuf/message'
-
-module Yoti
-  module Protobuf
-    module V1
-      module Attrpubapi
-        ##
-        # Enum Classes
-        #
-        class ContentType < ::Protobuf::Enum
-          define :UNDEFINED, 0
-          define :STRING, 1
-          define :JPEG, 2
-          define :DATE, 3
-          define :PNG, 4
-        end
-
-        ##
-        # Message Classes
-        #
-        class Attribute < ::Protobuf::Message; end
-        class Anchor < ::Protobuf::Message; end
-
-        ##
-        # Message Fields
-        #
-        class Attribute
-          optional :string, :name, 1
-          optional :bytes, :value, 2
-          optional Yoti::Protobuf::V1::Attrpubapi::ContentType, :content_type, 3
-          repeated Yoti::Protobuf::V1::Attrpubapi::Anchor, :anchors, 4
-        end
-
-        class Anchor
-          optional :bytes, :artifact_link, 1
-          repeated :bytes, :origin_server_certs, 2
-          optional :bytes, :artifact_signature, 3
-          optional :string, :sub_type, 4
-          optional :bytes, :signature, 5
-          optional :bytes, :signed_time_stamp, 6
-        end
-      end
-    end
-  end
-end

data/lib/yoti/protobuf/v1/attribute_public_api/list.pb.rb

@@ -1,33 +0,0 @@
-require 'protobuf/message'
-require_relative 'attribute.pb'
-
-module Yoti
-  module Protobuf
-    module V1
-      module Attrpubapi
-        ##
-        # Message Classes
-        #
-        class AttributeAndId < ::Protobuf::Message; end
-        class AttributeAndIdList < ::Protobuf::Message; end
-        class AttributeList < ::Protobuf::Message; end
-
-        ##
-        # Message Fields
-        #
-        class AttributeAndId
-          optional Yoti::Protobuf::V1::Attrpubapi::Attribute, :attribute, 1
-          optional :bytes, :attribute_id, 2
-        end
-
-        class AttributeAndIdList
-          repeated Yoti::Protobuf::V1::Attrpubapi::AttributeAndId, :attribute_and_id_list, 1
-        end
-
-        class AttributeList
-          repeated Yoti::Protobuf::V1::Attrpubapi::Attribute, :attributes, 1
-        end
-      end
-    end
-  end
-end

data/lib/yoti/protobuf/v1/attribute_public_api/signing.pb.rb

@@ -1,27 +0,0 @@
-require 'protobuf/message'
-require_relative 'attribute.pb'
-
-module Yoti
-  module Protobuf
-    module V1
-      module Attrpubapi
-        ##
-        # Message Classes
-        #
-        class AttributeSigning < ::Protobuf::Message; end
-
-        ##
-        # Message Fields
-        #
-        class AttributeSigning
-          optional :string, :name, 1
-          optional :bytes, :value, 2
-          optional Yoti::Protobuf::V1::Attrpubapi::ContentType, :content_type, 3
-          optional :bytes, :artifact_signature, 4
-          optional :string, :sub_type, 5
-          optional :bytes, :signed_time_stamp, 6
-        end
-      end
-    end
-  end
-end

data/lib/yoti/protobuf/v1/common_public_api/encrypted_data.pb.rb

@@ -1,22 +0,0 @@
-require 'protobuf/message'
-
-module Yoti
-  module Protobuf
-    module V1
-      module Compubapi
-        ##
-        # Message Classes
-        #
-        class EncryptedData < ::Protobuf::Message; end
-
-        ##
-        # Message Fields
-        #
-        class EncryptedData
-          optional :bytes, :iv, 1
-          optional :bytes, :cipher_text, 2
-        end
-      end
-    end
-  end
-end

data/lib/yoti/protobuf/v1/definitions/attribute-public-api/attrpubapi_v1/signing.proto

@@ -1,23 +0,0 @@
-//syntax = "proto2";
-
-package attrpubapi_v1;
-
-import "Attribute.proto";
-
-option java_package = "com.yoti.attrpubapi_v1";
-option java_outer_classname = "AttrProto";
-
-
-message AttributeSigning {
-	optional string name = 1;
-
-	optional bytes value = 2;
-
-	optional ContentType content_type = 3;
-
-	optional bytes artifact_signature = 4;
-
-	optional string sub_type = 5;
-
-	optional bytes signed_time_stamp = 6;
-}