httplog 0.2.15 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d6a52cb676f03cfac9c5a01d9ccc94a90fa570c
-  data.tar.gz: e9df033e0168daa111145d05e325d727f88f17ac
+  metadata.gz: cf4cc23f31ff23be6b482a93162f13f24f3a1ff0
+  data.tar.gz: 3f649844b6d24e7352d834f24391fff4803270a9
 SHA512:
-  metadata.gz: 4547cfe819ebdd84ed7feca3c274d9311528146607a9e6ef3caa5e46800660038cda8e3954761b13658ae09ca0729028c95f64f0e5cc2563252350cd39c40815
-  data.tar.gz: 016c63b7476a75c47f0e6c0d8eab37d3a1e209d4438689b386f614f85499b42e03c4ac570c5430c6881d096101aecc8fc25908b79b34952d59a74d38bec734ca
+  metadata.gz: dc9258c783313ef2293e9681d5cca9bc069cd3f9010bf9c03425e2828d8e8b39e771a5af10d3323598a7dcf84f52dad0f1b662256b55d786124198da250253f2
+  data.tar.gz: a8e8e2d9e43241ae5cf017954222ec5ac4dbf5c55a61f76085fcecdb61fd572b365f7464d86f7754f19182a49eef4950ea9d569d0e2499848f7c37f89648bf75

data/README.md

@@ -36,7 +36,12 @@ use this in a production environment.
 
     require 'httplog'
 
-By default, this will log all outgoing HTTP requests and their responses to $stdout on DEBUG level.
+By default, this will log all outgoing HTTP requests and their responses to $stdout on DEBUG level. 
+
+### Notes on content types
+
+* Binary data from response bodies (as indicated by the `Content-Type` header)is not logged. 
+* Text data (`text/*` and most `application/*` types) is encoded as UTF-8, with invalid characters replaced. If you need to inspect raw non-UTF data exactly as sent over the wire, this tool is probably not for you.
 
 ### Configuration
 

data/lib/httplog/adapters/ethon.rb

@@ -30,11 +30,13 @@ if defined?(Ethon)
 
           # Not sure where the acutal 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(/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
           HttpLog.log_compact(@action_name, @url, @return_code, bm)
           HttpLog.log_status(status)
           HttpLog.log_benchmark(bm)
-          HttpLog.log_body(response_body)
+          HttpLog.log_body(response_body, encoding, content_type)
           return_code
         end
       end

data/lib/httplog/adapters/excon.rb

@@ -55,8 +55,10 @@ if defined?(Excon)
           datum = orig_response(datum)
         end
         response = datum[:response]
+        headers = response[:headers] || {}
+        content_type = 
         HttpLog.log_status(response[:status])
-        HttpLog.log_body(response[:body])
+        HttpLog.log_body(response[:body], headers['Content-Encoding'], headers['Content-Type'])
         datum
       end
     end

data/lib/httplog/adapters/http.rb

@@ -18,11 +18,12 @@ if defined?(::HTTP::Client) and defined?(::HTTP::Connection)
         end
 
         if log_enabled
+          headers = @response.headers
           HttpLog.log_compact(req.verb, req.uri, @response.code, bm)
           HttpLog.log_status(@response.code)
           HttpLog.log_benchmark(bm)
           HttpLog.log_headers(@response.headers.to_h)
-          HttpLog.log_body(@response.body, @response.headers["Content-Encoding"])
+          HttpLog.log_body(@response.body, headers['Content-Encoding'], headers['Content-Type'])
         end
 
         @response

data/lib/httplog/adapters/httpclient.rb

@@ -23,10 +23,11 @@ if defined?(::HTTPClient)
 
       if log_enabled
         res = conn.pop
+        headers = res.headers
         HttpLog.log_compact(req.header.request_method, req.header.request_uri, res.status_code, bm)
         HttpLog.log_status(res.status_code)
         HttpLog.log_benchmark(bm)
-        HttpLog.log_body(res.body)
+        HttpLog.log_body(res.body, headers['Content-Encoding'], headers['Content-Type'])
         conn.push(res)
       end
 

data/lib/httplog/adapters/net_http.rb

@@ -26,7 +26,7 @@ module Net
         HttpLog.log_status(@response.code)
         HttpLog.log_benchmark(bm)
         HttpLog.log_headers(@response.each_header.collect)
-        HttpLog.log_body(@response.body, @response.header["Content-Encoding"])
+        HttpLog.log_body(@response.body, @response['Content-Encoding'], @response['Content-Type'])
       end
 
       @response

data/lib/httplog/adapters/patron.rb

@@ -16,10 +16,11 @@ if defined?(Patron)
         end
 
         if log_enabled
+          headers = @response.headers
           HttpLog.log_compact(action_name, url, @response.status, bm)
           HttpLog.log_status(@response.status)
           HttpLog.log_benchmark(bm)
-          HttpLog.log_body(@response.body)
+          HttpLog.log_body(@response.body, headers['Content-Encoding'], headers['Content-Type'])
         end
       end
     end

data/lib/httplog/http_log.rb

@@ -76,26 +76,35 @@ module HttpLog
       log("Benchmark: #{seconds} seconds")
     end
 
-    def log_body(body, encoding = nil)
+    def log_body(body, encoding = nil, content_type=nil)
       return if options[:compact_log] || !options[:log_response]
+
+      unless text_based?(content_type)
+        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)")
-      else
-        if encoding =~ /gzip/
-          sio = StringIO.new( body.to_s )
-          gz = Zlib::GzipReader.new( sio )
-          log("Response: (deflated)\n#{gz.read}")
-        else
-          log("Response:\n#{body.to_s}")
-        end
+        return
       end
+
+      if encoding =~ /gzip/
+        sio = StringIO.new( body.to_s )
+        gz = Zlib::GzipReader.new( sio )
+        body = gz.read
+      end
+
+      data = utf_encoded(body.to_s, content_type)
+
+      log("Response:\n#{data}")
     end
 
     def log_data(data)
       return if options[:compact_log] || !options[:log_data]
-      data = data.to_s.encode('UTF-8', :invalid => :replace, :undef => :replace) if data
+      data = utf_encoded(data.to_s)
       log("Data: #{data}")
     end
 
@@ -109,5 +118,21 @@ module HttpLog
       return msg unless options[:color]
       msg.send(:colorize, options[:color])
     end
+
+    private
+
+    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)
+    end
+
+    def text_based?(content_type)
+      # This is a very naive way of determining if the content type is text-based; but
+      # 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'
+    end
   end
 end

data/lib/httplog/version.rb

@@ -1,4 +1,4 @@
 module HttpLog
-  VERSION = "0.2.15"
+  VERSION = "0.3.0"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httplog
 version: !ruby/object:Gem::Version
-  version: 0.2.15
+  version: 0.3.0
 platform: ruby
 authors:
 - Thilo Rusche
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-06 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec