Type:
Module
Constants:
DEFAULT_PARSER : Parser.new

URI::Parser.new

TBLENCWWWCOMP_ : {}
TBLDECWWWCOMP_ : {}
HTML5ASCIIINCOMPAT : [Encoding::UTF_7, Encoding::UTF_16BE, Encoding::UTF_16LE, Encoding::UTF_32BE, Encoding::UTF_32LE]
WFKV_ : '(?:[^%#=;&]*(?:%\h\h[^%#=;&]*)*)'

URI is a module providing classes to handle Uniform Resource Identifiers (RFC2396)

Features

  • Uniform handling of handling URIs

  • Flexibility to introduce custom URI schemes

  • Flexibility to have an alternate URI::Parser (or just different patterns and regexp's)

Basic example

require 'uri'

uri = URI("http://foo.com/posts?id=30&limit=5#time=1305298413")
#=> #<URI::HTTP:0x00000000b14880
      URL:http://foo.com/posts?id=30&limit=5#time=1305298413>
uri.scheme
#=> "http"
uri.host
#=> "foo.com"
uri.path
#=> "/posts"
uri.query
#=> "id=30&limit=5"
uri.fragment
#=> "time=1305298413"

uri.to_s
#=> "http://foo.com/posts?id=30&limit=5#time=1305298413"

Adding custom URIs

module URI
  class RSYNC < Generic
    DEFAULT_PORT = 873
  end
  @@schemes['RSYNC'] = RSYNC
end
#=> URI::RSYNC

URI.scheme_list
#=> {"FTP"=>URI::FTP, "HTTP"=>URI::HTTP, "HTTPS"=>URI::HTTPS,
     "LDAP"=>URI::LDAP, "LDAPS"=>URI::LDAPS, "MAILTO"=>URI::MailTo,
     "RSYNC"=>URI::RSYNC}

uri = URI("rsync://rsync.foo.com")
#=> #<URI::RSYNC:0x00000000f648c8 URL:rsync://rsync.foo.com>

RFC References

A good place to view an RFC spec is www.ietf.org/rfc.html

Here is a list of all related RFC's.

Class tree

Copyright Info

Author

Akira Yamada <akira@ruby-lang.org>

Documentation

Akira Yamada <akira@ruby-lang.org> Dmitry V. Sabanin <sdmitry@lrn.ru> Vincent Batts <vbatts@hashbangbash.com>

License

Copyright © 2001 akira yamada <akira@ruby-lang.org> You can redistribute it and/or modify it under the same term as Ruby.

Revision

$Id$

attributes=
  • References/Ruby on Rails/Ruby/Classes/URI/URI::LDAP

attributes=(val) Instance Public methods setter for attributes val

2025-01-10 15:47:30
build
  • References/Ruby on Rails/Ruby/Classes/URI/URI::HTTP

build(args) Class Public methods Description Create

2025-01-10 15:47:30
opaque=
  • References/Ruby on Rails/Ruby/Classes/URI/URI::Generic

opaque=(v) Instance Public methods Args v

2025-01-10 15:47:30
merge!
  • References/Ruby on Rails/Ruby/Classes/URI/URI::Generic

merge!(oth) Instance Public methods Args oth

2025-01-10 15:47:30
absolute
  • References/Ruby on Rails/Ruby/Classes/URI/URI::Generic

absolute() Instance Public methods Alias for:

2025-01-10 15:47:30
scope=
  • References/Ruby on Rails/Ruby/Classes/URI/URI::LDAP

scope=(val) Instance Public methods setter for scope val

2025-01-10 15:47:30
parser
  • References/Ruby on Rails/Ruby/Classes/URI/URI::Generic

parser() Instance Public methods returns the parser to be used.

2025-01-10 15:47:30
parse
  • References/Ruby on Rails/Ruby/Classes/URI

parse(uri) Class Public methods Synopsis

2025-01-10 15:47:30
to_mailtext
  • References/Ruby on Rails/Ruby/Classes/URI/URI::MailTo

to_mailtext() Instance Public methods Returns the RFC822 e-mail text equivalent

2025-01-10 15:47:30
set_typecode
  • References/Ruby on Rails/Ruby/Classes/URI/URI::FTP

set_typecode(v) Instance Protected methods private setter for the typecode v

2025-01-10 15:47:30