onfido 6.1.0 → 6.3.0

data/lib/onfido/api_client.rb

@@ -35,7 +35,7 @@ module Onfido
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "onfido-ruby/6.1.0"
+      @user_agent = "onfido-ruby/6.3.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -142,7 +142,11 @@ module Onfido
         form_params.each do |key, value|
           case value
           when ::File, ::Tempfile
-            data[key] = Faraday::FilePart.new(value.path, Marcel::MimeType.for(Pathname.new(value.path)))
+            mime = Marcel::MimeType.for(Pathname.new(value.path))
+            if mime == 'application/octet-stream'
+              mime = Marcel::MimeType.for(extension: File.extname(value.path).delete_prefix('.')) || mime
+            end
+            data[key] = Faraday::FilePart.new(value.path, mime)
           when ::Array, nil
             # let Faraday handle Array and nil parameters
             data[key] = value

data/lib/onfido/configuration.rb

@@ -10,6 +10,8 @@ Generator version: 7.16.0
 =end
 
 require 'faraday/follow_redirects'
+require 'uri'
+require 'json'
 
 module Onfido
   class Configuration
@@ -74,6 +76,14 @@ module Onfido
     # @return [Proc]
     attr_accessor :access_token_getter
 
+    # Defines the OAuth2 client ID for client credentials flow.
+    # @return [String]
+    attr_accessor :oauth_client_id
+
+    # Defines the OAuth2 client secret for client credentials flow.
+    # @return [String]
+    attr_accessor :oauth_client_secret
+
     # Set this to return data as binary instead of downloading a temp file. When enabled (set to true)
     # HTTP responses with return type `File` will be returned as a stream of binary data.
     # Default to false.
@@ -188,6 +198,7 @@ module Onfido
       @ignore_operation_servers = false
       @inject_format = false
       @force_ending_format = false
+      @oauth_mutex = Mutex.new 
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
 
       use( Faraday::FollowRedirects::Middleware ) 
@@ -232,6 +243,7 @@ module Onfido
     end
 
     def api_token=(api_token)
+      raise ArgumentError, 'Cannot set API token when OAuth credentials are already configured' if @oauth_client_id 
       @api_key = {'Token' => "Token token=#{api_token}"}
     end
 
@@ -248,6 +260,64 @@ module Onfido
       @timeout = timeout
     end
 
+    # Sets OAuth2 client credentials for authentication.
+    # The client will automatically exchange credentials for an access token
+    # and refresh it when expired. This is mutually exclusive with api_token.
+    #
+    # @param client_id [String] OAuth2 client ID
+    # @param client_secret [String] OAuth2 client secret
+    def set_oauth_credentials(client_id, client_secret)
+      raise ArgumentError, 'OAuth client ID must not be nil or empty' if client_id.nil? || client_id.empty?
+      raise ArgumentError, 'OAuth client secret must not be nil or empty' if client_secret.nil? || client_secret.empty?
+      raise ArgumentError, 'Cannot set OAuth credentials when API token is already configured' if @api_key&.key?('Token') 
+
+      @oauth_client_id = client_id
+      @oauth_client_secret = client_secret
+      @oauth_access_token = nil
+      @oauth_token_expires_at = nil
+    end
+
+    private
+
+    def fetch_oauth_access_token
+      @oauth_mutex.synchronize do
+        return @oauth_access_token if @oauth_access_token && @oauth_token_expires_at && Time.now.to_f < @oauth_token_expires_at
+
+        conn = Faraday.new(
+          url: base_url,
+          ssl: { ca_file: ssl_ca_file, verify: ssl_verify, verify_mode: ssl_verify_mode,
+                 client_cert: ssl_client_cert, client_key: ssl_client_key },
+          proxy: proxy
+        ) do |f|
+          configure_middleware(f)
+          f.adapter(Faraday.default_adapter)
+          configure_connection(f)
+        end
+
+        response = conn.post('oauth/token') do |req|
+          req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+          req.options.timeout = timeout
+          req.body = URI.encode_www_form(
+            'client_id' => @oauth_client_id,
+            'client_secret' => @oauth_client_secret
+          )
+        end
+
+        unless response.success?
+          raise "OAuth token exchange failed with status #{response.status}: #{response.body}"
+        end
+
+        data = JSON.parse(response.body)
+        @oauth_access_token = data['access_token']
+        expires_in = data['expires_in'].to_i
+        @oauth_token_expires_at = Time.now.to_f + (expires_in - 30)
+
+        @oauth_access_token
+      end
+    end
+
+    public
+
     # Gets API key (with prefix if set).
     # @param [String] param_name the parameter name of API key auth
     def api_key_with_prefix(param_name, param_alias = nil)
@@ -273,6 +343,17 @@ module Onfido
 
     # Returns Auth Settings hash for api client.
     def auth_settings
+      if @oauth_client_id && !@oauth_client_id.empty?
+        return {
+          'Token' =>
+            {
+              type: 'bearer',
+              in: 'header',
+              key: 'Authorization',
+              value: "Bearer #{fetch_oauth_access_token}"
+            },
+        }
+      end
       {
         'Token' =>
           {
@@ -281,6 +362,13 @@ module Onfido
             key: 'Authorization',
             value: api_key_with_prefix('Token')
           },
+        'OAuth2ClientCredentials' =>
+          {
+            type: 'oauth2',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token_with_refresh}"
+          },
       }
     end
 

data/lib/onfido/models/biometric_token.rb

@@ -0,0 +1,265 @@
+=begin
+#Onfido Public API v3.6
+
+#The Onfido Public API (v3.6)
+
+The version of the OpenAPI document: v3.6
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Onfido
+  # Biometric token.
+  class BiometricToken
+    # The biometric token's unique identifier.
+    attr_accessor :uuid
+
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'uuid' => :'uuid',
+        :'data' => :'data'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'uuid' => :'String',
+        :'data' => :'BiometricTokenData'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::BiometricToken` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::BiometricToken`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'uuid')
+        self.uuid = attributes[:'uuid']
+      else
+        self.uuid = nil
+      end
+
+      if attributes.key?(:'data')
+        self.data = attributes[:'data']
+      else
+        self.data = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @uuid.nil?
+        invalid_properties.push('invalid value for "uuid", uuid cannot be nil.')
+      end
+
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @uuid.nil?
+      return false if @data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] uuid Value to be assigned
+    def uuid=(uuid)
+      if uuid.nil?
+        fail ArgumentError, 'uuid cannot be nil'
+      end
+
+      @uuid = uuid
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      @data = data
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          uuid == o.uuid &&
+          data == o.data
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [uuid, data].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Onfido.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end