Class: EventMachine::HttpClient

Inherits:
Connection
  • Object
show all
Includes:
Deferrable, HttpEncoding
Defined in:
lib/em-http/client.rb

Constant Summary collapse

TRANSFER_ENCODING = 
"TRANSFER_ENCODING"
CONTENT_ENCODING = 
"CONTENT_ENCODING"
CONTENT_LENGTH = 
"CONTENT_LENGTH"
KEEP_ALIVE = 
"CONNECTION"
"SET_COOKIE"
LOCATION = 
"LOCATION"
HOST = 
"HOST"
CRLF = 
"\r\n"

Constants included from HttpEncoding

EventMachine::HttpEncoding::BASIC_AUTH_ENCODING, EventMachine::HttpEncoding::FIELD_ENCODING, EventMachine::HttpEncoding::HTTP_REQUEST_HEADER

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HttpEncoding

#encode_basic_auth, #encode_cookies, #encode_field, #encode_headers, #encode_host, #encode_param, #encode_query, #encode_request, #escape, #munge_header_keys, #unescape

Instance Attribute Details

#errors ⇒ Object (readonly)

Returns the value of attribute errors.



155
156
157
 
# File 'lib/em-http/client.rb', line 155

def errors
  @errors
end

#method ⇒ Object

Returns the value of attribute method.



154
155
156
 
# File 'lib/em-http/client.rb', line 154

def method
  @method
end

#options ⇒ Object

Returns the value of attribute options.



154
155
156
 
# File 'lib/em-http/client.rb', line 154

def options
  @options
end

#response ⇒ Object (readonly)

Returns the value of attribute response.



155
156
157
 
# File 'lib/em-http/client.rb', line 155

def response
  @response
end

#response_header ⇒ Object (readonly)

Returns the value of attribute response_header.



155
156
157
 
# File 'lib/em-http/client.rb', line 155

def response_header
  @response_header
end

#uri ⇒ Object

Returns the value of attribute uri.



154
155
156
 
# File 'lib/em-http/client.rb', line 154

def uri
  @uri
end

Instance Method Details

#connection_completed ⇒ Object

start HTTP request once we establish connection to host



173
174
175
176
 
# File 'lib/em-http/client.rb', line 173

def connection_completed
  send_request_header
  send_request_body
end

#dispatch ⇒ Object

Response processing



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/em-http/client.rb', line 249

def dispatch
  while case @state
    when :response_header
      parse_response_header
    when :chunk_header
      parse_chunk_header
    when :chunk_body
      process_chunk_body
    when :chunk_footer
      process_chunk_footer
    when :response_footer
      process_response_footer
    when :body
      process_body
    when :finished, :invalid
      break
    else raise RuntimeError, "invalid state: #{@state}"
    end
  end
end

#on_body_data(data) ⇒ Object

Called when part of the body has been read



236
237
238
 
# File 'lib/em-http/client.rb', line 236

def on_body_data(data)
  @response << data
end

#on_error(msg) ⇒ Object

request failed, invoke errback



194
195
196
197
 
# File 'lib/em-http/client.rb', line 194

def on_error(msg)
  @errors = msg
  unbind
end

#on_request_complete ⇒ Object

request is done, invoke the callback



179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/em-http/client.rb', line 179

def on_request_complete

  if @response_header.compressed? and @inflate.include?(response_header[CONTENT_ENCODING])
    case response_header[CONTENT_ENCODING]
    when 'deflate' then 
      @response = Zlib::Inflate.inflate(@response)
    when 'gzip', 'compressed' then
      @response = Zlib::GzipReader.new(StringIO.new(@response)).read
    end
  end
			
  unbind
end

#parse_chunk_header ⇒ Object 



309
310
311
312
313
314
315
316
317
 
# File 'lib/em-http/client.rb', line 309

def parse_chunk_header
  return false unless parse_header(@chunk_header)

  @bytes_remaining = @chunk_header.chunk_size
  @chunk_header = HttpChunkHeader.new

  @state = @bytes_remaining > 0 ? :chunk_body : :response_footer
  true
end

#parse_header(header) ⇒ Object 



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/em-http/client.rb', line 270

def parse_header(header)
  return false if @data.empty?

  begin
    @parser_nbytes = @parser.execute(header, @data.to_str, @parser_nbytes)
  rescue EventMachine::HttpClientParserError
    @state = :invalid
    on_error "invalid HTTP format, parsing fails"
  end

  return false unless @parser.finished?

  # Clear parsed data from the buffer
  @data.read(@parser_nbytes)
  @parser.reset
  @parser_nbytes = 0

  true
end

#parse_response_header ⇒ Object 



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/em-http/client.rb', line 290

def parse_response_header
  return false unless parse_header(@response_header)

  unless @response_header.http_status and @response_header.http_reason
    @state = :invalid
    on_error "no HTTP response"
    return false
  end

  if @response_header.chunked_encoding?
    @state = :chunk_header
  else
    @state = :body
    @bytes_remaining = @response_header.content_length
  end

  true
end

#post_init ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/em-http/client.rb', line 157

def post_init
  self.comm_inactivity_timeout = 5

  @parser = HttpClientParser.new
  @data = EventMachine::Buffer.new
  @response_header = HttpResponseHeader.new
  @chunk_header = HttpChunkHeader.new

  @state = :response_header
  @parser_nbytes = 0
  @inflate = []
  @response = ''
  @errors = ''
end

#process_body ⇒ Object 



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
 
# File 'lib/em-http/client.rb', line 365

def process_body
  if @bytes_remaining.nil?
    on_body_data @data.read
    return false
  end

  if @bytes_remaining.zero?
    @state = :finished
    on_request_complete
    return false
  end

  if @data.size < @bytes_remaining
    @bytes_remaining -= @data.size
    on_body_data @data.read
    return false
  end

  on_body_data @data.read(@bytes_remaining)
  @bytes_remaining = 0

  # If Keep-Alive is enabled, the server may be pushing more data to us
  # after the first request is complete. Hence, finish first request, and
  # reset state.
  if @response_header.keep_alive?
    @data.clear # hard reset, TODO: add support for keep-alive connections!
    @state = :finished
    on_request_complete

  else
    if @data.empty?
      @state = :finished
      on_request_complete
    else
      @state = :invalid
      on_error "garbage at end of body"
    end
  end

  false
end

#process_chunk_body ⇒ Object 



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/em-http/client.rb', line 319

def process_chunk_body
  if @data.size < @bytes_remaining
    @bytes_remaining -= @data.size
    on_body_data @data.read
    return false
  end

  on_body_data @data.read(@bytes_remaining)
  @bytes_remaining = 0

  @state = :chunk_footer
  true
end

#process_chunk_footer ⇒ Object 



333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/em-http/client.rb', line 333

def process_chunk_footer
  return false if @data.size < 2

  if @data.read(2) == CRLF
    @state = :chunk_header
  else
    @state = :invalid
    on_error "non-CRLF chunk footer"
  end

  true
end

#process_response_footer ⇒ Object 



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/em-http/client.rb', line 346

def process_response_footer
  return false if @data.size < 2

  if @data.read(2) == CRLF
    if @data.empty?
      @state = :finished
      on_request_complete
    else
      @state = :invalid
      on_error "garbage at end of chunked response"
    end
  else
    @state = :invalid
    on_error "non-CRLF response footer"
  end

  false
end

#receive_data(data) ⇒ Object 



230
231
232
233
 
# File 'lib/em-http/client.rb', line 230

def receive_data(data)
  @data << data
  dispatch
end

#send_request_body ⇒ Object 



226
227
228
 
# File 'lib/em-http/client.rb', line 226

def send_request_body
  send_data @options[:body] if @options[:body]
end

#send_request_header ⇒ Object 



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
 
# File 'lib/em-http/client.rb', line 199

def send_request_header
  query   = @options[:query]
  head    = @options[:head] ? munge_header_keys(@options[:head]) : {}
  body    = @options[:body]

  # Set the Host header if it hasn't been specified already
  head['host'] ||= encode_host

  # Set the Content-Length if body is given
  head['content-length'] =  body.length if body

  # Set the User-Agent if it hasn't been specified
  head['user-agent'] ||= "EventMachine HttpClient"

  # Set auto-inflate flags
  if head['accept-encoding']
    @inflate = head['accept-encoding'].split(',').map {|t| t.strip}
  end

  # Build the request
  request_header = encode_request(@method, @uri.path, query)
  request_header << encode_headers(head)
  request_header << CRLF

  send_data request_header
end

#unbind ⇒ Object 



240
241
242
243
 
# File 'lib/em-http/client.rb', line 240

def unbind
  (@state == :finished) ? succeed(self) : fail
  close_connection
end