1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
|
# frozen_string_literal: true
require "base64"
require "http/headers"
module HTTP
module Chainable
# Request a get sans response body
# @param uri
# @option options [Hash]
def head(uri, options = {}) # rubocop:disable Style/OptionHash
request :head, uri, options
end
# Get a resource
# @param uri
# @option options [Hash]
def get(uri, options = {}) # rubocop:disable Style/OptionHash
request :get, uri, options
end
# Post to a resource
# @param uri
# @option options [Hash]
def post(uri, options = {}) # rubocop:disable Style/OptionHash
request :post, uri, options
end
# Put to a resource
# @param uri
# @option options [Hash]
def put(uri, options = {}) # rubocop:disable Style/OptionHash
request :put, uri, options
end
# Delete a resource
# @param uri
# @option options [Hash]
def delete(uri, options = {}) # rubocop:disable Style/OptionHash
request :delete, uri, options
end
# Echo the request back to the client
# @param uri
# @option options [Hash]
def trace(uri, options = {}) # rubocop:disable Style/OptionHash
request :trace, uri, options
end
# Return the methods supported on the given URI
# @param uri
# @option options [Hash]
def options(uri, options = {}) # rubocop:disable Style/OptionHash
request :options, uri, options
end
# Convert to a transparent TCP/IP tunnel
# @param uri
# @option options [Hash]
def connect(uri, options = {}) # rubocop:disable Style/OptionHash
request :connect, uri, options
end
# Apply partial modifications to a resource
# @param uri
# @option options [Hash]
def patch(uri, options = {}) # rubocop:disable Style/OptionHash
request :patch, uri, options
end
# Make an HTTP request with the given verb
# @param verb
# @param uri
# @option options [Hash]
def request(verb, uri, options = {}) # rubocop:disable Style/OptionHash
branch(options).request verb, uri
end
# Prepare an HTTP request with the given verb
# @param verb
# @param uri
# @option options [Hash]
def build_request(verb, uri, options = {}) # rubocop:disable Style/OptionHash
branch(options).build_request verb, uri
end
# @overload timeout(options = {})
# Syntax sugar for `timeout(:per_operation, options)`
# @overload timeout(klass, options = {})
# Adds a timeout to the request.
# @param [#to_sym] klass
# either :null, :global, or :per_operation
# @param [Hash] options
# @option options [Float] :read Read timeout
# @option options [Float] :write Write timeout
# @option options [Float] :connect Connect timeout
def timeout(klass, options = {}) # rubocop:disable Style/OptionHash
if klass.is_a? Hash
options = 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
%i[read write connect].each do |k|
next unless options.key? k
options["#{k}_timeout".to_sym] = options.delete k
end
branch default_options.merge(
:timeout_class => klass,
:timeout_options => options
)
end
# @overload persistent(host, timeout: 5)
# Flags as persistent
# @param [String] host
# @option [Integer] timeout Keep alive timeout
# @raise [Request::Error] if Host is invalid
# @return [HTTP::Client] Persistent client
# @overload persistent(host, timeout: 5, &block)
# Executes given block with persistent client and automatically closes
# connection at the end of execution.
#
# @example
#
# def keys(users)
# HTTP.persistent("https://github.com") do |http|
# users.map { |u| http.get("/#{u}.keys").to_s }
# end
# end
#
# # same as
#
# def keys(users)
# http = HTTP.persistent "https://github.com"
# users.map { |u| http.get("/#{u}.keys").to_s }
# ensure
# http.close if http
# end
#
#
# @yieldparam [HTTP::Client] client Persistent client
# @return [Object] result of last expression in the block
def persistent(host, timeout: 5)
options = {:keep_alive_timeout => timeout}
p_client = branch default_options.merge(options).with_persistent host
return p_client unless block_given?
yield p_client
ensure
p_client.close if p_client
end
# Make a request through an HTTP proxy
# @param [Array] proxy
# @raise [Request::Error] if HTTP proxy is invalid
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 default_options.with_proxy(proxy_hash)
end
alias through via
# Make client follow redirects.
# @param opts
# @return [HTTP::Client]
# @see Redirector#initialize
def follow(options = {}) # rubocop:disable Style/OptionHash
branch default_options.with_follow options
end
# Make a request with the given headers
# @param headers
def headers(headers)
branch default_options.with_headers(headers)
end
# Make a request with the given cookies
def cookies(cookies)
branch default_options.with_cookies(cookies)
end
# Force a specific encoding for response body
def encoding(encoding)
branch default_options.with_encoding(encoding)
end
# Accept the given MIME type(s)
# @param type
def accept(type)
headers Headers::ACCEPT => MimeType.normalize(type)
end
# Make a request with the given Authorization header
# @param [#to_s] value Authorization header value
def auth(value)
headers Headers::AUTHORIZATION => value.to_s
end
# Make a request with the given Basic authorization header
# @see http://tools.ietf.org/html/rfc2617
# @param [#fetch] opts
# @option opts [#to_s] :user
# @option opts [#to_s] :pass
def basic_auth(opts)
user = opts.fetch :user
pass = opts.fetch :pass
auth("Basic " + Base64.strict_encode64("#{user}:#{pass}"))
end
# Get options for HTTP
# @return [HTTP::Options]
def default_options
@default_options ||= HTTP::Options.new
end
# Set options for HTTP
# @param opts
# @return [HTTP::Options]
def default_options=(opts)
@default_options = HTTP::Options.new(opts)
end
# Set TCP_NODELAY on the socket
def nodelay
branch default_options.with_nodelay(true)
end
# Turn on given features. Available features are:
# * auto_inflate
# * auto_deflate
# @param features
def use(*features)
branch default_options.with_features(features)
end
private
# :nodoc:
def branch(options)
HTTP::Client.new(options)
end
end
end
|