In Files

  • uri/http.rb

URI::HTTP

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>.

Constants

COMPONENT

An Array of the available components for URI::HTTP

DEFAULT_PORT

A Default port of 80 for URI::HTTP

Public Class Methods

build(args) click to toggle source

Description

Create 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:

newuri = URI::HTTP.build({:host => 'www.example.com',
  :path> => '/foo/bar'})

newuri = 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.

 
               # File uri/http.rb, line 60
def self.build(args)
  tmp = Util::make_components_hash(self, args)
  return super(tmp)
end
            
new(*arg) click to toggle source

Description

Create a new URI::HTTP object from generic URI components as per RFC 2396. No HTTP-specific syntax checking (as per RFC 1738) is performed.

Arguments are scheme, userinfo, host, port, registry, path, opaque, query and fragment, in that order.

Example:

uri = URI::HTTP.new('http', nil, "www.example.com", nil, "/path",
  "query", 'fragment')

See also URI::Generic.new

 
               # File uri/http.rb, line 83
def initialize(*arg)
  super(*arg)
end
            

Public Instance Methods

request_uri() click to toggle source

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.

 
               # File uri/http.rb, line 95
def request_uri
  r = path_query
  if r && r[0] != ?/
    r = '/' + r
  end

  r
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus