https://github.com/kobusjoubert/faraday-logging-color_formatter

Faraday color logging formatter
https://github.com/kobusjoubert/faraday-logging-color_formatter

Last synced: about 2 months ago
JSON representation

Faraday color logging formatter

• Host: GitHub
• URL: https://github.com/kobusjoubert/faraday-logging-color_formatter
• Owner: kobusjoubert
• License: mit
• Created: 2023-01-11T06:07:14.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-01-25T05:29:02.000Z (over 1 year ago)
• Last Synced: 2024-07-24T04:43:48.416Z (about 2 months ago)
• Language: Ruby
• Size: 23.4 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-faraday - faraday-logging-color_formatter - A color formatter for the default Faraday logger (Tooling)

README

        
# Faraday::Logging::ColorFormatter

[![Gem Version](https://badge.fury.io/rb/faraday-logging-color_formatter.svg)](https://badge.fury.io/rb/faraday-logging-color_formatter)

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

Install the gem and add to the application's Gemfile by executing:

    $ bundle add faraday-logging-color_formatter

If bundler is not being used to manage dependencies, install the gem by executing:

    $ gem install faraday-logging-color_formatter

## 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

If you want to replace the default `HTTP Request` and `HTTP Response` prefixes or adjust the indentation, pass in a `prefix` hash with your own values.

    connection = Faraday.new(url: 'http://httpbingo.org') do |conn|

      conn.response :logger, ActiveSupport::Logger.new($stdout), formatter: Faraday::Logging::ColorFormatter, prefix: { request: 'request', response: 'response', indent: 2 }

    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).