Class: HTTP::Request

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Headers::Mixin
Defined in:
lib/http/request.rb,
lib/http/request/writer.rb

Defined Under Namespace

Classes: UnsupportedMethodError, UnsupportedSchemeError, Writer

Constant Summary collapse

USER_AGENT =

Default User-Agent header value

"http.rb/#{HTTP::VERSION}".freeze
METHODS =

RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1

[:options, :get, :head, :post, :put, :delete, :trace, :connect]
SCHEMES =

Allowed schemes

[:http, :https, :ws, :wss]
PORTS =

Default ports of supported schemes

{
  :http   => 80,
  :https  => 443,
  :ws     => 80,
  :wss    => 443
}

Instance Attribute Summary collapse

Attributes included from Headers::Mixin

#headers

Instance Method Summary collapse

Methods included from Headers::Mixin

#[], #[]=

Constructor Details

#initialize(opts) ⇒ Request

Returns a new instance of Request.

Parameters:

  • opts (Hash) —

    a customizable set of options

Options Hash (opts):

  • :version (String)
  • :verb (#to_s) —

    HTTP request method

  • :uri (HTTP::URI, #to_s)
  • :headers (Hash)
  • :proxy (Hash)
  • :body (String) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/http/request.rb', line 72

def initialize(opts)
  @verb   = opts.fetch(:verb).to_s.downcase.to_sym
  @uri    = normalize_uri(opts.fetch :uri)
  @scheme = @uri.scheme.to_s.downcase.to_sym if @uri.scheme

  fail(UnsupportedMethodError, "unknown method: #{verb}") unless METHODS.include?(@verb)
  fail(UnsupportedSchemeError, "unknown scheme: #{scheme}") unless SCHEMES.include?(@scheme)

  @proxy   = opts[:proxy] || {}
  @body    = opts[:body]
  @version = opts[:version] || "1.1"
  @headers = HTTP::Headers.coerce(opts[:headers] || {})

  @headers[Headers::HOST]        ||= default_host_header_value
  @headers[Headers::USER_AGENT]  ||= USER_AGENT
end

Instance Attribute Details

#body ⇒ Object (readonly)

Returns the value of attribute body.



64
65
66
 
# File 'lib/http/request.rb', line 64

def body
  @body
end

#proxy ⇒ Object (readonly)

Returns the value of attribute proxy.



64
65
66
 
# File 'lib/http/request.rb', line 64

def proxy
  @proxy
end

#scheme ⇒ Object (readonly)

Scheme is normalized to be a lowercase symbol e.g. :http, :https



59
60
61
 
# File 'lib/http/request.rb', line 59

def scheme
  @scheme
end

#uri ⇒ Object (readonly)

"Request URI" as per RFC 2616 http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html



63
64
65
 
# File 'lib/http/request.rb', line 63

def uri
  @uri
end

#verb ⇒ Object (readonly)

Method is given as a lowercase symbol e.g. :get, :post



56
57
58
 
# File 'lib/http/request.rb', line 56

def verb
  @verb
end

#version ⇒ Object (readonly)

Returns the value of attribute version.



64
65
66
 
# File 'lib/http/request.rb', line 64

def version
  @version
end

Instance Method Details

#connect_using_proxy(socket) ⇒ Object

Setup tunnel through proxy for SSL request



131
132
133
 
# File 'lib/http/request.rb', line 131

def connect_using_proxy(socket)
  Request::Writer.new(socket, nil, proxy_connect_headers, proxy_connect_header).connect_through_proxy
end

#headline ⇒ Object

Compute HTTP request header for direct or proxy request



136
137
138
139
 
# File 'lib/http/request.rb', line 136

def headline
  request_uri = using_proxy? ? uri : uri.omit(:scheme, :authority)
  "#{verb.to_s.upcase} #{request_uri.omit :fragment} HTTP/#{version}"
end

#include_proxy_authorization_header ⇒ Object

Compute and add the Proxy-Authorization header



121
122
123
 
# File 'lib/http/request.rb', line 121

def include_proxy_authorization_header
  headers[Headers::PROXY_AUTHORIZATION] = proxy_authorization_header
end

#proxy_authorization_header ⇒ Object 



125
126
127
128
 
# File 'lib/http/request.rb', line 125

def proxy_authorization_header
  digest = Base64.strict_encode64("#{proxy[:proxy_username]}:#{proxy[:proxy_password]}")
  "Basic #{digest}"
end

#proxy_connect_header ⇒ Object

Compute HTTP request header SSL proxy connection



142
143
144
 
# File 'lib/http/request.rb', line 142

def proxy_connect_header
  "CONNECT #{host}:#{port} HTTP/#{version}"
end

#proxy_connect_headers ⇒ Object

Headers to send with proxy connect request



147
148
149
150
151
152
153
154
155
156
 
# File 'lib/http/request.rb', line 147

def proxy_connect_headers
  connect_headers = HTTP::Headers.coerce(
    Headers::HOST        => headers[Headers::HOST],
    Headers::USER_AGENT  => headers[Headers::USER_AGENT]
  )

  connect_headers[Headers::PROXY_AUTHORIZATION] = proxy_authorization_header if using_authenticated_proxy?

  connect_headers
end

#redirect(uri, verb = @verb) ⇒ Object

Returns new Request with updated uri



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/http/request.rb', line 90

def redirect(uri, verb = @verb)
  req = self.class.new(
    :verb    => verb,
    :uri     => @uri.join(uri),
    :headers => headers,
    :proxy   => proxy,
    :body    => body,
    :version => version
  )

  req[Headers::HOST] = req.uri.host
  req
end

#socket_host ⇒ Object

Host for tcp socket



159
160
161
 
# File 'lib/http/request.rb', line 159

def socket_host
  using_proxy? ? proxy[:proxy_address] : host
end

#socket_port ⇒ Object

Port for tcp socket



164
165
166
 
# File 'lib/http/request.rb', line 164

def socket_port
  using_proxy? ? proxy[:proxy_port] : port
end

#stream(socket) ⇒ Object

Stream the request to a socket



105
106
107
108
 
# File 'lib/http/request.rb', line 105

def stream(socket)
  include_proxy_authorization_header if using_authenticated_proxy? && !@uri.https?
  Request::Writer.new(socket, body, headers, headline).stream
end

#using_authenticated_proxy? ⇒ Boolean

Is this request using an authenticated proxy?

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/http/request.rb', line 116

def using_authenticated_proxy?
  proxy && proxy.keys.size == 4
end

#using_proxy? ⇒ Boolean

Is this request using a proxy?

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/http/request.rb', line 111

def using_proxy?
  proxy && proxy.keys.size >= 2
end