123456789_123456789_123456789_123456789_123456789_

Class: Net::HTTPRequest

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
Net::HTTP::Copy, Net::HTTP::Delete, Net::HTTP::Get, Net::HTTP::Head, Net::HTTP::Lock, Net::HTTP::Mkcol, Net::HTTP::Move, Net::HTTP::Options, Net::HTTP::Patch, Net::HTTP::Post, Net::HTTP::Propfind, Net::HTTP::Proppatch, Net::HTTP::Put, Net::HTTP::Trace, Net::HTTP::Unlock
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, HTTPGenericRequest
Instance Chain:
self, HTTPGenericRequest, HTTPHeader
Inherits: Net::HTTPGenericRequest
Defined in: lib/net/http/request.rb

Overview

HTTP request class. This class wraps together the request header and the request path. You cannot use this class directly. Instead, you should use one of its subclasses: HTTP::Get, HTTP::Post, HTTP::Head.

Class Method Summary

HTTPGenericRequest - Inherited

.new

Instance Attribute Summary

HTTPGenericRequest - Inherited

#body, #body=, #body_exist?, #body_stream, #body_stream=,
#decode_content

Automatically set to false if the user sets the Accept-Encoding header.
#method, #path, #request_body_permitted?, #response_body_permitted?, #uri

HTTPHeader - Included

#chunked?

Returns “true” if the “transfer-encoding” header is present and set to “chunked”.
#connection_close?, #connection_keep_alive?,
#content_length

Returns an Integer object which represents the HTTP Content-Length: header field, or nil if that field was not provided.
#content_length=

Instance Method Summary

HTTPGenericRequest - Inherited

#encode_multipart_form_data, #flush_buffer, #inspect, #quote_string, #send_request_with_body, #send_request_with_body_data, #send_request_with_body_stream, #supply_default_content_type,
#wait_for_continue

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,
#[]=

Don’t automatically decode response content-encoding if the user indicates they want to handle it.
#exec

write.
#set_body_internal

internal use only.
#update_uri

internal use only.

HTTPHeader - Included

#[]

Returns the header field corresponding to the case-insensitive key.
#[]=

Sets the header field corresponding to the case-insensitive key.
#add_field
Ruby 1.8.3

Adds a value to a named header field, instead of replacing its value.
#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_header, except the keys are provided in capitalized form.
#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
Ruby 1.8.3

Returns an array of header field strings corresponding to the case-insensitive key.
#initialize_http_header,
#key?

true if key header exists.
#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 nil if there is no such header.
#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 an 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,
#length

Alias for HTTPHeader#size.
#size

obsolete.

Constructor Details

.new(path, initheader = nil) ⇒ HTTPRequest

Creates an HTTP request object for path.

initheader are the default headers to use. HTTP adds Accept-Encoding to enable compression of the response body unless Accept-Encoding or Range are supplied in initheader.

[ GitHub ] 

  


# File 'lib/net/http/request.rb', line 14



def initialize(path, initheader = nil)
  super self.class::METHOD,
        self.class::REQUEST_HAS_BODY,
        self.class::RESPONSE_HAS_BODY,
        path, initheader
end