yoti 1.5.0 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00ff1a296c371b2d5e94ccd5e0951963ff8cbcf9676717724369567e39ef1652
-  data.tar.gz: e80cb02c9f2cd4b9fdab9ac59de05aeee58cdc1066229a0bde35f4310052d562
+  metadata.gz: d1d2cbb57b376a252d798c35820fcee63a46eb99809422441e592ed25bc0f9da
+  data.tar.gz: 1e31e86853d8e419cad2bec50a260d9e26a9c8043299ff6dc10620635c9169c9
 SHA512:
-  metadata.gz: 74652cb02c63be28c4296c47e073f756baf3836289cf71f646949a36d870716a7851dbe2c4c78f9fb3b771e08213d6035e1bb2508a0a4fbae340d1964d4754a5
-  data.tar.gz: '019dd78cc18bdfeb6bb2b852cd3ae8331062f4a5d7af312882aa143818af75ea7fc7e15e3dddf96d30c32b208c13a56327eeebc509415502a888442bd45e7b4b'
+  metadata.gz: 88a932e08b8b73b81ef7153935e984df1d0816c9cfdf0fe912342a57ca8b12a91892aec6b226520cd48f94b660264dca2cadd593ef85008dc2564c97c811a409
+  data.tar.gz: 1b0bdb68176391c56302aff5bda6040aece1d891d6b4491ea605af30029c079de046ea6e03df81c49c99100a1500a0730adfbc6e705c69f18c2a6c96172f0c09

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/Gemfile

@@ -2,8 +2,6 @@ source 'https://rubygems.org'
 
 gem 'guard'
 gem 'guard-rspec'
-gem 'pry'
-gem 'pry-byebug'
 gem 'rubocop'
 gem 'rubocop-performance'
 

data/README.md

@@ -270,7 +270,7 @@ The examples can be found in the [examples folder](examples).
 ### Ruby on Rails
 
 1. Create your application in the [Yoti Hub](https://hub.yoti.com)
-1. Set the application domain of your app to `localhost:3000`
+1. Set the application domain of your app to `localhost:3001`
 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)

data/Rakefile

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

data/lib/yoti.rb

@@ -12,6 +12,7 @@ require_relative 'yoti/http/profile_request'
 require_relative 'yoti/http/request'
 
 require_relative 'yoti/data_type/anchor'
+require_relative 'yoti/data_type/age_verification'
 require_relative 'yoti/data_type/base_profile'
 require_relative 'yoti/data_type/application_profile'
 require_relative 'yoti/data_type/profile'
@@ -21,6 +22,7 @@ require_relative 'yoti/data_type/image'
 require_relative 'yoti/data_type/image_jpeg'
 require_relative 'yoti/data_type/image_png'
 require_relative 'yoti/data_type/multi_value'
+require_relative 'yoti/data_type/document_details'
 
 require_relative 'yoti/util/age_processor'
 require_relative 'yoti/util/anchor_processor'
@@ -31,6 +33,20 @@ require_relative 'yoti/client'
 
 require_relative 'yoti/protobuf/main'
 
+require_relative 'yoti/dynamic_share_service/share_url'
+require_relative 'yoti/dynamic_share_service/policy/wanted_attribute'
+require_relative 'yoti/dynamic_share_service/policy/wanted_anchor'
+require_relative 'yoti/dynamic_share_service/policy/source_constraint'
+require_relative 'yoti/dynamic_share_service/policy/dynamic_policy'
+require_relative 'yoti/dynamic_share_service/dynamic_scenario'
+require_relative 'yoti/dynamic_share_service/extension/extension'
+require_relative 'yoti/dynamic_share_service/extension/location_constraint_extension'
+require_relative 'yoti/dynamic_share_service/extension/transactional_flow_extension'
+require_relative 'yoti/dynamic_share_service/extension/thirdparty_attribute_extension'
+
+require_relative 'yoti/share/extra_data'
+require_relative 'yoti/share/attribute_issuance_details'
+
 # 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
   #
@@ -60,6 +61,11 @@ module Yoti
     #
     # The age under/over attribute
     #
+    # @deprecated 2.0.0 - replaced by:
+    # - Yoti::Profile#age_verifications
+    # - Yoti::Profile#find_age_over_verification
+    # - Yoti::Profile#find_age_under_verification
+    #
     # @return [Boolean]
     #
     attr_reader :age_verified
@@ -78,11 +84,21 @@ module Yoti
     #
     attr_reader :timestamp
 
+    #
+    # Extra data
+    #
+    # @return [ExtraData]
+    #
+    attr_reader :extra_data
+
     #
     # @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)
+    def initialize(receipt, decrypted_profile = nil, decrypted_application_profile = nil, extra_data = nil)
       @remember_me_id = receipt['remember_me_id']
       @user_id = @remember_me_id
       @receipt_id = receipt['receipt_id']
@@ -91,6 +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 = extra_data
       @user_profile = @extended_user_profile.map do |name, attribute|
         [name, attribute.value]
       end.to_h
@@ -99,7 +116,7 @@ module Yoti
     #
     # The user's structured postal address as JSON
     #
-    # @deprecated replaced by Profile.structured_postal_address
+    # @deprecated replaced by Yoti::Profile#structured_postal_address
     #
     # @return [Hash]
     #
@@ -178,6 +195,8 @@ module Yoti
     #
     # Processes age verification
     #
+    # @deprecated 2.0.0
+    #
     # @param [Yoti::Protobuf::Attrpubapi::Attribute] attribute
     #
     def process_age_verified(attribute)

data/lib/yoti/client.rb

@@ -15,10 +15,11 @@ module Yoti
       receipt = Yoti::ProfileRequest.new(encrypted_connect_token).receipt
       user_profile = Protobuf.user_profile(receipt)
       application_profile = Protobuf.application_profile(receipt)
+      extra_data = Protobuf.extra_data(receipt)
 
       return ActivityDetails.new(receipt) if user_profile.nil?
 
-      ActivityDetails.new(receipt, user_profile, application_profile)
+      ActivityDetails.new(receipt, user_profile, application_profile, extra_data)
     end
 
     def self.aml_check(aml_profile)

data/lib/yoti/data_type/age_verification.rb

@@ -0,0 +1,54 @@
+module Yoti
+  #
+  # Wraps an 'Age Verify/Condition' attribute to provide behaviour specific
+  # to verifying someone's age.
+  #
+  class AgeVerification
+    #
+    # The wrapped profile attribute.
+    #
+    # Use this if you need access to the underlying list of Anchors.
+    #
+    # @return [Yoti::Attribute]
+    #
+    attr_reader :attribute
+
+    #
+    # Whether or not the profile passed the age check.
+    #
+    # @return [Boolean]
+    #
+    attr_reader :result
+
+    #
+    # The type of age check performed, as specified on Yoti Hub.
+    #
+    # Among the possible values are 'age_over' and 'age_under'.
+    #
+    # @return [String]
+    #
+    attr_reader :check_type
+
+    #
+    # The age that was that checked, as specified on Yoti Hub.
+    #
+    # @return [Integer]
+    #
+    attr_reader :age
+
+    #
+    # @param [Yoti::Attribute]
+    #
+    def initialize(attribute)
+      raise(ArgumentError, "'#{attribute.name}' is not a valid age verification") unless /^[^:]+:(?!.*:)[0-9]+$/.match?(attribute.name)
+
+      @attribute = attribute
+
+      split = attribute.name.split(':')
+      @check_type = split[0]
+
+      @age = split[1].to_i
+      @result = attribute.value == 'true'
+    end
+  end
+end

data/lib/yoti/data_type/attribute.rb

@@ -21,10 +21,13 @@ module Yoti
     POSTAL_ADDRESS = 'postal_address'
     STRUCTURED_POSTAL_ADDRESS = 'structured_postal_address'
     DOCUMENT_IMAGES = 'document_images'
+    DOCUMENT_DETAILS = 'document_details'
     APPLICATION_NAME = 'application_name'
     APPLICATION_LOGO = 'application_logo'
     APPLICATION_URL = 'application_url'
     APPLICATION_RECEIPT_BGCOLOR = 'application_receipt_bgcolor'
+    AGE_OVER = 'age_over:'
+    AGE_UNDER = 'age_under:'
 
     #
     # Gets the name of the attribute.

data/lib/yoti/data_type/base_profile.rb

@@ -29,5 +29,18 @@ module Yoti
 
       @attributes[attr_name]
     end
+
+    protected
+
+    #
+    # Find attributes starting with provided name.
+    #
+    # @param [String] name
+    #
+    # @returns [Array]
+    #
+    def find_attributes_starting_with(name)
+      @attributes.select { |key| key.to_s.start_with?(name) }
+    end
   end
 end

data/lib/yoti/data_type/document_details.rb

@@ -0,0 +1,88 @@
+module Yoti
+  class DocumentDetails
+    #
+    # @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
+    EXPIRATION_INDEX = 3
+    AUTHORITY_INDEX = 4
+
+    #
+    # Type of the document e.g. PASSPORT | DRIVING_LICENCE | NATIONAL_ID | PASS_CARD
+    #
+    # @return [String]
+    #
+    attr_reader :type
+
+    #
+    # ISO-3166-1 alpha-3 country code, e.g. "GBR"
+    #
+    # @return [String]
+    #
+    attr_reader :issuing_country
+
+    #
+    # Document number (may include letters) from the document.
+    #
+    # @return [String]
+    #
+    attr_reader :document_number
+
+    #
+    # Expiration date of the document in DateTime format. If the document does not expire, this
+    # field will not be present. The time part of this DateTime will default to 00:00:00.
+    #
+    # @return [DateTime]
+    #
+    attr_reader :expiration_date
+
+    #
+    # Can either be a country code (for a state), or the name of the issuing authority.
+    #
+    # @return [String]
+    #
+    attr_reader :issuing_authority
+
+    #
+    # @param [String] value
+    #
+    def initialize(value)
+      parse_value(value)
+    end
+
+    private
+
+    #
+    # Parses provided value into separate attributes
+    #
+    # @param [String] value
+    #
+    def parse_value(value)
+      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]
+      @expiration_date = parse_date_from_string(attributes[EXPIRATION_INDEX]) if attributes.length > 3
+      @issuing_authority = attributes[AUTHORITY_INDEX] if attributes.length > 4
+    end
+
+    #
+    # Converts provided date string into DateTime
+    #
+    # @param [String] date_string
+    #
+    # @return [DateTime]
+    #
+    def parse_date_from_string(date_string)
+      return nil if date_string == '-'
+
+      DateTime.iso8601(date_string)
+    end
+  end
+end

data/lib/yoti/data_type/profile.rb

@@ -1,3 +1,5 @@
+require_relative 'base_profile'
+
 module Yoti
   #
   # Encapsulates Yoti user profile
@@ -116,6 +118,47 @@ module Yoti
       get_attribute(Yoti::Attribute::STRUCTURED_POSTAL_ADDRESS)
     end
 
+    #
+    # Document Details.
+    #
+    # @return [Attribute, nil]
+    #
+    def document_details
+      get_attribute(Yoti::Attribute::DOCUMENT_DETAILS)
+    end
+
+    # Finds all the 'Age Over' and 'Age Under' derived attributes returned with the profile,
+    # and returns them wrapped in AgeVerification objects
+    #
+    # @return [Array]
+    #
+    def age_verifications
+      find_all_age_verifications
+      @age_verifications.values
+    end
+
+    #
+    # Searches for an AgeVerification corresponding to an 'Age Over' check for the given age
+    #
+    # @param [Integer] age
+    #
+    # @return [AgeVerification|nil]
+    #
+    def find_age_over_verification(age)
+      find_age_verification(Yoti::Attribute::AGE_OVER, age)
+    end
+
+    #
+    # Searches for an AgeVerification corresponding to an 'Age Under' check for the given age.
+    #
+    # @param [Integer] age
+    #
+    # @return [AgeVerification|nil]
+    #
+    def find_age_under_verification(age)
+      find_age_verification(Yoti::Attribute::AGE_UNDER, age)
+    end
+
     protected
 
     #
@@ -134,5 +177,38 @@ module Yoti
         structured_postal_address.verifiers
       )
     end
+
+    private
+
+    #
+    # Searches for an AgeVerification corresponding to provided type and age.
+    #
+    # @param [String] type
+    # @param [Integer] age
+    #
+    # @return [Yoti::AgeVerification|nil]
+    #
+    def find_age_verification(type, age)
+      raise(ArgumentError, "#{age} is not a valid age") unless age.is_a?(Integer)
+
+      find_all_age_verifications
+      @age_verifications[type + age.to_s] || nil
+    end
+
+    #
+    # Find all age verifications and put in key value Hash.
+    #
+    def find_all_age_verifications
+      return @age_verifications unless @age_verifications.nil?
+
+      @age_verifications = {}
+
+      find_attributes_starting_with(Yoti::Attribute::AGE_OVER).each do |_name, attribute|
+        @age_verifications[attribute.name] = Yoti::AgeVerification.new(attribute)
+      end
+      find_attributes_starting_with(Yoti::Attribute::AGE_UNDER).each do |_name, attribute|
+        @age_verifications[attribute.name] = Yoti::AgeVerification.new(attribute)
+      end
+    end
   end
 end