larsburgess-rest-client 1.6.1

data/lib/restclient/raw_response.rb

@@ -0,0 +1,34 @@
+module RestClient
+  # The response from RestClient on a raw request looks like a string, but is
+  # actually one of these.  99% of the time you're making a rest call all you
+  # care about is the body, but on the occassion you want to fetch the
+  # headers you can:
+  #
+  #   RestClient.get('http://example.com').headers[:content_type]
+  #
+  # In addition, if you do not use the response as a string, you can access
+  # a Tempfile object at res.file, which contains the path to the raw
+  # downloaded request body.
+  class RawResponse
+
+    include AbstractResponse
+
+    attr_reader :file
+
+    def initialize tempfile, net_http_res, args
+      @net_http_res = net_http_res
+      @args = args
+      @file = tempfile
+    end
+
+    def to_s
+      @file.open
+      @file.read
+    end
+
+    def size
+      File.size file
+    end
+
+  end
+end

data/lib/restclient/request.rb

@@ -0,0 +1,300 @@
+require 'tempfile'
+require 'mime/types'
+require 'cgi'
+
+module RestClient
+  # This class is used internally by RestClient to send the request, but you can also
+  # call it directly if you'd like to use a method not supported by the
+  # main API.  For example:
+  #
+  #   RestClient::Request.execute(:method => :head, :url => 'http://example.com')
+  #
+  # Mandatory parameters:
+  # * :method
+  # * :url
+  # Optional parameters (have a look at ssl and/or uri for some explanations):
+  # * :headers a hash containing the request headers
+  # * :cookies will replace possible cookies in the :headers
+  # * :user and :password for basic auth, will be replaced by a user/password available in the :url
+  # * :raw_response return a low-level RawResponse instead of a Response
+  # * :verify_ssl enable ssl verification, possible values are constants from OpenSSL::SSL
+  # * :timeout and :open_timeout
+  # * :ssl_client_cert, :ssl_client_key, :ssl_ca_file
+  class Request
+
+    attr_reader :method, :url, :headers, :cookies,
+                :payload, :user, :password, :timeout,
+                :open_timeout, :raw_response, :verify_ssl, :ssl_client_cert,
+                :ssl_client_key, :ssl_ca_file, :processed_headers, :args
+
+    def self.execute(args, & block)
+      new(args).execute(& block)
+    end
+
+    def initialize args
+      @method = args[:method] or raise ArgumentError, "must pass :method"
+      @headers = args[:headers] || {}
+      if args[:url]
+        @url = process_get_params(args[:url], headers)
+      else
+        raise ArgumentError, "must pass :url"
+      end
+      @cookies = @headers.delete(:cookies) || args[:cookies] || {}
+      @payload = Payload.generate(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
+      @processed_headers = make_headers headers
+      @args = args
+    end
+
+    def execute & block
+      uri = parse_url_with_auth(url)
+      transmit uri, net_http_request_class(method).new(uri.request_uri, processed_headers), payload, & block
+    end
+
+    # Extract the query parameters for get request and append them to the url
+    def process_get_params url, headers
+      if [:get, :head].include? method
+        get_params = {}
+        headers.delete_if do |key, value|
+          if 'params' == key.to_s.downcase && value.is_a?(Hash)
+            get_params.merge! value
+            true
+          else
+            false
+          end
+        end
+        unless get_params.empty?
+          query_string = get_params.collect { |k, v| "#{k.to_s}=#{CGI::escape(v.to_s)}" }.join('&')
+          url + "?#{query_string}"
+        else
+          url
+        end
+      else
+        url
+      end
+    end
+
+    def make_headers user_headers
+      unless @cookies.empty?
+        user_headers[:cookie] = @cookies.map { |(key, val)| "#{key.to_s}=#{CGI::escape(val)}" }.sort.join(';')
+      end
+      headers = stringify_headers(default_headers).merge(stringify_headers(user_headers))
+      headers.merge!(@payload.headers) if @payload
+      headers
+    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 = CGI.unescape(uri.user) if uri.user
+      @password = CGI.unescape(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, & block
+      setup_credentials req
+
+      net = net_http_class.new(uri.host, uri.port)
+      net.use_ssl = uri.is_a?(URI::HTTPS)
+      if @verify_ssl == false
+        net.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      elsif @verify_ssl.is_a? Integer
+        net.verify_mode = @verify_ssl
+        net.verify_callback = lambda do |preverify_ok, ssl_context|
+          if (!preverify_ok) || ssl_context.error != 0
+            err_msg = "SSL Verification failed -- Preverify: #{preverify_ok}, Error: #{ssl_context.error_string} (#{ssl_context.error})"
+            raise SSLCertificateNotVerified.new(err_msg)
+          end
+          true
+        end
+      end
+      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
+
+      RestClient.before_execution_procs.each do |before_proc|
+        before_proc.call(req, args)
+      end
+
+      log_request
+
+      net.start do |http|
+        res = http.request(req, payload) { |http_response| fetch_body(http_response) }
+        log_response res
+        process_result res, & block
+      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 RestClient.log
+            if size == 0
+              RestClient.log << "#{@method} #{@url} done (0 length file\n)"
+            elsif total == 0
+              RestClient.log << "#{@method} #{@url} (zero content length)\n"
+            else
+              RestClient.log << "#{@method} #{@url} %d%% done (%d of %d)\n" % [(size * 100) / total, size, total]
+            end
+          end
+        end
+        @tf.close
+        @tf
+      else
+        http_response.read_body
+      end
+      http_response
+    end
+
+    def process_result res, & block
+      if @raw_response
+        # We don't decode raw requests
+        response = RawResponse.new(@tf, res, args)
+      else
+        response = Response.create(Request.decode(res['content-encoding'], res.body), res, args)
+      end
+
+      if block_given?
+        block.call(response, self, res, & block)
+      else
+        response.return!(self, res, & block)
+      end
+
+    end
+
+    def self.decode content_encoding, body
+      if (!body) || body.empty?
+        body
+      elsif content_encoding == 'gzip'
+        Zlib::GzipReader.new(StringIO.new(body)).read
+      elsif content_encoding == 'deflate'
+        Zlib::Inflate.new.inflate body
+      else
+        body
+      end
+    end
+
+    def log_request
+      if RestClient.log
+        out = []
+        out << "RestClient.#{method} #{url.inspect}"
+        out << payload.short_inspect if payload
+        out << processed_headers.to_a.sort.map { |(k, v)| [k.inspect, v.inspect].join("=>") }.join(", ")
+        RestClient.log << out.join(', ') + "\n"
+      end
+    end
+
+    def log_response res
+      if RestClient.log
+        size = @raw_response ? File.size(@tf.path) : (res.body.nil? ? 0 : res.body.size)
+        RestClient.log << "# => #{res.code} #{res.class.to_s.gsub(/^Net::HTTP/, '')} | #{(res['Content-type'] || '').gsub(/;.*$/, '')} #{size} bytes\n"
+      end
+    end
+
+    # Return a hash of headers whose keys are capitalized strings
+    def stringify_headers headers
+      headers.inject({}) do |result, (key, value)|
+        if key.is_a? Symbol
+          key = key.to_s.split(/_/).map { |w| w.capitalize }.join('-')
+        end
+        if 'CONTENT-TYPE' == key.upcase
+          target_value = value.to_s
+          result[key] = MIME::Types.type_for_extension target_value
+        elsif 'ACCEPT' == key.upcase
+          # Accept can be composed of several comma-separated values
+          if value.is_a? Array
+            target_values = value
+          else
+            target_values = value.to_s.split ','
+          end
+          result[key] = target_values.map { |ext| MIME::Types.type_for_extension(ext.to_s.strip) }.join(', ')
+        else
+          result[key] = value.to_s
+        end
+        result
+      end
+    end
+
+    def default_headers
+      {:accept => '*/*; q=0.5, application/xml', :accept_encoding => 'gzip, deflate'}
+    end
+
+  end
+end
+
+module MIME
+  class Types
+
+    # Return the first found content-type for a value considered as an extension or the value itself
+    def type_for_extension ext
+      candidates = @extension_index[ext]
+      candidates.empty? ? ext : candidates[0].content_type
+    end
+
+    class << self
+      def type_for_extension ext
+        @__types__.type_for_extension ext
+      end
+    end
+  end
+end

data/lib/restclient/resource.rb

@@ -0,0 +1,152 @@
+module RestClient
+  # A class that can be instantiated for access to a RESTful resource,
+  # including authentication.
+  #
+  # Example:
+  #
+  #   resource = RestClient::Resource.new('http://some/resource')
+  #   jpg = resource.get(:accept => 'image/jpg')
+  #
+  # With HTTP basic authentication:
+  #
+  #   resource = RestClient::Resource.new('http://protected/resource', :user => 'user', :password => 'password')
+  #   resource.delete
+  #
+  # With a timeout (seconds):
+  #
+  #   RestClient::Resource.new('http://slow', :timeout => 10)
+  #
+  # With an open timeout (seconds):
+  #
+  #   RestClient::Resource.new('http://behindfirewall', :open_timeout => 10)
+  #
+  # You can also use resources to share common headers. For headers keys,
+  # symbols are converted to strings. Example:
+  #
+  #   resource = RestClient::Resource.new('http://some/resource', :headers => { :client_version => 1 })
+  #
+  # This header will be transported as X-Client-Version (notice the X prefix,
+  # capitalization and hyphens)
+  #
+  # Use the [] syntax to allocate subresources:
+  #
+  #   site = RestClient::Resource.new('http://example.com', :user => 'adam', :password => 'mypasswd')
+  #   site['posts/1/comments'].post 'Good article.', :content_type => 'text/plain'
+  #
+  class Resource
+    attr_reader :url, :options, :block
+
+    def initialize(url, options={}, backwards_compatibility=nil, &block)
+      @url = url
+      @block = block
+      if options.class == Hash
+        @options = options
+      else # compatibility with previous versions
+        @options = { :user => options, :password => backwards_compatibility }
+      end
+    end
+
+    def get(additional_headers={}, &block)
+      headers = (options[:headers] || {}).merge(additional_headers)
+      Request.execute(options.merge(
+              :method => :get,
+              :url => url,
+              :headers => headers), &(block || @block))
+    end
+
+    def post(payload, additional_headers={}, &block)
+      headers = (options[:headers] || {}).merge(additional_headers)
+      Request.execute(options.merge(
+              :method => :post,
+              :url => url,
+              :payload => payload,
+              :headers => headers), &(block || @block))
+    end
+
+    def put(payload, additional_headers={}, &block)
+      headers = (options[:headers] || {}).merge(additional_headers)
+      Request.execute(options.merge(
+              :method => :put,
+              :url => url,
+              :payload => payload,
+              :headers => headers), &(block || @block))
+    end
+
+    def delete(additional_headers={}, &block)
+      headers = (options[:headers] || {}).merge(additional_headers)
+      Request.execute(options.merge(
+              :method => :delete,
+              :url => url,
+              :headers => headers), &(block || @block))
+    end
+
+    def to_s
+      url
+    end
+
+    def user
+      options[:user]
+    end
+
+    def password
+      options[:password]
+    end
+
+    def headers
+      options[:headers] || {}
+    end
+
+    def timeout
+      options[:timeout]
+    end
+
+    def open_timeout
+      options[:open_timeout]
+    end
+
+    # Construct a subresource, preserving authentication.
+    #
+    # Example:
+    #
+    #   site = RestClient::Resource.new('http://example.com', 'adam', 'mypasswd')
+    #   site['posts/1/comments'].post 'Good article.', :content_type => 'text/plain'
+    #
+    # This is especially useful if you wish to define your site in one place and
+    # call it in multiple locations:
+    #
+    #   def orders
+    #     RestClient::Resource.new('http://example.com/orders', 'admin', 'mypasswd')
+    #   end
+    #
+    #   orders.get                     # GET http://example.com/orders
+    #   orders['1'].get                # GET http://example.com/orders/1
+    #   orders['1/items'].delete       # DELETE http://example.com/orders/1/items
+    #
+    # Nest resources as far as you want:
+    #
+    #   site = RestClient::Resource.new('http://example.com')
+    #   posts = site['posts']
+    #   first_post = posts['1']
+    #   comments = first_post['comments']
+    #   comments.post 'Hello', :content_type => 'text/plain'
+    #
+    def [](suburl, &new_block)
+      case
+        when block_given? then self.class.new(concat_urls(url, suburl), options, &new_block)
+        when block        then self.class.new(concat_urls(url, suburl), options, &block)
+      else
+        self.class.new(concat_urls(url, suburl), options)
+      end
+    end
+
+    def concat_urls(url, suburl) # :nodoc:
+      url = url.to_s
+      suburl = suburl.to_s
+      if url.slice(-1, 1) == '/' or suburl.slice(0, 1) == '/'
+        url + suburl
+      else
+        "#{url}/#{suburl}"
+      end
+    end
+  end
+end