- #
- A
- B
- C
- D
- E
- F
- H
- I
- M
- N
- O
- P
- Q
- R
- S
- T
- U
DEFAULT_PORT | = | nil |
A Default port of nil for URI::Generic |
||
COMPONENT | = | [ :scheme, :userinfo, :host, :port, :registry, :path, :opaque, :query, :fragment ].freeze |
An Array of the available components for URI::Generic |
||
USE_REGISTRY | = | false |
Default to not use the registry for a URI::Generic |
[R] | fragment | returns the fragment component of the URI.
|
[R] | host | returns the host component of the URI.
It returns nil if no host component.
The component doesn't contains the port number.
Since IPv6 addresses are wrapped by brackets in URIs, this method returns IPv6 addresses wrapped by brackets. This form is not appropriate to pass socket methods such as IO.open. If unwrapped host names are required, use “hostname” method.
|
[R] | opaque | returns the opaque part of the URI.
Portion of the path that does make use of the slash '/'. The path typically refers to the absolute path and the opaque part.
|
[R] | path | returns the path component of the URI.
|
[R] | port | returns the port component of the URI.
|
[R] | query | returns the query component of the URI.
|
[R] | registry | returns the registry component of the URI.
|
[R] | scheme | returns the scheme component of the URI.
|
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 121 def self.build(args) if args.kind_of?(Array) && args.size == ::URI::Generic::COMPONENT.size tmp = args elsif args.kind_of?(Hash) tmp = ::URI::Generic::COMPONENT.collect do |c| if args.include?(c) args[c] else nil end end else raise ArgumentError, "expected Array of or Hash of components of #{self.class} (#{self.class.component.join(', ')})" end tmp << nil tmp << true return self.new(*tmp) end
Synopsis
See new
Description
At first, tries to create a new URI::Generic instance using ::build. But, if exception URI::InvalidComponentError is raised, then it URI::Escape#escape all URI components and tries again.
# File ../ruby/lib/uri/generic.rb, line 83 def self.build2(args) begin return self.build(args) rescue InvalidComponentError if args.kind_of?(Array) return self.build(args.collect{|x| if x parser.escape(x) else x end }) elsif args.kind_of?(Hash) tmp = {} args.each do |key, value| tmp[key] = if value parser.escape(value) else value end end return self.build(tmp) end end end
Returns default port
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
-
A part of URI after '#' sign
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 172 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 @registry = nil @fragment = nil @parser = parser == DEFAULT_PARSER ? nil : parser if arg_check self.scheme = scheme self.userinfo = userinfo self.host = host self.port = port self.path = path self.query = query self.opaque = opaque self.registry = registry 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.set_query(query) self.set_opaque(opaque) self.set_registry(registry) self.set_fragment(fragment) end if @registry && !self.class.use_registry raise InvalidURIError, "the scheme #{@scheme} does not accept registry part: #{@registry} (or bad hostname?)" end @scheme.freeze if @scheme self.set_path('') if !@path && !@opaque # (see RFC2396 Section 5.2) self.set_port(self.default_port) if self.default_port && !@port end
Returns whether a registry of naming authorities are being used.
Compares to URI's
Args
- v
-
URI or String
Description
attempt to parse other URI +oth+
return [parsed_oth, self]
Usage
require 'uri'
uri = URI.parse("http://my.example.com")
uri.coerce("http://foo.com")
#=> [#<URI::HTTP:0x00000000bcb028 URL:http://foo.com/>, #<URI::HTTP:0x00000000d92178 URL:http://my.example.com>]
Returns default port
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.
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/open-uri.rb, line 710 def find_proxy 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' unless proxy_uri = ENV[name] if proxy_uri = ENV[name.upcase] warn 'The environment variable HTTP_PROXY is discouraged. Use http_proxy.' end end else proxy_uri = ENV[name] || ENV[name.upcase] end if proxy_uri && self.hostname require 'socket' begin addr = IPSocket.getaddress(self.hostname) proxy_uri = nil if /\A127\.|\A::1\z/ =~ addr rescue SocketError end end if proxy_uri proxy_uri = URI.parse(proxy_uri) name = 'no_proxy' if no_proxy = ENV[name] || ENV[name.upcase] no_proxy.scan(/([^:,]*)(?::(\d+))?/) {|host, port| if /(\A|\.)#{Regexp.quote host}\z/i =~ self.host && (!port || self.port == port.to_i) proxy_uri = nil break end } end proxy_uri else nil end end
Args
- v
-
String
Description
public setter for the fragment component v
. (with validation)
see also #check_fragment
Usage
require 'uri'
uri = URI.parse("http://my.example.com/?id=25#time=1305212049")
uri.fragment = "time=1305212086"
# => "time=1305212086"
uri
#=> #<URI::HTTP:0x000000007a81f8 URL:http://my.example.com/?id=25#time=1305212086>
Args
- v
-
String
Description
public setter for the host component v
. (with validation)
see also #check_host
Usage
require 'uri'
uri = URI.parse("http://my.example.com")
uri.host = "foo.com"
# => "foo.com"
uri
#=> #<URI::HTTP:0x000000008e89e8 URL:http://foo.com>
set the host part of the URI as the argument with brackets for IPv6 addresses.
This method is same as #host= except the argument can be bare IPv6 address.
u = URI(“foo/bar”) p u.to_s #=> “foo/bar” u.hostname = “::1” p u.to_s #=> “[::1]/bar”
If the arugument seems IPv6 address, it is wrapped by brackets.
Args
- oth
-
URI or String
Description
Merges two URI's.
Usage
require 'uri'
uri = URI.parse("http://my.example.com")
p uri.merge("/main.rbx?page=1")
# => #<URI::HTTP:0x2021f3b0 URL:http://my.example.com/main.rbx?page=1>
# File ../ruby/lib/uri/generic.rb, line 1198 def merge(oth) begin base, rel = merge0(oth) rescue raise $!.class, $!.message end if base == rel return base end authority = rel.userinfo || rel.host || rel.port # RFC2396, Section 5.2, 2) if (rel.path.nil? || rel.path.empty?) && !authority && !rel.query base.set_fragment(rel.fragment) if rel.fragment return base end base.set_query(nil) base.set_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.set_query(rel.query) if rel.query base.set_fragment(rel.fragment) if rel.fragment return base end
Args
- v
-
String
Description
public setter for the opaque component v
. (with validation)
see also #check_opaque
returns the parser to be used.
Unless a URI::Parser is defined, then DEFAULT_PARSER is used.
returns the password component
Args
- v
-
String
Description
public setter for the password
component. (with validation)
see also #check_password
Usage
require 'uri'
uri = URI.parse("http://john:S3nsit1ve@my.example.com")
uri.password = "V3ry_S3nsit1ve"
# => "V3ry_S3nsit1ve"
uri
#=> #<URI::HTTP:0x00000000881d90 URL:http://john:V3ry_S3nsit1ve@my.example.com>
Args
- v
-
String
Description
public setter for the path component v
. (with validation)
see also #check_path
Usage
require 'uri'
uri = URI.parse("http://my.example.com/pub/files")
uri.path = "/faq/"
# => "/faq/"
uri
#=> #<URI::HTTP:0x000000008e89e8 URL:http://my.example.com/faq/>
Args
- v
-
String
Description
public setter for the port component v
. (with validation)
see also #check_port
Usage
require 'uri'
uri = URI.parse("http://my.example.com")
uri.port = 8080
# => 8080
uri
#=> #<URI::HTTP:0x000000008e89e8 URL:http://my.example.com:8080>
Args
- v
-
String
Description
public setter for the query component v
. (with validation)
see also #check_query
Usage
require 'uri'
uri = URI.parse("http://my.example.com/?id=25")
uri.query = "id=1"
# => "id=1"
uri
#=> #<URI::HTTP:0x000000008e89e8 URL:http://my.example.com/?id=1>
Args
- v
-
String
Description
public setter for the registry component v
. (with validation)
see also #check_registry
Args
- oth
-
URI or String
Description
Calculates relative path from oth to self
Usage
require 'uri'
uri = URI.parse('http://my.example.com/main.rbx?page=1')
p uri.route_from('http://my.example.com')
#=> #<URI::Generic:0x20218858 URL:/main.rbx?page=1>
# File ../ruby/lib/uri/generic.rb, line 1372 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
Args
- oth
-
URI or String
Description
Calculates relative path to oth from self
Usage
require 'uri'
uri = URI.parse('http://my.example.com')
p uri.route_to('http://my.example.com/main.rbx?page=1')
#=> #<URI::Generic:0x2020c2f6 URL:/main.rbx?page=1>
Args
- v
-
String
Description
public setter for the scheme component v
. (with validation)
see also #check_scheme
Usage
require 'uri'
uri = URI.parse("http://my.example.com")
uri.scheme = "https"
# => "https"
uri
#=> #<URI::HTTP:0x000000008e89e8 URL:https://my.example.com>
Args
Description
Selects specified components from URI
Usage
require 'uri'
uri = URI.parse('http://myuser:mypass@my.example.com/test.rbx')
p uri.select(:userinfo, :host, :path)
# => ["myuser:mypass", "my.example.com", "/test.rbx"]
Constructs String from URI
# File ../ruby/lib/uri/generic.rb, line 1453 def to_s str = '' if @scheme str << @scheme str << ':' end if @opaque str << @opaque else if @registry str << @registry else if @host 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 end str << path_query end if @fragment str << '#' str << @fragment end str end
returns the user component
Args
- v
-
String
Description
public setter for the user
component. (with validation)
see also #check_user
Usage
require 'uri'
uri = URI.parse("http://john:S3nsit1ve@my.example.com")
uri.user = "sam"
# => "sam"
uri
#=> #<URI::HTTP:0x00000000881d90 URL:http://sam:V3ry_S3nsit1ve@my.example.com>
returns the userinfo, either as 'user' or 'user:password'
Sets userinfo, argument is string like 'name:pass'
protected setter for the fragment component v
see also #fragment=
protected setter for the password component v
see also #password=
protected setter for the registry component v
see also #registry=
protect setter for the user
component, and
password
if available. (with validation)
see also #userinfo=
check the fragment v
component against the URI::Parser Regexp for
:FRAGMENT
check the host v
component for RFC2396 compliance and against
the URI::Parser Regexp for :HOST
Can not have a registry or opaque component defined, with a host component defined.
# File ../ruby/lib/uri/generic.rb, line 597 def check_host(v) return v unless v if @registry || @opaque raise InvalidURIError, "can not set host with registry or opaque" elsif parser.regexp[:HOST] !~ v raise InvalidComponentError, "bad component(expected host component): #{v}" end return true end
check the opaque v
component for RFC2396 compliance and
against the URI::Parser Regexp for :OPAQUE
Can not have a host, port, user or path component defined, with an opaque component defined.
# File ../ruby/lib/uri/generic.rb, line 947 def check_opaque(v) return v unless v # raise if both hier and opaque are not nil, because: # absoluteURI = scheme ":" ( hier_part | opaque_part ) # hier_part = ( net_path | abs_path ) [ "?" query ] if @host || @port || @user || @path # userinfo = @user + ':' + @password raise InvalidURIError, "can not set opaque with host, port, userinfo or path" elsif v && parser.regexp[:OPAQUE] !~ v raise InvalidComponentError, "bad component(expected opaque component): #{v}" end return true end
check the password v
component for RFC2396 compliance and
against the URI::Parser Regexp for :USERINFO
Can not have a registry or opaque component defined, with a user component defined.
# File ../ruby/lib/uri/generic.rb, line 426 def check_password(v, user = @user) if @registry || @opaque raise InvalidURIError, "can not set password with registry or opaque" end return v unless v if !user raise InvalidURIError, "password component depends user component" end if parser.regexp[:USERINFO] !~ v raise InvalidComponentError, "bad component(expected user component): #{v}" end return true end
check the path v
component for RFC2396 compliance and against
the URI::Parser Regexp for :ABS_PATH and :REL_PATH
Can not have a opaque component defined, with a path component defined.
# File ../ruby/lib/uri/generic.rb, line 810 def check_path(v) # raise if both hier and opaque are not nil, because: # absoluteURI = scheme ":" ( hier_part | opaque_part ) # hier_part = ( net_path | abs_path ) [ "?" query ] if v && @opaque raise InvalidURIError, "path conflicts with opaque" end # If scheme is ftp, path may be relative. # See RFC 1738 section 3.2.2, and RFC 2396. if @scheme && @scheme != "ftp" if v && v != '' && parser.regexp[:ABS_PATH] !~ v raise InvalidComponentError, "bad component(expected absolute path component): #{v}" end else if v && v != '' && parser.regexp[:ABS_PATH] !~ v && parser.regexp[:REL_PATH] !~ v raise InvalidComponentError, "bad component(expected relative path component): #{v}" end end return true end
check the port v
component for RFC2396 compliance and against
the URI::Parser Regexp for :PORT
Can not have a registry or opaque component defined, with a port component defined.
# File ../ruby/lib/uri/generic.rb, line 689 def check_port(v) return v unless v if @registry || @opaque raise InvalidURIError, "can not set port with registry or opaque" elsif !v.kind_of?(Fixnum) && parser.regexp[:PORT] !~ v raise InvalidComponentError, "bad component(expected port component): #{v}" end return true end
check the query v
component for RFC2396 compliance and against
the URI::Parser Regexp for :QUERY
Can not have a opaque component defined, with a query component defined.
# File ../ruby/lib/uri/generic.rb, line 882 def check_query(v) return v unless v # raise if both hier and opaque are not nil, because: # absoluteURI = scheme ":" ( hier_part | opaque_part ) # hier_part = ( net_path | abs_path ) [ "?" query ] if @opaque raise InvalidURIError, "query conflicts with opaque" end if v && v != '' && parser.regexp[:QUERY] !~ v raise InvalidComponentError, "bad component(expected query component): #{v}" end return true end
check the registry v
component for RFC2396 compliance and
against the URI::Parser Regexp for :REGISTRY
Can not have a host, port or user component defined, with a registry component defined.
# File ../ruby/lib/uri/generic.rb, line 756 def check_registry(v) return v unless v # raise if both server and registry are not nil, because: # authority = server | reg_name # server = [ [ userinfo "@" ] hostport ] if @host || @port || @user # userinfo = @user + ':' + @password raise InvalidURIError, "can not set registry with host, port, or userinfo" elsif v && parser.regexp[:REGISTRY] !~ v raise InvalidComponentError, "bad component(expected registry component): #{v}" end return true end
check the scheme v
component against the URI::Parser Regexp for
:SCHEME
check the user v
component for RFC2396 compliance and against
the URI::Parser Regexp for :USERINFO
Can not have a registry or opaque component defined, with a user component defined.
# File ../ruby/lib/uri/generic.rb, line 402 def check_user(v) if @registry || @opaque raise InvalidURIError, "can not set user with registry or opaque" end return v unless v if parser.regexp[:USERINFO] !~ v raise InvalidComponentError, "bad component(expected userinfo component or user component): #{v}" end return true end
check the user
and password
.
If password
is not provided, then user
is split,
using #split_userinfo,
to pull user
and +password.
see also #check_user, #check_password
escapes 'user:password' v
based on RFC 1738 section
3.1
return base and rel. you can modify `base', but can not `rel'.
# File ../ruby/lib/uri/generic.rb, line 1241 def merge0(oth) oth = parser.send(:convert_to_uri, oth) if self.relative? && oth.relative? raise BadURIError, "both URI are relative" end if self.absolute? && oth.absolute? #raise BadURIError, # "both URI are absolute" # hmm... should return oth for usability? return oth, oth end if self.absolute? return self.dup, oth else return oth, oth end end
Merges a base path base
, with relative path rel
,
returns a modified base path.
# File ../ruby/lib/uri/generic.rb, line 1088 def merge_path(base, rel) # RFC2396, Section 5.2, 5) # RFC2396, Section 5.2, 6) base_path = split_path(base) rel_path = split_path(rel) # RFC2396, Section 5.2, 6), a) base_path << '' if base_path.last == '..' while i = base_path.index('..') base_path.slice!(i - 1, 2) end if (first = rel_path.first) and first.empty? base_path.clear rel_path.shift end # RFC2396, Section 5.2, 6), c) # RFC2396, Section 5.2, 6), d) rel_path.push('') if rel_path.last == '.' || rel_path.last == '..' rel_path.delete('.') # RFC2396, Section 5.2, 6), e) tmp = [] rel_path.each do |x| if x == '..' && !(tmp.empty? || tmp.last == '..') tmp.pop else tmp << x end end add_trailer_slash = !tmp.empty? if base_path.empty? base_path = [''] # keep '/' for root directory elsif add_trailer_slash base_path.pop end while x = tmp.shift if x == '..' # RFC2396, Section 4 # a .. or . in an absolute path has no special meaning base_path.pop if base_path.size > 1 else # if x == '..' # valid absolute (but abnormal) path "/../..." # else # valid absolute path # end base_path << x tmp.each {|t| base_path << t} add_trailer_slash = false break end end base_path.push('') if add_trailer_slash return base_path.join('/') end
returns the assemble String with path and query components
returns an Array of the path split on '/'