Ruby 1.9.2 リファレンスマニュアル > ライブラリ一覧 > net/httpライブラリ > Net::HTTPクラス

class Net::HTTP

クラスの継承リスト: Net::HTTP < Object < Kernel < BasicObject

Abstract

HTTP のクライアントのためのクラスです。

特異メソッド

Proxy(address, port = 80)

Proxy 経由で http サーバに接続するためのクラスを作成し返します。このクラスは Net::HTTP を継承しているので Net::HTTP と全く同じように使えます。指定されたプロクシを常に経由して http サーバに接続します。

address が nil のときは Net::HTTP クラスをそのまま返します。

require 'net/http'
proxy_class = Net::HTTP::Proxy('proxy.example.com', 8080)
http = proxy_class.new('www.ruby-lang.org')
http.start {|h|
  h.get('/ja/') # proxy.example.com 経由で接続します。
}

http_default_port

default_port

port

HTTP のデフォルトポート (80) です。

get(address, path, port = 80)

ホスト address の port 番ポートに接続して path の表現するエンティティボディを取得し、文字列で返します。

get_print(address, path, port = 80)

ホスト address の port 番ポートに接続して path の表現するエンティティボディを取得したうえ、$stdout に << で出力します。

get_response(uri)

get_response(host, path = nil, port = nil)

https_default_port

HTTPS のデフォルトポート (443) です。

version_1_1?

version_1_1

is_version_1_1?

ライブラリのバージョンが 1.1 のとき true を返します。 Ruby 1.8 以降では常に false です。

version_1_2?

version_1_2

is_version_1_2?

ライブラリのバージョンが 1.2 のとき true を返します。 Ruby 1.8 以降では常に true です。

new(address, port = 80, proxy_addr = nil, proxy_port = nil)

新しい HTTP オブジェクトを生成します。address は HTTP サーバーの FQDN で、 port は接続するポート番号です。このメソッドではまだ接続はしません。

proxy_addr を与えるとプロクシを介して接続するオブジェクトを生成します。

post_form(uri, params)

proxy_address

proxy_class?

自身が (Proxy メソッドによって作成された) プロクシ用のクラスならば真。

proxy_pass

proxy_port

proxy_user

socket_type

このメソッドは obsolete です。

start(address, port = 80, proxy_addr = nil, proxy_port = nil)

start(address, port = 80, proxy_addr = nil, proxy_port = nil) {|http| .... }

以下と同じです。

Net::HTTP.new(address, port, proxy_addr, proxy_port).start(&block)

インスタンスメソッド

started?

active?

HTTP セッションが開始されていたら真。

address

接続するアドレス

close_on_empty_response

close_on_empty_response=(bool)

copy(path, initheader = nil)

set_debug_output(io)

debug_outupt=(io)

delete(path, initheader = nil)

finish

HTTP セッションを終了します。セッション開始前にこのメソッドが呼ばれた場合は例外 IOError を発生します。

get(path, header = nil)

get(path, header = nil) {|str| .... }

サーバ上の path にあるエンティティを取得します。また header が nil でなければ、リクエストを送るときにその内容を HTTP ヘッダとして書きこみます。header はハッシュで、「ヘッダ名 => 内容」のような形式でなければいけません。

戻り値は、バージョン 1.1 では HTTPResponse とエンティティボディ文字列の二要素の配列です。1.2 では HTTPResponse ただひとつのみです。この場合、エンティティボディは response.body で得られます。

ブロックとともに呼ばれた時はエンティティボディを少しずつブロックに与えます。

1.1 では 3xx (再試行可能なエラー)に対しても例外を発生します。この場合 HTTPResponse は例外オブジェクトから err.response で得ることができます。一方 1.2 では全く例外を発生しません。

# net/http version 1.1 (Ruby 1.6.x)
response, body = http.get( '/index.html' )

# net/http version 1.2 (Ruby 1.8.x or later)
response = http.get('/index.html')

# compatible in both version
response , = http.get('/index.html')
response.body

# compatible, using block
File.open('save.txt', 'w') {|f|
  http.get('/~foo/', nil) do |str|
    f.write str
  end
}

request_get(path, header = nil)

request_get(path, header = nil) {|response| .... }

get2(path, header = nil)

get2(path, header = nil) {|response| .... }

path にあるエンティティを取得します。 HTTPResponse オブジェクトを返します。

ブロックとともに呼び出されたときは、ブロック実行中は接続を維持したまま HTTPResponse オブジェクトをブロックに渡します。

このメソッドは HTTP プロトコルに関連した例外は発生させません。

# example
response = http.request_get('/index.html')
p response['content-type']
puts response.body          # body is already read

# using block
http.request_get('/index.html') {|response|
  p response['content-type']
  response.read_body do |str|   # read body now
    print str
  end
}

head(path, header = nil)

サーバ上の path にあるエンティティのヘッダのみを取得します。また header が nil でなければリクエストを送るときにその内容を HTTP ヘッダとして書きこみます。header はハッシュで、「ヘッダ名 => 内容」のような形式でなければいけません。

HTTPResponse オブジェクトを返します。

net/http version 1.1 では 3xx (再試行可能なエラー) に対しても例外を発生します。この場合、HTTPResponse は例外オブジェクトから err.response で得ることができます。一方 net/http version 1.2 では全く例外を発生しません。

response = nil
Net::HTTP.start('some.www.server', 80) {|http|
  response = http.head('/index.html')
}
p response['content-type']

request_head(path, header = nil)

request_head(path, header = nil) {|response| .... }

head2(path, header = nil)

head2(path, header = nil) {|response| .... }

inspect

lock(path, body, initheader = nil)

mkcol(path, body, initheader = nil)

move(path, body, initheader = nil)

open_timeout

open_timeout=(seconds)

接続時に待つ最大秒数。この秒数たってもコネクションが開かなければ例外 TimeoutError を発生します。

options(path, initheader = nil)

port

接続するポート番号

post(path, data, header = nil, dest = nil)

post(path, data, header = nil) {|str| .... }

サーバ上の path にあるエンティティに対し文字列 data を送ります。

戻り値は get と同じように、net/http バージョン 1.1 では HTTPResponse とエンティティボディ文字列の二要素の配列です。 net/http 1.2 では HTTPResponse ただひとつのみです。この場合、エンティティボディは response.body で得られます。

header は get メソッドと同じです。

dest を与えた場合には、レスポンスは << メソッドを使って dest に書きこまれます。 dest には << メソッドが定義されたオブジェクト、通常 String オブジェクトか Array オブジェクトを与えます。この dest は戻り値の HTTPResponse オブジェクトの body にもなります。

ブロックと一緒に呼びだされたときはエンティティボディを少しずつ文字列としてブロックに与えます。このとき戻り値の HTTPResponse オブジェクトは有効な body を持ちません。

dest とブロックを同時に与えてはいけません。同時に与えた場合は例外 ArgumentError を発生します。

net/http version 1.1 では 3xx (再試行可能なエラー)に対しても例外を発生します。この場合、HTTPResponse は例外オブジェクトから err.response で得ることができます。一方 net/http version 1.2 では全く例外を発生しません。

# net/http version 1.1 (Ruby 1.6.x)
response, body = http.post('/cgi-bin/search.rb', 'query=subject&target=ruby')

# version 1.2 (Ruby 1.8.x or later)
response = http.post('/cgi-bin/search.rb', 'query=subject&target=ruby')

# compatible in both version
response , = http.post('/cgi-bin/search.rb', 'query=subject&target=ruby')

# compatible, using block
File.open('save.html', 'w') {|f|
  http.post('/cgi-bin/search.rb', 'query=subject&target=ruby') do |str|
    f.write str
  end
}

request_post(path, data, header = nil)

request_post(path, data, header = nil) {|response| .... }

post2(path, data, header = nil)

post2(path, data, header = nil) {|response| .... }

path にあるエンティティを取得します。 HTTPResponse オブジェクトを返します。

ブロックとともに呼び出されたときは、ボディを読みこむ前に HTTPResponse オブジェクトをブロックに渡します。

このメソッドは HTTP プロトコルに関連した例外は発生させません。

# example
response = http.post2('/cgi-bin/nice.rb', 'datadatadata...')
p response.status
puts response.body          # body is already read

# using block
http.post2('/cgi-bin/nice.rb', 'datadatadata...') {|response|
  p response.status
  p response['content-type']
  response.read_body do |str|   # read body now
    print str
  end
}

propfind(path, body, initheader = {'Depth' => '0'})

proppatch(path, body, initheader = nil)

proxy?

プロクシを介して接続するなら真を返します。

proxy_address

proxyaddr

プロクシ経由で接続する HTTP オブジェクトならプロクシのアドレス。そうでないなら nil。

proxy_pass

proxy_port

proxyport

プロクシ経由で接続する HTTP オブジェクトならプロクシのポート。そうでないなら nil。

proxy_user

put(path, data, initheader = nil)

request_put(path, data, initheader = nil)

request_put(path, data, initheader = nil) {|response| .... }

put2(path, data, initheader = nil)

put2(path, data, initheader = nil) {|response| .... }

read_timeout

read_timeout=(seconds)

読みこみ (read(2) 一回) でブロックしてよい最大秒数。この秒数たっても読みこめなければ例外 TimeoutError を発生します。

request(request [, data])

request(request [, data]) {|response| .... }

HTTPResquest オブジェクト request を送信します。POST/PUT の時は data も与えられます (POST/PUT 以外で data を与えると ArgumentError を発生します)。

ブロックとともに呼びだされたときはボディを読みこまずに HTTPResponse オブジェクトをブロックに与えます。

このメソッドは HTTP プロトコルに関連した例外は発生させません。

send_request(name, path, data = nil, header = nil)

start

start {|http| .... }

TCP コネクションを張り、HTTP セッションを開始します。すでにセッションが開始していたら例外 IOError を発生します。

イテレータとして呼ばれた時はブロックの間だけセッションを接続し、ブロック終了とともに自動的にセッションを閉じます。

trace(path, initheader = nil)

unlock(path, body, initheader = nil)

追加されるメソッド

ca_file [added by net/https]
ca_file=(path) [added by net/https]: PEM 形式で保存された CA 証明書ファイルのパスを設定します。ファイルには複数の CA 証明書が含まれていても構いません。
ca_path [added by net/https]
ca_path=(path) [added by net/https]: PEM 形式で保存された CA 証明書ファイルが存在するディレクトリを設定します。
cert [added by net/https]
cert=(certificate) [added by net/https]: クライアント証明書として OpenSSL::X509::Certificate オブジェクトを設定します。
cert_store [added by net/https]
cert_store=(store) [added by net/https]: サーバ証明書の検証のために使う信頼している CA 証明書のストレージ OpenSSL::X509::Store オブジェクトを設定します。通常は ca_path=(path) や ca_file=(path) を使います。
key [added by net/https]
key=(key) [added by net/https]: OpenSSL::PKey::RSA オブジェクトか OpenSSL::PKey::DSA オブジェクトを設定します。
peer_cert [added by net/https]: サーバが送ってきた X.509 証明書を OpenSSL::X509::Certificate オブジェクトとして返します。
ssl_timeout [added by net/https]
ssl_timeout=(sec) [added by net/https]
timeout=(sec) [added by net/https]
use_ssl=(bool) [added by net/https]: HTTP で SSL/TLS を使うかどうかを設定します。 HTTPS 使う場合は true を代入します。デフォルトでは false です。つまり SSL/TLS を有効にするには必ず use_ssl = true を呼ぶ必要があります。
use_ssl? [added by net/https]: HTTP で SSL/TLS を使うなら true を返します。
verify_callback [added by net/https]
verify_callback=(proc) [added by net/https]: 通常のサーバ証明書の検証に加えてさらに適用される Proc オブジェクトを設定します。
verify_depth [added by net/https]
verify_depth=(depth) [added by net/https]: サーバ証明書を検証する時の証明書チェーンの最大の深さを設定します。
verify_mode [added by net/https]
verify_mode=(mode) [added by net/https]: サーバ証明書に対する検証モードを設定します。 OpenSSL::SSL::VERIFY_NONE か OpenSSL::SSL::VERIFY_PEER が設定可能です。 OpenSSL::SSL も参照してください。

class Net::HTTP

Abstract

特異メソッド

インスタンスメソッド

追加されるメソッド

Methods

Classes