-
-
Notifications
You must be signed in to change notification settings - Fork 41
/
Copy pathHaveHttpStatus.html
312 lines (312 loc) · 18.4 KB
/
HaveHttpStatus.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: RSpec::Rails::Matchers::HaveHttpStatus
— Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="/documentation/7.0/rspec-rails/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/7.0/rspec-rails/css/common.css" type="text/css" />
<link rel="stylesheet" href="/documentation/7.0/rspec-rails/css/rspec.css" type="text/css" />
<script type="text/javascript">
pathId = "RSpec::Rails::Matchers::HaveHttpStatus";
relpath = '../../../';
</script>
<script type="text/javascript" charset="utf-8" src="/documentation/7.0/rspec-rails/js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="/documentation/7.0/rspec-rails/js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (H)</a> »
<span class='title'><span class='object_link'><a href="../../../RSpec.html" title="RSpec (module)">RSpec</a></span></span> » <span class='title'><span class='object_link'><a href="../../Rails.html" title="RSpec::Rails (module)">Rails</a></span></span> » <span class='title'><span class='object_link'><a href="../Matchers.html" title="RSpec::Rails::Matchers (module)">Matchers</a></span></span>
»
<span class="title">HaveHttpStatus</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: RSpec::Rails::Matchers::HaveHttpStatus
<span class="private note title">Private</span>
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="HaveHttpStatus/GenericStatus.html" title="RSpec::Rails::Matchers::HaveHttpStatus::GenericStatus (class)">GenericStatus</a></span>, <span class='object_link'><a href="HaveHttpStatus/NumericCode.html" title="RSpec::Rails::Matchers::HaveHttpStatus::NumericCode (class)">NumericCode</a></span>, <span class='object_link'><a href="HaveHttpStatus/SymbolicStatus.html" title="RSpec::Rails::Matchers::HaveHttpStatus::SymbolicStatus (class)">SymbolicStatus</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rspec/rails/matchers/have_http_status.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This module is part of a private API.</strong>
You should avoid using this module if possible, as it may be removed or be changed in the future.
</p>
<p>Namespace for various implementations of <code>have_http_status</code>.</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="HaveHttpStatus/GenericStatus.html" title="RSpec::Rails::Matchers::HaveHttpStatus::GenericStatus (class)">GenericStatus</a></span>, <span class='object_link'><a href="HaveHttpStatus/NumericCode.html" title="RSpec::Rails::Matchers::HaveHttpStatus::NumericCode (class)">NumericCode</a></span>, <span class='object_link'><a href="HaveHttpStatus/SymbolicStatus.html" title="RSpec::Rails::Matchers::HaveHttpStatus::SymbolicStatus (class)">SymbolicStatus</a></span>
</p>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#as_test_response-class_method" title="as_test_response (class method)">.<strong>as_test_response</strong>(obj) ⇒ ActionDispatch::TestResponse </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>Conversion function to coerce the provided object into an <code>ActionDispatch::TestResponse</code>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#matcher_for_status-class_method" title="matcher_for_status (class method)">.<strong>matcher_for_status</strong>(target) ⇒ Object </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>Instantiates an instance of the proper matcher based on the provided <code>target</code>.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#invalid_response_type_message-instance_method" title="#invalid_response_type_message (instance method)">#<strong>invalid_response_type_message</strong> ⇒ String<sup>?</sup> </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>A formatted failure message if <code>@invalid_response</code> is present, <code>nil</code> otherwise.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="as_test_response-class_method">
.<strong>as_test_response</strong>(obj) ⇒ <tt>ActionDispatch::TestResponse</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This method is part of a private API.</strong>
You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<p>Conversion function to coerce the provided object into an
<code>ActionDispatch::TestResponse</code>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>obj</span>
<span class='type'>(<tt>Object</tt>)</span>
—
<div class='inline'><p>object to convert to a response</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>ActionDispatch::TestResponse</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/have_http_status.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_as_test_response'>as_test_response</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='op'>::</span><span class='const'>ActionDispatch</span><span class='op'>::</span><span class='const'>Response</span> <span class='op'>===</span> <span class='id identifier rubyid_obj'>obj</span> <span class='op'>||</span> <span class='op'>::</span><span class='const'>Rack</span><span class='op'>::</span><span class='const'>MockResponse</span> <span class='op'>===</span> <span class='id identifier rubyid_obj'>obj</span>
<span class='op'>::</span><span class='const'>ActionDispatch</span><span class='op'>::</span><span class='const'>TestResponse</span><span class='period'>.</span><span class='id identifier rubyid_from_response'>from_response</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
<span class='kw'>elsif</span> <span class='op'>::</span><span class='const'>ActionDispatch</span><span class='op'>::</span><span class='const'>TestResponse</span> <span class='op'>===</span> <span class='id identifier rubyid_obj'>obj</span>
<span class='id identifier rubyid_obj'>obj</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:status_code</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:response_headers</span><span class='rparen'>)</span>
<span class='comment'># Acts As Capybara Session
</span> <span class='comment'># Hack to support `Capybara::Session` without having to load
</span> <span class='comment'># Capybara or catch `NameError`s for the undefined constants
</span> <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='const'>ActionDispatch</span><span class='op'>::</span><span class='const'>Response</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_resp'>resp</span><span class='op'>|</span>
<span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_status_code'>status_code</span>
<span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='period'>.</span><span class='id identifier rubyid_clear'>clear</span>
<span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_response_headers'>response_headers</span><span class='rparen'>)</span>
<span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
<span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span> <span class='op'>=</span> <span class='const'>ActionDispatch</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='op'>::</span><span class='const'>ActionDispatch</span><span class='op'>::</span><span class='const'>TestResponse</span><span class='period'>.</span><span class='id identifier rubyid_from_response'>from_response</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>TypeError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Invalid response type: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_obj'>obj</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="matcher_for_status-class_method">
.<strong>matcher_for_status</strong>(target) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This method is part of a private API.</strong>
You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<p>Instantiates an instance of the proper matcher based on the provided
<code>target</code>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>target</span>
<span class='type'>(<tt>Object</tt>)</span>
—
<div class='inline'><p>expected http status or code</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>response matcher instance</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21
22
23
24
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/have_http_status.rb', line 19</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_matcher_for_status'>matcher_for_status</span><span class='lparen'>(</span><span class='id identifier rubyid_target'>target</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='const'><span class='object_link'><a href="HaveHttpStatus/GenericStatus.html" title="RSpec::Rails::Matchers::HaveHttpStatus::GenericStatus (class)">GenericStatus</a></span></span><span class='period'>.</span><span class='id identifier rubyid_valid_statuses'><span class='object_link'><a href="HaveHttpStatus/GenericStatus.html#valid_statuses-class_method" title="RSpec::Rails::Matchers::HaveHttpStatus::GenericStatus.valid_statuses (method)">valid_statuses</a></span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_target'>target</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="HaveHttpStatus/GenericStatus.html" title="RSpec::Rails::Matchers::HaveHttpStatus::GenericStatus (class)">GenericStatus</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="HaveHttpStatus/GenericStatus.html#initialize-instance_method" title="RSpec::Rails::Matchers::HaveHttpStatus::GenericStatus#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_target'>target</span><span class='rparen'>)</span>
<span class='kw'>elsif</span> <span class='const'>Symbol</span> <span class='op'>===</span> <span class='id identifier rubyid_target'>target</span>
<span class='const'><span class='object_link'><a href="HaveHttpStatus/SymbolicStatus.html" title="RSpec::Rails::Matchers::HaveHttpStatus::SymbolicStatus (class)">SymbolicStatus</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="HaveHttpStatus/SymbolicStatus.html#initialize-instance_method" title="RSpec::Rails::Matchers::HaveHttpStatus::SymbolicStatus#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_target'>target</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='const'><span class='object_link'><a href="HaveHttpStatus/NumericCode.html" title="RSpec::Rails::Matchers::HaveHttpStatus::NumericCode (class)">NumericCode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="HaveHttpStatus/NumericCode.html#initialize-instance_method" title="RSpec::Rails::Matchers::HaveHttpStatus::NumericCode#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_target'>target</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="invalid_response_type_message-instance_method">
#<strong>invalid_response_type_message</strong> ⇒ <tt>String</tt><sup>?</sup>
</h3><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This method is part of a private API.</strong>
You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<p>Returns a formatted failure message if
<code>@invalid_response</code> is present, <code>nil</code> otherwise.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
—
<div class='inline'><p>a formatted failure message if
<code>@invalid_response</code> is present, <code>nil</code> otherwise</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
60
61
62
63
64
65</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/have_http_status.rb', line 60</span>
<span class='kw'>def</span> <span class='id identifier rubyid_invalid_response_type_message'>invalid_response_type_message</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='ivar'>@invalid_response</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>expected a response object, but an instance of </span><span class='tstring_end'>"</span></span> \
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@invalid_response</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> was received</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Oct 9 21:42:10 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.3.5).
</div>
</div>
</body>
</html>