httplog 1.5.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97cbba2cdb0af09dcf6664e290981b074a40f9c91d81be74a737a746bfc1e612
-  data.tar.gz: 228590a39ab68d89d3261f219e2bac4945f4fde315219943cbbacdfc1aaa2922
+  metadata.gz: '0741018e32c5c27fcd5af3f417806ccd01f0034ce67083d90ddf13812ba5d8e5'
+  data.tar.gz: bb0dadfbbd7e3834a1a99459e3828c5cc11c04624ae194f488209b417f75880e
 SHA512:
-  metadata.gz: d857f2dc7142fb7243371afd4d3993b65ced6092ecb6ac361abbd2957bc1884e18131ca707b3e2c9dc694ad9996c09e12ddf7b31f978d8d55def35322159a861
-  data.tar.gz: eafbb1ef94500b468083f8073049749e6073d2ec423fadae8f6aca3221624bb914f28a489305f35cd5fb222b247eb81f5b2446f4694f919959267d83c0bfcbe7
+  metadata.gz: 024403ade01a1e3fd8352735f65c61ee5d723a914be3cae1b57e6f66498e37fc4234424ed7ab51f7d79f9d536080bd978046a913eb3ead713b5c46c0920582b2
+  data.tar.gz: d4004322b6371d761f9c6e4868b7a71943f166935c53a59c42af902ac1666d7e4c279d8fc24e3b1b8b7009cc3301a9e783775e07a3bdee513dc23839757f25da

data/README.md

@@ -1,12 +1,11 @@
 ## httplog
 
-[![Gem Version](https://badge.fury.io/rb/httplog.svg)](http://badge.fury.io/rb/httplog) [![Build Status](https://travis-ci.org/trusche/httplog.svg?branch=master)](https://travis-ci.org/trusche/httplog) [![Code Climate](https://codeclimate.com/github/trusche/httplog.svg)](https://codeclimate.com/github/trusche/httplog)
+[![Gem Version](https://badge.fury.io/rb/httplog.svg)](http://badge.fury.io/rb/httplog) [![Build Status](https://travis-ci.com/trusche/httplog.svg?branch=master)](https://travis-ci.org/trusche/httplog) [![Code Climate](https://codeclimate.com/github/trusche/httplog.svg)](https://codeclimate.com/github/trusche/httplog)
 [![Release Version](https://img.shields.io/github/release/trusche/httplog.svg)](https://img.shields.io/github/release/trusche/httplog.svg)
-<a href="https://www.bearer.sh?ref=httplog"><img src="/bearer-badge.png" height="20px"/></a>
 
 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.5
+Requires ruby >= 2.6
 
 This gem works with the following ruby modules and libraries:
 
@@ -30,10 +29,6 @@ This is very much a development and debugging tool; it is **not recommended** to
 use this in a production environment as it is monkey-patching the respective HTTP implementations.
 You have been warned - use at your own risk.
 
-Httplog is kindly sponsored by <a href="https://www.bearer.sh?ref=httplog">Bearer.sh</a> - go check them out please!
-
-<a href="https://www.bearer.sh?ref=httplog"><img src="/bearer-sponsor.png" height="72px" /></a>
-
 ### Installation
 
     gem install httplog

data/httplog.gemspec

@@ -17,12 +17,18 @@ Gem::Specification.new do |gem|
   gem.description = "Log outgoing HTTP requests made from your application. Helpful for tracking API calls
                      of third party gems that don't provide their own log output."
 
+  gem.metadata = {
+    "bug_tracker_uri"   => "https://github.com/trusche/httplog/issues",
+    "changelog_uri"     => "https://github.com/trusche/httplog/CHANGELOG.md",
+    "source_code_uri"   => "https://github.com/trusche/httplog"
+  }
+
   gem.files         = Dir['lib/**/*.rb'] +
                         %w(httplog.gemspec README.md CHANGELOG.md)
   gem.test_files    = `git ls-files -- test/*`.split("\n")
   gem.require_paths = ['lib']
 
-  gem.required_ruby_version = '>= 2.2'
+  gem.required_ruby_version = '>= 2.6'
 
   gem.add_development_dependency 'ethon', ['~> 0.11']
   gem.add_development_dependency 'excon', ['~> 0.60']
@@ -32,6 +38,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'httparty', ['~> 0.16']
   gem.add_development_dependency 'httpclient', ['~> 2.8']
   gem.add_development_dependency 'rest-client', ['~> 2.0']
+  gem.add_development_dependency 'typhoeus', ['~> 1.4']
   gem.add_development_dependency 'listen', ['~> 3.0']
   gem.add_development_dependency 'patron', ['~> 0.12']
   gem.add_development_dependency 'rake', ['~> 13.0']
@@ -40,6 +47,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'thin', ['~> 1.7']
   gem.add_development_dependency 'oj', ['>= 3.9.2']
 
-  gem.add_dependency 'rack', ['>= 1.0']
+  gem.add_dependency 'rack', ['>= 2.0']
   gem.add_dependency 'rainbow', ['>= 2.0.0']
 end

data/lib/httplog/adapters/ethon.rb

@@ -8,7 +8,7 @@ if defined?(Ethon)
       module Http
         alias orig_http_request http_request
         def http_request(url, action_name, options = {})
-          @http_log = options.merge(method: action_name) # remember this for compact logging
+          @http_log = options.merge(method: action_name, url: url) # remember this for compact logging
           orig_http_request(url, action_name, options)
         end
       end
@@ -18,32 +18,50 @@ if defined?(Ethon)
         def perform
           return orig_perform unless HttpLog.url_approved?(url)
 
-          bm = Benchmark.realtime { orig_perform }
+          httplog_add_callback
 
-          # Not sure where the actual status code is stored - so let's
-          # extract it from the response header.
-          encoding = response_headers.scan(/Content-Encoding: (\S+)/).flatten.first
-          content_type = response_headers.scan(/Content-Type: (\S+(; charset=\S+)?)/).flatten.first
+          bm = Benchmark.realtime { orig_perform }
 
-          # Hard to believe that Ethon wouldn't parse out the headers into
-          # an array; probably overlooked it. Anyway, let's do it ourselves:
-          headers = response_headers.split(/\r?\n/).drop(1)
+          url = @http_log[:url]
+          url = "#{url}?#{@http_log[:params]}" if @http_log[:params]
 
           HttpLog.call(
             method: @http_log[:method],
-            url: @url,
+            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,
+            response_body: @http_log[:response_body],
+            response_headers: @http_log[:response_headers].map { |header| header.split(/:\s/) }.to_h,
             benchmark: bm,
-            encoding: encoding,
-            content_type: content_type,
-            mask_body: HttpLog.masked_body_url?(url)
+            encoding: @http_log[:encoding],
+            content_type: @http_log[:content_type],
+            mask_body: HttpLog.masked_body_url?(@http_log[:url])
           )
           return_code
         end
+
+        def httplog_add_callback
+          # Hack to perform this callback before the cleanup
+          @on_complete ||= []
+          @on_complete.unshift -> (*) do
+            # Not sure where the actual status code is stored - so let's
+            # extract it from the response header.
+            encoding = response_headers.scan(/Content-Encoding: (\S+)/).flatten.first
+            content_type = response_headers.scan(/Content-Type: (\S+(; charset=\S+)?)/).flatten.first
+
+            # Hard to believe that Ethon wouldn't parse out the headers into
+            # an array; probably overlooked it. Anyway, let's do it ourselves:
+            headers = response_headers.split(/\r?\n/).drop(1)
+
+            @http_log.merge!(
+              encoding: encoding,
+              content_type: content_type,
+              response_headers: headers,
+              response_body: response_body
+            )
+          end
+        end
       end
     end
   end

data/lib/httplog/configuration.rb

@@ -50,7 +50,7 @@ module HttpLog
       @prefix_data_lines       = false
       @prefix_response_lines   = false
       @prefix_line_numbers     = false
-      @json_parser             = JSON
+      @json_parser             = nil
       @filter_parameters       = %w[password]
     end
   end

data/lib/httplog/http_log.rb

@@ -26,6 +26,7 @@ module HttpLog
 
     def configure
       yield(configuration)
+      configuration.json_parser ||= ::JSON if configuration.json_log || configuration.url_masked_body_pattern
     end
 
     def call(options = {})
@@ -349,7 +350,7 @@ module HttpLog
     end
 
     def log_data_lines(data)
-      data.each_line.with_index do |line, row|
+      data.to_s.each_line.with_index do |line, row|
         if config.prefix_line_numbers
           log("#{row + 1}: #{line.chomp}")
         else

data/lib/httplog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HttpLog
-  VERSION = '1.5.0'.freeze
+  VERSION = '1.6.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httplog
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Thilo Rusche
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-20 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ethon
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -226,14 +240,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -272,7 +286,10 @@ files:
 homepage: http://github.com/trusche/httplog
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/trusche/httplog/issues
+  changelog_uri: https://github.com/trusche/httplog/CHANGELOG.md
+  source_code_uri: https://github.com/trusche/httplog
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -281,14 +298,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Log outgoing HTTP requests.