Parent

RestClient::Request

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')

backwards compatibility

Attributes

cookies[R]
headers[R]
method[R]
open_timeout[R]
password[R]
payload[R]
timeout[R]
url[R]
user[R]

Public Class Methods

execute(args) click to toggle source
# File lib/restclient/request.rb, line 11
def self.execute(args)
        new(args).execute
end
new(args) click to toggle source
# File lib/restclient/request.rb, line 15
          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]
          end

Public Instance Methods

decode(content_encoding, body) click to toggle source
# File lib/restclient/request.rb, line 148
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
default_headers() click to toggle source
# File lib/restclient/request.rb, line 182
def default_headers
        { :accept => 'application/xml', :accept_encoding => 'gzip, deflate' }
end
display_log(msg) click to toggle source
# File lib/restclient/request.rb, line 170
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
execute() click to toggle source
# File lib/restclient/request.rb, line 27
def execute
        execute_inner
rescue Redirect => e
        @url = e.url
        execute
end
execute_inner() click to toggle source
# File lib/restclient/request.rb, line 34
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
make_headers(user_headers) click to toggle source
# File lib/restclient/request.rb, line 39
          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
net_http_class() click to toggle source
# File lib/restclient/request.rb, line 50
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
net_http_request_class(method) click to toggle source
# File lib/restclient/request.rb, line 59
def net_http_request_class(method)
        Net::HTTP.const_get(method.to_s.capitalize)
end
parse_url(url) click to toggle source
# File lib/restclient/request.rb, line 63
def parse_url(url)
        url = "http://#{url}" unless url.match(/^http/)
        URI.parse(url)
end
parse_url_with_auth(url) click to toggle source
# File lib/restclient/request.rb, line 68
def parse_url_with_auth(url)
        uri = parse_url(url)
        @user = uri.user if uri.user
        @password = uri.password if uri.password
        uri
end
process_payload(p=nil, parent_key=nil) click to toggle source
# File lib/restclient/request.rb, line 75
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
process_result(res) click to toggle source
# File lib/restclient/request.rb, line 124
def process_result(res)
        if res.code =~ /\A2\d{2}\z/
                decode res['content-encoding'], res.body if res.body
        elsif %(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
request_log() click to toggle source
# File lib/restclient/request.rb, line 158
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
response_log(res) click to toggle source
# File lib/restclient/request.rb, line 166
def response_log(res)
        "# => #{res.code} #{res.class.to_s.gsub(/^Net::HTTP/, '')} | #{(res['Content-type'] || '').gsub(/;.*$/, '')} #{(res.body) ? res.body.size : nil} bytes"
end
setup_credentials(req) click to toggle source
# File lib/restclient/request.rb, line 120
def setup_credentials(req)
        req.basic_auth(user, password) if user
end
transmit(uri, req, payload) click to toggle source
# File lib/restclient/request.rb, line 92
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
        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)
                display_log response_log(res)
                string = process_result(res)

                if string or @method == :head
                        Response.new(string, res)
                else
                        nil
                end
        end
rescue EOFError
        raise RestClient::ServerBrokeConnection
rescue Timeout::Error
        raise RestClient::RequestTimeout
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.