NetHttpWrapper

NetHttpWrapper adds callbacks to Net::HTTP requests.

It can be used e.g. for logging purposes, but the library does not make any assumptions on how to do this. It does not add neither additional dependency nor convention to your project.

You can use Rails logger, external service or just print to STDOUT, using format you need.

Add this line to your application's Gemfile:

gem 'net_http_wrapper'

Register the after_request callback as follows:

NetHttpWrapper.after_request do |http:, request:, response:, start_time:|
  # log request/duration, store metrics, analyze response body etc.
end 

You can add multiple callbacks. Callbacks will be called in the same order as registered.

Note: you are responsible for error handling within the block!

Enable the callbacks invocation (initially disabled):

NetHttpWrapper.enable

Snippet below can be added as an initializer to Rails application.

NetHttpWrapper.enable

NetHttpWrapper.after_request do |http:, request:, response:, start_time:|
  request_duration = (Time.now - start_time).round(3)
  request_url =
    "http#{"s" if http.use_ssl?}://#{http.address}:#{http.port}#{request.path}"

  Rails.logger.info(name: 'http_request',
                    method: request.method,
                    url: request_url,
                    status: response.code,
                    duration: request_duration)
end

If you use WebMock, enable wrapper after the WebMock initialization, otherwise WebMock will hide wrapped request and no 'after_request' callbacks will be called.

In RSpec you could do this in 'before' block:

before(:suite) { NetHttpWrapper.enable }

But the following will not work:

allow_any_instance_of(Net::HTTP).to receive(:request) { raise Net::ReadTimeout  }
# =>
# Using `any_instance` to stub a method (request) 
# that has been defined on a prepended module (NetHttpWrapper) is not supported.

As a workaround you could stub 'Net::HTTP.start' in some cases:

allow_any_instance_of(Net::HTTP).to receive(:start) { raise Net::OpenTimeout  }

After checking out the repo, run bin/setup to install dependencies. Then, run rake to run the code style check and the tests. You can also run bundle exec bin/console for an interactive prompt that will allow you to experiment.

You can also see example in action running bundle exec ruby examples/log_to_stdout.rb

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 tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/dimasamodurov/net_http_wrapper.