incognia_api 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a52bbb4d602bec60845df1106450e7d4642f55cc993635fe67abf05bb1e4faf3
-  data.tar.gz: 88daa93221f7d5901ae3235e7da5175a0a2542e7778543f713687b34d4c49d28
+  metadata.gz: 823c5ab4bca2a8fd1d856482906971073d95a1f55e378c6d812da69d205f689e
+  data.tar.gz: 26e4f368b891e14cab04a69b1de02342bf48e2b5f0eea474a1947bf5103fd773
 SHA512:
-  metadata.gz: ee85936265c871bb6d76a1b10f4c2959d7e2ce9bc3c5df5eba102e5f4a3a1b2b33f35b79636db0b12e79955177dd8733d70e4e5cb8c32a47560f112ac6f3839f
-  data.tar.gz: a9c0b9a25f6b06931d6bc14e0fabb6d4e068d774e9c526e28bf6a66ac5d125b8c2549bee872f6f8e50d6a4781a3ca79a7338ce11e50784963d891c623fec62f0
+  metadata.gz: 3e34fe28af027501b6e4f907d4c9973c930fc86b2ce3ae565fce72979c3a55098a0c3700b91f62d00d7c8ab2d350440e89caf11b0a716c053d6e5f7f89ca2731
+  data.tar.gz: 07ece7a29b0fe8dcb88b1e7df6817d83ab13c42c751bdcb83877912df9f4c94c54d401368c549e0f4cce3e28ffcdfb19a28df5abb27823d9f012ecd6a0f8ec2b

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [3.0.0] - 2025-09-22
+- Update `faraday` dependency to version 2.13.4
+- Remove `faraday_middleware` dependency
+
+## [2.2.0] - 2025-09-16
+
+- Add support for passing an optional person_id parameter to HTTP request helpers
+
 ## [2.1.0] - 2025-05-09
 
 - Add support for passing an optional location parameter to register logins and payments

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    incognia_api (2.1.0)
-      faraday (~> 1.10)
-      faraday_middleware (~> 1.2)
+    incognia_api (3.0.0)
+      faraday (~> 2.13)
 
 GEM
   remote: https://rubygems.org/
@@ -14,34 +13,18 @@ GEM
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
-    faraday (1.10.3)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      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-retry (1.0.3)
-    faraday_middleware (1.2.0)
-      faraday (~> 1.0)
+    faraday (2.13.4)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.1)
+      net-http (>= 0.5.0)
     hashdiff (1.0.1)
+    json (2.14.0)
+    logger (1.7.0)
     method_source (1.0.0)
-    multipart-post (2.3.0)
+    net-http (0.6.0)
+      uri
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -61,8 +44,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    ruby2_keywords (0.0.5)
     timecop (0.9.4)
+    uri (1.0.3)
     webmock (3.14.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)

data/README.md

@@ -6,7 +6,7 @@ Incognia Ruby library provides easy access to the Incogia API from Ruby
 applications. It includes:
 
 - Basic Access Token management (with transparent token refresh)
-- API resounces dinamically built from API responses
+- API resources dinamically built from API responses
 
 For more information on how to integrate Incognia APIs, refer to one of the
 following guides:
@@ -69,14 +69,35 @@ assessment = Incognia::Api.register_signup(
 It also supports optional parameters, for example:
 
 ```ruby
-address = Incognia::Address.new(line: "West 34th Street, New York City, NY 10001")
+# address may include any or all of the following formats: address line, coordinates, or structured address
+address = Incognia::Address.new(
+  line: "Av. Paulista, 1578 - Bela Vista, São Paulo - SP, 01310-200", 
+  coordinates: {lat: -23.589339, lng: -46.659043}, 
+  structured: 
+  {
+    locale: "pt-BR",
+    country_name: "Brasil",
+    country_code: "BR",
+    state: "SP",
+    city: "São Paulo",
+    borough: "",
+    neighborhood: "Bela Vista",
+    street: "Av. Paulista",
+    number: "1578",
+    complements: "Andar 2",
+    postal_code: "01310-200"
+  }
+)
+# Person id: either a valid SSN (USA) or CPF (Brazil). Only numerical characters must be provided as value.
+person_id = Incognia::PersonId.new(type: "cpf", value: "12345678901")
 request_token = "WlMksW+jh5GPhqWBorsV8yDihoSHHpmt+DpjJ7eYxpHhuO/5tuHTuA..."
 external_id = "7b02736a-7718-4b83-8982-f68fb6f501fa"
 
 assessment = Incognia::Api.register_signup(
   request_token: request_token,
   address: address,
-  external_id: external_id
+  external_id: external_id,
+  person_id: person_id
 )
 
 # => #<OpenStruct id="...", device_id="...", risk_assessment="..", evidence=...>
@@ -102,14 +123,29 @@ assessment = Incognia::Api.register_login(
 It also supports optional parameters, for example:
 
 ```ruby
+timestamp = Date.parse("2025-04-23T12:12:12-03:00")
+location = Incognia::Location.new(latitude: -23.589339, longitude: -46.659043, collected_at: timestamp)
+# These are all also valid timestamps for Location.timestamp
+timestamp1 = Time.new(2025, 4, 23, 12, 12, 12, "-03:00")
+timestamp2 = DateTime.parse("2025-04-23T12:12:12-03:00")
+timestamp3 = "2025-04-23T12:12:12-03:00"
+timestamp4 = Time.now()
+
+# Person id: either a valid SSN (USA) or CPF (Brazil). Only numerical characters must be provided as value.
+person_id = Incognia::PersonId.new(type: "cpf", value: "12345678901")
+external_id = 'some-external-identifier'
+
+# Mandatory fields
 request_token = "WlMksW+jh5GPhqWBorsV8yDihoSHHpmt+DpjJ7eYxpHhuO/5tuHTuA..."
 account_id = 'account-identifier-123'
-external_id = 'some-external-identifier'
+
 
 assessment = Incognia::Api.register_login(
   request_token: request_token,
   account_id: account_id,
   external_id: external_id,
+  person_id: person_id,
+  location: location,
   eval: false # can be used to register a new login without evaluating it
 )
 
@@ -182,9 +218,17 @@ payment_methods = [
   }
 ]
 
+location = Incognia::Location.new(latitude: -23.589339, longitude: -46.659043, collected_at: "2025-04-23T12:12:12-03:00")
+
+# Person id: either a valid SSN (USA) or CPF (Brazil). Only numerical characters must be provided as value.
+person_id = Incognia::PersonId.new(type: "cpf", value: "12345678901")
+external_id = 'some-external-identifier'
+
 assessment = Incognia::Api.register_payment(
   request_token: 'request-token',
   account_id: 'account-id',
+  location: location,
+  person_id: person_id,
   external_id: 'external-id',
   addresses: addresses,
   payment_value: payment_value,
@@ -198,21 +242,25 @@ assessment = Incognia::Api.register_payment(
 
 This method registers a feedback event for the given identifiers (optional arguments), returning true when success.
 
-The `occurred_at` argument should be a _Time_, _DateTime_ or an date in **RFC 3339** format.
+The `occurred_at` argument should be a _Time_, _DateTime_ or a date in **RFC 3339** format.
 
-The `expires_at` argument should be a _Time_, _DateTime_ or an date in **RFC 3339** format.
+The `expires_at` argument should be a _Time_, _DateTime_ or a date in **RFC 3339** format.
 
 
 ```ruby
 request_token = 'request-token'
 account_id = 'account-id'
 occurred_at = DateTime.parse('2024-07-22T15:20:00Z')
+# person id: optional
+person_id = Incognia::PersonId.new(type: "cpf", value: "12345678901")
+
 
 success = Incognia::Api.register_feedback(
   event: Incognia::Constants::FeedbackEvent::ACCOUNT_TAKEOVER,
   occurred_at: occurred_at,
   request_token: request_token,
-  account_id: account_id
+  account_id: account_id,
+  person_id: person_id
 )
 
 # => true

data/fixtures/vcr_cassettes/token.yml

@@ -8,7 +8,7 @@ http_interactions:
       string: ''
     headers:
       User-Agent:
-      - Faraday v1.4.2
+      - Faraday v2.13.4
       Authorization:
       - Basic R1BXSzFMQ1paSW8xRkxPQ0NuTExNcU44UWkxSHYzazQ6RUxHOV8yazU5T0hkMUdiVXhIaGRTdGtqZUI3TXlQZ21vRjhlR2YxM0xBMU1scmZRZ1Q1bkhFMmFIaVNobVc0WA==
       Content-Type:
@@ -58,7 +58,7 @@ http_interactions:
       string: '{"installation_id":"xyz"}'
     headers:
       User-Agent:
-      - Faraday v1.4.2
+      - Faraday v2.13.4
       Authorization:
       - Bearer access_token
       Content-Type:

data/incognia_api.gemspec

@@ -11,7 +11,7 @@ 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-ruby"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/inloco/incognia-ruby"
@@ -28,8 +28,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
-  spec.add_dependency('faraday', '~> 1.10')
-  spec.add_dependency('faraday_middleware', '~> 1.2')
+  spec.add_dependency('faraday', '~> 2.13')
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/incognia_api/api.rb

@@ -1,7 +1,6 @@
 require "faraday"
 require "json"
 require "logger"
-require 'faraday_middleware'
 
 module Incognia
   class Api
@@ -9,10 +8,11 @@ module Incognia
       # business layer: uses the Client.instance to build domain objects
       # raises missing parameters errors
 
-      def register_signup(request_token: nil, address: nil, **opts)
+      def register_signup(request_token: nil, address: nil, person_id: nil, **opts)
         params = { request_token: request_token }.compact
         params.merge!(opts)
         params.merge!(address.to_hash) if address
+        params.merge!(person_id: person_id.to_hash) if person_id
 
         response = connection.request(
           :post,
@@ -23,13 +23,14 @@ module Incognia
         SignupAssessment.from_hash(response.body) if response.success?
       end
 
-      def register_login(account_id:, request_token: nil, location: nil, **opts)
+      def register_login(account_id:, request_token: nil, location: nil, person_id: nil, **opts)
         params = {
           type: :login,
           account_id: account_id,
           request_token: request_token
         }.compact
         params.merge!(location: location.to_hash) if location
+        params.merge!(person_id: person_id.to_hash) if person_id
         params.merge!(opts)
 
         response = connection.request(
@@ -41,11 +42,12 @@ module Incognia
         LoginAssessment.from_hash(response.body) if response.success?
       end
 
-      def register_feedback(event:, occurred_at: nil, expires_at: nil, **ids)
+      def register_feedback(event:, occurred_at: nil, expires_at: nil, person_id: nil, **ids)
         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, occurred_at: occurred_at, expires_at: expires_at }.compact
+        params.merge!(person_id: person_id.to_hash) if person_id
         params.merge!(ids)
 
         response = connection.request(
@@ -57,13 +59,14 @@ module Incognia
         response.success?
       end
 
-      def register_payment(account_id:, request_token: nil, location: nil, **opts)
+      def register_payment(account_id:, request_token: nil, location: nil, person_id: nil, **opts)
         params = {
           type: :payment,
           account_id: account_id,
           request_token: request_token
         }.compact
         params.merge!(location: location.to_hash) if location
+        params.merge!(person_id: person_id.to_hash) if person_id
         params.merge!(opts)
 
         response = connection.request(

data/lib/incognia_api/client.rb

@@ -14,9 +14,7 @@ module Incognia
       json_data = JSON.generate(data) if data
 
       connection.send(method, endpoint, json_data, headers) do |r|
-        r.headers[Faraday::Request::Authorization::KEY] ||= Faraday::Request
-          .lookup_middleware(:authorization)
-          .header(:Bearer, credentials.access_token)
+        r.headers[Faraday::Request::Authorization::KEY] ||= "Bearer #{credentials.access_token}"
       end
     rescue Faraday::ClientError, Faraday::ServerError => e
       raise APIError.new(e.to_s, e.response)
@@ -50,9 +48,8 @@ module Incognia
     protected
 
     def request_credentials
-      basic_auth = Faraday::Request
-        .lookup_middleware(:basic_auth)
-        .header(Incognia.config.client_id, Incognia.config.client_secret)
+      basic_auth = Faraday::Utils
+        .basic_header_from(Incognia.config.client_id, Incognia.config.client_secret)
 
       response = connection.send(:post, 'v2/token') do |r|
         r.headers[Faraday::Request::Authorization::KEY] = basic_auth

data/lib/incognia_api/person_id.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Incognia
+  class PersonId
+    attr_reader :type, :value
+
+    def initialize(type:, value:)
+      @type  = type
+      @value = value
+    end
+
+    def to_hash
+      { type: type, value: value }
+    end
+  end
+end

data/lib/incognia_api/version.rb

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

data/lib/incognia_api.rb

@@ -7,6 +7,7 @@ require_relative "incognia_api/util"
 require_relative "incognia_api/address"
 require_relative "incognia_api/api"
 require_relative "incognia_api/location"
+require_relative "incognia_api/person_id"
 
 require_relative "incognia_api/resources/api_resource"
 require_relative "incognia_api/resources/signup_assessment"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: incognia_api
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Guilherme Cavalcanti
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-09 00:00:00.000000000 Z
+date: 2025-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.13'
 description: Official Ruby lib for communicating with Incognia API
 email:
 - guiocavalcanti@gmail.com
@@ -46,7 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
-- ".github/workflows/codeql.yml"
+- ".github/workflows/codeql.yaml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
@@ -66,6 +52,7 @@ files:
 - lib/incognia_api/configuration.rb
 - lib/incognia_api/constants/feedback_event.rb
 - lib/incognia_api/location.rb
+- lib/incognia_api/person_id.rb
 - lib/incognia_api/resources/api_resource.rb
 - lib/incognia_api/resources/credentials.rb
 - lib/incognia_api/resources/login_assessment.rb
@@ -87,7 +74,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="