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
|
EM-HTTP-Request
===============
Asynchronous HTTP client for Ruby, based on EventMachine runtime.
- Ragel HTTP parser for speed & performance
- Simple interface for single & parallel requests via deferred callbacks
- Automatic gzip & deflate decoding
- Basic-Auth & OAuth support
- Custom timeout support
- Stream response processing
- Proxy support (with SSL Tunneling): CONNECT, direct & SOCKS5
- Auto-follow 3xx redirects with custom max depth
- Bi-directional communication with web-socket services
- [Native mocking support](http://wiki.github.com/igrigorik/em-http-request/mocking-httprequest) and through [Webmock](http://github.com/bblimke/webmock)
Getting started
---------------
gem install em-http-request
irb:0> require 'em-http'
Or checkout [screencast / demo](http://everburning.com/news/eventmachine-screencast-em-http-request/) of using EM-HTTP-Request.
Libraries & Applications using em-http
--------------------------------------
- [chirpstream](http://github.com/joshbuddy/chirpstream) - EM client for Twitters Chirpstream API
- [RDaneel](http://github.com/hasmanydevelopers/RDaneel) - Ruby crawler which respects robots.txt
- [rsolr-async](http://github.com/mwmitchell/rsolr-async) - An asynchronus connection adapter for RSolr
- [PubSubHubbub](http://github.com/igrigorik/PubSubHubbub) - Asynchronous PubSubHubbub ruby client
- [Firering](http://github.com/EmmanuelOga/firering) - Eventmachine powered Campfire API
- and many others.. drop me a link if you want yours included!
Simple client example
---------------------
EventMachine.run {
http = EventMachine::HttpRequest.new('http://127.0.0.1/').get :query => {'keyname' => 'value'}, :timeout => 10
http.callback {
p http.response_header.status
p http.response_header
p http.response
EventMachine.stop
}
}
Multi-request example
---------------------
Fire and wait for multiple requests to complete via the MultiRequest interface.
EventMachine.run {
multi = EventMachine::MultiRequest.new
# add multiple requests to the multi-handler
multi.add(EventMachine::HttpRequest.new('http://www.google.com/').get)
multi.add(EventMachine::HttpRequest.new('http://www.yahoo.com/').get)
multi.callback {
p multi.responses[:succeeded]
p multi.responses[:failed]
EventMachine.stop
}
}
Basic-Auth example
------------------
Full basic author support. For OAuth, check examples/oauth-tweet.rb file.
EventMachine.run {
http = EventMachine::HttpRequest.new('http://www.website.com/').get :head => {'authorization' => ['user', 'pass']}
http.errback { failed }
http.callback {
p http.response_header
EventMachine.stop
}
}
POSTing data example
--------------------
For multi-part uploads, please see [this gist](https://gist.github.com/778639).
EventMachine.run {
http1 = EventMachine::HttpRequest.new('http://www.website.com/').post :body => {"key1" => 1, "key2" => [2,3]}
http2 = EventMachine::HttpRequest.new('http://www.website.com/').post :body => "some data"
# ...
}
Streaming body processing
-------------------------
Allows you to consume an HTTP stream of content in real-time. Each time a new piece of content is pushed
to the client, it is passed to the stream callback for you to operate on.
EventMachine.run {
http = EventMachine::HttpRequest.new('http://www.website.com/').get
http.stream { |chunk| print chunk }
}
Streaming files from disk
-------------------------
Allows you to efficiently stream a (large) file from disk via EventMachine's FileStream interface.
EventMachine.run {
http = EventMachine::HttpRequest.new('http://www.website.com/').post :file => 'largefile.txt'
http.callback { |chunk| puts "Upload finished!" }
}
Proxy example
-------------
Full transparent proxy support with support for SSL tunneling.
EventMachine.run {
http = EventMachine::HttpRequest.new('http://www.website.com/').get :proxy => {
:host => 'www.myproxy.com',
:port => 8080,
:authorization => ['username', 'password'] # authorization is optional
}
SOCKS5 Proxy example
-------------
Tunnel your requests via connect via SOCKS5 proxies (ssh -D port somehost).
EventMachine.run {
http = EventMachine::HttpRequest.new('http://www.website.com/').get :proxy => {
:host => 'www.myproxy.com',
:port => 8080,
:type => :socks
}
Auto-follow 3xx redirects
-------------------------
Specify the max depth of redirects to follow, default is 0.
EventMachine.run {
http = EventMachine::HttpRequest.new('http://www.google.com/').get :redirects => 1
http.callback { p http.last_effective_url }
}
WebSocket example
-----------------
[Bi-directional communication with WebSockets](http://www.igvita.com/2009/12/22/ruby-websockets-tcp-for-the-browser/): simply pass in a ws:// resource and the client will negotiate the connection upgrade for you. On successful handshake the callback is invoked, and any incoming messages will be passed to the stream callback. The client can also send data to the server at will by calling the "send" method!
EventMachine.run {
http = EventMachine::HttpRequest.new("ws://yourservice.com/websocket").get :timeout => 0
http.errback { puts "oops" }
http.callback {
puts "WebSocket connected!"
http.send("Hello client")
}
http.stream { |msg|
puts "Recieved: #{msg}"
http.send "Pong: #{msg}"
}
http.disconnect { puts "oops, dropped connection?" }
}
License
-------
(MIT License) - Copyright (c) 2011 Ilya Grigorik
|
