webmock 1.3.5 → 1.4.0

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 #Changelog
 
+## 1.4.0
+
+* Curb support!!! Thanks to the awesome work of Pete Higgins!
+
+* `include WebMock` is now deprecated to avoid method and constant name conflicts. Please `include WebMock::API` instead.
+
+* `WebMock::API#request` is renamed to `WebMock::API#a_request` to prevent method name conflicts with i.e. Rails controller specs. 
+  WebMock.request is still available.
+
+* Deprecated `WebMock#request`, `WebMock#allow_net_connect!`, `WebMock#net_connect_allowed?`, `WebMock#registered_request?`, `WebMock#reset_callbacks`, `WebMock#after_request` instance methods. These methods are still available, but only as WebMock class methods.
+
+* Removed `WebMock.response_for_request` and `WebMock.assertion_failure` which were only used internally and were not documented.
+
+* :allow_localhost => true' now permits 0.0.0.0 in addition to 127.0.0.1 and 'localhost'. Thanks to Myron Marston and Mike Gehard for suggesting this.
+
+* Fixed issue with both RSpec 1.x and 2.x being available.
+
+  WebMock now tries to use already loaded version of RSpec (1.x or 2.x). Previously it was loading RSpec 2.0 if available, even if RSpec 1.3 was already loaded.
+
+  Thanks to Hans de Graaff for reporting this.
+
+* Changed runtime dependency on Addressable version 2.2.2 which fixes handling of percent-escaped '+'
+
 ## 1.3.5
 
 * External requests can be disabled while allowing selected hosts. Thanks to Charles Li and Ryan Bigg

data/README.md

@@ -21,6 +21,7 @@ Supported HTTP libraries
 * HTTPClient
 * Patron
 * EM-HTTP-Request
+* Curb
 
 ##Installation
 
@@ -33,7 +34,7 @@ Add the following code to `test/test_helper.rb`
 	require 'webmock/test_unit'
 	
 	class Test::Unit::TestCase
-	  config.include WebMock
+	  include WebMock::API
 	end
 
 ### RSpec
@@ -43,7 +44,7 @@ Add the following code to `spec/spec_helper`:
 	require 'webmock/rspec'
 
 	Spec::Runner.configure do |config|
-	  config.include WebMock
+	  config.include WebMock::API
 	end
 
 ### RSpec 2
@@ -53,25 +54,20 @@ Add the following code to `spec/spec_helper`:
 	require 'webmock/rspec'
 	
 	RSpec.configure do |config|
-	  config.include WebMock
+	  config.include WebMock::API
 	end
 
 ### Cucumber
 
 Add the following code to `features/support/env.rb`
 
-	require 'webmock/rspec'  
-	module WebMockWorld
-	  include WebMock
-	  include WebMock::Matchers
-	end
-
-	World(WebMockWorld)
+	require 'webmock/rspec'
+	World(WebMock::API, WebMock::Matchers)
 
 You can also use WebMock outside a test framework:
 
 	require 'webmock'
-	include WebMock
+	include WebMock::API
 	include WebMock::Matchers
 
 ## Examples
@@ -357,19 +353,19 @@ You can also use WebMock outside a test framework:
 
 ### Different way of setting expectations in RSpec
 
-	request(:post, "www.example.com").with(:body => "abc", :headers => {'Content-Length' => 3}).should have_been_made.once
+	a_request(:post, "www.example.com").with(:body => "abc", :headers => {'Content-Length' => 3}).should have_been_made.once
 
-	request(:post, "www.something.com").should have_been_made.times(3)
+	a_request(:post, "www.something.com").should have_been_made.times(3)
 
-	request(:any, "www.example.com").should_not have_been_made
+	a_request(:any, "www.example.com").should_not have_been_made
 
-	request(:post, "www.example.com").with { |req| req.body == "abc" }.should have_been_made
-	
-	request(:get, "www.example.com").with(:query => {"a" => ["b", "c"]}).should have_been_made
-	
-	request(:post, "www.example.com").
+	a_request(:post, "www.example.com").with { |req| req.body == "abc" }.should have_been_made
+
+	a_request(:get, "www.example.com").with(:query => {"a" => ["b", "c"]}).should have_been_made
+
+	a_request(:post, "www.example.com").
 	  with(:body => {"a" => ["b", "c"]}, :headers => 'Content-Type' => 'application/json').should have_been_made
-	
+
 ## Clearing stubs and request history
 
 If you want to reset all current stubs and history of requests use `WebMock.reset_webmock`
@@ -535,6 +531,7 @@ People who submitted patches and new features or suggested improvements. Many th
 * Muness Alrubaie
 * Charles Li
 * Ryan Bigg
+* Pete Higgins
 
 ## Background
 

data/Rakefile

@@ -10,12 +10,13 @@ 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_dependency "addressable", ">= 2.2.2"
     gem.add_dependency "crack", ">=0.1.7"
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency "httpclient", ">= 2.1.5.2"
-    gem.add_development_dependency "patron", ">= 0.4.5" unless RUBY_PLATFORM =~ /java/
-    gem.add_development_dependency "em-http-request", ">= 0.2.7" unless RUBY_PLATFORM =~ /java/
+    gem.add_development_dependency "patron", ">= 0.4.9" unless RUBY_PLATFORM =~ /java/
+    gem.add_development_dependency "em-http-request", ">= 0.2.14" unless RUBY_PLATFORM =~ /java/
+    gem.add_development_dependency "curb", ">= 0.7.8" unless RUBY_PLATFORM =~ /java/
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-1.3.5
+1.4.0

data/lib/webmock.rb

@@ -3,9 +3,12 @@ require 'singleton'
 require 'addressable/uri'
 require 'crack'
 
+require 'webmock/deprecation'
+
 require 'webmock/http_lib_adapters/net_http'
 require 'webmock/http_lib_adapters/httpclient'
 require 'webmock/http_lib_adapters/patron'
+require 'webmock/http_lib_adapters/curb'
 require 'webmock/http_lib_adapters/em_http_request'
 
 require 'webmock/errors'
@@ -20,8 +23,10 @@ require 'webmock/responses_sequence'
 require 'webmock/request_stub'
 require 'webmock/response'
 
+require 'webmock/assertion_failure'
 require 'webmock/request_execution_verifier'
 require 'webmock/config'
 require 'webmock/callback_registry'
 require 'webmock/request_registry'
+require 'webmock/api'
 require 'webmock/webmock'

data/lib/webmock/adapters/rspec.rb

@@ -1,13 +1,20 @@
 require 'webmock'
 
 # RSpec 1.x and 2.x compatibility
-begin
-  require 'rspec'
+if defined?(Rspec)
   RSPEC_NAMESPACE = RSPEC_CONFIGURER = Rspec
-rescue LoadError
-  require 'spec'
+elsif defined?(Spec)
   RSPEC_NAMESPACE = Spec
   RSPEC_CONFIGURER = Spec::Runner
+else  
+  begin
+    require 'rspec'
+    RSPEC_NAMESPACE = RSPEC_CONFIGURER = Rspec
+  rescue LoadError
+    require 'spec'
+    RSPEC_NAMESPACE = Spec
+    RSPEC_CONFIGURER = Spec::Runner
+  end
 end
 
 require 'webmock/adapters/rspec/request_pattern_matcher'
@@ -23,8 +30,4 @@ RSPEC_CONFIGURER.configure { |config|
   end
 }
 
-module WebMock
-  def assertion_failure(message)
-    raise RSPEC_NAMESPACE::Expectations::ExpectationNotMetError.new(message)
-  end
-end
+WebMock::AssertionFailure.error_class = RSPEC_NAMESPACE::Expectations::ExpectationNotMetError

data/lib/webmock/adapters/test_unit.rb

@@ -15,10 +15,5 @@ class Test::Unit::TestCase
   end
 end
 
-module WebMock
-  AssertionFailedError = Test::Unit::AssertionFailedError rescue MiniTest::Assertion # ruby1.9 compat
-  def assertion_failure(message)
-    raise AssertionFailedError.new(message)
-  end
-end
 
+WebMock::AssertionFailure.error_class = Test::Unit::AssertionFailedError rescue MiniTest::Assertion # ruby1.9 compat

data/lib/webmock/api.rb

@@ -0,0 +1,32 @@
+module WebMock
+  module API
+    extend self
+    
+    def stub_request(method, uri)
+      WebMock::RequestRegistry.instance.register_request_stub(WebMock::RequestStub.new(method, uri))
+    end
+
+    alias_method :stub_http_request, :stub_request
+
+    def a_request(method, uri)
+      WebMock::RequestPattern.new(method, uri)
+    end
+    
+    class << self
+      alias :request :a_request
+    end
+
+    def assert_requested(method, uri, options = {}, &block)
+      expected_times_executed = options.delete(:times) || 1
+      request = WebMock::RequestPattern.new(method, uri, options).with(&block)
+      verifier = WebMock::RequestExecutionVerifier.new(request, expected_times_executed)
+      WebMock::AssertionFailure.failure(verifier.failure_message) unless verifier.matches?
+    end
+
+    def assert_not_requested(method, uri, options = {}, &block)
+      request = WebMock::RequestPattern.new(method, uri, options).with(&block)
+      verifier = WebMock::RequestExecutionVerifier.new(request, options.delete(:times))
+      WebMock::AssertionFailure.failure(verifier.negative_failure_message) unless verifier.does_not_match?
+    end
+  end
+end

data/lib/webmock/assertion_failure.rb

@@ -0,0 +1,13 @@
+module WebMock
+  class AssertionFailure
+    class << self
+      attr_writer :error_class
+      @error_class = RuntimeError
+    
+      def failure(message)
+        raise @error_class.new(message)
+      end
+    
+    end
+  end
+end

data/lib/webmock/deprecation.rb

@@ -0,0 +1,9 @@
+module WebMock
+  class Deprecation
+    class << self
+      def warning(message)
+        warn "WebMock deprecation warning: #{message}"
+      end
+    end
+  end
+end

data/lib/webmock/http_lib_adapters/curb.rb

@@ -0,0 +1,260 @@
+if defined?(Curl)
+
+  module Curl
+    class Easy
+      def curb_or_webmock
+        request_signature = build_request_signature
+        WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
+
+        if WebMock::RequestRegistry.instance.registered_request?(request_signature)
+          webmock_response = WebMock::RequestRegistry.instance.response_for_request(request_signature)
+          build_curb_response(webmock_response)
+          WebMock::CallbackRegistry.invoke_callbacks(
+            {:lib => :curb}, request_signature, webmock_response)
+          invoke_curb_callbacks
+          true
+        elsif WebMock.net_connect_allowed?(request_signature.uri)
+          res = yield
+          if WebMock::CallbackRegistry.any_callbacks?
+            webmock_response = build_webmock_response
+            WebMock::CallbackRegistry.invoke_callbacks(
+              {:lib => :curb, :real_request => true}, request_signature,
+                webmock_response)   
+          end
+          res
+        else
+          raise WebMock::NetConnectNotAllowedError.new(request_signature)
+        end
+      end
+
+      def build_request_signature
+        method = @webmock_method.to_s.downcase.to_sym
+
+        uri = WebMock::Util::URI.heuristic_parse(self.url)
+        uri.path = uri.normalized_path.gsub("[^:]//","/")
+        uri.user = self.username
+        uri.password = self.password
+
+        request_body = case method
+        when :post
+          self.post_body || @post_body
+        when :put
+          @put_data
+        else
+          nil
+        end
+
+        request_signature = WebMock::RequestSignature.new(
+          method,
+          uri.to_s,
+          :body => request_body,
+          :headers => self.headers
+        )
+        request_signature
+      end
+
+      def build_curb_response(webmock_response)
+        raise Curl::Err::TimeoutError if webmock_response.should_timeout        
+        webmock_response.raise_error_if_any
+        
+        @body_str = webmock_response.body
+        @response_code = webmock_response.status[0]
+
+        @header_str = "HTTP/1.1 #{webmock_response.status[0]} #{webmock_response.status[1]}\r\n"
+        if webmock_response.headers
+          @header_str << webmock_response.headers.map do |k,v| 
+            "#{k}: #{v.is_a?(Array) ? v.join(", ") : v}"
+          end.join("\r\n")
+        end
+      end
+
+      def invoke_curb_callbacks
+        @on_progress.call(0.0,1.0,0.0,1.0) if @on_progress
+        @on_header.call(self.header_str) if @on_header
+        @on_body.call(self.body_str) if @on_body
+        @on_complete.call(self) if @on_complete
+
+        case response_code
+        when 200..299
+          @on_success.call(self) if @on_success
+        when 500..599
+          @on_failure.call(self, self.response_code) if @on_failure
+        end
+      end
+
+      def build_webmock_response
+        status, headers = WebmockHelper.parse_header_string(self.header_str)
+
+        webmock_response = WebMock::Response.new
+        webmock_response.status = [self.response_code, status]
+        webmock_response.body = self.body_str
+        webmock_response.headers = headers
+        webmock_response
+      end
+
+      ###
+      ### Mocks of Curl::Easy methods below here.
+      ### 
+
+      def http_with_webmock(method)
+        @webmock_method = method
+        curb_or_webmock do
+          http_without_webmock(method)
+        end
+      end
+      alias_method :http_without_webmock, :http
+      alias_method :http, :http_with_webmock
+
+      %w[ get head delete ].each do |verb|
+        define_method "http_#{verb}_with_webmock" do
+          @webmock_method = verb
+          curb_or_webmock do
+            send( "http_#{verb}_without_webmock" )
+          end
+        end
+
+        alias_method "http_#{verb}_without_webmock", "http_#{verb}"
+        alias_method "http_#{verb}", "http_#{verb}_with_webmock"
+      end
+
+      def http_put_with_webmock data
+        @webmock_method = :put
+        @put_data = data
+        curb_or_webmock do
+          http_put_without_webmock(data)
+        end
+      end
+      alias_method :http_put_without_webmock, :http_put
+      alias_method :http_put, :http_put_with_webmock
+
+      def http_post_with_webmock data
+        @webmock_method = :post
+        @post_body = data
+        curb_or_webmock do
+          http_post_without_webmock(data)
+        end
+      end
+      alias_method :http_post_without_webmock, :http_post
+      alias_method :http_post, :http_post_with_webmock
+
+
+      def perform_with_webmock
+        @webmock_method ||= :get
+        curb_or_webmock do
+          perform_without_webmock
+        end 
+      end
+      alias :perform_without_webmock :perform
+      alias :perform :perform_with_webmock
+      
+      def put_data_with_webmock= data
+        @webmock_method = :put
+        @put_data = data
+        self.put_data_without_webmock = data
+      end
+      alias_method :put_data_without_webmock=, :put_data=
+      alias_method :put_data=, :put_data_with_webmock=
+      
+      def post_body_with_webmock= data
+        @webmock_method = :post
+        self.post_body_without_webmock = data
+      end
+      alias_method :post_body_without_webmock=, :post_body=
+      alias_method :post_body=, :post_body_with_webmock=
+
+      def delete_with_webmock= value
+        @webmock_method = :delete if value
+        self.delete_without_webmock = value
+      end
+      alias_method :delete_without_webmock=, :delete=
+      alias_method :delete=, :delete_with_webmock=
+
+      def head_with_webmock= value
+        @webmock_method = :head if value
+        self.head_without_webmock = value
+      end
+      alias_method :head_without_webmock=, :head=
+      alias_method :head=, :head_with_webmock=
+
+      def body_str_with_webmock
+        @body_str || body_str_without_webmock
+      end
+      alias :body_str_without_webmock :body_str
+      alias :body_str :body_str_with_webmock
+
+      def response_code_with_webmock
+        @response_code || response_code_without_webmock
+      end
+      alias :response_code_without_webmock :response_code
+      alias :response_code :response_code_with_webmock
+
+      def header_str_with_webmock
+        @header_str || header_str_without_webmock
+      end
+      alias :header_str_without_webmock :header_str
+      alias :header_str :header_str_with_webmock
+
+      %w[ success failure header body complete progress ].each do |callback|
+        class_eval <<-METHOD, __FILE__, __LINE__
+          def on_#{callback}_with_webmock &block
+            @on_#{callback} = block
+            on_#{callback}_without_webmock &block
+          end
+        METHOD
+        alias_method "on_#{callback}_without_webmock", "on_#{callback}"
+        alias_method "on_#{callback}", "on_#{callback}_with_webmock"
+      end
+
+      %w[ http_get http_head http_delete perform ].each do |method|
+        class_eval <<-METHOD, __FILE__, __LINE__
+          def self.#{method}(url, &block)
+            c = new
+            c.url = url
+            block.call(c) if block
+            c.send("#{method}")
+            c
+          end
+        METHOD
+      end
+
+      %w[ put post ].each do |verb|
+        class_eval <<-METHOD, __FILE__, __LINE__
+          def self.http_#{verb}(url, data, &block)
+            c = new
+            c.url = url
+            block.call(c) if block
+            c.send("http_#{verb}", data)
+            c
+          end
+        METHOD
+      end
+  
+      module WebmockHelper
+        # Borrowed from Patron:
+        # http://github.com/toland/patron/blob/master/lib/patron/response.rb
+        def self.parse_header_string(header_string)
+          status, headers = nil, {}
+
+          header_string.split(/\r\n/).each do |header|
+            if header =~ %r|^HTTP/1.[01] \d\d\d (.*)|
+              status = $1
+            else
+              parts = header.split(':', 2)
+              unless parts.empty?
+                parts[1].strip! unless parts[1].nil?
+                if headers.has_key?(parts[0])
+                  headers[parts[0]] = [headers[parts[0]]] unless headers[parts[0]].kind_of? Array
+                  headers[parts[0]] << parts[1]
+                else
+                  headers[parts[0]] = parts[1]
+                end
+              end
+            end
+          end
+
+          return status, headers
+        end
+      end
+    end
+  end
+end