webmock 0.7.1 → 0.7.2

data/CHANGELOG

@@ -0,0 +1,9 @@
+== 0.7.3
+
+  * Clarified documentation
+  * Fixed some issues with loading of Webmock classes
+  * Test::Unit and RSpec adapters have to be required separately
+
+== 0.7.2
+
+  * Added support for matching escaped and non escaped URLs

data/README.md

@@ -1,82 +1,100 @@
 WebMock
 =======
 
-Library for stubbing HTTP requests in Ruby.
+Library for stubbing HTTP requests and setting expectations on HTTP requests in Ruby.
 
 Features
 --------
 
-* Stubbing requests and setting requests expectations
-* Matching requests based on method, url, headers and body
+* Stubbing HTTP requests at low Net::HTTP level (no need to change tests when you change HTTP lib interface)
+* Setting and verifying expectations on HTTP requests
+* Matching requests based on method, URI, headers and body
+* Smart matching of the same URIs in different representations (also encoded and non encoded forms)
+* Smart matching of the same headers in different representations.
 * Support for Test::Unit and RSpec (and can be easily extended to other frameworks)
-* Support for Net::Http and other http libraries based on Net::Http
-* Adding other http library adapters is easy
-
+* Support for Net::HTTP and other http libraries based on Net::HTTP (i.e RightHttpConnection, rest-client, HTTParty)
+* Easy to extend to other HTTP libraries except Net::HTTP
 
 Installation
 ------------
 
     gem install webmock --source http://gemcutter.org
 
-In your `test/test_helper.rb` or `spec/spec_helper.rb` include the following lines
+In your `test/test_helper.rb` add these two lines:
 
-    require 'webmock'
+    require 'webmock/test_unit'
 	
 	include WebMock
 
-Now you are ready to write your tests/specs with stubbed HTTP calls. 
+or if you use RSpec add these lines to `spec/spec_helper`:
+
+	require 'webmock/rspec'
+
+	include WebMock
+
+You can also use WebMock without RSpec or Test::Unit support:
+
+	require 'webmock'
+
+	include WebMock
 
 ## Examples
 
-### Stubbed request based on url only and with the default response
+
+
+## Stubbing
+
+
+### Stubbed request based on uri only and with the default response
 
 	 stub_request(:any, "www.google.com")
 
-	 Net::HTTP.get('www.google.com', '/')    # ===> Success
-	
-### Stubbing requests based on method, url, body and headers
+	 Net::HTTP.get("www.google.com", "/")    # ===> Success
+
+### Stubbing requests based on method, uri, body and headers
 
 	stub_request(:post, "www.google.com").with(:body => "abc", :headers => { 'Content-Length' => 3 })
 
-	url = URI.parse('http://www.google.com/')
-    req = Net::HTTP::Post.new(url.path)
+	uri = URI.parse("http://www.google.com/")
+    req = Net::HTTP::Post.new(uri.path)
 	req['Content-Length'] = 3
-    res = Net::HTTP.start(url.host, url.port) {|http|
-      http.request(req, 'abc')
+    res = Net::HTTP.start(uri.host, uri.port) {|http|
+      http.request(req, "abc")
     }    # ===> Success
 
 ### Matching custom request headers
 
-    stub_request(:any, "www.google.com").with(:headers=>{'Header-Name'=>"Header-Value"}).to_return(:body => "abc", :status => 200)
+    stub_request(:any, "www.google.com").
+	  with( :headers=>{ 'Header-Name' => 'Header-Value' } ).to_return(:body => "abc", :status => 200)
 
-	url = URI.parse('http://www.google.com/')
-    req = Net::HTTP::Post.new(url.path)
-	req['Header-Name'] = "Header-Value"
-    res = Net::HTTP.start(url.host, url.port) {|http|
+	uri = URI.parse('http://www.google.com/')
+    req = Net::HTTP::Post.new(uri.path)
+	req['Header-Name'] = 'Header-Value'
+    res = Net::HTTP.start(uri.host, uri.port) {|http|
       http.request(req, 'abc')
     }    # ===> Success
 
-### Custom response
+### Stubbing with custom response
 
-	stub_request(:any, "www.google.com").to_return(:body => "abc", :status => 200,  :headers => { 'Content-Length' => 3 })
+	stub_request(:any, "www.google.com").to_return(:body => "abc", :status => 200,  :headers => { 'Content-Length' => 3 } )
 	
-	Net::HTTP.get('www.google.com', '/')    # ===> "abc"
-	
-### Custom response with body as file path
+	Net::HTTP.get("www.google.com", '/')    # ===> "abc"
+
+### Custom response with body specified as a path to file
 
 	File.open('/tmp/response_body.txt', 'w') { |f| f.puts 'abc' }
 
 	stub_request(:any, "www.google.com").to_return(:body => "/tmp/response_body.txt", :status => 200)
 
 	Net::HTTP.get('www.google.com', '/')    # ===> "abc\n"
-	
+
 ### Request with basic authentication
 
 	stub_request(:any, "john:smith@www.google.com")
 	
 	Net::HTTP.get(URI.parse('http://john:smith@www.google.com'))    # ===> Success
-	
-### Matching urls using regular expressions
+
+### Matching uris using regular expressions
 
 	 stub_request(:any, /.*google.*/)
 
@@ -96,29 +114,23 @@ Now you are ready to write your tests/specs with stubbed HTTP calls.
 	
 	Net::HTTP.get('www.something.com', '/')    # ===> Failure
 
-### Clearing stubs
-
-	stub_request(:any, "www.google.com")
-
-	Net::HTTP.get('www.google.com', '/')    # ===> Success
-	
-	reset_webmock
-	
-	Net::HTTP.get('www.google.com', '/')    # ===> Failure
 
+## Setting Expectations
 
-### Test/Unit style assertions (they actually work everywhere, in RSpec too)
+### Setting expectations in Test::Unit
+	require 'webmock/test_unit'
 
     stub_request(:any, "www.google.com")
 
-	url = URI.parse('http://www.google.com/')
-    req = Net::HTTP::Post.new(url.path)
+	uri = URI.parse('http://www.google.com/')
+    req = Net::HTTP::Post.new(uri.path)
 	req['Content-Length'] = 3
-    res = Net::HTTP.start(url.host, url.port) {|http|
+    res = Net::HTTP.start(uri.host, uri.port) {|http|
       http.request(req, 'abc')
     }
 
-	assert_requested :post, "http://www.google.com", :headers => {'Content-Length' => 3}, :body => "abc", :times => 1    # ===> Success
+	assert_requested :post, "http://www.google.com",
+	  :headers => {'Content-Length' => 3}, :body => "abc", :times => 1    # ===> Success
 	
 	assert_not_requested :get, "http://www.something.com"    # ===> Success
 
@@ -130,68 +142,149 @@ Now you are ready to write your tests/specs with stubbed HTTP calls.
 
 	assert_requested :get, "http://www.google.com"    # ===> Success
 
-### RSpec matchers 1
 
-	request(:post, "www.google.com").with(:body => "abc", :headers => {'Content-Length' => 3}).should have_been_made.once
-	
-	request(:post, "www.something.com").should have_been_made.times(3)
-	
-	request(:any, "www.example.com").should_not have_been_made
+### Setting expectations in RSpec
+ This style is borrowed from [fakeweb-matcher](http://github.com/freelancing-god/fakeweb-matcher)
 
-### RSpec matchers 2 ([fakeweb-matcher](http://github.com/freelancing-god/fakeweb-matcher) style)
+	require 'webmock/rspec'
 
 	WebMock.should have_requested(:get, "www.google.com").with(:body => "abc", :headers => {'Content-Length' => 3}).twice
 	
 	WebMock.should_not have_requested(:get, "www.something.com")
 
-Notes
------
+### Different way of setting expectations in RSpec
 
-### Matching requests
+	request(:post, "www.google.com").with(:body => "abc", :headers => {'Content-Length' => 3}).should have_been_made.once
+
+	request(:post, "www.something.com").should have_been_made.times(3)
 
-Here are the criteria of matching requests:
+	request(:any, "www.example.com").should_not have_been_made
 
-* request url matches stubbed request url pattern
-* and request method is the same as stubbed request method or stubbed request method is :any
-* and request body is the same as stubbed request body or stubbed request body is not set (is nil)
-* and request headers are the same as stubbed request headers or stubbed request headers are a subset of request headers or stubbed request headers are not set
 
-### Precedence of stubs
+## Clearing stubs and request history
 
-Always the last declared stub matching the request will be applied. 
-i.e
+If you want to reset all current stubs and history of requests use `WebMock.reset_webmock`
+
+	stub_request(:any, "www.google.com")
+
+	Net::HTTP.get('www.google.com', '/')    # ===> Success
+
+	reset_webmock
+
+	Net::HTTP.get('www.google.com', '/')    # ===> Failure
+
+	assert_not_requested :get, "www.google.com"    # ===> Success
+
+
+## Matching requests
+
+An executed request matches stubbed request if it passes following criteria:
+
+  Request URI matches stubbed request URI string or Regexp pattern<br/>
+  And request method is the same as stubbed request method or stubbed request method is :any<br/>
+  And request body is the same as stubbed request body or stubbed request body is not set (is nil)<br/>
+  And request headers match stubbed request headers, or stubbed request headers match a subset of request headers, or stubbed request headers are not set
+
+## Precedence of stubs
+
+Always the last declared stub matching the request will be applied i.e:
 
 	stub_request(:get, "www.google.com").to_return(:body => "abc")
 	stub_request(:get, "www.google.com").to_return(:body => "def")
 
 	Net::HTTP.get('www.google.com', '/')   # ====> "def"
 
-Bugs and Issues
----------------
+## Matching URIs
+
+WebMock will match all different representations of the same URI. 
+
+I.e all the following representations of the URI are equal:
+
+    "www.google.com"
+    "www.google.com/"
+    "www.google.com:80"
+    "www.google.com:80/"
+    "http://www.google.com"
+    "http://www.google.com/"
+    "http://www.google.com:80"
+    "http://www.google.com:80/"
+	
+The following URIs with basic authentication are also equal for WebMock
+
+	"a b:pass@www.google.com"
+	"a b:pass@www.google.com/"
+	"a b:pass@www.google.com:80"
+	"a b:pass@www.google.com:80/"
+	"http://a b:pass@www.google.com"
+	"http://a b:pass@www.google.com/"
+	"http://a b:pass@www.google.com:80"
+	"http://a b:pass@www.google.com:80/"
+	"a%20b:pass@www.google.com"
+	"a%20b:pass@www.google.com/"
+	"a%20b:pass@www.google.com:80"
+	"a%20b:pass@www.google.com:80/"
+	"http://a%20b:pass@www.google.com"
+	"http://a%20b:pass@www.google.com/"
+	"http://a%20b:pass@www.google.com:80"
+	"http://a%20b:pass@www.google.com:80/"	
+
+or these
+
+	"www.google.com/big image.jpg/?a=big image&b=c"
+	"www.google.com/big%20image.jpg/?a=big%20image&b=c"
+	"www.google.com:80/big image.jpg/?a=big image&b=c"
+	"www.google.com:80/big%20image.jpg/?a=big%20image&b=c"
+	"http://www.google.com/big image.jpg/?a=big image&b=c"
+	"http://www.google.com/big%20image.jpg/?a=big%20image&b=c"
+	"http://www.google.com:80/big image.jpg/?a=big image&b=c"
+	"http://www.google.com:80/big%20image.jpg/?a=big%20image&b=c"
+
+
+If you provide Regexp to match URI, WebMock will try to match it against every valid form of the same url.
+
+I.e `/.*big image.*/` will match `www.google.com/big%20image.jpg` because it is equivalent of `www.google.com/big image.jpg`
+
+
+## Matching headers
+
+WebMock will match request headers against stubbed request headers in the following situations:
+
+1. Stubbed request has headers specified and request headers are the same as stubbed headers <br/>
+i.e stubbed headers: `{ 'Header1' => 'Value1', 'Header1' => 'Value1' }`, requested: `{ 'Header1' => 'Value1', 'Header1' => 'Value1' }`
+
+2. Stubbed request has headers specified and stubbed request headers are a subset of request headers <br/>
+i.e stubbed headers: `{ 'Header1' => 'Value1'  }`, requested: `{ 'Header1' => 'Value1', 'Header1' => 'Value1' }`
+
+3. Stubbed request has no headers <br/>
+i.e stubbed headers: `nil`, requested: `{ 'Header1' => 'Value1', 'Header1' => 'Value1' }`
+
+WebMock normalises headers and treats all forms of same headers as equal:
+i.e the following two sets of headers are equal:
+
+`{ "Header1" => "value1", :content_length => 123, :X_CuStOm_hEAder => :value }`
+
+`{ :header1 => "value1",  "Content-Length" => 123, "x-cuSTOM-HeAder" => "value" }`
+
+
+## Bugs and Issues
 
 Please submit them here [http://github.com/bblimke/webmock/issues](http://github.com/bblimke/webmock/issues)
 
-Suggestions
-------------
+## Suggestions
 
 If you have any suggestions on how to improve WebMock please send an email to the mailing list [groups.google.com/group/webmock-users](http://groups.google.com/group/webmock-users)
 
 I'm particularly interested in how the DSL could be improved.
 
-Todo
-----
-
-* Add EventMachine::Protocols::HttpClient adapter
+## Credits
 
-Credits
--------
+Thanks to my fellow [Bambinos](http://new-bamboo.co.uk/) for all the great suggestions!
 
-Thank you Fakeweb! This library is based on the idea taken from [FakeWeb](fakeweb.rubyforge.org).
-I took couple of solutions from that project. I also copied some code i.e Net:Http adapter or url normalisation function. 
+Thank you Fakeweb! This library was inspired by [FakeWeb](fakeweb.rubyforge.org).
+I took couple of solutions from that project. I also copied some code i.e Net:HTTP adapter. 
 Fakeweb architecture unfortunately didn't allow me to extend it easily with the features I needed.
 I also preferred some things to work differently i.e request stub precedence.
 
-Copyright
----------
+## Copyright
 
 Copyright 2009 Bartosz Blimke. See LICENSE for details.

data/Rakefile

@@ -10,6 +10,7 @@ begin
     gem.email = "bartosz.blimke@gmail.com"
     gem.homepage = "http://github.com/bblimke/webmock"
     gem.authors = ["Bartosz Blimke"]
+    gem.add_dependency "addressable", ">= 2.1.1"
     gem.add_development_dependency "rspec", ">= 1.2.9"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
@@ -34,7 +35,7 @@ require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.test_files = FileList["test/**/*.rb"].exclude("test/test_helper.rb")
   test.verbose = false
-  test.warning = true
+  test.warning = false
 end
 
 task :spec => :check_dependencies

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.7.2

data/lib/webmock.rb

@@ -1,18 +1,21 @@
 require 'singleton'
 
+require 'addressable/uri'
+
 require 'webmock/http_lib_adapters/net_http'
 
 require 'webmock/errors'
+
+require 'webmock/util/uri'
+require 'webmock/util/headers'
+require 'webmock/util/hash_counter'
+
 require 'webmock/request_profile'
-require 'webmock/request_execution_verifier'
-require 'webmock/url'
+require 'webmock/request_signature'
 require 'webmock/request_stub'
-require 'webmock/utility'
-require 'webmock/config'
 require 'webmock/response'
-require 'webmock/util/hash_counter'
-require 'webmock/request_registry'
-require 'webmock/webmock'
 
-require 'webmock/adapters/rspec'
-require 'webmock/adapters/test_unit'
+require 'webmock/request_execution_verifier'
+require 'webmock/config'
+require 'webmock/request_registry'
+require 'webmock/webmock'

data/lib/webmock/adapters/rspec.rb

@@ -1,23 +1,21 @@
-if defined?(Spec::Runner) 
-  
-  require 'webmock/adapters/rspec/request_profile_matcher'
-  require 'webmock/adapters/rspec/webmock_matcher'
-  require 'webmock/adapters/rspec/matchers'
-  
-  Spec::Runner.configure { |config|
-  
-    config.include WebMock::Matchers
-  
-    config.before :each do
-      WebMock.reset_webmock
-    end
-  }
-  
-  module WebMock
-    private
-    def assertion_failure(message)
-      raise Spec::Expectations::ExpectationNotMetError.new(message)
-    end
+require 'webmock'
+require 'spec'
+require 'webmock/adapters/rspec/request_profile_matcher'
+require 'webmock/adapters/rspec/webmock_matcher'
+require 'webmock/adapters/rspec/matchers'
+
+Spec::Runner.configure { |config|
+
+  config.include WebMock::Matchers
+
+  config.before :each do
+    WebMock.reset_webmock
   end
-  
-end
+}
+
+module WebMock
+  private
+  def assertion_failure(message)
+    raise Spec::Expectations::ExpectationNotMetError.new(message)
+  end
+end