yoti 1.6.4 → 1.10.0

data/lib/yoti/dynamic_share_service/dynamic_scenario.rb

@@ -4,8 +4,13 @@ module Yoti
   module DynamicSharingService
     # Describes a dynamic share
     class DynamicScenario
+      # @return [Yoti::DynamicSharingService::DynamicPolicy]
       attr_reader :policy
+
+      # @return [Array<Yoti::DynamicSharingService::Extension>]
       attr_reader :extensions
+
+      # @return [String]
       attr_reader :callback_endpoint
 
       def initialize

data/lib/yoti/dynamic_share_service/extension/extension.rb

@@ -3,7 +3,10 @@
 module Yoti
   module DynamicSharingService
     class Extension
+      # @return [String]
       attr_reader :type
+
+      # @return [#to_json]
       attr_reader :content
 
       def to_json(*_args)

data/lib/yoti/dynamic_share_service/extension/location_constraint_extension.rb

@@ -6,7 +6,10 @@ module Yoti
     class LocationConstraintExtension
       EXTENSION_TYPE = 'LOCATION_CONSTRAINT'
 
+      # @return [#to_json]
       attr_reader :content
+
+      # @return [String]
       attr_reader :type
 
       def initialize

data/lib/yoti/dynamic_share_service/extension/thirdparty_attribute_extension.rb

@@ -38,7 +38,7 @@ module Yoti
       end
 
       #
-      # @param [String] *names
+      # @param [String] names
       #
       # @return [self]
       #

data/lib/yoti/dynamic_share_service/extension/transactional_flow_extension.rb

@@ -5,7 +5,11 @@ module Yoti
     # Extension for transactional flows
     class TransactionalFlowExtension
       EXTENSION_TYPE = 'TRANSACTIONAL_FLOW'
+
+      # @return [#to_json]
       attr_reader :content
+
+      # @return [String]
       attr_reader :type
 
       def initialize

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

@@ -7,7 +7,10 @@ module Yoti
       SELFIE_AUTH_TYPE = 1
       PIN_AUTH_TYPE = 2
 
+      # @return [Array<Integer>]
       attr_reader :wanted_auth_types
+
+      # @return [Array<Yoti::DynamicSharingService::WantedAttribute>]
       attr_reader :wanted
 
       def wanted_remember_me
@@ -16,8 +19,8 @@ module Yoti
         false
       end
 
-      def to_json(*args)
-        as_json.to_json(*args)
+      def to_json(*_args)
+        as_json.to_json
       end
 
       def as_json(*_args)
@@ -93,36 +96,54 @@ module Yoti
 
       #
       # @param [String] name
-      # @param [Hash] constraints
+      # @param [Array<SourceConstraint>] constraints
+      # @param [Bool] accept_self_asserted
       #
-      def with_wanted_attribute_by_name(name, constraints: nil)
+      def with_wanted_attribute_by_name(name, constraints: nil, accept_self_asserted: nil)
         attribute_builder = WantedAttribute.builder.with_name(name)
         constraints&.each do |constraint|
           attribute_builder.with_constraint constraint
         end
+        attribute_builder.with_accept_self_asserted(accept_self_asserted) unless accept_self_asserted.nil?
         attribute = attribute_builder.build
         with_wanted_attribute attribute
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_family_name(options = {})
         with_wanted_attribute_by_name Attribute::FAMILY_NAME, **options
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_given_names(options = {})
         with_wanted_attribute_by_name Attribute::GIVEN_NAMES, **options
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_full_name(options = {})
         with_wanted_attribute_by_name Attribute::FULL_NAME, **options
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_date_of_birth(options = {})
         with_wanted_attribute_by_name Attribute::DATE_OF_BIRTH, **options
       end
 
       #
       # @param [String] derivation
-      # @param [Hash] constraints
+      # @param [Array<SourceConstraint>] constraints
       #
       def with_age_derived_attribute(derivation, constraints: nil)
         attribute_builder = WantedAttribute.builder
@@ -135,49 +156,93 @@ module Yoti
       end
 
       #
-      # @param [Integer] derivation
+      # @param [Integer] age
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
       #
       def with_age_over(age, options = {})
         with_age_derived_attribute(Attribute::AGE_OVER + age.to_s, **options)
       end
 
       #
-      # @param [Integer] derivation
+      # @param [Integer] age
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
       #
       def with_age_under(age, options = {})
         with_age_derived_attribute(Attribute::AGE_UNDER + age.to_s, **options)
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_gender(options = {})
         with_wanted_attribute_by_name Attribute::GENDER, **options
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_postal_address(options = {})
         with_wanted_attribute_by_name(Attribute::POSTAL_ADDRESS, **options)
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_structured_postal_address(options = {})
         with_wanted_attribute_by_name(Attribute::STRUCTURED_POSTAL_ADDRESS, **options)
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_nationality(options = {})
         with_wanted_attribute_by_name(Attribute::NATIONALITY, **options)
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_phone_number(options = {})
         with_wanted_attribute_by_name(Attribute::PHONE_NUMBER, **options)
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_selfie(options = {})
         with_wanted_attribute_by_name(Attribute::SELFIE, **options)
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_email(options = {})
         with_wanted_attribute_by_name(Attribute::EMAIL_ADDRESS, **options)
       end
 
-      def with_document_details
-        with_wanted_attribute_by_name(Attribute::DOCUMENT_DETAILS)
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
+      def with_document_details(options = {})
+        with_wanted_attribute_by_name(Attribute::DOCUMENT_DETAILS, **options)
+      end
+
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
+      def with_document_images(options = {})
+        with_wanted_attribute_by_name(Attribute::DOCUMENT_IMAGES, **options)
       end
     end
   end

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

@@ -4,7 +4,10 @@ module Yoti
   module DynamicSharingService
     # A wanted anchor for a source based constraint
     class WantedAnchor
+      # @return [String]
       attr_reader :value
+
+      # @return [String]
       attr_reader :sub_type
 
       def initialize

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

@@ -4,8 +4,13 @@ module Yoti
   module DynamicSharingService
     # Describes a wanted attribute in a dynamic sharing policy
     class WantedAttribute
+      # @return [String]
       attr_reader :name
+
+      # @return [String]
       attr_reader :derivation
+
+      # @return [Array<#as_json>]
       attr_reader :constraints
 
       def initialize

data/lib/yoti/dynamic_share_service/share_url.rb

@@ -13,50 +13,33 @@ module Yoti
       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
+      yoti_request = Yoti::Request
+                     .builder
+                     .with_http_method('POST')
+                     .with_base_url(Yoti.configuration.api_endpoint)
+                     .with_endpoint("qrcodes/apps/#{Yoti.configuration.client_sdk_id}")
+                     .with_query_param('appId', Yoti.configuration.client_sdk_id)
+                     .with_payload(scenario)
+                     .build
 
-      create_share_url_parse_response response
-    end
+      begin
+        create_share_url_parse_response yoti_request.execute
+      rescue Yoti::RequestError => e
+        raise if e.response.nil?
 
-    def self.create_share_url_parse_response(response)
-      if response.code.to_i < 200 || response.code.to_i >= 300
-        case response.code
+        case e.response.code
         when '400'
           raise InvalidDataError
         when '404'
           raise ApplicationNotFoundError
         else
-          raise UnknownHTTPError, response.code
+          raise UnknownHTTPError, e.response.code
         end
       end
+    end
 
+    def self.create_share_url_parse_response(response)
       Share.new JSON.parse response.body
     end
 
@@ -78,5 +61,15 @@ module Yoti
         super msg
       end
     end
+
+    # @deprecated no longer used - will be removed in 2.0.0
+    def self.create_share_url_query
+      "?nonce=#{SecureRandom.uuid}&timestamp=#{Time.now.to_i}"
+    end
+
+    # @deprecated no longer used - will be removed in 2.0.0
+    def self.create_share_url_endpoint
+      "/qrcodes/apps/#{Yoti.configuration.client_sdk_id}"
+    end
   end
 end

data/lib/yoti/errors.rb

@@ -3,12 +3,25 @@ module Yoti
   class ProtobufError < StandardError; end
 
   # Raises exceptions related to API requests
-  class RequestError < StandardError; end
+  class RequestError < StandardError
+    attr_reader :response
+
+    def initialize(message, response = nil)
+      super(message)
+      @response = response
+    end
+
+    def message
+      return super if @response.nil? || @response.body.empty?
+
+      "#{super}: #{@response.body}"
+    end
+  end
 
   # Raises exceptions related to OpenSSL actions
   class SslError < StandardError; end
 
-  # Raises exceptions realted to an incorrect gem configuration value
+  # Raises exceptions related to an incorrect gem configuration value
   class ConfigurationError < StandardError; end
 
   # Raises exceptions related to AML actions

data/lib/yoti/http/aml_check_request.rb

@@ -1,13 +1,16 @@
 module Yoti
   # Manage the API's AML check requests
   class AmlCheckRequest
+    #
+    # @param [AmlProfile] aml_profile
+    #
     def initialize(aml_profile)
       @aml_profile = aml_profile
       @payload = aml_profile.payload
       @request = request
     end
 
-    # @return [String] a JSON representation of the AML check response
+    # @return [Hash] a JSON representation of the AML check response
     def response
       JSON.parse(@request.body)
     end
@@ -15,11 +18,14 @@ module Yoti
     private
 
     def request
-      yoti_request = Yoti::Request.new
-      yoti_request.http_method = 'POST'
-      yoti_request.endpoint = 'aml-check'
-      yoti_request.payload = @payload
-      yoti_request
+      Yoti::Request
+        .builder
+        .with_http_method('POST')
+        .with_base_url(Yoti.configuration.api_endpoint)
+        .with_endpoint('aml-check')
+        .with_query_param('appId', Yoti.configuration.client_sdk_id)
+        .with_payload(@payload)
+        .build
     end
   end
 end

data/lib/yoti/http/payloads/aml_address.rb

@@ -7,6 +7,10 @@ module Yoti
     # @return [String] the postcode required for USA, optional otherwise
     attr_accessor :post_code
 
+    #
+    # @param [String] country
+    # @param [String] post_code
+    #
     def initialize(country, post_code = nil)
       raise AmlError, 'AmlAddress requires a country.' if country.to_s.empty?
 

data/lib/yoti/http/payloads/aml_profile.rb

@@ -1,6 +1,12 @@
 module Yoti
   # Manages the AML check Profile object
   class AmlProfile
+    #
+    # @param [String] given_names
+    # @param [String] family_name
+    # @param [AmlAddress] aml_address
+    # @param [String] ssn
+    #
     def initialize(given_names, family_name, aml_address, ssn = nil)
       @given_names = given_names
       @family_name = family_name
@@ -11,7 +17,7 @@ module Yoti
       raise AmlError, 'Request for USA require a valid SSN and postcode.' if usa_invalid
     end
 
-    # @return [Object] the AML check request body
+    # @return [Hash] the AML check request body
     def payload
       {
         given_names: @given_names,

data/lib/yoti/http/profile_request.rb

@@ -1,6 +1,9 @@
 module Yoti
   # Manage the API's profile requests
   class ProfileRequest
+    #
+    # @param [String] encrypted_connect_token
+    #
     def initialize(encrypted_connect_token)
       @encrypted_connect_token = encrypted_connect_token
       @request = request
@@ -14,12 +17,14 @@ module Yoti
     private
 
     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'
-      yoti_request
+      Yoti::Request
+        .builder
+        .with_http_method('GET')
+        .with_base_url(Yoti.configuration.api_endpoint)
+        .with_endpoint("profile/#{Yoti::SSL.decrypt_token(@encrypted_connect_token)}")
+        .with_query_param('appId', Yoti.configuration.client_sdk_id)
+        .with_header('X-Yoti-Auth-Key', Yoti::SSL.auth_key_from_pem)
+        .build
     end
   end
 end