Module: HTTP::Chainable
Instance Method Summary collapse
-
#accept(type) ⇒ Object
Accept the given MIME type(s).
-
#auth(value, opts = nil) ⇒ Object
Make a request with the given Authorization header.
-
#basic_auth(opts) ⇒ Object
Make a request with the given Basic authorization header.
- #cache(cache) ⇒ Object (also: #with_cache)
-
#connect(uri, options = {}) ⇒ Object
Convert to a transparent TCP/IP tunnel.
-
#cookies(cookies) ⇒ Object
Make a request with the given cookies.
-
#default_headers ⇒ Object
deprecated
Deprecated.
Will be removed in 1.0.0; Use
#default_options#headers
-
#default_headers=(headers) ⇒ Object
deprecated
Deprecated.
Will be removed in 1.0.0; Use
#headers
-
#default_options ⇒ HTTP::Options
Get options for HTTP.
-
#default_options=(opts) ⇒ HTTP::Options
Set options for HTTP.
-
#delete(uri, options = {}) ⇒ Object
Delete a resource.
-
#follow(opts = {}) ⇒ HTTP::Client
(also: #with_follow)
Make client follow redirects.
-
#get(uri, options = {}) ⇒ Object
Get a resource.
-
#head(uri, options = {}) ⇒ Object
Request a get sans response body.
-
#headers(headers) ⇒ Object
(also: #with, #with_headers)
Make a request with the given headers.
-
#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)
197 198 199 |
# File 'lib/http/chainable.rb', line 197 def accept(type) with :accept => MimeType.normalize(type) end |
#auth(value, opts = nil) ⇒ Object
Make a request with the given Authorization header
203 204 205 206 207 208 |
# File 'lib/http/chainable.rb', line 203 def auth(value, opts = nil) # shim for deprecated auth(:basic, opts). # will be removed in 0.8.0 return basic_auth(opts) if :basic == value with :authorization => value.to_s end |
#basic_auth(opts) ⇒ Object
Make a request with the given Basic authorization header
215 216 217 218 219 220 |
# File 'lib/http/chainable.rb', line 215 def basic_auth(opts) user = opts.fetch :user pass = opts.fetch :pass auth("Basic " << Base64.strict_encode64("#{user}:#{pass}")) end |
#cache(cache) ⇒ Object Also known as: with_cache
168 169 170 |
# File 'lib/http/chainable.rb', line 168 def cache(cache) branch .with_cache(cache) end |
#connect(uri, options = {}) ⇒ Object
Convert to a transparent TCP/IP tunnel
57 58 59 |
# File 'lib/http/chainable.rb', line 57 def connect(uri, = {}) request :connect, uri, end |
#cookies(cookies) ⇒ Object
Make a request with the given cookies
191 192 193 |
# File 'lib/http/chainable.rb', line 191 def () branch .() end |
#default_headers ⇒ Object
Will be removed in 1.0.0; Use #default_options#headers
Get headers of HTTP options
237 238 239 |
# File 'lib/http/chainable.rb', line 237 def default_headers .headers end |
#default_headers=(headers) ⇒ Object
Will be removed in 1.0.0; Use #headers
Set headers of HTTP options
244 245 246 247 248 |
# File 'lib/http/chainable.rb', line 244 def default_headers=(headers) @default_options = .dup do |opts| opts.headers = headers end end |
#default_options ⇒ HTTP::Options
Get options for HTTP
224 225 226 |
# File 'lib/http/chainable.rb', line 224 def @default_options ||= HTTP::Options.new end |
#default_options=(opts) ⇒ HTTP::Options
Set options for HTTP
231 232 233 |
# File 'lib/http/chainable.rb', line 231 def (opts) @default_options = HTTP::Options.new(opts) end |
#delete(uri, options = {}) ⇒ Object
Delete a resource
36 37 38 |
# File 'lib/http/chainable.rb', line 36 def delete(uri, = {}) request :delete, uri, end |
#follow(opts = {}) ⇒ HTTP::Client Also known as: with_follow
Make client follow redirects.
160 161 162 |
# File 'lib/http/chainable.rb', line 160 def follow(opts = {}) branch .with_follow opts end |
#get(uri, options = {}) ⇒ Object
Get a resource
15 16 17 |
# File 'lib/http/chainable.rb', line 15 def get(uri, = {}) request :get, uri, end |
#head(uri, options = {}) ⇒ Object
Request a get sans response body
8 9 10 |
# File 'lib/http/chainable.rb', line 8 def head(uri, = {}) request :head, uri, end |
#headers(headers) ⇒ Object Also known as: with, with_headers
Make a request with the given headers
178 179 180 |
# File 'lib/http/chainable.rb', line 178 def headers(headers) branch .with_headers(headers) end |
#options(uri, options = {}) ⇒ Object
Return the methods supported on the given URI
50 51 52 |
# File 'lib/http/chainable.rb', line 50 def (uri, = {}) request :options, uri, end |
#patch(uri, options = {}) ⇒ Object
Apply partial modifications to a resource
64 65 66 |
# File 'lib/http/chainable.rb', line 64 def patch(uri, = {}) request :patch, uri, end |
#persistent(host) ⇒ HTTP::Client #persistent(host) {|client| ... } ⇒ Object
130 131 132 133 134 135 136 |
# File 'lib/http/chainable.rb', line 130 def persistent(host) p_client = branch .with_persistent host return p_client unless block_given? yield p_client ensure p_client.close end |
#post(uri, options = {}) ⇒ Object
Post to a resource
22 23 24 |
# File 'lib/http/chainable.rb', line 22 def post(uri, = {}) request :post, uri, end |
#put(uri, options = {}) ⇒ Object
Put to a resource
29 30 31 |
# File 'lib/http/chainable.rb', line 29 def put(uri, = {}) request :put, uri, end |
#request(verb, uri, options = {}) ⇒ Object
Make an HTTP request with the given verb
71 72 73 |
# File 'lib/http/chainable.rb', line 71 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
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/http/chainable.rb', line 83 def timeout(klass, = {}) klass, = :per_operation, klass if klass.is_a? Hash 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 fail ArgumentError, "Unsupported Timeout class: #{klass}" end [:read, :write, :connect].each do |k| next unless .key? k ["#{k}_timeout".to_sym] = .delete k end branch :timeout_class => klass, :timeout_options => end |
#trace(uri, options = {}) ⇒ Object
Echo the request back to the client
43 44 45 |
# File 'lib/http/chainable.rb', line 43 def trace(uri, = {}) request :trace, uri, end |
#via(*proxy) ⇒ Object Also known as: through
Make a request through an HTTP proxy
141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/http/chainable.rb', line 141 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) if [2, 4].include?(proxy_hash.keys.size) branch .with_proxy(proxy_hash) else fail(RequestError, "invalid HTTP proxy: #{proxy_hash}") end end |