-
Notifications
You must be signed in to change notification settings - Fork 968
/
httparty_spec.rb
637 lines (533 loc) · 20.1 KB
/
httparty_spec.rb
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
describe HTTParty do
before(:each) do
@klass = Class.new
@klass.instance_eval { include HTTParty }
end
describe "AllowedFormats deprecated" do
before do
Kernel.stub(:warn)
end
it "warns with a deprecation message" do
Kernel.should_receive(:warn).with("Deprecated: Use HTTParty::Parser::SupportedFormats")
HTTParty::AllowedFormats
end
it "returns HTTPart::Parser::SupportedFormats" do
HTTParty::AllowedFormats.should == HTTParty::Parser::SupportedFormats
end
end
describe "pem" do
it 'should set the pem content' do
@klass.pem 'PEM-CONTENT'
@klass.default_options[:pem].should == 'PEM-CONTENT'
end
it "should set the password to nil if it's not provided" do
@klass.pem 'PEM-CONTENT'
@klass.default_options[:pem_password].should be_nil
end
it 'should set the password' do
@klass.pem 'PEM-CONTENT', 'PASSWORD'
@klass.default_options[:pem_password].should == 'PASSWORD'
end
end
describe 'http_proxy' do
it 'should set the address' do
@klass.http_proxy 'proxy.foo.com', 80
options = @klass.default_options
options[:http_proxyaddr].should == 'proxy.foo.com'
options[:http_proxyport].should == 80
end
it 'should set the proxy user and pass when they are provided' do
@klass.http_proxy 'proxy.foo.com', 80, 'user', 'pass'
options = @klass.default_options
options[:http_proxyuser].should == 'user'
options[:http_proxypass].should == 'pass'
end
end
describe "base uri" do
before(:each) do
@klass.base_uri('api.foo.com/v1')
end
it "should have reader" do
@klass.base_uri.should == 'http://api.foo.com/v1'
end
it 'should have writer' do
@klass.base_uri('http://api.foobar.com')
@klass.base_uri.should == 'http://api.foobar.com'
end
it 'should not modify the parameter during assignment' do
uri = 'http://api.foobar.com'
@klass.base_uri(uri)
uri.should == 'http://api.foobar.com'
end
end
describe ".disable_rails_query_string_format" do
it "sets the query string normalizer to HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER" do
@klass.disable_rails_query_string_format
@klass.default_options[:query_string_normalizer].should == HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER
end
end
describe ".normalize_base_uri" do
it "should add http if not present for non ssl requests" do
uri = HTTParty.normalize_base_uri('api.foobar.com')
uri.should == 'http://api.foobar.com'
end
it "should add https if not present for ssl requests" do
uri = HTTParty.normalize_base_uri('api.foo.com/v1:443')
uri.should == 'https://api.foo.com/v1:443'
end
it "should not remove https for ssl requests" do
uri = HTTParty.normalize_base_uri('https://api.foo.com/v1:443')
uri.should == 'https://api.foo.com/v1:443'
end
it 'should not modify the parameter' do
uri = 'http://api.foobar.com'
HTTParty.normalize_base_uri(uri)
uri.should == 'http://api.foobar.com'
end
end
describe "headers" do
def expect_headers(header={})
HTTParty::Request.should_receive(:new) \
.with(anything, anything, hash_including({ :headers => header })) \
.and_return(mock("mock response", :perform => nil))
end
it "should default to empty hash" do
@klass.headers.should == {}
end
it "should be able to be updated" do
init_headers = {:foo => 'bar', :baz => 'spax'}
@klass.headers init_headers
@klass.headers.should == init_headers
end
it "uses the class headers when sending a request" do
expect_headers(:foo => 'bar')
@klass.headers(:foo => 'bar')
@klass.get('')
end
it "overwrites class headers when passing in headers" do
expect_headers(:baz => 'spax')
@klass.headers(:foo => 'bar')
@klass.get('', :headers => {:baz => 'spax'})
end
context "with cookies" do
it 'utilizes the class-level cookies' do
expect_headers(:foo => 'bar', 'cookie' => 'type=snickerdoodle')
@klass.headers(:foo => 'bar')
@klass.cookies(:type => 'snickerdoodle')
@klass.get('')
end
it 'adds cookies to the headers' do
expect_headers(:foo => 'bar', 'cookie' => 'type=snickerdoodle')
@klass.headers(:foo => 'bar')
@klass.get('', :cookies => {:type => 'snickerdoodle'})
end
it 'adds optional cookies to the optional headers' do
expect_headers(:baz => 'spax', 'cookie' => 'type=snickerdoodle')
@klass.get('', :cookies => {:type => 'snickerdoodle'}, :headers => {:baz => 'spax'})
end
end
end
describe "cookies" do
def expect_cookie_header(s)
HTTParty::Request.should_receive(:new) \
.with(anything, anything, hash_including({ :headers => { "cookie" => s } })) \
.and_return(mock("mock response", :perform => nil))
end
it "should not be in the headers by default" do
HTTParty::Request.stub!(:new).and_return(stub(nil, :perform => nil))
@klass.get("")
@klass.headers.keys.should_not include("cookie")
end
it "should raise an ArgumentError if passed a non-Hash" do
lambda do
@klass.cookies("nonsense")
end.should raise_error(ArgumentError)
end
it "should allow a cookie to be specified with a one-off request" do
expect_cookie_header "type=snickerdoodle"
@klass.get("", :cookies => { :type => "snickerdoodle" })
end
describe "when a cookie is set at the class level" do
before(:each) do
@klass.cookies({ :type => "snickerdoodle" })
end
it "should include that cookie in the request" do
expect_cookie_header "type=snickerdoodle"
@klass.get("")
end
it "should pass the proper cookies when requested multiple times" do
2.times do
expect_cookie_header "type=snickerdoodle"
@klass.get("")
end
end
it "should allow the class defaults to be overridden" do
expect_cookie_header "type=chocolate_chip"
@klass.get("", :cookies => { :type => "chocolate_chip" })
end
end
describe "in a class with multiple methods that use different cookies" do
before(:each) do
@klass.instance_eval do
def first_method
get("first_method", :cookies => { :first_method_cookie => "foo" })
end
def second_method
get("second_method", :cookies => { :second_method_cookie => "foo" })
end
end
end
it "should not allow cookies used in one method to carry over into other methods" do
expect_cookie_header "first_method_cookie=foo"
@klass.first_method
expect_cookie_header "second_method_cookie=foo"
@klass.second_method
end
end
end
describe "default params" do
it "should default to empty hash" do
@klass.default_params.should == {}
end
it "should be able to be updated" do
new_defaults = {:foo => 'bar', :baz => 'spax'}
@klass.default_params new_defaults
@klass.default_params.should == new_defaults
end
end
describe "default timeout" do
it "should default to nil" do
@klass.default_options[:timeout].should == nil
end
it "should support updating" do
@klass.default_timeout 10
@klass.default_options[:timeout].should == 10
end
it "should support floats" do
@klass.default_timeout 0.5
@klass.default_options[:timeout].should == 0.5
end
end
describe "debug_output" do
it "stores the given stream as a default_option" do
@klass.debug_output $stdout
@klass.default_options[:debug_output].should == $stdout
end
it "stores the $stderr stream by default" do
@klass.debug_output
@klass.default_options[:debug_output].should == $stderr
end
end
describe "basic http authentication" do
it "should work" do
@klass.basic_auth 'foobar', 'secret'
@klass.default_options[:basic_auth].should == {:username => 'foobar', :password => 'secret'}
end
end
describe "digest http authentication" do
it "should work" do
@klass.digest_auth 'foobar', 'secret'
@klass.default_options[:digest_auth].should == {:username => 'foobar', :password => 'secret'}
end
end
describe "parser" do
class CustomParser
def self.parse(body)
return {:sexy => true}
end
end
let(:parser) do
Proc.new{ |data, format| CustomParser.parse(data) }
end
it "should set parser options" do
@klass.parser parser
@klass.default_options[:parser].should == parser
end
it "should be able parse response with custom parser" do
@klass.parser parser
FakeWeb.register_uri(:get, 'http://twitter.com/statuses/public_timeline.xml', :body => 'tweets')
custom_parsed_response = @klass.get('http://twitter.com/statuses/public_timeline.xml')
custom_parsed_response[:sexy].should == true
end
it "raises UnsupportedFormat when the parser cannot handle the format" do
@klass.format :json
class MyParser < HTTParty::Parser
SupportedFormats = {}
end unless defined?(MyParser)
expect do
@klass.parser MyParser
end.to raise_error(HTTParty::UnsupportedFormat)
end
it 'does not validate format whe custom parser is a proc' do
expect do
@klass.format :json
@klass.parser lambda {|body, format|}
end.to_not raise_error(HTTParty::UnsupportedFormat)
end
end
describe "format" do
it "should allow xml" do
@klass.format :xml
@klass.default_options[:format].should == :xml
end
it "should allow json" do
@klass.format :json
@klass.default_options[:format].should == :json
end
it "should allow yaml" do
@klass.format :yaml
@klass.default_options[:format].should == :yaml
end
it "should allow plain" do
@klass.format :plain
@klass.default_options[:format].should == :plain
end
it 'should not allow funky format' do
lambda do
@klass.format :foobar
end.should raise_error(HTTParty::UnsupportedFormat)
end
it 'should only print each format once with an exception' do
lambda do
@klass.format :foobar
end.should raise_error(HTTParty::UnsupportedFormat, "':foobar' Must be one of: html, json, plain, xml, yaml")
end
it 'sets the default parser' do
@klass.default_options[:parser].should be_nil
@klass.format :json
@klass.default_options[:parser].should == HTTParty::Parser
end
it 'does not reset parser to the default parser' do
my_parser = lambda {}
@klass.parser my_parser
@klass.format :json
@klass.parser.should == my_parser
end
end
describe "#no_follow" do
it "sets no_follow to false by default" do
@klass.no_follow
@klass.default_options[:no_follow].should be_false
end
it "sets the no_follow option to true" do
@klass.no_follow true
@klass.default_options[:no_follow].should be_true
end
end
describe "#maintain_method_across_redirects" do
it "sets maintain_method_across_redirects to true by default" do
@klass.maintain_method_across_redirects
@klass.default_options[:maintain_method_across_redirects].should be_true
end
it "sets the maintain_method_across_redirects option to false" do
@klass.maintain_method_across_redirects false
@klass.default_options[:maintain_method_across_redirects].should be_false
end
end
describe ".follow_redirects" do
it "sets follow redirects to true by default" do
@klass.follow_redirects
@klass.default_options[:follow_redirects].should be_true
end
it "sets the follow_redirects option to false" do
@klass.follow_redirects false
@klass.default_options[:follow_redirects].should be_false
end
end
describe ".query_string_normalizer" do
it "sets the query_string_normalizer option" do
normalizer = proc {}
@klass.query_string_normalizer normalizer
@klass.default_options[:query_string_normalizer].should == normalizer
end
end
describe "with explicit override of automatic redirect handling" do
before do
@request = HTTParty::Request.new(Net::HTTP::Get, 'http://api.foo.com/v1', :format => :xml, :no_follow => true)
@redirect = stub_response 'first redirect', 302
@redirect['location'] = 'http://foo.com/bar'
HTTParty::Request.stub(:new => @request)
end
it "should fail with redirected GET" do
lambda do
@error = @klass.get('/foo', :no_follow => true)
end.should raise_error(HTTParty::RedirectionTooDeep) {|e| e.response.body.should == 'first redirect'}
end
it "should fail with redirected POST" do
lambda do
@klass.post('/foo', :no_follow => true)
end.should raise_error(HTTParty::RedirectionTooDeep) {|e| e.response.body.should == 'first redirect'}
end
it "should fail with redirected DELETE" do
lambda do
@klass.delete('/foo', :no_follow => true)
end.should raise_error(HTTParty::RedirectionTooDeep) {|e| e.response.body.should == 'first redirect'}
end
it "should fail with redirected PUT" do
lambda do
@klass.put('/foo', :no_follow => true)
end.should raise_error(HTTParty::RedirectionTooDeep) {|e| e.response.body.should == 'first redirect'}
end
it "should fail with redirected HEAD" do
lambda do
@klass.head('/foo', :no_follow => true)
end.should raise_error(HTTParty::RedirectionTooDeep) {|e| e.response.body.should == 'first redirect'}
end
it "should fail with redirected OPTIONS" do
lambda do
@klass.options('/foo', :no_follow => true)
end.should raise_error(HTTParty::RedirectionTooDeep) {|e| e.response.body.should == 'first redirect'}
end
end
describe "with multiple class definitions" do
before(:each) do
@klass.instance_eval do
base_uri "http://first.com"
default_params :one => 1
end
@additional_klass = Class.new
@additional_klass.instance_eval do
include HTTParty
base_uri "http://second.com"
default_params :two => 2
end
end
it "should not run over each others options" do
@klass.default_options.should == { :base_uri => 'http://first.com', :default_params => { :one => 1 } }
@additional_klass.default_options.should == { :base_uri => 'http://second.com', :default_params => { :two => 2 } }
end
end
describe "two child classes inheriting from one parent" do
before(:each) do
@parent = Class.new do
include HTTParty
def self.name
"Parent"
end
end
@child1 = Class.new(@parent)
@child2 = Class.new(@parent)
end
it "does not modify each others inherited attributes" do
@child1.default_params :joe => "alive"
@child2.default_params :joe => "dead"
@child1.default_options.should == { :default_params => {:joe => "alive"} }
@child2.default_options.should == { :default_params => {:joe => "dead"} }
@parent.default_options.should == { }
end
it "inherits default_options from the superclass" do
@parent.basic_auth 'user', 'password'
@child1.default_options.should == {:basic_auth => {:username => 'user', :password => 'password'}}
@child1.basic_auth 'u', 'p' # modifying child1 has no effect on child2
@child2.default_options.should == {:basic_auth => {:username => 'user', :password => 'password'}}
end
it "doesn't modify the parent's default options" do
@parent.basic_auth 'user', 'password'
@child1.basic_auth 'u', 'p'
@child1.default_options.should == {:basic_auth => {:username => 'u', :password => 'p'}}
@child1.basic_auth 'email', 'token'
@child1.default_options.should == {:basic_auth => {:username => 'email', :password => 'token'}}
@parent.default_options.should == {:basic_auth => {:username => 'user', :password => 'password'}}
end
it "inherits default_cookies from the parent class" do
@parent.cookies 'type' => 'chocolate_chip'
@child1.default_cookies.should == {"type" => "chocolate_chip"}
@child1.cookies 'type' => 'snickerdoodle'
@child1.default_cookies.should == {"type" => "snickerdoodle"}
@child2.default_cookies.should == {"type" => "chocolate_chip"}
end
it "doesn't modify the parent's default cookies" do
@parent.cookies 'type' => 'chocolate_chip'
@child1.cookies 'type' => 'snickerdoodle'
@child1.default_cookies.should == {"type" => "snickerdoodle"}
@parent.default_cookies.should == {"type" => "chocolate_chip"}
end
end
describe "grand parent with inherited callback" do
before do
@grand_parent = Class.new do
def self.inherited(subclass)
subclass.instance_variable_set(:@grand_parent, true)
end
end
@parent = Class.new(@grand_parent) do
include HTTParty
end
end
it "continues running the #inherited on the parent" do
child = Class.new(@parent)
child.instance_variable_get(:@grand_parent).should be_true
end
end
describe "#get" do
it "should be able to get html" do
stub_http_response_with('google.html')
HTTParty.get('http://www.google.com').should == file_fixture('google.html')
end
it "should be able parse response type json automatically" do
stub_http_response_with('twitter.json')
tweets = HTTParty.get('http://twitter.com/statuses/public_timeline.json')
tweets.size.should == 20
tweets.first['user'].should == {
"name" => "Pyk",
"url" => nil,
"id" => "7694602",
"description" => nil,
"protected" => false,
"screen_name" => "Pyk",
"followers_count" => 1,
"location" => "Opera Plaza, California",
"profile_image_url" => "http://static.twitter.com/images/default_profile_normal.png"
}
end
it "should be able parse response type xml automatically" do
stub_http_response_with('twitter.xml')
tweets = HTTParty.get('http://twitter.com/statuses/public_timeline.xml')
tweets['statuses'].size.should == 20
tweets['statuses'].first['user'].should == {
"name" => "Magic 8 Bot",
"url" => nil,
"id" => "17656026",
"description" => "ask me a question",
"protected" => "false",
"screen_name" => "magic8bot",
"followers_count" => "90",
"profile_image_url" => "http://s3.amazonaws.com/twitter_production/profile_images/65565851/8ball_large_normal.jpg",
"location" => nil
}
end
it "should not get undefined method add_node for nil class for the following xml" do
stub_http_response_with('undefined_method_add_node_for_nil.xml')
result = HTTParty.get('http://foobar.com')
result.should == {"Entities"=>{"href"=>"https://s3-sandbox.parature.com/api/v1/5578/5633/Account", "results"=>"0", "total"=>"0", "page_size"=>"25", "page"=>"1"}}
end
it "should parse empty response fine" do
stub_http_response_with('empty.xml')
result = HTTParty.get('http://foobar.com')
result.should be_nil
end
it "should accept http URIs" do
stub_http_response_with('google.html')
lambda do
HTTParty.get('http://google.com')
end.should_not raise_error(HTTParty::UnsupportedURIScheme)
end
it "should accept https URIs" do
stub_http_response_with('google.html')
lambda do
HTTParty.get('https://google.com')
end.should_not raise_error(HTTParty::UnsupportedURIScheme)
end
it "should raise an ArgumentError on URIs that are not http or https" do
lambda do
HTTParty.get("file:///there_is_no_party_on/my/filesystem")
end.should raise_error(HTTParty::UnsupportedURIScheme)
end
it "should raise an InvalidURIError on URIs that can't be parsed at all" do
lambda do
HTTParty.get("It's the one that says 'Bad URI'")
end.should raise_error(URI::InvalidURIError)
end
end
end