RubyGems - webmock - Versions diffs - 0.8.2 → 0.9.0 - Mend

webmock 0.8.2 → 0.9.0

Files changed (29) hide show

data/CHANGELOG.md +113 -0
data/README.md +84 -18
data/VERSION +1 -1
data/lib/webmock.rb +1 -0
data/lib/webmock/adapters/rspec/webmock_matcher.rb +2 -2
data/lib/webmock/http_lib_adapters/net_http.rb +11 -13
data/lib/webmock/request.rb +1 -1
data/lib/webmock/request_profile.rb +11 -2
data/lib/webmock/request_signature.rb +8 -2
data/lib/webmock/request_stub.rb +39 -11
data/lib/webmock/response.rb +32 -1
data/lib/webmock/responses_sequence.rb +40 -0
data/lib/webmock/util/headers.rb +1 -1
data/lib/webmock/webmock.rb +4 -4
data/spec/example_curl_output.txt +20 -0
data/spec/httpclient_spec_helper.rb +4 -0
data/spec/net_http_spec.rb +8 -0
data/spec/net_http_spec_helper.rb +10 -1
data/spec/request_profile_spec.rb +5 -0
data/spec/request_registry_spec.rb +4 -4
data/spec/request_signature_spec.rb +35 -0
data/spec/request_stub_spec.rb +123 -0
data/spec/response_spec.rb +72 -7
data/spec/spec_helper.rb +27 -0
data/spec/webmock_spec.rb +674 -330
data/test/test_webmock.rb +2 -1
data/webmock.gemspec +5 -3
metadata +5 -3
data/CHANGELOG +0 -36

@@ -1,9 +1,19 @@
+#compatibility with Ruby 1.9.2 preview1 to allow reading raw responses
+class StringIO
+  alias_method :read_nonblock, :sysread
+end
 module WebMock
   class Response
     attr_reader :options
     def initialize(options = {})
-      self.options = options
+      if options.is_a?(IO) || options.is_a?(String)
+          self.options = read_raw_response(options)
+        else
+          self.options = options
+      end
       @options[:headers] = Util::Headers.normalize_headers(@options[:headers]) unless @options[:headers].is_a?(Proc)
     end
@@ -39,6 +49,8 @@ module WebMock
     def ==(other)
       options == other.options
     end
+    private
     def stringify_body!
       if @options[:body].is_a?(IO)
@@ -47,6 +59,25 @@ module WebMock
         io.close
       end
     end
+    def read_raw_response(raw_response)
+      if raw_response.is_a?(IO)
+        string = raw_response.read
+        raw_response.close
+        raw_response = string
+      end
+      socket = Net::BufferedIO.new(raw_response)
+      response = Net::HTTPResponse.read_new(socket)
+      transfer_encoding = response.delete('transfer-encoding') #chunks were already read by curl
+      response.reading_body(socket, true) {}
+      options = {}
+      options[:headers] = {}
+      response.each_header {|name, value| options[:headers][name] = value}
+      options[:headers]['transfer-encoding'] = transfer_encoding if transfer_encoding
+      options[:body] = response.read_body
+      options
+    end
   end
 end

data/lib/webmock/responses_sequence.rb ADDED

@@ -0,0 +1,40 @@
+module WebMock
+  class ResponsesSequence
+    attr_accessor :times_to_repeat
+    def initialize(responses)
+      @times_to_repeat = 1
+      @responses = responses
+      @current_position = 0
+    end
+    def end?
+      @times_to_repeat == 0
+    end
+    def next_response
+      if @times_to_repeat > 0
+        response = @responses[@current_position]
+        increase_position
+        response
+      else
+        @responses.last
+      end
+    end
+    private
+    def increase_position
+      if @current_position == (@responses.length - 1)
+        @current_position = 0
+        @times_to_repeat -= 1
+      else
+        @current_position += 1
+      end
+    end
+  end
+end

data/lib/webmock/util/headers.rb CHANGED

@@ -7,7 +7,7 @@ module WebMock
       def self.normalize_headers(headers)
         return nil unless headers
         array = headers.map { |name, value|
-          [name.to_s.split(/_|-/).map { |segment| segment.capitalize }.join("-"), value.to_s]
+          [name.to_s.split(/_|-/).map { |segment| segment.capitalize }.join("-"), value.is_a?(Regexp) ? value : value.to_s]
         }
         Hash[*array.flatten]
       end

data/lib/webmock/webmock.rb CHANGED

@@ -11,15 +11,15 @@ module WebMock
     RequestProfile.new(method, uri)
   end
-  def assert_requested(method, uri, options = {})
+  def assert_requested(method, uri, options = {}, &block)
     expected_times_executed = options.delete(:times) || 1
-    request = RequestProfile.new(method, uri, options)
+    request = RequestProfile.new(method, uri, options).with(&block)
     verifier = RequestExecutionVerifier.new(request, expected_times_executed)
     assertion_failure(verifier.failure_message) unless verifier.matches?
   end
-  def assert_not_requested(method, uri, options = {})
-    request = RequestProfile.new(method, uri, options)
+  def assert_not_requested(method, uri, options = {}, &block)
+    request = RequestProfile.new(method, uri, options).with(&block)
     verifier = RequestExecutionVerifier.new(request, options.delete(:times))
     assertion_failure(verifier.negative_failure_message) unless verifier.does_not_match?
   end

data/spec/example_curl_output.txt ADDED

@@ -0,0 +1,20 @@
+HTTP/1.1 200 OK
+Content-Type: text/html; charset=UTF-8
+Connection: Keep-Alive
+Date: Sat, 23 Jan 2010 01:01:05 GMT
+Content-Length: 438
+<HTML>
+<HEAD>
+  <TITLE>Example Web Page</TITLE>
+</HEAD>
+<body>
+<p>You have reached this web page by typing &quot;example.com&quot;,
+&quot;example.net&quot;,
+  or &quot;example.org&quot; into your web browser.</p>
+<p>These domain names are reserved for use in documentation and are not available
+  for registration. See <a href="http://www.rfc-editor.org/rfc/rfc2606.txt">RFC
+  2606</a>, Section 3.</p>
+</BODY>
+</HTML>

data/spec/httpclient_spec_helper.rb CHANGED

@@ -23,6 +23,10 @@ module HTTPClientSpecHelper
       :status => response.code.to_s })
   end
+  def default_client_request_headers(request_method = nil, has_body = false)
+    {'Content-Type'=>'application/x-www-form-urlencoded'} if request_method == 'POST' && has_body
+  end
   def setup_expectations_for_real_request(options = {})
     socket = mock("TCPSocket")
     TCPSocket.should_receive(:new).

data/spec/net_http_spec.rb CHANGED

@@ -29,6 +29,13 @@ describe "Webmock with Net:HTTP" do
     req.body = "my_params"
     Net::HTTP.start("www.example.com") { |http| http.request(req)}.body.should == "abc"
   end
+  it "should handle Net::HTTP::Post#body_stream" do
+    stub_http_request(:post, "www.example.com").with(:body => "my_params").to_return(:body => "abc")
+    req = Net::HTTP::Post.new("/")
+    req.body_stream = StringIO.new("my_params")
+    Net::HTTP.start("www.example.com") { |http| http.request(req)}.body.should == "abc"
+  end
   it "should behave like Net::HTTP and raise error if both request body and body argument are set" do
     stub_http_request(:post, "www.example.com").with(:body => "my_params").to_return(:body => "abc")
@@ -39,4 +46,5 @@ describe "Webmock with Net:HTTP" do
     }.should raise_error("both of body argument and HTTPRequest#body set")
   end
 end

data/spec/net_http_spec_helper.rb CHANGED

@@ -16,11 +16,20 @@ module NetHTTPSpecHelper
     response = http.start {|http|
       http.request(req, options[:body], &block)
     }
+    headers = {}
+    response.each_header {|name, value| headers[name] = value}
     OpenStruct.new({
       :body => response.body,
-      :headers => response,
+      :headers => WebMock::Util::Headers.normalize_headers(headers),
       :status => response.code })
   end
+  def default_client_request_headers(request_method = nil, has_body = false)
+    default_request = Net::HTTPGenericRequest.new('','','','/')
+    default_net_http_headers = Hash[*default_request.to_hash.map {|k,v|
+      [k, v.flatten]
+    }.flatten]
+  end
   # Sets several expectations that a real HTTP request makes it
   # past WebMock to the socket layer. You can use this when you need to check

data/spec/request_profile_spec.rb CHANGED

@@ -35,6 +35,11 @@ describe RequestProfile do
     "GET http://www.example.com/ with body 'abc' with headers {'A'=>'a', 'B'=>'b'}"
   end
+  it "should report string describing itself with block" do
+    RequestProfile.new(:get, "www.example.com",
+      :body => "abc", :headers => {'A' => 'a', 'B' => 'b'}).with {|req| true}.to_s.should ==
+    "GET http://www.example.com/ with body 'abc' with headers {'A'=>'a', 'B'=>'b'} with given block"
+  end
   describe "with" do
     before(:each) do

data/spec/request_registry_spec.rb CHANGED

@@ -50,7 +50,7 @@ describe RequestRegistry do
   describe "response for request" do
     it "should registered response for request profile" do
-      @request_stub.response = @response = Response.new
+      @request_stub.instance_variable_set(:@responses, [@response = Response.new])
       RequestRegistry.instance.register_request_stub(@request_stub)
       RequestRegistry.instance.response_for_request(@request_signature).should == @response
     end
@@ -61,11 +61,11 @@ describe RequestRegistry do
     it "should always return last registered matching response" do
       @request_stub1 = RequestStub.new(:get, "www.example.com")
-      @request_stub1.response = @response1 = Response.new
+      @request_stub1.instance_variable_set(:@responses, [@response1 = Response.new])
       @request_stub2 = RequestStub.new(:get, "www.example.com")
-      @request_stub2.response = @response2 = Response.new
+      @request_stub2.instance_variable_set(:@responses, [@response2 = Response.new])
       @request_stub3 = RequestStub.new(:get, "www.example.org")
-      @request_stub3.response = @response3 = Response.new
+      @request_stub3.instance_variable_set(:@responses, [@response3 = Response.new])
       RequestRegistry.instance.register_request_stub(@request_stub1)
       RequestRegistry.instance.register_request_stub(@request_stub2)
       RequestRegistry.instance.register_request_stub(@request_stub3)

data/spec/request_signature_spec.rb CHANGED

@@ -89,11 +89,21 @@ describe RequestSignature do
       RequestSignature.new(:get, "www.example.com", :body => "abc").
         should match(RequestProfile.new(:get, "www.example.com", :body => "abc"))
     end
+    it "should match for body matching regexp" do
+      RequestSignature.new(:get, "www.example.com", :body => "abc").
+        should match(RequestProfile.new(:get, "www.example.com", :body => /^abc$/))
+    end
     it "should not match for different bodies" do
       RequestSignature.new(:get, "www.example.com", :body => "abc").
         should_not match(RequestProfile.new(:get, "www.example.com", :body => "def"))
     end
+    it "should not match for body not matching regexp" do
+      RequestSignature.new(:get, "www.example.com", :body => "xabc").
+        should_not match(RequestProfile.new(:get, "www.example.com", :body => /^abc$/))
+    end
     it "should match if other has not specified body" do
       RequestSignature.new(:get, "www.example.com", :body => "abc").
@@ -119,11 +129,21 @@ describe RequestSignature do
       RequestSignature.new(:get, "www.example.com", :headers => {'Content-Type' => 'image/jpeg'}).
         should match(RequestProfile.new(:get, "www.example.com", :headers => {'Content-Type' => 'image/jpeg'}))
     end
+    it "should match for header values matching regexp" do
+      RequestSignature.new(:get, "www.example.com", :headers => {'Content-Type' => 'image/jpeg'}).
+        should match(RequestProfile.new(:get, "www.example.com", :headers => {'Content-Type' => %r{^image/jpeg$}}))
+    end
     it "should not match for different values of the same header" do
       RequestSignature.new(:get, "www.example.com", :headers => {'Content-Type' => 'image/jpeg'}).
         should_not match(RequestProfile.new(:get, "www.example.com", :headers => {'Content-Type' => 'image/png'}))
     end
+    it "should not match for header values not matching regexp" do
+      RequestSignature.new(:get, "www.example.com", :headers => {'Content-Type' => 'image/jpegx'}).
+        should_not match(RequestProfile.new(:get, "www.example.com", :headers => {'Content-Type' => %r{^image\/jpeg$}}))
+    end
     it "should match if request has more headers than other" do
       RequestSignature.new(:get, "www.example.com", :headers => {'Content-Type' => 'image/jpeg', 'Content-Length' => '8888'}).
@@ -165,6 +185,21 @@ describe RequestSignature do
         should_not match(RequestProfile.new(:get, "www.example.com", :headers => {'A'=>'a'}))
     end
+    it "should match if block given to profile evaluates on request to true" do
+      RequestSignature.new(:get, "www.example.com").
+        should match(RequestProfile.new(:get, "www.example.com").with { |request| true } )
+    end
+    it "should not match if block given to profile evaluates on request to false" do
+      RequestSignature.new(:get, "www.example.com").
+        should_not match( RequestProfile.new(:get, "www.example.com").with { |request| false } )
+    end
+    it "should pass self to the block when matching" do
+      signature = RequestSignature.new(:get, "www.example.com")
+      signature.should match(RequestProfile.new(:get, "www.example.com").with { |request| request == signature } )
+    end
   end
 end

data/spec/request_stub_spec.rb CHANGED

@@ -28,6 +28,11 @@ describe RequestStub do
       @request_stub.request_profile.headers.should == {'B' => 'b'}
     end
+    it "should assign given block to request profile" do
+      @request_stub.with { |req| "block output" }
+      @request_stub.request_profile.with_block.call(nil).should == "block output"
+    end
   end
   describe "to_return" do
@@ -38,6 +43,46 @@ describe RequestStub do
       @request_stub.response.status.should == 500
     end
+    it "should assign responses with provided options" do
+      @request_stub.to_return([{:body => "abc"}, {:body => "def"}])
+      [@request_stub.response.body, @request_stub.response.body].should == ["abc", "def"]
+    end
+  end
+  describe "then" do
+    it "should return stub without any modifications, acting as syntactic sugar" do
+      @request_stub.then.should == @request_stub
+    end
+  end
+  describe "response" do
+    it "should return responses in a sequence passed as array" do
+      @request_stub.to_return([{:body => "abc"}, {:body => "def"}])
+      @request_stub.response.body.should == "abc"
+      @request_stub.response.body.should == "def"
+    end
+    it "should repeat returning last response" do
+      @request_stub.to_return([{:body => "abc"}, {:body => "def"}])
+      @request_stub.response
+      @request_stub.response
+      @request_stub.response.body.should == "def"
+    end
+    it "should return responses in a sequence passed as comma separated params" do
+      @request_stub.to_return({:body => "abc"}, {:body => "def"})
+      @request_stub.response.body.should == "abc"
+      @request_stub.response.body.should == "def"
+    end
+    it "should return responses declared in multiple to_return declarations" do
+      @request_stub.to_return({:body => "abc"}).to_return({:body => "def"})
+      @request_stub.response.body.should == "abc"
+      @request_stub.response.body.should == "def"
+    end
   end
   describe "to_raise" do
@@ -48,7 +93,85 @@ describe RequestStub do
         @request_stub.response.raise_error_if_any
       }.should raise_error(ArgumentError, "Exception from WebMock")
     end
+    it "should assign sequence of responses with response with exception to be thrown" do
+      @request_stub.to_return(:body => "abc").then.to_raise(ArgumentError)
+      @request_stub.response.body.should == "abc"
+      lambda {
+        @request_stub.response.raise_error_if_any
+      }.should raise_error(ArgumentError, "Exception from WebMock")
+    end
+    it "should assign a list responses to be thrown in a sequence" do
+      @request_stub.to_raise(ArgumentError, IndexError)
+      lambda {
+        @request_stub.response.raise_error_if_any
+      }.should raise_error(ArgumentError, "Exception from WebMock")
+      lambda {
+        @request_stub.response.raise_error_if_any
+      }.should raise_error(IndexError, "Exception from WebMock")
+    end
+    it "should raise exceptions declared in multiple to_raise declarations" do
+       @request_stub.to_raise(ArgumentError).then.to_raise(IndexError)
+        lambda {
+          @request_stub.response.raise_error_if_any
+        }.should raise_error(ArgumentError, "Exception from WebMock")
+        lambda {
+          @request_stub.response.raise_error_if_any
+        }.should raise_error(IndexError, "Exception from WebMock")
+    end
+  end
+  describe "times" do
+    it "should give error if declared before any response declaration is declared" do
+      lambda {
+        @request_stub.times(3)
+       }.should raise_error("Invalid WebMock stub declaration. times(N) can be declared only after response declaration.")
+    end
+    it "should repeat returning last declared response declared number of times" do
+      @request_stub.to_return({:body => "abc"}).times(2).then.to_return({:body => "def"})
+      @request_stub.response.body.should == "abc"
+      @request_stub.response.body.should == "abc"
+      @request_stub.response.body.should == "def"
+    end
+    it "should repeat raising last declared exception declared number of times" do
+      @request_stub.to_return({:body => "abc"}).times(2).then.to_return({:body => "def"})
+      @request_stub.response.body.should == "abc"
+      @request_stub.response.body.should == "abc"
+      @request_stub.response.body.should == "def"
+    end
+    it "should repeat returning last declared sequence of responses declared number of times" do
+      @request_stub.to_return({:body => "abc"}, {:body => "def"}).times(2).then.to_return({:body => "ghj"})
+      @request_stub.response.body.should == "abc"
+      @request_stub.response.body.should == "def"
+      @request_stub.response.body.should == "abc"
+      @request_stub.response.body.should == "def"
+      @request_stub.response.body.should == "ghj"
+    end
+    it "should return self" do
+      @request_stub.to_return({:body => "abc"}).times(1).should == @request_stub
+    end
+    it "should raise error if argument is not integer" do
+      lambda {
+         @request_stub.to_return({:body => "abc"}).times("not number")
+      }.should raise_error("times(N) accepts integers >= 1 only")
+    end
+    it "should raise error if argument is < 1" do
+      lambda {
+        @request_stub.to_return({:body => "abc"}).times(0)
+      }.should raise_error("times(N) accepts integers >= 1 only")
+    end
   end
 end