Module: WebMock

Extended by:
API
Includes:
API
Defined in:
lib/webmock/util/json.rb,
lib/webmock/api.rb,
lib/webmock/errors.rb,
lib/webmock/config.rb,
lib/webmock/webmock.rb,
lib/webmock/version.rb,
lib/webmock/response.rb,
lib/webmock/util/uri.rb,
lib/webmock/deprecation.rb,
lib/webmock/request_stub.rb,
lib/webmock/util/headers.rb,
lib/webmock/stub_registry.rb,
lib/webmock/rack_response.rb,
lib/webmock/rspec/matchers.rb,
lib/webmock/request_pattern.rb,
lib/webmock/request_registry.rb,
lib/webmock/util/hash_counter.rb,
lib/webmock/request_signature.rb,
lib/webmock/callback_registry.rb,
lib/webmock/assertion_failure.rb,
lib/webmock/request_body_diff.rb,
lib/webmock/responses_sequence.rb,
lib/webmock/util/hash_validator.rb,
lib/webmock/util/version_checker.rb,
lib/webmock/stub_request_snippet.rb,
lib/webmock/request_signature_snippet.rb,
lib/webmock/util/hash_keys_stringifier.rb,
lib/webmock/request_execution_verifier.rb,
lib/webmock/http_lib_adapters/net_http.rb,
lib/webmock/http_lib_adapters/net_http.rb,
lib/webmock/http_lib_adapters/curb_adapter.rb,
lib/webmock/rspec/matchers/webmock_matcher.rb,
lib/webmock/http_lib_adapters/excon_adapter.rb,
lib/webmock/matchers/hash_including_matcher.rb,
lib/webmock/http_lib_adapters/patron_adapter.rb,
lib/webmock/http_lib_adapters/http_rb_adapter.rb,
lib/webmock/http_lib_adapters/http_lib_adapter.rb,
lib/webmock/http_lib_adapters/manticore_adapter.rb,
lib/webmock/http_lib_adapters/httpclient_adapter.rb,
lib/webmock/rspec/matchers/request_pattern_matcher.rb,
lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb,
lib/webmock/http_lib_adapters/em_http_request_adapter.rb,
lib/webmock/http_lib_adapters/http_lib_adapter_registry.rb

Overview

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Defined Under Namespace

Modules: API, HttpLibAdapters, Matchers, NetHTTPUtility, RSpecMatcherDetector, Util Classes: AssertionFailure, BodyPattern, CallbackRegistry, Config, Deprecation, DynamicResponse, HashValidator, HeadersPattern, HttpLibAdapter, HttpLibAdapterRegistry, MethodPattern, NetConnectNotAllowedError, RackResponse, RequestBodyDiff, RequestExecutionVerifier, RequestPattern, RequestPatternMatcher, RequestRegistry, RequestSignature, RequestSignatureSnippet, RequestStub, Response, ResponseFactory, ResponsesSequence, StubRegistry, StubRequestSnippet, URIAddressablePattern, URIPattern, URIRegexpPattern, URIStringPattern, VersionChecker, WebMockMatcher

Constant Summary

VERSION =
'2.0.1'

Class Method Summary collapse

Methods included from API

a_request, assert_not_requested, assert_requested, hash_including, remove_request_stub, stub_request

Class Method Details

.after_request(options = {}, &block) ⇒ Object



124
125
126
# File 'lib/webmock/webmock.rb', line 124

def self.after_request(options={}, &block)
  WebMock::CallbackRegistry.add_callback(options, block)
end

.allow_net_connect!(options = {}) ⇒ Object



44
45
46
47
# File 'lib/webmock/webmock.rb', line 44

def self.allow_net_connect!(options = {})
  Config.instance.allow_net_connect = true
  Config.instance.net_http_connect_on_start = options[:net_http_connect_on_start]
end

.disable!(options = {}) ⇒ Object



28
29
30
31
32
33
34
# File 'lib/webmock/webmock.rb', line 28

def self.disable!(options = {})
  except = [options[:except]].flatten.compact
  HttpLibAdapterRegistry.instance.each_adapter do |name, adapter|
    adapter.enable!
    adapter.disable! unless except.include?(name)
  end
end

.disable_net_connect!(options = {}) ⇒ Object



49
50
51
52
53
54
# File 'lib/webmock/webmock.rb', line 49

def self.disable_net_connect!(options = {})
  Config.instance.allow_net_connect = false
  Config.instance.allow_localhost = options[:allow_localhost]
  Config.instance.allow = options[:allow]
  Config.instance.net_http_connect_on_start = options[:net_http_connect_on_start]
end

.enable!(options = {}) ⇒ Object



36
37
38
39
40
41
42
# File 'lib/webmock/webmock.rb', line 36

def self.enable!(options = {})
  except = [options[:except]].flatten.compact
  HttpLibAdapterRegistry.instance.each_adapter do |name, adapter|
    adapter.disable!
    adapter.enable! unless except.include?(name)
  end
end

.globally_stub_request(&block) ⇒ Object



136
137
138
# File 'lib/webmock/webmock.rb', line 136

def self.globally_stub_request(&block)
  WebMock::StubRegistry.instance.register_global_stub(&block)
end

.hide_body_diff!Object



90
91
92
# File 'lib/webmock/webmock.rb', line 90

def self.hide_body_diff!
  Config.instance.show_body_diff = false
end

.hide_stubbing_instructions!Object



98
99
100
# File 'lib/webmock/webmock.rb', line 98

def self.hide_stubbing_instructions!
  Config.instance.show_stubbing_instructions = false
end

.included(clazz) ⇒ Object



3
4
5
6
7
8
9
10
11
12
13
14
15
# File 'lib/webmock/webmock.rb', line 3

def self.included(clazz)
  WebMock::Deprecation.warning("include WebMock is deprecated. Please include WebMock::API instead")
  if clazz.instance_methods.map(&:to_s).include?('request')
    warn "WebMock#request was not included in #{clazz} to avoid name collision"
  else
    clazz.class_eval do
      def request(method, uri)
        WebMock::Deprecation.warning("WebMock#request is deprecated. Please use WebMock::API#a_request method instead")
        WebMock.a_request(method, uri)
      end
    end
  end
end

.net_connect_allowed?(uri = nil) ⇒ Boolean



56
57
58
59
60
61
62
63
64
# File 'lib/webmock/webmock.rb', line 56

def self.net_connect_allowed?(uri = nil)
  if uri.is_a?(String)
    uri = WebMock::Util::URI.normalize_uri(uri)
  end

  Config.instance.allow_net_connect ||
  ( Config.instance.allow_localhost && WebMock::Util::URI.is_uri_localhost?(uri) ||
    Config.instance.allow && net_connect_explicit_allowed?(Config.instance.allow, uri) )
end

.net_connect_explicit_allowed?(allowed, uri = nil) ⇒ Boolean



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/webmock/webmock.rb', line 66

def self.net_connect_explicit_allowed?(allowed, uri=nil)
  case allowed
  when Array
    allowed.any? { |allowed_item| net_connect_explicit_allowed?(allowed_item, uri) }
  when Regexp
    (uri.to_s =~ allowed) != nil ||
    (uri.omit(:port).to_s =~ allowed) != nil && uri.port == uri.default_port
  when String
    allowed == uri.to_s ||
    allowed == uri.host ||
    allowed == "#{uri.host}:#{uri.port}" ||
    allowed == "#{uri.scheme}://#{uri.host}:#{uri.port}" ||
    allowed == "#{uri.scheme}://#{uri.host}" && uri.port == uri.default_port
  else
    if allowed.respond_to?(:call)
      allowed.call(uri)
    end
  end
end


132
133
134
# File 'lib/webmock/webmock.rb', line 132

def self.print_executed_requests
  puts WebMock::RequestExecutionVerifier.executed_requests_message
end

.registered_request?(request_signature) ⇒ Boolean



128
129
130
# File 'lib/webmock/webmock.rb', line 128

def self.registered_request?(request_signature)
  WebMock::StubRegistry.instance.registered_request?(request_signature)
end

.reset!Object



110
111
112
113
# File 'lib/webmock/webmock.rb', line 110

def self.reset!
  WebMock::RequestRegistry.instance.reset!
  WebMock::StubRegistry.instance.reset!
end

.reset_callbacksObject



120
121
122
# File 'lib/webmock/webmock.rb', line 120

def self.reset_callbacks
  WebMock::CallbackRegistry.reset
end

.reset_webmockObject



115
116
117
118
# File 'lib/webmock/webmock.rb', line 115

def self.reset_webmock
  WebMock::Deprecation.warning("WebMock.reset_webmock is deprecated. Please use WebMock.reset! method instead")
  reset!
end

.show_body_diff!Object



86
87
88
# File 'lib/webmock/webmock.rb', line 86

def self.show_body_diff!
  Config.instance.show_body_diff = true
end

.show_body_diff?Boolean



94
95
96
# File 'lib/webmock/webmock.rb', line 94

def self.show_body_diff?
  Config.instance.show_body_diff
end

.show_stubbing_instructions!Object



102
103
104
# File 'lib/webmock/webmock.rb', line 102

def self.show_stubbing_instructions!
  Config.instance.show_stubbing_instructions = true
end

.show_stubbing_instructions?Boolean



106
107
108
# File 'lib/webmock/webmock.rb', line 106

def self.show_stubbing_instructions?
  Config.instance.show_stubbing_instructions
end

.versionObject



24
25
26
# File 'lib/webmock/webmock.rb', line 24

def self.version
  VERSION
end