class URI

• URI
• Reference
• Object

Overview

This class represents a URI reference as defined by RFC 3986: Uniform Resource Identifier (URI): Generic Syntax.

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"

Defined in:

Constructors

• .new(scheme = nil, host = nil, port = nil, path = nil, query = nil, user = nil, password = nil, fragment = nil, opaque = nil)
• .parse(raw_url : String) : URI

  Parses raw_url into an URI.

Class Method Summary

• .escape(string : String, io : IO, space_to_plus = false)

  URL-encode a String and write the result to an IO.

• .escape(string : String, space_to_plus = false) : String

  URL-encode a String.

• .escape(string : String, io : IO, space_to_plus = false, &block)

  URL-encode a String and write the result to an IO.

• .escape(string : String, space_to_plus = false, &block) : String

  URL-encode a String.

• .reserved?(byte) : Bool

  Returns whether given byte is reserved character defined in RFC 3986.

• .unescape(string : String, io : IO, plus_to_space = false)

  URL-decode a string and write the result to an IO.

• .unescape(string : String, plus_to_space = false) : String

  URL-decode a String.

• .unescape(string : String, io : IO, plus_to_space = false, &block)

  URL-decode a String and write the result to an IO.

• .unescape(string : String, plus_to_space = false, &block) : String

  URL-decode a String.

• .unescape_one(string, bytesize, i, byte, char, io, plus_to_space = false, &block)

  :nodoc: Unescapes one character.

• .unreserved?(byte) : Bool

  Returns whether given byte is unreserved character defined in RFC 3986.

Instance Method Summary

• #==(other : self)
• #fragment : String?

  Returns the fragment component of the URI.

• #fragment=(fragment : String?)

  Sets the fragment component of the URI.

• #full_path

  Returns the full path of this URI.

• #hash
• #host : String?

  Returns the host component of the URI.

• #host=(host : String?)

  Sets the host component of the URI.

• #normalize

  Returns normalized URI.

• #normalize!

  Destructive normalize.

• #opaque : String?

  Returns the opaque component of the URI.

• #opaque=(opaque : String?)

  Sets the opaque component of the URI.

• #password : String?

  Returns the password component of the URI.

• #password=(password : String?)

  Sets the password component of the URI.

• #path : String?

  Returns the path component of the URI.

• #path=(path : String?)

  Sets the path component of the URI.

• #port : Int32?

  Returns the port component of the URI.

• #port=(port : Int32?)

  Sets the port component of the URI.

• #query : String?

  Returns the query component of the URI.

• #query=(query : String?)

  Sets the query component of the URI.

• #scheme : String?

  Returns the scheme component of the URI.

• #scheme=(scheme : String?)

  Sets the scheme component of the URI.

• #to_s(io : IO)
• #user : String?

  Returns the user component of the URI.

• #user=(user : String?)

  Sets the user component of the URI.

• #userinfo

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

Constructor Detail

require "uri"

uri = URI.parse("http://crystal-lang.org") # => #<URI:0x1068a7e40 @scheme="http", @host="crystal-lang.org", ... >
uri.scheme                                 # => "http"
uri.host                                   # => "crystal-lang.org"

Class Method Detail

URI.escape("'Stop!' said Fred")                      # => "%27Stop%21%27%20said%20Fred"
URI.escape("'Stop!' said Fred", space_to_plus: true) # => "%27Stop%21%27+said+Fred"

# Escape URI path
URI.escape("/foo/file?(1).txt") do |byte|
  URI.unreserved?(byte) || byte.chr == '/'
end
# => "/foo/file%3F%281%29.txt"

URI.unescape("%27Stop%21%27%20said%20Fred")                  # => "'Stop!' said Fred"
URI.unescape("%27Stop%21%27+said+Fred", plus_to_space: true) # => "'Stop!' said Fred"

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"