http-wiretap 0.1.0

data/README.md

@@ -0,0 +1,114 @@
+HTTP Wiretap - An HTTP Recorder
+===============================
+
+## DESCRIPTION
+
+HTTP Wiretap is a library used to log HTTP requests and responses within your
+application. This can be useful when trying to determine what is occurring in
+your application or when trying to debug someone else's application.
+
+This library follows the rules of [Semantic Versioning](http://semver.org/).
+
+
+## RUNNING
+
+To install HTTP Wiretap, simply install the gem:
+
+	$ [sudo] gem install http-wiretap
+
+And enable it within your application:
+
+	require 'http/wiretap'
+	HTTP::Wiretap.start()
+
+And disable it when you're done:
+
+	HTTP::Wiretap.stop()
+
+Or clear out your log directory while running:
+
+	HTTP::Wiretap.clear()
+
+By default, all requests will be logged to `http-log` of your present working
+directory. Also, your `http-log` directory will be cleared out each time you
+run `start()`.
+
+
+## MODES
+
+HTTP Wiretap will log HTTP traffic in two modes:
+
+1. Raw - Logs traffic in the order that it occurred.
+2. Host - Groups traffic by host and path
+
+When logging, data written will be linked with a symbolic link to save space and
+reduce I/O.
+
+The `http-log` directory is separated by mode and then each request is written
+into a directory that contains a `request` file and a `response` file. Each of
+these files contain the headers and body.
+
+
+## EXAMPLE
+
+If your application were to make the following requests:
+
+	http://abc.com/login
+	http://xyz.com/users
+	http://xyz.com/users/1/favorites
+	http://abc.com/fetch_info.pl?foo=bar
+	http://abc.com/fetch_info.pl?foo=baz
+
+Then your `http-log` directory will show the following:
+
+	+ http-log/
+	  + raw/
+	    + 0/
+	      + request
+	      + response
+	    + 1/
+	      + request
+	      + response
+	    + 2/
+	      + request
+	      + response
+	    + 3/
+	      + request
+	      + response
+	  + host/
+	    + abc.com/
+	      + login/
+	        + 0/
+	          + request
+	          + response
+	      + fetch_info.pl/
+	        + 0/
+	          + request
+	          + response
+	        + 1/
+	          + request
+	          + response
+	    + xyz.com/
+	      + users/
+	        + 0/
+	          + request
+	          + response
+	        + 1/
+	          + favorites/
+	            + 0/
+	              + request
+	              + response
+
+There can be overlap when making calls to a `/users` path and then a `/users/0`
+path since requests are numbered. If anyone has a better idea of how to
+structure this while keeping it simple, please let me know.
+
+
+## CONTRIBUTE
+
+If you'd like to contribute to HTTP Wiretap, start by forking the repository
+on GitHub:
+
+http://github.com/benbjohnson/http-wiretap
+
+Please add test coverage to your code when submitting pull requests.

data/lib/http/ext/net_http.rb

@@ -0,0 +1,26 @@
+require 'net/http'
+require 'net/https'
+
+module Net
+  class HTTP
+    def request_with_wiretap(request, body = nil, &block)
+      request_id = nil
+      
+      # Log request
+      if ::HTTP::Wiretap.enabled
+        request_id = ::HTTP::Wiretap.log_request(self, request)
+      end
+      
+      # Send request
+      response = request_without_wiretap(request, body, &block)
+
+      # Log response
+      if ::HTTP::Wiretap.enabled
+        ::HTTP::Wiretap.log_response(self, response, request_id)
+      end
+    end
+
+    alias_method :request_without_wiretap, :request
+    alias_method :request, :request_with_wiretap
+  end
+end

data/lib/http/wiretap.rb

@@ -0,0 +1,158 @@
+dir = File.join(File.dirname(File.expand_path(__FILE__)), '..')
+$:.unshift(dir)
+
+require 'http/ext/net_http'
+require 'fileutils'
+
+module HTTP
+  class Wiretap
+    VERSION = '0.1.0'
+    
+    ############################################################################
+    # Static Initializers
+    ############################################################################
+    
+    @enabled = false 
+
+
+    ############################################################################
+    # Static Properties
+    ############################################################################
+    
+    # A flag stating if wiretap has started
+    def self.enabled
+      @enabled
+    end
+
+
+    # The root directory where logs are stored.
+    def self.log_directory
+      @log_directory || 'http-log'
+    end
+
+    # Sets the root directory where logs are stored.
+    def self.log_directory=(dir)
+      @log_directory = dir
+    end
+
+
+    ############################################################################
+    # Static Methods
+    ############################################################################
+    
+    # Begins logging requests and responses.
+    def self.start()
+      # Reset the sequential request identifier
+      @next_id = 0
+      @host_request_paths = {}
+      @host_request_next_id = {}
+      
+      # Enable logging
+      @enabled = true
+      
+      # Clear log directory
+      FileUtils.rm_rf(log_directory)
+    end
+
+    # Stops logging requests and responses.
+    def self.stop()
+      # Disable logging
+      @enabled = false
+    end
+
+    # Stops logging and then restarts.
+    def self.restart()
+      self.stop()
+      self.start()
+    end
+    
+    # Logs a request's headers and body to a file. The file will be written to: 
+    #
+    # <log_directory>/raw/<request_number>/request
+    #
+    # A symbolic link will be made from that directory to the `host/` directory.
+    #
+    # @param [Net::HTTP] http  the object sending the request
+    # @param [Net::HTTP::Request] request  the request being logged
+    #
+    # @return [Fixnum]  the sequential identifier for this request
+    def self.log_request(http, request)
+      return unless @enabled
+      
+      # Retrieve the request identifier
+      request_id = @next_id
+      @next_id += 1
+      
+      # Create raw log directory
+      raw_dir = File.expand_path("#{log_directory}/raw/#{request_id}")
+      ::FileUtils.mkdir_p(raw_dir)
+      
+      # Write request to file
+      File.open("#{raw_dir}/request", 'w') do |file|
+        # Write method and path
+        file.write("#{request.method} #{request.path} HTTP/1.1\r\n")
+        
+        # Write headers
+        connection = *request.get_fields('Connection') || 'close'
+        request.each_capitalized do |header_name, header_value|
+          if header_name != 'Connection'
+            file.write("#{header_name}: #{header_value}\r\n")
+          end
+        end
+        file.write("Connection: #{connection}\r\n")
+        file.write("Host: #{http.address}:#{http.port}\r\n")
+        file.write("\r\n")
+        
+        # Write body
+        file.write(request.body) unless request.body.nil?
+      end
+      
+      # Link to host-based log
+      host_request_name = "#{http.address}#{request.path}"
+      host_request_id = @host_request_next_id[host_request_name] ||= 0
+      @host_request_next_id[host_request_name] += 1
+      host_dir = File.expand_path("#{log_directory}/host/#{host_request_name}/#{host_request_id}")
+      @host_request_paths[request_id] = host_dir
+      ::FileUtils.mkdir_p(host_dir)
+      ::FileUtils.ln_sf("#{raw_dir}/request", "#{host_dir}/request")
+
+      return request_id
+    end
+
+    # Logs a response's headers and body to a file. The file will be written to: 
+    #
+    # <log_directory>/raw/<request_number>/response
+    #
+    # A symbolic link will be made from that directory to the `host/` directory.
+    #
+    # @param [Net::HTTP] http  the object sending the request
+    # @param [Net::HTTP::Request] request  the request being logged
+    # @param [Fixnum] request_id  the sequential identifier for the request
+    def self.log_response(http, response, request_id)
+      return unless @enabled
+
+      # Create log directory
+      raw_dir = File.expand_path("#{log_directory}/raw/#{request_id}")
+      ::FileUtils.mkdir_p(raw_dir)
+      
+      # Write response to file
+      File.open("#{raw_dir}/response", 'w') do |file|
+        file.write("HTTP/#{response.http_version} #{response.code}\r\n")
+
+        # Write headers
+        response.each_capitalized do |header_name, header_value|
+          file.write("#{header_name}: #{header_value}\r\n")
+        end
+        file.write("\r\n")
+        
+        # Write body
+        file.write(response.body) unless response.body.nil?
+      end
+
+      # Link to host-based log
+      host_dir = @host_request_paths[request_id]
+      ::FileUtils.mkdir_p(host_dir)
+      ::FileUtils.ln_sf("#{raw_dir}/response", "#{host_dir}/response")
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: http-wiretap
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ben Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-23 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 0
+        - 9
+        - 12
+        version: 0.9.12
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: unindentable
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id004
+description: 
+email: 
+- benbjohnson@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/http/ext/net_http.rb
+- lib/http/wiretap.rb
+- README.md
+has_rdoc: true
+homepage: http://github.com/benbjohnson/http-wiretap
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An HTTP Recorder
+test_files: []
+