mirror of
https://github.com/rest-client/rest-client.git
synced 2022-11-09 13:49:40 -05:00
232 lines
6.2 KiB
Ruby
232 lines
6.2 KiB
Ruby
require 'tempfile'
|
|
|
|
module RestClient
|
|
# This class is used internally by RestClient to send the request, but you can also
|
|
# access it internally if you'd like to use a method not directly supported by the
|
|
# main API. For example:
|
|
#
|
|
# RestClient::Request.execute(:method => :head, :url => 'http://example.com')
|
|
#
|
|
class Request
|
|
attr_reader :method, :url, :payload, :headers,
|
|
:cookies, :user, :password, :timeout, :open_timeout,
|
|
:verify_ssl, :ssl_client_cert, :ssl_client_key, :ssl_ca_file,
|
|
:raw_response
|
|
|
|
def self.execute(args)
|
|
new(args).execute
|
|
end
|
|
|
|
def initialize(args)
|
|
@method = args[:method] or raise ArgumentError, "must pass :method"
|
|
@url = args[:url] or raise ArgumentError, "must pass :url"
|
|
@headers = args[:headers] || {}
|
|
@cookies = @headers.delete(:cookies) || args[:cookies] || {}
|
|
@payload = process_payload(args[:payload])
|
|
@user = args[:user]
|
|
@password = args[:password]
|
|
@timeout = args[:timeout]
|
|
@open_timeout = args[:open_timeout]
|
|
@raw_response = args[:raw_response] || false
|
|
@verify_ssl = args[:verify_ssl] || false
|
|
@ssl_client_cert = args[:ssl_client_cert] || nil
|
|
@ssl_client_key = args[:ssl_client_key] || nil
|
|
@ssl_ca_file = args[:ssl_ca_file] || nil
|
|
@tf = nil # If you are a raw request, this is your tempfile
|
|
end
|
|
|
|
def execute
|
|
execute_inner
|
|
rescue Redirect => e
|
|
@url = e.url
|
|
execute
|
|
end
|
|
|
|
def execute_inner
|
|
uri = parse_url_with_auth(url)
|
|
transmit uri, net_http_request_class(method).new(uri.request_uri, make_headers(headers)), payload
|
|
end
|
|
|
|
def make_headers(user_headers)
|
|
unless @cookies.empty?
|
|
user_headers[:cookie] = @cookies.map {|key, val| "#{key.to_s}=#{val}" }.join('; ')
|
|
end
|
|
|
|
default_headers.merge(user_headers).inject({}) do |final, (key, value)|
|
|
final[key.to_s.gsub(/_/, '-').capitalize] = value.to_s
|
|
final
|
|
end
|
|
end
|
|
|
|
def net_http_class
|
|
if RestClient.proxy
|
|
proxy_uri = URI.parse(RestClient.proxy)
|
|
Net::HTTP::Proxy(proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
|
|
else
|
|
Net::HTTP
|
|
end
|
|
end
|
|
|
|
def net_http_request_class(method)
|
|
Net::HTTP.const_get(method.to_s.capitalize)
|
|
end
|
|
|
|
def parse_url(url)
|
|
url = "http://#{url}" unless url.match(/^http/)
|
|
URI.parse(url)
|
|
end
|
|
|
|
def parse_url_with_auth(url)
|
|
uri = parse_url(url)
|
|
@user = uri.user if uri.user
|
|
@password = uri.password if uri.password
|
|
uri
|
|
end
|
|
|
|
def process_payload(p=nil, parent_key=nil)
|
|
unless p.is_a?(Hash)
|
|
p
|
|
else
|
|
@headers[:content_type] ||= 'application/x-www-form-urlencoded'
|
|
p.keys.map do |k|
|
|
key = parent_key ? "#{parent_key}[#{k}]" : k
|
|
if p[k].is_a? Hash
|
|
process_payload(p[k], key)
|
|
else
|
|
value = URI.escape(p[k].to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
|
|
"#{key}=#{value}"
|
|
end
|
|
end.join("&")
|
|
end
|
|
end
|
|
|
|
def transmit(uri, req, payload)
|
|
setup_credentials(req)
|
|
|
|
net = net_http_class.new(uri.host, uri.port)
|
|
net.use_ssl = uri.is_a?(URI::HTTPS)
|
|
net.verify_mode = OpenSSL::SSL::VERIFY_NONE if @verify_ssl == false
|
|
net.cert = @ssl_client_cert if @ssl_client_cert
|
|
net.key = @ssl_client_key if @ssl_client_key
|
|
net.ca_file = @ssl_ca_file if @ssl_ca_file
|
|
net.read_timeout = @timeout if @timeout
|
|
net.open_timeout = @open_timeout if @open_timeout
|
|
|
|
display_log request_log
|
|
|
|
net.start do |http|
|
|
res = http.request(req, payload) { |http_response| fetch_body(http_response) }
|
|
result = process_result(res)
|
|
display_log response_log(res)
|
|
|
|
if result.kind_of?(String) or @method == :head
|
|
Response.new(result, res)
|
|
elsif @raw_response
|
|
RawResponse.new(@tf, res)
|
|
else
|
|
nil
|
|
end
|
|
end
|
|
rescue EOFError
|
|
raise RestClient::ServerBrokeConnection
|
|
rescue Timeout::Error
|
|
raise RestClient::RequestTimeout
|
|
end
|
|
|
|
def setup_credentials(req)
|
|
req.basic_auth(user, password) if user
|
|
end
|
|
|
|
def fetch_body(http_response)
|
|
if @raw_response
|
|
# Taken from Chef, which as in turn...
|
|
# Stolen from http://www.ruby-forum.com/topic/166423
|
|
# Kudos to _why!
|
|
@tf = Tempfile.new("rest-client")
|
|
size, total = 0, http_response.header['Content-Length'].to_i
|
|
http_response.read_body do |chunk|
|
|
@tf.write(chunk)
|
|
size += chunk.size
|
|
if size == 0
|
|
display_log("#{@method} #{@url} done (0 length file)")
|
|
elsif total == 0
|
|
display_log("#{@method} #{@url} (zero content length)")
|
|
else
|
|
display_log("#{@method} #{@url} %d%% done (%d of %d)" % [(size * 100) / total, size, total])
|
|
end
|
|
end
|
|
@tf.close
|
|
@tf
|
|
else
|
|
http_response.read_body
|
|
end
|
|
http_response
|
|
end
|
|
|
|
def process_result(res)
|
|
if res.code =~ /\A2\d{2}\z/
|
|
# We don't decode raw requests
|
|
unless @raw_response
|
|
decode res['content-encoding'], res.body if res.body
|
|
end
|
|
elsif %w(301 302 303).include? res.code
|
|
url = res.header['Location']
|
|
|
|
if url !~ /^http/
|
|
uri = URI.parse(@url)
|
|
uri.path = "/#{url}".squeeze('/')
|
|
url = uri.to_s
|
|
end
|
|
|
|
raise Redirect, url
|
|
elsif res.code == "304"
|
|
raise NotModified, res
|
|
elsif res.code == "401"
|
|
raise Unauthorized, res
|
|
elsif res.code == "404"
|
|
raise ResourceNotFound, res
|
|
else
|
|
raise RequestFailed, res
|
|
end
|
|
end
|
|
|
|
def decode(content_encoding, body)
|
|
if content_encoding == 'gzip' and not body.empty?
|
|
Zlib::GzipReader.new(StringIO.new(body)).read
|
|
elsif content_encoding == 'deflate'
|
|
Zlib::Inflate.new.inflate(body)
|
|
else
|
|
body
|
|
end
|
|
end
|
|
|
|
def request_log
|
|
out = []
|
|
out << "RestClient.#{method} #{url.inspect}"
|
|
out << (payload.size > 100 ? "(#{payload.size} byte payload)".inspect : payload.inspect) if payload
|
|
out << headers.inspect.gsub(/^\{/, '').gsub(/\}$/, '') unless headers.empty?
|
|
out.join(', ')
|
|
end
|
|
|
|
def response_log(res)
|
|
size = @raw_response ? File.size(@tf.path) : res.body.size
|
|
"# => #{res.code} #{res.class.to_s.gsub(/^Net::HTTP/, '')} | #{(res['Content-type'] || '').gsub(/;.*$/, '')} #{size} bytes"
|
|
end
|
|
|
|
def display_log(msg)
|
|
return unless log_to = RestClient.log
|
|
|
|
if log_to == 'stdout'
|
|
STDOUT.puts msg
|
|
elsif log_to == 'stderr'
|
|
STDERR.puts msg
|
|
else
|
|
File.open(log_to, 'a') { |f| f.puts msg }
|
|
end
|
|
end
|
|
|
|
def default_headers
|
|
{ :accept => 'application/xml', :accept_encoding => 'gzip, deflate' }
|
|
end
|
|
end
|
|
end
|