httplog 0.2.1 → 0.2.2

data/README.md

@@ -4,11 +4,19 @@ 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.
 
-So far this gem works with the following HTTP libraries:
+So far this gem works with the following ruby modules and libraries:
 
-* Net::HTTP
-* OpenURI
-* HTTPClient
+* [Net::HTTP](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/net/http/rdoc/index.html)
+* [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)
+* [HTTPClient](https://github.com/nahi/httpclient)
+* [HTTParty](https://github.com/jnunemaker/httparty)
+
+These libraries are at least partially supported, where they use one of the above as adapters:
+
+* [Faraday](https://github.com/technoweenie/faraday)
+* [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.
@@ -50,7 +58,7 @@ So if you want to use this in a Rails app:
 
 With the default configuration, the log output might look like this:
 
-    D, [2012-11-21T15:09:03.532970 #6857] DEBUG -- : [httplog] Connecting: localhost
+    D, [2012-11-21T15:09:03.532970 #6857] DEBUG -- : [httplog] Connecting: localhost:80
     D, [2012-11-21T15:09:03.533877 #6857] DEBUG -- : [httplog] Sending: GET http://localhost:9292/index.html
     D, [2012-11-21T15:09:03.534499 #6857] DEBUG -- : [httplog] Status: 200
     D, [2012-11-21T15:09:03.534544 #6857] DEBUG -- : [httplog] Benchmark: 0.00057 seconds
@@ -67,10 +75,14 @@ With the default configuration, the log output might look like this:
 
 ### Known Issues
 
+* Requests types other than GET and POST have not been explicitly tested.
+  They may or may not be logged, depending on the implementation details of the underlying library.
+  If they are not for a particular library, please feel free to open an issue with the details.
+
 * When using OpenURI, the reading of the HTTP response body is deferred,
   so it is not available for logging. This will be noted in the logging statement:
 
-        D, [2012-11-21T15:09:03.547005 #6857] DEBUG -- : [httplog] Connecting: localhost
+        D, [2012-11-21T15:09:03.547005 #6857] DEBUG -- : [httplog] Connecting: localhost:80
         D, [2012-11-21T15:09:03.547938 #6857] DEBUG -- : [httplog] Sending: GET http://localhost:9292/index.html
         D, [2012-11-21T15:09:03.548615 #6857] DEBUG -- : [httplog] Status: 200
         D, [2012-11-21T15:09:03.548662 #6857] DEBUG -- : [httplog] Benchmark: 0.000617 seconds
@@ -79,6 +91,16 @@ With the default configuration, the log output might look like this:
 *  When using HTTPClient, the TCP connection establishment will be logged
    *after* the HTTP request and headers, due to the way HTTPClient is organized.
 
+        D, [2012-11-22T18:39:46.031698 #12800] DEBUG -- : [httplog] Sending: GET http://localhost:9292/index.html
+        D, [2012-11-22T18:39:46.031756 #12800] DEBUG -- : [httplog] Header: accept: */*
+        D, [2012-11-22T18:39:46.031788 #12800] DEBUG -- : [httplog] Header: foo: bar
+        D, [2012-11-22T18:39:46.031942 #12800] DEBUG -- : [httplog] Connecting: localhost:9292
+        D, [2012-11-22T18:39:46.033409 #12800] DEBUG -- : [httplog] Status: 200
+        D, [2012-11-22T18:39:46.033483 #12800] DEBUG -- : [httplog] Benchmark: 0.001562 seconds
+
+* When using Ethon and any library based on it (such as Typhoeus),
+  the TCP connection is not logged (since it's established by libcurl).
+
 ### Running the specs
 
 Make sure you have the necessary dependencies installed by running `bundle install`.

data/lib/httplog.rb

@@ -2,3 +2,5 @@ require "httplog/version"
 require "httplog/http_log"
 require "httplog/adapters/net_http"
 require "httplog/adapters/httpclient"
+require "httplog/adapters/excon"
+require "httplog/adapters/ethon"

data/lib/httplog/adapters/ethon.rb

@@ -0,0 +1,36 @@
+if defined?(Ethon)
+  module Ethon
+    class Easy
+
+      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
+
+          orig_http_request(url, action_name, options)
+        end
+      end
+
+      module Operations
+        alias_method :orig_perform, :perform
+        def perform
+          response_code = nil
+          bm = Benchmark.realtime do
+            reponse_code = orig_perform
+          end
+
+          # 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
+          HttpLog.log_compact(@action_name, @url, @return_code, bm)
+          HttpLog.log_status(status)
+          HttpLog.log_benchmark(bm)
+          HttpLog.log_body(response_body)
+          return_code
+        end
+      end
+    end
+  end
+end

data/lib/httplog/adapters/excon.rb

@@ -0,0 +1,36 @@
+if defined?(Excon)
+  module Excon
+    class Socket
+      alias_method :orig_connect, :connect
+      def connect
+        host = @proxy ? @proxy[:host] : @params[:host]
+        port = @proxy ? @proxy[:port] : @params[:port]
+        HttpLog.log_connection(host, port)
+        orig_connect
+      end
+
+    end
+
+    class Connection
+      alias_method :orig_request_kernel, :request_kernel
+      def request_kernel(params)
+       url = "#{params[:scheme]}://#{params[:host]}:#{params[:port]}#{params[:path]}#{params[:query]}"
+        HttpLog.log_request(params[:method], url)
+        HttpLog.log_headers(params[:headers])
+        HttpLog.log_data(params[:body]) if params[:method] == :post
+
+        response = nil
+        bm = Benchmark.realtime do
+          response = orig_request_kernel(params)
+        end
+
+        HttpLog.log_compact(params[:method], url, response.status, bm)
+        HttpLog.log_status(response.status)
+        HttpLog.log_benchmark(bm)
+        HttpLog.log_body(response.body)
+
+        response
+      end
+    end
+  end
+end

data/lib/httplog/adapters/httpclient.rb

@@ -1,4 +1,3 @@
-
 if defined?(::HTTPClient)
   class HTTPClient
     private

data/lib/httplog/version.rb

@@ -1,4 +1,4 @@
 module HttpLog
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: httplog
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-22 00:00:00.000000000 Z
+date: 2012-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -75,6 +75,86 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ethon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! "Log outgoing HTTP requests made from your application. Helpful for
   tracking API calls\n                     of third party gems that don't provide
   their own log output."
@@ -83,6 +163,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/httplog/adapters/ethon.rb
+- lib/httplog/adapters/excon.rb
 - lib/httplog/adapters/httpclient.rb
 - lib/httplog/adapters/net_http.rb
 - lib/httplog/http_log.rb
@@ -114,5 +196,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Logs outgoing Net::HTTP requests.
+summary: Logs outgoing HTTP requests.
 test_files: []
+has_rdoc: