Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > open-uriライブラリ > OpenURIモジュール
クラスの継承リスト: OpenURI
http/ftp に簡単にアクセスするためのモジュールです。
open_uri(name, mode = 'r', perm = nil, options = {}) -> StringIO
[permalink][rdoc]open_uri(name, mode = 'r', perm = nil, options = {}) {|sio| ... } -> nil
URI である文字列 name のリソースを取得して StringIO オブジェクト として返します。
ブロックを与えた場合は StringIO オブジェクトを引数としてブロックを 評価します。ブロックの終了時に StringIO は close されます。nil を返します。
require 'open-uri' sio = OpenURI.open_uri('http://www.example.com') p sio.last_modified puts sio.read OpenURI.open_uri('http://www.example.com'){|sio| sio.read }
options には Hash を与えます。理解するハッシュの キーは以下のシンボル、
です。 「:content_length_proc」と「:progress_proc」はプログレスバーに 利用されることを想定しています。
require 'open-uri' sio = OpenURI.open_uri('http://www.example.com', { :proxy => 'http://proxy.example.com:8000/', :http_basic_authentication => [username, password] })
プロクシの設定をします。 値には以下のいずれかを与えます。
文字列: "http://proxy.example.com:8000/" のようなプロクシの URI。 URI オブジェクト: URI.parse("http://proxy.example.com:8000/") のようなプロクシの URI オブジェクト。 true: Proxy を環境変数などから見つけようとする。使う環境変数は schema に応じて http_proxy, https_proxy, ftp_proxy が使われる。 false: Proxy を用いない。 nil: Proxy を用いない。
HTTP の Basic 認証のためのユーザ名とパスワードを、文字列の配列 ["user", "password"] として与えます。
値にはブロックを与えます。ブロックは対象となる URI の Content-Length ヘッダの値を引数として、実際の転送が始まる前に評価されます。Redirect された場合は、 実際に転送されるリソースの HTTP ヘッダを利用します。Content-Length ヘッダがない場合は、nil を 引数としてブロックを評価します。ブロックの返り値は特に利用されません。
値にはブロックを与えます。ブロックは対象となる URI からデータの 断片が転送されるたびに、その断片のサイズを引数として評価されます。ブロックの返り値は特に 利用されません。
パスワード付きプロクシの設定を与えます。 設定には3要素の配列を渡します。 最初の要素はプロクシのURIで、文字列かURIオブジェクトを指定します。 2番目にはプロクシのユーザ名、3番目にはプロクシのパスワードを指定します。
:proxy と :proxy_http_basic_authentication を同時に指定すると ArgumentError が発生します。
使い方:
:proxy_http_basic_authentication => ["http://proxy.example.com:8000/", "proxy-user", "proxy-password"] :proxy_http_basic_authentication => [URI.parse("http://proxy.example.com:8000/"), "proxy-user", "proxy-password"]
http コネクションのタイムアウト秒数を指定します。nil でタイムアウトなしを 指定できます。
SSL の CA 証明書を指定します。これを指定した場合は OpenSSL がデフォルトで使う CA 証明書は使われません。
証明書のファイル名、証明書のディレクトリ名を指定できます。 詳しくは OpenSSL::X509::Store#add_file、 OpenSSL::X509::Store#add_path を参照してください。デフォルトの証明書については OpenSSL::X509::Store#set_default_paths を参照してください。
SSL の証明書の検証のモードを指定します。 詳しくは OpenSSL::SSL::SSLContext#verify_mode= を参照してください。
ftp を active mode で使うかどうかを指定します。 デフォルトは false (passive mode) です。
HTTP でサーバがリダイレクトを指示してきたとき、 対応するかどうかを指定します。 デフォルトは true (リダイレクトする) です。
HTTP と FTP の間のリダイレクトもこれで指定します。