Ruby

# Documentation::

# Akira Yamada <akira@ruby-lang.org>

# Dmitry V. Sabanin <sdmitry@lrn.ru>

# Vincent Batts <vbatts@hashbangbash.com>

#

# == Developer Documentation

#

# === Class tree

#

# - URI::Generic (in uri/generic.rb)

# - URI::FTP - (in uri/ftp.rb)

# - URI::HTTP - (in uri/http.rb)

# - URI::HTTPS - (in uri/https.rb)

# - URI::LDAP - (in uri/ldap.rb)

# - URI::LDAPS - (in uri/ldaps.rb)

# - URI::MailTo - (in uri/mailto.rb)

# - URI::Parser - (in uri/common.rb)

# - URI::REGEXP - (in uri/common.rb)

# - URI::REGEXP::PATTERN - (in uri/common.rb)

# - URI::Util - (in uri/common.rb)

# - URI::Escape - (in uri/common.rb)

# - URI::Error - (in uri/common.rb)

# - URI::InvalidURIError - (in uri/common.rb)

# - URI::InvalidComponentError - (in uri/common.rb)

# - URI::BadURIError - (in uri/common.rb)

#

#

# == URI

#

# === Introduction

#

# 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"

#

# === Next step example

#

# 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://rysnc.foo.com")

# #=> #<URI::RSYNC:0x00000000f648c8 URL:rsync://rsync.foo.com>

#

# == RFC References

#

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

#

# Here is a list of all related RFC's.

# - RFC822

# - RFC1738

# - RFC2255

# - RFC2368

# - RFC2373

# - RFC2396

# - RFC2732

# - RFC3986

#

# See URI for general documentation

#

#

end # module Escape

end # module URI

#

# See URI for general documentation

#

# See URI for general documentation

#

# See URI for general documentation

#

# See URI for general documentation

# License:: You can redistribute it and/or modify it under the same term as Ruby.

#

# See URI for general documentation

# = uri/ldap.rb

#

# License:: You can redistribute it and/or modify it under the same term as Ruby.

#

# See URI for general documentation

#

#

# See URI for general documentation