fbe 0.23.4 → 0.23.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebe33dc4f8380eeabe72495993dea6fe88842c8d062d7f41ce43111e664ba825
-  data.tar.gz: 2763f2c522defeb27a03bda9b15ec07d690721a663cb5bda91c2b07ea69b0b49
+  metadata.gz: bed0dbc2fe40503e276fad9620585658b3781cc02ce1fd171136ec9cae18bb67
+  data.tar.gz: 7ff721a9a5550eb960e4f98be1148b68e67a0198f821ba7485683022b0af2d1c
 SHA512:
-  metadata.gz: de77042cef4d5d7110fb13584e0b9765537dc156da8150c355a97f6d2b0b3212f8b46e8d20b24f96eacf3e1b93a30728e31514b731ca4fb6e92955046cc3f4b9
-  data.tar.gz: 5693137ce96120cad70e867b3e85655e29a4bc7d00e30435203f5c7b871e4b1248cd277190bb123dbcbe536beccbe99b72a4257da399a10f221ed0e4048e45b3
+  metadata.gz: 6f9a87c2d309bd1806aff0184d1173f903b8e5612b6564de1e7b1a4fa9c932c88793f294e33a341255d810095a161d0bdb492492510ffd19c6ffae2c14724609
+  data.tar.gz: c91361e3272512623ca9f3c7f7b35c056bd55e37a3baf5635525974043fc62a1d80eac2dd533385bd124c91b0ccb54167319f2691e1e439be47c30c751ae3873

data/lib/fbe/middleware/rate_limit.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
+# SPDX-License-Identifier: MIT
+
+require 'faraday'
+require 'json'
+require_relative '../../fbe'
+require_relative '../../fbe/middleware'
+
+# Faraday middleware that caches GitHub API rate limit information.
+#
+# This middleware intercepts calls to the /rate_limit endpoint and caches
+# the results locally. It tracks the remaining requests count and decrements
+# it for each API call. Every 100 requests, it refreshes the cached data
+# by allowing the request to pass through to the GitHub API.
+#
+# @example Usage in Faraday middleware stack
+#   connection = Faraday.new do |f|
+#     f.use Fbe::Middleware::RateLimit
+#   end
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024-2025 Zerocracy
+# License:: MIT
+class Fbe::Middleware::RateLimit < Faraday::Middleware
+  # Initializes the rate limit middleware.
+  #
+  # @param [Object] app The next middleware in the stack
+  def initialize(app)
+    super
+    @cached_response = nil
+    @remaining_count = nil
+    @request_counter = 0
+  end
+
+  # Processes the HTTP request and handles rate limit caching.
+  #
+  # @param [Faraday::Env] env The request environment
+  # @return [Faraday::Response] The response from cache or the next middleware
+  def call(env)
+    if env.url.path == '/rate_limit'
+      handle_rate_limit_request(env)
+    else
+      track_request
+      @app.call(env)
+    end
+  end
+
+  private
+
+  # Handles requests to the rate_limit endpoint.
+  #
+  # @param [Faraday::Env] env The request environment
+  # @return [Faraday::Response] Cached or fresh response
+  def handle_rate_limit_request(env)
+    if @cached_response.nil? || @request_counter >= 100
+      response = @app.call(env)
+      @cached_response = response.dup
+      @remaining_count = extract_remaining_count(response)
+      @request_counter = 0
+      response
+    else
+      response = @cached_response.dup
+      update_remaining_count(response)
+      Faraday::Response.new(response_env(env, response))
+    end
+  end
+
+  # Tracks non-rate_limit requests and decrements counter.
+  def track_request
+    return if @remaining_count.nil?
+    @remaining_count -= 1 if @remaining_count.positive?
+    @request_counter += 1
+  end
+
+  # Extracts the remaining count from the response body.
+  #
+  # @param [Faraday::Response] response The API response
+  # @return [Integer] The remaining requests count
+  def extract_remaining_count(response)
+    body = response.body
+    if body.is_a?(String)
+      begin
+        body = JSON.parse(body)
+      rescue JSON::ParserError
+        return 0
+      end
+    end
+    return 0 unless body.is_a?(Hash)
+    body.dig('rate', 'remaining') || 0
+  end
+
+  # Updates the remaining count in the response body.
+  #
+  # @param [Faraday::Response] response The cached response to update
+  def update_remaining_count(response)
+    body = response.body
+    original_was_string = body.is_a?(String)
+    if original_was_string
+      begin
+        body = JSON.parse(body)
+      rescue JSON::ParserError
+        return
+      end
+    end
+    return unless body.is_a?(Hash) && body['rate']
+    body['rate']['remaining'] = @remaining_count
+    return unless original_was_string
+    response.instance_variable_set(:@body, body.to_json)
+  end
+
+  # Creates a response environment for the cached response.
+  #
+  # @param [Faraday::Env] env The original request environment
+  # @param [Faraday::Response] response The cached response
+  # @return [Hash] Response environment hash
+  def response_env(env, response)
+    headers = response.headers.dup
+    headers['x-ratelimit-remaining'] = @remaining_count.to_s if @remaining_count
+    {
+      method: env.method,
+      url: env.url,
+      request_headers: env.request_headers,
+      request_body: env.request_body,
+      status: response.status,
+      response_headers: headers,
+      body: response.body
+    }
+  end
+end

data/lib/fbe/octo.rb

@@ -20,6 +20,7 @@ require 'verbose'
 require_relative '../fbe'
 require_relative 'middleware'
 require_relative 'middleware/formatter'
+require_relative 'middleware/rate_limit'
 require_relative 'middleware/sqlite_store'
 require_relative 'middleware/trace'
 
@@ -107,6 +108,7 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
             end
             builder.use(Octokit::Response::RaiseError)
             builder.use(Faraday::Response::Logger, loog, formatter: Fbe::Middleware::Formatter)
+            builder.use(Fbe::Middleware::RateLimit)
             builder.use(Fbe::Middleware::Trace, trace)
             builder.adapter(Faraday.default_adapter)
           end

data/lib/fbe.rb

@@ -10,5 +10,5 @@
 # License:: MIT
 module Fbe
   # Current version of the gem (changed by +.rultor.yml+ on every release)
-  VERSION = '0.23.4' unless const_defined?(:VERSION)
+  VERSION = '0.23.6' unless const_defined?(:VERSION)
 end

data/test/fbe/middleware/test_rate_limit.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
+# SPDX-License-Identifier: MIT
+
+require 'faraday'
+require 'webmock'
+require_relative '../../test__helper'
+require_relative '../../../lib/fbe'
+require_relative '../../../lib/fbe/middleware'
+require_relative '../../../lib/fbe/middleware/rate_limit'
+
+# Test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024-2025 Zerocracy
+# License:: MIT
+class RateLimitTest < Fbe::Test
+  def test_caches_rate_limit_response_on_first_call
+    rate_limit_response = {
+      'rate' => {
+        'limit' => 5000,
+        'remaining' => 4999,
+        'reset' => 1_672_531_200
+      }
+    }
+    stub_request(:get, 'https://api.github.com/rate_limit')
+      .to_return(status: 200, body: rate_limit_response.to_json, headers: { 'Content-Type' => 'application/json' })
+    conn = create_connection
+    response = conn.get('/rate_limit')
+    assert_equal 200, response.status
+    assert_equal 4999, response.body['rate']['remaining']
+  end
+
+  def test_returns_cached_response_on_subsequent_calls
+    rate_limit_response = {
+      'rate' => {
+        'limit' => 5000,
+        'remaining' => 4999,
+        'reset' => 1_672_531_200
+      }
+    }
+    stub_request(:get, 'https://api.github.com/rate_limit')
+      .to_return(status: 200, body: rate_limit_response.to_json, headers: { 'Content-Type' => 'application/json' })
+      .times(1)
+    conn = create_connection
+    conn.get('/rate_limit')
+    response = conn.get('/rate_limit')
+    assert_equal 200, response.status
+    assert_equal 4999, response.body['rate']['remaining']
+    assert_requested :get, 'https://api.github.com/rate_limit', times: 1
+  end
+
+  def test_decrements_remaining_count_for_non_rate_limit_requests
+    rate_limit_response = {
+      'rate' => {
+        'limit' => 5000,
+        'remaining' => 4999,
+        'reset' => 1_672_531_200
+      }
+    }
+    stub_request(:get, 'https://api.github.com/rate_limit')
+      .to_return(status: 200, body: rate_limit_response.to_json, headers: { 'Content-Type' => 'application/json',
+                                                                            'X-RateLimit-Remaining' => '4999' })
+    stub_request(:get, 'https://api.github.com/user')
+      .to_return(status: 200, body: '{"login": "test"}', headers: { 'Content-Type' => 'application/json' })
+    conn = create_connection
+    conn.get('/rate_limit')
+    conn.get('/user')
+    response = conn.get('/rate_limit')
+    assert_equal 4998, response.body['rate']['remaining']
+    assert_equal '4998', response.headers['x-ratelimit-remaining']
+  end
+
+  def test_refreshes_cache_after_hundred_requests
+    rate_limit_response = {
+      'rate' => {
+        'limit' => 5000,
+        'remaining' => 4999,
+        'reset' => 1_672_531_200
+      }
+    }
+    refreshed_response = {
+      'rate' => {
+        'limit' => 5000,
+        'remaining' => 4950,
+        'reset' => 1_672_531_200
+      }
+    }
+    stub_request(:get, 'https://api.github.com/rate_limit')
+      .to_return(status: 200, body: rate_limit_response.to_json, headers: { 'Content-Type' => 'application/json' })
+      .then
+      .to_return(status: 200, body: refreshed_response.to_json, headers: { 'Content-Type' => 'application/json' })
+    stub_request(:get, 'https://api.github.com/user')
+      .to_return(status: 200, body: '{"login": "test"}', headers: { 'Content-Type' => 'application/json' })
+      .times(100)
+    conn = create_connection
+    conn.get('/rate_limit')
+    100.times { conn.get('/user') }
+    response = conn.get('/rate_limit')
+    assert_equal 4950, response.body['rate']['remaining']
+    assert_requested :get, 'https://api.github.com/rate_limit', times: 2
+  end
+
+  def test_handles_response_without_rate_data
+    stub_request(:get, 'https://api.github.com/rate_limit')
+      .to_return(status: 200, body: '{}', headers: { 'Content-Type' => 'application/json' })
+    conn = create_connection
+    response = conn.get('/rate_limit')
+    assert_equal 200, response.status
+    assert_empty(response.body)
+  end
+
+  def test_ignores_non_hash_response_body
+    stub_request(:get, 'https://api.github.com/rate_limit')
+      .to_return(status: 200, body: 'invalid json', headers: { 'Content-Type' => 'text/plain' })
+    conn = create_connection
+    response = conn.get('/rate_limit')
+    assert_equal 200, response.status
+    assert_equal 'invalid json', response.body
+  end
+
+  def test_handles_zero_remaining_count
+    rate_limit_response = {
+      'rate' => {
+        'limit' => 5000,
+        'remaining' => 1,
+        'reset' => 1_672_531_200
+      }
+    }
+    stub_request(:get, 'https://api.github.com/rate_limit')
+      .to_return(status: 200, body: rate_limit_response.to_json, headers: { 'Content-Type' => 'application/json' })
+    stub_request(:get, 'https://api.github.com/user')
+      .to_return(status: 200, body: '{"login": "test"}', headers: { 'Content-Type' => 'application/json' })
+      .times(2)
+    conn = create_connection
+    conn.get('/rate_limit')
+    conn.get('/user')
+    conn.get('/user')
+    response = conn.get('/rate_limit')
+    assert_equal 0, response.body['rate']['remaining']
+  end
+
+  private
+
+  def create_connection
+    Faraday.new(url: 'https://api.github.com') do |f|
+      f.use Fbe::Middleware::RateLimit
+      f.response :json
+      f.adapter :net_http
+    end
+  end
+end

data/test/fbe/test_conclude.rb

@@ -79,11 +79,7 @@ class TestConclude < Fbe::Test
       }
     )
     stub_request(:get, 'https://api.github.com/rate_limit').to_return(
-      { body: 'hm...', headers: { 'X-RateLimit-Remaining' => '777' } },
-      { body: 'hm...', headers: { 'X-RateLimit-Remaining' => '777' } },
-      { body: 'hm...', headers: { 'X-RateLimit-Remaining' => '777' } },
-      { body: 'hm...', headers: { 'X-RateLimit-Remaining' => '999' } },
-      { body: 'hm...', headers: { 'X-RateLimit-Remaining' => '9' } }
+      { body: '{"rate":{"remaining":51}}', headers: { 'X-RateLimit-Remaining' => '51' } }
     )
     global = {}
     o = Fbe.octo(loog: Loog::NULL, options:, global:)

data/test/fbe/test_octo.rb

@@ -99,7 +99,7 @@ class TestOcto < Fbe::Test
   def test_caching
     WebMock.disable_net_connect!
     stub_request(:get, 'https://api.github.com/rate_limit').to_return(
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } }
+      { body: '{"rate":{"remaining":222}}', headers: { 'X-RateLimit-Remaining' => '222' } }
     )
     global = {}
     o = Fbe.octo(loog: Loog::NULL, global:, options: Judges::Options.new)
@@ -133,12 +133,10 @@ class TestOcto < Fbe::Test
   def test_off_quota?
     WebMock.disable_net_connect!
     stub_request(:get, 'https://api.github.com/rate_limit').to_return(
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '333' } },
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '333' } },
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '3' } }
+      { body: '{"rate":{"remaining":50}}', headers: { 'X-RateLimit-Remaining' => '50' } }
     )
     stub_request(:get, 'https://api.github.com/user/42').to_return(
-      body: '', headers: { 'X-RateLimit-Remaining' => '3' }
+      body: '', headers: { 'X-RateLimit-Remaining' => '49' }
     )
     o = Fbe.octo(loog: Loog::NULL, global: {}, options: Judges::Options.new)
     refute_predicate(o, :off_quota?)
@@ -149,11 +147,7 @@ class TestOcto < Fbe::Test
   def test_off_quota_twice
     WebMock.disable_net_connect!
     stub_request(:get, 'https://api.github.com/rate_limit').to_return(
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '333' } },
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '333' } },
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '333' } },
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '5555' } },
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '5' } }
+      { body: '{"rate":{"remaining":51}}', headers: { 'X-RateLimit-Remaining' => '51' } }
     )
     stub_request(:get, 'https://api.github.com/user/42').to_return(
       { body: '', headers: { 'X-RateLimit-Remaining' => '5555' } },
@@ -372,9 +366,9 @@ class TestOcto < Fbe::Test
     loog = Loog::Buffer.new
     WebMock.disable_net_connect!
     stub_request(:get, 'https://api.github.com/rate_limit').to_return(
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } },
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } },
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } }
+      { body: '{"rate":{"remaining":222}}', headers: { 'X-RateLimit-Remaining' => '222' } },
+      { body: '{"rate":{"remaining":222}}', headers: { 'X-RateLimit-Remaining' => '222' } },
+      { body: '{"rate":{"remaining":222}}', headers: { 'X-RateLimit-Remaining' => '222' } }
     )
     stub_request(:get, 'https://api.github.com/user/123').to_return do
       {
@@ -396,9 +390,9 @@ class TestOcto < Fbe::Test
     octo.repository('foo/bar')
     octo.print_trace!(all: true, max: 9_999)
     output = loog.to_s
-    assert_includes output, '3 URLs vs 6 requests'
-    assert_includes output, '222 quota left'
-    assert_includes output, '/rate_limit: 3'
+    assert_includes output, '3 URLs vs 4 requests'
+    assert_includes output, '219 quota left'
+    assert_includes output, '/rate_limit: 1'
     assert_includes output, '/user/123: 1'
     assert_includes output, '/repos/foo/bar: 2'
     repo_index = output.index('/repos/foo/bar: 2')
@@ -539,19 +533,13 @@ class TestOcto < Fbe::Test
   def test_fetch_rate_limit_by_making_new_request
     WebMock.disable_net_connect!
     stub_request(:get, 'https://api.github.com/rate_limit').to_return(
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '321' } }
-    ).to_return(
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '123' } }
-    ).to_return(
-      { body: '{}', headers: { 'X-RateLimit-Remaining' => '1' } }
-    ).to_raise(StandardError.new('no more requests to https://api.github.com/rate_limit'))
+      { body: '{"rate":{"remaining":321}}', headers: { 'X-RateLimit-Remaining' => '321' } }
+    )
     loog = Loog::Buffer.new
     o = Fbe.octo(loog:, global: {}, options: Judges::Options.new)
     refute_predicate(o, :off_quota?)
     assert_match(/321 GitHub API quota left/, loog.to_s)
     o.print_trace!(all: true)
-    assert_match(/123 quota left/, loog.to_s)
-    assert_predicate(o, :off_quota?)
-    assert_match(/1 GitHub API quota left/, loog.to_s)
+    assert_match(/321 quota left/, loog.to_s)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.23.4
+  version: 0.23.6
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -363,6 +363,7 @@ files:
 - lib/fbe/just_one.rb
 - lib/fbe/middleware.rb
 - lib/fbe/middleware/formatter.rb
+- lib/fbe/middleware/rate_limit.rb
 - lib/fbe/middleware/sqlite_store.rb
 - lib/fbe/middleware/trace.rb
 - lib/fbe/octo.rb
@@ -376,6 +377,7 @@ files:
 - renovate.json
 - rules/basic.fe
 - test/fbe/middleware/test_formatter.rb
+- test/fbe/middleware/test_rate_limit.rb
 - test/fbe/middleware/test_sqlite_store.rb
 - test/fbe/middleware/test_trace.rb
 - test/fbe/test_award.rb