incognia_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8091ced0819f517cbe35df392b7f51d7943403f0b6053e97226c5dcb91cf7f5d
-  data.tar.gz: 07732b958841e661ab36548eabc14d4f55895fec5997f40b2e7f4c654d746eac
+  metadata.gz: d20f61a585d3f2a6f3ae499a5a32ce1162ce812d6450eaaa3ed2c3107caeff26
+  data.tar.gz: f48d53ed2d2bc99face81e094a0193f8a5e5cb0752b12abaaf1020ae3ca47d4f
 SHA512:
-  metadata.gz: bd76587fcc7ca3edb6cd011cd8df4d8546d60deaf7026cd2de4241ffccfdafbf288c425627cd437385439ea675269e26e84178233444db02def82c2df2871ee1
-  data.tar.gz: 6a65cf592482f88de479b5c60233f592e3bfc1ccfe5982e2fb3f37d56285b76d1f3dda133737c03ae771476192708b117632d8813fe3e08f2dd2647883de71c8
+  metadata.gz: a686efb7675e67313ea627bc22898d37027e07dd7742153ba525e818f36190be57f1a72848f1149d9826b198d419ac48f550f3e22deb5fb5d1801bc345784dca
+  data.tar.gz: 304ee383de088469fc85f5fdb873aeb8650be7c04b0b58c4c6fe37e7f32ae3bf067bfa4726a28f813edc59df3ea7520263478cf08ba927257c3cc4268b351948

data/.github/CODEOWNERS

@@ -1 +1 @@
-* @guiocavalcanti
+* @guiocavalcanti @julianalucena @ottony

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.3.0] - 2022-05-06
+
+- Allow registering feedbacks
+- Allow registering logins
+
 ## [0.2.0] - 2022-05-06
 
 - Allow registering signups without address

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    incognia_api (0.2.0)
+    incognia_api (0.3.0)
       faraday
       faraday_middleware
 

data/README.md

@@ -75,6 +75,74 @@ assessment = api.get_signup_assessment(signup_id: "95a9fc56-f65e-436b-a87f-a1338
 
 ```
 
+### 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:
+
+```ruby
+installation_id = "WlMksW+jh5GPhqWBorsV8yDihoSHHpmt+DpjJ7eYxpHhuO/5tuHTuA..."
+account_id = 'account-identifier-123'
+
+assessment = api.register_login(
+  installation_id: installation_id,
+  account_id: account_id,
+)
+
+# => #<OpenStruct id="...", device_id="...", risk_assessment="..", evidence=...>
+
+```
+
+It also supports optional parameters, for example:
+
+```ruby
+installation_id = "WlMksW+jh5GPhqWBorsV8yDihoSHHpmt+DpjJ7eYxpHhuO/5tuHTuA..."
+account_id = 'account-identifier-123'
+external_id = 'some-external-identifier'
+
+assessment = api.register_login(
+  installation_id: installation_id,
+  account_id: account_id,
+  external_id: external_id,
+  eval: false # can be used to register a new login without evaluating it
+)
+
+# => #<OpenStruct id="...", device_id="...", risk_assessment="..", evidence=...>
+```
+
+### Registering a Feedback
+
+This method registers a feedback event for the given identifiers (optional arguments), returning true when success.
+
+The `timestamp` argument should be a _Time_, _DateTime_ or an _Integer_ being the timestamp in milliseconds:
+
+```ruby
+account_id = "cdb2cfbb-8ad8-4668-b276-5fff9bbfdc96"
+timestamp = DateTime.parse('2022-06-20 23:29:00 UTC-3')
+
+success = api.register_feedback(
+  event: Incognia::Constants::FeedbackEvent::IDENTITY_FRAUD,
+  timestamp: timestamp,
+  account_id: account_id
+)
+
+# => true
+```
+
+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
+)
+
+# => true
+```
+
+Check the [documentation](https://developer.incognia.com) to see possible identifiers for each event type.
+
 ## Exception handling
 
 Every method call can throw `APIError` and `APIAuthenticationError`.

data/lib/incognia/api.rb

@@ -36,6 +36,37 @@ module Incognia
 
       SignupAssessment.from_hash(response.body) if response.success?
     end
-  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
+
+    def register_feedback(event: , timestamp: nil, **ids)
+      timestamp = timestamp.strftime('%s%L') if timestamp.respond_to? :strftime
+
+      params = { event: event, timestamp: timestamp&.to_i }.compact
+      params.merge!(ids)
+
+      response = connection.request(
+        :post,
+        '/api/v2/feedbacks',
+        params
+      )
+
+      response.success?
+    end
+  end
 end

data/lib/incognia/constants/feedback_event.rb

@@ -0,0 +1,33 @@
+module Incognia
+  module Constants
+    module FeedbackEvent
+      ACCOUNT_TAKEOVER = 'account_takeover'.freeze
+      CHALLENGE_FAILED = 'challenge_failed'.freeze
+      CHALLENGE_PASSED = 'challenge_passed'.freeze
+      CHARGEBACK = 'chargeback'.freeze
+      CHARGEBACK_NOTIFICATION = 'chargeback_notification'.freeze
+      CUSTOM_CHURN_DEBT_20D = 'custom_churn_debt_20d'.freeze
+      IDENTITY_FRAUD = 'identity_fraud'.freeze
+      MPOS_FRAUD = 'mpos_fraud'.freeze
+      PASSWORD_CHANGE_FAILED = 'password_change_failed'.freeze
+      PASSWORD_CHANGED_SUCCESSFULLY = 'password_changed_successfully'.freeze
+      PROMOTION_ABUSE = 'promotion_abuse'.freeze
+      VERIFIED = 'verified'.freeze
+
+      SIGNUP_ACCEPTED = 'signup_accepted'.freeze
+      SIGNUP_DECLINED = 'signup_declined'.freeze
+
+      LOGIN_ACCEPTED = 'login_accepted'.freeze
+      LOGIN_DECLINED = 'login_declined'.freeze
+
+      PAYMENT_ACCEPTED = 'payment_accepted'.freeze
+      PAYMENT_ACCEPTED_BY_CONTROL_GROUP = 'payment_accepted_by_control_group'.freeze
+      PAYMENT_ACCEPTED_BY_THIRD_PARTY = 'payment_accepted_by_third_party'.freeze
+      PAYMENT_DECLINED = 'payment_declined'.freeze
+      PAYMENT_DECLINED_BY_ACQUIRER = 'payment_declined_by_acquirer'.freeze
+      PAYMENT_DECLINED_BY_BUSINESS = 'payment_declined_by_business'.freeze
+      PAYMENT_DECLINED_BY_MANUAL_REVIEW = 'payment_declined_by_manual_review'.freeze
+      PAYMENT_DECLINED_BY_RISK_ANALYSIS = 'payment_declined_by_risk_analysis'.freeze
+    end
+  end
+end

data/lib/incognia/resources/login_assessment.rb

@@ -0,0 +1,5 @@
+require_relative "api_resource"
+
+module Incognia
+  class LoginAssessment < APIResource; end
+end

data/lib/incognia/version.rb

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

data/lib/incognia.rb

@@ -8,8 +8,11 @@ require_relative "incognia/api"
 
 require_relative "incognia/resources/api_resource"
 require_relative "incognia/resources/signup_assessment"
+require_relative "incognia/resources/login_assessment"
 require_relative "incognia/resources/credentials"
 
+require_relative "incognia/constants/feedback_event"
+
 module Incognia
   class APIError < StandardError
     attr_reader :message, :errors, :status

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: incognia_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Guilherme Cavalcanti
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-06 00:00:00.000000000 Z
+date: 2022-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -62,8 +62,10 @@ files:
 - lib/incognia/address.rb
 - lib/incognia/api.rb
 - lib/incognia/client.rb
+- lib/incognia/constants/feedback_event.rb
 - lib/incognia/resources/api_resource.rb
 - lib/incognia/resources/credentials.rb
+- lib/incognia/resources/login_assessment.rb
 - lib/incognia/resources/signup_assessment.rb
 - lib/incognia/util.rb
 - lib/incognia/version.rb
@@ -88,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Official Ruby lib for communicating with Incognia API