httplog 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d14cf469bd22766290911769c43b063cedd6fb99
-  data.tar.gz: 2841bc515ff5a8ba0bc93c7cce4e32890c4e6dcb
+  metadata.gz: 559dce6d4408a4c64b11a0a80860f373cca08218
+  data.tar.gz: 631b221d50a319c8ab94fabccf910d8ba1ea8d17
 SHA512:
-  metadata.gz: 4e8a1a683566e66ebb9ba3541e0e3920c8c4cb72840db8de88e27099775bf4c0d434899bee602a01e089d20f8a12541a5431db52b68623efe1fcc5c0cf84397c
-  data.tar.gz: 112ff2e0279fb85b20f705976c6f2314115a75ea8be82d492e51a13db926e038cfe14a4d65caa0da42f96d42e26db2f5291c4065a76d0dd7edc8e70bdb0fc4c7
+  metadata.gz: 45a9cb8d87165ce54676c5946e56af35c306a19e02a9cf2f17018ac4fd03e8a2993506eae1eb71db3a5b38a3bbbea9f072b96f3c3dfb1ccd75b19ec7d516918a
+  data.tar.gz: c1bbaf8818fd4454223b28ba62e41538d255b02354623777891a445cf584da77e15dec6e34c912f6399d172a555a10633def08e4343eccc2b40b8b339140d8de

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - "2.2.8"
-  - "2.3.5"
-  - "2.4.2"
+  - "2.3.8"
+  - "2.4.4"
+  - "2.5.2"
 gemfile:
   - gemfiles/http2.gemfile
   - gemfiles/http3.gemfile

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.2.0 - 2018-12-31
+
+* [#65](https://github.com/trusche/httplog/pull/65) Added JSON as an optional output format
+* Ruby 2.2 no longer supported
+
+## 1.1.1 - 2018-06-30
+
+* [#60](https://github.com/trusche/httplog/issues/60) Fixed a bug in color configuration settings
+
 ## 1.1.0 - 2018-06-22
 
 * [#59](https://github.com/trusche/httplog/issues/59) Switched colorization library to MIT licensed [rainbow](https://github.com/sickill/rainbow).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    httplog (1.1.1)
+    httplog (1.2.0)
       rack (>= 1.0)
       rainbow (>= 2.0.0)
 
@@ -13,18 +13,18 @@ GEM
     coderay (1.1.2)
     daemons (1.2.6)
     diff-lcs (1.3)
-    docile (1.1.5)
-    domain_name (0.5.20170404)
+    docile (1.3.1)
+    domain_name (0.5.20180417)
       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)
+    eventmachine (1.2.7)
+    excon (0.62.0)
+    faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
-    ffi (1.9.23)
+    ffi (1.9.25)
     formatador (0.2.5)
-    guard (2.14.2)
+    guard (2.15.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -38,16 +38,17 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    http (3.0.0)
+    http (3.3.0)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
-      http-form_data (>= 2.0.0.pre.pre2, < 3)
+      http-form_data (~> 2.0)
       http_parser.rb (~> 0.6.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    http-form_data (2.0.0)
+    http-form_data (2.1.1)
     http_parser.rb (0.6.0)
-    httparty (0.16.0)
+    httparty (0.16.3)
+      mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     httpclient (2.8.3)
     json (2.1.0)
@@ -55,42 +56,45 @@ GEM
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
-    lumberjack (1.0.12)
-    method_source (0.9.0)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
     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.1)
-    pry (0.11.3)
+    patron (0.13.1)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (3.0.2)
-    rack (2.0.4)
+    public_suffix (3.0.3)
+    rack (2.0.6)
     rainbow (3.0.0)
-    rake (12.3.0)
-    rb-fsevent (0.10.2)
+    rake (12.3.2)
+    rb-fsevent (0.10.3)
     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)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
@@ -98,7 +102,7 @@ GEM
       daemons (~> 1.0, >= 1.0.9)
       eventmachine (~> 1.0, >= 1.0.4)
       rack (>= 1, < 3)
-    thor (0.20.0)
+    thor (0.20.3)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.5)
@@ -123,4 +127,4 @@ DEPENDENCIES
   thin (~> 1.7)
 
 BUNDLED WITH
-   1.16.1
+   1.17.1

data/Guardfile

@@ -3,7 +3,7 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', version: 2 do
+guard 'rspec', cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { 'spec' }

data/README.md

@@ -5,7 +5,7 @@
 
 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.
 
-Requires ruby >= 2.2.
+Requires ruby >= 2.3.
 
 This gem works with the following ruby modules and libraries:
 
@@ -72,11 +72,14 @@ HttpLog.configure do |config|
   # ...or log all request as a single line by setting this to `true`
   config.compact_log = false
 
+  # You can also log in JSON format
+  config.json_log = false
+
   # Prettify the output - see below
   config.color = false
 
   # Limit logging based on URL patterns
-  config.url_whitelist_pattern = /.*/
+  config.url_whitelist_pattern = nil
   config.url_blacklist_pattern = nil
 end
 ```
@@ -114,6 +117,10 @@ For more color options please refer to the [rainbow documentation](https://githu
 
 If the log is too noisy for you, but you don't want to completely disable it either, set the `compact_log` option to `true`. This will log each request in a single line with method, request URI, response status and time, but no data or headers. No need to disable any other options individually.
 
+### JSON logging
+
+If you want to log HTTP requests in a JSON format, set the `json_log` option to `true`. You can combine this with `compact_log` to only log the basic request metrics without headers and bodies.
+
 ### Example
 
 With the default configuration, the log output might look like this:
@@ -136,6 +143,14 @@ With `compact_log` enabled, the same request might look like this:
 
     [httplog] GET http://localhost:9292/index.html completed with status code 200 in 0.00057 seconds
 
+With `json_log` enabled:
+
+    [httplog] {"method":"GET","url":"localhost:80","request_body":null, "request_headers":{"foo":"bar"}, "response_code":200,"response_body":"<html>\n      <head>\n        <title>Test Page</title>\n      </head>\n      <body>\n        <h1>This is the test page.</h1>\n      </body>\n    </html>","response_headers":{"foo":"bar"},"benchmark":0.00057}
+
+And with `json_log` *and* `compact_log` enabled:
+
+    [httplog] {"method":"GET","url":"localhost:80","response_code":200,"benchmark":0.00057}
+
 ### Known Issues
 
 Following are some known quirks and issues with particular libraries. If you know a workaround or have
@@ -200,3 +215,4 @@ Thanks to these fine folks for contributing pull requests:
 * [Ilya Bondarenko](https://github.com/sedx)
 * [Kostas Zacharakis](https://github.com/kzacharakis)
 * [Yuri Smirnov](https://github.com/tycooon)
+* [Manuel Bustillo Alonso](https://github.com/bustikiller)

data/lib/httplog/adapters/ethon.rb

@@ -8,13 +8,7 @@ if defined?(Ethon)
       module Http
         alias orig_http_request http_request
         def http_request(url, action_name, options = {})
-          @action_name = action_name # remember this for compact logging
-          if HttpLog.url_approved?(url)
-            HttpLog.log_request(action_name, url)
-            HttpLog.log_headers(options[:headers])
-            HttpLog.log_data(options[:body]) # if action_name == :post
-          end
-
+          @http_log    = options.merge(method: action_name) # remember this for compact logging
           orig_http_request(url, action_name, options)
         end
       end
@@ -36,11 +30,18 @@ if defined?(Ethon)
           # an array; probably overlooked it. Anyway, let's do it ourselves:
           headers = response_headers.split(/\r?\n/)[1..-1]
 
-          HttpLog.log_compact(@action_name, @url, @return_code, bm)
-          HttpLog.log_status(status)
-          HttpLog.log_benchmark(bm)
-          HttpLog.log_headers(headers)
-          HttpLog.log_body(response_body, encoding, content_type)
+          HttpLog.call(
+            method: @http_log[:method],
+            url: @url,
+            request_body: @http_log[:body],
+            request_headers: @http_log[:headers],
+            response_code: @return_code,
+            response_body: response_body,
+            response_headers: headers.map{ |header| header.split(/:\s/) }.to_h,
+            benchmark: bm,
+            encoding: encoding,
+            content_type: content_type
+          )
           return_code
         end
       end

data/lib/httplog/adapters/excon.rb

@@ -2,20 +2,26 @@
 
 if defined?(Excon)
   module Excon
+    module HttpLogHelper
+      def _httplog_url(datum)
+        @httplog_url ||= "#{datum[:scheme]}://#{datum[:host]}:#{datum[:port]}#{datum[:path]}#{datum[:query]}"
+      end
+    end
+
     class Socket
+      include Excon::HttpLogHelper
       alias orig_connect connect
       def connect
         host = @data[:proxy] ? @data[:proxy][:host] : @data[:host]
         port = @data[:proxy] ? @data[:proxy][:port] : @data[:port]
-        HttpLog.log_connection(host, port)
+        HttpLog.log_connection(host, port) if ::HttpLog.url_approved?(_httplog_url(@data))
         orig_connect
       end
     end
 
     class Connection
-      def _httplog_url(datum)
-        "#{datum[:scheme]}://#{datum[:host]}:#{datum[:port]}#{datum[:path]}#{datum[:query]}"
-      end
+      include Excon::HttpLogHelper
+      attr_reader :bm
 
       alias orig_request request
       def request(params, &block)
@@ -24,41 +30,25 @@ if defined?(Excon)
           result = orig_request(params, &block)
         end
 
-        datum = @data.merge(params)
-        datum[:headers] = @data[:headers].merge(datum[:headers] || {})
-        url = _httplog_url(datum)
-
-        if HttpLog.url_approved?(url)
-          HttpLog.log_compact(datum[:method], url, datum[:status] || result.status, bm)
-          HttpLog.log_benchmark(bm)
-        end
+        url = _httplog_url(@data)
+        return result unless HttpLog.url_approved?(url)
+
+        headers = result[:headers] || {}
+
+        HttpLog.call(
+          method: params[:method],
+          url: url,
+          request_body: @data[:body],
+          request_headers: @data[:headers] || {},
+          response_code: result[:status],
+          response_body: result[:body],
+          response_headers: headers,
+          benchmark: bm,
+          encoding: headers['Content-Encoding'],
+          content_type: headers['Content-Type']
+        )
         result
       end
-
-      alias orig_request_call request_call
-      def request_call(datum)
-        url = _httplog_url(datum)
-
-        if HttpLog.url_approved?(url)
-          HttpLog.log_request(datum[:method], _httplog_url(datum))
-          HttpLog.log_headers(datum[:headers])
-          HttpLog.log_data(datum[:body]) # if datum[:method] == :post
-        end
-        orig_request_call(datum)
-      end
-
-      alias orig_response response
-      def response(datum = {})
-        return orig_response(datum) unless HttpLog.url_approved?(_httplog_url(datum))
-
-        datum = orig_response(datum)
-        response = datum[:response]
-        headers = response[:headers] || {}
-        HttpLog.log_status(response[:status])
-        HttpLog.log_headers(headers)
-        HttpLog.log_body(response[:body], headers['Content-Encoding'], headers['Content-Type'])
-        datum
-      end
     end
   end
 end

data/lib/httplog/adapters/http.rb

@@ -8,11 +8,7 @@ if defined?(::HTTP::Client) && defined?(::HTTP::Connection)
       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 HttpLog.url_approved?(req.uri)
 
           body = if defined?(::HTTP::Request::Body)
                    req.body.respond_to?(:source) ? req.body.source : req.body.instance_variable_get(:@body)
@@ -20,21 +16,24 @@ if defined?(::HTTP::Client) && defined?(::HTTP::Connection)
                    req.body
                  end
 
-          HttpLog.log_data(body.to_s)
-          body.rewind if body.respond_to?(:rewind)
-        end
-
-        bm = Benchmark.realtime do
-          @response = send(orig_request_method, req, options)
-        end
+          bm = Benchmark.realtime do
+            @response = send(orig_request_method, req, options)
+          end
+
+          HttpLog.call(
+            method: req.verb,
+            url: req.uri,
+            request_body: body,
+            request_headers: req.headers,
+            response_code: @response.code,
+            response_body: @response.body,
+            response_headers: @response.headers,
+            benchmark: bm,
+            encoding: @response.headers['Content-Encoding'],
+            content_type: @response.headers['Content-Type']
+          )
 
-        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, headers['Content-Encoding'], headers['Content-Type'])
+          body.rewind if body.respond_to?(:rewind)
         end
 
         @response

data/lib/httplog/adapters/httpclient.rb

@@ -7,14 +7,6 @@ if defined?(::HTTPClient)
     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)
-
-      if log_enabled
-        HttpLog.log_request(req.header.request_method, req.header.request_uri)
-        HttpLog.log_headers(req.headers)
-        HttpLog.log_data(req.body)
-      end
-
       retryable_response = nil
       bm = Benchmark.realtime do
         begin
@@ -24,14 +16,21 @@ if defined?(::HTTPClient)
         end
       end
 
-      if log_enabled
+      if HttpLog.url_approved?(req.header.request_uri)
         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_headers(headers)
-        HttpLog.log_body(res.body, headers['Content-Encoding'], headers['Content-Type'])
+
+        HttpLog.call(
+          method: req.header.request_method,
+          url: req.header.request_uri,
+          request_body: req.body,
+          request_headers: req.headers,
+          response_code: res.status_code,
+          response_body: res.body,
+          response_headers: res.headers,
+          benchmark: bm,
+          encoding: res.headers['Content-Encoding'],
+          content_type: res.headers['Content-Type']
+        )
         conn.push(res)
       end