rubyist-fakeweb 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/CHANGELOG ADDED
@@ -0,0 +1,128 @@
1
+ fakeweb (development)
2
+
3
+ * fix the #http_version of :file and :string responses, which was returning the
4
+ request URI instead of something sensible like "1.0" [Chris Kampmeier]
5
+
6
+ * add method aliases in the Net::HTTP patch to eliminate warnings when running
7
+ with -w [Joshua Clingenpeel]
8
+
9
+ * fix that removing the redefinition of OpenURI::HTTPError in 1.2.0 caused
10
+ :exception responses to raise when OpenURI isn't available [Chris Kampmeier]
11
+
12
+ * fix registering an :exception response with classes that require arguments for
13
+ instantiation, like Interrupt's subclasses [Chris Kampmeier]
14
+
15
+
16
+ fakeweb (1.2.2)
17
+
18
+ * fix that HTTP Digest and OAuth requests could raise URI::InvalidURIErrors
19
+ [Bill Kocik, Chris Kampmeier]
20
+
21
+
22
+ fakeweb (1.2.1)
23
+
24
+ * fix that query parameters are handled correctly when registering with a URI
25
+ object [Anselmo Alves, Chris Kampmeier]
26
+
27
+ * fix an exception when registering with the :response option and a string
28
+ containing "\0" [Jonathan Baudanza, Chris Kampmeier]
29
+
30
+ * fix that trailing slashes were considered significant for requests to the root
31
+ of a domain [Chris Kampmeier]
32
+
33
+ * add support for HTTP basic authentication via userinfo strings in URIs
34
+ [Michael Bleigh]
35
+
36
+
37
+ fakeweb (1.2.0)
38
+
39
+ * add lib/fakeweb.rb so you can require "fakeweb" as well [Chris Kampmeier]
40
+
41
+ * fix compatibility with Ruby 1.9.1 [Chris Kampmeier]
42
+
43
+ * fix that newlines in file-based responses could be doubled in the response
44
+ object's body [Mark Menard, Chris Kampmeier]
45
+
46
+ * fix unnecessary munging of the transfer-encoding header, which improves
47
+ compatibility with mechanize [Mark Menard]
48
+
49
+ * fix a test and the RCov dependency to be compatible with JRuby [Mark Menard]
50
+
51
+ * remove an unnecessary redefinition of OpenURI::HTTPError [Josh Nichols]
52
+
53
+ * rearrange implementation code into separate files, one per class [Josh Nichols]
54
+
55
+ * fix a bug where FakeWeb.response_for would raise if the request wasn't
56
+ registered [Chris Kampmeier]
57
+
58
+ * add HTTP method support, so FakeWeb takes both the URI and method into
59
+ account for registration, requests, and responses. Backwards-compatible with
60
+ the old method signatures, which didn't have a method param. [Chris Kampmeier]
61
+
62
+ * start work on Ruby 1.9 compatibility [Chris Kampmeier]
63
+
64
+ * add FakeWeb.allow_net_connect= to enable/disable the pass-through to
65
+ Net::HTTP for unregistered URIs [Mislav Marohnić, Chris Kampmeier]
66
+
67
+ * remove setup.rb, since most people use RubyGems [Mislav Marohnić]
68
+
69
+ * fix that 'http://example.com/?' (empty query) matches a registered
70
+ 'http://example.com/', and vice-versa [Mislav Marohnić]
71
+
72
+ * improve the test suite to not rely on an internet connection [Chris Kampmeier]
73
+
74
+ * use `rake test` instead of `rake tests` [Josh Nichols]
75
+
76
+ * fix an incompatibility with Ruby 1.8.6 p36 where you'd get "Errno::EINTR:
77
+ Interrupted system call" exceptions in Socket#sysread for any non-faked
78
+ request [Chris Kampmeier]
79
+
80
+ * response rotation: you can now optionally call FakeWeb.register_uri with an
81
+ array of options hashes; these are used, in order, to respond to
82
+ repeated requests (to repeat a response more than once before rotating, use
83
+ the :times option). Once you run out of responses, further requests always
84
+ receive the last response. [Michael Shapiro]
85
+
86
+ * add support for Net::HTTP's undocumented full-URI request style (fixes
87
+ URI::InvalidURIErrors that you might see in older libraries) [Chris Kampmeier]
88
+
89
+ * sort query params before storing internally, so that
90
+ http://example.com/?a=1&b=2 and http://example.com/?b=2&a=1 are considered the
91
+ same URL (although this is technically incorrect, it's much more
92
+ convenient--most web apps work that way, and Net::HTTP's use of a hash to pass
93
+ query params means that the order in which FakeWeb stores them can be
94
+ unpredictable) [Chris Kampmeier]
95
+
96
+ * add support for ports in URLs, so that http://example.com/ and
97
+ http://example.com:3000/ are not the same [Chris Kampmeier]
98
+
99
+ * fix for non-faked SSL requests failing with "Unable to create local socket"
100
+ [Chris Kampmeier]
101
+
102
+ * update Rakefile to fix warning about deprecated code [Chris Kampmeier]
103
+
104
+
105
+ fakeweb (1.1.2)
106
+
107
+ * add required dependencies to GemSpec to ensure that tests pass in firebrigade
108
+ (http://firebrigade.seattlerb.org/) [Blaine Cook]
109
+
110
+
111
+ fakeweb (1.1.1)
112
+
113
+ * fix for non-existence of :string method on File as presented by open-uri
114
+ [Blaine Cook]
115
+
116
+ * fix for curl example test - google redirects to ccTLDs for those outside US
117
+ [Blaine Cook]
118
+
119
+
120
+ fakeweb (1.1.0)
121
+
122
+ * update code to correspond to ruby 1.8.4 (breaks compatibility with ruby 1.8.2)
123
+ [Blaine Cook]
124
+
125
+
126
+ fakeweb (1.0.0)
127
+
128
+ * initial import [Blaine Cook]
data/LICENSE.txt ADDED
@@ -0,0 +1,281 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Lesser General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
data/README.rdoc ADDED
@@ -0,0 +1,196 @@
1
+ = FakeWeb
2
+
3
+ FakeWeb is a helper for faking web requests in Ruby. It works at a global
4
+ level, without modifying code or writing extensive stubs.
5
+
6
+
7
+ == Installation
8
+
9
+ The latest release of FakeWeb is once again available from your friendly
10
+ RubyForge mirror. Just install the gem:
11
+
12
+ sudo gem install fakeweb
13
+
14
+ Note: the gem was previously available as +FakeWeb+ (capital letters), but now
15
+ all versions are simply registered as +fakeweb+. If you have any old +FakeWeb+
16
+ gems lying around, remove them: <tt>sudo gem uninstall FakeWeb</tt>
17
+
18
+
19
+ == Help and discussion
20
+
21
+ RDocs for the current release are available at http://fakeweb.rubyforge.org.
22
+
23
+ There's a mailing list for questions and discussion at
24
+ http://groups.google.com/group/fakeweb-users.
25
+
26
+ The main source repository is http://github.com/chrisk/fakeweb.
27
+
28
+ == Examples
29
+
30
+ Start by requiring FakeWeb:
31
+
32
+ require 'rubygems'
33
+ require 'fakeweb'
34
+
35
+ === Registering basic string responses
36
+
37
+ FakeWeb.register_uri(:get, "http://example.com/test1", :string => "Hello World!")
38
+
39
+ Net::HTTP.get(URI.parse("http://example.com/test1"))
40
+ => "Hello World!"
41
+
42
+ Net::HTTP.get(URI.parse("http://example.com/test2"))
43
+ => FakeWeb is bypassed and the response from a real request is returned
44
+
45
+ === Replaying a recorded response
46
+
47
+ page = `curl -is http://www.google.com/`
48
+ FakeWeb.register_uri(:get, "http://www.google.com/", :response => page)
49
+
50
+ Net::HTTP.get(URI.parse("http://www.google.com/"))
51
+ # => Full response, including headers
52
+
53
+ === Adding a custom status to the response
54
+
55
+ FakeWeb.register_uri(:get, "http://example.com/", :string => "Nothing to be found 'round here",
56
+ :status => ["404", "Not Found"])
57
+
58
+ Net::HTTP.start("example.com") do |req|
59
+ response = req.get("/")
60
+ response.code # => "404"
61
+ response.message # => "Not Found"
62
+ response.body # => "Nothing to be found 'round here"
63
+ end
64
+
65
+ === Responding to any HTTP method
66
+
67
+ FakeWeb.register_uri(:any, "http://example.com", :string => "response for any HTTP method")
68
+
69
+ If you use the <tt>:any</tt> symbol, the URI you specify will be completely
70
+ stubbed out (regardless of the HTTP method of the request). This can be useful
71
+ for RPC-like services, where the HTTP method isn't significant. (Older
72
+ versions of FakeWeb always behaved like this, and didn't accept the first
73
+ +method+ argument above; this syntax is still supported, for
74
+ backwards-compatibility, but it will probably be deprecated at some point.)
75
+
76
+ === Rotating responses
77
+
78
+ You can optionally call FakeWeb.register_uri with an array of options hashes;
79
+ these are used, in order, to respond to repeated requests. Once you run out of
80
+ responses, further requests always receive the last response. (You can also send
81
+ a response more than once before rotating, by specifying a <tt>:times</tt>
82
+ option for that response.)
83
+
84
+ FakeWeb.register_uri(:delete, "http://example.com/posts/1",
85
+ [{:string => "Post 1 deleted.", :status => ["200", "OK"]},
86
+ {:string => "Post not found", :status => ["404", "Not Found"]}])
87
+
88
+ Net::HTTP.start("example.com") do |req|
89
+ req.delete("/posts/1").body # => "Post 1 deleted"
90
+ req.delete("/posts/1").body # => "Post not found"
91
+ req.delete("/posts/1").body # => "Post not found"
92
+ end
93
+
94
+ === Using a block to generate a response
95
+
96
+ You can optionally call FakeWeb.register_uri with a block which will be used to
97
+ generate the response. The block will receive a hash containing the query parameters.
98
+ The return value of the block will be the response body.
99
+
100
+ FakeWeb.register_uri(:post, "http://example.com/", {}) do |params|
101
+ # => params will be {'foo' => 'bar'}
102
+ "Hello"
103
+ end
104
+
105
+ resp = Net::HTTP.post_form(URI.parse('http://example.com/'), {'foo' => 'bar'})
106
+ resp.body # => "Hello"
107
+
108
+ === Using HTTP basic authentication
109
+
110
+ You can stub requests that use basic authentication with +userinfo+ strings in
111
+ the URIs:
112
+
113
+ FakeWeb.register_uri("http://example.com/secret", :string => "Unauthorized", :status => ["401", "Unauthorized"])
114
+ FakeWeb.register_uri("http://user:pass@example.com/secret", :string => "Authorized")
115
+
116
+ Net::HTTP.start("example.com") do |http|
117
+ req = Net::HTTP::Get.new("/secret")
118
+ http.request(req) # => "Unauthorized"
119
+ req.basic_auth("user", "pass")
120
+ http.request(req) # => "Authorized"
121
+ end
122
+
123
+ === Clearing registered URIs
124
+
125
+ The FakeWeb registry is a singleton that lasts for the duration of your
126
+ program, maintaining every fake response you register. If needed, you
127
+ can clean out the registry and remove all registered URIs:
128
+
129
+ FakeWeb.clean_registry
130
+
131
+ === Blocking all real requests
132
+
133
+ When you're using FakeWeb to replace _all_ of your requests, it's useful to
134
+ catch when requests are made for unregistered URIs (unlike the default
135
+ behavior, which is to pass those requests through to Net::HTTP as usual).
136
+
137
+ FakeWeb.allow_net_connect = false
138
+ Net::HTTP.get(URI.parse("http://example.com/"))
139
+ => raises FakeWeb::NetConnectNotAllowedError
140
+
141
+ FakeWeb.allow_net_connect = true
142
+ Net::HTTP.get(URI.parse("http://example.com/"))
143
+ => FakeWeb is bypassed and the response from a real request is returned
144
+
145
+ This is handy when you want to make sure your tests are self-contained, or you
146
+ want to catch the scenario when a URI is changed in implementation code
147
+ without a corresponding test change.
148
+
149
+
150
+ == More info
151
+
152
+ FakeWeb lets you decouple your test environment from live services without
153
+ modifying code or writing extensive stubs.
154
+
155
+ In addition to the conceptual advantage of having idempotent request
156
+ behaviour, FakeWeb makes tests run faster than if they were made to remote (or
157
+ even local) web servers. It also makes it possible to run tests without a
158
+ network connection or in situations where the server is behind a firewall or
159
+ has host-based access controls.
160
+
161
+ FakeWeb works with anything based on Net::HTTP--both higher-level wrappers,
162
+ like OpenURI, as well as a ton of libraries for popular web services.
163
+
164
+
165
+ == Known Issues
166
+
167
+ * Request bodies are ignored, including PUT and POST parameters. If you need
168
+ different responses for different request bodies, you need to request
169
+ different URLs, and register different responses for each. (Query strings are
170
+ fully supported, though.) We're currently considering how the API should
171
+ change to add support for request bodies in 1.3.0. Your input would be really
172
+ helpful: see http://groups.google.com/group/fakeweb-users/browse_thread/thread/44d190a6b12e4273
173
+ for a discussion of some different options. Thanks!
174
+
175
+
176
+ == Copyright
177
+
178
+ Copyright 2006-2007 Blaine Cook
179
+
180
+ Copyright 2008-2009 various contributors
181
+
182
+ FakeWeb is free software; you can redistribute it and/or modify it under the
183
+ terms of the GNU General Public License as published by the Free Software
184
+ Foundation; either version 2 of the License, or (at your option) any later
185
+ version.
186
+
187
+ FakeWeb is distributed in the hope that it will be useful, but WITHOUT ANY
188
+ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
189
+ FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
190
+ details.
191
+
192
+ You should have received a copy of the GNU General Public License along
193
+ with FakeWeb; if not, write to the Free Software Foundation, Inc., 51
194
+ Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
195
+
196
+ See <tt>LICENSE.txt</tt> for the full terms.