incognia_api 2.2.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 485a9d5fcf16b98a5ca942d1d4fe47e876f25f60a70193d7bcb70110aebd725a
-  data.tar.gz: 97a539a4a8a7a7d30ab63e12f6969b34580386fa76e93dee106ffd9a8371f253
+  metadata.gz: 8b71c411cba337dac4e3ad7e0f16199ee99bc3ce6dc47858ee4b396a6e75b303
+  data.tar.gz: 68abfb412d0db671e1a98542f6179537745fbd395ec4b21b605b109133c91a42
 SHA512:
-  metadata.gz: f282bbcc8499cbc2bcae7ad4aaa151dc785a7c1e86e40ebeabe91de440ba51b28d9de06c2e4db9a9870381d3ba6fc6ebbd4e71e9dfdd61c821b085a18fd6cf2e
-  data.tar.gz: bffdaf58ca5335190f1a7b4a11ad1a2e0254f47a75366a60b54f3e6697b58c79f2ba531e49f0195068c768327e205b06016120b38369da35cbf77db1bbbf763f
+  metadata.gz: 2aa64e0525e09a97cca4dab86a0e2156822766884b0dda0905cc98806bc9ab3cfd761c612ecdd681cda460ced463f46694befe18b3fff49d12fc31062b2e3ade
+  data.tar.gz: f36e80da9184b5d65f72a2d2e0446fe3d383e6f90f791db041dc6ea56d6c81edcc4fd8009f5f82cd7c8084d1acb3531008cb8b97670448b83a1e6a294be161ae

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [3.1.0] - 2026-04-17
+- Add optional `keep_alive` support with configurable `max_connections` for persistent HTTP connections.
+- Add `X-Incognia-Latency` support by sending the previous successful request latency on subsequent API calls.
+- Refresh locked dependencies, including `faraday` 2.14.1 and `json` 2.15.2.1.
+
+## [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

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    incognia_api (2.2.0)
-      faraday (~> 1.10)
-      faraday_middleware (~> 1.2)
+    incognia_api (3.1.0)
+      faraday (~> 2.13)
+      faraday-net_http_persistent (~> 2.3)
 
 GEM
   remote: https://rubygems.org/
@@ -11,37 +11,27 @@ GEM
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     coderay (1.1.3)
+    connection_pool (3.0.2)
     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.14.1)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.2)
+      net-http (~> 0.5)
+    faraday-net_http_persistent (2.3.1)
+      faraday (~> 2.5)
+      net-http-persistent (>= 4.0.4, < 5)
     hashdiff (1.0.1)
+    json (2.15.2.1)
+    logger (1.7.0)
     method_source (1.0.0)
-    multipart-post (2.3.0)
+    net-http (0.9.1)
+      uri (>= 0.11.1)
+    net-http-persistent (4.0.8)
+      connection_pool (>= 2.2.4, < 4)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -61,16 +51,17 @@ 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.1.1)
     webmock (3.14.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
-  ruby
+  arm64-darwin-24
   x86_64-darwin-20
+  x86_64-linux-gnu
 
 DEPENDENCIES
   incognia_api!

data/README.md

@@ -39,9 +39,23 @@ Before using the API client, you must configure it using credentials obtained
 from the [Incognia dashboard](https://dash.incognia.com/):
 
 ```ruby
-Incognia.configure(client_id: ENV['INCOGNIA_CLIENT_ID'], client_secret: ENV['INCOGNIA_CLIENT_SECRET'])
+Incognia.configure(
+  client_id: ENV['INCOGNIA_CLIENT_ID'],
+  client_secret: ENV['INCOGNIA_CLIENT_SECRET']
+)
+```
+
+To reuse HTTP connections between requests, enable `keep_alive`. When enabled,
+`max_connections` sets the maximum number of concurrent persistent
+connections used by the client.
 
-# Incognia.configure(client_id: "your-client-id", client_secret: "your-client-secret")
+```ruby
+Incognia.configure(
+  client_id: ENV['INCOGNIA_CLIENT_ID'],
+  client_secret: ENV['INCOGNIA_CLIENT_SECRET'],
+  keep_alive: true,
+  max_connections: 5
+)
 ```
 
 For sandbox credentials, refer to the [API testing guide](https://developer.incognia.com/).

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,8 @@ 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')
+  spec.add_dependency('faraday-net_http_persistent', '~> 2.3')
 
   # 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

data/lib/incognia_api/client.rb

@@ -1,23 +1,34 @@
 require "time"
 require "singleton"
+require "faraday/net_http_persistent"
 
 module Incognia
   class Client
     include Singleton
+    LATENCY_HEADER = "X-Incognia-Latency".freeze
+
     # TODO:
     # (ok) http/adapter specific code
     # (ok) raises network/authentication errors
     # (ok) handles token refreshing ok
     # future: handles retrying
 
+    def initialize
+      @last_latency_ms = nil
+      @last_latency_mutex = Mutex.new
+    end
+
     def request(method, endpoint = nil, data = nil, headers = {})
       json_data = JSON.generate(data) if data
+      request_headers = Faraday::Utils::Headers.new.update(headers)
+      request_headers[Faraday::Request::Authorization::KEY] ||= "Bearer #{credentials.access_token}"
+      request_headers[LATENCY_HEADER] = last_latency_ms&.to_s
 
-      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)
-      end
+      start = Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond)
+      response = connection.send(method, endpoint, json_data, request_headers.compact)
+      store_last_latency(Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond) - start) if response.success?
+
+      response
     rescue Faraday::ClientError, Faraday::ServerError => e
       raise APIError.new(e.to_s, e.response)
     rescue Faraday::Error => e
@@ -30,6 +41,12 @@ module Incognia
       @credentials
     end
 
+    def reset!
+      @connection&.close
+      @connection = nil
+      @credentials = nil
+    end
+
     def connection
       return @connection if @connection
 
@@ -43,16 +60,23 @@ module Incognia
         faraday.response :json, content_type: /\bjson$/
         faraday.response :raise_error
 
-        faraday.adapter Faraday.default_adapter
+        if Incognia.config.keep_alive
+          adapter_options = {
+            pool_size: Incognia.config.max_connections
+          }.compact
+
+          faraday.adapter :net_http_persistent, **adapter_options
+        else
+          faraday.adapter Faraday.default_adapter
+        end
       end
     end
 
     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
@@ -76,5 +100,13 @@ module Incognia
       Credentials.from_hash(properties)
     end
 
+    def last_latency_ms
+      @last_latency_mutex.synchronize { @last_latency_ms }
+    end
+
+    def store_last_latency(latency_ms)
+      @last_latency_mutex.synchronize { @last_latency_ms = latency_ms }
+    end
+
   end
 end

data/lib/incognia_api/configuration.rb

@@ -4,14 +4,27 @@ module Incognia
   class Configuration
     include Singleton
 
-    attr_accessor :client_id, :client_secret, :host
+    attr_accessor :client_id, :client_secret, :host, :keep_alive, :max_connections
+
+    def configure(client_id:, client_secret:, host: nil, keep_alive: false, max_connections: nil)
+      validate_connection_settings!(keep_alive: keep_alive, max_connections: max_connections)
 
-    def configure(client_id:, client_secret:, host: nil)
       @client_id = client_id
       @client_secret = client_secret
       @host = host || 'https://api.incognia.com/api'
+      @keep_alive = keep_alive
+      @max_connections = max_connections
 
       self
     end
+
+    private
+
+    def validate_connection_settings!(keep_alive:, max_connections:)
+      return if max_connections.nil?
+
+      raise ArgumentError, 'max_connections requires keep_alive: true' unless keep_alive
+      raise ArgumentError, 'max_connections must be a positive Integer' unless max_connections.is_a?(Integer) && max_connections.positive?
+    end
   end
 end

data/lib/incognia_api/version.rb

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

data/lib/incognia_api.rb

@@ -19,7 +19,7 @@ require_relative "incognia_api/constants/feedback_event"
 
 module Incognia
   def self.configure(**args)
-    config.configure(**args)
+    config.configure(**args).tap { Client.instance.reset! }
   end
 
   def self.config

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: incognia_api
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Guilherme Cavalcanti
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-16 00:00:00.000000000 Z
+date: 2026-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,28 +16,28 @@ 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'
+        version: '2.13'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-net_http_persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.3'
 description: Official Ruby lib for communicating with Incognia API
 email:
 - guiocavalcanti@gmail.com
@@ -88,7 +88,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:
   - - ">="