rest-client 1.6.0

data/lib/rest-client.rb

@@ -0,0 +1,2 @@
+# More logical way to require 'rest-client'
+require File.dirname(__FILE__) + '/restclient'

data/lib/rest_client.rb

@@ -0,0 +1,2 @@
+# This file exists for backward compatbility with require 'rest_client'
+require File.dirname(__FILE__) + '/restclient'

data/lib/restclient.rb

@@ -0,0 +1,161 @@
+require 'uri'
+require 'zlib'
+require 'stringio'
+
+begin
+  require 'net/https'
+rescue LoadError => e
+  raise e unless RUBY_PLATFORM =~ /linux/
+  raise LoadError, "no such file to load -- net/https. Try running apt-get install libopenssl-ruby"
+end
+
+require File.dirname(__FILE__) + '/restclient/exceptions'
+require File.dirname(__FILE__) + '/restclient/request'
+require File.dirname(__FILE__) + '/restclient/abstract_response'
+require File.dirname(__FILE__) + '/restclient/response'
+require File.dirname(__FILE__) + '/restclient/raw_response'
+require File.dirname(__FILE__) + '/restclient/resource'
+require File.dirname(__FILE__) + '/restclient/payload'
+require File.dirname(__FILE__) + '/restclient/net_http_ext'
+
+# This module's static methods are the entry point for using the REST client.
+#
+#   # GET
+#   xml = RestClient.get 'http://example.com/resource'
+#   jpg = RestClient.get 'http://example.com/resource', :accept => 'image/jpg'
+#
+#   # authentication and SSL
+#   RestClient.get 'https://user:password@example.com/private/resource'
+#
+#   # POST or PUT with a hash sends parameters as a urlencoded form body
+#   RestClient.post 'http://example.com/resource', :param1 => 'one'
+#
+#   # nest hash parameters
+#   RestClient.post 'http://example.com/resource', :nested => { :param1 => 'one' }
+#
+#   # POST and PUT with raw payloads
+#   RestClient.post 'http://example.com/resource', 'the post body', :content_type => 'text/plain'
+#   RestClient.post 'http://example.com/resource.xml', xml_doc
+#   RestClient.put 'http://example.com/resource.pdf', File.read('my.pdf'), :content_type => 'application/pdf'
+#
+#   # DELETE
+#   RestClient.delete 'http://example.com/resource'
+#
+#   # retreive the response http code and headers
+#   res = RestClient.get 'http://example.com/some.jpg'
+#   res.code                    # => 200
+#   res.headers[:content_type]  # => 'image/jpg'
+#
+#   # HEAD
+#   RestClient.head('http://example.com').headers
+#
+# To use with a proxy, just set RestClient.proxy to the proper http proxy:
+#
+#   RestClient.proxy = "http://proxy.example.com/"
+#
+# Or inherit the proxy from the environment:
+#
+#   RestClient.proxy = ENV['http_proxy']
+#
+# For live tests of RestClient, try using http://rest-test.heroku.com, which echoes back information about the rest call:
+#
+#   >> RestClient.put 'http://rest-test.heroku.com/resource', :foo => 'baz'
+#   => "PUT http://rest-test.heroku.com/resource with a 7 byte payload, content type application/x-www-form-urlencoded {\"foo\"=>\"baz\"}"
+#
+module RestClient
+
+  def self.get(url, headers={}, &block)
+    Request.execute(:method => :get, :url => url, :headers => headers, &block)
+  end
+
+  def self.post(url, payload, headers={}, &block)
+    Request.execute(:method => :post, :url => url, :payload => payload, :headers => headers, &block)
+  end
+
+  def self.put(url, payload, headers={}, &block)
+    Request.execute(:method => :put, :url => url, :payload => payload, :headers => headers, &block)
+  end
+
+  def self.delete(url, headers={}, &block)
+    Request.execute(:method => :delete, :url => url, :headers => headers, &block)
+  end
+
+  def self.head(url, headers={}, &block)
+    Request.execute(:method => :head, :url => url, :headers => headers, &block)
+  end
+
+  class << self
+    attr_accessor :proxy
+  end
+
+  # Setup the log for RestClient calls.
+  # Value should be a logger but can can be stdout, stderr, or a filename.
+  # You can also configure logging by the environment variable RESTCLIENT_LOG.
+  def self.log= log
+    @@log = create_log log
+  end
+
+  def self.version
+    version_path = File.dirname(__FILE__) + "/../VERSION"
+    return File.read(version_path).chomp if File.file?(version_path)
+    "0.0.0"
+  end
+
+  # Create a log that respond to << like a logger
+  # param can be 'stdout', 'stderr', a string (then we will log to that file) or a logger (then we return it)
+  def self.create_log param
+    if param
+      if param.is_a? String
+        if param == 'stdout'
+          stdout_logger = Class.new do
+            def << obj
+              STDOUT.puts obj
+            end
+          end
+          stdout_logger.new
+        elsif param == 'stderr'
+          stderr_logger = Class.new do
+            def << obj
+              STDERR.puts obj
+            end
+          end
+          stderr_logger.new
+        else
+          file_logger = Class.new do
+            attr_writer :target_file
+
+            def << obj
+              File.open(@target_file, 'a') { |f| f.puts obj }
+            end
+          end
+          logger = file_logger.new
+          logger.target_file = param
+          logger
+        end
+      else
+        param
+      end
+    end
+  end
+
+  @@env_log = create_log ENV['RESTCLIENT_LOG']
+
+  @@log = nil
+
+  def self.log # :nodoc:
+    @@env_log || @@log
+  end
+
+  @@before_execution_procs = []
+
+  # Add a Proc to be called before each request in executed.
+  # The proc parameters will be the http request and the request params.
+  def self.add_before_execution_proc &proc
+    @@before_execution_procs << proc
+  end
+
+  def self.before_execution_procs # :nodoc:
+    @@before_execution_procs
+  end
+
+end

data/lib/restclient/abstract_response.rb

@@ -0,0 +1,89 @@
+require 'cgi'
+
+module RestClient
+
+  module AbstractResponse
+
+    attr_reader :net_http_res, :args
+
+    # HTTP status code
+    def code
+      @code ||= @net_http_res.code.to_i
+    end
+
+    # A hash of the headers, beautified with symbols and underscores.
+    # e.g. "Content-type" will become :content_type.
+    def headers
+      @headers ||= AbstractResponse.beautify_headers(@net_http_res.to_hash)
+    end
+
+    # The raw headers.
+    def raw_headers
+      @raw_headers ||= @net_http_res.to_hash
+    end
+
+    # Hash of cookies extracted from response headers
+    def cookies
+      @cookies ||= (self.headers[:set_cookie] || {}).inject({}) do |out, cookie_content|
+        CGI::Cookie::parse(cookie_content).each do |key, cookie|
+          unless ['expires', 'path'].include? key
+            out[CGI::escape(key)] = cookie.value[0] ? (CGI::escape(cookie.value[0]) || '') : ''
+          end
+        end
+        out
+      end
+    end
+
+    # Return the default behavior corresponding to the response code:
+    # the response itself for code in 200..206, redirection for 301, 302 and 307 in get and head cases, redirection for 303 and an exception in other cases
+    def return! request  = nil, &block
+      if (200..207).include? code
+        self
+      elsif [301, 302, 307].include? code
+        unless [:get, :head].include? args[:method]
+          raise Exceptions::EXCEPTIONS_MAP[code], self
+        else
+          follow_redirection(request, &block)
+        end
+      elsif code == 303
+        args[:method] = :get
+        args.delete :payload
+        follow_redirection(request, &block)
+      elsif Exceptions::EXCEPTIONS_MAP[code]
+        raise Exceptions::EXCEPTIONS_MAP[code], self
+      else
+        raise RequestFailed, self
+      end
+    end
+
+    def to_i
+      code
+    end
+
+    def description
+      "#{code} #{STATUSES[code]} | #{(headers[:content_type] || '').gsub(/;.*$/, '')} #{size} bytes\n"
+    end
+
+    # Follow a redirection
+    def follow_redirection request = nil, &block
+      url = headers[:location]
+      if url !~ /^http/
+        url = URI.parse(args[:url]).merge(url).to_s
+      end
+      args[:url] = url
+      if request
+        args[:password] = request.password
+        args[:user] = request.user
+        args[:headers] = request.headers
+      end
+      Request.execute args, &block
+    end
+
+    def AbstractResponse.beautify_headers(headers)
+      headers.inject({}) do |out, (key, value)|
+        out[key.gsub(/-/, '_').downcase.to_sym] = %w{ set-cookie }.include?(key.downcase) ? value : value.first
+        out
+      end
+    end
+  end
+end

data/lib/restclient/exceptions.rb

@@ -0,0 +1,172 @@
+module RestClient
+
+  STATUSES = {100 => 'Continue',
+              101 => 'Switching Protocols',
+              102 => 'Processing', #WebDAV
+
+              200 => 'OK',
+              201 => 'Created',
+              202 => 'Accepted',
+              203 => 'Non-Authoritative Information', # http/1.1
+              204 => 'No Content',
+              205 => 'Reset Content',
+              206 => 'Partial Content',
+              207 => 'Multi-Status', #WebDAV
+
+              300 => 'Multiple Choices',
+              301 => 'Moved Permanently',
+              302 => 'Found',
+              303 => 'See Other', # http/1.1
+              304 => 'Not Modified',
+              305 => 'Use Proxy', # http/1.1
+              306 => 'Switch Proxy', # no longer used
+              307 => 'Temporary Redirect', # http/1.1
+              
+              400 => 'Bad Request',
+              401 => 'Unauthorized',
+              402 => 'Payment Required',
+              403 => 'Forbidden',
+              404 => 'Resource Not Found',
+              405 => 'Method Not Allowed',
+              406 => 'Not Acceptable',
+              407 => 'Proxy Authentication Required',
+              408 => 'Request Timeout',
+              409 => 'Conflict',
+              410 => 'Gone',
+              411 => 'Length Required',
+              412 => 'Precondition Failed',
+              413 => 'Request Entity Too Large',
+              414 => 'Request-URI Too Long',
+              415 => 'Unsupported Media Type',
+              416 => 'Requested Range Not Satisfiable',
+              417 => 'Expectation Failed',
+              418 => 'I\'m A Teapot',
+              421 => 'Too Many Connections From This IP',
+              422 => 'Unprocessable Entity', #WebDAV
+              423 => 'Locked', #WebDAV
+              424 => 'Failed Dependency', #WebDAV
+              425 => 'Unordered Collection', #WebDAV
+              426 => 'Upgrade Required', 
+              449 => 'Retry With', #Microsoft
+              450 => 'Blocked By Windows Parental Controls', #Microsoft
+
+              500 => 'Internal Server Error',
+              501 => 'Not Implemented',
+              502 => 'Bad Gateway',
+              503 => 'Service Unavailable',
+              504 => 'Gateway Timeout',
+              505 => 'HTTP Version Not Supported',
+              506 => 'Variant Also Negotiates',
+              507 => 'Insufficient Storage', #WebDAV
+              509 => 'Bandwidth Limit Exceeded', #Apache
+              510 => 'Not Extended'}
+
+  # Compatibility : make the Response act like a Net::HTTPResponse when needed
+  module ResponseForException
+    def method_missing symbol, *args
+      if net_http_res.respond_to? symbol
+        warn "[warning] The response contained in an RestClient::Exception is now a RestClient::Response instead of a Net::HTTPResponse, please update your code"
+        net_http_res.send symbol, *args
+      else
+        super
+      end
+    end
+  end
+
+  # This is the base RestClient exception class. Rescue it if you want to
+  # catch any exception that your request might raise
+  # You can get the status code by e.http_code, or see anything about the
+  # response via e.response.
+  # For example, the entire result body (which is
+  # probably an HTML error page) is e.response.
+  class Exception < RuntimeError
+    attr_accessor :message, :response
+
+    def initialize response = nil
+      @response = response
+
+      # compatibility: this make the exception behave like a Net::HTTPResponse
+      response.extend ResponseForException if response
+    end
+
+    def http_code
+      # return integer for compatibility
+      @response.code.to_i if @response
+    end
+
+    def http_body
+      @response.body if @response
+    end
+
+    def inspect
+      "#{self.class} : #{http_code} #{message}"
+    end
+
+  end
+
+  # Compatibility
+  class ExceptionWithResponse < Exception
+  end
+
+  # The request failed with an error code not managed by the code
+  class RequestFailed < ExceptionWithResponse
+
+    def message
+      "HTTP status code #{http_code}"
+    end
+
+    def to_s
+      message
+    end
+  end
+
+  # We will a create an exception for each status code, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
+  module Exceptions
+    # Map http status codes to the corresponding exception class
+    EXCEPTIONS_MAP = {}
+  end
+
+  STATUSES.each_pair do |code, message|
+
+    # Compatibility
+    superclass = ([304, 401, 404].include? code) ? ExceptionWithResponse : RequestFailed
+    klass = Class.new(superclass) do
+      send(:define_method, :message) {message}
+    end
+    klass_constant = const_set message.delete(' \-\''), klass
+    Exceptions::EXCEPTIONS_MAP[code] = klass_constant
+  end
+
+  # A redirect was encountered; caught by execute to retry with the new url.
+  class Redirect < Exception
+
+    message = 'Redirect'
+
+    attr_accessor :url
+
+    def initialize(url)
+      @url = url
+    end
+  end
+
+  # The server broke the connection prior to the request completing.  Usually
+  # this means it crashed, or sometimes that your network connection was
+  # severed before it could complete.
+  class ServerBrokeConnection < Exception
+    message = 'Server broke connection'
+  end
+
+  class SSLCertificateNotVerified < Exception
+    def initialize(message)
+      super(nil)
+      self.message = message
+    end
+  end
+end
+
+# backwards compatibility
+class RestClient::Request
+  Redirect = RestClient::Redirect
+  Unauthorized = RestClient::Unauthorized
+  RequestFailed = RestClient::RequestFailed
+end

data/lib/restclient/net_http_ext.rb

@@ -0,0 +1,21 @@
+#
+# Replace the request method in Net::HTTP to sniff the body type
+# and set the stream if appropriate
+#
+# Taken from:	
+# http://www.missiondata.com/blog/ruby/29/streaming-data-to-s3-with-ruby/
+
+module Net
+  class HTTP
+    alias __request__ request
+
+    def request(req, body=nil, &block)
+      if body != nil && body.respond_to?(:read)
+        req.body_stream = body
+        return __request__(req, nil, &block)
+      else
+        return __request__(req, body, &block)
+      end
+    end
+  end
+end