Class: HTTPX::Request

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Callbacks
Defined in:
lib/httpx/request.rb

Overview

Defines how an HTTP request is handled internally, both in terms of making attributes accessible, as well as maintaining the state machine which manages streaming the request onto the wire.

Direct Known Subclasses

Plugins::Proxy::HTTP::ConnectRequest

Defined Under Namespace

Classes: Body

Constant Summary collapse

ALLOWED_URI_SCHEMES = 
%w[https http].freeze
USER_AGENT =

default value used for “user-agent” header, when not overridden.

"httpx.rb/#{VERSION}".freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Callbacks

#callbacks_for?, #emit, #on, #once

Constructor Details

#initialize(verb, uri, options, params = EMPTY_HASH) ⇒ Request

initializes the instance with the given verb (an upppercase String, ex. ‘GEt’), an absolute or relative uri (either as String or URI::HTTP object), the request options (instance of HTTPX::Options) and an optional Hash of params.

Besides any of the options documented in HTTPX::Options (which would override or merge with what options sets), it accepts also the following:

:params

hash or array of key-values which will be encoded and set in the query string of request uris.

:body

to be encoded in the request body payload. can be a String, an IO object (i.e. a File), or an Enumerable.

:form

hash of array of key-values which will be form-urlencoded- or multipart-encoded in requests body payload.

:json

hash of array of key-values which will be JSON-encoded in requests body payload.

:xml

Nokogiri XML nodes which will be encoded in requests body payload.

:body, :form, :json and :xml are all mutually exclusive, i.e. only one of them gets picked up.

Raises:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/httpx/request.rb', line 70

def initialize(verb, uri, options, params = EMPTY_HASH)
  @verb    = verb.to_s.upcase
  @uri     = Utils.to_uri(uri)

  @headers = options.headers.dup
  merge_headers(params.delete(:headers)) if params.key?(:headers)

  @headers["user-agent"] ||= USER_AGENT
  @headers["accept"]     ||= "*/*"

  # forego compression in the Range request case
  if @headers.key?("range")
    @headers.delete("accept-encoding")
  else
    @headers["accept-encoding"] ||= options.supported_compression_formats
  end

  @query_params = params.delete(:params) if params.key?(:params)

  @body = options.request_body_class.new(@headers, options, **params)

  @options = @body.options

  if @uri.relative? || @uri.host.nil?
    origin = @options.origin
    raise(Error, "invalid URI: #{@uri}") unless origin

    base_path = @options.base_path

    @uri = origin.merge("#{base_path}#{@uri}")
  end

  raise UnsupportedSchemeError, "#{@uri}: #{@uri.scheme}: unsupported URI scheme" unless ALLOWED_URI_SCHEMES.include?(@uri.scheme)

  @state = :idle
  @response = nil
  @peer_address = nil
  @ping = false
  @persistent = @options.persistent
  @active_timeouts = []
end

Instance Attribute Details

#active_timeouts ⇒ Object (readonly)

Returns the value of attribute active_timeouts.



48
49
50
 
# File 'lib/httpx/request.rb', line 48

def active_timeouts
  @active_timeouts
end

#body ⇒ Object (readonly)

an HTTPX::Request::Body object containing the request body payload (or nil, whenn there is none).



29
30
31
 
# File 'lib/httpx/request.rb', line 29

def body
  @body
end

#drain_error ⇒ Object (readonly)

Exception raised during enumerable body writes.



41
42
43
 
# File 'lib/httpx/request.rb', line 41

def drain_error
  @drain_error
end

#headers ⇒ Object (readonly)

an HTTPX::Headers object containing the request HTTP headers.



26
27
28
 
# File 'lib/httpx/request.rb', line 26

def headers
  @headers
end

#options ⇒ Object (readonly)

an HTTPX::Options object containing request options.



35
36
37
 
# File 'lib/httpx/request.rb', line 35

def options
  @options
end

#peer_address ⇒ Object

The IP address from the peer server.



44
45
46
 
# File 'lib/httpx/request.rb', line 44

def peer_address
  @peer_address
end

#persistent=(value) ⇒ Object (writeonly)

Sets the attribute persistent

Parameters:

  • value —

    the value to set the attribute persistent to.



46
47
48
 
# File 'lib/httpx/request.rb', line 46

def persistent=(value)
  @persistent = value
end

#response ⇒ Object

the corresponding HTTPX::Response object, when there is one.



38
39
40
 
# File 'lib/httpx/request.rb', line 38

def response
  @response
end

#state ⇒ Object (readonly)

a symbol describing which frame is currently being flushed.



32
33
34
 
# File 'lib/httpx/request.rb', line 32

def state
  @state
end

#uri ⇒ Object (readonly)

the absolute URI object for this request.



23
24
25
 
# File 'lib/httpx/request.rb', line 23

def uri
  @uri
end

#verb ⇒ Object (readonly)

the upcased string HTTP verb for this request.



20
21
22
 
# File 'lib/httpx/request.rb', line 20

def verb
  @verb
end

Instance Method Details

#authority ⇒ Object

returs the URI authority of the request.

session.build_request("GET", "https://google.com/query").authority #=> "google.com"
session.build_request("GET", "http://internal:3182/a").authority #=> "internal:3182"



203
204
205
 
# File 'lib/httpx/request.rb', line 203

def authority
  @uri.authority
end

#drain_body ⇒ Object

consumes and returns the next available chunk of request body that can be sent



233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/httpx/request.rb', line 233

def drain_body
  return nil if @body.nil?

  @drainer ||= @body.each
  chunk = @drainer.next.dup

  emit(:body_chunk, chunk)
  chunk
rescue StopIteration
  nil
rescue StandardError => e
  @drain_error = e
  nil
end

#expects? ⇒ Boolean

whether the request supports the 100-continue handshake and already processed the 100 response.

Returns:

  • (Boolean) 


298
299
300
 
# File 'lib/httpx/request.rb', line 298

def expects?
  @headers["expect"] == "100-continue" && @informational_status == 100 && !@response
end

#inspect ⇒ Object

:nocov:



249
250
251
252
253
254
255
 
# File 'lib/httpx/request.rb', line 249

def inspect
  "#<HTTPX::Request:#{object_id} " \
    "#{@verb} " \
    "#{uri} " \
    "@headers=#{@headers} " \
    "@body=#{@body}>"
end

#interests ⇒ Object

returns :r or :w, depending on whether the request is waiting for a response or flushing.



152
153
154
155
156
 
# File 'lib/httpx/request.rb', line 152

def interests
  return :r if @state == :done || @state == :expect

  :w
end

#merge_headers(h) ⇒ Object

merges h into the instance of HTTPX::Headers of the request.



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

def merge_headers(h)
  @headers = @headers.merge(h)
end

#origin ⇒ Object

returs the URI origin of the request.

session.build_request("GET", "https://google.com/query").authority #=> "https://google.com"
session.build_request("GET", "http://internal:3182/a").authority #=> "http://internal:3182"



211
212
213
 
# File 'lib/httpx/request.rb', line 211

def origin
  @uri.origin
end

#path ⇒ Object

returnns the URI path of the request uri.



191
192
193
194
195
196
197
 
# File 'lib/httpx/request.rb', line 191

def path
  path = uri.path.dup
  path =  +"" if path.nil?
  path << "/" if path.empty?
  path << "?#{query}" unless query.empty?
  path
end

#persistent? ⇒ Boolean

Returns:

  • (Boolean) 


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

def persistent?
  @persistent
end

#ping! ⇒ Object

marks the request as having been buffered with a ping



118
119
120
 
# File 'lib/httpx/request.rb', line 118

def ping!
  @ping = true
end

#ping? ⇒ Boolean

whether request has been buffered with a ping

Returns:

  • (Boolean) 


113
114
115
 
# File 'lib/httpx/request.rb', line 113

def ping?
  @ping
end

#query ⇒ Object

returs the URI query string of the request (when available).

session.build_request("GET", "https://search.com").query #=> ""
session.build_request("GET", "https://search.com?q=a").query #=> "q=a"
session.build_request("GET", "https://search.com", params: { q: "a"}).query #=> "q=a"
session.build_request("GET", "https://search.com?q=a", params: { foo: "bar"}).query #=> "q=a&foo&bar"



221
222
223
224
225
226
227
228
229
230
 
# File 'lib/httpx/request.rb', line 221

def query
  return @query if defined?(@query)

  query = []
  if (q = @query_params)
    query << Transcoder::Form.encode(q)
  end
  query << @uri.query if @uri.query
  @query = query.join("&")
end

#read_timeout ⇒ Object

the read timeout defined for this request.



123
124
125
 
# File 'lib/httpx/request.rb', line 123

def read_timeout
  @options.timeout[:read_timeout]
end

#request_timeout ⇒ Object

the request timeout defined for this request.



133
134
135
 
# File 'lib/httpx/request.rb', line 133

def request_timeout
  @options.timeout[:request_timeout]
end

#scheme ⇒ Object

the URI scheme of the request uri.



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

def scheme
  @uri.scheme
end

#set_timeout_callback(event, &callback) ⇒ Object 



302
303
304
305
306
307
308
309
 
# File 'lib/httpx/request.rb', line 302

def set_timeout_callback(event, &callback)
  clb = once(event, &callback)

  # reset timeout callbacks when requests get rerouted to a different connection
  once(:idle) do
    callbacks(event).delete(clb)
  end
end

#trailers ⇒ Object

returns an instance of HTTPX::Headers containing the trailer headers



147
148
149
 
# File 'lib/httpx/request.rb', line 147

def trailers
  @trailers ||= @options.headers_class.new
end

#trailers? ⇒ Boolean

if the request contains trailer headers

Returns:

  • (Boolean) 


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

def trailers?
  defined?(@trailers)
end

#transition(nextstate) ⇒ Object

moves on to the nextstate of the request state machine (when all preconditions are met)



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/httpx/request.rb', line 259

def transition(nextstate)
  case nextstate
  when :idle
    @body.rewind
    @ping = false
    @response = nil
    @drainer = nil
    @active_timeouts.clear
  when :headers
    return unless @state == :idle

  when :body
    return unless @state == :headers ||
                  @state == :expect

    if @headers.key?("expect")
      if @informational_status && @informational_status == 100
        # check for 100 Continue response, and deallocate the var
        # if @informational_status == 100
        #   @response = nil
        # end
      else
        return if @state == :expect # do not re-set it

        nextstate = :expect
      end
    end
  when :trailers
    return unless @state == :body
  when :done
    return if @state == :expect

  end
  @state = nextstate
  emit(@state, self)
  nil
end

#write_timeout ⇒ Object

the write timeout defined for this request.



128
129
130
 
# File 'lib/httpx/request.rb', line 128

def write_timeout
  @options.timeout[:write_timeout]
end