class URI
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:
uri/punycode.cruri/uri_parser.cr
uri.cr
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
-
.default_port(scheme : String) : Int32?
Returns the default port for the given scheme if known, otherwise returns
nil
. - .escape(string : String, io : IO, space_to_plus = false)
-
.escape(string : String, space_to_plus = false) : String
URL-encode a
String
. - .escape(string : String, io : IO, space_to_plus = false, &block)
-
.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.
-
.set_default_port(scheme : String, port : Int32?) : Nil
Registers the default port for the given scheme.
-
.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)
-
.unescape(string : String, plus_to_space = false, &block) : String
URL-decode a
String
. -
.unreserved?(byte) : Bool
Returns whether given byte is unreserved character defined in RFC 3986.
Instance Method Summary
- #==(other : self)
-
#absolute?
Returns
true
if URI has a scheme specified. -
#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(hasher)
-
#host : String?
Returns the host component of the URI.
-
#host=(host : String?)
Sets the host component of the URI.
-
#hostname
Returns the host part of the URI and unwrap brackets for IPv6 addresses.
-
#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.
-
#relative?
Returns
true
if URI does not have a scheme specified. -
#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.
Instance methods inherited from class Reference
==(other : self)==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference)
same?(other : Nil) same?, to_s(io : IO) : Nil to_s
Constructor methods inherited from class Reference
new
new
Instance methods inherited from class Object
!=(other)
!=,
!~(other)
!~,
==(other)
==,
===(other : JSON::Any)===(other : YAML::Any)
===(other) ===, =~(other) =~, class class, dup dup, hash(hasher)
hash hash, inspect(io : IO)
inspect inspect, itself itself, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, tap(&block) tap, to_json(io : IO)
to_json to_json, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ") to_pretty_json, to_s
to_s(io : IO) to_s, to_yaml(io : IO)
to_yaml to_yaml, try(&block) try, unsafe_as(type : T.class) forall T unsafe_as
Constructor methods inherited from class Object
from_json(string_or_io, root : String) : selffrom_json(string_or_io) : self from_json, from_yaml(string_or_io : String | IO) : self from_yaml
Constructor Detail
Parses raw_url
into an URI. The raw_url
may be relative or absolute.
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
Returns the default port for the given scheme if known,
otherwise returns nil
.
URI.default_port "http" # => 80
URI.default_port "ponzi" # => nil
URL-encode a String
.
If space_to_plus is true
, it replace space character (0x20) to '+'
and '+'
is
encoded to '%2B'
. e.g. application/x-www-form-urlencoded
want this replace.
URI.escape("'Stop!' said Fred") # => "%27Stop%21%27%20said%20Fred"
URI.escape("'Stop!' said Fred", space_to_plus: true) # => "%27Stop%21%27+said+Fred"
URL-encode a String
.
This method requires block, the block is called with each characters
whose code is less than 0x80
. The characters that block returns
true
are not escaped, other characters are escaped.
# Escape URI path
URI.escape("/foo/file?(1).txt") do |byte|
URI.unreserved?(byte) || byte.chr == '/'
end
# => "/foo/file%3F%281%29.txt"
Returns whether given byte is reserved character defined in RFC 3986.
Reserved characters are ':', '/', '?', '#', '[', ']', '@', '!', '$', '&', "'", '(', ')', '*', '+', ',', ';' and '='.
Registers the default port for the given scheme.
If port is nil
, the existing default port for the
scheme, if any, will be unregistered.
URI.set_default_port "ponzi", 9999
URL-decode a string and write the result to an IO
.
URL-decode a String
.
If plus_to_space is true
, it replace plus character (0x2B
) to ' '.
e.g. application/x-www-form-urlencoded
wants this replace.
URI.unescape("%27Stop%21%27%20said%20Fred") # => "'Stop!' said Fred"
URI.unescape("%27Stop%21%27+said+Fred", plus_to_space: true) # => "'Stop!' said Fred"
URL-decode a String
.
This method requires block, the block is called with each bytes
whose is less than 0x80
. The bytes that block returns true
are not unescaped, other characters are unescaped.
Returns whether given byte is unreserved character defined in RFC 3986.
Unreserved characters are alphabet, digit, '_', '.', '-', '~'.
Instance Method Detail
Returns the fragment component of the URI.
URI.parse("http://foo.com/bar#section1").fragment # => "section1"
Returns the full path of this URI.
uri = URI.parse "http://foo.com/posts?id=30&limit=5#time=1305298413"
uri.full_path # => "/posts?id=30&limit=5"
Returns the host component of the URI.
URI.parse("http://foo.com").host # => "foo.com"
Returns the host part of the URI and unwrap brackets for IPv6 addresses.
URI.parse("http://[::1]/bar").hostname # => "::1"
URI.parse("http://[::1]/bar").host # => "[::1]"
Returns the opaque component of the URI.
URI.parse("mailto:alice@example.com").opaque # => "alice@example.com"
Returns the password component of the URI.
URI.parse("http://admin:password@foo.com").password # => "password"
Returns the path component of the URI.
URI.parse("http://foo.com/bar").path # => "/bar"
Returns the port component of the URI.
URI.parse("http://foo.com:5432").port # => 5432
Returns the query component of the URI.
URI.parse("http://foo.com/bar?q=1").query # => "q=1"
Returns the scheme component of the URI.
URI.parse("http://foo.com").scheme # => "http"
URI.parse("mailto:alice@example.com").scheme # => "mailto"
Returns the user component of the URI.
URI.parse("http://admin:password@foo.com").user # => "admin"
Returns the user-information component containing the provided username and password.
uri = URI.parse "http://admin:password@foo.com"
uri.userinfo # => "admin:password"