lago-ruby-client 1.44.0 → 1.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e05c7adf2d8d5d2dd6d5e8e9263908f415013356761245b1f22878b0fd0c7a2
-  data.tar.gz: d89d43c70f055b2363ef08cb063d5910f1335257846292400b4e1f88e0ab882f
+  metadata.gz: b0d737a1ba08ae4f9d2a731af4cf55918555cfe91e1606fbef6126b830090e82
+  data.tar.gz: 06b6d2a32667abe5872075cb96081aedff4d0d07fa49e0a4158f594ee66f4803
 SHA512:
-  metadata.gz: fdab377ffb956c42aec999bd2ca63fa4ceeb895f656497175b955b93d2d2adfa60e2b088ff3deedbf039fef3ca01fb4ecb2d98aa2afb27d74bcf9f9710737ace
-  data.tar.gz: 0e52ca90f164179ac5e28c90e48a37ef1d0f57ffe47f35ba105df18857ed4035a4969fa9aff93de0291143bfd0bb5e2d23efb052b5db7e17cebd3502cbf46f9a
+  metadata.gz: fbb748d95cb04580ecba3e5340e5587c72f4b20ce629fefc06eeb8435c074cbde11e8874407bcdf3f0f32680e961ca553b1b6ae929d695357e2bf2d21ca13041
+  data.tar.gz: a0ef70eeb95aff16cef4492c9b2ba989323b7bae8cbc26b50a9cb3e098cd49ea54bee30fc83e6f4912f226eb5bfb538a3bb3e3f3c6829ec592b2e50bee474778

data/lib/lago/api/client.rb

@@ -53,13 +53,15 @@ module Lago
     API_PATH = 'api/v1/'
 
     class Client
-      attr_reader :api_key, :api_url, :use_ingest_service, :ingest_api_url
+      attr_reader :api_key, :api_url, :use_ingest_service, :ingest_api_url, :max_retries, :retry_on_rate_limit
 
-      def initialize(api_key: nil, api_url: nil, use_ingest_service: false, ingest_api_url: nil)
+      def initialize(api_key: nil, api_url: nil, use_ingest_service: false, ingest_api_url: nil, **options)
         @api_key = api_key
         @api_url = api_url
         @use_ingest_service = use_ingest_service
         @ingest_api_url = ingest_api_url
+        @max_retries = options.fetch(:max_retries, 3)
+        @retry_on_rate_limit = options.fetch(:retry_on_rate_limit, true)
       end
 
       def base_api_url

data/lib/lago/api/connection.rb

@@ -6,84 +6,90 @@ module Lago
   module Api
     class Connection
       RESPONSE_SUCCESS_CODES = [200, 201, 202, 204].freeze
+      DEFAULT_MAX_RETRIES = 3
+      INITIAL_BACKOFF = 1
+      BACKOFF_MULTIPLIER = 2
+      MAX_RETRY_DELAY = 20
 
-      def initialize(api_key, uri)
+      def initialize(api_key, uri, max_retries: DEFAULT_MAX_RETRIES, retry_on_rate_limit: true)
         @api_key = api_key
         @uri = uri
+        @max_retries = max_retries
+        @retry_on_rate_limit = retry_on_rate_limit
       end
 
       def post(body, path = uri.path)
-        response = http_client.send_request(
-          'POST',
-          path,
-          prepare_payload(body),
-          headers
-        )
-
-        handle_response(response)
+        execute_request do
+          http_client.send_request(
+            'POST',
+            path,
+            prepare_payload(body),
+            headers
+          )
+        end
       end
 
       def put(path = uri.path, identifier:, body:)
         uri_path = identifier.nil? ? path : "#{path}/#{CGI.escapeURIComponent(identifier)}"
-        response = http_client.send_request(
-          'PUT',
-          uri_path,
-          prepare_payload(body),
-          headers
-        )
-
-        handle_response(response)
+        execute_request do
+          http_client.send_request(
+            'PUT',
+            uri_path,
+            prepare_payload(body),
+            headers
+          )
+        end
       end
 
       def patch(path = uri.path, identifier:, body:)
         uri_path = identifier.nil? ? path : "#{path}/#{CGI.escapeURIComponent(identifier)}"
-        response = http_client.send_request(
-          'PATCH',
-          uri_path,
-          prepare_payload(body),
-          headers
-        )
-
-        handle_response(response)
+        execute_request do
+          http_client.send_request(
+            'PATCH',
+            uri_path,
+            prepare_payload(body),
+            headers
+          )
+        end
       end
 
       def get(path = uri.path, identifier:)
         uri_path = identifier.nil? ? path : "#{path}/#{CGI.escapeURIComponent(identifier)}"
-        response = http_client.send_request(
-          'GET',
-          uri_path,
-          prepare_payload(nil),
-          headers
-        )
-
-        handle_response(response)
+        execute_request do
+          http_client.send_request(
+            'GET',
+            uri_path,
+            prepare_payload(nil),
+            headers
+          )
+        end
       end
 
       def destroy(path = uri.path, identifier:, options: nil)
         uri_path = path
         uri_path += "/#{CGI.escapeURIComponent(identifier)}" if identifier
         uri_path += "?#{URI.encode_www_form(options)}" unless options.nil?
-        response = http_client.send_request(
-          'DELETE',
-          uri_path,
-          prepare_payload(nil),
-          headers
-        )
-
-        handle_response(response)
+        execute_request do
+          http_client.send_request(
+            'DELETE',
+            uri_path,
+            prepare_payload(nil),
+            headers
+          )
+        end
       end
 
       def get_all(options, path = uri.path)
         uri_path = options.empty? ? path : "#{path}?#{URI.encode_www_form(options)}"
 
-        response = http_client.send_request(
-          'GET',
-          uri_path,
-          prepare_payload(nil),
-          headers
-        )
-
-        handle_response(response)
+        execute_request do
+          http_client.send_request(
+            'GET',
+            uri_path,
+            prepare_payload(nil),
+            headers
+          )
+        end
       end
 
       private
@@ -98,14 +104,35 @@ module Lago
         }
       end
 
-      def handle_response(response)
-        raise_error(response) unless RESPONSE_SUCCESS_CODES.include?(response.code.to_i)
+      def execute_request(retry_count = 0, &block)
+        response = yield
+        handle_response(response, retry_count, block)
+      end
 
-        response.body.empty? || JSON.parse(response.body)
+      def handle_response(response, retry_count, block)
+        code = response.code.to_i
+
+        if code == 429 && @retry_on_rate_limit && retry_count < @max_retries
+          handle_rate_limit(response, retry_count, block)
+        elsif !RESPONSE_SUCCESS_CODES.include?(code)
+          raise_error(response)
+        else
+          parse_response_body(response)
+        end
       rescue JSON::ParserError
         response.body
       end
 
+      def handle_rate_limit(response, retry_count, block)
+        reset_seconds = extract_reset_seconds(response, retry_count)
+        sleep(reset_seconds)
+        execute_request(retry_count + 1, &block)
+      end
+
+      def parse_response_body(response)
+        response.body.empty? || JSON.parse(response.body)
+      end
+
       def http_client
         http_client = Net::HTTP.new(uri.hostname, uri.port)
         http_client.use_ssl = true if uri.scheme == 'https'
@@ -120,7 +147,42 @@ module Lago
       end
 
       def raise_error(response)
-        raise Lago::Api::HttpError.new(response.code.to_i, response.body, uri)
+        code = response.code.to_i
+
+        raise Lago::Api::HttpError.new(code, response.body, uri) unless code == 429
+
+        limit, remaining, reset = parse_rate_limit_headers(response)
+        raise Lago::Api::RateLimitError.new(
+          code,
+          response.body,
+          uri,
+          limit:,
+          remaining:,
+          reset:
+        )
+      end
+
+      def parse_rate_limit_headers(response)
+        limit = response['x-ratelimit-limit']&.to_i
+        remaining = response['x-ratelimit-remaining']&.to_i
+        reset = response['x-ratelimit-reset']&.to_i
+
+        [limit, remaining, reset]
+      end
+
+      def extract_reset_seconds(response, retry_count)
+        delay = if response['x-ratelimit-reset']
+          [response['x-ratelimit-reset'].to_i, INITIAL_BACKOFF].max
+        else
+          # Exponential backoff if header is missing
+          calculate_backoff(retry_count)
+        end
+
+        [delay, MAX_RETRY_DELAY].min
+      end
+
+      def calculate_backoff(retry_count)
+        INITIAL_BACKOFF * (BACKOFF_MULTIPLIER**retry_count)
       end
     end
   end

data/lib/lago/api/rate_limit_error.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Lago
+  module Api
+    class RateLimitError < HttpError
+      attr_reader :limit, :remaining, :reset
+
+      def initialize(code, body, uri, **options)
+        super(code, body, uri)
+        @limit = options[:limit]
+        @remaining = options[:remaining]
+        @reset = options[:reset]
+      end
+
+      def message
+        base_message = "HTTP #{error_code} - URI: #{uri}.\nError: #{error_body}"
+        return base_message unless reset
+
+        "#{base_message}\nRate limit will reset in #{reset} seconds."
+      end
+    end
+  end
+end

data/lib/lago/api/resources/base.rb

@@ -59,7 +59,12 @@ module Lago
         def connection
           uri = URI.join(client.base_api_url, api_resource)
 
-          Lago::Api::Connection.new(client.api_key, uri)
+          Lago::Api::Connection.new(
+            client.api_key,
+            uri,
+            max_retries: client.max_retries,
+            retry_on_rate_limit: client.retry_on_rate_limit,
+          )
         end
       end
     end

data/lib/lago/api/resources/event.rb

@@ -16,7 +16,12 @@ module Lago
 
         def create(params)
           uri = URI("#{client.base_ingest_api_url}#{api_resource}")
-          connection = Lago::Api::Connection.new(client.api_key, uri)
+          connection = Lago::Api::Connection.new(
+            client.api_key,
+            uri,
+            max_retries: client.max_retries,
+            retry_on_rate_limit: client.retry_on_rate_limit,
+          )
 
           payload = whitelist_params(params)
           response = connection.post(payload, uri)[root_name]

data/lib/lago/api/resources/nested.rb

@@ -8,7 +8,12 @@ module Lago
       class Nested < Base
         def initialize(client)
           super(client)
-          @connection = Lago::Api::Connection.new(client.api_key, client.base_api_url)
+          @connection = Lago::Api::Connection.new(
+            client.api_key,
+            client.base_api_url,
+            max_retries: client.max_retries,
+            retry_on_rate_limit: client.retry_on_rate_limit,
+          )
         end
 
         def create(*parent_ids, params)

data/lib/lago/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lago
-  VERSION = '1.44.0'
+  VERSION = '1.46.0'
 end

data/lib/lago-ruby-client.rb

@@ -11,3 +11,4 @@ require 'lago/version'
 require 'lago/api/client'
 require 'lago/api/connection'
 require 'lago/api/http_error'
+require 'lago/api/rate_limit_error'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: lago-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.44.0
+  version: 1.46.0
 platform: ruby
 authors:
 - Lovro Colic
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-03-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -52,6 +51,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +205,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -276,7 +303,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - lovro@getlago.com
 executables: []
@@ -287,6 +313,7 @@ files:
 - lib/lago/api/client.rb
 - lib/lago/api/connection.rb
 - lib/lago/api/http_error.rb
+- lib/lago/api/rate_limit_error.rb
 - lib/lago/api/resources/activity_log.rb
 - lib/lago/api/resources/add_on.rb
 - lib/lago/api/resources/api_log.rb
@@ -341,7 +368,6 @@ metadata:
   homepage_uri: https://www.getlago.com/
   source_code_uri: https://github.com/getlago/lago-ruby-client
   documentation_uri: https://doc.getlago.com
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -356,8 +382,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Lago Rest API client
 test_files: []