Class URI::Generic
In: lib/open-uri.rb
lib/uri/generic.rb
Parent: Object

Base class for all URI classes. Implements generic URI syntax as per RFC 2396.

Methods

+   -   ==   absolute   absolute?   build   build2   coerce   component   component   component_ary   default_port   default_port   eql?   find_proxy   fragment=   hash   hierarchical?   host=   inspect   merge   merge!   new   normalize   normalize!   opaque=   password   password=   path=   port=   query=   registry=   relative?   route_from   route_to   scheme=   select   set_fragment   set_host   set_opaque   set_password   set_path   set_port   set_query   set_registry   set_scheme   set_user   set_userinfo   to_s   use_registry   user   user=   userinfo   userinfo=  

Included Modules

URI REGEXP

Constants

DEFAULT_PORT = nil
COMPONENT = [ :scheme, :userinfo, :host, :port, :registry, :path, :opaque, :query, :fragment
USE_REGISTRY = false

Attributes

fragment  [R] 
host  [R] 
opaque  [R] 
path  [R] 
port  [R] 
query  [R] 
registry  [R] 
scheme  [R] 

Public Class methods

build(args)

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.

build2(args)

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 URI::Escape.escape all URI components and tries again.

component()

Components of the URI in the order.

default_port()

Returns default port

new(scheme, userinfo, host, port, registry, path, opaque, query, fragment, arg_check = false)

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:DOC: FIXME!
path:Path on server
opaque:DOC: FIXME!
query:Query data
fragment:A part of URI after ’#’ sign
arg_check:Check arguments [false by default]

Description

Creates a new URI::Generic instance from ``generic’’ components without check.

use_registry()

DOC: FIXME!

Public Instance methods

+(oth)

Alias for merge

-(oth)

Alias for route_from

==(oth)

Compares to URI‘s

absolute()

Alias for absolute?

absolute?()

Checks if URI is an absolute one

find_proxy()

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.

hierarchical?()

Checks if URI has a path

merge(oth)

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>
merge!(oth)

Args

oth:URI or String

Description

Destructive form of merge

Usage

  require 'uri'

  uri = URI.parse("http://my.example.com")
  uri.merge!("/main.rbx?page=1")
  p uri
  # =>  #<URI::HTTP:0x2021f3b0 URL:http://my.example.com/main.rbx?page=1>
normalize()

Returns normalized URI

normalize!()

Destructive version of normalize

relative?()

Checks if URI is relative

route_from(oth)

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>
route_to(oth)

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>
select(*components)

Args

components:Multiple Symbol arguments defined in URI::HTTP

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"]
to_s()

Constructs String from URI

userinfo=(userinfo)

Sets userinfo, argument is string like ‘name:pass‘

Protected Instance methods

[Validate]

ruby-doc.org is a service of James Britt and Neurogami, a Ruby application development company in Phoenix, AZ.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.