httplog 1.0.2 → 1.0.3

data/lib/httplog/adapters/http.rb

@@ -1,25 +1,24 @@
+# frozen_string_literal: true
+
 if defined?(::HTTP::Client) && defined?(::HTTP::Connection)
-  module ::HTTP
+  module ::HTTP # rubocop:disable Style/ClassAndModuleChildren
     class Client
-
-      #
       request_method = respond_to?('make_request') ? 'make_request' : 'perform'
       orig_request_method = "orig_#{request_method}"
       alias_method(orig_request_method, request_method) unless method_defined?(orig_request_method)
 
       define_method request_method do |req, options|
-
         log_enabled = HttpLog.url_approved?(req.uri)
 
         if log_enabled
           HttpLog.log_request(req.verb, req.uri)
           HttpLog.log_headers(req.headers.to_h)
 
-          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
+          body = if defined?(::HTTP::Request::Body)
+                   req.body.respond_to?(:source) ? req.body.source : req.body.instance_variable_get(:@body)
+                 else
+                   req.body
+                 end
 
           HttpLog.log_data(body.to_s)
           body.rewind if body.respond_to?(:rewind)
@@ -43,7 +42,7 @@ if defined?(::HTTP::Client) && defined?(::HTTP::Connection)
     end
 
     class Connection
-      alias_method(:orig_initialize, :initialize) unless method_defined?(:orig_initialize)
+      alias orig_initialize initialize unless method_defined?(:orig_initialize)
 
       def initialize(req, options)
         HttpLog.log_connection(req.uri.host, req.uri.port) if HttpLog.url_approved?(req.uri)

data/lib/httplog/adapters/httpclient.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 if defined?(::HTTPClient)
   class HTTPClient
     private
-    alias_method :orig_do_get_block, :do_get_block
+
+    alias orig_do_get_block do_get_block
 
     def do_get_block(req, proxy, conn, &block)
       log_enabled = HttpLog.url_approved?(req.header.request_uri)
@@ -32,11 +35,11 @@ if defined?(::HTTPClient)
         conn.push(res)
       end
 
-      raise retryable_response if retryable_response != nil
+      raise retryable_response unless retryable_response.nil?
     end
 
     class Session
-      alias_method :orig_create_socket, :create_socket
+      alias orig_create_socket create_socket
 
       # up to version 2.6, the method signature is `create_socket(site)`; after that,
       # it's `create_socket(hort, port)`
@@ -53,7 +56,7 @@ if defined?(::HTTPClient)
           if HttpLog.url_approved?("#{host}:#{port}")
             HttpLog.log_connection(host, port)
           end
-          orig_create_socket(host,port)
+          orig_create_socket(host, port)
         end
       end
     end

data/lib/httplog/adapters/net_http.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 module Net
   class HTTP
-    alias_method(:orig_request, :request) unless method_defined?(:orig_request)
-    alias_method(:orig_connect, :connect) unless method_defined?(:orig_connect)
+    alias orig_request request unless method_defined?(:orig_request)
+    alias orig_connect connect unless method_defined?(:orig_connect)
 
     def request(req, body = nil, &block)
-
       url = "http://#{@address}:#{@port}#{req.path}"
 
       log_enabled = HttpLog.url_approved?(url)
@@ -14,7 +15,7 @@ module Net
         HttpLog.log_headers(req.each_header.collect)
         # A bit convoluted becase post_form uses form_data= to assign the data, so
         # in that case req.body will be empty.
-        HttpLog::log_data(req.body.nil? || req.body.size == 0 ? body : req.body) #if req.method == 'POST'
+        HttpLog.log_data(req.body.nil? || req.body.empty? ? body : req.body) # if req.method == 'POST'
       end
 
       bm = Benchmark.realtime do
@@ -38,5 +39,4 @@ module Net
       orig_connect
     end
   end
-
 end

data/lib/httplog/adapters/patron.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 if defined?(Patron)
   module Patron
     class Session
-      alias_method :orig_request, :request
+      alias orig_request request
       def request(action_name, url, headers, options = {})
         log_enabled = HttpLog.url_approved?(url)
 
         if log_enabled
           HttpLog.log_request(action_name, url)
           HttpLog.log_headers(headers)
-          HttpLog.log_data(options[:data])# if action_name == :post
+          HttpLog.log_data(options[:data]) # if action_name == :post
         end
 
         bm = Benchmark.realtime do

data/lib/httplog/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HttpLog
   class Configuration
     attr_accessor :enabled,
@@ -12,7 +14,6 @@ module HttpLog
                   :log_status,
                   :log_response,
                   :log_benchmark,
-                  :compact_log,
                   :url_whitelist_pattern,
                   :url_blacklist_pattern,
                   :color,
@@ -33,7 +34,6 @@ module HttpLog
       @log_status            = true
       @log_response          = true
       @log_benchmark         = true
-      @compact_log           = false
       @url_whitelist_pattern = /.*/
       @url_blacklist_pattern = nil
       @color                 = false
@@ -44,9 +44,8 @@ module HttpLog
 
     # TODO: remove in 1.0.0
     def []=(key, value)
-      $stderr.puts "DEPRECATION WARNING: Assignment to HttpLog.options will be removed in version 1.0.0. Please use HttpLog.configure block instead as described here: https://github.com/trusche/httplog#configuration"
-      self.send("#{key.to_s}=", value)
+      warn 'DEPRECATION WARNING: Assignment to HttpLog.options will be removed in version 1.0.0. Please use HttpLog.configure block instead as described here: https://github.com/trusche/httplog#configuration'
+      send("#{key}=", value)
     end
-
   end
 end

data/lib/httplog/http_log.rb

@@ -1,21 +1,22 @@
-require "net/http"
-require "logger"
-require "benchmark"
-require "colorize"
-require "rack"
+# frozen_string_literal: true
+
+require 'net/http'
+require 'logger'
+require 'benchmark'
+require 'colorize'
+require 'rack'
 
 module HttpLog
-  LOG_PREFIX = "[httplog] ".freeze
+  LOG_PREFIX = '[httplog] '.freeze
 
   class << self
-
-    attr_accessor :configuration
+    attr_writer :configuration
 
     def configuration
       @configuration ||= Configuration.new
     end
-    alias_method :config, :configuration
-    alias_method :options, :configuration # TODO: remove with 1.0.0
+    alias config configuration
+    alias options configuration # TODO: remove with 1.0.0
 
     def reset!
       @configuration = nil
@@ -37,7 +38,7 @@ module HttpLog
 
     def log_connection(host, port = nil)
       return if config.compact_log || !config.log_connect
-      log("Connecting: #{[host, port].compact.join(":")}")
+      log("Connecting: #{[host, port].compact.join(':')}")
     end
 
     def log_request(method, uri)
@@ -47,7 +48,7 @@ module HttpLog
 
     def log_headers(headers = {})
       return if config.compact_log || !config.log_headers
-      headers.each do |key,value|
+      headers.each do |key, value|
         log("Header: #{key}: #{value}")
       end
     end
@@ -63,36 +64,39 @@ module HttpLog
       log("Benchmark: #{seconds.to_f.round(6)} seconds")
     end
 
-    def log_body(body, encoding = nil, content_type=nil)
+    def log_body(body, encoding = nil, content_type = nil)
       return if config.compact_log || !config.log_response
 
       unless text_based?(content_type)
-        log("Response: (not showing binary data)")
+        log('Response: (not showing binary data)')
         return
       end
 
       if body.is_a?(Net::ReadAdapter)
         # open-uri wraps the response in a Net::ReadAdapter that defers reading
         # the content, so the reponse body is not available here.
-        log("Response: (not available yet)")
+        log('Response: (not available yet)')
         return
       end
 
       if encoding =~ /gzip/ && body && !body.empty?
-        sio = StringIO.new( body.to_s )
-        gz = Zlib::GzipReader.new( sio )
-        body = gz.read
+        begin
+          sio = StringIO.new(body.to_s)
+          gz = Zlib::GzipReader.new(sio)
+          body = gz.read
+        rescue Zlib::GzipFile::Error => e
+          log("(gzip decompression failed)")
+        end
       end
 
       data = utf_encoded(body.to_s, content_type)
 
       if config.prefix_response_lines
-        log("Response:")
+        log('Response:')
         log_data_lines(data)
       else
         log("Response:\n#{data}")
       end
-
     end
 
     def log_data(data)
@@ -100,7 +104,7 @@ module HttpLog
       data = utf_encoded(data.to_s.dup)
 
       if config.prefix_data_lines
-        log("Data:")
+        log('Data:')
         log_data_lines(data)
       else
         log("Data: #{data}")
@@ -120,10 +124,14 @@ module HttpLog
 
     private
 
-    def utf_encoded(data, content_type=nil)
+    def utf_encoded(data, content_type = nil)
       charset = content_type.to_s.scan(/; charset=(\S+)/).flatten.first || 'UTF-8'
-      data.force_encoding(charset) rescue data.force_encoding('UTF-8')
-      data.encode('UTF-8', :invalid => :replace, :undef => :replace)
+      begin
+        data.force_encoding(charset)
+      rescue StandardError
+        data.force_encoding('UTF-8')
+      end
+      data.encode('UTF-8', invalid: :replace, undef: :replace)
     end
 
     def text_based?(content_type)
@@ -131,7 +139,7 @@ module HttpLog
       # it will allow application/json and the like without having to resort to more
       # heavy-handed checks.
       content_type =~ /^text/ ||
-      content_type =~ /^application/ && content_type != 'application/octet-stream'
+        content_type =~ /^application/ && content_type != 'application/octet-stream'
     end
 
     def log_data_lines(data)
@@ -151,6 +159,5 @@ module HttpLog
         config.prefix.to_s
       end
     end
-
   end
 end

data/lib/httplog/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HttpLog
-  VERSION = "1.0.2"
+  VERSION = '1.0.3'.freeze
 end

data/spec/adapters/ethon_adapter.rb

@@ -1,20 +1,22 @@
-require "ethon"
+# frozen_string_literal: true
+
+require 'ethon'
 class EthonAdapter < HTTPBaseAdapter
   def send_get_request
     easy = Ethon::Easy.new
-    easy.http_request(parse_uri.to_s, :get, { headers: @headers })
+    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.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.http_request(parse_uri.to_s, :post, headers: @headers, body: @data)
     easy.perform
   end
 

data/spec/adapters/excon_adapter.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'excon'
 class ExconAdapter < HTTPBaseAdapter
   def send_get_request
-    Excon.get(parse_uri.to_s, headers: @headers )
+    Excon.get(parse_uri.to_s, headers: @headers)
   end
 
   def send_head_request

data/spec/adapters/faraday_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 class FaradayAdapter < HTTPBaseAdapter
   def send_get_request
@@ -47,7 +49,7 @@ class FaradayAdapter < HTTPBaseAdapter
       faraday.request :multipart
       faraday.request :url_encoded
 
-      faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
     end
   end
 end

data/spec/adapters/http_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'http'
 class HTTPAdapter < HTTPBaseAdapter
   def send_get_request

data/spec/adapters/http_base_adapter.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 class HTTPBaseAdapter
-  def initialize(host, port, path, headers, data, params, protocol = 'http')
-    @host = host
-    @port = port
-    @path = path
-    @headers = headers
-    @data = data
-    @params = params
-    @protocol = protocol
+  def initialize(options = {})
+    @host     = options.fetch(:host, 'localhost')
+    @port     = options.fetch(:port, 80)
+    @path     = options.fetch(:path, '/')
+    @headers  = options.fetch(:headers, {})
+    @data     = options.fetch(:data, nil)
+    @params   = options.fetch(:params, {})
+    @protocol = options.fetch(:protocol, 'http')
   end
 
   def logs_data?

data/spec/adapters/httparty_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'httparty'
 class HTTPartyAdapter < HTTPBaseAdapter
   def send_get_request

data/spec/adapters/httpclient_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HTTPClientAdapter < HTTPBaseAdapter
   def send_get_request
     ::HTTPClient.get(parse_uri, header: @headers)

data/spec/adapters/net_http_adapter.rb

@@ -1,19 +1,19 @@
+# frozen_string_literal: true
+
 class NetHTTPAdapter < HTTPBaseAdapter
   def send_get_request
     Net::HTTP.get_response(@host, [@path, @data].compact.join('?'), @port)
   end
 
   def send_head_request
-    http = Net::HTTP.new(@host, @port)
-    http.head(@path, @headers)
+    Net::HTTP.new(@host, @port).head(@path, @headers)
   end
 
   def send_post_request
-    http = Net::HTTP.new(@host, @port)
-    resp = http.post(@path, @data)
+    Net::HTTP.new(@host, @port).post(@path, @data)
   end
 
   def send_post_form_request
-    res = Net::HTTP.post_form(parse_uri, @params)
+    Net::HTTP.post_form(parse_uri, @params)
   end
 end

data/spec/adapters/open_uri_adapter.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 class OpenUriAdapter < HTTPBaseAdapter
   def send_get_request
-    open(parse_uri)
+    open(parse_uri) # rubocop:disable Security/Open
   end
 
   def expected_response_body
-    " (not available yet)"
+    ' (not available yet)'
   end
 
   def self.should_log_headers?