yoti 1.5.0 → 1.6.0

data/lib/yoti/sandbox/attribute.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Sandbox
+  # Attribute describes an attribute on a sandbox profile
+  class Attribute
+    attr_accessor :name
+    attr_accessor :value
+    attr_accessor :derivation
+    attr_accessor :optional
+    attr_reader :anchors
+
+    def initialize(
+      name: '',
+      value: '',
+      derivation: '',
+      optional: false,
+      anchors: []
+    )
+      @name = name
+      @value = value
+      @derivation = derivation
+      @optional = optional
+      @anchors = anchors
+    end
+
+    def as_json(*_args)
+      {
+        name: name,
+        value: value,
+        derivation: derivation,
+        optional: optional,
+        anchors: anchors
+      }
+    end
+
+    def with_anchor(anchor)
+      @anchors.push anchor
+      self
+    end
+  end
+
+  # Helper functions for building derivation strings
+  module Derivation
+    def self.age_over(age)
+      "age_over:#{age}"
+    end
+
+    def self.age_under(age)
+      "age_under:#{age}"
+    end
+  end
+end

data/lib/yoti/sandbox/profile.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require 'yoti/data_type/attribute'
+
+require 'base64'
+
+require_relative 'attribute'
+
+module Sandbox
+  # Builds a user profile on the sandbox instance
+  class Profile
+    attr_reader :remember_me_id
+    attr_reader :attributes
+
+    def as_json(*_args)
+      {
+        remember_me_id: remember_me_id,
+        profile_attributes: attributes.map(&:as_json)
+      }
+    end
+
+    def to_json(*_args)
+      as_json.to_json
+    end
+
+    def initialize
+      @remember_me_id = ''
+      @attributes = []
+    end
+
+    def with_remember_me_id(id)
+      @remember_me_id = id
+      self
+    end
+
+    def with_attribute(
+      name:,
+      value:,
+      derivation: '',
+      optional: false,
+      anchors: []
+    )
+      @attributes.push Sandbox::Attribute.new(
+        name: name,
+        value: value,
+        derivation: derivation,
+        optional: optional,
+        anchors: anchors
+      )
+      self
+    end
+
+    def with_given_names(value, optional: false, anchors: [])
+      with_attribute(
+        name: Yoti::Attribute::GIVEN_NAMES,
+        value: value,
+        optional: optional,
+        anchors: anchors
+      )
+    end
+
+    def with_family_name(value, optional: false, anchors: [])
+      with_attribute(
+        name: Yoti::Attribute::FAMILY_NAME,
+        value: value,
+        optional: optional,
+        anchors: anchors
+      )
+    end
+
+    def with_full_name(value, optional: false, anchors: [])
+      with_attribute(
+        name: Yoti::Attribute::FULL_NAME,
+        value: value,
+        optional: optional,
+        anchors: anchors
+      )
+    end
+
+    def with_date_of_birth(date, optional: false, anchors: [])
+      with_attribute(
+        name: Yoti::Attribute::DATE_OF_BIRTH,
+        value: date.to_s,
+        optional: optional,
+        anchors: anchors
+      )
+    end
+
+    def with_age_verification(dob:, derivation:, optional: false, anchors: [])
+      with_attribute(
+        name: Yoti::Attribute::DATE_OF_BIRTH,
+        value: dob.to_s,
+        derivation: derivation,
+        optional: optional,
+        anchors: anchors
+      )
+    end
+
+    def with_gender(value, optional: false, anchors: [])
+      with_attribute(
+        name: Yoti::Attribute::GENDER,
+        value: value,
+        optional: optional,
+        anchors: anchors
+      )
+    end
+
+    def with_phone_number(value, optional: false, anchors: [])
+      with_attribute(
+        name: Yoti::Attribute::PHONE_NUMBER,
+        value: value,
+        optional: optional,
+        anchors: anchors
+      )
+    end
+
+    def with_nationality(value, optional: false, anchors: [])
+      with_attribute(
+        name: Yoti::Attribute::NATIONALITY,
+        value: value,
+        optional: optional,
+        anchors: anchors
+      )
+    end
+
+    def with_postal_address(value, optional: false, anchors: [])
+      with_attribute(
+        name: Yoti::Attribute::POSTAL_ADDRESS,
+        value: value,
+        optional: optional,
+        anchors: anchors
+      )
+    end
+
+    def with_structured_postal_address(data, optional: false, anchors: [])
+      with_attribute(
+        name: Yoti::Attribute::STRUCTURED_POSTAL_ADDRESS,
+        value: data.to_json,
+        optional: optional,
+        anchors: anchors
+      )
+    end
+
+    def with_selfie(data, optional: false, anchors: [])
+      with_attribute(
+        name: Yoti::Attribute::SELFIE,
+        value: Base64.strict_encode64(data),
+        optional: optional,
+        anchors: anchors
+      )
+    end
+
+    def with_email_address(value, optional: false, anchors: [])
+      with_attribute(
+        name: Yoti::Attribute::EMAIL_ADDRESS,
+        value: value,
+        optional: optional,
+        anchors: anchors
+      )
+    end
+
+    def with_document_details(value, optional: false, anchors: [])
+      with_attribute(
+        name: Yoti::Attribute::DOCUMENT_DETAILS,
+        value: value,
+        optional: optional,
+        anchors: anchors
+      )
+    end
+  end
+end

data/lib/yoti/sandbox/sandbox.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'yoti'
+require 'yoti/configuration'
+require 'yoti/http/signed_request'
+
+require_relative 'sandbox_client'
+require_relative 'profile'
+require_relative 'anchor'
+require_relative 'attribute'
+
+require 'openssl'
+require 'net/http'
+require 'date'
+require 'securerandom'
+
+require 'dotenv'
+Dotenv.load
+
+# Singleton for sandbox test resources
+module Sandbox
+  class << self
+    attr_accessor :sandbox_client
+    attr_accessor :dev_key
+    attr_accessor :application
+  end
+
+  def self.setup!
+    return if application
+
+    read_dev_key!
+    create_application!
+    self.sandbox_client = Client.new(
+      app_id: application['id'],
+      private_key: application['private_key'],
+      base_url: ENV['SANDBOX_BASE_URL']
+    )
+    configure_yoti(
+      app_id: sandbox_client.app_id,
+      pem: sandbox_client.key.to_pem
+    )
+    nil
+  end
+
+  def self.configure_yoti(app_id:, pem:)
+    Yoti.configuration = Yoti::Configuration.new
+    Yoti.configuration.client_sdk_id = app_id
+    Yoti.configuration.key = pem
+    Yoti.configuration.key_file_path = ''
+    Yoti.configuration.api_endpoint = "#{ENV['SANDBOX_BASE_URL']}/"
+    Yoti::SSL.reload!
+  end
+
+  def self.create_application_uri
+    uri = URI(
+      "#{ENV['SANDBOX_BASE_URL']}/#{ENV['SANDBOX_ENDPOINT']}?\
+nonce=#{SecureRandom.uuid}&timestamp=#{Time.now.to_i}"
+    )
+    uri.port = 11_443
+    uri
+  end
+
+  def self.create_application!
+    Yoti.configure do |config|
+      config.key_file_path = ENV['SANDBOX_KEY']
+      config.client_sdk_id = 'DUMMY'
+    end
+
+    uri = create_application_uri
+    payload = { name: "Test Run #{DateTime.now.rfc3339}" }
+
+    response = Net::HTTP.start(
+      uri.hostname,
+      uri.port,
+      use_ssl: true,
+      verify_mode: OpenSSL::SSL::VERIFY_NONE
+    ) do |http|
+      unsigned = Net::HTTP::Post.new uri
+      unsigned.body = payload.to_json
+      signed_request = Yoti::SignedRequest.new(
+        unsigned,
+        "#{ENV['SANDBOX_ENDPOINT']}?#{uri.query}",
+        payload
+      ).sign
+      Yoti::Log.logger.info("Creating application #{signed_request.body}")
+      http.request signed_request
+    end
+
+    raise "Create application failed #{response.code}: #{response.body}" unless response.code == '201'
+
+    self.application = JSON.parse(response.body)
+    nil
+  end
+
+  def self.read_dev_key!
+    self.dev_key = OpenSSL::PKey::RSA.new(
+      File.read(ENV['SANDBOX_KEY'], encoding: 'utf-8')
+    )
+    nil
+  end
+
+  def self.share(profile)
+    sandbox_client.setup_sharing_profile profile
+  end
+end

data/lib/yoti/sandbox/sandbox_client.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sandbox
+  # Client is responsible for setting up test data in the sandbox instance
+  class Client
+    attr_accessor :app_id
+    attr_accessor :key
+    attr_accessor :base_url
+
+    def initialize(app_id:, private_key:, base_url:)
+      @app_id = app_id
+      @base_url = base_url
+      @key = OpenSSL::PKey::RSA.new(Base64.decode64(private_key))
+    end
+
+    def setup_sharing_profile(profile)
+      endpoint = "/apps/#{app_id}/tokens?\
+nonce=#{SecureRandom.uuid}&timestamp=#{Time.now.to_i}"
+      uri = URI(
+        "#{@base_url}/#{endpoint}"
+      )
+
+      response = Net::HTTP.start(
+        uri.hostname,
+        uri.port,
+        use_ssl: true,
+        verify_mode: OpenSSL::SSL::VERIFY_NONE
+      ) do |http|
+        unsigned = Net::HTTP::Post.new uri
+        unsigned.body = profile.to_json
+        signed_request = Yoti::SignedRequest.new(
+          unsigned,
+          endpoint,
+          profile
+        ).sign
+        http.request signed_request
+      end
+
+      raise "Failed to share profile #{response.code}: #{response.body}" unless response.code == '201'
+
+      token = JSON.parse(response.body)['token']
+      token
+    end
+  end
+end

data/lib/yoti/share/attribute_issuance_details.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module Yoti
+  module Share
+    class Definition
+      attr_reader :name
+
+      #
+      # Constructor
+      #
+      # @param [String] name
+      #
+      def initialize(name)
+        @name = name
+      end
+    end
+
+    class AttributeIssuanceDetails
+      attr_reader :token
+      attr_reader :attributes
+      attr_reader :expiry_date
+
+      #
+      # Constructor
+      #
+      # @param [Yoti::Protobuf::Sharepubapi::ThirdPartyAttribute] data_entry
+      #
+      def initialize(data_entry)
+        @token = Base64.encode64(data_entry.issuance_token)
+        begin
+          @expiry_date = DateTime.parse(data_entry.issuing_attributes.expiry_date)
+        rescue ArgumentError
+          @expiry_date = nil
+        end
+        @attributes = data_entry.issuing_attributes.definitions.map do |defn|
+          Definition.new(defn.name)
+        end
+      end
+    end
+  end
+end

data/lib/yoti/share/extra_data.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Share
+    class ExtraData
+      attr_reader :attribute_issuance_details
+
+      #
+      # Constructor
+      #
+      # @param [Yoti::Protobuf::Sharepubapi::ExtraData] proto
+      #
+      def initialize(proto)
+        @attribute_issuance_details = nil
+
+        proto.list.each do |data_entry|
+          if data_entry.type == :THIRD_PARTY_ATTRIBUTE && @attribute_issuance_details.nil?
+            attribute = Yoti::Protobuf::Sharepubapi::ThirdPartyAttribute.decode(data_entry.value)
+            @attribute_issuance_details = Yoti::Share::AttributeIssuanceDetails.new(attribute)
+          end
+        end
+      end
+    end
+  end
+end