Module: HTTP::Chainable
Instance Method Summary collapse
-
#accept(type) ⇒ Object
Accept the given MIME type(s).
-
#auth(value) ⇒ Object
Make a request with the given Authorization header.
-
#basic_auth(opts) ⇒ Object
Make a request with the given Basic authorization header.
-
#connect(uri, options = {}) ⇒ Object
Convert to a transparent TCP/IP tunnel.
-
#cookies(cookies) ⇒ Object
Make a request with the given cookies.
-
#default_options ⇒ HTTP::Options
Get options for HTTP.
-
#default_options=(opts) ⇒ HTTP::Options
Set options for HTTP.
-
#delete(uri, options = {}) ⇒ Object
Delete a resource.
-
#encoding(encoding) ⇒ Object
Force a specific encoding for response body.
-
#follow(opts = {}) ⇒ HTTP::Client
Make client follow redirects.
-
#get(uri, options = {}) ⇒ Object
Get a resource.
-
#head(uri, options = {}) ⇒ Object
Request a get sans response body.
-
#headers(headers) ⇒ Object
Make a request with the given headers.
-
#nodelay ⇒ Object
Set TCP_NODELAY on the socket.
-
#options(uri, options = {}) ⇒ Object
Return the methods supported on the given URI.
-
#patch(uri, options = {}) ⇒ Object
Apply partial modifications to a resource.
- #persistent(host) ⇒ Object
-
#post(uri, options = {}) ⇒ Object
Post to a resource.
-
#put(uri, options = {}) ⇒ Object
Put to a resource.
-
#request(verb, uri, options = {}) ⇒ Object
Make an HTTP request with the given verb.
-
#timeout(klass, options = {}) ⇒ Object
@overload(options = {}) Syntax sugar for
timeout(:per_operation, options)
@overload(klass, options = {}) @param [#to_sym] klass @param [Hash] options @option options [Float] :read Read timeout @option options [Float] :write Write timeout @option options [Float] :connect Connect timeout. -
#trace(uri, options = {}) ⇒ Object
Echo the request back to the client.
-
#via(*proxy) ⇒ Object
(also: #through)
Make a request through an HTTP proxy.
Instance Method Details
#accept(type) ⇒ Object
Accept the given MIME type(s)
191 192 193 |
# File 'lib/http/chainable.rb', line 191 def accept(type) headers Headers::ACCEPT => MimeType.normalize(type) end |
#auth(value) ⇒ Object
Make a request with the given Authorization header
197 198 199 |
# File 'lib/http/chainable.rb', line 197 def auth(value) headers Headers::AUTHORIZATION => value.to_s end |
#basic_auth(opts) ⇒ Object
Make a request with the given Basic authorization header
206 207 208 209 210 211 |
# File 'lib/http/chainable.rb', line 206 def basic_auth(opts) user = opts.fetch :user pass = opts.fetch :pass auth("Basic " + Base64.strict_encode64("#{user}:#{pass}")) end |
#connect(uri, options = {}) ⇒ Object
Convert to a transparent TCP/IP tunnel
60 61 62 |
# File 'lib/http/chainable.rb', line 60 def connect(uri, = {}) request :connect, uri, end |
#cookies(cookies) ⇒ Object
Make a request with the given cookies
180 181 182 |
# File 'lib/http/chainable.rb', line 180 def () branch .() end |
#default_options ⇒ HTTP::Options
Get options for HTTP
215 216 217 |
# File 'lib/http/chainable.rb', line 215 def @default_options ||= HTTP::Options.new end |
#default_options=(opts) ⇒ HTTP::Options
Set options for HTTP
222 223 224 |
# File 'lib/http/chainable.rb', line 222 def (opts) @default_options = HTTP::Options.new(opts) end |
#delete(uri, options = {}) ⇒ Object
Delete a resource
39 40 41 |
# File 'lib/http/chainable.rb', line 39 def delete(uri, = {}) request :delete, uri, end |
#encoding(encoding) ⇒ Object
Force a specific encoding for response body
185 186 187 |
# File 'lib/http/chainable.rb', line 185 def encoding(encoding) branch .with_encoding(encoding) end |
#follow(opts = {}) ⇒ HTTP::Client
Make client follow redirects.
169 170 171 |
# File 'lib/http/chainable.rb', line 169 def follow(opts = {}) branch .with_follow opts end |
#get(uri, options = {}) ⇒ Object
Get a resource
18 19 20 |
# File 'lib/http/chainable.rb', line 18 def get(uri, = {}) request :get, uri, end |
#head(uri, options = {}) ⇒ Object
Request a get sans response body
11 12 13 |
# File 'lib/http/chainable.rb', line 11 def head(uri, = {}) request :head, uri, end |
#headers(headers) ⇒ Object
Make a request with the given headers
175 176 177 |
# File 'lib/http/chainable.rb', line 175 def headers(headers) branch .with_headers(headers) end |
#nodelay ⇒ Object
Set TCP_NODELAY on the socket
227 228 229 |
# File 'lib/http/chainable.rb', line 227 def nodelay branch .with_nodelay(true) end |
#options(uri, options = {}) ⇒ Object
Return the methods supported on the given URI
53 54 55 |
# File 'lib/http/chainable.rb', line 53 def (uri, = {}) request :options, uri, end |
#patch(uri, options = {}) ⇒ Object
Apply partial modifications to a resource
67 68 69 |
# File 'lib/http/chainable.rb', line 67 def patch(uri, = {}) request :patch, uri, end |
#persistent(host) ⇒ HTTP::Client #persistent(host) {|client| ... } ⇒ Object
139 140 141 142 143 144 145 |
# File 'lib/http/chainable.rb', line 139 def persistent(host) p_client = branch .with_persistent host return p_client unless block_given? yield p_client ensure p_client.close if p_client end |
#post(uri, options = {}) ⇒ Object
Post to a resource
25 26 27 |
# File 'lib/http/chainable.rb', line 25 def post(uri, = {}) request :post, uri, end |
#put(uri, options = {}) ⇒ Object
Put to a resource
32 33 34 |
# File 'lib/http/chainable.rb', line 32 def put(uri, = {}) request :put, uri, end |
#request(verb, uri, options = {}) ⇒ Object
Make an HTTP request with the given verb
74 75 76 |
# File 'lib/http/chainable.rb', line 74 def request(verb, uri, = {}) branch().request verb, uri end |
#timeout(klass, options = {}) ⇒ Object
@overload(options = {})
Syntax sugar for timeout(:per_operation, options)
@overload(klass, options = {})
@param [#to_sym] klass
@param [Hash] options
@option options [Float] :read Read timeout
@option options [Float] :write Write timeout
@option options [Float] :connect Connect timeout
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/http/chainable.rb', line 86 def timeout(klass, = {}) if klass.is_a? Hash = klass klass = :per_operation end klass = case klass.to_sym when :null then HTTP::Timeout::Null when :global then HTTP::Timeout::Global when :per_operation then HTTP::Timeout::PerOperation else raise ArgumentError, "Unsupported Timeout class: #{klass}" end [:read, :write, :connect].each do |k| next unless .key? k ["#{k}_timeout".to_sym] = .delete k end branch .merge( :timeout_class => klass, :timeout_options => ) end |
#trace(uri, options = {}) ⇒ Object
Echo the request back to the client
46 47 48 |
# File 'lib/http/chainable.rb', line 46 def trace(uri, = {}) request :trace, uri, end |
#via(*proxy) ⇒ Object Also known as: through
Make a request through an HTTP proxy
150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/http/chainable.rb', line 150 def via(*proxy) proxy_hash = {} proxy_hash[:proxy_address] = proxy[0] if proxy[0].is_a?(String) proxy_hash[:proxy_port] = proxy[1] if proxy[1].is_a?(Integer) proxy_hash[:proxy_username] = proxy[2] if proxy[2].is_a?(String) proxy_hash[:proxy_password] = proxy[3] if proxy[3].is_a?(String) proxy_hash[:proxy_headers] = proxy[2] if proxy[2].is_a?(Hash) proxy_hash[:proxy_headers] = proxy[4] if proxy[4].is_a?(Hash) raise(RequestError, "invalid HTTP proxy: #{proxy_hash}") unless (2..5).cover?(proxy_hash.keys.size) branch .with_proxy(proxy_hash) end |