net_http_wrapper 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ba9d676fb9ac9e647a7dfe07c7af79e9259d20db79a3de283cedcb71b773786
+  data.tar.gz: 5c20e8bb7508fa43fa5fcd86cc052e08aab666da25a3f74d07965ef14c481571
+SHA512:
+  metadata.gz: aa524bd45bb786f56c581423e82d30a9553242bbe71a5e1e0a7536ca0b20a2fbf1ecac7322e86905f0cb7d6378b9728fa6c71694b3b5cee0b5c9009aecb92353
+  data.tar.gz: 7ffcfe898f9e9c29b7077e560eef0e3b08425e3d5ddda261916eb9993e8c27a7bea9f8519caeb6f0c418aba8d07cebd4a5146b598cbfa28bbbd2ee5e9279ad24

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Metrics/LineLength:
+  Max: 100
+Metrics/BlockLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in http_wrapper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    net_http_wrapper (0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.8)
+    jaro_winkler (1.5.2)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.64.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    safe_yaml (1.0.4)
+    unicode-display_width (1.4.1)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  net_http_wrapper!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  webmock (~> 3.5.1)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,75 @@
+# NetHttpWrapper
+[![Build Status](https://travis-ci.org/DimaSamodurov/net_http_wrapper.svg?branch=master)](https://travis-ci.org/DimaSamodurov/net_http_wrapper)
+[![Code Climate](https://api.codeclimate.com/v1/badges/83512d69c7a20acd6582/maintainability)](https://codeclimate.com/github/DimaSamodurov/net_http_wrapper/maintainability)
+
+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. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'net_http_wrapper'
+```
+
+## Usage
+
+Register the `after_request` callback as follows:
+
+```ruby
+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):
+```ruby
+NetHttpWrapper.enable
+```
+
+### Example
+
+Snippet below can be added as an initializer to Rails application.
+
+```ruby
+NetHttpWrapper.enable
+
+NetHttpWrapper.after_request do |http:, request:, response:, start_time:|
+  request_duration = (Time.now - start_time).round(3)
+  request_url =
+    URI.decode("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
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 
+Then, run `rake spec` to run the tests, and run `rubocop` to check code style.
+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 tags, 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/dimasamodurov/net_http_wrapper.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'net_http_wrapper'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/net_http_wrapper.rb

@@ -0,0 +1,61 @@
+require 'net_http_wrapper/version'
+require 'net/http'
+
+# Allows registering callbacks on `Net::HTTP#request` method.
+module NetHttpWrapper
+  class Error < StandardError
+  end
+
+  # Defines methods to be available on NetHttpWrapper class.
+  module DSL
+    def enable
+      Net::HTTP.prepend NetHttpWrapper
+      @enabled = true
+    end
+
+    def disable
+      @enabled = false
+    end
+
+    def enabled?
+      @enabled
+    end
+
+    # Registers a callback that will be called upon request completion.
+    #
+    # Callback will receive following parameters:
+    # - http:  HTTP instance,
+    # - request: HTTP Request,
+    # - response: HTTP Response,
+    # - start_time: Request Start Time
+    #
+    # Example:
+    #   NetHttpWrapper.after_request do |http:, request:, response:, start_time:|
+    #     # e.g. log request duration
+    #   end
+    def after_request(&block)
+      after_request_callbacks << block
+    end
+
+    # List of registered callbacks to be executed upon the request completion.
+    def after_request_callbacks
+      @after_request_callbacks ||= []
+    end
+  end
+
+  extend DSL
+
+  def request(req, body = nil, &block)
+    start_time = Time.now
+    super.tap do |resp|
+      next unless NetHttpWrapper.enabled?
+
+      NetHttpWrapper.after_request_callbacks.each do |callback|
+        callback.call(http: self,
+                      request: req,
+                      response: resp,
+                      start_time: start_time)
+      end
+    end
+  end
+end

data/lib/net_http_wrapper/version.rb

@@ -0,0 +1,3 @@
+module NetHttpWrapper
+  VERSION = '0.0.2'.freeze
+end

data/net_http_wrapper.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'net_http_wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'net_http_wrapper'
+  spec.version       = NetHttpWrapper::VERSION
+  spec.authors       = ['Dmytro Samodurov']
+  spec.email         = ['dimasamodurov@gmail.com']
+
+  spec.summary       = 'Net::HTTP request wrapper.'
+  spec.description   = 'Wraps Net::HTTP requests e.g. for logging purposes.'
+  spec.homepage      = 'https://github.com/dimasamodurov/net_http_wrapper'
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.5.1'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: net_http_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Dmytro Samodurov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-13 00:00:00.000000000 Z
+dependencies:
+- !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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wraps Net::HTTP requests e.g. for logging purposes.
+email:
+- dimasamodurov@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/net_http_wrapper.rb
+- lib/net_http_wrapper/version.rb
+- net_http_wrapper.gemspec
+homepage: https://github.com/dimasamodurov/net_http_wrapper
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Net::HTTP request wrapper.
+test_files: []