Class: Gem::URI::HTTP

Inherits:
Generic show all
Defined in:
lib/rubygems/vendor/uri/lib/uri/http.rb

Overview

The syntax of HTTP URIs is defined in RFC1738 section 3.3.

Note that the Ruby Gem::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

HTTPS

Constant Summary collapse

DEFAULT_PORT =

A Default port of 80 for Gem::URI::HTTP.

80
COMPONENT =

An Array of the available components for Gem::URI::HTTP.

%i[
  scheme
  userinfo host port
  path
  query
  fragment
].freeze

Constants inherited from Generic

Generic::USE_REGISTRY

Constants included from Gem::URI

DEFAULT_PARSER, Parser, REGEXP, RFC2396_PARSER, RFC3986_PARSER, TBLDECWWWCOMP_, TBLENCURICOMP_, TBLENCWWWCOMP_, VERSION, VERSION_CODE

Instance Attribute Summary

Attributes inherited from Generic

#fragment, #host, #opaque, #path, #port, #query, #scheme

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Generic

#==, #absolute?, build2, #coerce, #component, component, #decoded_password, #decoded_user, #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 Gem::URI

decode_uri_component, decode_www_form, decode_www_form_component, encode_uri_component, encode_www_form, encode_www_form_component, extract, for, join, parse, regexp, register_scheme, scheme_list, split

Constructor Details

This class inherits a constructor from Gem::URI::Generic

Class Method Details

.build(args) ⇒ Object

Description

Creates a new Gem::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 = Gem::URI::HTTP.build(host: 'www.example.com', path: '/foo/bar')

uri = Gem::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/rubygems/vendor/uri/lib/uri/http.rb', line 59

def self.build(args)
  tmp = Util.make_components_hash(self, args)
  super(tmp)
end

Instance Method Details

#authority ⇒ Object

Description

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

Example:

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



97
98
99
100
101
102
103
 
# File 'lib/rubygems/vendor/uri/lib/uri/http.rb', line 97

def authority
  if port == default_port
    host
  else
    "#{host}:#{port}"
  end
end

#origin ⇒ Object

Description

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

Example:

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



119
120
121
 
# File 'lib/rubygems/vendor/uri/lib/uri/http.rb', line 119

def origin
  "#{scheme}://#{authority}"
end

#request_uri ⇒ Object

Description

Returns the full path for an HTTP request, as required by Net::HTTP::Get.

If the Gem::URI contains a query, the full path is Gem::URI#path + ‘?’ + Gem::URI#query. Otherwise, the path is simply Gem::URI#path.

Example:

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



77
78
79
80
81
82
 
# File 'lib/rubygems/vendor/uri/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