Merge branch 'feat/remove_api_instance' into fix-feedback-remove-inva…

…lid-types
inloco · Oct 30, 2024 · 99c3df6 · 99c3df6
2 parents 14b9120 + 09e6e34
commit 99c3df6
Show file tree

Hide file tree

Showing 10 changed files with 369 additions and 230 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [1.3.0] - 2024-10-30
+
+- Add support for general configuration and use Incognia::Api as a static class
+
+## [1.2.0] - 2024-08-26
+
+- Removes the requirement to send installation id to register signup, login and payment
+
 ## [1.1.0] - 2024-07-24
 
 - Add support to passing request_token and occurred_at to #register_feedback

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    incognia_api (1.1.0)
+    incognia_api (1.3.0)
       faraday (~> 1.10)
       faraday_middleware (~> 1.2)
 

diff --git a/README.md b/README.md
@@ -35,28 +35,30 @@ Or install it yourself as:
 
 ### Configuration
 
-Before using the API client, you must initialize it using credentials obtained
-from the [Incognia dashboard]():
+Before using the API client, you must configure it using credentials obtained
+from the [Incognia dashboard](https://dash.incognia.com/):
 
 ```ruby
-api = Incognia::Api.new(client_id: "your-client-id", client_secret:
-"your-client-secret")
+Incognia.configure(client_id: ENV['INCOGNIA_CLIENT_ID'], client_secret: ENV['INCOGNIA_CLIENT_SECRET'])
 
+# Incognia.configure(client_id: "your-client-id", client_secret: "your-client-secret")
 ```
 
-For sandbox credentials, refer to the [API testing guide]().
+For sandbox credentials, refer to the [API testing guide](https://developer.incognia.com/).
+
+:bulb: For Rails applications it's recommended to create an initializer file, for example `config/initializers/incognia.rb`.
 
 
 ### Registering a Signup
 
-This method registers a new signup for the given installation and address, returning a signup assessment, containing the risk assessment and supporting evidence:
+This method registers a new signup for the given request token and address, returning a signup assessment, containing the risk assessment and supporting evidence:
 
 ```ruby
 address = Incognia::Address.new(line: "West 34th Street, New York City, NY 10001")
-installation_id = "WlMksW+jh5GPhqWBorsV8yDihoSHHpmt+DpjJ7eYxpHhuO/5tuHTuA..."
+request_token = "WlMksW+jh5GPhqWBorsV8yDihoSHHpmt+DpjJ7eYxpHhuO/5tuHTuA..."
 
-assessment = api.register_signup(
-  installation_id: installation_id,
+assessment = Incognia::Api.register_signup(
+  request_token: request_token,
   address: address
 )
 
@@ -68,11 +70,11 @@ It also supports optional parameters, for example:
 
 ```ruby
 address = Incognia::Address.new(line: "West 34th Street, New York City, NY 10001")
-installation_id = "WlMksW+jh5GPhqWBorsV8yDihoSHHpmt+DpjJ7eYxpHhuO/5tuHTuA..."
+request_token = "WlMksW+jh5GPhqWBorsV8yDihoSHHpmt+DpjJ7eYxpHhuO/5tuHTuA..."
 external_id = "7b02736a-7718-4b83-8982-f68fb6f501fa"
 
-assessment = api.register_signup(
-  installation_id: installation_id,
+assessment = Incognia::Api.register_signup(
+  request_token: request_token,
   address: address,
   external_id: external_id
 )
@@ -82,14 +84,14 @@ assessment = api.register_signup(
 
 ### Registering a Login
 
-This method registers a new login for the given installation and account, returning a login assessment, containing the risk assessment and supporting evidence:
+This method registers a new login for the given request token and account, returning a login assessment, containing the risk assessment and supporting evidence:
 
 ```ruby
-installation_id = "WlMksW+jh5GPhqWBorsV8yDihoSHHpmt+DpjJ7eYxpHhuO/5tuHTuA..."
+request_token = "WlMksW+jh5GPhqWBorsV8yDihoSHHpmt+DpjJ7eYxpHhuO/5tuHTuA..."
 account_id = 'account-identifier-123'
 
-assessment = api.register_login(
-  installation_id: installation_id,
+assessment = Incognia::Api.register_login(
+  request_token: request_token,
   account_id: account_id,
 )
 
@@ -100,12 +102,12 @@ assessment = api.register_login(
 It also supports optional parameters, for example:
 
 ```ruby
-installation_id = "WlMksW+jh5GPhqWBorsV8yDihoSHHpmt+DpjJ7eYxpHhuO/5tuHTuA..."
+request_token = "WlMksW+jh5GPhqWBorsV8yDihoSHHpmt+DpjJ7eYxpHhuO/5tuHTuA..."
 account_id = 'account-identifier-123'
 external_id = 'some-external-identifier'
 
-assessment = api.register_login(
-  installation_id: installation_id,
+assessment = Incognia::Api.register_login(
+  request_token: request_token,
   account_id: account_id,
   external_id: external_id,
   eval: false # can be used to register a new login without evaluating it
@@ -116,12 +118,12 @@ assessment = api.register_login(
 
 ### Registering Payment
 
-This method registers a new payment for the given installation and account, returning a `hash`,
+This method registers a new payment for the given request token and account, returning a `hash`,
 containing the risk assessment and supporting evidence.
 
 ```ruby
-assessment = api.register_payment(
-  installation_id: 'installation-id',
+assessment = Incognia::Api.register_payment(
+  request_token: 'request-token',
   account_id: 'account-id'
 )
 
@@ -180,8 +182,8 @@ payment_methods = [
   }
 ]
 
-assessment = api.register_payment(
-  installation_id: 'installation-id',
+assessment = Incognia::Api.register_payment(
+  request_token: 'request-token',
   account_id: 'account-id',
   external_id: 'external-id',
   addresses: addresses,
@@ -202,14 +204,14 @@ The `expires_at` argument should be a _Time_, _DateTime_ or an date in **RFC 333
 
 
 ```ruby
-installation_id = 'installation-id'
+request_token = 'request-token'
 account_id = 'account-id'
 occurred_at = DateTime.parse('2024-07-22T15:20:00Z')
 
-success = api.register_feedback(
+success = Incognia::Api.register_feedback(
   event: Incognia::Constants::FeedbackEvent::ACCOUNT_TAKEOVER,
   occurred_at: occurred_at,
-  installation_id: installation_id,
+  request_token: request_token,
   account_id: account_id
 )
 
@@ -219,10 +221,10 @@ success = api.register_feedback(
 For custom fraud, set the value of `event` with the corresponding code:
 
 ```ruby
-success = api.register_feedback(
+success = Incognia::Api.register_feedback(
   event: 'custom_fraud_name',
   occurred_at: occurred_at,
-  installation_id: installation_id,
+  request_token: request_token,
   account_id: account_id
 )
 

diff --git a/lib/incognia_api.rb b/lib/incognia_api.rb
@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "incognia_api/configuration"
 require_relative "incognia_api/version"
 require_relative "incognia_api/client"
 require_relative "incognia_api/util"
@@ -15,6 +16,14 @@
 require_relative "incognia_api/constants/feedback_event"
 
 module Incognia
+  def self.configure(**args)
+    config.configure(**args)
+  end
+
+  def self.config
+    Configuration.instance
+  end
+
   class APIError < StandardError
     attr_reader :message, :errors, :status
 

diff --git a/lib/incognia_api/api.rb b/lib/incognia_api/api.rb
@@ -5,79 +5,82 @@
 
 module Incognia
   class Api
-    # business layer: uses the Client to build domain objects
-    # raises missing parameters errors
-    attr_accessor :connection
-
-    def initialize(client_id:, client_secret:)
-      @connection = Client.new(client_id: client_id,
-                               client_secret: client_secret,
-                               host: "https://api.incognia.com/api")
-    end
-
-    def register_signup(installation_id:, address: nil, **opts)
-      params = { installation_id: installation_id }
-      params.merge!(opts)
-      params.merge!(address&.to_hash) if address
-
-      response = connection.request(
-        :post,
-        'v2/onboarding/signups',
-        params
-      )
-
-      SignupAssessment.from_hash(response.body) if response.success?
-    end
-
-    def register_login(installation_id:, account_id:, **opts)
-      params = {
-        type: :login,
-        installation_id: installation_id,
-        account_id: account_id,
-      }
-      params.merge!(opts)
-
-      response = connection.request(
-        :post,
-        'v2/authentication/transactions',
-        params
-      )
-
-      LoginAssessment.from_hash(response.body) if response.success?
-    end
+    class << self
+      # business layer: uses the Client.instance to build domain objects
+      # raises missing parameters errors
+
+      def register_signup(request_token: nil, address: nil, **opts)
+        params = { request_token: request_token }.compact
+        params.merge!(opts)
+        params.merge!(address&.to_hash) if address
+
+        response = connection.request(
+          :post,
+          'v2/onboarding/signups',
+          params
+        )
+
+        SignupAssessment.from_hash(response.body) if response.success?
+      end
 
-    def register_feedback(event:, occurred_at: nil, expires_at: nil, timestamp: nil, **ids)
-      if !timestamp.nil?
-        warn("Deprecation warning: use occurred_at instead of timestamp")
+      def register_login(account_id:, request_token: nil, **opts)
+        params = {
+          type: :login,
+          account_id: account_id,
+          request_token: request_token
+        }.compact
+        params.merge!(opts)
+
+        response = connection.request(
+          :post,
+          'v2/authentication/transactions',
+          params
+        )
+
+        LoginAssessment.from_hash(response.body) if response.success?
       end
 
-      timestamp = timestamp.strftime('%s%L') if timestamp.respond_to? :strftime
-      occurred_at = occurred_at.to_datetime.rfc3339 if occurred_at.respond_to? :to_datetime
-      expires_at = expires_at.to_datetime.rfc3339 if expires_at.respond_to? :to_datetime
+      def register_feedback(event:, occurred_at: nil, expires_at: nil, timestamp: nil, **ids)
+        if !timestamp.nil?
+          warn("Deprecation warning: use occurred_at instead of timestamp")
+        end
 
-      params = { event: event, timestamp: timestamp&.to_i, occurred_at: occurred_at, expires_at: expires_at }.compact
-      params.merge!(ids)
+        timestamp = timestamp.strftime('%s%L') if timestamp.respond_to? :strftime
+        occurred_at = occurred_at.to_datetime.rfc3339 if occurred_at.respond_to? :to_datetime
+        expires_at = expires_at.to_datetime.rfc3339 if expires_at.respond_to? :to_datetime
 
-      response = connection.request(
-        :post,
-        '/api/v2/feedbacks',
-        params
-      )
+        params = { event: event, timestamp: timestamp&.to_i, occurred_at: occurred_at, expires_at: expires_at }.compact
+        params.merge!(ids)
 
-      response.success?
-    end
+        response = connection.request(
+          :post,
+          '/api/v2/feedbacks',
+          params
+        )
 
-    def register_payment(installation_id:, account_id:, **opts)
-      params = { installation_id: installation_id, account_id: account_id, type: :payment }
-      params.merge!(opts)
+        response.success?
+      end
 
-      response = connection.request(
-        :post,
-        'v2/authentication/transactions',
-        params
-      )
+      def register_payment(account_id:, request_token: nil, **opts)
+        params = {
+          type: :payment,
+          account_id: account_id,
+          request_token: request_token
+        }.compact
+        params.merge!(opts)
+
+        response = connection.request(
+          :post,
+          'v2/authentication/transactions',
+          params
+        )
+
+        PaymentAssessment.from_hash(response.body) if response.success?
+      end
 
-      PaymentAssessment.from_hash(response.body) if response.success?
+      def connection
+        Client.instance
+      end
     end
   end
 end