Class: URI::HTTP
Overview
The syntax of HTTP URIs is defined in RFC1738 section 3.3.
Note that the Ruby URI library allows HTTP URLs containing usernames and passwords. This is not legal as per the RFC, but used to be supported in Internet Explorer 5 and 6, before the MS04-004 security update. See <URL:support.microsoft.com/kb/834489>.
Direct Known Subclasses
Constant Summary collapse
- DEFAULT_PORT =
A Default port of 80 for URI::HTTP.
80
- COMPONENT =
An Array of the available components for URI::HTTP.
i[ scheme userinfo host port path query fragment ].freeze
Constants inherited from Generic
Constants included from URI
DEFAULT_PARSER, Parser, REGEXP, RFC3986_PARSER, TBLDECWWWCOMP_, TBLENCWWWCOMP_, VERSION, VERSION_CODE
Instance Attribute Summary
Attributes inherited from Generic
#fragment, #host, #opaque, #path, #port, #query, #scheme
Class Method Summary collapse
-
.build(args) ⇒ Object
Description.
Instance Method Summary collapse
-
#request_uri ⇒ Object
Description.
Methods inherited from Generic
#==, #absolute?, build2, #coerce, #component, component, #default_port, default_port, #eql?, #find_proxy, #hash, #hierarchical?, #hostname, #hostname=, #initialize, #inspect, #merge, #merge!, #normalize, #normalize!, #parser, #password, #password=, #registry, #registry=, #relative?, #route_from, #route_to, #select, #to_s, use_proxy?, use_registry, #user, #user=, #userinfo, #userinfo=
Methods included from URI
decode_www_form, decode_www_form_component, encode_www_form, encode_www_form_component, extract, for, join, parse, regexp, scheme_list, split
Constructor Details
This class inherits a constructor from URI::Generic
Class Method Details
.build(args) ⇒ Object
Description
Creates a new URI::HTTP object from components, with syntax checking.
The components accepted are userinfo, host, port, path, query, and fragment.
The components should be provided either as an Array, or as a Hash with keys formed by preceding the component names with a colon.
If an Array is used, the components must be passed in the order [userinfo, host, port, path, query, fragment]
.
Example:
uri = URI::HTTP.build(host: 'www.example.com', path: '/foo/bar')
uri = URI::HTTP.build([nil, "www.example.com", nil, "/path",
"query", 'fragment'])
Currently, if passed userinfo components this method generates invalid HTTP URIs as per RFC 1738.
59 60 61 62 |
# File 'lib/uri/http.rb', line 59 def self.build(args) tmp = Util.make_components_hash(self, args) super(tmp) end |
Instance Method Details
#request_uri ⇒ Object
Description
Returns the full path for an HTTP request, as required by Net::HTTP::Get.
If the URI contains a query, the full path is URI#path + ‘?’ + URI#query. Otherwise, the path is simply URI#path.
Example:
uri = URI::HTTP.build(path: '/foo/bar', query: 'test=true')
uri.request_uri # => "/foo/bar?test=true"
77 78 79 80 81 82 |
# File 'lib/uri/http.rb', line 77 def request_uri return unless @path url = @query ? "#@path?#@query" : @path.dup url.start_with?(?/.freeze) ? url : ?/ + url end |