webmock 1.20.1 → 1.20.2

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.20.2
+
+  * WebMock provides a helpful error message if an incompatible object is given as response body.
+
+      Thanks to [Mark Lorenz](https://github.com/dapplebeforedawn)
+
 ## 1.20.1
 
   * `assert_requested` and `assert_not_requested` accept `at_least_times` and `at_most_times` options

data/README.md

@@ -35,6 +35,7 @@ Supported Ruby Interpreters
 * MRI 1.9.2
 * MRI 1.9.3
 * MRI 2.0.0
+* MRI 2.1
 * REE 1.8.7
 * JRuby
 * Rubinius
@@ -931,6 +932,7 @@ People who submitted patches and new features or suggested improvements. Many th
 * Tasos Stathopoulos
 * Dan Buettner
 * Sven Riedel
+* Mark Lorenz
 
 For a full list of contributors you can visit the
 [contributors](https://github.com/bblimke/webmock/contributors) page.

data/lib/webmock/response.rb

@@ -43,6 +43,7 @@ module WebMock
 
     def body=(body)
       @body = body
+      assert_valid_body!
       stringify_body!
     end
 
@@ -109,6 +110,13 @@ module WebMock
       end
     end
 
+    def assert_valid_body!
+      valid_types = [Proc, IO, Pathname, String, Array]
+      return if @body.nil?
+      return if valid_types.any? { |c| @body.is_a?(c) }
+      raise InvalidBody, "must be one of: #{valid_types}. '#{@body.class}' given"
+    end
+
     def read_raw_response(raw_response)
       if raw_response.is_a?(IO)
         string = raw_response.read
@@ -129,6 +137,8 @@ module WebMock
       options
     end
 
+    InvalidBody = Class.new(StandardError)
+
   end
 
   class DynamicResponse < Response

data/lib/webmock/version.rb

@@ -1,3 +1,3 @@
 module WebMock
-  VERSION = '1.20.1' unless defined?(::WebMock::VERSION)
+  VERSION = '1.20.2' unless defined?(::WebMock::VERSION)
 end

data/spec/unit/request_pattern_spec.rb

@@ -400,7 +400,7 @@ describe WebMock::RequestPattern do
                                                              :headers => {:content_type => 'application/json'}, :body => "foo bar"))
           end
 
-          it "shound not match if request body is different" do
+          it "should not match if request body is different" do
             WebMock::RequestPattern.new(:post, 'www.example.com', :body => {:a => 1, :b => 2}).
               should_not match(WebMock::RequestSignature.new(:post, "www.example.com",
               :headers => {:content_type => 'application/json'}, :body => "{\"a\":1,\"c\":null}"))

data/spec/unit/response_spec.rb

@@ -124,6 +124,15 @@ describe WebMock::Response do
       @response = WebMock::Response.new(:body => Pathname.new(__FILE__))
       @response.body.should == File.read(__FILE__)
     end
+
+    # Users of webmock commonly make the mistake of stubbing the response
+    # body to return a hash, to prevent this:
+    #
+    it "should error if not given one of the allowed types" do
+      lambda { WebMock::Response.new(:body => Hash.new) }.should \
+        raise_error(WebMock::Response::InvalidBody)
+    end
+
   end
 
   describe "from raw response" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: webmock
 version: !ruby/object:Gem::Version 
-  hash: 69
+  hash: 67
   prerelease: 
   segments: 
   - 1
   - 20
-  - 1
-  version: 1.20.1
+  - 2
+  version: 1.20.2
 platform: ruby
 authors: 
 - Bartosz Blimke