class URI

Overview

This class represents a URI reference as defined by [RFC 3986: Uniform Resource Identifier (URI): Generic Syntax](https://www.ietf.org/rfc/rfc3986.txt).

This class provides constructors for creating URI instances from their components or by parsing their string forms and methods for accessing the various components of an instance.

Basic example:

require "uri"

uri = URI.parse "http://foo.com/posts?id=30&limit=5#time=1305298413"
# => #<URI:0x1003f1e40 @scheme="http", @host="foo.com", @port=nil, @path="/posts", @query="id=30&limit=5", ... >
uri.scheme
# => "http"
uri.host
# => "foo.com"
uri.query
# => "id=30&limit=5"
uri.to_s
# => "http://foo.com/posts?id=30&limit=5#time=1305298413"

Superclass hierarchy

Defined in:

Constant Summary

• RFC3986_relative_ref = /\\A(?<relative_ref>(?<relative_part>\\/\\/(?<authority>(?:(?<userinfo>(?:%\\h\\h|[!$&-.0-;=A-Z_a-z~])*)@)?(?<host>(?<IP_literal>\\[(?<IPv6address>(?:\\h{1,4}:){6}(?<ls32>\\h{1,4}:\\h{1,4}|(?<IPv4address>(?<dec_octet>[1-9]\\d|1\\d{2}|2[0-4]\\d|25[0-5]|\\d)\\.\\g<dec_octet>\\.\\g<dec_octet>\\.\\g<dec_octet>))|::(?:\\h{1,4}:){5}\\g<ls32>|\\h{1,4}?::(?:\\h{1,4}:){4}\\g<ls32>|(?:(?:\\h{1,4}:){,1}\\h{1,4})?::(?:\\h{1,4}:){3}\\g<ls32>|(?:(?:\\h{1,4}:){,2}\\h{1,4})?::(?:\\h{1,4}:){2}\\g<ls32>|(?:(?:\\h{1,4}:){,3}\\h{1,4})?::\\h{1,4}:\\g<ls32>|(?:(?:\\h{1,4}:){,4}\\h{1,4})?::\\g<ls32>|(?:(?:\\h{1,4}:){,5}\\h{1,4})?::\\h{1,4}|(?:(?:\\h{1,4}:){,6}\\h{1,4})?::)|(?<IPvFuture>v\\h+\\.[!$&-.0-;=A-Z_a-z~]+)\\])|\\g<IPv4address>|(?<reg_name>(?:%\\h\\h|[!$&-.0-9;=A-Z_a-z~])+))?(?::(?<port>\\d*))?)(?<path_abempty>(?:\\/(?<segment>(?:%\\h\\h|[!$&-.0-;=@-Z_a-z~])*))*)|(?<path_absolute>\\/(?:(?<segment_nz>(?:%\\h\\h|[!$&-.0-;=@-Z_a-z~])+)(?:\\/\\g<segment>)*)?)|(?<path_noscheme>(?<segment_nz_nc>(?:%\\h\\h|[!$&-.0-9;=@-Z_a-z~])+)(?:\\/\\g<segment>)*)|(?<path_empty>))(?:\\?(?<query>[^#]*))?(?:\\#(?<fragment>(?:%\\h\\h|[!$&-.0-;=@-Z_a-z~\\/?])*))?)\\z/
• RFC3986_URI = /\\A(?<URI>(?<scheme>[A-Za-z][+\\-.0-9A-Za-z]*):(?<hier_part>\\/\\/(?<authority>(?:(?<userinfo>(?:%\\h\\h|[!$&-.0-;=A-Z_a-z~])*)@)?(?<host>(?<IP_literal>\\[(?:(?<IPv6address>(?:\\h{1,4}:){6}(?<ls32>\\h{1,4}:\\h{1,4}|(?<IPv4address>(?<dec_octet>[1-9]\\d|1\\d{2}|2[0-4]\\d|25[0-5]|\\d)\\.\\g<dec_octet>\\.\\g<dec_octet>\\.\\g<dec_octet>))|::(?:\\h{1,4}:){5}\\g<ls32>|\\h{1,4}?::(?:\\h{1,4}:){4}\\g<ls32>|(?:(?:\\h{1,4}:)?\\h{1,4})?::(?:\\h{1,4}:){3}\\g<ls32>|(?:(?:\\h{1,4}:){,2}\\h{1,4})?::(?:\\h{1,4}:){2}\\g<ls32>|(?:(?:\\h{1,4}:){,3}\\h{1,4})?::\\h{1,4}:\\g<ls32>|(?:(?:\\h{1,4}:){,4}\\h{1,4})?::\\g<ls32>|(?:(?:\\h{1,4}:){,5}\\h{1,4})?::\\h{1,4}|(?:(?:\\h{1,4}:){,6}\\h{1,4})?::)|(?<IPvFuture>v\\h+\\.[!$&-.0-;=A-Z_a-z~]+))\\])|\\g<IPv4address>|(?<reg_name>(?:%\\h\\h|[!$&-.0-9;=A-Z_a-z~])+))?(?::(?<port>\\d*))?)(?<path_abempty>(?:\\/(?<segment>(?:%\\h\\h|[!$&-.0-;=@-Z_a-z~])*))*)|(?<path_absolute>\\/(?:(?<segment_nz>(?:%\\h\\h|[!$&-.0-;=@-Z_a-z~])+)(?:\\/\\g<segment>)*)?)|(?<path_rootless>\\g<segment_nz>(?:\\/\\g<segment>)*)|(?<path_empty>))(?:\\?(?<query>[^#]*))?(?:\\#(?<fragment>(?:%\\h\\h|[!$&-.0-;=@-Z_a-z~\\/?])*))?)\\z/

  URI defined in RFC3986

Class Method Summary

• .parse(raw_url : String)

  Parses raw_url into an URI.

• .new(scheme = nil, host = nil, port = nil, path = nil, query = nil, user = nil, password = nil, fragment = nil, opaque = nil)

Instance Method Summary

• #fragment

  Returns the fragment component of the URI.

• #fragment=(fragment)

  Sets the fragment component of the URI.

• #full_path

  Returns the full path of this URI.

• #host

  Returns the host component of the URI.

• #host=(host)

  Sets the host component of the URI.

• #opaque

  Returns the opaque component of the URI.

• #opaque=(opaque)

  Sets the opaque component of the URI.

• #password

  Returns the password component of the URI.

• #password=(password)

  Sets the password component of the URI.

• #path

  Returns the path component of the URI.

• #path=(path)

  Sets the path component of the URI.

• #port

  Returns the port component of the URI.

• #port=(port)

  Sets the port component of the URI.

• #query

  Returns the query component of the URI.

• #query=(query)

  Sets the query component of the URI.

• #scheme

  Returns the scheme component of the URI.

• #scheme=(scheme)

  Sets the scheme component of the URI.

• #to_s(io : IO)
• #user

  Returns the user component of the URI.

• #user=(user)

  Sets the user component of the URI.

• #userinfo

  Returns the user-information component containing the provided username and password.

Class Method Detail

require 

Instance Method Detail

URI.parse("http://foo.com/bar#section1").fragment # => "section1"

uri = URI.parse "http://foo.com/posts?id=30&limit=5#time=1305298413"
uri.full_path # => "/posts?id=30&limit=5"

URI.parse("http://foo.com").host # => "foo.com"

URI.parse("mailto:alice@example.com").opaque # => "alice@example.com"

URI.parse("http://admin:password@foo.com").password # => "password"

URI.parse("http://foo.com/bar").path # => "/bar"

URI.parse("http://foo.com:5432").port # => 5432

URI.parse("http://foo.com/bar?q=1").query # => "q=1"

URI.parse("http://foo.com").scheme # => "http"
URI.parse("mailto:alice@example.com").scheme # => "mailto"

URI.parse("http://admin:password@foo.com").user # => "admin"

uri = URI.parse "http://admin:password@foo.com"
uri.userinfo # => "admin:password"