faraday-logging-color_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ae45ba949e38fd7d48e52261a5a970a9dbc6364418ec3e9d63390f94ec4f2e5
+  data.tar.gz: 9cc5d52fede52c09b37cfdc5cca4a33f6aa8c00787df2a99307782e7025219a7
+SHA512:
+  metadata.gz: a7475d9f73f29aab4631bb938cf1d85af1c14d7649c7ffe48157deb4df7c6178eee2e48ae7cb8e4a173eab47f1a0c7d7b94340f7dee579a78751ae21c40d4985
+  data.tar.gz: b4063955edb24f02e2494b1d9a661eaef4ca006de74c42346208e1b8e3a32fefa3a4d9dd3a801721c0afecff85ff35d4bbca1e3b3470d2307e480f95035d25f5

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - exe/**/*
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 160

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 0.1.0
+#### 2023-01-11
+* Initial commit.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faraday-logging-color_formatter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Kobus Joubert
+
+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.

data/README.md

@@ -0,0 +1,49 @@
+# Faraday::Logging::ColorFormatter
+
+Add some color to your Faraday logging output.
+
+Before...
+
+![before](https://user-images.githubusercontent.com/3071529/212807973-e87213da-d687-4db2-af70-5bb67eb81e0a.png)
+
+After...
+
+![after](https://user-images.githubusercontent.com/3071529/212807978-609ee381-f445-4d98-9994-31f7a4e5caa5.png)
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+Add the following to your ruby program.
+
+    require 'faraday/logging/color_formatter'
+
+And then add the `Faraday::Logging::ColorFormatter` formatter to your logger middleware config.
+
+    connection = Faraday.new(url: 'http://httpbingo.org') do |conn|
+      conn.response :logger, ActiveSupport::Logger.new($stdout), formatter: Faraday::Logging::ColorFormatter
+    end
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests and `rake rubocop` to run the linters. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kobusjoubert/faraday-logging-color_formatter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/faraday-logging-color_formatter.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'lib/faraday/logging/color_formatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'faraday-logging-color_formatter'
+  spec.version = Faraday::Logging::ColorFormatter::VERSION
+  spec.authors = ['Kobus Joubert']
+  spec.email = ['kobus@translate3d.com']
+
+  spec.summary = 'Faraday color logging formatter'
+  spec.description = 'Add some color to your Faraday logging output.'
+  spec.homepage = 'https://github.com/kobusjoubert/faraday-logging-color_formatter'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/kobusjoubert/faraday-logging-color_formatter'
+  spec.metadata['changelog_uri'] = 'https://github.com/kobusjoubert/faraday-logging-color_formatter/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'faraday', '~> 2.1'
+
+  spec.add_development_dependency 'bundler', '~> 2.3'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'rubocop', '~> 1.42'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.16'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/faraday/logging/color_formatter/formatter.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Faraday
+  module Logging
+    module ColorFormatter
+      class Formatter < Faraday::Logging::Formatter
+        ANSI_COLORS = { red: "\e[31m", green: "\e[32m", yellow: "\e[33m", blue: "\e[34m", magenta: "\e[35m", cyan: "\e[36m", reset: "\e[0m" }.freeze
+
+        def request(env)
+          http_request_term = in_color(:blue) { 'HTTP Request' }
+          http_request_log  = in_color(request_log_color(env.method)) { "#{env.method.upcase} #{apply_filters(env.url.to_s)}" }
+
+          request_log = proc { "#{http_request_term}  #{http_request_log}" }
+          public_send(log_level, &request_log)
+
+          log_headers(nil, env.request_headers) if log_headers?(:request)
+          log_body(nil, env[:body]) if env[:body] && log_body?(:request)
+        end
+
+        def response(env)
+          http_response_term = in_color(:blue) { 'HTTP Response' }
+          http_response_log  = in_color(response_log_color(env.status)) { "Status #{env.status}" }
+
+          status = proc { "#{http_response_term}  #{http_response_log}" }
+          public_send(log_level, &status)
+
+          log_headers(nil, env.response_headers) if log_headers?(:response)
+          log_body(nil, env[:body]) if env[:body] && log_body?(:response)
+        end
+
+        private
+
+        def in_color(color)
+          "#{ANSI_COLORS[color]}#{yield}#{ANSI_COLORS[:reset]}"
+        end
+
+        def request_log_color(request_method)
+          case request_method
+          when :post
+            :green
+          when :put, :patch
+            :yellow
+          when :delete
+            :red
+          else
+            :blue
+          end
+        end
+
+        def response_log_color(response_status)
+          case response_status
+          when 100..199
+            :blue
+          when 200..299
+            :green
+          when 300..399
+            :yellow
+          when 400..599
+            :red
+          end
+        end
+      end
+    end
+  end
+end

data/lib/faraday/logging/color_formatter/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Faraday
+  module Logging
+    module ColorFormatter
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/faraday/logging/color_formatter.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'color_formatter/version'
+require_relative 'color_formatter/formatter'
+
+module Faraday
+  module Logging
+    module ColorFormatter
+      class Error < StandardError; end
+
+      class << self
+        def new(...)
+          Faraday::Logging::ColorFormatter::Formatter.new(...)
+        end
+      end
+    end
+  end
+end

data/sig/faraday/logging/color_formatter.rbs

@@ -0,0 +1,8 @@
+module Faraday
+  module Logging
+    module ColorFormatter
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: faraday-logging-color_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kobus Joubert
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.42'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+description: Add some color to your Faraday logging output.
+email:
+- kobus@translate3d.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faraday-logging-color_formatter.gemspec
+- lib/faraday/logging/color_formatter.rb
+- lib/faraday/logging/color_formatter/formatter.rb
+- lib/faraday/logging/color_formatter/version.rb
+- sig/faraday/logging/color_formatter.rbs
+homepage: https://github.com/kobusjoubert/faraday-logging-color_formatter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kobusjoubert/faraday-logging-color_formatter
+  source_code_uri: https://github.com/kobusjoubert/faraday-logging-color_formatter
+  changelog_uri: https://github.com/kobusjoubert/faraday-logging-color_formatter/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.2
+signing_key:
+specification_version: 4
+summary: Faraday color logging formatter
+test_files: []