incognia_api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d20f61a585d3f2a6f3ae499a5a32ce1162ce812d6450eaaa3ed2c3107caeff26
-  data.tar.gz: f48d53ed2d2bc99face81e094a0193f8a5e5cb0752b12abaaf1020ae3ca47d4f
+  metadata.gz: c06d3f1dee05fda7643ec2f4fe90cc9701d268bf403dbffddb90e2a9f44fe78d
+  data.tar.gz: 7f40ea03ef4b6fccc3fe22b59ef0bec2d8418357c497facb8f07c505905e2617
 SHA512:
-  metadata.gz: a686efb7675e67313ea627bc22898d37027e07dd7742153ba525e818f36190be57f1a72848f1149d9826b198d419ac48f550f3e22deb5fb5d1801bc345784dca
-  data.tar.gz: 304ee383de088469fc85f5fdb873aeb8650be7c04b0b58c4c6fe37e7f32ae3bf067bfa4726a28f813edc59df3ea7520263478cf08ba927257c3cc4268b351948
+  metadata.gz: cdd6f1391a78d3ab2fd9989415056d9d54dc4b85fad42260b5ec1e8460eb5bc4094baa30c1588f5224a06e24d2ce9cd734dd590fb851f46703b2e7c3bdfddf3e
+  data.tar.gz: 8e706e0ec640801e8df377f2c84366b052727623e054b53f8fd7150a98128a027385a11707dfc1ffe6907eb9ed681ee5956feedc29e62646b595eaaa2bf92cf8

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,14 @@
 ## [Unreleased]
 
+## [0.4.0] - 2023-04-14
+
+- Rename main filename to match the gem name
+
+## [0.3.1] - 2023-01-24
+
+- Allow optional params on #register_signup
+- Add Reset feedback event
+
 ## [0.3.0] - 2022-05-06
 
 - Allow registering feedbacks

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    incognia_api (0.3.0)
+    incognia_api (0.4.0)
       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.3.0)
     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:
@@ -132,7 +148,7 @@ For custom fraud, set the value of `event` with the corresponding code:
 
 ```ruby
 success = api.register_feedback(
-  event: 'custom_fraud_name'
+  event: 'custom_fraud_name',
   timestamp: timestamp,
   account_id: account_id,
   installation_id: installation_id

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require "incognia"
+require "incognia_api"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/{incognia.gemspec → incognia_api.gemspec}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "lib/incognia/version"
+require_relative "lib/incognia_api/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "incognia_api"
@@ -10,12 +10,12 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "Official Ruby lib for communicating with Incognia API"
   spec.description   = "Official Ruby lib for communicating with Incognia API"
-  spec.homepage      = "https://github.com/inloco/incognia-api-ruby"
+  spec.homepage      = "https://github.com/inloco/incognia-ruby"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/inloco/incognia-api-ruby"
-  spec.metadata["changelog_uri"] = "https://github.com/inloco/incognia-api-ruby/blob/master/"
+  spec.metadata["source_code_uri"] = "https://github.com/inloco/incognia-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/inloco/incognia-ruby/blob/master/"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/{incognia → incognia_api}/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,

data/lib/{incognia → incognia_api}/constants/feedback_event.rb

@@ -6,12 +6,12 @@ module Incognia
       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
+      RESET = 'reset'.freeze
       VERIFIED = 'verified'.freeze
 
       SIGNUP_ACCEPTED = 'signup_accepted'.freeze

data/lib/{incognia → incognia_api}/version.rb

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

data/lib/{incognia.rb → incognia_api.rb}

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require_relative "incognia/version"
-require_relative "incognia/client"
-require_relative "incognia/util"
-require_relative "incognia/address"
-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"
+require_relative "incognia_api/version"
+require_relative "incognia_api/client"
+require_relative "incognia_api/util"
+require_relative "incognia_api/address"
+require_relative "incognia_api/api"
+
+require_relative "incognia_api/resources/api_resource"
+require_relative "incognia_api/resources/signup_assessment"
+require_relative "incognia_api/resources/login_assessment"
+require_relative "incognia_api/resources/credentials"
+
+require_relative "incognia_api/constants/feedback_event"
 
 module Incognia
   class APIError < StandardError

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: incognia_api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Guilherme Cavalcanti
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-08 00:00:00.000000000 Z
+date: 2023-04-17 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"
@@ -57,24 +58,24 @@ files:
 - bin/console
 - bin/setup
 - fixtures/vcr_cassettes/token.yml
-- incognia.gemspec
-- lib/incognia.rb
-- 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
-homepage: https://github.com/inloco/incognia-api-ruby
+- incognia_api.gemspec
+- lib/incognia_api.rb
+- lib/incognia_api/address.rb
+- lib/incognia_api/api.rb
+- lib/incognia_api/client.rb
+- lib/incognia_api/constants/feedback_event.rb
+- lib/incognia_api/resources/api_resource.rb
+- lib/incognia_api/resources/credentials.rb
+- lib/incognia_api/resources/login_assessment.rb
+- lib/incognia_api/resources/signup_assessment.rb
+- lib/incognia_api/util.rb
+- lib/incognia_api/version.rb
+homepage: https://github.com/inloco/incognia-ruby
 licenses: []
 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/
+  homepage_uri: https://github.com/inloco/incognia-ruby
+  source_code_uri: https://github.com/inloco/incognia-ruby
+  changelog_uri: https://github.com/inloco/incognia-ruby/blob/master/
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -90,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Official Ruby lib for communicating with Incognia API