httplog 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57c207794ceafa4e8185c47cb51bc54dbfceb94e
-  data.tar.gz: 4482066218c96fa8902fb37899d1f0e3026ea4ea
+  metadata.gz: 171da0b013750ec91396725db8f43e91bfaa2044
+  data.tar.gz: 16903e8cc554aff0a9548ce2ee954a1b0cc7217f
 SHA512:
-  metadata.gz: a610095dea85ebd44a2c130de565743d6ef8ca7ddb198ba89c4ed208630fbd61a17571c907710a310d9a18256cefe912c0d27df0ee581d6c33ab3b1b46234d7b
-  data.tar.gz: 2cb8ff4349edec051baf98dc38e999b1ac012f8bb231bab86486ce79d9a0e7c3b2249444ad2f2f930edcc076b4872e8c340257f4480b5f4d733604f9d7bd9564
+  metadata.gz: c68d8a348d96a068fcc72c53d76a7ff270a9fcb53f5bae5502b3f84cded30f3848f4e8a105208b70467c1ea9b50636604b16ca2849f75d3edc460b19f1c2d829
+  data.tar.gz: 57e537dbd5ae1eb6d0b6fff9ba8e7e8a4c528e20b5b29a7d21157b4a47c3bd94feb7c49bc375ccb79256091704ff7792a0ed40f75378addf8a07b4ddd6e406ce

data/.rubocop.yml

@@ -0,0 +1,55 @@
+inherit_from: ./.rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.2
+  Exclude:
+    - 'db/**/*'
+    - 'db/schema.rb'
+    - 'app/assets/**'
+    - 'config/**/*'
+    - 'bin/**/*'
+    - 'node_modules/**/*'
+    - 'public/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - 'doc/**/*'
+    - 'coverage/**/*'
+    - Gemfile
+    - Guardfile
+
+Layout/EmptyLinesAroundBlockBody:
+  EnforcedStyle: no_empty_lines
+  Enabled: true
+
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: no_empty_lines
+  Enabled: true
+
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: no_empty_lines
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Style/Documentation:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: '[]'
+    '%i': '[]'
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,36 @@
+# Offense count: 13
+Metrics/AbcSize:
+  Enabled: false
+
+# Offense count: 43
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Enabled: false
+
+# Offense count: 137
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Enabled: false
+
+# Offense count: 7
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+# Offense count: 195
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: when_needed, always, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 328
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Enabled: false

data/.travis.yml

@@ -15,4 +15,3 @@ script: bundle exec rspec spec
 # workaround for https://github.com/travis-ci/travis-ci/issues/5239:
 before_install:
   - gem install bundler
-  - bundle install

data/Gemfile

@@ -1,2 +1,4 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    httplog (1.0.2)
+    httplog (1.0.3)
       colorize (~> 0.8)
       rack (>= 1.0)
 
@@ -123,4 +123,4 @@ DEPENDENCIES
   thin (~> 1.7)
 
 BUNDLED WITH
-   1.16.0
+   1.16.1

data/Guardfile

@@ -1,24 +1,25 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', :version => 2 do
+guard 'rspec', version: 2 do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch('spec/spec_helper.rb')  { 'spec' }
 
   # Rails example
   watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
   watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
   watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('config/routes.rb')                           { "spec/routing" }
-  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
-  
+  watch(%r{^spec/support/(.+)\.rb$})                  { 'spec' }
+  watch('config/routes.rb')                           { 'spec/routing' }
+  watch('app/controllers/application_controller.rb')  { 'spec/controllers' }
+
   # Capybara request specs
   watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
-  
+
   # Turnip features and steps
   watch(%r{^spec/acceptance/(.+)\.feature$})
-  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
 end
-

data/README.md

@@ -4,7 +4,7 @@
 
 Log outgoing HTTP requests made from your application. Helps with debugging pesky API error responses, or just generally understanding what's going on under the hood.
 
-**+++Requires ruby 2.2 or higher. If you're stuck with an older version of ruby for some reason, you're stuck with httplog v0.3.3.+++**
+Requires ruby >= 2.2.
 
 This gem works with the following ruby modules and libraries:
 
@@ -128,6 +128,9 @@ With `compact_log` enabled, the same request might look like this:
 
 ### Known Issues
 
+Following are some known quirks and issues with particular libraries. If you know a workaround or have
+a suggestion for a fix, please open an issue or, even better, submit a pull request!
+
 * Requests types other than GET and POST have not been explicitly tested.
   They may or may not be logged, depending on the implementation details of the underlying library.
   If they are not for a particular library, please feel free to open an issue with the details.
@@ -158,6 +161,9 @@ With `compact_log` enabled, the same request might look like this:
 
 * Benchmarking only covers the time between starting the HTTP request and receiving the response. It does *not* cover the time it takes to establish the TCP connection.
 
+* When using [REST Client](https://github.com/rest-client/rest-client), POST requests might be missing the requests
+  data. See #54 for details.
+
 ### Running the specs
 
 Make sure you have the necessary dependencies installed by running `bundle install`.

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -13,10 +15,10 @@ rescue LoadError
 end
 require 'rspec/core/rake_task'
 
-desc "Run specs"
+desc 'Run specs'
 RSpec::Core::RakeTask.new(:spec)
 
-desc "Generate documentation"
+desc 'Generate documentation'
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'HttpLog'
@@ -36,9 +38,9 @@ end
 
 # ----- Packaging -----
 task :build do
-  sh "gem build httplog.gemspec"
+  sh 'gem build httplog.gemspec'
   mkdir_p 'pkg'
-  sh "mv *.gem pkg/ "
+  sh 'mv *.gem pkg/ '
 end
 
-task :default => :spec
+task default: :spec

data/gemfiles/http2.gemfile

@@ -1,5 +1,7 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-gem "http", "~> 2.0"
+source 'https://rubygems.org'
 
-gemspec path: ".."
+gem 'http', '~> 2.0'
+
+gemspec path: '..'

data/gemfiles/http3.gemfile

@@ -1,5 +1,7 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-gem "http", "~> 3.0"
+source 'https://rubygems.org'
 
-gemspec path: ".."
+gem 'http', '~> 3.0'
+
+gemspec path: '..'

data/gemfiles/http4.gemfile

@@ -1,5 +1,7 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-gem "http", github: "httprb/http"
+source 'https://rubygems.org'
 
-gemspec path: ".."
+gem 'http', github: 'httprb/http'
+
+gemspec path: '..'

data/gemfiles/rack1.gemfile

@@ -1,5 +1,7 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-gem "rack", "~> 1.0"
+source 'https://rubygems.org'
 
-gemspec path: ".."
+gem 'rack', '~> 1.0'
+
+gemspec path: '..'

data/gemfiles/rack2.gemfile

@@ -1,5 +1,7 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-gem "rack", "~> 2.0"
+source 'https://rubygems.org'
 
-gemspec path: ".."
+gem 'rack', '~> 2.0'
+
+gemspec path: '..'

data/httplog.gemspec

@@ -1,41 +1,42 @@
+# frozen_string_literal: true
+
 # Provide a simple gemspec so you can easily use your
 # project in your rails apps through git.
 
-$:.push File.expand_path("../lib", __FILE__)
-require "httplog/version"
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'httplog/version'
 
 Gem::Specification.new do |gem|
-  gem.name        = "httplog"
+  gem.name        = 'httplog'
   gem.version     = HttpLog::VERSION
-  gem.licenses    = ["MIT"]
-  gem.summary     = %q{Log outgoing HTTP requests.}
-  gem.authors     = ["Thilo Rusche"]
-  gem.email       = %q{thilorusche@gmail.com}
-  gem.files       = Dir["lib/**/*"] + ["MIT-LICENSE", "Rakefile", "README.md", "CHANGELOG.md"]
-  gem.homepage    = %q{http://github.com/trusche/httplog}
-  gem.description = %q{Log outgoing HTTP requests made from your application. Helpful for tracking API calls
-                     of third party gems that don't provide their own log output.}
+  gem.licenses    = ['MIT']
+  gem.summary     = 'Log outgoing HTTP requests.'
+  gem.authors     = ['Thilo Rusche']
+  gem.email       = 'thilorusche@gmail.com'
+  gem.homepage    = 'http://github.com/trusche/httplog'
+  gem.description = "Log outgoing HTTP requests made from your application. Helpful for tracking API calls
+                     of third party gems that don't provide their own log output."
 
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- test/*`.split("\n")
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
-  gem.required_ruby_version = ">= 2.2"
+  gem.required_ruby_version = '>= 2.2'
 
-  gem.add_development_dependency "rspec", ["~> 3.7"]
-  gem.add_development_dependency "guard-rspec", ["~> 4.7"]
-  gem.add_development_dependency "thin", ["~> 1.7"]
-  gem.add_development_dependency "httpclient", ["~> 2.8"]
-  gem.add_development_dependency "httparty", ["~> 0.16"]
-  gem.add_development_dependency "faraday", ["~> 0.14"]
-  gem.add_development_dependency "excon", ["~> 0.60"]
-  gem.add_development_dependency "ethon", ["~> 0.11"]
-  gem.add_development_dependency "patron", ["~> 0.12"]
-  gem.add_development_dependency "http", ["~> 3.0"]
-  gem.add_development_dependency "simplecov", ["~> 0.15"]
-  gem.add_development_dependency "rake", ["~> 12.3"]
-  gem.add_development_dependency "listen", ["~> 3.0"]
+  gem.add_development_dependency 'ethon', ['~> 0.11']
+  gem.add_development_dependency 'excon', ['~> 0.60']
+  gem.add_development_dependency 'faraday', ['~> 0.14']
+  gem.add_development_dependency 'guard-rspec', ['~> 4.7']
+  gem.add_development_dependency 'http', ['~> 3.0']
+  gem.add_development_dependency 'httparty', ['~> 0.16']
+  gem.add_development_dependency 'httpclient', ['~> 2.8']
+  gem.add_development_dependency 'listen', ['~> 3.0']
+  gem.add_development_dependency 'patron', ['~> 0.12']
+  gem.add_development_dependency 'rake', ['~> 12.3']
+  gem.add_development_dependency 'rspec', ['~> 3.7']
+  gem.add_development_dependency 'simplecov', ['~> 0.15']
+  gem.add_development_dependency 'thin', ['~> 1.7']
 
-  gem.add_dependency "colorize", ["~> 0.8"]
-  gem.add_dependency "rack", [">= 1.0"]
+  gem.add_dependency 'colorize', ['~> 0.8']
+  gem.add_dependency 'rack', ['>= 1.0']
 end

data/lib/httplog.rb

@@ -1,9 +1,11 @@
-require "httplog/version"
-require "httplog/configuration"
-require "httplog/http_log"
-require "httplog/adapters/net_http"
-require "httplog/adapters/httpclient"
-require "httplog/adapters/excon"
-require "httplog/adapters/ethon"
-require "httplog/adapters/patron"
-require "httplog/adapters/http"
+# frozen_string_literal: true
+
+require 'httplog/version'
+require 'httplog/configuration'
+require 'httplog/http_log'
+require 'httplog/adapters/net_http'
+require 'httplog/adapters/httpclient'
+require 'httplog/adapters/excon'
+require 'httplog/adapters/ethon'
+require 'httplog/adapters/patron'
+require 'httplog/adapters/http'

data/lib/httplog/adapters/ethon.rb

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
+
 if defined?(Ethon)
   module Ethon
     class Easy
-
       attr_accessor :action_name
 
       module Http
-        alias_method :orig_http_request, :http_request
+        alias orig_http_request http_request
         def http_request(url, action_name, options = {})
           @action_name = action_name # remember this for compact logging
           if HttpLog.url_approved?(url)
             HttpLog.log_request(action_name, url)
             HttpLog.log_headers(options[:headers])
-            HttpLog.log_data(options[:body]) #if action_name == :post
+            HttpLog.log_data(options[:body]) # if action_name == :post
           end
 
           orig_http_request(url, action_name, options)
@@ -19,18 +20,15 @@ if defined?(Ethon)
       end
 
       module Operations
-        alias_method :orig_perform, :perform
+        alias orig_perform perform
         def perform
           return orig_perform unless HttpLog.url_approved?(url)
 
-          response_code = nil
-          bm = Benchmark.realtime do
-            reponse_code = orig_perform
-          end
+          bm = Benchmark.realtime { orig_perform }
 
           # Not sure where the actual status code is stored - so let's
           # extract it from the response header.
-          status   = response_headers.scan(/HTTP\/... (\d{3})/).flatten.first
+          status   = response_headers.scan(%r{HTTP/... (\d{3})}).flatten.first
           encoding = response_headers.scan(/Content-Encoding: (\S+)/).flatten.first
           content_type = response_headers.scan(/Content-Type: (\S+(; charset=\S+)?)/).flatten.first
 

data/lib/httplog/adapters/excon.rb

@@ -1,23 +1,23 @@
+# frozen_string_literal: true
+
 if defined?(Excon)
   module Excon
     class Socket
-      alias_method :orig_connect, :connect
+      alias orig_connect connect
       def connect
         host = @data[:proxy] ? @data[:proxy][:host] : @data[:host]
         port = @data[:proxy] ? @data[:proxy][:port] : @data[:port]
         HttpLog.log_connection(host, port)
         orig_connect
       end
-
     end
 
     class Connection
-
       def _httplog_url(datum)
         "#{datum[:scheme]}://#{datum[:host]}:#{datum[:port]}#{datum[:path]}#{datum[:query]}"
       end
 
-      alias_method :orig_request, :request
+      alias orig_request request
       def request(params, &block)
         result = nil
         bm = Benchmark.realtime do
@@ -35,25 +35,23 @@ if defined?(Excon)
         result
       end
 
-      alias_method :orig_request_call, :request_call
+      alias orig_request_call request_call
       def request_call(datum)
         url = _httplog_url(datum)
 
         if HttpLog.url_approved?(url)
           HttpLog.log_request(datum[:method], _httplog_url(datum))
           HttpLog.log_headers(datum[:headers])
-          HttpLog.log_data(datum[:body])# if datum[:method] == :post
+          HttpLog.log_data(datum[:body]) # if datum[:method] == :post
         end
         orig_request_call(datum)
       end
 
-      alias_method :orig_response, :response
-      def response(datum={})
+      alias orig_response response
+      def response(datum = {})
         return orig_response(datum) unless HttpLog.url_approved?(_httplog_url(datum))
 
-        bm = Benchmark.realtime do
-          datum = orig_response(datum)
-        end
+        datum = orig_response(datum)
         response = datum[:response]
         headers = response[:headers] || {}
         HttpLog.log_status(response[:status])