class HTTP::Message
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¶ ↑
-
Gets response message body.
res = clnt.get(url) p res.content #=> String
-
Gets response status code.
res = clnt.get(url) p res.status #=> 200, 501, etc. (Integer)
-
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
Constants
- CRLF
- VERSION_WARNING
Attributes
- HTTP::Message::Headers
-
message header.
- HTTP::Message::Body
-
message body.
- HTTP::Message::Headers
-
message header.
- OpenSSL::X509::Certificate
-
response only. server certificate which is used for retrieving the response.
Public Class Methods
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 :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.)
# File lib/httpclient/http.rb, line 843 def file?(obj) obj.respond_to?(:read) and obj.respond_to?(:pos) and obj.respond_to?(:pos=) end
Default MIME type handler. See ::mime_type_handler=.
# File lib/httpclient/http.rb, line 806 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
Returns MIME type handler.
# File lib/httpclient/http.rb, line 783 def mime_type_handler @@mime_type_handler end
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.
# File lib/httpclient/http.rb, line 778 def mime_type_handler=(handler) @@mime_type_handler = handler end
Returns true if the given query (or body) has a multiple parameter.
# File lib/httpclient/http.rb, line 832 def multiparam_query?(query) query.is_a?(Array) or query.is_a?(Hash) end
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.
# File lib/httpclient/http.rb, line 722 def new_connect_request(uri) m = new m.http_header.init_connect_request(uri) m.http_header.body_size = nil m end
Creates a Message instance of general request.
- method
- 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
- boundary
-
When the boundary given, it is sent as a multipart/form-data using this boundary String.
# File lib/httpclient/http.rb, line 742 def new_request(method, uri, query = nil, body = nil, boundary = nil) m = new m.http_header.init_request(method, uri, query) m.http_body = Body.new m.http_body.init_request(body || '', boundary) if body m.http_header.body_size = m.http_body.size m.http_header.chunked = true if m.http_body.size.nil? else m.http_header.body_size = nil end m end
Creates a Message instance of response.
- body
-
a String or an IO of response message body.
# File lib/httpclient/http.rb, line 758 def new_response(body, req = nil) m = new m.http_header.init_response(Status::OK, req) m.http_body = Body.new m.http_body.init_response(body) m.http_header.body_size = m.http_body.size || 0 m end
from CGI.parse
# File lib/httpclient/http.rb, line 906 def parse(query) params = Hash.new([].freeze) query.split(/[&;]/n).each do |pairs| key, value = pairs.split('=',2).collect{|v| unescape(v) } if params.has_key?(key) params[key].push(value) else params[key] = [value] end end params end
from CGI.unescape
# File lib/httpclient/http.rb, line 920 def unescape(string) string.tr('+', ' ').gsub(/((?:%[0-9a-fA-F]{2})+)/n) do [$1.delete('%')].pack('H*') end end
Public Instance Methods
Returns content encoding
# File lib/httpclient/http.rb, line 1030 def body_encoding @http_header.body_encoding end
Returns a content of message body. A String or an IO.
# File lib/httpclient/http.rb, line 1035 def content @http_body.content end
Returns 'Content-Type' header value.
# File lib/httpclient/http.rb, line 1018 def content_type @http_header.content_type end
Sets 'Content-Type' header value. Overrides if already exists.
# File lib/httpclient/http.rb, line 1023 def content_type=(content_type) @http_header.content_type = content_type end
Dumps message (header and body) to given dev. dev needs to respond to <<.
# File lib/httpclient/http.rb, line 953 def dump(dev = '') str = @http_header.dump + CRLF if @http_header.chunked dev = @http_body.dump_chunked(str, dev) elsif @http_body dev = @http_body.dump(str, dev) else dev << str end dev end
Returns Hash of header. key and value are both String. Each key has a single value so you can't extract exact value when a message has multiple headers like 'Set-Cookie'. Use header for that purpose. (It returns an Array always)
# File lib/httpclient/http.rb, line 1046 def headers Hash[*http_header.all.flatten] end
Sets a new body. header.body_size is updated with new body.size.
# File lib/httpclient/http.rb, line 966 def http_body=(body) @http_body = body @http_header.body_size = @http_body.size if @http_header end
Convenience method to return boolean of whether we had a successful request
# File lib/httpclient/http.rb, line 1064 def ok? HTTP::Status.successful?(status) end
# File lib/httpclient/http.rb, line 1068 def redirect? HTTP::Status.redirect?(status) end
SEE_OTHER is a redirect, but it should sent as GET
# File lib/httpclient/http.rb, line 1073 def see_other? status == HTTP::Status::SEE_OTHER end
Returns HTTP status code in response. Integer.
# File lib/httpclient/http.rb, line 994 def status @http_header.status_code end
Sets HTTP status code of response. Integer. Reason phrase is updated, too.
# File lib/httpclient/http.rb, line 1003 def status=(status) @http_header.status_code = status end
# File lib/httpclient/http.rb, line 983 def version warning(VERSION_WARNING) @http_header.http_version.to_f end
# File lib/httpclient/http.rb, line 988 def version=(version) warning(VERSION_WARNING) @http_header.http_version = version end