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

USER_AGENT =

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

"httpx.rb/#{VERSION}"

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Callbacks

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

Constructor Details

#initialize(verb, uri, options = {}) ⇒ Request

initializes the instance with the given verb, an absolute or relative uri, and the request options.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/httpx/request.rb', line 51

def initialize(verb, uri, options = {})
  @verb    = verb.to_s.upcase
  @options = Options.new(options)
  @uri     = Utils.to_uri(uri)
  if @uri.relative?
    origin = @options.origin
    raise(Error, "invalid URI: #{@uri}") unless origin

    base_path = @options.base_path

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

  @headers = @options.headers_class.new(@options.headers)
  @headers["user-agent"] ||= USER_AGENT
  @headers["accept"]     ||= "*/*"

  @body = @options.request_body_class.new(@headers, @options)
  @state = :idle
  @response = nil
  @peer_address = nil
  @persistent = @options.persistent
end

Instance Attribute Details

#body ⇒ Object (readonly)

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



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

def body
  @body
end

#drain_error ⇒ Object (readonly)

Exception raised during enumerable body writes.



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

def drain_error
  @drain_error
end

#headers ⇒ Object (readonly)

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



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

def headers
  @headers
end

#options ⇒ Object (readonly)

an HTTPX::Options object containing request options.



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

def options
  @options
end

#peer_address ⇒ Object

The IP address from the peer server.



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

def peer_address
  @peer_address
end

#persistent=(value) ⇒ Object (writeonly)

Sets the attribute persistent

Parameters:

  • value —

    the value to set the attribute persistent to.



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

def persistent=(value)
  @persistent = value
end

#response ⇒ Object

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



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

def response
  @response
end

#state ⇒ Object (readonly)

a symbol describing which frame is currently being flushed.



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

def state
  @state
end

#uri ⇒ Object (readonly)

the absolute URI object for this request.



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

def uri
  @uri
end

#verb ⇒ Object (readonly)

the upcased string HTTP verb for this request.



18
19
20
 
# File 'lib/httpx/request.rb', line 18

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"



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

def authority
  @uri.authority
end

#drain_body ⇒ Object

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/httpx/request.rb', line 183

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) 


244
245
246
 
# File 'lib/httpx/request.rb', line 244

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

#inspect ⇒ Object

:nocov:



199
200
201
202
203
204
205
 
# File 'lib/httpx/request.rb', line 199

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.



103
104
105
106
107
 
# File 'lib/httpx/request.rb', line 103

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

  :w
end

#merge_headers(h) ⇒ Object 



109
110
111
 
# File 'lib/httpx/request.rb', line 109

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"



161
162
163
 
# File 'lib/httpx/request.rb', line 161

def origin
  @uri.origin
end

#path ⇒ Object

returnns the URI path of the request uri.



141
142
143
144
145
146
147
 
# File 'lib/httpx/request.rb', line 141

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) 


90
91
92
 
# File 'lib/httpx/request.rb', line 90

def persistent?
  @persistent
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"



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/httpx/request.rb', line 171

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

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

#read_timeout ⇒ Object

the read timeout defied for this requet.



76
77
78
 
# File 'lib/httpx/request.rb', line 76

def read_timeout
  @options.timeout[:read_timeout]
end

#request_timeout ⇒ Object

the request timeout defied for this requet.



86
87
88
 
# File 'lib/httpx/request.rb', line 86

def request_timeout
  @options.timeout[:request_timeout]
end

#scheme ⇒ Object

the URI scheme of the request uri.



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

def scheme
  @uri.scheme
end

#trailers ⇒ Object 



98
99
100
 
# File 'lib/httpx/request.rb', line 98

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

#trailers? ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/httpx/request.rb', line 94

def trailers?
  defined?(@trailers)
end

#transition(nextstate) ⇒ Object

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/httpx/request.rb', line 209

def transition(nextstate)
  case nextstate
  when :idle
    @body.rewind
    @response = nil
    @drainer = nil
  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 defied for this requet.



81
82
83
 
# File 'lib/httpx/request.rb', line 81

def write_timeout
  @options.timeout[:write_timeout]
end