class URI::HTTP - Documentation for Ruby 3.2

# class 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¶ ↑

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.

Calls superclass method `URI::Generic::build`

    # File lib/uri/http.rb, line 59
    def self.build(args)
      tmp = Util.make_components_hash(self, args)
      super(tmp)
    end

### Public Instance Methods

authority() click to toggle source

## Description¶ ↑

Returns the authority for an `HTTP` uri, as defined in datatracker.ietf.org/doc/html/rfc3986/#section-3.2.

Example:

    URI::HTTP.build(host: 'www.example.com', path: '/foo/bar').authority #=> "www.example.com"
    URI::HTTP.build(host: 'www.example.com', port: 8000, path: '/foo/bar').authority #=> "www.example.com:8000"
    URI::HTTP.build(host: 'www.example.com', port: 80, path: '/foo/bar').authority #=> "www.example.com"

    # File lib/uri/http.rb, line 97
    def authority
      if port == default_port
        host
      else
        "#{host}:#{port}"
      end
    end

origin() click to toggle source

## Description¶ ↑

Returns the origin for an `HTTP` uri, as defined in datatracker.ietf.org/doc/html/rfc6454.

Example:

    URI::HTTP.build(host: 'www.example.com', path: '/foo/bar').origin #=> "http://www.example.com"
    URI::HTTP.build(host: 'www.example.com', port: 8000, path: '/foo/bar').origin #=> "http://www.example.com:8000"
    URI::HTTP.build(host: 'www.example.com', port: 80, path: '/foo/bar').origin #=> "http://www.example.com"
    URI::HTTPS.build(host: 'www.example.com', path: '/foo/bar').origin #=> "https://www.example.com"

    # File lib/uri/http.rb, line 119
    def origin
      "#{scheme}://#{authority}"
    end

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.

Example:

    uri = URI::HTTP.build(path: '/foo/bar', query: 'test=true')
    uri.request_uri #  => "/foo/bar?test=true"

    # 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