webmock 1.20.2 → 1.20.3

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.20.3
+
+  * `with` method raises error if provided without options hash and without block
+
+  * `with` and `to_return` raise an error if invoked with invalid keys in options hash.
+
 ## 1.20.2
 
   * WebMock provides a helpful error message if an incompatible object is given as response body.

data/Gemfile

@@ -5,14 +5,13 @@ if ENV["EM_HTTP_REQUEST_0_X"]
   gem 'em-http-request', '~> 0.3.0'
 end
 
-
 group :development do
   gem 'rake'
 end
 
 group :test do
   gem 'rack'
-  gem 'minitest_tu_shim'
+  gem 'minitest_tu_shim', '1.3.2'
 end
 
 platforms :jruby do

data/README.md

@@ -546,6 +546,8 @@ WebMock.should have_requested(:get, "www.example.com").
 WebMock.should_not have_requested(:get, "www.something.com")
 
 WebMock.should have_requested(:post, "www.example.com").with { |req| req.body == "abc" }
+# Note that the block with `do ... end` instead of curly brackets won't work!
+# Why? See this comment https://github.com/bblimke/webmock/issues/174#issuecomment-34908908
 
 WebMock.should have_requested(:get, "www.example.com").with(:query => {"a" => ["b", "c"]})
 

data/lib/webmock.rb

@@ -16,6 +16,7 @@ require 'webmock/util/hash_counter'
 require 'webmock/util/hash_keys_stringifier'
 require 'webmock/util/json'
 require 'webmock/util/version_checker'
+require 'webmock/util/hash_validator'
 
 require 'webmock/matchers/hash_including_matcher'
 

data/lib/webmock/api.rb

@@ -19,7 +19,7 @@ module WebMock
 
     def assert_requested(*args, &block)
       if not args[0].is_a?(WebMock::RequestStub)
-        args = convert_uri_method_and_options_to_request_and_options(*args, &block)
+        args = convert_uri_method_and_options_to_request_and_options(args[0], args[1], args[2], &block)
       elsif block
         raise ArgumentError, "assert_requested with a stub object, doesn't accept blocks"
       end
@@ -28,7 +28,7 @@ module WebMock
 
     def assert_not_requested(*args, &block)
       if not args[0].is_a?(WebMock::RequestStub)
-        args = convert_uri_method_and_options_to_request_and_options(*args, &block)
+        args = convert_uri_method_and_options_to_request_and_options(args[0], args[1], args[2], &block)
       elsif block
         raise ArgumentError, "assert_not_requested with a stub object, doesn't accept blocks"
       end
@@ -59,9 +59,13 @@ module WebMock
 
     private
 
-    def convert_uri_method_and_options_to_request_and_options(*args, &block)
-      request = WebMock::RequestPattern.new(*args).with(&block)
-      [request, args[2] || {}]
+    def convert_uri_method_and_options_to_request_and_options(method, uri, options, &block)
+      options ||= {}
+      options_for_pattern = options.dup
+      [:times, :at_least_times, :at_most_times].each { |key| options_for_pattern.delete(key) }
+      request = WebMock::RequestPattern.new(method, uri, options_for_pattern)
+      request = request.with(&block) if block
+      [request, options]
     end
 
     def assert_request_requested(request, options = {})

data/lib/webmock/request_pattern.rb

@@ -20,6 +20,7 @@ module WebMock
     end
 
     def with(options = {}, &block)
+      raise ArgumentError.new('#with method invoked with no arguments. Either options hash or block must be specified.') if options.empty? && !block_given?
       assign_options(options)
       @with_block = block
       self
@@ -49,6 +50,7 @@ module WebMock
 
     def assign_options(options)
       options = WebMock::Util::HashKeysStringifier.stringify_keys!(options, :deep => true)
+      HashValidator.new(options).validate_keys('body', 'headers', 'query')
       @body_pattern = BodyPattern.new(options['body']) if options.has_key?('body')
       @headers_pattern = HeadersPattern.new(options['headers']) if options.has_key?('headers')
       @uri_pattern.add_query_params(options['query']) if options.has_key?('query')

data/lib/webmock/response.rb

@@ -76,11 +76,13 @@ module WebMock
     end
 
     def options=(options)
-      self.headers = options[:headers]
-      self.status = options[:status]
-      self.body = options[:body]
-      self.exception = options[:exception]
-      @should_timeout = options[:should_timeout]
+      options = WebMock::Util::HashKeysStringifier.stringify_keys!(options)
+      HashValidator.new(options).validate_keys('headers', 'status', 'body', 'exception', 'should_timeout')
+      self.headers = options['headers']
+      self.status = options['status']
+      self.body = options['body']
+      self.exception = options['exception']
+      @should_timeout = options['should_timeout']
     end
 
     def evaluate(request_signature)

data/lib/webmock/util/hash_validator.rb

@@ -0,0 +1,17 @@
+module WebMock
+  class HashValidator
+    def initialize(hash)
+      @hash = hash
+    end
+
+    #This code is based on https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/keys.rb
+    def validate_keys(*valid_keys)
+      valid_keys.flatten!
+      @hash.each_key do |k|
+        unless valid_keys.include?(k)
+          raise ArgumentError.new("Unknown key: #{k.inspect}. Valid keys are: #{valid_keys.map(&:inspect).join(', ')}")
+        end
+      end
+    end
+  end
+end

data/lib/webmock/version.rb

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

data/spec/acceptance/curb/curb_spec.rb

@@ -373,7 +373,7 @@ unless RUBY_PLATFORM =~ /java/
       end
 
       it "should work with several body arguments for post using the class method" do
-        stub_request(:post, "www.example.com").with(:user => {:first_name=>'Bartosz', :last_name=>'Blimke'})
+        stub_request(:post, "www.example.com").with(:body => {:user => {:first_name=>'Bartosz', :last_name=>'Blimke'}})
         c = Curl::Easy.http_post "http://www.example.com", 'user[first_name]=Bartosz', 'user[last_name]=Blimke'
         c.response_code.should == 200
       end

data/spec/acceptance/typhoeus/typhoeus_hydra_spec.rb

@@ -22,7 +22,7 @@ unless RUBY_PLATFORM =~ /java/
 
       describe "when params are used" do
         it "should take into account params for POST request" do
-          stub_request(:post, "www.example.com/?hello=world").with(:params => {:hello => 'world'})
+          stub_request(:post, "www.example.com/?hello=world").with(:query => {:hello => 'world'})
           request = Typhoeus::Request.new("http://www.example.com", :method => :post, :params => {:hello => 'world'})
           hydra.queue(request)
           hydra.run

data/spec/unit/request_pattern_spec.rb

@@ -48,6 +48,13 @@ describe WebMock::RequestPattern do
       @request_pattern.to_s.should ==WebMock::RequestPattern.new(:get, "www.example.com", :headers => {'A' => 'a'}).to_s
     end
 
+    it "should raise an error if options passed to `with` are invalid" do
+      expect { @request_pattern.with(:foo => "bar") }.to raise_error('Unknown key: "foo". Valid keys are: "body", "headers", "query"')
+    end
+
+    it "should raise an error if neither options or block is provided" do
+      expect { @request_pattern.with() }.to raise_error('#with method invoked with no arguments. Either options hash or block must be specified.')
+    end
   end
 
 

data/spec/unit/response_spec.rb

@@ -26,6 +26,10 @@ describe WebMock::Response do
     @response = WebMock::Response.new(:headers => {'A' => 'a'})
   end
 
+  it "should raise an error when initialized with unknown option" do
+    expect { WebMock::Response.new(:foo => "bar") }.to raise_error('Unknown key: "foo". Valid keys are: "headers", "status", "body", "exception", "should_timeout"')
+  end
+
   it "should report normalized headers" do
     WebMock::Util::Headers.should_receive(:normalize_headers).with('A' => 'a').and_return('B' => 'b')
     @response = WebMock::Response.new(:headers => {'A' => 'a'})
@@ -33,7 +37,6 @@ describe WebMock::Response do
   end
 
   describe "status" do
-
     it "should have 200 code and empty message by default" do
       @response.status.should == [200, ""]
     end
@@ -47,7 +50,6 @@ describe WebMock::Response do
       @response = WebMock::Response.new(:status => [500, "Internal Server Error"])
       @response.status.should == [500, "Internal Server Error"]
     end
-
   end
 
   describe "raising error" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: webmock
 version: !ruby/object:Gem::Version 
-  hash: 67
+  hash: 65
   prerelease: 
   segments: 
   - 1
   - 20
-  - 2
-  version: 1.20.2
+  - 3
+  version: 1.20.3
 platform: ruby
 authors: 
 - Bartosz Blimke
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-11-02 00:00:00 +01:00
+date: 2014-11-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -273,6 +273,7 @@ files:
 - lib/webmock/test_unit.rb
 - lib/webmock/util/hash_counter.rb
 - lib/webmock/util/hash_keys_stringifier.rb
+- lib/webmock/util/hash_validator.rb
 - lib/webmock/util/headers.rb
 - lib/webmock/util/json.rb
 - lib/webmock/util/query_mapper.rb