RubyGems - httplog - Versions diffs - 1.3.1 → 1.5.0 - Mend

httplog 1.3.1 → 1.5.0

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 (56) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +32 -0
data/README.md +53 -22
data/httplog.gemspec +7 -4
data/lib/httplog/adapters/ethon.rb +2 -1
data/lib/httplog/adapters/excon.rb +2 -1
data/lib/httplog/adapters/http.rb +5 -3
data/lib/httplog/adapters/httpclient.rb +6 -4
data/lib/httplog/adapters/net_http.rb +13 -2
data/lib/httplog/adapters/patron.rb +2 -1
data/lib/httplog/configuration.rb +27 -21
data/lib/httplog/http_log.rb +138 -49
data/lib/httplog/version.rb +1 -1
metadata +37 -51
data/.gitignore +0 -7
data/.rspec +0 -2
data/.rubocop.yml +0 -55
data/.rubocop_todo.yml +0 -36
data/.ruby-version +0 -1
data/.travis.yml +0 -17
data/Gemfile +0 -4
data/Gemfile.lock +0 -130
data/Guardfile +0 -25
data/MIT-LICENSE +0 -20
data/Rakefile +0 -46
data/gemfiles/http3.gemfile +0 -7
data/gemfiles/http4.gemfile +0 -7
data/gemfiles/http5.gemfile +0 -7
data/gemfiles/rack1.gemfile +0 -7
data/gemfiles/rack2.gemfile +0 -7
data/spec/adapters/ethon_adapter.rb +0 -26
data/spec/adapters/excon_adapter.rb +0 -16
data/spec/adapters/faraday_adapter.rb +0 -59
data/spec/adapters/http_adapter.rb +0 -27
data/spec/adapters/http_base_adapter.rb +0 -39
data/spec/adapters/httparty_adapter.rb +0 -16
data/spec/adapters/httpclient_adapter.rb +0 -31
data/spec/adapters/net_http_adapter.rb +0 -21
data/spec/adapters/open_uri_adapter.rb +0 -19
data/spec/adapters/patron_adapter.rb +0 -36
data/spec/adapters/typhoeus_adapter.rb +0 -28
data/spec/configuration_spec.rb +0 -22
data/spec/lib/http_client_spec.rb +0 -15
data/spec/lib/http_log_spec.rb +0 -320
data/spec/log/.gitkeep +0 -0
data/spec/spec_helper.rb +0 -45
data/spec/support/index.html +0 -8
data/spec/support/index.html.gz +0 -0
data/spec/support/log4r.yml +0 -17
data/spec/support/not_gzipped.html.gz +0 -8
data/spec/support/shared_examples.rb +0 -79
data/spec/support/test.bin +0 -0
data/spec/support/test.pdf +0 -198
data/spec/support/test_server.rb +0 -34
data/spec/support/utf8-invalid.html +0 -0
data/spec/support/utf8.html +0 -8

data/spec/adapters/typhoeus_adapter.rb DELETED Viewed

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-require 'excon'
-class TyphoeusAdapter < HTTPBaseAdapter
-  def send_get_request
-    Typhoeus.get(parse_uri(true).to_s, headers: @headers)
-  end
-  def send_head_request
-    Typhoeus.head(parse_uri.to_s, headers: @headers)
-  end
-  def send_post_request
-    Typhoeus.post(parse_uri.to_s, body: @data, headers: @headers)
-  end
-  def send_post_form_request
-    Typhoeus.post(parse_uri.to_s, body: @params, headers: @headers)
-  end
-  def send_multipart_post_request
-    send_post_form_request
-  end
-  def self.is_libcurl?
-    true
-  end
-end

data/spec/configuration_spec.rb DELETED Viewed

@@ -1,22 +0,0 @@
-# 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
-        expect(config.compact_log).to eq(false)
-      end
-    end
-    describe '#compact_log=' do
-      it 'sets values' do
-        config.compact_log = true
-        expect(config.compact_log).to eq(true)
-      end
-    end
-  end
-end

data/spec/lib/http_client_spec.rb DELETED Viewed

@@ -1,15 +0,0 @@
-# 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 DELETED Viewed

@@ -1,320 +0,0 @@
-# frozen_string_literal: true
-require 'spec_helper'
-describe HttpLog do
-  subject { log } # see spec_helper
-  let(:secret)  { 'my secret' }
-  let(:host)    { 'localhost' }
-  let(:port)    { 9292 }
-  let(:path)    { '/index.html' }
-  let(:headers) { { 'accept' => '*/*', 'foo' => secret } }
-  let(:data)    { "foo=#{secret}&bar=foo" }
-  let(:params)  { { 'foo' => secret, 'bar' => 'foo:form-data' } }
-  let(:html)    { File.read('./spec/support/index.html') }
-  let(:json)    { JSON.parse(log.match(/\[httplog\]\s(.*)/).captures.first) }
-  # Default configuration
-  let(:enabled)               { HttpLog.configuration.enabled }
-  let(:severity)              { HttpLog.configuration.severity }
-  let(:log_headers)           { HttpLog.configuration.log_headers }
-  let(:log_request)           { HttpLog.configuration.log_request }
-  let(:log_response)          { HttpLog.configuration.log_response }
-  let(:log_data)              { HttpLog.configuration.log_data }
-  let(:log_connect)           { HttpLog.configuration.log_connect }
-  let(:log_benchmark)         { HttpLog.configuration.log_benchmark }
-  let(:color)                 { HttpLog.configuration.color }
-  let(:prefix)                { HttpLog.configuration.prefix }
-  let(:prefix_response_lines) { HttpLog.configuration.prefix_response_lines }
-  let(:prefix_line_numbers)   { HttpLog.configuration.prefix_line_numbers }
-  let(:json_log)              { HttpLog.configuration.json_log }
-  let(:compact_log)           { HttpLog.configuration.compact_log }
-  let(:url_blacklist_pattern) { HttpLog.configuration.url_blacklist_pattern }
-  let(:url_whitelist_pattern) { HttpLog.configuration.url_whitelist_pattern }
-  let(:filter_parameters)     { HttpLog.configuration.filter_parameters }
-  def configure
-    HttpLog.configure do |c|
-      c.enabled               = enabled
-      c.severity              = severity
-      c.log_headers           = log_headers
-      c.log_request           = log_request
-      c.log_response          = log_response
-      c.log_data              = log_data
-      c.log_connect           = log_connect
-      c.log_benchmark         = log_benchmark
-      c.color                 = color
-      c.prefix                = prefix
-      c.prefix_response_lines = prefix_response_lines
-      c.prefix_line_numbers   = prefix_line_numbers
-      c.json_log              = json_log
-      c.compact_log           = compact_log
-      c.url_blacklist_pattern = url_blacklist_pattern
-      c.url_whitelist_pattern = url_whitelist_pattern
-      c.filter_parameters     = filter_parameters
-    end
-  end
-  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) }
-      before { configure }
-      context 'with default configuration' do
-        describe 'GET requests' do
-          let!(:res) { adapter.send_get_request }
-          it_behaves_like 'logs request', 'GET'
-          it_behaves_like 'logs data'
-          it_behaves_like 'logs expected response'
-          it_behaves_like 'logs status', 200
-          it_behaves_like 'logs benchmark'
-          it { is_expected.to_not include('Header:') }
-          it { is_expected.to_not include("\e[0") }
-          unless adapter_class.is_libcurl?
-            it { is_expected.to include("Connecting: #{host}:#{port}") }
-          end
-          it { expect(res).to be_a adapter.response if adapter.respond_to? :response }
-          context 'with gzip encoding' do
-            let(:path) { '/index.html.gz' }
-            let(:data) { nil }
-            it_behaves_like 'logs expected response'
-            if adapter_class.method_defined? :send_head_request
-              it "doesn't try to decompress body for HEAD requests" do
-                expect(log).to include('Response:')
-              end
-            end
-          end
-          context 'with UTF-8 response body' do
-            let(:path) { '/utf8.html' }
-            let(:data) { nil }
-            it_behaves_like 'logs expected response'
-            it { is_expected.to include('    <title>Блог Яндекса</title>') if adapter.logs_data? }
-          end
-          context 'with binary response body' do
-            %w[/test.bin /test.pdf].each do |response_file_name|
-              let(:path) { response_file_name }
-              let(:data) { nil }
-              it { is_expected.to include('Response: (not showing binary data)') }
-              context 'and JSON logging' do
-                let(:json_log) { true }
-                it { expect(json['response_body']).to eq '(not showing binary data)' }
-              end
-            end
-          end
-        end
-        describe 'POST requests' do
-          if adapter_class.method_defined? :send_post_request
-            let!(:res) { adapter.send_post_request }
-            unless adapter_class.is_libcurl?
-              it { is_expected.to include("Connecting: #{host}:#{port}") }
-            end
-            it_behaves_like 'logs request', 'POST'
-            it_behaves_like 'logs expected response'
-            it_behaves_like 'logs data'
-            it_behaves_like 'logs status', 200
-            it_behaves_like 'logs benchmark'
-            it { is_expected.to_not include('Header:') }
-            it { expect(res).to be_a adapter.response if adapter.respond_to? :response }
-            context 'with non-UTF request data' do
-              let(:data) { "a UTF-8 striñg with an 8BIT-ASCII character: \xC3" }
-              it_behaves_like 'logs expected response' # == doesn't throw exception
-            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_behaves_like 'logs expected response' # == doesn't throw exception
-            end
-          end
-        end
-      end
-      context 'with custom configuration' do
-        context 'GET requests' do
-          before { adapter.send_get_request }
-          context 'when disabled' do
-            let(:enabled) { false }
-            it_behaves_like 'logs nothing'
-          end
-          context 'with different log level' do
-            let(:severity) { Logger::Severity::INFO }
-            it { is_expected.to include('INFO') }
-          end
-          context 'with headers logging' do
-            let(:log_headers) { true }
-            it { is_expected.to match(%r{Header: accept: */*}i) } # request
-            it { is_expected.to match(/Header: Server: thin/i) } # response
-            it_behaves_like 'filtered parameters'
-          end
-          context 'with blacklist hit' do
-            let(:url_blacklist_pattern) { /#{host}:#{port}/ }
-            it_behaves_like 'logs nothing'
-          end
-          context 'with blacklist miss' do
-            let(:url_blacklist_pattern) { /example.com/ }
-            it_behaves_like 'logs request', 'GET'
-          end
-          context 'with whitelist hit' do
-            let(:url_whitelist_pattern) { /#{host}:#{port}/ }
-            it_behaves_like 'logs request', 'GET'
-            context 'and blacklist hit' do
-              let(:url_blacklist_pattern) { /#{host}:#{port}/ }
-              it_behaves_like 'logs nothing'
-            end
-          end
-          context 'with whitelist miss' do
-            let(:url_whitelist_pattern) { /example.com/ }
-            it_behaves_like 'logs nothing'
-          end
-          it_behaves_like 'with request logging disabled'
-          it_behaves_like 'with connection logging disabled'
-          it_behaves_like 'data logging disabled'
-          it_behaves_like 'response logging disabled'
-          it_behaves_like 'benchmark logging disabled'
-          it_behaves_like 'filtered parameters'
-          context 'with single color' do
-            let(:color) { :red }
-            it { is_expected.to include("\e[31m") }
-          end
-          context 'with color hash' do
-            let(:color) { { color: :black, background: :yellow } }
-            it { is_expected.to include("\e[30m\e[43m") }
-          end
-          context 'with custom prefix' do
-            let(:prefix) { '[my logger]' }
-            it { is_expected.to include('[my logger]') }
-            it { is_expected.to_not include(HttpLog::LOG_PREFIX) }
-          end
-          context 'with custom lambda prefix' do
-            let(:prefix) { -> { '[custom prefix]' } }
-            it { is_expected.to include('[custom prefix]') }
-            it { is_expected.to_not include(HttpLog::LOG_PREFIX) }
-          end
-          context 'with compact config' do
-            let(:compact_log) { true }
-            it { is_expected.to match(%r{\[httplog\] GET http://#{host}:#{port}#{path}(\?.*)? completed with status code \d{3} in \d+\.\d{1,6} }) }
-            it { is_expected.to_not include("Connecting: #{host}:#{port}") }
-            it { is_expected.to_not include('Response:') }
-            it { is_expected.to_not include('Data:') }
-            it { is_expected.to_not include('Benchmark: ') }
-          end
-        end
-        context 'POST requests' do
-          if adapter_class.method_defined? :send_post_request
-            before { adapter.send_post_request }
-            it_behaves_like 'data logging disabled'
-            it_behaves_like 'response logging disabled'
-            it_behaves_like 'benchmark logging disabled'
-            it_behaves_like 'with prefix response lines'
-            it_behaves_like 'with line numbers'
-            it_behaves_like 'filtered parameters'
-          end
-        end
-        context 'POST form data requests' do
-          if adapter_class.method_defined? :send_post_form_request
-            before { adapter.send_post_form_request }
-            it_behaves_like 'data logging disabled'
-            it_behaves_like 'response logging disabled'
-            it_behaves_like 'benchmark logging disabled'
-            it_behaves_like 'with prefix response lines'
-            it_behaves_like 'with line numbers'
-            it_behaves_like 'filtered parameters'
-          end
-        end
-        context 'POST multi-part requests (file upload)' do
-          let(:upload) { Tempfile.new('http-log') }
-          let(:params) { { 'foo' => secret, 'file' => upload } }
-          if adapter_class.method_defined? :send_multipart_post_request
-            before { adapter.send_multipart_post_request }
-            it_behaves_like 'data logging disabled'
-            it_behaves_like 'response logging disabled'
-            it_behaves_like 'benchmark logging disabled'
-            it_behaves_like 'with prefix response lines'
-            it_behaves_like 'with line numbers'
-            it_behaves_like 'filtered parameters'
-          end
-        end
-      end
-      context 'with JSON config' do
-        let(:json_log) { true }
-        if adapter_class.method_defined? :send_post_request
-          before { adapter.send_post_request }
-          it { expect(json['method']).to eq('POST') }
-          it { expect(json['request_body']).to eq(data) }
-          it { expect(json['request_headers']).to be_a(Hash) }
-          it { expect(json['response_headers']).to be_a(Hash) }
-          it { expect(json['response_code']).to eq(200) }
-          it { expect(json['response_body']).to eq(html) }
-          it { expect(json['benchmark']).to be_a(Numeric) }
-          it_behaves_like 'filtered parameters'
-          context 'and compact config' do
-            let(:compact_log) { true }
-            it { expect(json['method']).to eq('POST') }
-            it { expect(json['request_body']).to be_nil }
-            it { expect(json['request_headers']).to be_nil }
-            it { expect(json['response_headers']).to be_nil }
-            it { expect(json['response_code']).to eq(200) }
-            it { expect(json['response_body']).to be_nil }
-            it { expect(json['benchmark']).to be_a(Numeric) }
-          end
-        end
-      end
-    end
-  end
-end

data/spec/log/.gitkeep DELETED Viewed

File without changes

data/spec/spec_helper.rb DELETED Viewed

@@ -1,45 +0,0 @@
-# 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'
-# require 'typhoeus'
-require 'ethon'
-require 'patron'
-require 'http'
-require 'simplecov'
-SimpleCov.start
-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 }
-# 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
-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 }
-  end
-  config.after(:each) do
-    HttpLog.reset!
-  end
-  def log
-    @log.string
-  end
-end

data/spec/support/index.html DELETED Viewed

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