aeden-contacts 0.2.15

Sign up to get free protection for your applications and to get access to all the features.
Files changed (49) hide show
  1. data/MIT-LICENSE +20 -0
  2. data/README.rdoc +51 -0
  3. data/Rakefile +71 -0
  4. data/VERSION.yml +4 -0
  5. data/lib/config/contacts.yml +10 -0
  6. data/lib/contacts/flickr.rb +133 -0
  7. data/lib/contacts/google.rb +387 -0
  8. data/lib/contacts/google_oauth.rb +91 -0
  9. data/lib/contacts/version.rb +9 -0
  10. data/lib/contacts/windows_live.rb +164 -0
  11. data/lib/contacts/yahoo.rb +236 -0
  12. data/lib/contacts.rb +55 -0
  13. data/spec/contact_spec.rb +61 -0
  14. data/spec/feeds/contacts.yml +10 -0
  15. data/spec/feeds/flickr/auth.getFrob.xml +4 -0
  16. data/spec/feeds/flickr/auth.getToken.xml +5 -0
  17. data/spec/feeds/google-many.xml +48 -0
  18. data/spec/feeds/google-single.xml +46 -0
  19. data/spec/feeds/wl_contacts.xml +29 -0
  20. data/spec/feeds/yh_contacts.txt +119 -0
  21. data/spec/feeds/yh_credential.xml +28 -0
  22. data/spec/flickr/auth_spec.rb +80 -0
  23. data/spec/gmail/auth_spec.rb +70 -0
  24. data/spec/gmail/fetching_spec.rb +198 -0
  25. data/spec/rcov.opts +2 -0
  26. data/spec/spec.opts +2 -0
  27. data/spec/spec_helper.rb +84 -0
  28. data/spec/windows_live/windows_live_spec.rb +34 -0
  29. data/spec/yahoo/yahoo_spec.rb +83 -0
  30. data/vendor/fakeweb/CHANGELOG +80 -0
  31. data/vendor/fakeweb/LICENSE.txt +281 -0
  32. data/vendor/fakeweb/README.rdoc +160 -0
  33. data/vendor/fakeweb/Rakefile +57 -0
  34. data/vendor/fakeweb/fakeweb.gemspec +13 -0
  35. data/vendor/fakeweb/lib/fake_web/ext/net_http.rb +58 -0
  36. data/vendor/fakeweb/lib/fake_web/registry.rb +78 -0
  37. data/vendor/fakeweb/lib/fake_web/responder.rb +88 -0
  38. data/vendor/fakeweb/lib/fake_web/response.rb +10 -0
  39. data/vendor/fakeweb/lib/fake_web/socket_delegator.rb +24 -0
  40. data/vendor/fakeweb/lib/fake_web.rb +152 -0
  41. data/vendor/fakeweb/test/fixtures/test_example.txt +1 -0
  42. data/vendor/fakeweb/test/fixtures/test_request +21 -0
  43. data/vendor/fakeweb/test/test_allow_net_connect.rb +41 -0
  44. data/vendor/fakeweb/test/test_fake_web.rb +453 -0
  45. data/vendor/fakeweb/test/test_fake_web_open_uri.rb +62 -0
  46. data/vendor/fakeweb/test/test_helper.rb +52 -0
  47. data/vendor/fakeweb/test/test_query_string.rb +37 -0
  48. data/vendor/windowslivelogin.rb +1151 -0
  49. metadata +108 -0
@@ -0,0 +1,34 @@
1
+ require 'spec_helper'
2
+ require 'contacts/windows_live'
3
+
4
+ describe Contacts::WindowsLive do
5
+
6
+ before(:each) do
7
+ @path = Dir.getwd + '/spec/feeds/'
8
+ @wl = Contacts::WindowsLive.new(@path + 'contacts.yml')
9
+ end
10
+
11
+ it 'parse the XML contacts document' do
12
+ contacts = Contacts::WindowsLive.parse_xml(contacts_xml)
13
+
14
+ contacts[0].name.should be_nil
15
+ contacts[0].email.should == 'froz@gmail.com'
16
+ contacts[1].name.should == 'Rafael Timbo'
17
+ contacts[1].email.should == 'timbo@hotmail.com'
18
+ contacts[2].name.should be_nil
19
+ contacts[2].email.should == 'betinho@hotmail.com'
20
+
21
+ end
22
+
23
+ it 'should can be initialized by a YAML file' do
24
+ wll = @wl.instance_variable_get('@wll')
25
+
26
+ wll.appid.should == 'your_app_id'
27
+ wll.securityalgorithm.should == 'wsignin1.0'
28
+ wll.returnurl.should == 'http://yourserver.com/your_return_url'
29
+ end
30
+
31
+ def contacts_xml
32
+ File.open(@path + 'wl_contacts.xml', 'r+').read
33
+ end
34
+ end
@@ -0,0 +1,83 @@
1
+ require 'spec_helper'
2
+ require 'contacts/yahoo'
3
+
4
+ describe Contacts::Yahoo do
5
+
6
+ before(:each) do
7
+ @path = Dir.getwd + '/spec/feeds/'
8
+ @yahoo = Contacts::Yahoo.new(@path + 'contacts.yml')
9
+ end
10
+
11
+ it 'should generate an athentication URL' do
12
+ auth_url = @yahoo.get_authentication_url()
13
+ auth_url.should match(/https:\/\/api.login.yahoo.com\/WSLogin\/V1\/wslogin\?appid=i%3DB%26p%3DUw70JGIdHWVRbpqYItcMw--&ts=.*&sig=.*/)
14
+ end
15
+
16
+ it 'should have a simple interface to grab the contacts' do
17
+ @yahoo.expects(:access_user_credentials).returns(read_file('yh_credential.xml'))
18
+ @yahoo.expects(:access_address_book_api).returns(read_file('yh_contacts.txt'))
19
+
20
+ redirect_path = '/?appid=i%3DB%26p%3DUw70JGIdHWVRbpqYItcMw--&token=AB.KoEg8vBwvJKFkwfcDTJEMKhGeAD6KhiDe0aZLCvoJzMeQG00-&appdata=&ts=1218501215&sig=d381fba89c7e9d3c14788720733c3fbf'
21
+
22
+ results = @yahoo.contacts(redirect_path)
23
+ results.should have_contact('Hugo Barauna', 'hugo.barauna@gmail.com')
24
+ results.should have_contact('Nina Benchimol', 'nina@hotmail.com')
25
+ results.should have_contact('Andrea Dimitri', 'and@yahoo.com')
26
+ results.should have_contact('Ricardo Fiorelli', 'ricardo@poli.usp.br')
27
+ results.should have_contact('Priscila', 'pizinha@yahoo.com.br')
28
+ end
29
+
30
+ it 'should validate yahoo redirect signature' do
31
+ redirect_path = '/?appid=i%3DB%26p%3DUw70JGIdHWVRbpqYItcMw--&token=AB.KoEg8vBwvJKFkwfcDTJEMKhGeAD6KhiDe0aZLCvoJzMeQG00-&appdata=&ts=1218501215&sig=d381fba89c7e9d3c14788720733c3fbf'
32
+
33
+ @yahoo.validate_signature(redirect_path).should be_true
34
+ @yahoo.token.should == 'AB.KoEg8vBwvJKFkwfcDTJEMKhGeAD6KhiDe0aZLCvoJzMeQG00-'
35
+ end
36
+
37
+ it 'should detect when the redirect is not valid' do
38
+ redirect_path = '/?appid=i%3DB%26p%3DUw70JGIdHWVRbpqYItcMw--&token=AB.KoEg8vBwvJKFkwfcDTJEMKhGeAD6KhiDe0aZLCvoJzMeQG00-&appdata=&ts=1218501215&sig=de4fe4ebd50a8075f75dcc23f6aca04f'
39
+
40
+ lambda{ @yahoo.validate_signature(redirect_path) }.should raise_error
41
+ end
42
+
43
+ it 'should generate the credential request URL' do
44
+ redirect_path = '/?appid=i%3DB%26p%3DUw70JGIdHWVRbpqYItcMw--&token=AB.KoEg8vBwvJKFkwfcDTJEMKhGeAD6KhiDe0aZLCvoJzMeQG00-&appdata=&ts=1218501215&sig=d381fba89c7e9d3c14788720733c3fbf'
45
+ @yahoo.validate_signature(redirect_path)
46
+
47
+ @yahoo.get_credential_url.should match(/https:\/\/api.login.yahoo.com\/WSLogin\/V1\/wspwtoken_login\?appid=i%3DB%26p%3DUw70JGIdHWVRbpqYItcMw--&ts=.*&token=.*&sig=.*/)
48
+ end
49
+
50
+ it 'should parse the credential XML' do
51
+ @yahoo.parse_credentials(read_file('yh_credential.xml'))
52
+
53
+ @yahoo.wssid.should == 'tr.jZsW/ulc'
54
+ @yahoo.cookie.should == 'Y=cdunlEx76ZEeIdWyeJNOegxfy.jkeoULJCnc7Q0Vr8D5P.u.EE2vCa7G2MwBoULuZhvDZuJNqhHwF3v5RJ4dnsWsEDGOjYV1k6snoln3RlQmx0Ggxs0zAYgbaA4BFQk5ieAkpipq19l6GoD_k8IqXRfJN0Q54BbekC_O6Tj3zl2wV3YQK6Mi2MWBQFSBsO26Tw_1yMAF8saflF9EX1fQl4N.1yBr8UXb6LLDiPQmlISq1_c6S6rFbaOhSZMgO78f2iqZmUAk9RmCHrqPJiHEo.mJlxxHaQsuqTMf7rwLEHqK__Gi_bLypGtaslqeWyS0h2J.B5xwRC8snfEs3ct_kLXT3ngP_pK3MeMf2pe1TiJ4JXVciY9br.KJFUgNd4J6rmQsSFj4wPLoMGCETfVc.M8KLiaFHasZqXDyCE7tvd1khAjQ_xLfQKlg1GlBOWmbimQ1FhdHnsVj3svXjEGquRh8JI2sHIQrzoiqAPBf9WFKQcH0t_1dxf4MOH.7gJaYDPEozCW5EcCsYjuHup9xJKxyTddh5pk8yUg5bURzA.TwPalExMKsbv.RWFBhzWKuTp5guNcqjmUHcCoT19_qFENHX41Xf3texAnsDDGj'
55
+ end
56
+
57
+ it 'should parse the contacts json response' do
58
+ json = read_file('yh_contacts.txt')
59
+
60
+ Contacts::Yahoo.parse_contacts(json).should have_contact('Hugo Barauna', 'hugo.barauna@gmail.com')
61
+ Contacts::Yahoo.parse_contacts(json).should have_contact('Nina Benchimol', 'nina@hotmail.com')
62
+ Contacts::Yahoo.parse_contacts(json).should have_contact('Andrea Dimitri', 'and@yahoo.com')
63
+ Contacts::Yahoo.parse_contacts(json).should have_contact('Ricardo Fiorelli', 'ricardo@poli.usp.br')
64
+ Contacts::Yahoo.parse_contacts(json).should have_contact('Priscila', 'pizinha@yahoo.com.br')
65
+ end
66
+
67
+ it 'should can be initialized by a YAML file' do
68
+ @yahoo.appid.should == 'i%3DB%26p%3DUw70JGIdHWVRbpqYItcMw--'
69
+ @yahoo.secret.should == 'a34f389cbd135de4618eed5e23409d34450'
70
+ end
71
+
72
+ def read_file(file)
73
+ File.open(@path + file, 'r+').read
74
+ end
75
+
76
+ def have_contact(name, email)
77
+ matcher_class = Class.new()
78
+ matcher_class.instance_eval do
79
+ define_method(:matches?) {|some_contacts| some_contacts.any? {|a_contact| a_contact.name == name && a_contact.emails.include?(email)}}
80
+ end
81
+ matcher_class.new
82
+ end
83
+ end
@@ -0,0 +1,80 @@
1
+ fakeweb (development)
2
+
3
+ * remove an unnecessary redefinition of OpenURI::HTTPError [Josh Nichols]
4
+
5
+ * rearrange implementation code into separate files, one per class [Josh Nichols]
6
+
7
+ * Fix a bug where FakeWeb.response_for would raise if the request wasn't
8
+ registered [Chris Kampmeier]
9
+
10
+ * add HTTP method support, so FakeWeb takes both the URI and method into
11
+ account for registration, requests, and responses. Backwards-compatible with
12
+ the old method signatures, which didn't have a method param. [Chris Kampmeier]
13
+
14
+ * start work on Ruby 1.9 compatibility [Chris Kampmeier]
15
+
16
+ * add FakeWeb.allow_net_connect= to enable/disable the pass-through to
17
+ Net::HTTP for unregistered URIs [Mislav Marohnić, Chris Kampmeier]
18
+
19
+ * remove setup.rb, since most people use RubyGems [Mislav Marohnić]
20
+
21
+ * fix that 'http://example.com/?' (empty query) matches a registered
22
+ 'http://example.com/', and vice-versa [Mislav Marohnić]
23
+
24
+ * improve the test suite to not rely on an internet connection [Chris Kampmeier]
25
+
26
+ * use `rake test` instead of `rake tests` [Josh Nichols]
27
+
28
+ * fix an incompatibility with Ruby 1.8.6 p36 where you'd get "Errno::EINTR:
29
+ Interrupted system call" exceptions in Socket#sysread for any non-faked
30
+ request [Chris Kampmeier]
31
+
32
+ * response rotation: you can now optionally call FakeWeb.register_uri with an
33
+ array of options hashes; these are used, in order, to respond to
34
+ repeated requests (to repeat a response more than once before rotating, use
35
+ the :times option). Once you run out of responses, further requests always
36
+ receive the last response. [Michael Shapiro]
37
+
38
+ * add support for Net::HTTP's undocumented full-URI request style (fixes
39
+ URI::InvalidURIErrors that you might see in older libraries) [Chris Kampmeier]
40
+
41
+ * sort query params before storing internally, so that
42
+ http://example.com/?a=1&b=2 and http://example.com/?b=2&a=1 are considered the
43
+ same URL (although this is technically incorrect, it's much more
44
+ convenient--most web apps work that way, and Net::HTTP's use of a hash to pass
45
+ query params means that the order in which FakeWeb stores them can be
46
+ unpredictable) [Chris Kampmeier]
47
+
48
+ * add support for ports in URLs, so that http://example.com/ and
49
+ http://example.com:3000/ are not the same [Chris Kampmeier]
50
+
51
+ * fix for non-faked SSL requests failing with "Unable to create local socket"
52
+ [Chris Kampmeier]
53
+
54
+ * update Rakefile to fix warning about deprecated code [Chris Kampmeier]
55
+
56
+
57
+ fakeweb (1.1.2)
58
+
59
+ * add required dependencies to GemSpec to ensure that tests pass in firebrigade
60
+ (http://firebrigade.seattlerb.org/) [Blaine Cook]
61
+
62
+
63
+ fakeweb (1.1.1)
64
+
65
+ * fix for non-existence of :string method on File as presented by open-uri
66
+ [Blaine Cook]
67
+
68
+ * fix for curl example test - google redirects to ccTLDs for those outside US
69
+ [Blaine Cook]
70
+
71
+
72
+ fakeweb (1.1.0)
73
+
74
+ * update code to correspond to ruby 1.8.4 (breaks compatibility with ruby 1.8.2)
75
+ [Blaine Cook]
76
+
77
+
78
+ fakeweb (1.0.0)
79
+
80
+ * initial import [Blaine Cook]
@@ -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
+
@@ -0,0 +1,160 @@
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
+ == Installation
7
+
8
+ This fork of Blaine Cook's original code has lots of fixes, stability
9
+ improvements, and a few new features. To get it, install the latest gem
10
+ directly from GitHub (currently 1.1.2.6):
11
+
12
+ sudo gem install chrisk-fakeweb --source http://gems.github.com
13
+
14
+ <b>Warning:</b> this +README+ goes with the latest development version, which
15
+ has significant API changes. If you're using 1.1.2.6, please see the +README+
16
+ for that release here: http://github.com/chrisk/fakeweb/tree/ff14175b8f
17
+
18
+ == Development Notes
19
+
20
+ We're currently considering how the API should change to add support for
21
+ request bodies (see Known Issues below). Your input might be really helpful:
22
+ see http://fakeweb.lighthouseapp.com/projects/22985/tickets/1 for a discussion
23
+ of some different options. Thanks!
24
+
25
+ == Examples
26
+
27
+ Start by requiring FakeWeb:
28
+
29
+ require 'rubygems'
30
+ require 'fake_web'
31
+
32
+ === Registering basic string responses
33
+
34
+ FakeWeb.register_uri(:get, "http://example.com/test1", :string => "Hello World!")
35
+
36
+ Net::HTTP.get(URI.parse("http://example.com/test1"))
37
+ => "Hello World!"
38
+
39
+ Net::HTTP.get(URI.parse("http://example.com/test2"))
40
+ => FakeWeb is bypassed and the response from a real request is returned
41
+
42
+ === Replaying a recorded response
43
+
44
+ page = `curl -is http://www.google.com/`
45
+ FakeWeb.register_uri(:get, "http://www.google.com/", :response => page)
46
+
47
+ Net::HTTP.get(URI.parse("http://www.google.com/"))
48
+ # => Full response, including headers
49
+
50
+ === Adding a custom status to the response
51
+
52
+ FakeWeb.register_uri(:get, "http://example.com/", :string => "Nothing to be found 'round here",
53
+ :status => ["404", "Not Found"])
54
+
55
+ Net::HTTP.start("example.com") do |req|
56
+ response = req.get("/")
57
+ response.code # => "404"
58
+ response.message # => "Not Found"
59
+ response.body # => "Nothing to be found 'round here"
60
+ end
61
+
62
+ === Responding to any HTTP method
63
+
64
+ FakeWeb.register_uri(:any, "http://example.com", :string => "response for any HTTP method")
65
+
66
+ If you use the <tt>:any</tt> symbol, the URI you specify will be completely
67
+ stubbed out (regardless of the HTTP method of the request). This can be useful
68
+ for RPC-like services, where the HTTP method isn't significant. (Older
69
+ versions of FakeWeb always behaved like this, and didn't accept the first
70
+ +method+ argument above; this syntax is still supported, for
71
+ backwards-compatibility, but it will probably be deprecated at some point.)
72
+
73
+ === Rotating responses
74
+
75
+ You can optionally call FakeWeb.register_uri with an array of options hashes;
76
+ these are used, in order, to respond to repeated requests. Once you run out of
77
+ responses, further requests always receive the last response. (You can also send
78
+ a response more than once before rotating, by specifying a <tt>:times</tt>
79
+ option for that response.)
80
+
81
+ FakeWeb.register_uri(:delete, "http://example.com/posts/1",
82
+ [{:string => "Post 1 deleted.", :status => ["200", "OK"]},
83
+ {:string => "Post not found", :status => ["404", "Not Found"]}])
84
+
85
+ Net::HTTP.start("example.com") do |req|
86
+ req.delete("/posts/1").body # => "Post 1 deleted"
87
+ req.delete("/posts/1").body # => "Post not found"
88
+ req.delete("/posts/1").body # => "Post not found"
89
+ end
90
+
91
+ === Clearing registered URIs
92
+
93
+ The FakeWeb registry is a singleton that lasts for the duration of your
94
+ program, maintaining every fake response you register. If needed, you
95
+ can clean out the registry and remove all registered URIs:
96
+
97
+ FakeWeb.clean_registry
98
+
99
+ === Blocking all real requests
100
+
101
+ When you're using FakeWeb to replace _all_ of your requests, it's useful to
102
+ catch when requests are made for unregistered URIs (unlike the default
103
+ behavior, which is to pass those requests through to Net::HTTP as usual).
104
+
105
+ FakeWeb.allow_net_connect = false
106
+ Net::HTTP.get(URI.parse("http://example.com/"))
107
+ => raises FakeWeb::NetConnectNotAllowedError
108
+
109
+ FakeWeb.allow_net_connect = true
110
+ Net::HTTP.get(URI.parse("http://example.com/"))
111
+ => FakeWeb is bypassed and the response from a real request is returned
112
+
113
+ This is handy when you want to make sure your tests are self-contained, or you
114
+ want to catch the scenario when a URI is changed in implementation code
115
+ without a corresponding test change.
116
+
117
+ == More info
118
+
119
+ FakeWeb lets you decouple your test environment from live services without
120
+ modifying code or writing extensive stubs.
121
+
122
+ In addition to the conceptual advantage of having idempotent request
123
+ behaviour, FakeWeb makes tests run faster than if they were made to remote (or
124
+ even local) web servers. It also makes it possible to run tests without a
125
+ network connection or in situations where the server is behind a firewall or
126
+ has host-based access controls.
127
+
128
+ FakeWeb works with anything based on Net::HTTP--both higher-level wrappers,
129
+ like OpenURI, as well as a ton of libraries for popular web services.
130
+
131
+
132
+ == Known Issues
133
+
134
+ * Request bodies are ignored, including PUT and POST parameters. If you need
135
+ different responses for different request bodies, you need to request
136
+ different URLs, and register different responses for each. (Query strings
137
+ are fully supported, though.)
138
+
139
+
140
+ == Copyright
141
+
142
+ Copyright 2006-2007 Blaine Cook
143
+
144
+ Copyright 2008-2009 various contributors
145
+
146
+ FakeWeb is free software; you can redistribute it and/or modify it under the
147
+ terms of the GNU General Public License as published by the Free Software
148
+ Foundation; either version 2 of the License, or (at your option) any later
149
+ version.
150
+
151
+ FakeWeb is distributed in the hope that it will be useful, but WITHOUT ANY
152
+ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
153
+ FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
154
+ details.
155
+
156
+ You should have received a copy of the GNU General Public License along
157
+ with FakeWeb; if not, write to the Free Software Foundation, Inc., 51
158
+ Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
159
+
160
+ See LICENSE.txt[link:files/LICENSE_txt.html] for the full terms.