incognia_api 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c92b64976c39bcd601a9a7aa6901c28a3ea41e773389e23274985372b261d45
-  data.tar.gz: 21c4bd2fc41170a8ab1d1962a2dc7be6c5fcbb7a52257743a2033af79662f16c
+  metadata.gz: f17e031979fde13ac3ac30d9cc3ebf9369da407eef0aec67e0313dcfa9c1ecd3
+  data.tar.gz: ecbd6959f1546fa24d5d85d5f7e95e8980539ab2fddca46838e46076571bc8b4
 SHA512:
-  metadata.gz: 35919782b5b8f3182fb9130cf4c7c89c2f0f2b998c884ec173f8bbc41edded16885c3ce5a76fe0673a4eb675ba3ad1909ec087479bad85db7e25280cdedccca4
-  data.tar.gz: b23238db561ec59ce3992944c5311f3b712362d7294b02510e85eb15eb6f8514443a9bdab96039ceead59e58052d3cd0de72912ef78d0681674d7d6108d429c1
+  metadata.gz: 0f9945bb733db1fb2015636f85b3342684635a027ff70d8bd493887365085b893877ca4ea77d3f8c4e937cccfd2c4cf580bcf8223505bbfdebf5b61ada4684fe
+  data.tar.gz: 4f85f0ab80d4f9ca47509a6ff9edf78514990de7d0d25a3cd6c8e2a90fdbc904516d554189ad29651aae120b20ee5afe61e7ecfa80bb3f0b511c0882664d0cdb

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [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
+
 ## [1.0.0] - 2024-07-05
 
 - Remove #get_signup_assessment, because the endpoint was discontinued

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    incognia_api (1.0.0)
+    incognia_api (1.2.0)
       faraday (~> 1.10)
       faraday_middleware (~> 1.2)
 

data/README.md

@@ -49,14 +49,14 @@ For sandbox credentials, refer to the [API testing guide]().
 
 ### 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,
+  request_token: request_token,
   address: address
 )
 
@@ -68,11 +68,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,
+  request_token: request_token,
   address: address,
   external_id: external_id
 )
@@ -82,14 +82,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,
+  request_token: request_token,
   account_id: account_id,
 )
 
@@ -100,12 +100,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,
+  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 +116,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',
+  request_token: 'request-token',
   account_id: 'account-id'
 )
 
@@ -181,7 +181,7 @@ payment_methods = [
 ]
 
 assessment = api.register_payment(
-  installation_id: 'installation-id',
+  request_token: 'request-token',
   account_id: 'account-id',
   external_id: 'external-id',
   addresses: addresses,
@@ -202,12 +202,14 @@ The `expires_at` argument should be a _Time_, _DateTime_ or an date in **RFC 333
 
 
 ```ruby
-account_id = "cdb2cfbb-8ad8-4668-b276-5fff9bbfdc96"
-timestamp = DateTime.parse('2022-06-20 23:29:00 UTC-3')
+request_token = 'request-token'
+account_id = 'account-id'
+occurred_at = DateTime.parse('2024-07-22T15:20:00Z')
 
 success = api.register_feedback(
-  event: Incognia::Constants::FeedbackEvent::IDENTITY_FRAUD,
-  timestamp: timestamp,
+  event: Incognia::Constants::FeedbackEvent::ACCOUNT_TAKEOVER,
+  occurred_at: occurred_at,
+  request_token: request_token,
   account_id: account_id
 )
 
@@ -219,9 +221,9 @@ For custom fraud, set the value of `event` with the corresponding code:
 ```ruby
 success = api.register_feedback(
   event: 'custom_fraud_name',
-  timestamp: timestamp,
-  account_id: account_id,
-  installation_id: installation_id
+  occurred_at: occurred_at,
+  request_token: request_token,
+  account_id: account_id
 )
 
 # => true

data/lib/incognia_api/api.rb

@@ -15,8 +15,8 @@ module Incognia
                                host: "https://api.incognia.com/api")
     end
 
-    def register_signup(installation_id:, address: nil, **opts)
-      params = { installation_id: installation_id }
+    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
 
@@ -29,12 +29,12 @@ module Incognia
       SignupAssessment.from_hash(response.body) if response.success?
     end
 
-    def register_login(installation_id:, account_id:, **opts)
+    def register_login(account_id:, request_token: nil, **opts)
       params = {
         type: :login,
-        installation_id: installation_id,
         account_id: account_id,
-      }
+        request_token: request_token
+      }.compact
       params.merge!(opts)
 
       response = connection.request(
@@ -46,11 +46,16 @@ module Incognia
       LoginAssessment.from_hash(response.body) if response.success?
     end
 
-    def register_feedback(event:, timestamp: nil, expires_at: nil, **ids)
+    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
+
       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
 
-      params = { event: event, timestamp: timestamp&.to_i, expires_at: expires_at }.compact
+      params = { event: event, timestamp: timestamp&.to_i, occurred_at: occurred_at, expires_at: expires_at }.compact
       params.merge!(ids)
 
       response = connection.request(
@@ -62,8 +67,12 @@ module Incognia
       response.success?
     end
 
-    def register_payment(installation_id:, account_id:, **opts)
-      params = { installation_id: installation_id, account_id: account_id, type: :payment }
+    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(

data/lib/incognia_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Incognia
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: incognia_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Guilherme Cavalcanti
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2024-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Official Ruby lib for communicating with Incognia API