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,
lib/http/request/caching.rb

Direct Known Subclasses

Caching

Defined Under Namespace

Classes: Caching, UnsupportedMethodError, UnsupportedSchemeError, Writer

Constant Summary collapse

USER_AGENT =

Default User-Agent header value

"RubyHTTPGem/#{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(verb, uri, headers = {}, proxy = {}, body = nil, version = "1.1") ⇒ Request

:nodoc:



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

def initialize(verb, uri, headers = {}, proxy = {}, body = nil, version = "1.1") # rubocop:disable ParameterLists
  @verb   = verb.to_s.downcase.to_sym
  @uri    = HTTP::URI.parse uri
  @scheme = @uri.scheme && @uri.scheme.to_s.downcase.to_sym

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

  @proxy, @body, @version = proxy, body, version

  @headers = HTTP::Headers.coerce(headers || {})

  @headers["Host"]        ||= default_host_header_value
  @headers["User-Agent"]  ||= USER_AGENT
end

Instance Attribute Details

#body ⇒ Object (readonly)

Returns the value of attribute body.



72
73
74
 
# File 'lib/http/request.rb', line 72

def body
  @body
end

#proxy ⇒ Object (readonly)

Returns the value of attribute proxy.



72
73
74
 
# File 'lib/http/request.rb', line 72

def proxy
  @proxy
end

#scheme ⇒ Object (readonly)

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



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

def scheme
  @scheme
end

#uri ⇒ Object (readonly)

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



71
72
73
 
# File 'lib/http/request.rb', line 71

def uri
  @uri
end

#verb ⇒ Object (readonly)

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



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

def verb
  @verb
end

#version ⇒ Object (readonly)

Returns the value of attribute version.



72
73
74
 
# File 'lib/http/request.rb', line 72

def version
  @version
end

Instance Method Details

#__method__(*args) ⇒ Object

The following alias may be removed in two minor versions (0.8.0) or one major version (1.0.0)



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

def __method__(*args)
  warn "#{Kernel.caller.first}: [DEPRECATION] HTTP::Request#__method__ is deprecated. Use #method instead."
  method(*args)
end

#caching ⇒ HTTP::Request::Caching

Returns:



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

def caching
  Caching.new self
end

#include_proxy_authorization_header ⇒ Object

Compute and add the Proxy-Authorization header



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

def include_proxy_authorization_header
  digest = Base64.encode64("#{proxy[:proxy_username]}:#{proxy[:proxy_password]}").chomp
  headers["Proxy-Authorization"] = "Basic #{digest}"
end

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

Returns new Request with updated uri



92
93
94
95
96
 
# File 'lib/http/request.rb', line 92

def redirect(uri, verb = @verb)
  req = self.class.new(verb, @uri.join(uri), headers, proxy, body, version)
  req["Host"] = req.uri.host
  req
end

#request_header ⇒ Object

Compute HTTP request header for direct or proxy request



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

def request_header
  "#{verb.to_s.upcase} #{uri.normalize} HTTP/#{version}"
end

#socket_host ⇒ Object

Host for tcp socket



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

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

#socket_port ⇒ Object

Port for tcp socket



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

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

#stream(socket) ⇒ Object

Stream the request to a socket



99
100
101
102
 
# File 'lib/http/request.rb', line 99

def stream(socket)
  include_proxy_authorization_header if using_authenticated_proxy?
  Request::Writer.new(socket, body, headers, request_header).stream
end

#using_authenticated_proxy? ⇒ Boolean

Is this request using an authenticated proxy?

Returns:

  • (Boolean) 


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

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

#using_proxy? ⇒ Boolean

Is this request using a proxy?

Returns:

  • (Boolean) 


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

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