httplog 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4603f2bab3809871813bd149f2356ea700f89b3d
-  data.tar.gz: 37d78609e492343c5c1153bb4c92bca7ec38de22
+  metadata.gz: c303651209c60fe9eee6dbca5268920cfb7fc10c
+  data.tar.gz: f8105724f2519713b68d1646f17cb470864acadd
 SHA512:
-  metadata.gz: 00c37ed11badf49dc23722834b42994be41e7e0f01ccc44cfb57997eac08ad56d558fd0d1ad932aeed44e8ab131cdc7e2284efca526788a3885c47b9f629262c
-  data.tar.gz: f82837fba14d48ff65f5df5c89a34ed50e6d2b8401306756aada44fe5f3cef823369ea95b732b48bf4e9690a06f0999c4b49d2f047e75442fd4c177dd6ca9a82
+  metadata.gz: d44012d40b3694cf0865f8ea398f92603f7cabba87bd839a8e6368d19d394cd59172e951af316f446750c24e980c94302e6b57dba110677fb54195701b6b6605
+  data.tar.gz: 0fefca9e93bf969d81edbd3f0a1dfa54dc52a5818dbf00516f004290f3e50954f099766ad5cc6fa3877d69c1b460d11e9a562653be6d1dcd808a9f6c2832428b

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+.rvmrc
+pkg/
+*.gem
+coverage/
+spec/log/*.log
+gemfiles/*.lock

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - "2.2.8"
+  - "2.3.5"
+  - "2.4.2"
+gemfile:
+  - gemfiles/http2.gemfile
+  - gemfiles/http3.gemfile
+  - gemfiles/http4.gemfile
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rspec spec
+# workaround for https://github.com/travis-ci/travis-ci/issues/5239:
+before_install:
+  - gem install bundler

data/CHANGELOG.md

@@ -0,0 +1,75 @@
+## 1.0.1 - 2018-02-18
+
+* [#56](https://github.com/trusche/httplog/pull/56) Fixed data logging for httprb v3 ([@tycooon])
+* Cleaned up dependencies and requiring ruby version >= 2.2
+
+## 1.0.0 - 2017-11-02
+
+* [#53](https://github.com/trusche/httplog/pull/53) Fix header logging
+
+## 0.99.7 - 2017-07-19
+
+* Requiring `rack` explicitly so that plain ruby clients don't have to
+
+## 0.99.6 - 2017-07-11
+
+* Added `enabled` configuration option (default: true, doh)
+
+## 0.99.5 - 2017-07-05
+
+* Bugfix: Returning response for patron adapter
+
+## 0.99.4 - 2017-06-12
+
+* Bugfix: No longer modifying post data in place for safe logging
+
+## 0.99.0 - 2017-02-28
+
+* Proper configuration!
+
+  If you're using any custom configuration, please replace any assignments of the type
+
+      # Old. Bad. Down with this sort of thing.
+      HttpLog.options[:foo] = 'bar'  
+
+  with the new configuration block syntax, e.g.
+
+      # Shiny. New. Ruby-ish.
+      HttpLog.configure do |config|
+        config.foo = 'bar'
+      end
+
+  Please see the [README](README.md#configuration) for details. **The old syntax will be dropped in version 1.0.0** (which will be the next version bump) and will raise a deprecation warning until then.
+
+* Dropped support for typhoeus
+
+  That only means typhoeus is no longer explictly tested; it will probably still work, depending on which adapter is used. With the default ethon adapter, the status code will probably not be logged, and there may be other issues. Typhoeus has its own logging facility, so it's just not worth the headache of trying to stay compatible.
+
+* Dropped support for log4r.
+
+  Log4r seems to be no longer maintained for some years; it was causing issues with ruby 2.4, so I dropped it.
+
+* Rounding benchmarks to microseconds. Because anything more is just silly.
+
+* Support for ruby 2.4
+* Support for latest versions of all remaining adapters
+
+## 0.3.3 - 2016-11-28
+
+* optional prefix for request data
+
+## 0.3.2 - 2016-04-13
+
+* support for httpclient 2.7
+
+## 0.3.1 - 2016-04-06
+
+* support for latest version of `httprb`
+
+## 0.3.0 - 2016-01-15
+* changes
+  * binary data is no longer written to the log
+* bug fixes
+  * consistently forcing encoding of response body to UTF-8
+  * considering `charset` part of `Content-Type` header when encoding
+  * inspecting 'Content-Encoding' header for gzip decompression in all adapters

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,124 @@
+PATH
+  remote: .
+  specs:
+    httplog (1.0.1)
+      colorize (~> 0.8)
+      rack (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    colorize (0.8.1)
+    daemons (1.2.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    eventmachine (1.2.5)
+    excon (0.60.0)
+    faraday (0.14.0)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.21)
+    formatador (0.2.5)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    http (3.0.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (>= 2.0.0.pre.pre2, < 3)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.0.0)
+    http_parser.rb (0.6.0)
+    httparty (0.16.0)
+      multi_xml (>= 0.5.2)
+    httpclient (2.8.3)
+    json (2.1.0)
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    lumberjack (1.0.12)
+    method_source (0.9.0)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    patron (0.12.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.2)
+    rack (2.0.4)
+    rake (12.3.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    shellany (0.0.1)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thin (1.7.2)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    thor (0.20.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ethon (~> 0.11)
+  excon (~> 0.60)
+  faraday (~> 0.14)
+  guard-rspec (~> 4.7)
+  http (~> 3.0)
+  httparty (~> 0.16)
+  httpclient (~> 2.8)
+  httplog!
+  listen (~> 3.0)
+  patron (~> 0.12)
+  rake (~> 12.3)
+  rspec (~> 3.7)
+  simplecov (~> 0.15)
+  thin (~> 1.7)
+
+BUNDLED WITH
+   1.16.0

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+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" }
+
+  # 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" }
+  
+  # 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' }
+end
+

data/README.md

@@ -1,6 +1,6 @@
 ## httplog
 
-[![Gem Version](https://badge.fury.io/rb/httplog.png)](http://badge.fury.io/rb/httplog) [![Build Status](https://travis-ci.org/trusche/httplog.svg?branch=master)](https://travis-ci.org/trusche/httplog) [![Code Climate](https://codeclimate.com/github/trusche/httplog.png)](https://codeclimate.com/github/trusche/httplog)
+[![Gem Version](https://badge.fury.io/rb/httplog.svg)](http://badge.fury.io/rb/httplog) [![Build Status](https://travis-ci.org/trusche/httplog.svg?branch=master)](https://travis-ci.org/trusche/httplog) [![Code Climate](https://codeclimate.com/github/trusche/httplog.svg)](https://codeclimate.com/github/trusche/httplog)
 
 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.
 
@@ -166,11 +166,9 @@ This will launch a simple rack server on port 9292 and run all tests locally aga
 
 ### Contributing
 
-If you have any issues with httplog,
-or feature requests,
-please [add an issue](https://github.com/trusche/httplog/issues) on GitHub
-or fork the project and send a pull request.
-Please include passing specs with all pull requests.
+If you have any issues with or feature requests for httplog,
+please [open an issue](https://github.com/trusche/httplog/issues) on GitHub
+or fork the project and send a pull request. **Please include passing specs with all pull requests.**
 
 ### Contributors
 
@@ -185,3 +183,4 @@ Thanks to these fine folks for contributing pull requests:
 * [Ryan Souza](https://github.com/ryansouza)
 * [Ilya Bondarenko](https://github.com/sedx)
 * [Kostas Zacharakis](https://github.com/kzacharakis)
+* [Yuri Smirnov](https://github.com/tycooon)

data/gemfiles/http2.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "http", "~> 2.0"
+
+gemspec path: ".."

data/gemfiles/http3.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "http", "~> 3.0"
+
+gemspec path: ".."

data/gemfiles/http4.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "http", github: "httprb/http"
+
+gemspec path: ".."

data/httplog.gemspec

@@ -0,0 +1,41 @@
+# 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"
+
+Gem::Specification.new do |gem|
+  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.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- test/*`.split("\n")
+  gem.require_paths = ["lib"]
+
+  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_dependency "colorize", ["~> 0.8"]
+  gem.add_dependency "rack", ["~> 2.0"]
+end

data/lib/httplog/adapters/http.rb

@@ -14,7 +14,15 @@ if defined?(::HTTP::Client) && defined?(::HTTP::Connection)
         if log_enabled
           HttpLog.log_request(req.verb, req.uri)
           HttpLog.log_headers(req.headers.to_h)
-          HttpLog.log_data(req.body) #if req.verb == :post
+
+          if defined?(::HTTP::Request::Body)
+            body = req.body.respond_to?(:source) ? req.body.source : req.body.instance_variable_get(:@body)
+          else
+            body = req.body
+          end
+
+          HttpLog.log_data(body.to_s)
+          body.rewind if body.respond_to?(:rewind)
         end
 
         bm = Benchmark.realtime do

data/lib/httplog/version.rb

@@ -1,3 +1,3 @@
 module HttpLog
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/adapters/ethon_adapter.rb

@@ -0,0 +1,24 @@
+require "ethon"
+class EthonAdapter < HTTPBaseAdapter
+  def send_get_request
+    easy = Ethon::Easy.new
+    easy.http_request(parse_uri.to_s, :get, { headers: @headers })
+    easy.perform
+  end
+
+  def send_head_request
+    easy = Ethon::Easy.new
+    easy.http_request(parse_uri.to_s, :head, { headers: @headers })
+    easy.perform
+  end
+
+  def send_post_request
+    easy = Ethon::Easy.new
+    easy.http_request(parse_uri.to_s, :post, { headers: @headers, body: @data })
+    easy.perform
+  end
+
+  def self.is_libcurl?
+    true
+  end
+end

data/spec/adapters/excon_adapter.rb

@@ -0,0 +1,14 @@
+require 'excon'
+class ExconAdapter < HTTPBaseAdapter
+  def send_get_request
+    Excon.get(parse_uri.to_s, headers: @headers )
+  end
+
+  def send_head_request
+    Excon.head(parse_uri.to_s, headers: @headers)
+  end
+
+  def send_post_request
+    Excon.post(parse_uri.to_s, body: @data, headers: @headers)
+  end
+end

data/spec/adapters/faraday_adapter.rb

@@ -0,0 +1,53 @@
+require 'faraday'
+class FaradayAdapter < HTTPBaseAdapter
+  def send_get_request
+    connection.get do |req|
+      req.url parse_uri.to_s
+      req.headers = @headers
+    end
+  end
+
+  def send_head_request
+    connection.head do |req|
+      req.url parse_uri.to_s
+      req.headers = @headers
+    end
+  end
+
+  def send_post_request
+    connection.post do |req|
+      req.url parse_uri.to_s
+      req.headers = @headers
+      req.body = @data
+    end
+  end
+
+  def send_post_form_request
+    connection.post do |req|
+      req.url parse_uri.to_s
+      req.headers = @headers
+      req.body = @params
+    end
+  end
+
+  def send_multipart_post_request
+    file_upload = Faraday::UploadIO.new(@params['file'], 'text/plain')
+
+    connection.post do |req|
+      req.url parse_uri.to_s
+      req.headers = @headers
+      req.body = @params.merge('file' => file_upload)
+    end
+  end
+
+  private
+
+  def connection
+    Faraday.new(url: "#{@protocol}://#{@host}:#{@port}") do |faraday|
+      faraday.request :multipart
+      faraday.request :url_encoded
+
+      faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+    end
+  end
+end