netnoop 0.1.0

data/.document

@@ -0,0 +1,3 @@
+README.md
+lib/**/*.rb
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Michael Klett
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# NetNoop
+
+Collects and stores your outgoing HTTP requests in NetNoop.requests for later inspection, usually in your test assertions or matchers.
+
+Can be used in conjunction with FakeWeb to disable outbound HTTP requests while also making the contents of those requests visible.
+
+
+    url = URI.parse("http://www.example.com/")
+    req = Net::HTTP::Post.new(url.path)
+    res = Net::HTTP.start(url.host, url.port) {|http|
+      http.request(req, "Inspect this.")
+    }
+
+    NetNoop.requests
+    # => [#<NetNoop::Request:0x10052ba60 @method=:post, @uri="http://www.example.com/", @body="Inspect this.">]
+
+    NetNoop.requests.first
+    # => #<NetNoop::Request:0x10052ba60 @method=:post, @uri="http://www.example.com/", @body="Inspect this.">
+  
+    NetNoop.request_map
+    # => {"http://www.example.com/"=>[#<NetNoop::Request:0x10052ba60 @method=:post, @uri="http://www.example.com/", @body="Inspect this.">]}
+
+    NetNoop.request_map["http://www.example.com/"].first
+    # => #<NetNoop::Request:0x10052ba60 @method=:post, @uri="http://www.example.com/", @body="Inspect this.">
+
+
+Currently requires [FakeWeb](http://github.com/chrisk/fakeweb/), although this dependency can likely be later removed.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Michael Klett. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "netnoop"
+    gem.summary = %Q{Collects and stores your outgoing HTTP requests for later inspection}
+    gem.description = %Q{Collects and stores your outgoing HTTP requests in NetNoop.requests for later inspection, usually in your test assertions or matchers.\n\nCan be used in conjunction with FakeWeb to disable outbound HTTP requests while also making the contents of those requests visible.}
+    gem.email = "michael@webadvocate.com"
+    gem.homepage = "http://github.com/moklett/netnoop"
+    gem.authors = ["Michael Klett"]
+    gem.add_dependency "fakeweb"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "netnoop #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/basic.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'netnoop'
+
+url = URI.parse("http://www.example.com/")
+req = Net::HTTP::Post.new(url.path)
+res = Net::HTTP.start(url.host, url.port) {|http|
+  http.request(req, "Inspect this.")
+}
+
+p NetNoop.requests
+
+p NetNoop.requests.first
+
+p NetNoop.request_map
+
+p NetNoop.request_map["http://www.example.com/"].first

data/lib/netnoop/bucket.rb

@@ -0,0 +1,26 @@
+require 'singleton'
+
+module NetNoop
+  class Bucket
+    include Singleton
+    
+    attr_accessor :request_map
+    attr_accessor :requests
+    
+    def initialize
+      empty_bucket
+    end
+    
+    def add_request(uri, method, body = nil)
+      req = NetNoop::Request.new(uri, method, body)
+      self.request_map[uri] = self.request_map[uri] + [req]
+      self.requests << req
+    end
+    
+    def empty_bucket
+      self.request_map = Hash.new([])
+      self.requests = []
+    end
+  end
+end
+      

data/lib/netnoop/hooks.rb

@@ -0,0 +1,36 @@
+module Net
+  class HTTP
+    def request_with_netnoop(request, body = nil, &block)
+      uri, method = netnoop_parse_request_details(request)
+      
+      NetNoop::Bucket.instance.add_request(uri, method, body)
+      request_without_netnoop(request, body, &block)
+    end
+    alias_method :request_without_netnoop, :request
+    alias_method :request, :request_with_netnoop
+    
+    private
+    
+    # Borrowed from FakeWeb code
+    def netnoop_parse_request_details(request)
+      protocol = use_ssl? ? "https" : "http"
+
+      path = request.path
+      path = URI.parse(request.path).request_uri if request.path =~ /^http/
+
+      if request["authorization"] =~ /^Basic /
+        userinfo = FakeWeb::Utility.decode_userinfo_from_header(request["authorization"])
+        userinfo = FakeWeb::Utility.encode_unsafe_chars_in_userinfo(userinfo) + "@"
+      else
+        userinfo = ""
+      end
+      
+      # TODO: optionally store the port
+      # uri = "#{protocol}://#{userinfo}#{self.address}:#{self.port}#{path}"
+      uri = "#{protocol}://#{userinfo}#{self.address}#{path}"
+      method = request.method.downcase.to_sym
+      
+      return uri, method
+    end
+  end
+end

data/lib/netnoop/request.rb

@@ -0,0 +1,13 @@
+module NetNoop
+  class Request
+    attr_reader :uri
+    attr_reader :method
+    attr_reader :body
+    
+    def initialize(uri, method, body)
+      @uri = uri
+      @method = method
+      @body = body
+    end
+  end
+end

data/lib/netnoop.rb

@@ -0,0 +1,26 @@
+begin
+  require 'fakeweb'
+rescue LoadError
+  require 'rubygems'
+  require 'fakeweb'
+end
+
+require 'uri'
+require 'netnoop/hooks'
+require 'netnoop/request'
+require 'netnoop/bucket'
+
+module NetNoop
+  def self.requests
+    Bucket.instance.requests
+  end
+  
+  def self.request_map
+    Bucket.instance.request_map
+  end
+  
+  def self.empty_bucket
+    Bucket.instance.empty_bucket
+  end
+end
+  

data/spec/netnoop_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "NetNoop" do
+  before(:each) do
+    NetNoop.empty_bucket
+  end
+  
+  context "upon a GET request" do
+    it "stores the request in the +requests+ array" do
+      perform_net_http_get(example_uri)
+      
+      req = NetNoop.requests.first
+      req.uri.should == example_uri
+      req.method.should == :get
+    end
+
+    it "stores the request in the +request_map+ hash" do
+      perform_net_http_get(example_uri)
+      
+      req = NetNoop.request_map[example_uri].first
+      req.uri.should == example_uri
+      req.method.should == :get
+    end
+  end
+  
+  context "upon a POST request" do
+    it "stores the request in the +requests+ array and the body is accessible" do
+      body = "I am the request body"
+      perform_net_http_post(example_uri, body)
+      NetNoop.requests.first.body.should == body
+    end
+  end
+  
+  
+  def perform_net_http_get(uri)
+    url = URI.parse(uri)
+    req = Net::HTTP::Get.new(url.path)
+    res = Net::HTTP.start(url.host, url.port) {|http|
+      http.request(req)
+    }
+  end
+
+  def perform_net_http_post(uri, body)
+    url = URI.parse(uri)
+    req = Net::HTTP::Post.new(url.path)
+    res = Net::HTTP.start(url.host, url.port) {|http|
+      http.request(req, body)
+    }
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'netnoop'
+require 'spec'
+require 'spec/autorun'
+
+def example_uri
+  "http://www.example.com/"
+end
+
+# FakeWeb setup
+FakeWeb.allow_net_connect = false
+FakeWeb.register_uri(:any, example_uri, :body => "Hello World")
+  
+Spec::Runner.configure do |config|
+end
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: netnoop
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Klett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-11 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id002
+description: |-
+  Collects and stores your outgoing HTTP requests in NetNoop.requests for later inspection, usually in your test assertions or matchers.
+  
+  Can be used in conjunction with FakeWeb to disable outbound HTTP requests while also making the contents of those requests visible.
+email: michael@webadvocate.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- examples/basic.rb
+- lib/netnoop.rb
+- lib/netnoop/bucket.rb
+- lib/netnoop/hooks.rb
+- lib/netnoop/request.rb
+- spec/netnoop_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/moklett/netnoop
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Collects and stores your outgoing HTTP requests for later inspection
+test_files: 
+- spec/netnoop_spec.rb
+- spec/spec_helper.rb
+- examples/basic.rb