Class: Net::HTTPGenericRequest
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
HTTPHeader
|
|
Inherits: | Object |
Defined in: | lib/net/http/generic_request.rb |
Overview
HTTPGenericRequest
is the parent of the HTTPRequest class. Do not use this directly; use a subclass of HTTPRequest.
Mixes in the HTTPHeader module to provide easier access to HTTP headers.
Class Method Summary
Instance Attribute Summary
- #body rw
- #body=(str) rw
- #body_stream rw
- #body_stream=(input) rw
- #body_exist? ⇒ Boolean readonly
-
#decode_content
readonly
Automatically set to false if the user sets the Accept-Encoding header.
- #method readonly
- #path readonly
- #request_body_permitted? ⇒ Boolean readonly
- #response_body_permitted? ⇒ Boolean readonly
- #uri readonly
HTTPHeader - Included
#content_length | Returns an Integer object which represents the HTTP Content-Length: header field, or |
#content_length=, | |
#chunked? | Returns “true” if the “transfer-encoding” header is present and set to “chunked”. |
#connection_close?, #connection_keep_alive? |
Instance Method Summary
- #encode_multipart_form_data(out, params, opt)
- #flush_buffer(out, buf, chunked_p)
- #inspect
- #quote_string(str, charset)
- #send_request_with_body(sock, ver, path, body)
- #send_request_with_body_data(sock, ver, path, params)
- #send_request_with_body_stream(sock, ver, path, f)
- #supply_default_content_type
-
#wait_for_continue(sock, ver)
Waits up to the continue timeout for a response from the server provided we're speaking HTTP 1.1 and are expecting a 100-continue response.
- #write_header(sock, ver, path)
HTTPHeader - Included
#[] | Returns the header field corresponding to the case-insensitive key. |
#[]= | Sets the header field corresponding to the case-insensitive key. |
#add_field |
|
#basic_auth | Set the Authorization: header for “Basic” authorization. |
#canonical_each | Alias for HTTPHeader#each_capitalized. |
#content_range | Returns a Range object which represents the value of the Content-Range: header field. |
#content_type | Returns a content type string such as “text/html”. |
#content_type= | Alias for HTTPHeader#set_content_type. |
#delete | Removes a header field, specified by case-insensitive key. |
#each | Alias for HTTPHeader#each_header. |
#each_capitalized | As for |
#each_capitalized_name | Iterates through the header names in the header, passing capitalized header names to the code block. |
#each_header | Iterates through the header names and values, passing in the name and value to the code block supplied. |
#each_key | Alias for HTTPHeader#each_name. |
#each_name | Iterates through the header names in the header, passing each header name to the code block. |
#each_value | Iterates through header values, passing each value to the code block. |
#fetch | Returns the header field corresponding to the case-insensitive key. |
#form_data= | Alias for HTTPHeader#set_form_data. |
#get_fields |
|
#initialize_http_header, | |
#key? | true if |
#main_type | Returns a content type string such as “text”. |
#proxy_basic_auth | Set Proxy-Authorization: header for “Basic” authorization. |
#range | Returns an Array of Range objects which represent the Range: HTTP header field, or |
#range= | Alias for HTTPHeader#set_range. |
#range_length | The length of the range represented in Content-Range: header. |
#set_content_type | Sets the content type in an HTTP header. |
#set_form | Set a HTML form data set. |
#set_form_data | Set header fields and a body from HTML form data. |
#set_range | Sets the HTTP Range: header. |
#sub_type | Returns a content type string such as “html”. |
#to_hash | Returns a Hash consisting of header names and array of values. |
#type_params | Any parameters specified for the content type, returned as a Hash. |
#append_field_value, #basic_encode, #capitalize, #set_field, #tokens |
Constructor Details
.new(m, reqbody, resbody, uri_or_path, initheader = nil) ⇒ HTTPGenericRequest
# File 'lib/net/http/generic_request.rb', line 11
def initialize(m, reqbody, resbody, uri_or_path, initheader = nil) @method = m @request_has_body = reqbody @response_has_body = resbody if URI === uri_or_path then @uri = uri_or_path.dup host = @uri.hostname.dup host << ":".freeze << @uri.port.to_s if @uri.port != @uri.default_port @path = uri_or_path.request_uri raise ArgumentError, "no HTTP request path given" unless @path else @uri = nil host = nil raise ArgumentError, "no HTTP request path given" unless uri_or_path raise ArgumentError, "HTTP request path is empty" if uri_or_path.empty? @path = uri_or_path.dup end @decode_content = false if @response_has_body and Net::HTTP::HAVE_ZLIB then if !initheader || !initheader.keys.any? { |k| %w[accept-encoding range].include? k.downcase } then @decode_content = true initheader = initheader ? initheader.dup : {} initheader["accept-encoding"] = "gzip;q=1.0,deflate;q=0.6,identity;q=0.3" end end initialize_http_header initheader self['Accept'] ||= '*/*' self['User-Agent'] ||= 'Ruby' self['Host'] ||= host if host @body = nil @body_stream = nil @body_data = nil end
Instance Attribute Details
#body (rw)
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 89
attr_reader :body
#body=(str) (rw)
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 91
def body=(str) @body = str @body_stream = nil @body_data = nil str end
#body_exist? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/net/http/generic_request.rb', line 84
def body_exist? warn "Net::HTTPRequest#body_exist? is obsolete; use response_body_permitted?" if $VERBOSE response_body_permitted? end
#body_stream (rw)
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 98
attr_reader :body_stream
#body_stream=(input) (rw)
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 100
def body_stream=(input) @body = nil @body_stream = input @body_data = nil input end
#decode_content (readonly)
Automatically set to false if the user sets the Accept-Encoding header. This indicates they wish to handle Content-encoding in responses themselves.
# File 'lib/net/http/generic_request.rb', line 60
attr_reader :decode_content
#method (readonly)
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 53
attr_reader :method
#path (readonly)
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 54
attr_reader :path
#request_body_permitted? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/net/http/generic_request.rb', line 76
def request_body_permitted? @request_has_body end
#response_body_permitted? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/net/http/generic_request.rb', line 80
def response_body_permitted? @response_has_body end
#uri (readonly)
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 55
attr_reader :uri
Instance Method Details
#encode_multipart_form_data(out, params, opt)
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 236
def encode_multipart_form_data(out, params, opt) charset = opt[:charset] boundary = opt[:boundary] require 'securerandom' unless defined?(SecureRandom) boundary ||= SecureRandom.urlsafe_base64(40) chunked_p = chunked? buf = '' params.each do |key, value, h={}| key = quote_string(key, charset) filename = h.key?(:filename) ? h[:filename] : value.respond_to?(:to_path) ? File.basename(value.to_path) : nil buf << "--#{boundary}\r\n" if filename filename = quote_string(filename, charset) type = h[:content_type] || 'application/octet-stream' buf << "Content-Disposition: form-data; " \ "name=\"#{key}\"; filename=\"#{filename}\"\r\n" \ "Content-Type: #{type}\r\n\r\n" if !out.respond_to?(:write) || !value.respond_to?(:read) # if out is not an IO or value is not an IO buf << (value.respond_to?(:read) ? value.read : value) elsif value.respond_to?(:size) && chunked_p # if out is an IO and value is a File, use IO.copy_stream flush_buffer(out, buf, chunked_p) out << "%x\r\n" % value.size if chunked_p IO.copy_stream(value, out) out << "\r\n" if chunked_p else # out is an IO, and value is not a File but an IO flush_buffer(out, buf, chunked_p) 1 while flush_buffer(out, value.read(4096), chunked_p) end else # non-file field: # HTML5 says, "The parts of the generated multipart/form-data # resource that correspond to non-file fields must not have a # Content-Type header specified." buf << "Content-Disposition: form-data; name=\"#{key}\"\r\n\r\n" buf << (value.respond_to?(:read) ? value.read : value) end buf << "\r\n" end buf << "--#{boundary}--\r\n" flush_buffer(out, buf, chunked_p) out << "0\r\n\r\n" if chunked_p end
#flush_buffer(out, buf, chunked_p)
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 292
def flush_buffer(out, buf, chunked_p) return unless buf out << "%x\r\n"%buf.bytesize if chunked_p out << buf out << "\r\n" if chunked_p buf.clear end
#inspect
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 62
def inspect "\#<#{self.class} #{@method}>" end
#quote_string(str, charset)
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 287
def quote_string(str, charset) str = str.encode(charset, fallback:->(c){'&#%d;'%c.encode("UTF-8").ord}) if charset str.gsub(/[\\"]/, '\\\\\&') end
#send_request_with_body(sock, ver, path, body)
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 182
def send_request_with_body(sock, ver, path, body) self.content_length = body.bytesize delete 'Transfer-Encoding' supply_default_content_type write_header sock, ver, path wait_for_continue sock, ver if sock.continue_timeout sock.write body end
#send_request_with_body_data(sock, ver, path, params)
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 210
def send_request_with_body_data(sock, ver, path, params) if /\Amultipart\/form-data\z/i !~ self.content_type self.content_type = 'application/x-www-form-urlencoded' return send_request_with_body(sock, ver, path, URI.encode_www_form(params)) end opt = @form_option.dup require 'securerandom' unless defined?(SecureRandom) opt[:boundary] ||= SecureRandom.urlsafe_base64(40) self.set_content_type(self.content_type, boundary: opt[:boundary]) if chunked? write_header sock, ver, path encode_multipart_form_data(sock, params, opt) else require 'tempfile' file = Tempfile.new('multipart') file.binmode encode_multipart_form_data(file, params, opt) file.rewind self.content_length = file.size write_header sock, ver, path IO.copy_stream(file, sock) file.close(true) end end
#send_request_with_body_stream(sock, ver, path, f)
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 191
def send_request_with_body_stream(sock, ver, path, f) unless content_length() or chunked? raise ArgumentError, "Content-Length not given and Transfer-Encoding is not `chunked'" end supply_default_content_type write_header sock, ver, path wait_for_continue sock, ver if sock.continue_timeout if chunked? chunker = Chunker.new(sock) IO.copy_stream(f, chunker) chunker.finish else # copy_stream can sendfile() to sock.io unless we use SSL. # If sock.io is an SSLSocket, copy_stream will hit SSL_write() IO.copy_stream(f, sock.io) end end
#supply_default_content_type
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 300
def supply_default_content_type return if content_type() warn 'net/http: warning: Content-Type did not set; using application/x-www-form-urlencoded' if $VERBOSE set_content_type 'application/x-www-form-urlencoded' end
#wait_for_continue(sock, ver)
Waits up to the continue timeout for a response from the server provided we're speaking HTTP 1.1 and are expecting a 100-continue response.
# File 'lib/net/http/generic_request.rb', line 310
def wait_for_continue(sock, ver) if ver >= '1.1' and @header['expect'] and @header['expect'].include?('100-continue') if sock.io.to_io.wait_readable(sock.continue_timeout) res = Net::HTTPResponse.read_new(sock) unless res.kind_of?(Net::HTTPContinue) res.decode_content = @decode_content throw :response, res end end end end
#write_header(sock, ver, path)
[ GitHub ]# File 'lib/net/http/generic_request.rb', line 323
def write_header(sock, ver, path) reqline = "#{@method} #{path} HTTP/#{ver}" if /[\r\n]/ =~ reqline raise ArgumentError, "A Request-Line must not contain CR or LF" end buf = "" buf << reqline << "\r\n" each_capitalized do |k,v| buf << "#{k}: #{v}\r\n" end buf << "\r\n" sock.write buf end