library open-uri

要約

http/ftp に簡単にアクセスするためのクラスです。 Kernel.#open を再定義します。

使用例

http/ftp の URL を、普通のファイルのように開けます。

require 'open-uri'
open("http://www.ruby-lang.org/") {|f|
  f.each_line {|line| p line}
}

開いたファイルオブジェクトは StringIO もしくは Tempfile ですが OpenURI::Meta モジュールで拡張されていて、メタ情報を獲得するメソッドが使えます。

require 'open-uri'
open("http://www.ruby-lang.org/en") {|f|
  f.each_line {|line| p line}
  p f.base_uri         # <URI::HTTP:0x40e6ef2 URL:http://www.ruby-lang.org/en/>
  p f.content_type     # "text/html"
  p f.charset          # "iso-8859-1"
  p f.content_encoding # []
  p f.last_modified    # Thu Dec 05 02:45:02 UTC 2002
}

ハッシュ引数で、追加のヘッダフィールドを指定できます。

require 'open-uri'
open("http://www.ruby-lang.org/en/",
  "User-Agent" => "Ruby/#{RUBY_VERSION}",
  "From" => "foo@bar.invalid",
  "Referer" => "http://www.ruby-lang.org/") {|f|
  ...
}

http_proxy や ftp_proxy などの環境変数は、デフォルトで有効になっています。プロキシを無効にするには :proxy => nil とします。

require 'open-uri'
open("http://www.ruby-lang.org/en/",
  :proxy => nil) {|f|
  ...
}

また、open-uri を読み込むと URI::HTTPURI::FTPOpenURI::OpenRead モジュールをインクルードします。ですので、 URI オブジェクトも似たような方法で開けます。

require 'open-uri'
uri = URI.parse("http://www.ruby-lang.org/en/")
uri.open {|f|
  ...
}

URI オブジェクトは直接読み込むことができます。戻り値の文字列は、OpenURI::Meta で拡張されています。

str = uri.read
p str.base_uri

モジュール

OpenURI

http/ftp に簡単にアクセスするためのモジュールです。

OpenURI::Meta

サーバから取得したデータの属性を扱うために使われるモジュールです。データを表す文字列や StringIO が extend します。

OpenURI::OpenRead

URI::HTTPURI::FTP を拡張するために用意されたモジュールです。

例外クラス

OpenURI::HTTPError

リソースの取得に失敗した時に投げられます。

追加・再定義されるメソッド

Kernel.#open