- #
- A
- B
- C
- D
- E
- F
- H
- I
- M
- N
- O
- P
- Q
- R
- S
- T
- U
Constants
COMPONENT | = | [ :scheme, :userinfo, :host, :port, :registry, :path, :opaque, :query, :fragment ].freeze |
An |
||
DEFAULT_PORT | = | nil |
A Default port of nil for |
Attributes
[R] | fragment | Returns the fragment component of the
|
[R] | host | Returns the host component of the
It returns nil if no host component exists.
The component does not contain the port number.
Since IPv6 addresses are wrapped with brackets in URIs, this method returns IPv6 addresses wrapped with brackets. This form is not appropriate to pass to socket methods such as
|
[R] | opaque | Returns the opaque part of the
The portion of the path that does not make use of the slash ‘/’. The path typically refers to an absolute path or an opaque part. (See RFC2396 Section 3 and 5.2.) |
[R] | path | Returns the path component of the
|
[R] | port | Returns the port component of the
|
[R] | query | Returns the query component of the
|
[R] | scheme | Returns the scheme component of the
|
Class Public methods
build(args) Link
Synopsis
See ::new
.
Description
Creates a new URI::Generic
instance from components of URI::Generic
with check. Components are: scheme, userinfo, host, port, registry, path, opaque, query, and fragment. You can provide arguments either by an Array
or a Hash
. See ::new
for hash keys to use or for order of array items.
# File ruby/lib/uri/generic.rb, line 116 def self.build(args) if args.kind_of?(Array) && args.size == ::URI::Generic::COMPONENT.size tmp = args.dup elsif args.kind_of?(Hash) tmp = ::URI::Generic::COMPONENT.collect do |c| if args.include?(c) args[c] else nil end end else component = self.class.component rescue ::URI::Generic::COMPONENT raise ArgumentError, "expected Array of or Hash of components of #{self.class} (#{component.join(', ')})" end tmp << nil tmp << true return self.new(*tmp) end
build2(args) Link
Synopsis
See ::new
.
Description
At first, tries to create a new URI::Generic
instance using URI::Generic::build
. But, if exception URI::InvalidComponentError
is raised, then it does URI::Escape.escape all URI
components and tries again.
# File ruby/lib/uri/generic.rb, line 78 def self.build2(args) begin return self.build(args) rescue InvalidComponentError if args.kind_of?(Array) return self.build(args.collect{|x| if x.is_a?(String) DEFAULT_PARSER.escape(x) else x end }) elsif args.kind_of?(Hash) tmp = {} args.each do |key, value| tmp[key] = if value DEFAULT_PARSER.escape(value) else value end end return self.build(tmp) end end end
default_port() Link
Returns default port.
new(scheme, userinfo, host, port, registry, path, opaque, query, fragment, parser = DEFAULT_PARSER, arg_check = false) Link
Args
scheme
-
Protocol scheme, i.e. ‘http’,‘ftp’,‘mailto’ and so on.
userinfo
-
User name and password, i.e. ‘sdmitry:bla’.
host
-
Server host name.
port
-
Server port.
registry
-
Registry of naming authorities.
path
-
Path on server.
opaque
-
Opaque part.
query
-
Query data.
fragment
-
Part of the
URI
after ‘#’ character. parser
-
Parser
for internal use [URI::DEFAULT_PARSER by default]. arg_check
-
Check arguments [false by default].
Description
Creates a new URI::Generic
instance from “generic” components without check.
# File ruby/lib/uri/generic.rb, line 169 def initialize(scheme, userinfo, host, port, registry, path, opaque, query, fragment, parser = DEFAULT_PARSER, arg_check = false) @scheme = nil @user = nil @password = nil @host = nil @port = nil @path = nil @query = nil @opaque = nil @fragment = nil @parser = parser == DEFAULT_PARSER ? nil : parser if arg_check self.scheme = scheme self.userinfo = userinfo self.hostname = host self.port = port self.path = path self.query = query self.opaque = opaque self.fragment = fragment else self.set_scheme(scheme) self.set_userinfo(userinfo) self.set_host(host) self.set_port(port) self.set_path(path) self.query = query self.set_opaque(opaque) self.fragment=(fragment) end if registry raise InvalidURIError, "the scheme #{@scheme} does not accept registry part: #{registry} (or bad hostname?)" end @scheme&.freeze self.set_path('') if !@path && !@opaque # (see RFC2396 Section 5.2) self.set_port(self.default_port) if self.default_port && !@port end
Instance Public methods
==(oth) Link
Compares two URIs.
absolute?() Link
Returns true if URI
has a scheme (e.g. http:// or https://) specified.
coerce(oth) Link
Args
Description
Attempts to parse other URI
oth
, returns [parsed_oth, self].
Usage
require 'uri'
uri = URI.parse("http://my.example.com")
uri.coerce("http://foo.com")
#=> [#<URI::HTTP http://foo.com>, #<URI::HTTP http://my.example.com>]
default_port() Link
Returns default port.
eql?(oth) Link
find_proxy(env=ENV) Link
Returns a proxy URI
. The proxy URI
is obtained from environment variables such as http_proxy, ftp_proxy, no_proxy, etc. If there is no proper proxy, nil is returned.
If the optional parameter env
is specified, it is used instead of ENV
.
Note that capitalized variables (HTTP_PROXY, FTP_PROXY, NO_PROXY, etc.) are examined, too.
But http_proxy and HTTP_PROXY is treated specially under CGI
environment. It’s because HTTP_PROXY may be set by Proxy: header. So HTTP_PROXY is not used. http_proxy is not used too if the variable is case insensitive. CGI_HTTP_PROXY can be used instead.
# File ruby/lib/uri/generic.rb, line 1500 def find_proxy(env=ENV) raise BadURIError, "relative URI: #{self}" if self.relative? name = self.scheme.downcase + '_proxy' proxy_uri = nil if name == 'http_proxy' && env.include?('REQUEST_METHOD') # CGI? # HTTP_PROXY conflicts with *_proxy for proxy settings and # HTTP_* for header information in CGI. # So it should be careful to use it. pairs = env.reject {|k, v| /\Ahttp_proxy\z/i !~ k } case pairs.length when 0 # no proxy setting anyway. proxy_uri = nil when 1 k, _ = pairs.shift if k == 'http_proxy' && env[k.upcase] == nil # http_proxy is safe to use because ENV is case sensitive. proxy_uri = env[name] else proxy_uri = nil end else # http_proxy is safe to use because ENV is case sensitive. proxy_uri = env.to_hash[name] end if !proxy_uri # Use CGI_HTTP_PROXY. cf. libwww-perl. proxy_uri = env["CGI_#{name.upcase}"] end elsif name == 'http_proxy' if RUBY_ENGINE == 'jruby' && p_addr = ENV_JAVA['http.proxyHost'] p_port = ENV_JAVA['http.proxyPort'] if p_user = ENV_JAVA['http.proxyUser'] p_pass = ENV_JAVA['http.proxyPass'] proxy_uri = "http://#{p_user}:#{p_pass}@#{p_addr}:#{p_port}" else proxy_uri = "http://#{p_addr}:#{p_port}" end else unless proxy_uri = env[name] if proxy_uri = env[name.upcase] warn 'The environment variable HTTP_PROXY is discouraged. Use http_proxy.', uplevel: 1 end end end else proxy_uri = env[name] || env[name.upcase] end if proxy_uri.nil? || proxy_uri.empty? return nil end if self.hostname begin addr = IPSocket.getaddress(self.hostname) return nil if /\A127\.|\A::1\z/ =~ addr rescue SocketError end end name = 'no_proxy' if no_proxy = env[name] || env[name.upcase] return nil unless URI::Generic.use_proxy?(self.hostname, addr, self.port, no_proxy) end URI.parse(proxy_uri) end
fragment=(v) Link
Checks the fragment v
component against the URI::Parser
Regexp
for :FRAGMENT.
Args
v
Description
Public setter for the fragment component v
(with validation).
Usage
require 'uri'
uri = URI.parse("http://my.example.com/?id=25#time=1305212049")
uri.fragment = "time=1305212086"
uri.to_s #=> "http://my.example.com/?id=25#time=1305212086"
# File ruby/lib/uri/generic.rb, line 929 def fragment=(v) return @fragment = nil unless v x = v.to_str v = x.dup if x.equal? v v.encode!(Encoding::UTF_8) rescue nil v.delete!("\t\r\n") v.force_encoding(Encoding::ASCII_8BIT) v.gsub!(/(?!%\h\h|[!-~])./n){'%%%02X' % $&.ord} v.force_encoding(Encoding::US_ASCII) @fragment = v end
hash() Link
hierarchical?() Link
Returns true if URI
is hierarchical.
Description
URI
has components listed in order of decreasing significance from left to right, see RFC3986 tools.ietf.org/html/rfc3986 1.2.3.
Usage
require 'uri'
uri = URI.parse("http://my.example.com/")
uri.hierarchical?
#=> true
uri = URI.parse("mailto:joe@example.com")
uri.hierarchical?
#=> false
host=(v) Link
Args
v
Description
Public setter for the host component v
(with validation).
See also URI::Generic.check_host.
Usage
require 'uri'
uri = URI.parse("http://my.example.com")
uri.host = "foo.com"
uri.to_s #=> "http://foo.com"
hostname() Link
Extract the host part of the URI
and unwrap brackets for IPv6 addresses.
This method is the same as URI::Generic#host
except brackets for IPv6 (and future IP) addresses are removed.
uri = URI("http://[::1]/bar")
uri.hostname #=> "::1"
uri.host #=> "[::1]"
hostname=(v) Link
Sets the host part of the URI
as the argument with brackets for IPv6 addresses.
This method is the same as URI::Generic#host=
except the argument can be a bare IPv6 address.
uri = URI("http://foo/bar")
uri.hostname = "::1"
uri.to_s #=> "http://[::1]/bar"
If the argument seems to be an IPv6 address, it is wrapped with brackets.
inspect() Link
merge(oth) Link
Args
Description
Merges two URIs.
Usage
require 'uri'
uri = URI.parse("http://my.example.com")
uri.merge("/main.rbx?page=1")
# => "http://my.example.com/main.rbx?page=1"
# File ruby/lib/uri/generic.rb, line 1109 def merge(oth) rel = parser.__send__(:convert_to_uri, oth) if rel.absolute? #raise BadURIError, "both URI are absolute" if absolute? # hmm... should return oth for usability? return rel end unless self.absolute? raise BadURIError, "both URI are relative" end base = self.dup authority = rel.userinfo || rel.host || rel.port # RFC2396, Section 5.2, 2) if (rel.path.nil? || rel.path.empty?) && !authority && !rel.query base.fragment=(rel.fragment) if rel.fragment return base end base.query = nil base.fragment=(nil) # RFC2396, Section 5.2, 4) if !authority base.set_path(merge_path(base.path, rel.path)) if base.path && rel.path else # RFC2396, Section 5.2, 4) base.set_path(rel.path) if rel.path end # RFC2396, Section 5.2, 7) base.set_userinfo(rel.userinfo) if rel.userinfo base.set_host(rel.host) if rel.host base.set_port(rel.port) if rel.port base.query = rel.query if rel.query base.fragment=(rel.fragment) if rel.fragment return base end
merge!(oth) Link
Args
Description
Destructive form of merge
.
Usage
require 'uri'
uri = URI.parse("http://my.example.com")
uri.merge!("/main.rbx?page=1")
uri.to_s # => "http://my.example.com/main.rbx?page=1"
normalize() Link
Returns normalized URI
.
require 'uri'
URI("HTTP://my.EXAMPLE.com").normalize
#=> #<URI::HTTP http://my.example.com/>
Normalization here means:
-
scheme and host are converted to lowercase,
-
an empty path component is set to “/”.
opaque=(v) Link
Args
v
Description
Public setter for the opaque component v
(with validation).
See also URI::Generic.check_opaque.
parser() Link
Returns the parser to be used.
Unless a URI::Parser
is defined, DEFAULT_PARSER is used.
password=(password) Link
Args
v
Description
Public setter for the password
component (with validation).
See also URI::Generic.check_password.
Usage
require 'uri'
uri = URI.parse("http://john:S3nsit1ve@my.example.com")
uri.password = "V3ry_S3nsit1ve"
uri.to_s #=> "http://john:V3ry_S3nsit1ve@my.example.com"
path=(v) Link
Args
v
Description
Public setter for the path component v
(with validation).
See also URI::Generic.check_path.
Usage
require 'uri'
uri = URI.parse("http://my.example.com/pub/files")
uri.path = "/faq/"
uri.to_s #=> "http://my.example.com/faq/"
port=(v) Link
Args
v
Description
Public setter for the port component v
(with validation).
See also URI::Generic.check_port.
Usage
require 'uri'
uri = URI.parse("http://my.example.com")
uri.port = 8080
uri.to_s #=> "http://my.example.com:8080"
query=(v) Link
Args
v
Description
Public setter for the query component v
.
Usage
require 'uri'
uri = URI.parse("http://my.example.com/?id=25")
uri.query = "id=1"
uri.to_s #=> "http://my.example.com/?id=1"
# File ruby/lib/uri/generic.rb, line 839 def query=(v) return @query = nil unless v raise InvalidURIError, "query conflicts with opaque" if @opaque x = v.to_str v = x.dup if x.equal? v v.encode!(Encoding::UTF_8) rescue nil v.delete!("\t\r\n") v.force_encoding(Encoding::ASCII_8BIT) raise InvalidURIError, "invalid percent escape: #{$1}" if /(%\H\H)/n.match(v) v.gsub!(/(?!%\h\h|[!$-&(-;=?-_a-~])./n.freeze){'%%%02X' % $&.ord} v.force_encoding(Encoding::US_ASCII) @query = v end
registry=(v) Link
route_from(oth) Link
Args
Description
Calculates relative path from oth to self.
Usage
require 'uri'
uri = URI.parse('http://my.example.com/main.rbx?page=1')
uri.route_from('http://my.example.com')
#=> #<URI::Generic /main.rbx?page=1>
# File ruby/lib/uri/generic.rb, line 1262 def route_from(oth) # you can modify `rel', but can not `oth'. begin oth, rel = route_from0(oth) rescue raise $!.class, $!.message end if oth == rel return rel end rel.set_path(route_from_path(oth.path, self.path)) if rel.path == './' && self.query # "./?foo" -> "?foo" rel.set_path('') end return rel end
route_to(oth) Link
Args
Description
Calculates relative path to oth from self.
Usage
require 'uri'
uri = URI.parse('http://my.example.com')
uri.route_to('http://my.example.com/main.rbx?page=1')
#=> #<URI::Generic /main.rbx?page=1>
scheme=(v) Link
Args
v
Description
Public setter for the scheme component v
(with validation).
See also URI::Generic.check_scheme.
Usage
require 'uri'
uri = URI.parse("http://my.example.com")
uri.scheme = "https"
uri.to_s #=> "https://my.example.com"
select(*components) Link
Args
Description
Selects specified components from URI
.
Usage
require 'uri'
uri = URI.parse('http://myuser:mypass@my.example.com/test.rbx')
uri.select(:userinfo, :host, :path)
# => ["myuser:mypass", "my.example.com", "/test.rbx"]
to_s() Link
# File ruby/lib/uri/generic.rb, line 1343 def to_s str = ''.dup if @scheme str << @scheme str << ':' end if @opaque str << @opaque else if @host || %w[file postgres].include?(@scheme) str << '//' end if self.userinfo str << self.userinfo str << '@' end if @host str << @host end if @port && @port != self.default_port str << ':' str << @port.to_s end str << @path if @query str << '?' str << @query end end if @fragment str << '#' str << @fragment end str end
user=(user) Link
Args
v
Description
Public setter for the user
component (with validation).
See also URI::Generic.check_user.
Usage
require 'uri'
uri = URI.parse("http://john:S3nsit1ve@my.example.com")
uri.user = "sam"
uri.to_s #=> "http://sam:V3ry_S3nsit1ve@my.example.com"
userinfo() Link
Returns the userinfo, either as ‘user’ or ‘user:password’.
userinfo=(userinfo) Link
Sets userinfo, argument is string like ‘name:pass’.
Instance Protected methods
component_ary() Link
set_host(v) Link
Protected setter for the host component v
.
See also URI::Generic.host=
.
set_opaque(v) Link
Protected setter for the opaque component v
.
See also URI::Generic.opaque=
.
set_password(v) Link
Protected setter for the password component v
.
See also URI::Generic.password=
.
set_path(v) Link
Protected setter for the path component v
.
See also URI::Generic.path=
.
set_port(v) Link
Protected setter for the port component v
.
See also URI::Generic.port=
.
set_scheme(v) Link
Protected setter for the scheme component v
.
See also URI::Generic.scheme=
.
set_user(v) Link
Protected setter for the user component v
.
See also URI::Generic.user=
.
set_userinfo(user, password = nil) Link
Protected setter for the user
component, and password
if available (with validation).
See also URI::Generic.userinfo=
.