URI

Universal Resource Identifier support library for Ruby

クラス階層

URI Module
URI::Generic Class
- URI::FTP Class
- URI::HTTP Class
  - URI::HTTPS Class
- URI::LDAP Class
- URI::MailTo Class

クラス変数

@@schemes: モジュール関数 parse によって生成可能なクラスを値とするハッシュ。キーはスキームを大文字だけで表した文字列。 URI::Genericを継承する場合にこのハッシュにエントリを追加するとそのクラスが URI::parse によってサポートされます。

モジュールメソッド:

URI.split(url)

URI を以下の要素に分割した配列を返します。

scheme
userinfo
host
port
registry
path
opaque
query
fragment

例:

require 'uri'
p URI.split("http://www.ruby-lang.org/")
# => ["http", nil, "www.ruby-lang.org", nil, nil, "/", nil, nil, nil]

URI.parse(uri_str)

URI(uri_str) ((<ruby 1.8.2 feature>))

与えられた URI から該当する URI サブクラスのインスタンスを生成して返します。

require 'uri'
p uri = URI.parse("http://www.ruby-lang.org/")

# => #<URI::HTTP:0x201002a6 URL:http://www.ruby-lang.org/>
p uri.scheme    # => "http"
p uri.host      # => "www.ruby-lang.org"
p uri.port      # => 80
p uri.path      # => "/"

URI.join(uri_str[, str, ...])

文字列 uri_str と str ... をURIとして連結して得られる URIオブジェクトを返します。

以下と等価です

URI.parse(uri_str) + str + ....

例

require 'uri'
p URI.join('http://www.ruby-lang.org/', '/ja/man-1.6/')
=> #<URI::HTTP:0x2010017a URL:http://www.ruby-lang.org/ja/man-1.6/>

URI.extract(str[, schemes])

URI.extract(str[, schemes]) {|uri_str| ... }

文字列 str に対してパターンマッチングを試み、絶対URIにマッチした部分文字列からなる配列として返します。抽出する URI がなければ nil を返します。

第2引数に文字列の配列 schemes が与えられた場合はそのスキームだけを検索します。

ブロックが与えられた場合は String#scan と同様で、マッチした部分がみつかるたびに uri_str にその部分を代入してブロックを評価します。このときの値は nil です。

# つまらんサンプルだ・・・
require 'uri'
str = "
        http://www.ruby-lang.org/
        http://www.ruby-lang.org/man-1.6/
"
p URI.extract(str, %w(http))
=> ["http://www.ruby-lang.org/", "http://www.ruby-lang.org/man-1.6/"]

URI.regexp([match_schemes])

ruby 1.8.1 feature:

URIにマッチする正規表現を返します。

第 2 引数に文字列の配列 match_schemes を与えた場合は、その文字列で指定されるスキームの URI のみにマッチする正規表現を返します。

いずれの場合も返り値の正規表現は不定数の正規表現グループ (括弧) を含みます。この括弧の数はバージョンによって変動する可能性があるので、それに依存したコードを書くべきではありません。

URI.escape(str[, unsafe])

URI.encode(str[, unsafe])

URI 文字列をエンコードした文字列を返します。unsafe には、URI として指定できない文字を正規表現か文字列で指定します(デフォルトは、定数 URI::UNSAFE

/[^-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]]/n

です)。

require 'uri'
$KCODE = 'EUC'
p URI.escape('http://www.ruby-lang.org/ja/man-1.6/?cmd=view;name=Rubyリファレンスマニュアル')

=> "http://www.ruby-lang.org/ja/man-1.6/?cmd=view;name=Ruby%A5%EA%A5%D5%A5%A1%A5%EC%A5%F3%A5%B9%A5%DE%A5%CB%A5%E5%A5%A2%A5%EB"

URI.unescape(str)

URI.decode(str)

URI 文字列をデコードした文字列を返します。

require 'uri'
$KCODE = 'EUC'
p URI.unescape('http://www.ruby-lang.org/ja/man-1.6/?cmd=view;name=Ruby%A5%EA%A5%D5%A5%A1%A5%EC%A5%F3%A5%B9%A5%DE%A5%CB%A5%E5%A5%A2%A5%EB')

=> "http://www.ruby-lang.org/ja/man-1.6/?cmd=view;name=Rubyリファレンスマニュアル"

URI::Generic

すべての URI クラスの基底クラスです。

クラスメソッド:

URI::Generic.default_port

スキームに対応するデフォルトのポート番号を返します。

require 'uri'
p URI::Generic.default_port     # => nil
p URI::HTTP.default_port        # => 80

URI::Generic.component

URI の構成要素の配列を返します。

require 'uri'
p URI::Generic.component
p URI::MailTo.component

# => [:scheme, :userinfo, :host, :port, :registry, :path, :opaque, :query, :fragment]
# => [:scheme, :to, :headers]

URI::Generic.use_registry

registry 部を利用するか否かを表す真偽値。この値が偽のとき、new に偽でない registry 部が与えられると例外 URI::InvalidURIError が起こります。

URI::Generic.build2(ary)

URI::Generic.build2(hash)

URI::Generic.build と同じですが、例外 URI::InvalidComponentError が発生した場合に、引数の各要素を URI.escape して再度 build を試みます。

URI::Generic.build(ary)

URI::Generic.build(hash)

引数で与えられた URI 構成要素から URI::Generic オブジェクトを生成します。構成要素は、

[scheme, userinfo, host, port, registry, path, opaque, query, fragment]

を配列かハッシュで与えます。

URI::Generic.new(scheme, userinfo, host, port, registry, path, opaque, query, fragment[, arg_check])

各引数を成分とする汎用URIオブジェクトを生成して返します。

use_registry が偽のとき、new に偽でない registry 部が与えられると例外 URI::InvalidURIError が起こります。

第10引数arg_checkとして真が与えられた場合は、値を返す前に各引数が字句規則に適合しているか否かを検査し、適合しない場合は例外 URI::InvalidComponentError が起ります。

メソッド:

URI::Generic#default_port

self.class.default_port です。

URI::Generic#component

self.class.component です。

URI::Generic#scheme

URI::Generic#scheme=(v)

URI::Generic#userinfo

URI::Generic#userinfo=(v)

URI::Generic#user

URI::Generic#user=(v)

URI::Generic#password

URI::Generic#password=(v)

URI::Generic#host

URI::Generic#host=(v)

URI::Generic#port

URI::Generic#port=(v)

URI::Generic#registry

URI::Generic#registry=(v)

URI::Generic#path

URI::Generic#path=(v)

URI::Generic#query

URI::Generic#query=(v)

URI::Generic#opaque

URI::Generic#opaque=(v)

URI::Generic#fragment

URI::Generic#fragment=(v)

各構成要素の属性メソッドです。属性設定では、引数の正当性をチェックし不正な引数に対して例外 URI::InvalidComponentError を発生させます。 ^*1

URI::Generic#hierarchical?

path が真なら真です。

URI::Generic#absolute?

scheme が真なら真です。

URI::Generic#relative?

scheme が偽なら真です。

URI::Generic#merge(rel)

URI::Generic#+(rel)

rel を連結する。 rel が文字列の場合は URI::parse(rel) によって、 URI に変換してから連結する。

require 'uri'
p URI.parse('http://www.ruby-lang.org/') + '/en/raa.html'
=> #<URI::HTTP:0x201001c0 URL:http://www.ruby-lang.org/en/raa.html>

URI::Generic#route_from(src)

URI::Generic#-(src)

srcからの相対パスを返します。

require 'uri'
p URI.parse('http://www.ruby-lang.org/en/raa.html') - 'http://www.ruby-lang.org/'
=> #<URI::Generic:0x20100256 URL:en/raa.html>

URI::Generic#route_to(dst)

dstへの相対パスを返します。

require 'uri'
p URI.parse('http://www.ruby-lang.org/').route_to('http://www.ruby-lang.org/en/raa.html')

=> #<URI::Generic:0x20100198 URL:en/raa.html>

URI::Generic#normalize

URI::Generic#normalize!

URI オブジェクトを正規化して返します。ホスト名を小文字にし、path 構成要素がなければ '/' をセットします。

URI::Generic#to_s

URI::Generic#to_str

URI を返します。

URI::Generic#==(uri)

引数に指定した URI (文字列またはURIオブジェクト)との一致判定を行います。URI は正規化して比較されます。

URI::Generic#to_a

URI::Generic#to_ary

URI オブジェクトの構成要素の配列を返します。

URI::FTP

スーパークラス:

URI::Generic

クラスメソッド:

URI::FTP.build(ary)

URI::FTP.build(hash)

引数で与えられた URI 構成要素から URI::FTP オブジェクトを生成します。構成要素は、

[userinfo, host, port, path, typecode]

を配列かハッシュで与えます。typecode は、"a"、"i" あるいは "d" です。 "a" はテキスト、"i" はバイナリ、"d" はディレクトリを表します。 "a" がテキストで、"i" がバイナリなのは、それぞれのデータタイプが FTPのプロトコルで ASCII と IMAGE と呼ばれていたためです。

URI::FTP.new(scheme, userinfo, host, port, registry, path, opaque, query, fragment[, arg_check])

汎用的な構成要素から URI::FTP オブジェクトを生成します。build と異なり、引数の正当性を検査しません。

require 'uri'
p ftp = URI.parse("ftp://ftp.ruby-lang.org/pub/ruby/;type=d")
p ftp.typecode
=> #<URI::FTP:0x2010029c URL:ftp://ftp.ruby-lang.org/pub/ruby/;type=d>
   "d"

URI::FTP#typecode

URI::FTP#typecode=(v)

各構成要素の属性メソッドです。属性設定では、引数の正当性をチェックし不正な引数に対して例外 URI::InvalidComponentError を発生させます。

URI::HTTP

スーパークラス:

URI::Generic

クラスメソッド:

URI::HTTP.build(ary)

URI::HTTP.build(hash)

引数で与えられた URI 構成要素から URI::HTTP オブジェクトを生成します。構成要素は、

[userinfo, host, port, path, query, fragment]

を配列かハッシュで与えます。

URI::HTTP.new(scheme, userinfo, host, port, registry, path, opaque, query, fragment[, arg_check])

汎用的な構成要素から URI::HTTP オブジェクトを生成します。build と異なり、引数の正当性を検査しません。

メソッド:

URI::HTTP#request_uri: path + '?' + query を返します。

URI::HTTPS

スーパークラス:

URI::HTTP

URI::LDAP

LDAP URI SCHEMA (described in RFC 2255)

ldap://<host>/<dn>[?<attrs>[?<scope>[?<filter>[?<extensions>]]]]

スーパークラス:

URI::Generic

クラスメソッド:

URI::LDAP.build(ary)
URI::LDAP.build(hash)
URI::LDAP.new(scheme, userinfo, host, port, registry, path, opaque, query, fragment[, arg_check])

メソッド:

URI::LDAP#dn
URI::LDAP#dn=(v)
URI::LDAP#attributes
URI::LDAP#attributes=(v)
URI::LDAP#scope
URI::LDAP#scope=(v)
URI::LDAP#filter
URI::LDAP#filter=(v)
URI::LDAP#extensions
URI::LDAP#extensions=(v)

URI::MailTo

RFC 2368, The mailto URL scheme

スーパークラス:

URI::Generic

クラスメソッド:

URI::MailTo.build(ary)

URI::MailTo.build(hash)

引数で与えられた URI 構成要素から URI::MailTo オブジェクトを生成します。構成要素は、

[to, headers]

を配列かハッシュで与えます。headers は、以下のような文字列か配列で与えます。

"subject=subscribe&cc=addr"

[["subject", "subscribe"], ["cc", "addr"]]

URI::MailTo.new(scheme, userinfo, host, port, registry, path, opaque, query, fragment[, arg_check])

汎用的な構成要素から URI::MailTo オブジェクトを生成します。build と異なり、引数の正当性を検査しません。

メソッド:

URI::MailTo#to

URI::MailTo#to=(v)

URI::MailTo#headers

URI::MailTo#headers=(v)

各構成要素の属性メソッドです。属性設定では、引数の正当性をチェックし不正な引数に対して例外 URI::InvalidComponentError を発生させます。

URI::MailTo#to_mailtext

URI::MailTo#to_rfc822text

URI オブジェクトからメールテキスト文字列を生成します。

require 'uri'
p mailto = URI.parse("mailto:ruby-list@ruby-lang.org?subject=subscribe&cc=myaddr")
print mailto.to_mailtext

=> #<URI::MailTo:0x20104a0e URL:mailto:ruby-list@ruby-lang.org?subject=subscribe&cc=myaddr>
   To: ruby-list@ruby-lang.org
   Subject: subscribe
   Cc: myaddr

例外クラス

URI::Error
- URI::InvalidURIError
- URI::InvalidComponentError
- URI::BadURIError

URI::Error: すべての URI 例外クラスの基底クラスです。
URI::InvalidURIError: 不正な URI を指定したときに発生します。
URI::InvalidComponentError: 不正な構成要素を指定したときに発生します。
URI::BadURIError: URI として正しいが、使い方が悪いときに発生します。

^*1あらい 2002-09-24: InvalidURIError を起こすものもあるのはわざと？

URI

関連 RFC

クラス階層

クラス変数

モジュールメソッド:

URI::Generic

クラスメソッド:

メソッド:

URI::FTP

スーパークラス:

クラスメソッド:

URI::HTTP

スーパークラス:

クラスメソッド:

メソッド:

URI::HTTPS

スーパークラス:

URI::LDAP

スーパークラス:

クラスメソッド:

メソッド:

URI::MailTo

スーパークラス:

クラスメソッド:

メソッド:

例外クラス