module WebMock::API

Public Instance Methods

a_request(method, uri) click to toggle source
# File lib/webmock/api.rb, line 14
def a_request(method, uri)
  WebMock::RequestPattern.new(method, uri)
end
assert_not_requested(*args, &block) click to toggle source
# File lib/webmock/api.rb, line 31
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[0], args[1], args[2], &block)
  elsif block
    raise ArgumentError, "assert_not_requested with a stub object, doesn't accept blocks"
  end
  assert_request_not_requested(*args)
end
Also aliased as: refute_requested
assert_requested(*args, &block) click to toggle source
# File lib/webmock/api.rb, line 22
def assert_requested(*args, &block)
  if not args[0].is_a?(WebMock::RequestStub)
    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
  assert_request_requested(*args)
end
hash_excluding(*args) click to toggle source
Calls superclass method
# File lib/webmock/api.rb, line 59
def hash_excluding(*args)
  if defined?(super)
    super
  else
    WebMock::Matchers::HashExcludingMatcher.new(anythingize_lonely_keys(*args))
  end
end
hash_including(*args) click to toggle source

Similar to RSpec::Mocks::ArgumentMatchers#hash_including()

Matches a hash that includes the specified key(s) or key/value pairs. Ignores any additional keys.

@example

object.should_receive(:message).with(hash_including(:key => val))
object.should_receive(:message).with(hash_including(:key))
object.should_receive(:message).with(hash_including(:key, :key2 => val2))
Calls superclass method
# File lib/webmock/api.rb, line 51
def hash_including(*args)
  if defined?(super)
    super
  else
    WebMock::Matchers::HashIncludingMatcher.new(anythingize_lonely_keys(*args))
  end
end
refute_requested(*args, &block)
remove_request_stub(stub) click to toggle source
# File lib/webmock/api.rb, line 67
def remove_request_stub(stub)
  WebMock::StubRegistry.instance.remove_request_stub(stub)
end
reset_executed_requests!() click to toggle source
# File lib/webmock/api.rb, line 71
def reset_executed_requests!
  WebMock::RequestRegistry.instance.reset!
end
stub_http_request(method, uri)
Alias for: stub_request
stub_request(method, uri) click to toggle source
# File lib/webmock/api.rb, line 7
def stub_request(method, uri)
  WebMock::StubRegistry.instance.
    register_request_stub(WebMock::RequestStub.new(method, uri))
end
Also aliased as: stub_http_request

Private Instance Methods

anythingize_lonely_keys(*args) click to toggle source

this is a based on RSpec::Mocks::ArgumentMatchers#anythingize_lonely_keys

# File lib/webmock/api.rb, line 104
def anythingize_lonely_keys(*args)
  hash = args.last.class == Hash ? args.delete_at(-1) : {}
  args.each { | arg | hash[arg] =  WebMock::Matchers::AnyArgMatcher.new(nil) }
  hash
end
assert_request_not_requested(request, options = {}) click to toggle source
# File lib/webmock/api.rb, line 95
def assert_request_not_requested(request, options = {})
  times = options.delete(:times)
  at_least_times = options.delete(:at_least_times)
  at_most_times  = options.delete(:at_most_times)
  verifier = WebMock::RequestExecutionVerifier.new(request, times, at_least_times, at_most_times)
  WebMock::AssertionFailure.failure(verifier.failure_message_when_negated) unless verifier.does_not_match?
end
assert_request_requested(request, options = {}) click to toggle source
# File lib/webmock/api.rb, line 86
def assert_request_requested(request, options = {})
  times = options.delete(:times)
  at_least_times = options.delete(:at_least_times)
  at_most_times  = options.delete(:at_most_times)
  times = 1 if times.nil? && at_least_times.nil? && at_most_times.nil?
  verifier = WebMock::RequestExecutionVerifier.new(request, times, at_least_times, at_most_times)
  WebMock::AssertionFailure.failure(verifier.failure_message) unless verifier.matches?
end
convert_uri_method_and_options_to_request_and_options(method, uri, options, &block) click to toggle source
# File lib/webmock/api.rb, line 77
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