faraday-verbose_ws_wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68f92cf8c6145a5f3ef7c114d7c97cb96626a4330b40025847b7c1e9332d3e08
+  data.tar.gz: 687f464c1360f5a37e13d11a8b7152638b6c315c984a852547497b24c56b838e
+SHA512:
+  metadata.gz: bb384a47db930911cc668156d77efacdad0d91534cb73e23e692a14c4182765518ea81b5efa8d1f3d7e2fcba5104164a18213fc8bd6a174f02dee3210c705a72
+  data.tar.gz: cfd1cbcf3203f403bb246d256579f9b80f2630e9fb0fb754878360899d3de4bfba40e207ea5309229a3f4bf944368d9ccdac66c6ef8e9176db08f62962a6874b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Unreleased
+
+*   Initial release.

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 masciugo
+
+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,54 @@
+# Faraday Verbose Ws Wrapper
+
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/masciugo/faraday-verbose_ws_wrapper/ci)](https://github.com/masciugo/faraday-verbose_ws_wrapper/actions?query=branch%3Amain)
+[![Gem](https://img.shields.io/gem/v/faraday-verbose_ws_wrapper.svg?style=flat-square)](https://rubygems.org/gems/faraday-verbose_ws_wrapper)
+[![License](https://img.shields.io/github/license/masciugo/faraday-verbose_ws_wrapper.svg?style=flat-square)](LICENSE.md)
+
+faraday middleware to make Rails logger more verbose.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-verbose_ws_wrapper'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install faraday-verbose_ws_wrapper
+```
+
+## Usage
+
+```ruby
+require 'faraday/verbose_ws_wrapper'
+
+# TODO
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+Then, run `bin/test` to run the tests.
+
+To install this gem onto your local machine, run `rake build`.
+
+To release a new version, make a commit with a message such as "Bumped to 0.0.2" and then run `rake release`.
+See how it works [here](https://bundler.io/guides/creating_gem.html#releasing-the-gem).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/masciugo/faraday-verbose_ws_wrapper).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/faraday/verbose_ws_wrapper/middleware.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Faraday
+  module VerboseWsWrapper
+    # This class provides the main implementation for your middleware.
+    # Your middleware can implement any of the following methods:
+    # * on_request - called when the request is being prepared
+    # * on_complete - called when the response is being processed
+    #
+    # Optionally, you can also override the following methods from Faraday::Middleware
+    # * initialize(app, options = {}) - the initializer method
+    # * call(env) - the main middleware invocation method.
+    #   This already calls on_request and on_complete, so you normally don't need to override it.
+    #   You may need to in case you need to "wrap" the request or need more control
+    #   (see "retry" middleware: https://github.com/lostisland/faraday/blob/main/lib/faraday/request/retry.rb#L142).
+    #   IMPORTANT: Remember to call `@app.call(env)` or `super` to not interrupt the middleware chain!
+    class Middleware < Faraday::Middleware
+
+      attr_writer :tag, :log_body, :color
+
+      def initialize(env, tag, options = {})
+        options.reverse_merge!({log_body: false})
+        super(env)
+        self.tag = tag
+        self.log_body = options[:log_body]
+        self.color = options[:color] || :gray
+      end
+
+      def call(env)
+        req_id = env.request_headers["X-Request-ID"] = SecureRandom.uuid
+        tags = [@tag.send(@color).bold]
+        tags << req_id.send(@color) unless Rails.env.development?
+        Rails.logger.tagged tags do
+          msg = ">> #{env.method} #{env.url}".send(@color)
+          msg += " body: #{env.body.to_json}" if @log_body
+          Rails.logger.info { msg }
+          @app.call(env).on_complete do |env|
+            raise 'request and response has differnet X-Request-ID header' if req_id != env.response_headers['X-Request-ID']
+            Rails.logger.info { "<< #{env.status} in #{env.response_headers['X-Runtime'].to_f * 1000 } ms" }
+            Rails.logger.debug { "<< #{env.response.body}" }
+          end
+        end
+      end
+
+      # # This method will be called when the request is being prepared.
+      # # You can alter it as you like, accessing things like request_body, request_headers, and more.
+      # # Refer to Faraday::Env for a list of accessible fields:
+      # # https://github.com/lostisland/faraday/blob/main/lib/faraday/options/env.rb
+      # #
+      # # @param env [Faraday::Env] the environment of the request being processed
+      # def on_request(env)
+      #   # Do something with the request environment...
+      #   # This method is optional.
+      # end
+
+      # # This method will be called when the response is being processed.
+      # # You can alter it as you like, accessing things like response_body, response_headers, and more.
+      # # Refer to Faraday::Env for a list of accessible fields:
+      # # https://github.com/lostisland/faraday/blob/main/lib/faraday/options/env.rb
+      # #
+      # # @param env [Faraday::Env] the environment of the response being processed.
+      # def on_complete(env)
+      #   # Do something with the response environment...
+      #   # This method is optional.
+      # end
+    end
+  end
+end

data/lib/faraday/verbose_ws_wrapper/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Faraday
+  module VerboseWsWrapper
+    VERSION = '0.1.0'
+  end
+end

data/lib/faraday/verbose_ws_wrapper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'verbose_ws_wrapper/middleware'
+require_relative 'verbose_ws_wrapper/version'
+
+module Faraday
+  # This will be your middleware main module, though the actual middleware implementation will go
+  # into Faraday::VerboseWsWrapper::Middleware for the correct namespacing.
+  module VerboseWsWrapper
+    # Faraday allows you to register your middleware for easier configuration.
+    # This step is totally optional, but it basically allows users to use a
+    # custom symbol (in this case, `:verbose_ws_wrapper`), to use your middleware in their connections.
+    # After calling this line, the following are both valid ways to set the middleware in a connection:
+    # * conn.use Faraday::VerboseWsWrapper::Middleware
+    # * conn.use :verbose_ws_wrapper
+    # Without this line, only the former method is valid.
+    # Faraday::Middleware.register_middleware(verbose_ws_wrapper: Faraday::VerboseWsWrapper::Middleware)
+
+    # Alternatively, you can register your middleware under Faraday::Request or Faraday::Response.
+    # This will allow to load your middleware using the `request` or `response` methods respectively.
+    #
+    # Load middleware with conn.request :verbose_ws_wrapper
+    Faraday::Request.register_middleware(verbose_ws_wrapper: Faraday::VerboseWsWrapper::Middleware)
+    #
+    # Load middleware with conn.response :verbose_ws_wrapper
+    # Faraday::Response.register_middleware(verbose_ws_wrapper: Faraday::VerboseWsWrapper::Middleware)
+  end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: faraday-verbose_ws_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- masciugo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 'faraday middleware to make Rails logger more verbose.
+
+  '
+email:
+- masciugo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/faraday/verbose_ws_wrapper.rb
+- lib/faraday/verbose_ws_wrapper/middleware.rb
+- lib/faraday/verbose_ws_wrapper/version.rb
+homepage: https://github.com/masciugo/faraday-verbose_ws_wrapper
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/masciugo/faraday-verbose_ws_wrapper/issues
+  changelog_uri: https://github.com/masciugo/faraday-verbose_ws_wrapper/blob/v0.1.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-verbose_ws_wrapper/0.1.0
+  homepage_uri: https://github.com/masciugo/faraday-verbose_ws_wrapper
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/masciugo/faraday-verbose_ws_wrapper
+  wiki_uri: https://github.com/masciugo/faraday-verbose_ws_wrapper/wiki
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: faraday middleware to make Rails logger more verbose
+test_files: []