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
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
|
=begin
= net/http.rb
Copyright (c) 1999-2003 Yukihiro Matsumoto
Copyright (c) 1999-2003 Minero Aoki
written & maintained by Minero Aoki <aamine@loveruby.net>.
This file is derived from "http-access.rb".
This program is free software. You can re-distribute and/or
modify this program under the same terms of ruby itself ---
Ruby Distribute License or GNU General Public License.
NOTE: You can find Japanese version of this document here:
((<URL:http://www.ruby-lang.org/ja/man-1.6/?cmd=view;name=net%2Fhttp.rb>))
$Id$
== What Is This Library?
This library provides your program functions to access WWW
documents via HTTP, Hyper Text Transfer Protocol version 1.1.
For details of HTTP, refer [RFC2616]
((<URL:http://www.ietf.org/rfc/rfc2616.txt>)).
== Examples
=== Getting Document From WWW Server
(formal version)
require 'net/http'
Net::HTTP.start('www.example.com', 80) {|http|
response = http.get('/index.html')
puts response.body
}
(shorter version)
require 'net/http'
Net::HTTP.get_print 'www.example.com', '/index.html'
or
require 'net/http'
require 'uri'
Net::HTTP.get_print URI.parse('http://www.example.com/index.html')
=== Posting Form Data
require 'net/http'
Net::HTTP.start('some.www.server', 80) {|http|
response = http.post('/cgi-bin/search.rb', 'query=ruby')
}
=== Accessing via Proxy
Net::HTTP.Proxy creates http proxy class. It has same
methods of Net::HTTP but its instances always connect to
proxy, instead of given host.
require 'net/http'
proxy_addr = 'your.proxy.host'
proxy_port = 8080
:
Net::HTTP::Proxy(proxy_addr, proxy_port).start('www.example.com') {|http|
# always connect to your.proxy.addr:8080
:
}
Since Net::HTTP.Proxy returns Net::HTTP itself when proxy_addr is nil,
there's no need to change code if there's proxy or not.
There are two additional parameters in Net::HTTP.Proxy which allow to
specify proxy user name and password:
Net::HTTP::Proxy(proxy_addr, proxy_port, proxy_user = nil, proxy_pass = nil)
You may use them to work with authorization-enabled proxies:
require 'net/http'
require 'uri'
proxy_host = 'your.proxy.host'
proxy_port = 8080
uri = URI.parse(ENV['http_proxy'])
proxy_user, proxy_pass = uri.userinfo.split(/:/) if uri.userinfo
Net::HTTP::Proxy(proxy_host, proxy_port,
proxy_user, proxy_pass).start('www.example.com') {|http|
# always connect to your.proxy.addr:8080 using specified username and password
:
}
=== Following Redirection
require 'net/http'
require 'uri'
def fetch( uri_str, limit = 10 )
# You should choose better exception.
raise ArgumentError, 'http redirect too deep' if limit == 0
response = Net::HTTP.get_response(URI.parse(uri_str))
case response
when Net::HTTPSuccess then response
when Net::HTTPRedirection then fetch(response['location'], limit - 1)
else
response.error!
end
end
print fetch('http://www.ruby-lang.org')
Net::HTTPSuccess and Net::HTTPRedirection is a HTTPResponse class.
All HTTPResponse objects belong to its own response class which
indicate HTTP result status. For details of response classes,
see section "HTTP Response Classes".
=== Basic Authentication
require 'net/http'
Net::HTTP.start('www.example.com') {|http|
req = Net::HTTP::Get.new('/secret-page.html')
req.basic_auth 'account', 'password'
response = http.request(req)
print response.body
}
=== HTTP Response Classes
Followings are sub classes of Net::HTTPResponse. All classes are
defined under the Net module. Indentation indicates inheritance.
xxx HTTPResponse
1xx HTTPInformation
100 HTTPContinue
101 HTTPSwitchProtocol
2xx HTTPSuccess
200 HTTPOK
201 HTTPCreated
202 HTTPAccepted
203 HTTPNonAuthoritativeInformation
204 HTTPNoContent
205 HTTPResetContent
206 HTTPPartialContent
3xx HTTPRedirection
300 HTTPMultipleChoice
301 HTTPMovedPermanently
302 HTTPFound
303 HTTPSeeOther
304 HTTPNotModified
305 HTTPUseProxy
307 HTTPTemporaryRedirect
4xx HTTPClientError
400 HTTPBadRequest
401 HTTPUnauthorized
402 HTTPPaymentRequired
403 HTTPForbidden
404 HTTPNotFound
405 HTTPMethodNotAllowed
406 HTTPNotAcceptable
407 HTTPProxyAuthenticationRequired
408 HTTPRequestTimeOut
409 HTTPConflict
410 HTTPGone
411 HTTPLengthRequired
412 HTTPPreconditionFailed
413 HTTPRequestEntityTooLarge
414 HTTPRequestURITooLong
415 HTTPUnsupportedMediaType
416 HTTPRequestedRangeNotSatisfiable
417 HTTPExpectationFailed
5xx HTTPServerError
500 HTTPInternalServerError
501 HTTPNotImplemented
502 HTTPBadGateway
503 HTTPServiceUnavailable
504 HTTPGatewayTimeOut
505 HTTPVersionNotSupported
xxx HTTPUnknownResponse
== Switching Net::HTTP versions
You can use net/http.rb 1.1 features (bundled with Ruby 1.6)
by calling HTTP.version_1_1. Calling Net::HTTP.version_1_2
allows you to use 1.2 features again.
# example
Net::HTTP.start {|http1| ...(http1 has 1.2 features)... }
Net::HTTP.version_1_1
Net::HTTP.start {|http2| ...(http2 has 1.1 features)... }
Net::HTTP.version_1_2
Net::HTTP.start {|http3| ...(http3 has 1.2 features)... }
This function is not multithread-safe.
== class Net::HTTP
=== Class Methods
: new( address, port = 80, proxy_addr = nil, proxy_port = nil )
creates a new Net::HTTP object.
If proxy_addr is given, creates an Net::HTTP object with proxy support.
This method does not open TCP connection.
: start( address, port = 80, proxy_addr = nil, proxy_port = nil )
creates a new Net::HTTP object and returns it
with opening TCP connection and HTTP session.
: start( address, port = 80, proxy_addr = nil, proxy_port = nil ) {|http| .... }
creates a new Net::HTTP object and gives it to the block.
HTTP session is kept to open while the block is exected.
This method returns the return value of the block.
: get_print( uri )
: get_print( host, path, port = 80 )
gets entity body from the target and outputs it to the stdout.
Net::HTTP.get_print URI.parse('http://www.example.com')
: get( uri )
: get( host, path, port = 80 )
send GET request to the target and gets a response.
This method returns a String.
print Net::HTTP.get(URI.parse('http://www.example.com'))
: get_response( uri )
: get_response( address, path, port = 80 )
send GET request to the target and get a response.
This method returns a Net::HTTPResponse object.
res = Net::HTTP.get_response(URI.parse('http://www.example.com'))
print res.body
: Proxy( address, port = 80, username = nil, password = nil )
creates a HTTP proxy class.
Arguments are address/port of proxy host and username/password
if authorization on proxy server is required.
You can replace the HTTP class with created proxy class.
If ADDRESS is nil, this method returns self (Net::HTTP).
# Example
proxy_class = Net::HTTP::Proxy('proxy.example.com', 8080)
:
proxy_class.start('www.ruby-lang.org') {|http|
# connecting proxy.foo.org:8080
:
}
: proxy_class?
return true if self is a class which was created by HTTP::Proxy.
: port
the default HTTP port number (80).
=== Instance Methods
: start
: start {|http| .... }
opens TCP connection and HTTP session.
When this method is called with block, gives a HTTP object
to the block and closes the TCP connection / HTTP session
after the block executed.
: started?
returns true if HTTP session is started.
: address
The host name to connect.
: port
The port number to connect.
: open_timeout
: open_timeout=(n)
seconds to wait until connection is opened.
If HTTP object cannot open a conection in this seconds,
it raises TimeoutError exception.
: read_timeout
: read_timeout=(n)
seconds to wait until reading one block (by one read(1) call).
If HTTP object cannot open a conection in this seconds,
it raises TimeoutError exception.
: finish
finishes HTTP session and closes TCP connection.
If HTTP session had not started, raises an IOError.
: proxy?
true if self is a HTTP proxy class
: proxy_address
address of proxy host. If self does not use a proxy, nil.
: proxy_port
port number of proxy host. If self does not use a proxy, nil.
: proxy_name
user name for accessing proxy. If self does not use a proxy, nil.
: proxy_pass
user password for accessing proxy. If self does not use a proxy, nil.
: get( path, header = nil )
: get( path, header = nil ) {|str| .... }
gets data from PATH on the connecting host.
HEADER must be a Hash like { 'Accept' => '*/*', ... }.
In version 1.1, this method returns a pair of objects,
a Net::HTTPResponse object and entity body string.
In version 1.2, this method returns a Net::HTTPResponse
object.
If called with block, gives entity body string to the block
little by little.
In version 1.1, this method might raises exception for also
3xx (redirect). On the case you can get a HTTPResponse object
by "anException.response".
In version 1.2, this method never raises exception.
# version 1.1 (bundled with Ruby 1.6)
response, body = http.get('/index.html')
# version 1.2 (bundled with Ruby 1.7 or later)
response = http.get('/index.html')
# using block
File.open('result.txt', 'w') {|f|
http.get('/~foo/') do |str|
f.write str
end
}
: head( path, header = nil )
gets only header from PATH on the connecting host.
HEADER is a Hash like { 'Accept' => '*/*', ... }.
This method returns a Net::HTTPResponse object.
In version 1.1, this method might raises exception for also
3xx (redirect). On the case you can get a HTTPResponse object
by "anException.response".
In version 1.2, this method never raises exception.
response = nil
Net::HTTP.start('some.www.server', 80) {|http|
response = http.head('/index.html')
}
p response['content-type']
: post( path, data, header = nil )
: post( path, data, header = nil ) {|str| .... }
posts DATA (must be a String) to PATH. HEADER must be a Hash
like { 'Accept' => '*/*', ... }.
In version 1.1, this method returns a pair of objects, a
Net::HTTPResponse object and an entity body string.
In version 1.2, this method returns a Net::HTTPReponse object.
If called with block, gives a part of entity body string.
In version 1.1, this method might raises exception for also
3xx (redirect). On the case you can get a HTTPResponse object
by "anException.response".
In version 1.2, this method never raises exception.
# version 1.1
response, body = http.post('/cgi-bin/search.rb', 'query=foo')
# version 1.2
response = http.post('/cgi-bin/search.rb', 'query=foo')
# using block
File.open('result.txt', 'w') {|f|
http.post('/cgi-bin/search.rb', 'query=foo') do |str|
f.write str
end
}
: request_get( path, header = nil )
: request_get( path, header = nil ) {|response| .... }
sends GET request to the PATH and get a response,
as a HTTPResponse object.
When called with block, gives a HTTPResponse object to the block
and close the TCP connection after the block is executed.
This method never raises Net::* exceptions.
response = http.request_get('/index.html')
# The entity body is already read here.
p response['content-type']
puts response.body
# using block
http.request_get('/index.html') {|response|
p response['content-type']
response.read_body do |str| # read body now
print str
end
}
: request_post( path, data, header = nil )
: request_post( path, data, header = nil ) {|response| .... }
sends POST request to the PATH and get a response,
as a HTTPResponse object.
When called with block, gives a HTTPResponse object to the block
before reading entity body, with keeping connection.
This method never raises Net::* exceptions.
# example
response = http.request_post('/cgi-bin/nice.rb', 'datadatadata...')
p response.status
puts response.body # body is already read
# using block
http.request_post('/cgi-bin/nice.rb', 'datadatadata...') {|response|
p response.status
p response['content-type']
response.read_body do |str| # read body now
print str
end
}
: request( request, data = nil )
: request( request, data = nil ) {|response| .... }
sends a HTTPRequest object REQUEST to the HTTP server.
This method also sends DATA string if REQUEST is a post/put request.
Giving DATA for get/head request causes ArgumentError.
If called with block, this method passes a HTTPResponse object to
the block, without reading entity body.
This method never raises Net::* exceptions.
== class Net::HTTPRequest
HTTP request class. This class wraps request header and entity path.
You MUST use its subclass, Net::HTTP::Get, Post, Head.
=== Class Methods
: new
creats HTTP request object.
=== Instance Methods
: self[key]
returns the header field corresponding to the case-insensitive key.
For example, a key of "Content-Type" might return "text/html"
: self[key] = val
sets the header field corresponding to the case-insensitive key.
: fetch( key, [, default] )
: fetch( key ) {|key| .... }
returns the header field corresponding to the case-insensitive key.
returns the default value if there's no header field named key.
: each {|name, val| .... }
iterates for each field name and value pair.
: basic_auth( account, password )
set Authorization: header for "Basic" authorization.
: proxy_basic_auth( account, password )
set Proxy-Authorization: header for "Basic" authorization.
: range
returns a Range object which represents Range: header field.
: range = r
: set_range( i, len )
set Range: header from Range (arg r) or beginning index and
length from it (arg i&len).
: content_length
returns a Integer object which represents Content-Length: header field.
: content_range
returns a Range object which represents Content-Range: header field.
== class Net::HTTPResponse
HTTP response class. This class wraps response header and entity.
All arguments named KEY is case-insensitive.
=== Instance Methods
: self[key]
returns the header field corresponding to the case-insensitive key.
For example, a key of "Content-Type" might return "text/html".
A key of "Content-Length" might do "2045".
More than one fields which has same names are joined with ','.
: self[key] = val
sets the header field corresponding to the case-insensitive key.
: fetch( key, [, default] )
: fetch( key ) {|key| .... }
returns the header field corresponding to the case-insensitive key.
returns the default value if there's no header field named key.
: key?( key )
true if key exists.
KEY is case insensitive.
: each {|name,value| .... }
iterates for each field name and value pair.
: canonical_each {|name,value| .... }
iterates for each "canonical" field name and value pair.
: code
HTTP result code string. For example, '302'.
: message
HTTP result message. For example, 'Not Found'.
: read_body( dest = '' )
gets entity body and write it into DEST using "<<" method.
If this method is called twice or more, nothing will be done
and returns first DEST.
: read_body {|str| .... }
gets entity body little by little and pass it to block.
: body
response body. If #read_body has been called, this method returns
arg of #read_body DEST. Else gets body as String and returns it.
=end
require 'net/protocol'
require 'uri'
module Net
class HTTPBadResponse < StandardError; end
class HTTPHeaderSyntaxError < StandardError; end
class HTTP
Revision = %q$Revision$.split[1]
HTTPVersion = '1.1'
#
# for backward compatibility
#
@@newimpl = true
def HTTP.version_1_2
@@newimpl = true
end
def HTTP.version_1_1
@@newimpl = false
end
def HTTP.is_version_1_2?
@@newimpl
end
def HTTP.setimplversion( obj )
f = @@newimpl
obj.instance_eval { @newimpl = f }
end
private_class_method :setimplversion
#
# short cut methods
#
def HTTP.get_print( arg1, arg2 = nil, port = nil )
if arg2
addr, path = arg1, arg2
else
uri = arg1
addr = uri.host
path = uri.request_uri
port = uri.port
end
new(addr, port || HTTP.default_port).start {|http|
http.get path, nil, $stdout
}
nil
end
#
# Use as either of the following:
# Net::HTTP.get(uri)
# Net::HTTP.get(host, path [, port])
#
def HTTP.get( arg1, arg2 = nil, arg3 = nil )
get_response(arg1,arg2,arg3).body
end
def HTTP.get_response( arg1, arg2 = nil, arg3 = nil )
if arg2
get_by_path(arg1, arg2, arg3)
else
get_by_uri(arg1)
end
end
def HTTP.get_by_path( addr, path, port = nil )
new(addr, port || HTTP.default_port).start {|http|
return http.request(Get.new(path))
}
end
private_class_method :get_by_path
def HTTP.get_by_uri( uri )
# Should we allow this?
# uri = URI.parse(uri) unless uri.respond_to?(:host)
new(uri.host, uri.port).start {|http|
return http.request(Get.new(uri.request_uri))
}
end
private_class_method :get_by_uri
#
# HTTP session management
#
def HTTP.default_port
80
end
def HTTP.socket_type
InternetMessageIO
end
class << HTTP
def start( address, port = nil, p_addr = nil, p_port = nil, p_user = nil, p_pass = nil, &block )
new(address, port, p_addr, p_port, p_user, p_pass).start(&block)
end
alias newobj new
def new( address, port = nil, p_addr = nil, p_port = nil, p_user = nil, p_pass = nil )
obj = Proxy(p_addr, p_port, p_user, p_pass).newobj(address, port)
setimplversion obj
obj
end
end
def initialize( address, port = nil )
@address = address
@port = port || HTTP.default_port
@curr_http_version = HTTPVersion
@seems_1_0_server = false
@close_on_empty_response = false
@socket = nil
@started = false
@open_timeout = 30
@read_timeout = 60
@debug_output = nil
end
def inspect
"#<#{self.class} #{@address}:#{@port} open=#{active?}>"
end
def set_debug_output( arg ) # :nodoc:
@debug_output = arg
end
attr_reader :address
attr_reader :port
attr_accessor :open_timeout
attr_reader :read_timeout
def read_timeout=( sec )
@socket.read_timeout = sec if @socket
@read_timeout = sec
end
def started?
@started
end
alias active? started?
attr_accessor :close_on_empty_response
def start
raise IOError, 'HTTP session already opened' if @started
if block_given?
begin
do_start
return yield(self)
ensure
finish
end
end
do_start
self
end
def do_start
@socket = self.class.socket_type.open(conn_address(), conn_port(),
@open_timeout, @read_timeout,
@debug_output)
on_connect
@started = true
end
private :do_start
def conn_address
address()
end
private :conn_address
def conn_port
port()
end
private :conn_port
def on_connect
end
private :on_connect
def finish
raise IOError, 'closing already closed HTTP session' unless @started
@socket.close if @socket and not @socket.closed?
@socket = nil
@started = false
nil
end
#
# proxy
#
public
# no proxy
@is_proxy_class = false
@proxy_addr = nil
@proxy_port = nil
@proxy_user = nil
@proxy_pass = nil
def HTTP.Proxy( p_addr, p_port = nil, p_user = nil, p_pass = nil )
return self unless p_addr
delta = ProxyDelta
proxyclass = Class.new(self)
proxyclass.module_eval {
include delta
# with proxy
@is_proxy_class = true
@proxy_address = p_addr
@proxy_port = p_port || default_port()
@proxy_user = p_user
@proxy_pass = p_pass
}
proxyclass
end
class << HTTP
def proxy_class?
@is_proxy_class
end
attr_reader :proxy_address
attr_reader :proxy_port
attr_reader :proxy_user
attr_reader :proxy_pass
end
def proxy?
self.class.proxy_class?
end
def proxy_address
self.class.proxy_address
end
def proxy_port
self.class.proxy_port
end
def proxy_user
self.class.proxy_user
end
def proxy_pass
self.class.proxy_pass
end
alias proxyaddr proxy_address
alias proxyport proxy_port
private
# without proxy
def conn_address
address
end
def conn_port
port
end
def edit_path( path )
path
end
module ProxyDelta
private
# with proxy
def conn_address
proxy_address()
end
def conn_port
proxy_port()
end
def edit_path( path )
'http://' + addr_port() + path
end
end
#
# HTTP operations
#
public
def get( path, initheader = nil, dest = nil, &block )
res = nil
request(Get.new(path, initheader)) {|r|
r.read_body dest, &block
res = r
}
unless @newimpl
res.value
return res, res.body
end
res
end
def head( path, initheader = nil )
res = request(Head.new(path, initheader))
@newimpl or res.value
res
end
def post( path, data, initheader = nil, dest = nil, &block )
res = nil
request(Post.new(path, initheader), data) {|r|
r.read_body dest, &block
res = r
}
unless @newimpl
res.value
return res, res.body
end
res
end
def put( path, data, initheader = nil )
res = request(Put.new(path, initheader), data)
@newimpl or res.value
res
end
def request_get( path, initheader = nil, &block )
request Get.new(path, initheader), &block
end
def request_head( path, initheader = nil, &block )
request Head.new(path, initheader), &block
end
def request_post( path, data, initheader = nil, &block )
request Post.new(path, initheader), data, &block
end
def request_put( path, data, initheader = nil, &block )
request Put.new(path, initheader), data, &block
end
alias get2 request_get
alias head2 request_head
alias post2 request_post
alias put2 request_put
def send_request( name, path, body = nil, header = nil )
r = HTTPGenericRequest.new(name,(body ? true : false),true,path,header)
request r, body
end
def request( req, body = nil, &block )
unless started?
start {
req['connection'] = 'close'
return request(req, body, &block)
}
end
if proxy_user()
req.proxy_basic_auth proxy_user(), proxy_pass()
end
begin_transport req
req.exec @socket, @curr_http_version, edit_path(req.path), body
begin
res = HTTPResponse.read_new(@socket)
end while HTTPContinue === res
res.reading_body(@socket, req.response_body_permitted?) {
yield res if block_given?
}
end_transport req, res
res
end
private
def begin_transport( req )
if @socket.closed?
@socket.reopen @open_timeout
on_connect
end
if @seems_1_0_server
req['connection'] = 'close'
end
if not req.response_body_permitted? and @close_on_empty_response
req['connection'] = 'close'
end
req['host'] = addr_port()
end
def end_transport( req, res )
@curr_http_version = res.http_version
if not res.body and @close_on_empty_response
D 'Conn close'
@socket.close
elsif keep_alive? req, res
D 'Conn keep-alive'
if @socket.closed?
D 'Conn (but seems 1.0 server)'
@seems_1_0_server = true
end
else
D 'Conn close'
@socket.close
end
end
def keep_alive?( req, res )
/close/i === req['connection'].to_s and return false
@seems_1_0_server and return false
/keep-alive/i === res['connection'].to_s and return true
/close/i === res['connection'].to_s and return false
/keep-alive/i === res['proxy-connection'].to_s and return true
/close/i === res['proxy-connection'].to_s and return false
@curr_http_version == '1.1' and return true
false
end
#
# utils
#
private
def addr_port
address + (port == HTTP.default_port ? '' : ":#{port}")
end
def D( msg )
if @debug_output
@debug_output << msg
@debug_output << "\n"
end
end
end
HTTPSession = HTTP
###
### Header
###
module HTTPHeader
def size
@header.size
end
alias length size
def []( key )
@header[key.downcase]
end
def []=( key, val )
@header[key.downcase] = val
end
def fetch( key, *args, &block )
@header.fetch(key.downcase, *args, &block)
end
def each_header( &block )
@header.each(&block)
end
alias each each_header
def each_key( &block )
@header.each_key(&block)
end
def each_value( &block )
@header.each_value(&block)
end
def delete( key )
@header.delete(key.downcase)
end
def key?( key )
@header.key?(key.downcase)
end
def to_hash
@header.dup
end
def canonical_each
@header.each do |k,v|
yield canonical(k), v
end
end
def canonical( k )
k.split(/-/).map {|i| i.capitalize }.join('-')
end
private :canonical
def range
s = @header['range'] or return nil
s.split(/,/).map {|spec|
m = /bytes\s*=\s*(\d+)?\s*-\s*(\d+)?/i.match(spec) or
raise HTTPHeaderSyntaxError, "wrong Range: #{spec}"
d1 = m[1].to_i
d2 = m[2].to_i
if m[1] and m[2] then d1..d2
elsif m[1] then d1..-1
elsif m[2] then -d2..-1
else
raise HTTPHeaderSyntaxError, 'range is not specified'
end
}
end
def range=( r, fin = nil )
r = (r ... r + fin) if fin
case r
when Numeric
s = r > 0 ? "0-#{r - 1}" : "-#{-r}"
when Range
first = r.first
last = r.last
if r.exclude_end?
last -= 1
end
if last == -1
s = first > 0 ? "#{first}-" : "-#{-first}"
else
first >= 0 or raise HTTPHeaderSyntaxError, 'range.first is negative'
last > 0 or raise HTTPHeaderSyntaxError, 'range.last is negative'
first < last or raise HTTPHeaderSyntaxError, 'must be .first < .last'
s = "#{first}-#{last}"
end
else
raise TypeError, 'Range/Integer is required'
end
@header['range'] = "bytes=#{s}"
r
end
alias set_range range=
def content_length
s = @header['content-length'] or return nil
m = /\d+/.match(s) or
raise HTTPHeaderSyntaxError, 'wrong Content-Length format'
m[0].to_i
end
def chunked?
s = @header['transfer-encoding']
(s and /(?:\A|[^\-\w])chunked(?:[^\-\w]|\z)/i === s) ? true : false
end
def content_range
s = @header['content-range'] or return nil
m = %r<bytes\s+(\d+)-(\d+)/(?:\d+|\*)>i.match(s) or
raise HTTPHeaderSyntaxError, 'wrong Content-Range format'
m[1].to_i .. m[2].to_i + 1
end
def range_length
r = self.content_range
r and r.length
end
def basic_auth( account, password )
@header['authorization'] = basic_encode(account, password)
end
def proxy_basic_auth( account, password )
header['proxy-authorization'] = basic_encode(account, password)
end
def basic_encode( account, password )
'Basic ' + ["#{account}:#{password}"].pack('m').strip
end
private :basic_encode
end
###
### Request
###
class HTTPGenericRequest
include HTTPHeader
def initialize( m, reqbody, resbody, path, initheader = nil )
@method = m
@request_has_body = reqbody
@response_has_body = resbody
@path = path
@header = {}
return unless initheader
initheader.each do |k,v|
key = k.downcase
$stderr.puts "net/http: WARNING: duplicated HTTP header: #{k}" if @header.key?(key) and $VERBOSE
@header[key] = v.strip
end
@header['accept'] ||= '*/*'
end
attr_reader :method
attr_reader :path
def inspect
"\#<#{self.class} #{@method}>"
end
def request_body_permitted?
@request_has_body
end
def response_body_permitted?
@response_has_body
end
alias body_exist? response_body_permitted?
#
# write
#
# internal use only
def exec( sock, ver, path, body )
if body
check_body_permitted
send_request_with_body sock, ver, path, body
else
request sock, ver, path
end
end
private
def check_body_permitted
request_body_permitted? or
raise ArgumentError, 'HTTP request body is not permitted'
end
def send_request_with_body( sock, ver, path, body )
@header['content-length'] = body.size.to_s
@header.delete 'transfer-encoding'
unless @header['content-type']
$stderr.puts 'net/http: WARNING: Content-Type did not set; using application/x-www-form-urlencoded' if $VERBOSE
@header['content-type'] = 'application/x-www-form-urlencoded'
end
request sock, ver, path
sock.write body
end
def request( sock, ver, path )
buf = "#{@method} #{path} HTTP/#{ver}\r\n"
canonical_each do |k,v|
buf << k + ': ' + v + "\r\n"
end
buf << "\r\n"
sock.write buf
end
end
class HTTPRequest < HTTPGenericRequest
def initialize( path, initheader = nil )
super self.class::METHOD,
self.class::REQUEST_HAS_BODY,
self.class::RESPONSE_HAS_BODY,
path, initheader
end
end
class HTTP
class Get < HTTPRequest
METHOD = 'GET'
REQUEST_HAS_BODY = false
RESPONSE_HAS_BODY = true
end
class Head < HTTPRequest
METHOD = 'HEAD'
REQUEST_HAS_BODY = false
RESPONSE_HAS_BODY = false
end
class Post < HTTPRequest
METHOD = 'POST'
REQUEST_HAS_BODY = true
RESPONSE_HAS_BODY = true
end
class Put < HTTPRequest
METHOD = 'PUT'
REQUEST_HAS_BODY = true
RESPONSE_HAS_BODY = true
end
end
###
### Response
###
module HTTPExceptions
def initialize( msg, res )
super msg
@response = res
end
attr_reader :response
alias data response
end
class HTTPError < ProtocolError
include HTTPExceptions
end
class HTTPRetriableError < ProtoRetriableError
include HTTPExceptions
end
# We cannot use the name "HTTPServerError", it is the name of the response.
class HTTPServerException < ProtoServerError
include HTTPExceptions
end
class HTTPFatalError < ProtoFatalError
include HTTPExceptions
end
class HTTPResponse
# predefine HTTPResponse class to allow inheritance
def self.body_permitted?
self::HAS_BODY
end
def self.exception_type
self::EXCEPTION_TYPE
end
end
class HTTPUnknownResponse < HTTPResponse
HAS_BODY = true
EXCEPTION_TYPE = HTTPError
end
class HTTPInformation < HTTPResponse # 1xx
HAS_BODY = false
EXCEPTION_TYPE = HTTPError
end
class HTTPSuccess < HTTPResponse # 2xx
HAS_BODY = true
EXCEPTION_TYPE = HTTPError
end
class HTTPRedirection < HTTPResponse # 3xx
HAS_BODY = true
EXCEPTION_TYPE = HTTPRetriableError
end
class HTTPClientError < HTTPResponse # 4xx
HAS_BODY = true
EXCEPTION_TYPE = HTTPServerException # for backward compatibility
end
class HTTPServerError < HTTPResponse # 5xx
HAS_BODY = true
EXCEPTION_TYPE = HTTPFatalError # for backward compatibility
end
class HTTPContinue < HTTPInformation # 100
HAS_BODY = false
end
class HTTPSwitchProtocol < HTTPInformation # 101
HAS_BODY = false
end
class HTTPOK < HTTPSuccess # 200
HAS_BODY = true
end
class HTTPCreated < HTTPSuccess # 201
HAS_BODY = true
end
class HTTPAccepted < HTTPSuccess # 202
HAS_BODY = true
end
class HTTPNonAuthoritativeInformation < HTTPSuccess # 203
HAS_BODY = true
end
class HTTPNoContent < HTTPSuccess # 204
HAS_BODY = false
end
class HTTPResetContent < HTTPSuccess # 205
HAS_BODY = false
end
class HTTPPartialContent < HTTPSuccess # 206
HAS_BODY = true
end
class HTTPMultipleChoice < HTTPRedirection # 300
HAS_BODY = true
end
class HTTPMovedPermanently < HTTPRedirection # 301
HAS_BODY = true
end
class HTTPFound < HTTPRedirection # 302
HAS_BODY = true
end
HTTPMovedTemporarily = HTTPFound
class HTTPSeeOther < HTTPRedirection # 303
HAS_BODY = true
end
class HTTPNotModified < HTTPRedirection # 304
HAS_BODY = false
end
class HTTPUseProxy < HTTPRedirection # 305
HAS_BODY = false
end
# 306 unused
class HTTPTemporaryRedirect < HTTPRedirection # 307
HAS_BODY = true
end
class HTTPBadRequest < HTTPClientError # 400
HAS_BODY = true
end
class HTTPUnauthorized < HTTPClientError # 401
HAS_BODY = true
end
class HTTPPaymentRequired < HTTPClientError # 402
HAS_BODY = true
end
class HTTPForbidden < HTTPClientError # 403
HAS_BODY = true
end
class HTTPNotFound < HTTPClientError # 404
HAS_BODY = true
end
class HTTPMethodNotAllowed < HTTPClientError # 405
HAS_BODY = true
end
class HTTPNotAcceptable < HTTPClientError # 406
HAS_BODY = true
end
class HTTPProxyAuthenticationRequired < HTTPClientError # 407
HAS_BODY = true
end
class HTTPRequestTimeOut < HTTPClientError # 408
HAS_BODY = true
end
class HTTPConflict < HTTPClientError # 409
HAS_BODY = true
end
class HTTPGone < HTTPClientError # 410
HAS_BODY = true
end
class HTTPLengthRequired < HTTPClientError # 411
HAS_BODY = true
end
class HTTPPreconditionFailed < HTTPClientError # 412
HAS_BODY = true
end
class HTTPRequestEntityTooLarge < HTTPClientError # 413
HAS_BODY = true
end
class HTTPRequestURITooLong < HTTPClientError # 414
HAS_BODY = true
end
HTTPRequestURITooLarge = HTTPRequestURITooLong
class HTTPUnsupportedMediaType < HTTPClientError # 415
HAS_BODY = true
end
class HTTPRequestedRangeNotSatisfiable < HTTPClientError # 416
HAS_BODY = true
end
class HTTPExpectationFailed < HTTPClientError # 417
HAS_BODY = true
end
class HTTPInternalServerError < HTTPServerError # 500
HAS_BODY = true
end
class HTTPNotImplemented < HTTPServerError # 501
HAS_BODY = true
end
class HTTPBadGateway < HTTPServerError # 502
HAS_BODY = true
end
class HTTPServiceUnavailable < HTTPServerError # 503
HAS_BODY = true
end
class HTTPGatewayTimeOut < HTTPServerError # 504
HAS_BODY = true
end
class HTTPVersionNotSupported < HTTPServerError # 505
HAS_BODY = true
end
class HTTPResponse # redefine
CODE_CLASS_TO_OBJ = {
'1' => HTTPInformation,
'2' => HTTPSuccess,
'3' => HTTPRedirection,
'4' => HTTPClientError,
'5' => HTTPServerError
}
CODE_TO_OBJ = {
'100' => HTTPContinue,
'101' => HTTPSwitchProtocol,
'200' => HTTPOK,
'201' => HTTPCreated,
'202' => HTTPAccepted,
'203' => HTTPNonAuthoritativeInformation,
'204' => HTTPNoContent,
'205' => HTTPResetContent,
'206' => HTTPPartialContent,
'300' => HTTPMultipleChoice,
'301' => HTTPMovedPermanently,
'302' => HTTPFound,
'303' => HTTPSeeOther,
'304' => HTTPNotModified,
'305' => HTTPUseProxy,
'307' => HTTPTemporaryRedirect,
'400' => HTTPBadRequest,
'401' => HTTPUnauthorized,
'402' => HTTPPaymentRequired,
'403' => HTTPForbidden,
'404' => HTTPNotFound,
'405' => HTTPMethodNotAllowed,
'406' => HTTPNotAcceptable,
'407' => HTTPProxyAuthenticationRequired,
'408' => HTTPRequestTimeOut,
'409' => HTTPConflict,
'410' => HTTPGone,
'411' => HTTPLengthRequired,
'412' => HTTPPreconditionFailed,
'413' => HTTPRequestEntityTooLarge,
'414' => HTTPRequestURITooLong,
'415' => HTTPUnsupportedMediaType,
'416' => HTTPRequestedRangeNotSatisfiable,
'417' => HTTPExpectationFailed,
'501' => HTTPInternalServerError,
'501' => HTTPNotImplemented,
'502' => HTTPBadGateway,
'503' => HTTPServiceUnavailable,
'504' => HTTPGatewayTimeOut,
'505' => HTTPVersionNotSupported
}
class << self
def read_new( sock )
httpv, code, msg = read_status_line(sock)
res = response_class(code).new(httpv, code, msg)
each_response_header(sock) do |k,v|
if res.key? k
res[k] << ', ' << v
else
res[k] = v
end
end
res
end
private
def read_status_line( sock )
str = sock.readline
m = /\AHTTP(?:\/(\d+\.\d+))?\s+(\d\d\d)\s*(.*)\z/in.match(str) or
raise HTTPBadResponse, "wrong status line: #{str.dump}"
m.to_a[1,3]
end
def response_class( code )
CODE_TO_OBJ[code] or
CODE_CLASS_TO_OBJ[code[0,1]] or
HTTPUnknownResponse
end
def each_response_header( sock )
while true
line = sock.readuntil("\n", true).sub(/\s+\z/, '')
break if line.empty?
m = /\A([^:]+):\s*/.match(line) or
raise HTTPBadResponse, 'wrong header line format'
yield m[1], m.post_match
end
end
end
include HTTPHeader
def initialize( httpv, code, msg )
@http_version = httpv
@code = code
@message = msg
@header = {}
@body = nil
@read = false
end
attr_reader :http_version
attr_reader :code
attr_reader :message
alias msg message
def inspect
"#<#{self.class} #{@code} readbody=#{@read}>"
end
#
# response <-> exception relationship
#
def code_type
self.class
end
def error!
raise error_type().new(@code + ' ' + @message.dump, self)
end
def error_type
self.class::EXCEPTION_TYPE
end
def value
error! unless HTTPSuccess === self
end
#
# header (for backward compatibility only; DO NOT USE)
#
def response
self
end
alias header response
alias read_header response
#
# body
#
# internal use only
def reading_body( sock, reqmethodallowbody )
@socket = sock
@body_exist = reqmethodallowbody && self.class.body_permitted?
begin
yield
self.body # ensure to read body
ensure
@socket = nil
end
end
def read_body( dest = nil, &block )
if @read
raise IOError, "#{self.class}\#read_body called twice" if dest or block
return @body
end
to = procdest(dest, block)
stream_check
if @body_exist
read_body_0 to
@body = to
else
@body = nil
end
@read = true
@body
end
alias body read_body
alias entity read_body
private
def read_body_0( dest )
if chunked?
read_chunked dest
else
clen = content_length()
if clen
@socket.read clen, dest, true # ignore EOF
else
clen = range_length()
if clen
@socket.read clen, dest
else
@socket.read_all dest
end
end
end
end
def read_chunked( dest )
len = nil
total = 0
while true
line = @socket.readline
hexlen = line.slice(/[0-9a-fA-F]+/) or
raise HTTPBadResponse, "wrong chunk size line: #{line}"
len = hexlen.hex
break if len == 0
@socket.read len, dest; total += len
@socket.read 2 # \r\n
end
until @socket.readline.empty?
# none
end
end
def stream_check
raise IOError, 'try to read body out of block' if @socket.closed?
end
def procdest( dest, block )
raise ArgumentError, 'both of arg and block are given for HTTP method'\
if dest and block
if block
ReadAdapter.new(block)
else
dest || ''
end
end
end
# for backward compatibility
HTTPInformationCode = HTTPInformation
HTTPSuccessCode = HTTPSuccess
HTTPRedirectionCode = HTTPRedirection
HTTPRetriableCode = HTTPRedirection
HTTPClientErrorCode = HTTPClientError
HTTPFatalErrorCode = HTTPClientError
HTTPServerErrorCode = HTTPServerError
HTTPResponceReceiver = HTTPResponse
end # module Net
|