Class HTTP::Message
In: lib/httpclient/http.rb
Parent: Object

Represents a HTTP message. A message is for a request or a response.

Request message is generated from given parameters internally so users don‘t need to care about it. Response message is the instance that methods of HTTPClient returns so users need to know how to extract HTTP response data from Message.

Some attributes are only for a request or a response, not both.

How to use HTTP response message

  1. Gets response message body. 
     res = clnt.get(url)
 p res.content #=> String
  2. Gets response status code. 
     res = clnt.get(url)
 p res.status #=> 200, 501, etc. (Integer)
  3. Gets response header. 
     res = clnt.get(url)
 res.header['set-cookie'].each do |value|
   p value
 end
 assert_equal(1, res.header['last-modified'].size)
 p res.header['last-modified'].first

Methods

body=   code   content   contenttype   contenttype=   dump   file?   internal_mime_type   keep_alive_enabled?   mime_type_handler   mime_type_handler=   multiparam_query?   new_connect_request   new_request   new_response   reason   reason=   status   status=   status_code   version   version=  

Classes and Modules

Class HTTP::Message::Body
Class HTTP::Message::Headers

Constants

CRLF = "\r\n"

External Aliases

mime_type_handler= -> set_mime_type_func
  For backward compatibility.
mime_type_handler -> get_mime_type_func

Attributes

body  [R] 
HTTP::Message::Body:message body.
header  [RW] 
HTTP::Message::Headers:message header.
peer_cert  [RW] 
OpenSSL::X509::Certificate:response only. server certificate which is used for retrieving the response.

Public Class methods

file?(obj)

Returns true if the given object is a File. In HTTPClient, a file is;

  • must respond to :read for retrieving String chunks.
  • must respond to :path and returns a path for Content-Disposition.
  • must respond to :pos and :pos= to rewind for reading. Rewinding is only needed for following HTTP redirect. Some IO impl defines :pos= but raises an Exception for pos= such as StringIO but there‘s no problem as far as using it for non-following methods (get/post/etc.)

[Source]

# File lib/httpclient/http.rb, line 745
      def file?(obj)
        obj.respond_to?(:read) and obj.respond_to?(:path) and
          obj.respond_to?(:pos) and obj.respond_to?(:pos=)
      end
internal_mime_type(path)

Default MIME type handler. See mime_type_handler=.

[Source]

# File lib/httpclient/http.rb, line 707
      def internal_mime_type(path)
        case path
        when /\.txt$/i
          'text/plain'
        when /\.(htm|html)$/i
          'text/html'
        when /\.doc$/i
          'application/msword'
        when /\.png$/i
          'image/png'
        when /\.gif$/i
          'image/gif'
        when /\.(jpg|jpeg)$/i
          'image/jpeg'
        else
          'application/octet-stream'
        end
      end
keep_alive_enabled?(version)

Returns true if the given HTTP version allows keep alive connection.

version:Float

[Source]

# File lib/httpclient/http.rb, line 728
      def keep_alive_enabled?(version)
        version >= 1.1
      end
mime_type_handler()

Returns MIME type handler.

[Source]

# File lib/httpclient/http.rb, line 684
      def mime_type_handler
        @@mime_type_handler
      end
mime_type_handler=(handler)

Sets MIME type handler.

handler must respond to :call with a single argument :path and returns a MIME type String e.g. ‘text/html’. When the handler returns nil or an empty String, ‘application/octet-stream’ is used.

When you set nil to the handler, internal_mime_type is used instead. The handler is nil by default.

[Source]

# File lib/httpclient/http.rb, line 679
      def mime_type_handler=(handler)
        @@mime_type_handler = handler
      end
multiparam_query?(query)

Returns true if the given query (or body) has a multiple parameter.

[Source]

# File lib/httpclient/http.rb, line 733
      def multiparam_query?(query)
        query.is_a?(Array) or query.is_a?(Hash)
      end
new_connect_request(uri)

Creates a Message instance of ‘CONNECT’ request. ‘CONNECT’ request does not have Body.

uri:an URI that need to connect. Only uri.host and uri.port are used.

[Source]

# File lib/httpclient/http.rb, line 623
      def new_connect_request(uri)
        m = new
        m.header.init_connect_request(uri)
        m.header.body_size = nil
        m
      end
new_request(method, uri, query = nil, body = nil, boundary = nil)

Creates a Message instance of general request.

method:HTTP method String.
uri:an URI object which represents an URL of web resource.
query:a Hash or an Array of query part of URL. e.g. { "a" => "b" } => ‘host/part?a=b’ Give an array to pass multiple value like
["a", "b"], ["a", "c"]
=> ‘host/part?a=b&a=c‘
body:a Hash or an Array of body part. e.g. { "a" => "b" } => ‘a=b’. Give an array to pass multiple value like
["a", "b"], ["a", "c"]
=> ‘a=b&a=c’.
boundary:When the boundary given, it is sent as a multipart/form-data using this boundary String.

[Source]

# File lib/httpclient/http.rb, line 643
      def new_request(method, uri, query = nil, body = nil, boundary = nil)
        m = new
        m.header.init_request(method, uri, query)
        m.body = Body.new
        m.body.init_request(body || '', boundary)
        if body
          m.header.body_size = m.body.size
          m.header.chunked = true if m.body.size.nil?
        else
          m.header.body_size = nil
        end
        m
      end
new_response(body)

Creates a Message instance of response.

body:a String or an IO of response message body.

[Source]

# File lib/httpclient/http.rb, line 659
      def new_response(body)
        m = new
        m.header.init_response(Status::OK)
        m.body = Body.new
        m.body.init_response(body)
        m.header.body_size = m.body.size || 0
        m
      end

Public Instance methods

body=(body)

Sets a new body. header.body_size is updated with new body.size.

[Source]

# File lib/httpclient/http.rb, line 811
    def body=(body)
      @body = body
      @header.body_size = @body.size if @header
    end
code()

Alias for status

content()

Returns a content of message body. A String or an IO.

[Source]

# File lib/httpclient/http.rb, line 861
    def content
      @body.content
    end
contenttype()

Sets ‘Content-Type’ header value. Overrides if already exists.

[Source]

# File lib/httpclient/http.rb, line 851
    def contenttype
      @header.contenttype
    end
contenttype=(contenttype)

Returns ‘Content-Type’ header value.

[Source]

# File lib/httpclient/http.rb, line 856
    def contenttype=(contenttype)
      @header.contenttype = contenttype
    end
dump(dev = '')

Dumps message (header and body) to given dev. dev needs to respond to <<.

[Source]

# File lib/httpclient/http.rb, line 798
    def dump(dev = '')
      str = header.dump + CRLF
      if header.chunked
        dev = body.dump_chunked(str, dev)
      elsif body
        dev = body.dump(str, dev)
      else
        dev << str
      end
      dev
    end
reason()

Returns HTTP status reason phrase in response. String.

[Source]

# File lib/httpclient/http.rb, line 841
    def reason
      @header.reason_phrase
    end
reason=(reason)

Sets HTTP status reason phrase of response. String.

[Source]

# File lib/httpclient/http.rb, line 846
    def reason=(reason)
      @header.reason_phrase = reason
    end
status()

Returns HTTP status code in response. Integer.

[Source]

# File lib/httpclient/http.rb, line 827
    def status
      @header.status_code
    end
status=(status)

Sets HTTP status code of response. Integer. Reason phrase is updated, too.

[Source]

# File lib/httpclient/http.rb, line 836
    def status=(status)
      @header.status_code = status
    end
status_code()

Alias for status

version()

Returns HTTP version in a HTTP header. Float.

[Source]

# File lib/httpclient/http.rb, line 817
    def version
      @header.http_version
    end
version=(version)

Sets HTTP version in a HTTP header. Float.

[Source]

# File lib/httpclient/http.rb, line 822
    def version=(version)
      @header.http_version = version
    end

[Validate]