Class: URI::HTTP (Ruby 2.7.3)
Description: Class : URI::HTTP - Ruby 2.7.3

### Home Classes Methods

### In Files

- uri/http.rb

### Parent

URI::Generic

### Methods

- ::build
- #request_uri

### Class/Module Index

Quicksearch

- Kernel
- URI
- URI::BadURIError
- URI::Error
- URI::Escape
- URI::FTP
- URI::File
- URI::Generic
- URI::HTTP
- URI::HTTPS
- URI::InvalidComponentError
- URI::InvalidURIError
- URI::LDAP
- URI::LDAPS
- URI::MailTo
- URI::Parser
- URI::REGEXP
- URI::RFC2396_Parser
- URI::RFC2396_REGEXP
- URI::RFC2396_REGEXP::PATTERN

No matching classes.

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

                   # File uri/http.rb, line 60
    def self.build(args)
      tmp = Util.make_components_hash(self, args)
      super(tmp)
    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.

Example:

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

                   # File uri/http.rb, line 78
    def request_uri
      return unless @path

      url = @query ? "#@path?#@query" : @path.dup
      url.start_with?(?/.freeze) ? url : ?/ + url
    end