incognia_api 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8091ced0819f517cbe35df392b7f51d7943403f0b6053e97226c5dcb91cf7f5d
-  data.tar.gz: 07732b958841e661ab36548eabc14d4f55895fec5997f40b2e7f4c654d746eac
+  metadata.gz: e4670f0fda3487b76490802caef76aa02c9ef037c552d4fab1e970871d07498f
+  data.tar.gz: b8286fe8ba8130ad7512bc8bf2acb065409195ed326a72c9c0a4fb27b9e7cfb0
 SHA512:
-  metadata.gz: bd76587fcc7ca3edb6cd011cd8df4d8546d60deaf7026cd2de4241ffccfdafbf288c425627cd437385439ea675269e26e84178233444db02def82c2df2871ee1
-  data.tar.gz: 6a65cf592482f88de479b5c60233f592e3bfc1ccfe5982e2fb3f37d56285b76d1f3dda133737c03ae771476192708b117632d8813fe3e08f2dd2647883de71c8
+  metadata.gz: 191d5b1ee6963347a37a752bedda18bd293a04b7adc245c037b67e5ac6f08e629d36dbe5701c5bb13b6f5e180a2d7e6153b3913da730a2418fcd66d972eb866e
+  data.tar.gz: 118a7ea43a3f35709383c24c1b5d372b92152fea8041894666fdeb8839c2b6c472b8ced28bb3b654bbbf9ecd2fa7b6367d37174acc1f434508070937880420c9

data/.github/CODEOWNERS

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

data/.github/workflows/codeql.yml

@@ -0,0 +1,76 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '25 9 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.3.1] - 2023-01-24
+
+- Allows optional params on #register_signup
+- Adds Reset feedback event
+
+## [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.1)
       faraday
       faraday_middleware
 
@@ -13,29 +13,33 @@ GEM
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
-    faraday (1.7.1)
+    faraday (1.10.3)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
       faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
+      faraday-net_http_persistent (~> 1.0)
       faraday-patron (~> 1.0)
       faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+      faraday-retry (~> 1.0)
       ruby2_keywords (>= 0.0.4)
     faraday-em_http (1.0.0)
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
-    faraday_middleware (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
       faraday (~> 1.0)
     hashdiff (1.0.1)
-    multipart-post (2.1.1)
+    multipart-post (2.2.3)
     public_suffix (4.0.6)
     rake (13.0.3)
     rexml (3.2.5)

data/README.md

@@ -64,6 +64,22 @@ assessment = api.register_signup(
 
 ```
 
+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..."
+external_id = "7b02736a-7718-4b83-8982-f68fb6f501fa"
+
+assessment = api.register_signup(
+  installation_id: installation_id,
+  address: address,
+  external_id: external_id
+)
+
+# => #<OpenStruct id="...", device_id="...", risk_assessment="..", evidence=...>
+```
+
 ### Getting a Signup
 
 This method allows you to query the latest assessment for a given signup event, returning signup assessment, containing the risk assessment and supporting evidence:
@@ -75,6 +91,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

@@ -15,9 +15,10 @@ module Incognia
                                host: "https://api.incognia.com/api")
     end
 
-   def register_signup(installation_id:, address: nil)
+   def register_signup(installation_id:, address: nil, **opts)
       params = { installation_id: installation_id }
-      params.merge!(address.to_hash) if address
+      params.merge!(opts)
+      params.merge!(address&.to_hash) if address
 
       response = connection.request(
         :post,
@@ -36,6 +37,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
+      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
+      RESET = 'reset'.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.1"
 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.1
 platform: ruby
 authors:
 - Guilherme Cavalcanti
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-06 00:00:00.000000000 Z
+date: 2023-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
+- ".github/workflows/codeql.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
@@ -62,8 +63,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
@@ -73,7 +76,7 @@ metadata:
   homepage_uri: https://github.com/inloco/incognia-api-ruby
   source_code_uri: https://github.com/inloco/incognia-api-ruby
   changelog_uri: https://github.com/inloco/incognia-api-ruby/blob/master/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,8 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Official Ruby lib for communicating with Incognia API
 test_files: []