httplog 0.2.4 → 0.2.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzdhNzViMDJmOTIxNmQ2NWQ2YmM3NjU2MmE2NDI3NGQ1MTVjNzdmYw==
+  data.tar.gz: !binary |-
+    OWU5NjJjZTY1OTRmYjNlZDNmZWVmZWVmMGJlNGZlNjYzMGQxYzM4OQ==
+SHA512:
+  metadata.gz: !binary |-
+    NWJjNTFmYzk4YTM2ZjIxMjg0ZTM4NjQyZDJlY2NmZWFlMGIyZDZiODE5YTVk
+    ZTk1Njc4NWIxYjczMzgwNDBiOTM5ZTBiNTVmZTdhM2NkNDNhMmVhYzQ4NmI1
+    YjBlMGVhNjQ4ZmZkNjI0N2Q5MTQxY2MzODY3NTdhZWI5OThlNmE=
+  data.tar.gz: !binary |-
+    MWIxNTdiNzMyNGQ5YWIxOGNhMjg2ZGZmMzIyOTlmYWU2MTA2ODE2YTU0Yzlh
+    MWQ3MTQ4NmQ5OTlkZjdlNTIyNWQ4MGNlMzY5MWM5Y2U5ZTJlNzk4ZmYyNDZi
+    NGRiZGRmYzY4ZTk3NTg0Y2QxZDRlMWQwMWU5ODQxNzcyYTJiZWY=

data/README.md

@@ -1,5 +1,7 @@
 ## httplog
 
+[![Gem Version](https://badge.fury.io/rb/httplog.png)](http://badge.fury.io/rb/httplog)
+
 Log outgoing HTTP requests made from your application.
 See the [blog post](http://trusche.github.com/blog/2011/09/29/logging-outgoing-http-requests/)
 for more details.
@@ -50,6 +52,11 @@ You can override the following default options:
     HttpLog.options[:log_benchmark] = true
     HttpLog.options[:compact_log]   = false # setting this to true will make all "log_*" options redundant
 
+	# 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
@@ -124,3 +131,4 @@ Thanks to these fine folks for contributing pull requests:
 * [Eric Cohen](https://github.com/eirc)
 * [Nikos Dimitrakopoulos](https://github.com/nikosd)
 * [Marcos Hack](https://github.com/marcoshack)
+* [Andrew Hammond](https://github.com/andrhamm)

data/lib/httplog/adapters/ethon.rb

@@ -2,12 +2,17 @@ if defined?(Ethon)
   module Ethon
     class Easy
 
+      attr_accessor :action_name
+
       module Http
         alias_method :orig_http_request, :http_request
         def http_request(url, action_name, options = {})
-          HttpLog.log_request(action_name, url)
-          HttpLog.log_headers(options[:headers])
-          HttpLog.log_data(options[:body]) if action_name == :post
+          @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
 
           orig_http_request(url, action_name, options)
         end
@@ -16,6 +21,8 @@ if defined?(Ethon)
       module Operations
         alias_method :orig_perform, :perform
         def perform
+          return orig_perform unless HttpLog.url_approved?(url)
+
           response_code = nil
           bm = Benchmark.realtime do
             reponse_code = orig_perform

data/lib/httplog/adapters/excon.rb

@@ -19,25 +19,38 @@ if defined?(Excon)
 
       alias_method :orig_request, :request
       def request(params, &block)
-        datum = nil
+        result = nil
         bm = Benchmark.realtime do
-          datum = orig_request(params, &block)
+          result = orig_request(params, &block)
         end
-        HttpLog.log_compact(datum[:method], _httplog_url(datum), datum[:status], bm)
-        HttpLog.log_benchmark(bm)
-        datum
+
+        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
+        result
       end
 
       alias_method :orig_request_call, :request_call
       def request_call(datum)
-        HttpLog.log_request(datum[:method], _httplog_url(datum))
-        HttpLog.log_headers(datum[:headers])
-        HttpLog.log_data(datum[:body]) if datum[:method] == :post
+        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_method :orig_response, :response
       def response(datum={})
+        return orig_response(datum) unless HttpLog.url_approved?(_httplog_url(datum))
+
         bm = Benchmark.realtime do
           datum = orig_response(datum)
         end

data/lib/httplog/adapters/httpclient.rb

@@ -4,9 +4,13 @@ if defined?(::HTTPClient)
     alias_method :orig_do_get_block, :do_get_block
 
     def do_get_block(req, proxy, conn, &block)
-      HttpLog.log_request(req.header.request_method, req.header.request_uri)
-      HttpLog.log_headers(req.headers)
-      HttpLog.log_data(req.body) if req.header.request_method == "POST"
+      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) if req.header.request_method == "POST"
+      end
 
       retryable_response = nil
       bm = Benchmark.realtime do
@@ -17,12 +21,14 @@ if defined?(::HTTPClient)
         end
       end
 
-      res = conn.pop
-      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)
-      conn.push(res)
+      if log_enabled
+        res = conn.pop
+        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)
+        conn.push(res)
+      end
 
       raise retryable_response if retryable_response != nil
     end
@@ -30,7 +36,9 @@ if defined?(::HTTPClient)
     class Session
       alias_method :orig_create_socket, :create_socket
       def create_socket(site)
-        HttpLog.log_connection(site.host, site.port)
+        if HttpLog.url_approved?("#{site.host}:#{site.port}")
+          HttpLog.log_connection(site.host, site.port)
+        end
         orig_create_socket(site)
       end
     end

data/lib/httplog/adapters/net_http.rb

@@ -7,7 +7,9 @@ module Net
 
       url = "http://#{@address}:#{@port}#{req.path}"
 
-      if started? && !HttpLog.options[:compact_log]
+      log_enabled = HttpLog.url_approved?(url)
+
+      if log_enabled && started?
         HttpLog.log_request(req.method, url)
         HttpLog.log_headers(req.each_header.collect)
         # A bit convoluted becase post_form uses form_data= to assign the data, so
@@ -19,7 +21,7 @@ module Net
         @response = orig_request(req, body, &block)
       end
 
-      if started?
+      if log_enabled && started?
         HttpLog.log_compact(req.method, url, @response.code, bm)
         HttpLog.log_status(@response.code)
         HttpLog.log_benchmark(bm)
@@ -31,7 +33,8 @@ module Net
     end
 
     def connect
-      HttpLog.log_connection(@address, @port) unless started?
+      HttpLog.log_connection(@address, @port) if !started? && HttpLog.url_approved?("#{@address}:#{@port}")
+
       orig_connect
     end
   end

data/lib/httplog/adapters/patron.rb

@@ -3,18 +3,24 @@ if defined?(Patron)
     class Session
       alias_method :orig_request, :request
       def request(action_name, url, headers, options = {})
-        HttpLog.log_request(action_name, url)
-        HttpLog.log_headers(headers)
-        HttpLog.log_data(options[:data]) if action_name == :post
+        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
+        end
 
         bm = Benchmark.realtime do
           @response = orig_request(action_name, url, headers, options)
         end
 
-        HttpLog.log_compact(action_name, url, @response.status, bm)
-        HttpLog.log_status(@response.status)
-        HttpLog.log_benchmark(bm)
-        HttpLog.log_body(@response.body)
+        if log_enabled
+          HttpLog.log_compact(action_name, url, @response.status, bm)
+          HttpLog.log_status(@response.status)
+          HttpLog.log_benchmark(bm)
+          HttpLog.log_body(@response.body)
+        end
       end
     end
   end

data/lib/httplog/http_log.rb

@@ -5,18 +5,22 @@ require "benchmark"
 module HttpLog
   DEFAULT_LOGGER  = Logger.new($stdout)
   DEFAULT_OPTIONS = {
-    :logger        => DEFAULT_LOGGER,
-    :severity      => Logger::Severity::DEBUG,
-    :log_connect   => true,
-    :log_request   => true,
-    :log_headers   => false,
-    :log_data      => true,
-    :log_status    => true,
-    :log_response  => true,
-    :log_benchmark => true,
-    :compact_log   => false
+    :logger                => DEFAULT_LOGGER,
+    :severity              => Logger::Severity::DEBUG,
+    :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
   }
 
+  LOG_PREFIX = "[httplog] ".freeze
+
   class << self
     def options
       @@options ||= DEFAULT_OPTIONS.clone
@@ -26,8 +30,16 @@ module HttpLog
       @@options = DEFAULT_OPTIONS.clone
     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])
+    end
+
     def log(msg)
-      @@options[:logger].add(@@options[:severity]) { "[httplog] #{msg}" }
+      @@options[:logger].add(@@options[:severity]) { LOG_PREFIX + msg }
     end
 
     def log_connection(host, port = nil)
@@ -81,6 +93,7 @@ module HttpLog
 
     def log_compact(method, uri, status, seconds)
       return unless options[: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
   end

data/lib/httplog/version.rb

@@ -1,4 +1,4 @@
 module HttpLog
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end
 

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: httplog
 version: !ruby/object:Gem::Version
-  version: 0.2.4
-  prerelease: 
+  version: 0.2.5
 platform: ruby
 authors:
 - Thilo Rusche
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-01 00:00:00.000000000 Z
+date: 2014-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -126,7 +111,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -134,7 +118,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -142,7 +125,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: ethon
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -150,7 +132,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -158,7 +139,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: patron
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -166,7 +146,20 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -192,27 +185,26 @@ files:
 - README.md
 homepage: http://github.com/trusche/httplog
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Logs outgoing HTTP requests.
 test_files: []
 has_rdoc: