RubyGems - httplog - Versions diffs - 1.0.2 → 1.0.3 - Mend

httplog 1.0.2 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

checksums.yaml +4 -4
data/.rubocop.yml +55 -0
data/.rubocop_todo.yml +36 -0
data/.travis.yml +0 -1
data/Gemfile +3 -1
data/Gemfile.lock +2 -2
data/Guardfile +10 -9
data/README.md +7 -1
data/Rakefile +7 -5
data/gemfiles/http2.gemfile +5 -3
data/gemfiles/http3.gemfile +5 -3
data/gemfiles/http4.gemfile +5 -3
data/gemfiles/rack1.gemfile +5 -3
data/gemfiles/rack2.gemfile +5 -3
data/httplog.gemspec +29 -28
data/lib/httplog.rb +11 -9
data/lib/httplog/adapters/ethon.rb +7 -9
data/lib/httplog/adapters/excon.rb +9 -11
data/lib/httplog/adapters/http.rb +9 -10
data/lib/httplog/adapters/httpclient.rb +7 -4
data/lib/httplog/adapters/net_http.rb +5 -5
data/lib/httplog/adapters/patron.rb +4 -2
data/lib/httplog/configuration.rb +4 -5
data/lib/httplog/http_log.rb +33 -26
data/lib/httplog/version.rb +3 -1
data/spec/adapters/ethon_adapter.rb +6 -4
data/spec/adapters/excon_adapter.rb +3 -1
data/spec/adapters/faraday_adapter.rb +3 -1
data/spec/adapters/http_adapter.rb +2 -0
data/spec/adapters/http_base_adapter.rb +10 -8
data/spec/adapters/httparty_adapter.rb +2 -0
data/spec/adapters/httpclient_adapter.rb +2 -0
data/spec/adapters/net_http_adapter.rb +5 -5
data/spec/adapters/open_uri_adapter.rb +4 -2
data/spec/adapters/patron_adapter.rb +4 -2
data/spec/adapters/typhoeus_adapter.rb +2 -1
data/spec/configuration_spec.rb +5 -6
data/spec/lib/http_client_spec.rb +15 -0
data/spec/lib/http_log_spec.rb +333 -0
data/spec/spec_helper.rb +7 -7
data/spec/support/not_gzipped.html.gz +8 -0
data/spec/support/test_server.rb +16 -14
metadata +43 -39
data/spec/http_log_spec.rb +0 -358

data/spec/adapters/patron_adapter.rb CHANGED Viewed

@@ -1,4 +1,6 @@
-require "patron"
+# frozen_string_literal: true
+require 'patron'
 class PatronAdapter < HTTPBaseAdapter
   def send_get_request
     session = Patron::Session.new
@@ -25,7 +27,7 @@ class PatronAdapter < HTTPBaseAdapter
     file = @params.delete('file')
     session = Patron::Session.new
-    session.post_multipart(parse_uri.to_s, data, {file: file.path}, @headers)
+    session.post_multipart(parse_uri.to_s, data, { file: file.path }, @headers)
   end
   def self.is_libcurl?

data/spec/adapters/typhoeus_adapter.rb CHANGED Viewed

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require 'excon'
 class TyphoeusAdapter < HTTPBaseAdapter
   def send_get_request
     Typhoeus.get(parse_uri.to_s, headers: @headers)
   end

data/spec/configuration_spec.rb CHANGED Viewed

@@ -1,20 +1,19 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 require 'spec_helper'
 module HttpLog
   describe Configuration do
     let(:config) { Configuration.new }
-    describe "#compact_log" do
-      it "defaults to false" do
+    describe '#compact_log' do
+      it 'defaults to false' do
         expect(config.compact_log).to eq(false)
       end
     end
-    describe "#compact_log=" do
-      it "sets values" do
+    describe '#compact_log=' do
+      it 'sets values' do
         config.compact_log = true
         expect(config.compact_log).to eq(true)
       end

data/spec/lib/http_client_spec.rb ADDED Viewed

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require 'spec_helper'
+describe HTTPClient do
+  let(:client) { HTTPClient.new }
+  it 'works with transparent_gzip_decompression' do
+    client.transparent_gzip_decompression = true
+    expect { client.get("http://localhost:9292/index.html.gz") }.to_not(raise_error)
+    expect(log).to include(HttpLog::LOG_PREFIX + 'Status: 200')
+    expect(log).to include(HttpLog::LOG_PREFIX + 'Data:')
+    expect(log).to include(HttpLog::LOG_PREFIX + "Response:\n<html>")
+  end
+end

data/spec/lib/http_log_spec.rb ADDED Viewed

@@ -0,0 +1,333 @@
+# frozen_string_literal: true
+require 'spec_helper'
+describe HttpLog do
+  let(:host) { 'localhost' }
+  let(:port) { 9292 }
+  let(:path) { '/index.html' }
+  let(:headers) { { 'accept' => '*/*', 'foo' => 'bar' } }
+  let(:data) { 'foo=bar&bar=foo' }
+  let(:params) { { 'foo' => 'bar:form-data', 'bar' => 'foo' } }
+  ADAPTERS = [
+    NetHTTPAdapter,
+    OpenUriAdapter,
+    HTTPClientAdapter,
+    HTTPartyAdapter,
+    FaradayAdapter,
+    ExconAdapter,
+    EthonAdapter,
+    PatronAdapter,
+    HTTPAdapter
+  ].freeze
+  ADAPTERS.each do |adapter_class|
+    context adapter_class, adapter: adapter_class.to_s do
+      let(:adapter) { adapter_class.new(host: host, port: port, path: path, headers: headers, data: data, params: params) }
+      context 'with default configuration' do
+        connection_test_method = adapter_class.is_libcurl? ? :to_not : :to
+        if adapter_class.method_defined? :send_get_request
+          it 'should log GET requests' do
+            res = adapter.send_get_request
+            expect(log).send(connection_test_method, include(HttpLog::LOG_PREFIX + "Connecting: #{host}:#{port}"))
+            expect(log).to     include(HttpLog::LOG_PREFIX + "Sending: GET http://#{host}:#{port}#{path}")
+            expect(log).to     include(HttpLog::LOG_PREFIX + 'Data:')
+            expect(log).to_not include(HttpLog::LOG_PREFIX + 'Header:')
+            expect(log).to     include(HttpLog::LOG_PREFIX + 'Status: 200')
+            expect(log).to     include(HttpLog::LOG_PREFIX + 'Benchmark: ')
+            expect(log).to     include(HttpLog::LOG_PREFIX + "Response:#{adapter.expected_response_body}")
+            expect(log.colorized?).to be_falsey
+            expect(res).to be_a adapter.response if adapter.respond_to? :response
+          end
+          context 'with gzip encoding' do
+            let(:path) { '/index.html.gz' }
+            let(:data) { nil }
+            it 'decompresses gzipped response body' do
+              adapter.send_get_request
+              expect(log).to include(HttpLog::LOG_PREFIX + "Response:#{adapter.expected_response_body}")
+            end
+            if adapter_class.method_defined? :send_head_request
+              it "doesn't try to decompress body for HEAD requests" do
+                adapter.send_head_request
+                expect(log).to include(HttpLog::LOG_PREFIX + 'Response:')
+              end
+            end
+          end
+          context 'with UTF-8 response body' do
+            let(:path) { '/utf8.html' }
+            let(:data) { nil }
+            it 'works' do
+              adapter.send_get_request
+              expect(log).to include(HttpLog::LOG_PREFIX + "Response:#{adapter.expected_response_body}")
+              if adapter.logs_data?
+                expect(log).to include('    <title>Блог Яндекса</title>')
+              end
+            end
+          end
+          context 'with binary response body' do
+            let(:path) { '/test.bin' }
+            let(:data) { nil }
+            it "doesn't log response" do
+              adapter.send_get_request
+              expect(log).to include(HttpLog::LOG_PREFIX + 'Response: (not showing binary data)')
+            end
+          end
+        end
+        if adapter_class.method_defined? :send_post_request
+          it 'logs POST requests' do
+            res = adapter.send_post_request
+            expect(log).send(connection_test_method, include(HttpLog::LOG_PREFIX + "Connecting: #{host}:#{port}"))
+            expect(log).to include(HttpLog::LOG_PREFIX + "Sending: POST http://#{host}:#{port}#{path}")
+            expect(log).to include(HttpLog::LOG_PREFIX + 'Data: foo=bar&bar=foo')
+            expect(log).to_not include(HttpLog::LOG_PREFIX + 'Header:')
+            expect(log).to include(HttpLog::LOG_PREFIX + 'Status: 200')
+            expect(log).to include(HttpLog::LOG_PREFIX + 'Benchmark: ')
+            expect(log).to include(HttpLog::LOG_PREFIX + "Response:#{adapter.expected_response_body}")
+            expect(log.colorized?).to be_falsey
+            expect(res).to be_a adapter.response if adapter.respond_to? :response
+          end
+          context 'with non-UTF request data' do
+            let(:data) { "a UTF-8 striñg with an 8BIT-ASCII character: \xC3" }
+            it 'does not raise and error' do
+              expect { adapter.send_post_request }.to_not raise_error
+              expect(log).to include(HttpLog::LOG_PREFIX + 'Response:')
+            end
+          end
+          context 'with URI encoded non-UTF data' do
+            let(:data) { 'a UTF-8 striñg with a URI encoded 8BIT-ASCII character: %c3' }
+            it 'does not raise and error' do
+              expect { adapter.send_post_request }.to_not raise_error
+              expect(log).to include(HttpLog::LOG_PREFIX + 'Response:')
+            end
+          end
+        end
+      end
+      context 'with custom configuration' do
+        context 'GET requests' do
+          it 'should not log anything unless enabled is set' do
+            HttpLog.configure { |c| c.enabled = false }
+            adapter.send_get_request
+            expect(log).to eq('')
+          end
+          it 'should log at other levels' do
+            HttpLog.configure { |c| c.severity = Logger::Severity::INFO }
+            adapter.send_get_request
+            expect(log).to include('INFO')
+          end
+          it 'should log headers if enabled' do
+            HttpLog.configure { |c| c.log_headers = true }
+            adapter.send_get_request
+            # request header
+            expect(log.downcase).to include(HttpLog::LOG_PREFIX + 'Header: accept: */*'.downcase)
+            # response header
+            expect(log.downcase).to include(HttpLog::LOG_PREFIX + 'Header: server: thin'.downcase)
+          end
+          it 'should not log headers if disabled' do
+            HttpLog.configure { |c| c.log_headers = false }
+            adapter.send_get_request
+            expect(log).to_not include(HttpLog::LOG_PREFIX + 'Header:')
+          end
+          it 'should log the request if url does not match blacklist pattern' do
+            HttpLog.configure { |c| c.url_blacklist_pattern = /example.com/ }
+            adapter.send_get_request
+            expect(log).to include(HttpLog::LOG_PREFIX + 'Sending: GET')
+          end
+          it 'should log the request if url matches whitelist pattern and not the blacklist pattern' do
+            HttpLog.configure { |c| c.url_blacklist_pattern = /example.com/ }
+            HttpLog.configure { |c| c.url_whitelist_pattern = /#{host}:#{port}/ }
+            adapter.send_get_request
+            expect(log).to include(HttpLog::LOG_PREFIX + 'Sending: GET')
+          end
+          it 'should not log the request if url matches blacklist pattern' do
+            HttpLog.configure { |c| c.url_blacklist_pattern = /#{host}:#{port}/ }
+            adapter.send_get_request
+            expect(log).to_not include(HttpLog::LOG_PREFIX + 'Sending: GET')
+          end
+          it 'should not log the request if url does not match whitelist pattern' do
+            HttpLog.configure { |c| c.url_whitelist_pattern = /example.com/ }
+            adapter.send_get_request
+            expect(log).to_not include(HttpLog::LOG_PREFIX + 'Sending: GET')
+          end
+          it 'should not log the request if url matches blacklist pattern and the whitelist pattern' do
+            HttpLog.configure { |c| c.url_blacklist_pattern = /#{host}:#{port}/ }
+            HttpLog.configure { |c| c.url_whitelist_pattern = /#{host}:#{port}/ }
+            adapter.send_get_request
+            expect(log).to_not include(HttpLog::LOG_PREFIX + 'Sending: GET')
+          end
+          it 'should not log the request if disabled' do
+            HttpLog.configure { |c| c.log_request = false }
+            adapter.send_get_request
+            expect(log).to_not include(HttpLog::LOG_PREFIX + 'Sending: GET')
+          end
+          it 'should not log the connection if disabled' do
+            HttpLog.configure { |c| c.log_connect = false }
+            adapter.send_get_request
+            expect(log).to_not include(HttpLog::LOG_PREFIX + "Connecting: #{host}:#{port}")
+          end
+          it 'should not log data if disabled' do
+            HttpLog.configure { |c| c.log_data = false }
+            adapter.send_get_request
+            expect(log).to_not include(HttpLog::LOG_PREFIX + 'Data:')
+          end
+          it 'should colorized output' do
+            HttpLog.configure { |c| c.color = :red }
+            adapter.send_get_request
+            expect(log.colorized?).to be_truthy
+          end
+          it 'should log with custom string prefix' do
+            HttpLog.configure { |c| c.prefix = '[my logger]' }
+            adapter.send_get_request
+            expect(log).to include('[my logger]')
+            expect(log).to_not include(HttpLog::LOG_PREFIX)
+          end
+          it 'should log with custom lambda prefix' do
+            HttpLog.configure { |c| c.prefix = -> { '[custom prefix]' } }
+            adapter.send_get_request
+            expect(log).to include('[custom prefix]')
+            expect(log).to_not include(HttpLog::LOG_PREFIX)
+          end
+        end
+        context 'POST requests' do
+          if adapter_class.method_defined? :send_post_request
+            it 'should not log data if disabled' do
+              HttpLog.configure { |c| c.log_data = false }
+              adapter.send_post_request
+              expect(log).to_not include(HttpLog::LOG_PREFIX + 'Data:')
+            end
+            it 'should not log the response if disabled' do
+              HttpLog.configure { |c| c.log_response = false }
+              adapter.send_post_request
+              expect(log).to_not include(HttpLog::LOG_PREFIX + 'Reponse:')
+            end
+            it 'should prefix all response lines' do
+              HttpLog.configure { |c| c.prefix_response_lines = true }
+              adapter.send_post_request
+              expect(log).to include(HttpLog::LOG_PREFIX + 'Response:')
+              expect(log).to include(HttpLog::LOG_PREFIX + '<html>')
+            end
+            it 'should prefix all response lines with line numbers' do
+              HttpLog.configure { |c| c.prefix_response_lines = true }
+              HttpLog.configure { |c| c.prefix_line_numbers = true }
+              adapter.send_post_request
+              expect(log).to include(HttpLog::LOG_PREFIX + 'Response:')
+              expect(log).to include(HttpLog::LOG_PREFIX + '1: <html>')
+            end
+            it 'should not log the benchmark if disabled' do
+              HttpLog.configure { |c| c.log_benchmark = false }
+              adapter.send_post_request
+              expect(log).to_not include(HttpLog::LOG_PREFIX + 'Benchmark:')
+            end
+            it 'should colorized output' do
+              HttpLog.configure { |c| c.color = :red }
+              adapter.send_post_request
+              expect(log.colorized?).to be_truthy
+            end
+          end
+        end
+        context 'POST form data requests' do
+          if adapter_class.method_defined? :send_post_form_request
+            it 'should not log data if disabled' do
+              HttpLog.configure { |c| c.log_data = false }
+              adapter.send_post_form_request
+              expect(log).to_not include(HttpLog::LOG_PREFIX + 'Data:')
+            end
+            it 'should not log the response if disabled' do
+              HttpLog.configure { |c| c.log_response = false }
+              adapter.send_post_form_request
+              expect(log).to_not include(HttpLog::LOG_PREFIX + 'Reponse:')
+            end
+            it 'should not log the benchmark if disabled' do
+              HttpLog.configure { |c| c.log_benchmark = false }
+              adapter.send_post_form_request
+              expect(log).to_not include(HttpLog::LOG_PREFIX + 'Benchmark:')
+            end
+          end
+        end
+        context 'POST multi-part requests (file upload)' do
+          let(:upload) { Tempfile.new('http-log') }
+          let(:params) { { 'foo' => 'bar', 'file' => upload } }
+          if adapter_class.method_defined? :send_multipart_post_request
+            it 'should not log data if disabled' do
+              HttpLog.configure { |c| c.log_data = false }
+              adapter.send_multipart_post_request
+              expect(log).to_not include(HttpLog::LOG_PREFIX + 'Data:')
+            end
+            it 'should not log the response if disabled' do
+              HttpLog.configure { |c| c.log_response = false }
+              adapter.send_multipart_post_request
+              expect(log).to_not include(HttpLog::LOG_PREFIX + 'Reponse:')
+            end
+            it 'should not log the benchmark if disabled' do
+              HttpLog.configure { |c| c.log_benchmark = false }
+              adapter.send_multipart_post_request
+              expect(log).to_not include(HttpLog::LOG_PREFIX + 'Benchmark:')
+            end
+          end
+        end
+      end
+      context 'with compact config' do
+        before(:each) { HttpLog.configure { |c| c.compact_log = true } }
+        it 'should log a single line with status and benchmark' do
+          adapter.send_get_request
+          expect(log).to match(%r{\[httplog\] GET http://#{host}:#{port}#{path}(\?.*)? completed with status code \d{3} in (\d|\.)+})
+          expect(log).to_not include(HttpLog::LOG_PREFIX + "Connecting: #{host}:#{port}")
+          expect(log).to_not include(HttpLog::LOG_PREFIX + 'Response:')
+          expect(log).to_not include(HttpLog::LOG_PREFIX + 'Data:')
+          expect(log).to_not include(HttpLog::LOG_PREFIX + 'Benchmark: ')
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb CHANGED Viewed

@@ -1,5 +1,7 @@
-$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$:.unshift(File.dirname(__FILE__))
+# frozen_string_literal: true
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'httpclient'
 require 'excon'
@@ -15,30 +17,28 @@ require 'httplog'
 require 'adapters/http_base_adapter'
 Dir[File.dirname(__FILE__) + '/adapters/*.rb'].each { |f| require f }
-Dir["./spec/support/**/*.rb"].each {|f| require f}
+Dir['./spec/support/**/*.rb'].each { |f| require f }
 # Start a local rack server to serve up test pages.
 @server_thread = Thread.new do
-  Rack::Handler::Thin.run Httplog::Test::Server.new, :Port => 9292
+  Rack::Handler::Thin.run Httplog::Test::Server.new, Port: 9292
 end
 sleep(3) # wait a moment for the server to be booted
 RSpec.configure do |config|
   config.before(:each) do
     require 'stringio'
     @log = StringIO.new
     @logger = Logger.new @log
-    HttpLog.configure{ |c| c.logger = @logger }
+    HttpLog.configure { |c| c.logger = @logger }
   end
   config.after(:each) do
     HttpLog.reset!
   end
   def log
     @log.string
   end

data/spec/support/not_gzipped.html.gz ADDED Viewed

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title>Test Page</title>
+  </head>
+  <body>
+    <h1>This is the test page.</h1>
+  </body>
+</html>