Class: HTTP::Message

Inherits:
Object
  • Object
show all
Defined in:
lib/httpclient/http.rb,
lib/oauthclient.rb

Overview

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

Defined Under Namespace

Classes: Body, Headers

Constant Summary collapse

CRLF = 
"\r\n"
VERSION_WARNING = 
'Message#version (Float) is deprecated. Use Message#http_version (String) instead.'
@@mime_type_handler = 
nil

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Message

Creates a Message. This method should be used internally. Use Message.new_connect_request, Message.new_request or Message.new_response instead.



920
921
922
923
 
# File 'lib/httpclient/http.rb', line 920

def initialize # :nodoc:
  @http_header = Headers.new
  @http_body = @peer_cert = nil
end

Instance Attribute Details

#http_body ⇒ Object

HTTP::Message::Body

message body.



911
912
913
 
# File 'lib/httpclient/http.rb', line 911

def http_body
  @http_body
end

#http_header ⇒ Object Also known as: header

HTTP::Message::Headers

message header.



908
909
910
 
# File 'lib/httpclient/http.rb', line 908

def http_header
  @http_header
end

#oauth_params ⇒ Object

Returns the value of attribute oauth_params.



13
14
15
 
# File 'lib/oauthclient.rb', line 13

def oauth_params
  @oauth_params
end

#peer_cert ⇒ Object

OpenSSL::X509::Certificate

response only. server certificate which is used for retrieving the response.



915
916
917
 
# File 'lib/httpclient/http.rb', line 915

def peer_cert
  @peer_cert
end

Class Method Details

.create_query_part_str(query) ⇒ Object

:nodoc:



827
828
829
830
831
832
833
834
835
 
# File 'lib/httpclient/http.rb', line 827

def create_query_part_str(query) # :nodoc:
  if multiparam_query?(query)
    escape_query(query)
  elsif query.respond_to?(:read)
    query = query.read
  else
    query.to_s
  end
end

.escape_query(query) ⇒ Object

:nodoc:



848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
 
# File 'lib/httpclient/http.rb', line 848

def escape_query(query) # :nodoc:
  pairs = []
  query.each { |attr, value|
    left = escape(attr.to_s) << '='
    if values = Array.try_convert(value)
      values.each { |value|
        if value.respond_to?(:read)
          value = value.read
        end
        pairs.push(left + escape(value.to_s))
      }
    else
      if value.respond_to?(:read)
        value = value.read
      end
      pairs.push(left << escape(value.to_s))
    end
  }
  pairs.join('&')
end

.file?(obj) ⇒ Boolean

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.)

Returns:

  • (Boolean) 


822
823
824
825
 
# File 'lib/httpclient/http.rb', line 822

def file?(obj)
  obj.respond_to?(:read) and obj.respond_to?(:pos) and
    obj.respond_to?(:pos=)
end

.internal_mime_type(path) ⇒ Object

Default MIME type handler. See mime_type_handler=.



785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'lib/httpclient/http.rb', line 785

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) ⇒ Boolean

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

version

String

Returns:

  • (Boolean) 


806
807
808
 
# File 'lib/httpclient/http.rb', line 806

def keep_alive_enabled?(version)
  version >= '1.1'
end

.mime_type(path) ⇒ Object

:nodoc:



770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'lib/httpclient/http.rb', line 770

def mime_type(path) # :nodoc:
  if @@mime_type_handler
    res = @@mime_type_handler.call(path)
    if !res || res.to_s == ''
      return 'application/octet-stream'
    else
      return res
    end
  else
    internal_mime_type(path)
  end
end

.mime_type_handler ⇒ Object Also known as: get_mime_type_func

Returns MIME type handler.



762
763
764
 
# File 'lib/httpclient/http.rb', line 762

def mime_type_handler
  @@mime_type_handler
end

.mime_type_handler=(handler) ⇒ Object Also known as: set_mime_type_func

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.



757
758
759
 
# File 'lib/httpclient/http.rb', line 757

def mime_type_handler=(handler)
  @@mime_type_handler = handler
end

.multiparam_query?(query) ⇒ Boolean

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

Returns:

  • (Boolean) 


811
812
813
 
# File 'lib/httpclient/http.rb', line 811

def multiparam_query?(query)
  query.is_a?(Array) or query.is_a?(Hash)
end

.new_connect_request(uri) ⇒ Object

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.



701
702
703
704
705
706
 
# File 'lib/httpclient/http.rb', line 701

def new_connect_request(uri)
  m = new
  m.http_header.init_connect_request(uri)
  m.http_header.body_size = nil
  m
end

.new_request(method, uri, query = nil, body = nil, boundary = nil) ⇒ Object

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.



721
722
723
724
725
726
727
728
729
730
731
732
733
 
# File 'lib/httpclient/http.rb', line 721

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

.new_response(body, req = nil) ⇒ Object

Creates a Message instance of response.

body

a String or an IO of response message body.



737
738
739
740
741
742
743
744
 
# File 'lib/httpclient/http.rb', line 737

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

.parse(query) ⇒ Object

from CGI.parse



885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/httpclient/http.rb', line 885

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

.unescape(string) ⇒ Object

from CGI.unescape



899
900
901
902
903
 
# File 'lib/httpclient/http.rb', line 899

def unescape(string)
  string.tr('+', ' ').gsub(/((?:%[0-9a-fA-F]{2})+)/n) do
    [$1.delete('%')].pack('H*')
  end
end

Instance Method Details

#body_encoding ⇒ Object

Returns content encoding



1004
1005
1006
 
# File 'lib/httpclient/http.rb', line 1004

def body_encoding
  @http_header.body_encoding
end

#content ⇒ Object Also known as: body

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



1009
1010
1011
 
# File 'lib/httpclient/http.rb', line 1009

def content
  @http_body.content
end

#content_type ⇒ Object Also known as: contenttype

Returns ‘Content-Type’ header value.



992
993
994
 
# File 'lib/httpclient/http.rb', line 992

def content_type
  @http_header.content_type
end

#content_type=(content_type) ⇒ Object Also known as: contenttype=

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



997
998
999
 
# File 'lib/httpclient/http.rb', line 997

def content_type=(content_type)
  @http_header.content_type = content_type
end

#cookies ⇒ Object

Extracts cookies from ‘Set-Cookie’ header. Supports ‘Set-Cookie’ in response header only. Do we need ‘Cookie’ support in request header?



1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'lib/httpclient/http.rb', line 1027

def cookies
  set_cookies = http_header['set-cookie']
  unless set_cookies.empty?
    uri = http_header.request_uri
    set_cookies.map { |str|
      cookie = WebAgent::Cookie.new
      cookie.parse(str, uri)
      cookie
    }
  end
end

#dump(dev = '') ⇒ Object

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



927
928
929
930
931
932
933
934
935
936
937
 
# File 'lib/httpclient/http.rb', line 927

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

#escape(str) ⇒ Object

:nodoc:



871
872
873
874
875
 
# File 'lib/httpclient/http.rb', line 871

def escape(str) # :nodoc:
  str.dup.force_encoding(Encoding::ASCII_8BIT).gsub(/([^ a-zA-Z0-9_.-]+)/) {
    '%' + $1.unpack('H2' * $1.bytesize).join('%').upcase
  }.tr(' ', '+')
end

#headers ⇒ Object

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)



1020
1021
1022
 
# File 'lib/httpclient/http.rb', line 1020

def headers
  Hash[*http_header.all.flatten]
end

#http_version ⇒ Object

Returns HTTP version in a HTTP header. String.



947
948
949
 
# File 'lib/httpclient/http.rb', line 947

def http_version
  @http_header.http_version
end

#http_version=(http_version) ⇒ Object

Sets HTTP version in a HTTP header. String.



952
953
954
 
# File 'lib/httpclient/http.rb', line 952

def http_version=(http_version)
  @http_header.http_version = http_version
end

#ok? ⇒ Boolean

Convenience method to return boolean of whether we had a successful request

Returns:

  • (Boolean) 


1040
1041
1042
 
# File 'lib/httpclient/http.rb', line 1040

def ok?
  HTTP::Status.successful?(status)
end

#reason ⇒ Object

Returns HTTP status reason phrase in response. String.



982
983
984
 
# File 'lib/httpclient/http.rb', line 982

def reason
  @http_header.reason_phrase
end

#reason=(reason) ⇒ Object

Sets HTTP status reason phrase of response. String.



987
988
989
 
# File 'lib/httpclient/http.rb', line 987

def reason=(reason)
  @http_header.reason_phrase = reason
end

#redirect? ⇒ Boolean

Returns:

  • (Boolean) 


1044
1045
1046
 
# File 'lib/httpclient/http.rb', line 1044

def redirect?
  HTTP::Status.redirect?(status)
end

#see_other? ⇒ Boolean

SEE_OTHER is a redirect, but it should sent as GET

Returns:

  • (Boolean) 


1049
1050
1051
 
# File 'lib/httpclient/http.rb', line 1049

def see_other?
  status == HTTP::Status::SEE_OTHER
end

#status ⇒ Object Also known as: code, status_code

Returns HTTP status code in response. Integer.



968
969
970
 
# File 'lib/httpclient/http.rb', line 968

def status
  @http_header.status_code
end

#status=(status) ⇒ Object

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



977
978
979
 
# File 'lib/httpclient/http.rb', line 977

def status=(status)
  @http_header.status_code = status
end

#version ⇒ Object 



957
958
959
960
 
# File 'lib/httpclient/http.rb', line 957

def version
  warn(VERSION_WARNING)
  @http_header.http_version.to_f
end

#version=(version) ⇒ Object 



962
963
964
965
 
# File 'lib/httpclient/http.rb', line 962

def version=(version)
  warn(VERSION_WARNING)
  @http_header.http_version = version
end