fbe 0.0.82 → 0.0.83

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51fe0b687df4a15c1472d3a88588801a8d8c000be7004f0d8537de7e1813ace5
-  data.tar.gz: cbb8890bdc7c56264a3d9e316c0d4b682ec230a234323f3ce23efbf703ea4a36
+  metadata.gz: 650928bcebcf4d25d8f9d1cb38036a3ffddc9169316692023b3be534ccfadf39
+  data.tar.gz: 2ee99b9be72972ad948457f2c636a746d48161a9e7b3840f00926a39bfa9e7a8
 SHA512:
-  metadata.gz: 926492d589e6740135445210ae19dbaa60b99b3cb9fecdbdead14002fa4865eb98c0d35ab9e86b976c6cbc4809884ce0a24c6476a3622163bc141c0180b7dae0
-  data.tar.gz: d43ea58b294e127c1d016b678de8a63e69d09ca1e28c69267a92a8b018a2ae54b32b177eefce41af1e1cdb4824f3308983d616aac85421b27bed6f51f59350b9
+  metadata.gz: aad6fbd2f387ac6fe8f88111f57e301224279a288ca45d447b3a66f3dba9cc53276438966a68f86544df7e49cbc9b92dcb075a55db29a2c086d8a083d8ae43d1
+  data.tar.gz: 5c4b9b4379a7565b5e06e2458474d4710f7b4c78791d389fd66da3b14029ea2fbb5e244b86ca69b2555db2edaa6611857f84f268f7f6581950dee7c4f9d73b86

data/Gemfile.lock

@@ -86,7 +86,7 @@ GEM
     elapsed (0.0.1)
       loog (> 0)
       tago (> 0)
-    erubi (1.13.0)
+    erubi (1.13.1)
     ethon (0.16.0)
       ffi (>= 1.15.0)
     factbase (0.4.0)
@@ -130,8 +130,8 @@ GEM
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     iri (0.8.0)
-    json (2.9.0)
-    judges (0.27.0)
+    json (2.9.1)
+    judges (0.28.1)
       backtrace (~> 0)
       baza.rb (~> 0)
       concurrent-ruby (~> 1.2)
@@ -148,7 +148,7 @@ GEM
       typhoeus (~> 1.3)
     language_server-protocol (3.17.0.3)
     liquid (5.5.1)
-    logger (1.6.3)
+    logger (1.6.4)
     loofah (2.23.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -290,6 +290,7 @@ GEM
 PLATFORMS
   arm64-darwin-22
   arm64-darwin-23
+  arm64-darwin-24
   x64-mingw-ucrt
   x86_64-darwin-20
   x86_64-darwin-21
@@ -311,4 +312,4 @@ DEPENDENCIES
   yard (= 0.9.37)
 
 BUNDLED WITH
-   2.4.22
+   2.5.16

data/lib/fbe/iterate.rb

@@ -175,15 +175,15 @@ class Fbe::Iterate
         end
       end
       if oct.off_quota
-        @loog.debug('We are off GitHub quota, time to stop')
+        @loog.info("We are off GitHub quota, time to stop after #{start.ago}")
         break
       end
       unless seen.any? { |r, v| v < @repeats && !restarted.include?(r) }
-        @loog.debug("No more repos to scan (out of #{repos.size}), quitting")
+        @loog.debug("No more repos to scan (out of #{repos.size}), quitting after #{start.ago}")
         break
       end
       if restarted.size == repos.size
-        @loog.debug("All #{repos.size} repos restarted, quitting")
+        @loog.debug("All #{repos.size} repos restarted, quitting after #{start.ago}")
         break
       end
     end

data/lib/fbe/middleware/formatter.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# MIT License
+#
+# Copyright (c) 2024 Zerocracy
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'faraday/logging/formatter'
+require_relative '../../fbe'
+require_relative '../../fbe/middleware'
+
+# Faraday logging formatter show verbose log for only error response
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Zerocracy
+# License:: MIT
+class Fbe::Middleware::Formatter < Faraday::Logging::Formatter
+  # Log HTTP request.
+  #
+  # @param [Hash] http The hash with data about HTTP request
+  def request(http)
+    @req = http
+  end
+
+  # Log HTTP response.
+  #
+  # @param [Hash] http The hash with data about HTTP response
+  def response(http)
+    return if http.status < 400
+    if http.status == 403 && http.response_headers['content-type'].start_with?('application/json')
+      warn(
+        [
+          "#{@req.method.upcase} #{apply_filters(@req.url.to_s)}",
+          '->',
+          http.status,
+          '/',
+          JSON.parse(http.response_body)['message']
+        ].join(' ')
+      )
+      return
+    end
+    error(
+      [
+        "#{@req.method.upcase} #{apply_filters(@req.url.to_s)} HTTP/1.1",
+        shifted(apply_filters(dump_headers(@req.request_headers))),
+        '',
+        shifted(apply_filters(@req.request_body)),
+        "HTTP/1.1 #{http.status}",
+        shifted(apply_filters(dump_headers(http.response_headers))),
+        '',
+        shifted(apply_filters(http.response_body))
+      ].join("\n")
+    )
+  end
+
+  private
+
+  def shifted(txt)
+    return '' if txt.nil?
+    "  #{txt.gsub("\n", "\n  ")}"
+  end
+
+  def dump_headers(headers)
+    return '' if headers.nil?
+    headers.map { |k, v| "#{k}: #{v.inspect}" }.join("\n")
+  end
+end

data/lib/fbe/middleware/quota.rb

@@ -51,9 +51,7 @@ class Fbe::Middleware::Quota < Faraday::Middleware
     @requests += 1
     response = @app.call(env)
     if out_of_limit?(env)
-      @loog.info(
-        "Too much GitHub API quota consumed, pausing for #{@pause} seconds"
-      )
+      @loog.info("Too much GitHub API quota consumed, pausing for #{@pause} seconds")
       sleep(@pause)
       @requests = 0
     end

data/lib/fbe/octo.rb

@@ -31,7 +31,7 @@ require 'octokit'
 require 'verbose'
 require_relative '../fbe'
 require_relative 'middleware'
-require_relative 'middleware/logging_formatter'
+require_relative 'middleware/formatter'
 require_relative 'middleware/quota'
 
 # Makes a call to the GitHub API.
@@ -93,17 +93,7 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
             builder.use(Fbe::Middleware::Quota, loog:, pause: options.github_api_pause || 60)
             builder.use(Faraday::HttpCache, serializer: Marshal, shared_cache: false, logger: Loog::NULL)
             builder.use(Octokit::Response::RaiseError)
-            builder.use(
-              Faraday::Response::Logger,
-              loog,
-              {
-                formatter: Fbe::Middleware::LoggingFormatter,
-                log_only_errors: true,
-                headers: true,
-                bodies: true,
-                errors: false
-              }
-            )
+            builder.use(Faraday::Response::Logger, loog, formatter: Fbe::Middleware::Formatter)
             builder.adapter(Faraday.default_adapter)
           end
         o.middleware = stack

data/lib/fbe.rb

@@ -27,5 +27,5 @@
 # License:: MIT
 module Fbe
   # Current version of the gem (changed by +.rultor.yml+ on every release)
-  VERSION = '0.0.82'
+  VERSION = '0.0.83'
 end

data/test/fbe/middleware/test_formatter.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# MIT License
+#
+# Copyright (c) 2024 Zerocracy
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'faraday'
+require 'loog'
+require 'minitest/autorun'
+require_relative '../../../lib/fbe'
+require_relative '../../../lib/fbe/middleware'
+require_relative '../../../lib/fbe/middleware/formatter'
+
+# Test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Zerocracy
+# License:: MIT
+class LoggingFormatterTest < Minitest::Test
+  def test_success_response
+    log_it(status: 200) do |loog|
+      assert_empty(loog.to_s)
+    end
+  end
+
+  def test_forward_response
+    log_it(status: 303) do |loog|
+      assert_empty(loog.to_s)
+    end
+  end
+
+  def test_error_response
+    log_it(status: 401) do |loog|
+      str = loog.to_s
+      refute_empty(str)
+      assert_match(%r{http://example.com}, str)
+      assert_match(/Authorization:/, str)
+      assert_match(%r{HTTP/1.1 401}, str)
+      assert_match(/x-github-api-version-selected: "2022-11-28"/, str)
+      assert_match(/hello, world!/, str)
+      assert_match(/request body/, str)
+    end
+  end
+
+  def test_limit_response
+    log_it(status: 403) do |loog|
+      str = loog.to_s
+      refute_empty(str)
+    end
+  end
+
+  private
+
+  def log_it(status:, method: :get)
+    loog = Loog::Buffer.new
+    formatter = Fbe::Middleware::Formatter.new(logger: loog, options: {})
+    formatter.request(
+      Faraday::Env.from(
+        {
+          method:,
+          request_body: 'some request body',
+          url: URI('http://example.com'),
+          request_headers: {
+            'Authorization' => 'Bearer github_pat_11AAsecret'
+          }
+        }
+      )
+    )
+    formatter.response(
+      Faraday::Env.from(
+        {
+          status:,
+          response_body: '{"message": "hello, world!"}',
+          response_headers: {
+            'content-type' => 'application/json',
+            'x-github-api-version-selected' => '2022-11-28'
+          }
+        }
+      )
+    )
+    yield loog
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.0.82
+  version: 0.0.83
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-19 00:00:00.000000000 Z
+date: 2024-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -287,7 +287,7 @@ files:
 - lib/fbe/iterate.rb
 - lib/fbe/just_one.rb
 - lib/fbe/middleware.rb
-- lib/fbe/middleware/logging_formatter.rb
+- lib/fbe/middleware/formatter.rb
 - lib/fbe/middleware/quota.rb
 - lib/fbe/octo.rb
 - lib/fbe/overwrite.rb
@@ -299,7 +299,7 @@ files:
 - lib/fbe/who.rb
 - renovate.json
 - rules/basic.fe
-- test/fbe/middleware/test_logging_formatter.rb
+- test/fbe/middleware/test_formatter.rb
 - test/fbe/middleware/test_quota.rb
 - test/fbe/test_award.rb
 - test/fbe/test_bylaws.rb

data/lib/fbe/middleware/logging_formatter.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-# MIT License
-#
-# Copyright (c) 2024 Zerocracy
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-require 'faraday'
-
-# Faraday logging formatter show verbose log for only error response
-class Fbe::Middleware::LoggingFormatter < Faraday::Logging::Formatter
-  AUTHORIZATION_FILTER = [/(Authorization: )([^&]+)([^&]{5})/, '\1********\3'].freeze
-
-  def initialize(**)
-    super
-    filter(*AUTHORIZATION_FILTER)
-  end
-
-  def request(env)
-    super unless log_only_errors?
-  end
-
-  def response(env)
-    return super unless log_only_errors?
-    request_with_response(env) if env.status.nil? || env.status >= 400
-  end
-
-  def request_with_response(env)
-    oll = @options[:log_level]
-    @options[:log_level] = :error
-    public_send(log_level, 'request') do
-      "#{env.method.upcase} #{apply_filters(env.url.to_s)}"
-    end
-    log_headers('request', env.request_headers) if log_headers?(:request)
-    log_body('request', env[:request_body]) if env[:request_body] && log_body?(:request)
-    public_send(log_level, 'response') { "Status #{env.status}" }
-    log_headers('response', env.response_headers) if log_headers?(:response)
-    log_body('response', env[:response_body]) if env[:response_body] && log_body?(:response)
-    @options[:log_level] = oll
-    nil
-  end
-
-  def log_only_errors?
-    @options[:log_only_errors]
-  end
-end

data/test/fbe/middleware/test_logging_formatter.rb

@@ -1,99 +0,0 @@
-# frozen_string_literal: true
-
-# MIT License
-#
-# Copyright (c) 2024 Zerocracy
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-require 'minitest/autorun'
-require 'faraday'
-require 'loog'
-require_relative '../../../lib/fbe/middleware'
-require_relative '../../../lib/fbe/middleware/logging_formatter'
-
-class LoggingFormatterTest < Minitest::Test
-  def test_success_response_with_debug_log_level
-    run_logging_formatter(status: 200, log_level: Logger::DEBUG) do |logger|
-      assert_empty(logger.to_s)
-    end
-  end
-
-  def test_success_response_with_error_log_level
-    run_logging_formatter(status: 307, log_level: Logger::ERROR) do |logger|
-      assert_empty(logger.to_s)
-    end
-  end
-
-  def test_error_response_with_debug_log_level
-    run_logging_formatter(status: 400, log_level: Logger::DEBUG) do |logger|
-      str = logger.to_s
-      refute_empty(str)
-      assert_match(%r{http://example.com}, str)
-      assert_match(/Authorization: [\*]{8}cret"/, str)
-      assert_match(/Status 400/, str)
-      assert_match(/x-github-api-version-selected: "2022-11-28"/, str)
-      assert_match(/some response body/, str)
-    end
-  end
-
-  def test_error_response_with_error_log_level
-    run_logging_formatter(method: :post, status: 500, log_level: Logger::ERROR) do |logger|
-      str = logger.to_s
-      refute_empty(str)
-      assert_match(%r{http://example.com}, str)
-      assert_match(/Authorization: [\*]{8}cret"/, str)
-      assert_match(/some request body/, str)
-      assert_match(/Status 500/, str)
-      assert_match(/x-github-api-version-selected: "2022-11-28"/, str)
-      assert_match(/some response body/, str)
-    end
-  end
-
-  private
-
-  def run_logging_formatter(status:, log_level:, method: :get)
-    logger = Loog::Buffer.new(level: log_level)
-    options = {
-      log_only_errors: true,
-      headers: true,
-      bodies: true,
-      errors: false
-    }
-    formatter = Fbe::Middleware::LoggingFormatter.new(logger:, options:)
-    env = Faraday::Env.from(
-      {
-        method:,
-        request_body: method == :get ? nil : 'some request body',
-        url: URI('http://example.com'),
-        request_headers: {
-          'Authorization' => 'Bearer github_pat_11AAsecret'
-        }
-      }
-    )
-    formatter.request(env)
-    env[:response_headers] = {
-      'x-github-api-version-selected' => '2022-11-28'
-    }
-    env[:status] = status
-    env[:response_body] = 'some response body'
-    formatter.response(env)
-    yield logger
-  end
-end