yoti 1.5.0 → 1.6.0

data/lib/yoti/dynamic_share_service/policy/wanted_anchor.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DynamicSharingService
+    # A wanted anchor for a source based constraint
+    class WantedAnchor
+      attr_reader :value
+      attr_reader :sub_type
+
+      def initialize
+        @value = ''
+        @sub_type = nil
+      end
+
+      def to_json(*_args)
+        as_json.to_json
+      end
+
+      def as_json
+        obj = {
+          name: @value
+        }
+        obj[:sub_type] = @sub_type if @sub_type
+        obj
+      end
+
+      def self.builder
+        WantedAnchorBuilder.new
+      end
+    end
+
+    # Builder for WantedAnchor
+    class WantedAnchorBuilder
+      def initialize
+        @anchor = WantedAnchor.new
+      end
+
+      def with_value(value)
+        @anchor.instance_variable_set(:@value, value)
+        self
+      end
+
+      def with_sub_type(sub_type = nil)
+        @anchor.instance_variable_set(:@sub_type, sub_type)
+        self
+      end
+
+      def build
+        Marshal.load Marshal.dump @anchor
+      end
+    end
+  end
+end

data/lib/yoti/dynamic_share_service/policy/wanted_attribute.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DynamicSharingService
+    # Describes a wanted attribute in a dynamic sharing policy
+    class WantedAttribute
+      attr_reader :name
+      attr_reader :derivation
+      attr_reader :constraints
+
+      def initialize
+        @constraints = []
+      end
+
+      def accept_self_asserted
+        return true if @accept_self_asserted
+
+        false
+      end
+
+      def to_json(*_args)
+        as_json.to_json
+      end
+
+      def as_json(*_args)
+        obj = {
+          name: @name
+        }
+        obj[:derivation] = @derivation if derivation
+        obj[:accept_self_asserted] = @accept_self_asserted if accept_self_asserted
+        obj[:constraints] = @constraints.map(&:as_json) unless constraints.empty?
+        obj
+      end
+
+      def self.builder
+        WantedAttributeBuilder.new
+      end
+    end
+
+    # Builder for WantedAttribute
+    class WantedAttributeBuilder
+      def initialize
+        @attribute = WantedAttribute.new
+      end
+
+      #
+      # @param [String] name
+      #
+      def with_name(name)
+        @attribute.instance_variable_set(:@name, name)
+        self
+      end
+
+      #
+      # @param [String] derivation
+      #
+      def with_derivation(derivation)
+        @attribute.instance_variable_set(:@derivation, derivation)
+        self
+      end
+
+      #
+      # @param constraint Constraint to apply to the requested attribute
+      #
+      def with_constraint(constraint)
+        @attribute.constraints.push(constraint)
+        self
+      end
+
+      #
+      # @param [Bool] accept
+      #
+      def with_accept_self_asserted(accept = true)
+        @attribute.instance_variable_set(:@accept_self_asserted, accept)
+        self
+      end
+
+      def build
+        raise 'Attribute name missing' if @attribute.name.nil? || @attribute.name == ''
+
+        Marshal.load Marshal.dump @attribute
+      end
+    end
+  end
+end

data/lib/yoti/dynamic_share_service/share_url.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DynamicSharingService
+    class Share
+      attr_reader :share_url, :ref_id
+
+      def initialize(data)
+        @share_url = data['qrcode']
+        @ref_id = data['ref_id']
+      end
+    end
+
+    def self.create_share_url_endpoint
+      "/qrcodes/apps/#{Yoti.configuration.client_sdk_id}"
+    end
+
+    def self.create_share_url_query
+      "?nonce=#{SecureRandom.uuid}&timestamp=#{Time.now.to_i}"
+    end
+
+    def self.create_share_url(scenario)
+      endpoint = "#{create_share_url_endpoint}#{create_share_url_query}"
+      uri = URI("#{Yoti.configuration.api_endpoint}#{endpoint}")
+
+      unsigned = Net::HTTP::Post.new uri
+      unsigned.body = scenario.to_json
+
+      signed_request = Yoti::SignedRequest.new(
+        unsigned,
+        endpoint,
+        scenario
+      ).sign
+
+      response = Net::HTTP.start(
+        uri.hostname,
+        uri.port,
+        use_ssl: true
+      ) do |http|
+        http.request signed_request
+      end
+
+      create_share_url_parse_response response
+    end
+
+    def self.create_share_url_parse_response(response)
+      if response.code.to_i < 200 || response.code.to_i >= 300
+        case response.code
+        when '400'
+          raise InvalidDataError
+        when '404'
+          raise ApplicationNotFoundError
+        else
+          raise UnknownHTTPError, response.code
+        end
+      end
+
+      Share.new JSON.parse response.body
+    end
+
+    class InvalidDataError < StandardError
+      def initialize(msg = 'JSON is incorrect, contains invalid data')
+        super
+      end
+    end
+
+    class ApplicationNotFoundError < StandardError
+      def initialize(msg = 'Application was not found')
+        super
+      end
+    end
+
+    class UnknownHTTPError < StandardError
+      def initialize(code = nil, msg = 'Unknown HTTP Error')
+        msg = "#{msg}: #{code}" unless code.nil?
+        super msg
+      end
+    end
+  end
+end

data/lib/yoti/http/profile_request.rb

@@ -15,6 +15,7 @@ module Yoti
 
     def request
       yoti_request = Yoti::Request.new
+      yoti_request.add_header('X-Yoti-Auth-Key', Yoti::SSL.auth_key_from_pem)
       yoti_request.encrypted_connect_token = @encrypted_connect_token
       yoti_request.http_method = 'GET'
       yoti_request.endpoint = 'profile'

data/lib/yoti/http/request.rb

@@ -14,6 +14,15 @@ module Yoti
     # @return [Hash] the body sent with the request
     attr_accessor :payload
 
+    def initialize
+      @headers = {}
+    end
+
+    # Adds a HTTP header to the request
+    def add_header(header, value)
+      @headers[header] = value
+    end
+
     # Makes a HTTP request after signing the headers
     # @return [Hash] the body from the HTTP request
     def body
@@ -51,6 +60,10 @@ module Yoti
         raise RequestError, "Request method not allowed: #{@http_method}"
       end
 
+      @headers.each do |header, value|
+        http_req[header] = value
+      end
+
       http_req
     end
 

data/lib/yoti/http/signed_request.rb

@@ -11,12 +11,9 @@ module Yoti
     end
 
     def sign
-      @http_req['X-Yoti-Auth-Key'] = @auth_key
       @http_req['X-Yoti-Auth-Digest'] = message_signature
       @http_req['X-Yoti-SDK'] = Yoti.configuration.sdk_identifier
       @http_req['X-Yoti-SDK-Version'] = "#{Yoti.configuration.sdk_identifier}-#{Yoti::VERSION}"
-      @http_req['Content-Type'] = 'application/json'
-      @http_req['Accept'] = 'application/json'
       @http_req
     end
 

data/lib/yoti/protobuf/main.rb

@@ -6,6 +6,9 @@ require 'json'
 require_relative 'attrpubapi/List_pb.rb'
 require_relative 'compubapi/EncryptedData_pb.rb'
 require_relative 'compubapi/SignedTimestamp_pb.rb'
+require_relative 'sharepubapi/ExtraData_pb.rb'
+require_relative 'sharepubapi/IssuingAttributes_pb.rb'
+require_relative 'sharepubapi/ThirdPartyAttribute_pb.rb'
 
 module Yoti
   module Protobuf
@@ -40,12 +43,20 @@ module Yoti
         decipher_profile(receipt['profile_content'], receipt['wrapped_receipt_key'])
       end
 
+      def extra_data(receipt)
+        return nil unless valid_receipt?(receipt)
+
+        decipher_profile(receipt['extra_data'], receipt['wrapped_receipt_key']) if receipt['extra_data']
+      end
+
       def attribute_list(data)
         Yoti::Protobuf::Attrpubapi::AttributeList.decode(data)
       end
 
       def value_based_on_attribute_name(value, attr_name)
         case attr_name
+        when Yoti::Attribute::DOCUMENT_DETAILS
+          Yoti::DocumentDetails.new(value)
         when Yoti::Attribute::DOCUMENT_IMAGES
           raise(TypeError, 'Document Images could not be decoded') unless value.is_a?(Yoti::MultiValue)
 

data/lib/yoti/protobuf/sharepubapi/DataEntry_pb.rb

@@ -0,0 +1,29 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: DataEntry.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "sharepubapi_v1.DataEntry" do
+    optional :type, :enum, 1, "sharepubapi_v1.DataEntry.Type"
+    optional :value, :bytes, 2
+  end
+  add_enum "sharepubapi_v1.DataEntry.Type" do
+    value :UNDEFINED, 0
+    value :INVOICE, 1
+    value :PAYMENT_TRANSACTION, 2
+    value :LOCATION, 3
+    value :TRANSACTION, 4
+    value :AGE_VERIFICATION_SECRET, 5
+    value :THIRD_PARTY_ATTRIBUTE, 6
+  end
+end
+
+module Yoti
+  module Protobuf
+    module Sharepubapi
+      DataEntry = Google::Protobuf::DescriptorPool.generated_pool.lookup("sharepubapi_v1.DataEntry").msgclass
+      DataEntry::Type = Google::Protobuf::DescriptorPool.generated_pool.lookup("sharepubapi_v1.DataEntry.Type").enummodule
+    end
+  end
+end

data/lib/yoti/protobuf/sharepubapi/ExtraData_pb.rb

@@ -0,0 +1,19 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: ExtraData.proto
+
+require 'google/protobuf'
+
+require_relative 'DataEntry_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "sharepubapi_v1.ExtraData" do
+    repeated :list, :message, 1, "sharepubapi_v1.DataEntry"
+  end
+end
+
+module Yoti
+  module Protobuf
+    module Sharepubapi
+      ExtraData = Google::Protobuf::DescriptorPool.generated_pool.lookup("sharepubapi_v1.ExtraData").msgclass
+    end
+  end
+end

data/lib/yoti/protobuf/sharepubapi/IssuingAttributes_pb.rb

@@ -0,0 +1,23 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: IssuingAttributes.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "sharepubapi_v1.IssuingAttributes" do
+    optional :expiry_date, :string, 1
+    repeated :definitions, :message, 2, "sharepubapi_v1.Definition"
+  end
+  add_message "sharepubapi_v1.Definition" do
+    optional :name, :string, 1
+  end
+end
+
+module Yoti
+  module Protobuf
+    module Sharepubapi
+      IssuingAttributes = Google::Protobuf::DescriptorPool.generated_pool.lookup("sharepubapi_v1.IssuingAttributes").msgclass
+      Definition = Google::Protobuf::DescriptorPool.generated_pool.lookup("sharepubapi_v1.Definition").msgclass
+    end
+  end
+end

data/lib/yoti/protobuf/sharepubapi/ThirdPartyAttribute_pb.rb

@@ -0,0 +1,20 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: ThirdPartyAttribute.proto
+
+require 'google/protobuf'
+
+require_relative 'IssuingAttributes_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "sharepubapi_v1.ThirdPartyAttribute" do
+    optional :issuance_token, :bytes, 1
+    optional :issuing_attributes, :message, 2, "sharepubapi_v1.IssuingAttributes"
+  end
+end
+
+module Yoti
+  module Protobuf
+    module Sharepubapi
+      ThirdPartyAttribute = Google::Protobuf::DescriptorPool.generated_pool.lookup("sharepubapi_v1.ThirdPartyAttribute").msgclass
+    end
+  end
+end

data/lib/yoti/sandbox.rb

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,49 @@
+# 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