fbe 0.0.67 → 0.0.69

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5adb2d9b9ca4a9d11bc4ef76e9cd92242af706e932b6df13b2344280d7cb9767
-  data.tar.gz: 55252a1f89312bf2bd6fc37a7e32fc6059d31630e77ab46d40ef2619a4eefe14
+  metadata.gz: a538e70cd251261fa8b1a980051cfd90195c79e291cbcc08431ae3a78481b5e7
+  data.tar.gz: 7492622c36dedef8fa2582cd47ecacf4006dec00244b28b0f8832ca68eb81bc8
 SHA512:
-  metadata.gz: 66386a3fe388c6c718b16e5cb64cca0c13d6b0244137b97fd8d361b47d9e2cb790c8faf09f29053f49a9daf8a7e4991fd7c7b3cdd22a30bc0cbeb49f21549daf
-  data.tar.gz: bc4006107a15beb21074be870ad5d909188c3cc91d18bfb4929da12560f822c0e6a39b4026f8491530ee291a6631490d2e33f6ebc0ec26b74fe7b9d619ed3afd
+  metadata.gz: 9d4c8417052d583b4a83177771c75c7cee4567a2e56f3522d6bd34cd81eeeafaa7328f38d251345023dbaca9b76fcc3cdda9b0252bb1ff8a5edee6702c49eb09
+  data.tar.gz: ef57a016e97e85e12da1426a97557f0d54d059b34fcfc07246e82124141726d9e82326f4d86bdea3394337823b35b48568652be0ad0c5a175b854bc243497da9

data/.rultor.yml

@@ -19,7 +19,7 @@
 # SOFTWARE.
 ---
 docker:
-  image: yegor256/rultor-image:1.23.1
+  image: yegor256/rultor-ruby
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
 install: |

data/Gemfile

@@ -29,7 +29,7 @@ gem 'minitest-reporters', '1.7.1', require: false
 gem 'rake', '13.2.1', require: false
 gem 'rspec-rails', '7.0.1', require: false
 gem 'rubocop', '1.66.1', require: false
-gem 'rubocop-performance', '1.22.0', require: false
+gem 'rubocop-performance', '1.22.1', require: false
 gem 'rubocop-rspec', '3.0.5', require: false
 gem 'simplecov', '0.22.0', require: false
 gem 'simplecov-cobertura', '2.1.0', require: false

data/Gemfile.lock

@@ -240,7 +240,7 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.32.3)
       parser (>= 3.3.1.0)
-    rubocop-performance (1.22.0)
+    rubocop-performance (1.22.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rspec (3.0.5)
@@ -297,7 +297,7 @@ DEPENDENCIES
   rake (= 13.2.1)
   rspec-rails (= 7.0.1)
   rubocop (= 1.66.1)
-  rubocop-performance (= 1.22.0)
+  rubocop-performance (= 1.22.1)
   rubocop-rspec (= 3.0.5)
   simplecov (= 0.22.0)
   simplecov-cobertura (= 2.1.0)

data/lib/fbe/github_graph.rb

@@ -108,6 +108,27 @@ class Fbe::Graph
     result.repository.ref.target.history.total_count
   end
 
+  def total_issues_and_pulls(owner, name)
+    result = query(
+      <<~GRAPHQL
+        {
+          repository(owner: "#{owner}", name: "#{name}") {
+            issues {
+              totalCount
+            }
+            pullRequests {
+              totalCount
+            }
+          }
+        }
+      GRAPHQL
+    ).to_h
+    {
+      'issues' => result.dig('repository', 'issues', 'totalCount') || 0,
+      'pulls' => result.dig('repository', 'pullRequests', 'totalCount') || 0
+    }
+  end
+
   # The HTTP class
   class HTTP < GraphQL::Client::HTTP
     def initialize(token, host)
@@ -135,6 +156,13 @@ class Fbe::Graph
       data[:"#{owner}_#{name}"] || []
     end
 
+    def total_issues_and_pulls(_owner, _name)
+      {
+        'issues' => 23,
+        'pulls' => 19
+      }
+    end
+
     private
 
     def conversation(id)

data/lib/fbe/middleware/logging_formatter.rb

@@ -0,0 +1,63 @@
+# 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/lib/fbe/octo.rb

@@ -32,6 +32,7 @@ require 'faraday/retry'
 require_relative '../fbe'
 require_relative 'middleware'
 require_relative 'middleware/quota'
+require_relative 'middleware/logging_formatter'
 
 # Interface to GitHub API.
 #
@@ -91,7 +92,17 @@ 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::NULL)
+            builder.use(
+              Faraday::Response::Logger,
+              loog,
+              {
+                formatter: Fbe::Middleware::LoggingFormatter,
+                log_only_errors: true,
+                headers: true,
+                bodies: true,
+                errors: false
+              }
+            )
             builder.adapter(Faraday.default_adapter)
           end
         o.middleware = stack
@@ -452,7 +463,7 @@ class Fbe::FakeOctokit
             number: 10,
             title: 'Awesome PR 10',
             created_at: Time.parse('2024-08-21 19:00:00 UTC'),
-            merged_at: Time.parse('2024-08-23 19:00:00 UTC')
+            pull_request: { merged_at: Time.parse('2024-08-23 19:00:00 UTC') }
           }
         ]
       }

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.67'
+  VERSION = '0.0.69'
 end

data/test/fbe/middleware/test_logging_formatter.rb

@@ -0,0 +1,99 @@
+# 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

data/test/fbe/test_github_graph.rb

@@ -122,4 +122,13 @@ class TestGitHubGraph < Minitest::Test
     result = graph.resolved_conversations('zerocracy', 'baza', 172)
     assert_equal(1, result.count)
   end
+
+  def test_total_issues_and_pulls
+    WebMock.disable_net_connect!
+    graph = Fbe.github_graph(options: Judges::Options.new('testing' => true), loog: Loog::NULL, global: {})
+    result = graph.total_issues_and_pulls('zerocracy', 'fbe')
+    refute_empty(result)
+    assert_equal(23, result['issues'])
+    assert_equal(19, result['pulls'])
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.0.67
+  version: 0.0.69
 platform: ruby
 authors:
 - Yegor Bugayenko
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-17 00:00:00.000000000 Z
+date: 2024-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -272,6 +272,7 @@ files:
 - lib/fbe/iterate.rb
 - lib/fbe/just_one.rb
 - lib/fbe/middleware.rb
+- lib/fbe/middleware/logging_formatter.rb
 - lib/fbe/middleware/quota.rb
 - lib/fbe/octo.rb
 - lib/fbe/overwrite.rb
@@ -283,6 +284,7 @@ files:
 - lib/fbe/who.rb
 - renovate.json
 - rules/basic.fe
+- test/fbe/middleware/test_logging_formatter.rb
 - test/fbe/middleware/test_quota.rb
 - test/fbe/test_award.rb
 - test/fbe/test_bylaws.rb
@@ -309,7 +311,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -326,7 +328,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: FactBase Extended (FBE), a collection of utility classes for Zerocracy judges
 test_files: []