httplog 0.3.3 → 0.99.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4458a32430545d16e4403483a77ef00b59d30c19
-  data.tar.gz: 5d334c5157c1da40ee45a1bd4c1142f1cd9c7636
+  metadata.gz: 04f8b802147c2e3feef23e52002cd36dfbd24b7f
+  data.tar.gz: 4826d8585db9817054996dd0b4f9f6bdcebd6a7a
 SHA512:
-  metadata.gz: a3c3a854366b3d89ba534bfef525d488e7899cfd4935a11458aee52d06bd8a4bcc20d6b773795ba6432207aad2083baa96501c51cd9a07bd899f22139a7e469d
-  data.tar.gz: f09ac99eb6b33c119b55c3a496dc3c6c49a1431dc80bf2cac01f6e6a77f19fc46544de7ccf9b0892572a7cd18cb1e7ac046aeb90817fc62b3925b2d428e250f6
+  metadata.gz: 2948b2216365799da61ece7891814da3fcb5db703704b24878dbf8fc23cad1ee9c877e773a80e353f971a8bf311aa5cddbb345631ae5bee761882a55c2fa1503
+  data.tar.gz: 202b4b85870bc9a497951b1c5302571fef172daeab7c4927639e2b4c627ba1841b875167601f59dee7faf0a725def65de34ded2c362cc0aa0f47ebde8d33b64d

data/README.md

@@ -2,26 +2,29 @@
 
 [![Gem Version](https://badge.fury.io/rb/httplog.png)](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.png)](https://codeclimate.com/github/trusche/httplog)
 
+**+++ This is the README for version 0.99.0 and higher. If you're on previous versions, please refer to [this README version](https://github.com/trusche/httplog/tree/v0.3.3), since the configuration syntax has changed.+++**
+
 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. 
 
-So far this gem works with the following ruby modules and libraries:
+**+++Requires ruby 2.2 or higher. If you're stuck with an older version of ruby for some reason, you're stuck with httplog v0.3.3.+++**
+
+This gem works with the following ruby modules and libraries:
 
 * [Net::HTTP](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/net/http/rdoc/index.html)
-* [Ethon](https://github.com/typhoeus/ethon) (**Needs work to support latest versions**)
-* [Excon](https://github.com/geemus/excon) (for excon >= v18.0, httplog >= 0.2.4 is required)
+* [Ethon](https://github.com/typhoeus/ethon)
+* [Excon](https://github.com/geemus/excon)
 * [OpenURI](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/open-uri/rdoc/index.html)
 * [Patron](https://github.com/toland/patron)
 * [HTTPClient](https://github.com/nahi/httpclient)
 * [HTTParty](https://github.com/jnunemaker/httparty)
 * [HTTP](https://github.com/httprb/http)
 
-These libraries are at least partially supported, where they use one of the above as adapters:
+These libraries are at least partially supported, where they use one of the above as adapters, but not explicitly tested - YMMV:
 
 * [Faraday](https://github.com/technoweenie/faraday)
-* [Typhoeus](https://github.com/typhoeus/typhoeus) (**Needs work to support latest versions**)
+* [Typhoeus](https://github.com/typhoeus/typhoeus)
 
-In theory, it should also work with any library built on top of these. But since
-the difference between theory and practice is bigger in practice than in theory, YMMV.
+In theory, it should also work with any library built on top of these. But the difference between theory and practice is bigger in practice than in theory.
 
 This is very much a development and debugging tool; it is **not recommended** to
 use this in a production environment as it is moneky-patching the respective HTTP implementations. 
@@ -46,33 +49,49 @@ By default, this will log all outgoing HTTP requests and their responses to $std
 
 You can override the following default options:
 
-    HttpLog.options[:logger]        = Logger.new($stdout)
-    HttpLog.options[:severity]      = Logger::Severity::DEBUG
-    HttpLog.options[:log_connect]   = true
-    HttpLog.options[:log_request]   = true
-    HttpLog.options[:log_headers]   = false
-    HttpLog.options[:log_data]      = true
-    HttpLog.options[:log_status]    = true
-    HttpLog.options[:log_response]  = true
-    HttpLog.options[:log_benchmark] = true
-    HttpLog.options[:compact_log]   = false # setting this to true will make 
-    all "log_*" options redundant
-    HttpLog.options[:color]         = false # (see below)
-	# only log requests made to specified hosts (URLs)
-    HttpLog.options[:url_whitelist_pattern] = /.*/
-    # overrides whitelist
-    HttpLog.options[:url_blacklist_pattern] = nil
-
-So if you want to use this in a Rails app:
-
-    # config/initializers/httplog.rb
-    HttpLog.options[:logger] = Rails.logger
+    HttpLog.configure do |config|
+     
+      # You can assign a different logger
+      config.logger = Logger.new($stdout)
+      
+      # I really wouldn't change this...
+      config.severity = Logger::Severity::DEBUG
+      
+      # Tweak which parts of the HTTP cycle to log...
+      config.log_connect   = true
+      config.log_request   = true
+      config.log_headers   = false
+      config.log_data      = true
+      config.log_status    = true
+      config.log_response  = true
+      config.log_benchmark = true
+      
+      # ...or log all request as a single line by setting this to `true`
+      config.compact_log = false 
+      
+      # Prettify the output - see below
+      config.color = false
+      
+      # Limit logging based on URL patterns
+      config.url_whitelist_pattern = /.*/
+      config.url_blacklist_pattern = nil
+    end
+
+If you want to use this in a Rails app, I'd suggest configuring this specifically for each environment. A global initializer is not a good idea since `HttpLog` will be undefined in production. Because you're **not using this in production**, right? :)
+
+    # config/environments/development.rb
+    
+    HttpLog.configure do |config|
+      config.logger = Rails.logger
+    end
 
 You can colorize the output to make it stand out in your logfile:
 
-    HttpLog.options[:color] = {color: :black, background: :light_red}    
+    HttpLog.configure do |config|
+      config.color = {color: :black, background: :light_red}
+    end
 
-For more color options see [colorize documentation](https://github.com/fazibear/colorize/blob/master/README.md)
+For more color options [please refer to the colorize documentation](https://github.com/fazibear/colorize/blob/master/README.md)
 
 ### Compact logging
 

data/lib/httplog.rb

@@ -1,4 +1,5 @@
 require "httplog/version"
+require "httplog/configuration"
 require "httplog/http_log"
 require "httplog/adapters/net_http"
 require "httplog/adapters/httpclient"

data/lib/httplog/configuration.rb

@@ -0,0 +1,50 @@
+module HttpLog
+  class Configuration
+    attr_accessor :compact_log,
+                  :logger,
+                  :severity,
+                  :prefix,
+                  :log_connect,
+                  :log_request,
+                  :log_headers,
+                  :log_data,
+                  :log_status,
+                  :log_response,
+                  :log_benchmark,
+                  :compact_log,
+                  :url_whitelist_pattern,
+                  :url_blacklist_pattern,
+                  :color,
+                  :prefix_data_lines,
+                  :prefix_response_lines,
+                  :prefix_line_numbers
+
+    def initialize
+      @compact_log           = false
+      @logger                = Logger.new($stdout)
+      @severity              = Logger::Severity::DEBUG
+      @prefix                = LOG_PREFIX
+      @log_connect           = true
+      @log_request           = true
+      @log_headers           = false
+      @log_data              = true
+      @log_status            = true
+      @log_response          = true
+      @log_benchmark         = true
+      @compact_log           = false
+      @url_whitelist_pattern = /.*/
+      @url_blacklist_pattern = nil
+      @color                 = false
+      @prefix_data_lines     = false
+      @prefix_response_lines = false
+      @prefix_line_numbers   = false
+    end
+
+    # 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)
+    end
+
+  end
+end

data/lib/httplog/http_log.rb

@@ -6,83 +6,63 @@ require "colorize"
 module HttpLog
   LOG_PREFIX = "[httplog] ".freeze
 
-  DEFAULT_LOGGER  = Logger.new($stdout)
-  DEFAULT_OPTIONS = {
-    :logger                => DEFAULT_LOGGER,
-    :severity              => Logger::Severity::DEBUG,
-    :prefix                => LOG_PREFIX,
-    :log_connect           => true,
-    :log_request           => true,
-    :log_headers           => false,
-    :log_data              => true,
-    :log_status            => true,
-    :log_response          => true,
-    :log_benchmark         => true,
-    :compact_log           => false,
-    :url_whitelist_pattern => /.*/,
-    :url_blacklist_pattern => nil,
-    :color                 => false,
-    :prefix_data_lines     => false,
-    :prefix_response_lines => false,
-    :prefix_line_numbers   => false
-  }
+  class << self
 
+    attr_accessor :configuration
 
-  class << self
-    def options
-      @@options ||= DEFAULT_OPTIONS.clone
+    def configuration
+      @configuration ||= Configuration.new
     end
+    alias_method :config, :configuration
+    alias_method :options, :configuration # TODO: remove with 1.0.0
 
-    def reset_options!
-      @@options = DEFAULT_OPTIONS.clone
+    def reset!
+      @configuration = nil
     end
 
+    def configure
+      yield(configuration)
+    end
+    
     def url_approved?(url)
-      unless options[:url_blacklist_pattern].nil?
-        return false if url.to_s.match(options[:url_blacklist_pattern])
-      end
-
-      url.to_s.match(options[:url_whitelist_pattern])
+      return false if config.url_blacklist_pattern && url.to_s.match(config.url_blacklist_pattern)
+      url.to_s.match(config.url_whitelist_pattern)
     end
 
     def log(msg)
-      # This builds a hash {0=>:DEBUG, 1=>:INFO, 2=>:WARN, 3=>:ERROR, 4=>:FATAL, 5=>:UNKNOWN}.
-      # Courtesy of the delayed_job gem in this commit: 
-      # https://github.com/collectiveidea/delayed_job/commit/e7f5aa1ed806e61251bdb77daf25864eeb3aff59
-      severities = Hash[*Logger::Severity.constants.enum_for(:each_with_index).collect{ |s, i| [i, s] }.flatten]
-      severity = severities[options[:severity]].to_s.downcase
-      options[:logger].send(severity, colorize(prefix + msg))
+      config.logger.log(config.severity, colorize(prefix + msg))
     end
 
     def log_connection(host, port = nil)
-      return if options[:compact_log] || !options[:log_connect]
+      return if config.compact_log || !config.log_connect
       log("Connecting: #{[host, port].compact.join(":")}")
     end
 
     def log_request(method, uri)
-      return if options[:compact_log] || !options[:log_request]
+      return if config.compact_log || !config.log_request
       log("Sending: #{method.to_s.upcase} #{uri}")
     end
 
     def log_headers(headers = {})
-      return if options[:compact_log] || !options[:log_headers]
+      return if config.compact_log || !config.log_headers
       headers.each do |key,value|
         log("Header: #{key}: #{value}")
       end
     end
 
     def log_status(status)
-      return if options[:compact_log] || !options[:log_status]
+      return if config.compact_log || !config.log_status
+      status = Rack::Utils.status_code(status) unless status == /\d{3}/
       log("Status: #{status}")
     end
 
     def log_benchmark(seconds)
-      return if options[:compact_log] || !options[:log_benchmark]
-      log("Benchmark: #{seconds} seconds")
+      return if config.compact_log || !config.log_benchmark
+      log("Benchmark: #{seconds.to_f.round(6)} seconds")
     end
 
     def log_body(body, encoding = nil, content_type=nil)
-      return if options[:compact_log] || !options[:log_response]
+      return if config.compact_log || !config.log_response
 
       unless text_based?(content_type)
         log("Response: (not showing binary data)")
@@ -104,7 +84,7 @@ module HttpLog
 
       data = utf_encoded(body.to_s, content_type)
 
-      if options[:prefix_response_lines]
+      if config.prefix_response_lines
         log("Response:")
         log_data_lines(data)
       else
@@ -114,10 +94,10 @@ module HttpLog
     end
 
     def log_data(data)
-      return if options[:compact_log] || !options[:log_data]
+      return if config.compact_log || !config.log_data
       data = utf_encoded(data.to_s)
 
-      if options[:prefix_data_lines]
+      if config.prefix_data_lines
         log("Data:")
         log_data_lines(data)
       else
@@ -126,14 +106,14 @@ module HttpLog
     end
 
     def log_compact(method, uri, status, seconds)
-      return unless options[:compact_log]
+      return unless config.compact_log
       status = Rack::Utils.status_code(status) unless status == /\d{3}/
       log("#{method.to_s.upcase} #{uri} completed with status code #{status} in #{seconds} seconds")
     end
 
     def colorize(msg)
-      return msg unless options[:color]
-      msg.send(:colorize, options[:color])
+      return msg unless config.color
+      msg.send(:colorize, config.color)
     end
 
     private
@@ -154,7 +134,7 @@ module HttpLog
 
     def log_data_lines(data)
       data.each_line.with_index do |line, row|
-        if options[:prefix_line_numbers]
+        if config.prefix_line_numbers
           log("#{row + 1}: #{line.chomp}")
         else
           log(line.strip)
@@ -163,10 +143,10 @@ module HttpLog
     end
 
     def prefix
-      if options[:prefix].respond_to?(:call)
-        options[:prefix].call
+      if config.prefix.respond_to?(:call)
+        config.prefix.call
       else
-        options[:prefix].to_s
+        config.prefix.to_s
       end
     end
 

data/lib/httplog/version.rb

@@ -1,4 +1,4 @@
 module HttpLog
-  VERSION = "0.3.3"
+  VERSION = "0.99.1"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httplog
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.99.1
 platform: ruby
 authors:
 - Thilo Rusche
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.18.0
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: ethon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ethon
+  name: patron
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: patron
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -164,20 +164,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: http
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.0.4
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -193,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: log4r
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,19 +193,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.8
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -252,6 +238,7 @@ files:
 - lib/httplog/adapters/httpclient.rb
 - lib/httplog/adapters/net_http.rb
 - lib/httplog/adapters/patron.rb
+- lib/httplog/configuration.rb
 - lib/httplog/http_log.rb
 - lib/httplog/version.rb
 homepage: http://github.com/trusche/httplog
@@ -273,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Logs outgoing HTTP requests.