rest-client 1.1.0 → 1.2.0

data/README.rdoc

@@ -8,10 +8,13 @@ of specifying actions: get, put, post, delete.
   require 'rest_client'
 
   RestClient.get 'http://example.com/resource'
+  
   RestClient.get 'https://user:password@example.com/private/resource'
 
   RestClient.post 'http://example.com/resource', :param1 => 'one', :nested => { :param2 => 'two' }
 
+  RestClient.post "http://example.com/resource", { 'x' => 1 }.to_json, :content_type => :json, :accept => :json
+
   RestClient.delete 'http://example.com/resource'
 
 == Multipart

data/Rakefile

@@ -7,8 +7,8 @@ Jeweler::Tasks.new do |s|
 	s.description = "A simple REST client for Ruby, inspired by the Sinatra microframework style of specifying actions: get, put, post, delete."
 	s.summary = "Simple REST client for Ruby, inspired by microframework syntax for specifying actions."
 	s.author = "Adam Wiggins"
-	s.email = "adam@heroku.com"
-	s.homepage = "http://rest-client.heroku.com/"
+	s.email = "rest.client@librelist.com"
+	s.homepage = "http://github.com/archiloque/rest-client"
 	s.rubyforge_project = "rest-client"
 	s.has_rdoc = true
 	s.files = FileList["[A-Z]*", "{bin,lib,spec}/**/*"]

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/lib/restclient.rb

@@ -3,10 +3,10 @@ require 'zlib'
 require 'stringio'
 
 begin
-	require 'net/https'
+  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"
+  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/request'
@@ -63,41 +63,42 @@ require File.dirname(__FILE__) + '/restclient/net_http_ext'
 #   => "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={})
-		Request.execute(:method => :get, :url => url, :headers => headers)
-	end
 
-	def self.post(url, payload, headers={})
-		Request.execute(:method => :post, :url => url, :payload => payload, :headers => headers)
-	end
+  def self.get(url, headers={})
+    Request.execute(:method => :get, :url => url, :headers => headers)
+  end
 
-	def self.put(url, payload, headers={})
-		Request.execute(:method => :put, :url => url, :payload => payload, :headers => headers)
-	end
+  def self.post(url, payload, headers={})
+    Request.execute(:method => :post, :url => url, :payload => payload, :headers => headers)
+  end
 
-	def self.delete(url, headers={})
-		Request.execute(:method => :delete, :url => url, :headers => headers)
-	end
+  def self.put(url, payload, headers={})
+    Request.execute(:method => :put, :url => url, :payload => payload, :headers => headers)
+  end
 
-	def self.head(url, headers={})
-		Request.execute(:method => :head, :url => url, :headers => headers)
-	end
+  def self.delete(url, headers={})
+    Request.execute(:method => :delete, :url => url, :headers => headers)
+  end
 
-	class << self
-		attr_accessor :proxy
-	end
+  def self.head(url, headers={})
+    Request.execute(:method => :head, :url => url, :headers => headers)
+  end
 
-	# Print log of RestClient calls.  Value can be stdout, stderr, or a filename.
-	# You can also configure logging by the environment variable RESTCLIENT_LOG.
-	def self.log=(log)
-		@@log = log
-	end
+  class << self
+    attr_accessor :proxy
+  end
+
+  # Print log of RestClient calls.  Value can be stdout, stderr, or a filename.
+  # You can also configure logging by the environment variable RESTCLIENT_LOG.
+  def self.log=(log)
+    @@log = log
+  end
 
-	def self.log    # :nodoc:
-		return ENV['RESTCLIENT_LOG'] if ENV['RESTCLIENT_LOG']
-		return @@log if defined? @@log
-		nil
-	end
+  def self.log # :nodoc:
+    return ENV['RESTCLIENT_LOG'] if ENV['RESTCLIENT_LOG']
+    return @@log if defined? @@log
+    nil
+  end
 
   def self.version
     version_path = File.dirname(__FILE__) + "/../VERSION"

data/lib/restclient/exceptions.rb

@@ -1,88 +1,89 @@
 module RestClient
-	# This is the base RestClient exception class. Rescue it if you want to
-	# catch any exception that your request might raise
-	class Exception < RuntimeError
-		def message(default=nil)
-			self.class::ErrorMessage
-		end
-	end
+  # This is the base RestClient exception class. Rescue it if you want to
+  # catch any exception that your request might raise
+  class Exception < RuntimeError
+    def message(default=nil)
+      self.class::ErrorMessage
+    end
+  end
 
-	# Base RestClient exception when there's a response available
-	class ExceptionWithResponse < Exception
-		attr_accessor :response
+  # Base RestClient exception when there's a response available
+  class ExceptionWithResponse < Exception
+    attr_accessor :response
 
-		def initialize(response=nil)
-			@response = response
-		end
+    def initialize(response=nil)
+      @response = response
+    end
 
-		def http_code
-			@response.code.to_i if @response
-		end
+    def http_code
+      @response.code.to_i if @response
+    end
 
-		def http_body
-			RestClient::Request.decode(@response['content-encoding'], @response.body) if @response
-		end
-	end
+    def http_body
+      RestClient::Request.decode(@response['content-encoding'], @response.body) if @response
+    end
+  end
 
-	# A redirect was encountered; caught by execute to retry with the new url.
-	class Redirect < Exception
-		ErrorMessage = "Redirect"
+  # A redirect was encountered; caught by execute to retry with the new url.
+  class Redirect < Exception
+    ErrorMessage = "Redirect"
 
-		attr_accessor :url
-		def initialize(url)
-			@url = url
-		end
-	end
+    attr_accessor :url
 
-	class NotModified < ExceptionWithResponse
-		ErrorMessage = 'NotModified'
-	end
+    def initialize(url)
+      @url = url
+    end
+  end
 
-	# Authorization is required to access the resource specified.
-	class Unauthorized < ExceptionWithResponse
-		ErrorMessage = 'Unauthorized'
-	end
+  class NotModified < ExceptionWithResponse
+    ErrorMessage = 'NotModified'
+  end
 
-	# No resource was found at the given URL.
-	class ResourceNotFound < ExceptionWithResponse
-		ErrorMessage = 'Resource not found'
-	end
+  # Authorization is required to access the resource specified.
+  class Unauthorized < ExceptionWithResponse
+    ErrorMessage = 'Unauthorized'
+  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
-		ErrorMessage = 'Server broke connection'
-	end
+  # No resource was found at the given URL.
+  class ResourceNotFound < ExceptionWithResponse
+    ErrorMessage = 'Resource not found'
+  end
 
-	# The server took too long to respond.
-	class RequestTimeout < Exception
-		ErrorMessage = 'Request timed out'
-	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
+    ErrorMessage = 'Server broke connection'
+  end
 
-	# The request failed, meaning the remote HTTP server returned a code other
-	# than success, unauthorized, or redirect.
-	#
-	# The exception message attempts to extract the error from the XML, using
-	# format returned by Rails: <errors><error>some message</error></errors>
-	#
-	# 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.body.
-	class RequestFailed < ExceptionWithResponse
-		def message
-			"HTTP status code #{http_code}"
-		end
+  # The server took too long to respond.
+  class RequestTimeout < Exception
+    ErrorMessage = 'Request timed out'
+  end
 
-		def to_s
-			message
-		end
-	end
+  # The request failed, meaning the remote HTTP server returned a code other
+  # than success, unauthorized, or redirect.
+  #
+  # The exception message attempts to extract the error from the XML, using
+  # format returned by Rails: <errors><error>some message</error></errors>
+  #
+  # 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.body.
+  class RequestFailed < ExceptionWithResponse
+    def message
+      "HTTP status code #{http_code}"
+    end
+
+    def to_s
+      message
+    end
+  end
 end
 
 # backwards compatibility
 class RestClient::Request
-	Redirect = RestClient::Redirect
-	Unauthorized = RestClient::Unauthorized
-	RequestFailed = RestClient::RequestFailed
+  Redirect = RestClient::Redirect
+  Unauthorized = RestClient::Unauthorized
+  RequestFailed = RestClient::RequestFailed
 end

data/lib/restclient/mixin/response.rb

@@ -1,48 +1,48 @@
 module RestClient
-	module Mixin
-		module Response
-			attr_reader :net_http_res
+  module Mixin
+    module Response
+      attr_reader :net_http_res
 
-			# HTTP status code, always 200 since RestClient throws exceptions for
-			# other codes.
-			def code
-				@code ||= @net_http_res.code.to_i
-			end
+      # HTTP status code, always 200 since RestClient throws exceptions for
+      # other codes.
+      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 ||= self.class.beautify_headers(@net_http_res.to_hash)
-			end
+      # A hash of the headers, beautified with symbols and underscores.
+      # e.g. "Content-type" will become :content_type.
+      def headers
+        @headers ||= self.class.beautify_headers(@net_http_res.to_hash)
+      end
 
-			# The raw headers.
-			def raw_headers
-				@raw_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] || "").split('; ').inject({}) do |out, raw_c|
-					key, val = raw_c.split('=')
-					unless %w(expires domain path secure).member?(key)
-						out[key] = val
-					end
-					out
-				end
-			end
+      # Hash of cookies extracted from response headers
+      def cookies
+        @cookies ||= (self.headers[:set_cookie] || "").split('; ').inject({}) do |out, raw_c|
+          key, val = raw_c.split('=')
+          unless %w(expires domain path secure).member?(key)
+            out[key] = val
+          end
+          out
+        end
+      end
 
-			def self.included(receiver)
-				receiver.extend(RestClient::Mixin::Response::ClassMethods)
-			end
+      def self.included(receiver)
+        receiver.extend(RestClient::Mixin::Response::ClassMethods)
+      end
 
-			module ClassMethods
-				def beautify_headers(headers)
-					headers.inject({}) do |out, (key, value)|
-						out[key.gsub(/-/, '_').downcase.to_sym] = value.first
-					out
-					end
-				end
-			end
-		end
-	end
+      module ClassMethods
+        def beautify_headers(headers)
+          headers.inject({}) do |out, (key, value)|
+            out[key.gsub(/-/, '_').downcase.to_sym] = value.first
+            out
+          end
+        end
+      end
+    end
+  end
 end

data/lib/restclient/net_http_ext.rb

@@ -6,16 +6,16 @@
 # http://www.missiondata.com/blog/ruby/29/streaming-data-to-s3-with-ruby/
 
 module Net
-	class HTTP
-		alias __request__ request
+  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
+    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

data/lib/restclient/payload.rb

@@ -1,171 +1,178 @@
-require "tempfile"
-require "stringio"
-require "mime/types"
+require 'tempfile'
+require 'stringio'
+require 'mime/types'
 
 module RestClient
-	module Payload
-		extend self
-
-		def generate(params)
-			if params.is_a?(String)
-				Base.new(params)
-			elsif params
-				if params.delete(:multipart) == true || has_file?(params)
-					Multipart.new(params)
-				else
-					UrlEncoded.new(params)
-				end
-			else
-				nil
-			end
-		end
-
-		def has_file?(params)
-			params.any? do |_, v|
-				case v
-				when Hash
-					has_file?(v)
-				else
-					v.respond_to?(:path) && v.respond_to?(:read)
-				end
-			end
-		end
-
-		class Base
-			def initialize(params)
-				build_stream(params)
-			end
-
-			def build_stream(params)
-				@stream = StringIO.new(params)
-				@stream.seek(0)
-			end
-
-			def read(bytes=nil)
-				@stream.read(bytes)
-			end
-			alias :to_s :read
-
-			def escape(v)
-				URI.escape(v.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
-			end
-
-			# Flatten parameters by converting hashes of hashes to flat hashes
-			# {keys1 => {keys2 => value}} will be transformed into {keys1[key2] => value}
-			def flatten_params(params, parent_key = nil)
-				result = {}
-				params.keys.map do |key|
-					calculated_key = parent_key ? "#{parent_key}[#{escape key}]" : escape(key)
-					value = params[key]
-					if value.is_a? Hash
-						result.merge!(flatten_params(value, calculated_key))
-					else
-						result[calculated_key] = value
-					end
-				end
-				result
-			end
-
-			def headers
-				{ 'Content-Length' => size.to_s }
-			end
-
-			def size
-				@stream.size
-			end
-			alias :length :size
-
-			def close
-				@stream.close
-			end
-
-			def inspect
-				result = to_s.inspect
-				@stream.seek(0)
-				result
-			end
-		end
-
-		class UrlEncoded < Base
-			def build_stream(params = nil)
-				@stream = StringIO.new(flatten_params(params).map do |k,v| 
-					"#{k}=#{escape(v)}"
-				end.join("&"))
-				@stream.seek(0)
-			end
-
-			def headers
-				super.merge({ 'Content-Type' => 'application/x-www-form-urlencoded' })
-			end
-		end
-
-		class Multipart < Base
-			EOL = "\r\n"
-
-			def build_stream(params)
-				b = "--#{boundary}"
-
-				@stream = Tempfile.new("RESTClient.Stream.#{rand(1000)}")
-				@stream.write(b + EOL)
-
-				if params.is_a? Hash
-					x = flatten_params(params).to_a
-				else
-					x = params.to_a
-				end
-				
-				last_index = x.length - 1
-				x.each_with_index do |a, index|
-					k, v = *a
-					if v.respond_to?(:read) && v.respond_to?(:path)
-						create_file_field(@stream, k,v)
-					else
-						create_regular_field(@stream, k,v)
-					end
-					@stream.write(EOL + b)
-					@stream.write(EOL) unless last_index == index
-				end
-				@stream.write('--')
-				@stream.write(EOL)
-				@stream.seek(0)
-			end
-
-			def create_regular_field(s, k, v)
-				s.write("Content-Disposition: multipart/form-data; name=\"#{k}\"")
-				s.write(EOL)
-				s.write(EOL)
-				s.write(v)
-			end
-
-			def create_file_field(s, k, v)
-				begin
-					s.write("Content-Disposition: multipart/form-data; name=\"#{k}\"; filename=\"#{v.respond_to?(:original_filename) ? v.original_filename : File.basename(v.path)}\"#{EOL}")
-					s.write("Content-Type: #{v.respond_to?(:content_type) ? v.content_type : mime_for(v.path)}#{EOL}")
-					s.write(EOL)
-					while data = v.read(8124)
-						s.write(data)
-					end
-				ensure
-					v.close
-				end
-			end
-
-			def mime_for(path)
-				mime = MIME::Types.type_for path
-				mime.empty? ? 'text/plain' : mime[0].content_type
-			end
-
-			def boundary
-				@boundary ||= rand(1_000_000).to_s
-			end
-
-			def headers
-				super.merge({'Content-Type' => %Q{multipart/form-data; boundary="#{boundary}"}})
-			end
-
-			def close
-				@stream.close
-			end
-		end
-	end
+  module Payload
+    extend self
+
+    def generate(params)
+      if params.is_a?(String)
+        Base.new(params)
+      elsif params
+        if params.delete(:multipart) == true || has_file?(params)
+          Multipart.new(params)
+        else
+          UrlEncoded.new(params)
+        end
+      else
+        nil
+      end
+    end
+
+    def has_file?(params)
+      params.any? do |_, v|
+        case v
+          when Hash
+            has_file?(v)
+          else
+            v.respond_to?(:path) && v.respond_to?(:read)
+        end
+      end
+    end
+
+    class Base
+      def initialize(params)
+        build_stream(params)
+      end
+
+      def build_stream(params)
+        @stream = StringIO.new(params)
+        @stream.seek(0)
+      end
+
+      def read(bytes=nil)
+        @stream.read(bytes)
+      end
+
+      alias :to_s :read
+
+      def escape(v)
+        URI.escape(v.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+      end
+
+      # Flatten parameters by converting hashes of hashes to flat hashes
+      # {keys1 => {keys2 => value}} will be transformed into {keys1[key2] => value}
+      def flatten_params(params, parent_key = nil)
+        result = {}
+        params.keys.map do |key|
+          calculated_key = parent_key ? "#{parent_key}[#{escape key}]" : escape(key)
+          value = params[key]
+          if value.is_a? Hash
+            result.merge!(flatten_params(value, calculated_key))
+          else
+            result[calculated_key] = value
+          end
+        end
+        result
+      end
+
+      def headers
+        { 'Content-Length' => size.to_s }
+      end
+
+      def size
+        @stream.size
+      end
+
+      alias :length :size
+
+      def close
+        @stream.close
+      end
+
+      def inspect
+        result = to_s.inspect
+        @stream.seek(0)
+        result
+      end
+
+      def short_inspect
+        (size > 100 ? "#{size} byte length" : inspect)
+      end
+
+    end
+
+    class UrlEncoded < Base
+      def build_stream(params = nil)
+        @stream = StringIO.new(flatten_params(params).map do |k, v|
+          "#{k}=#{escape(v)}"
+        end.join("&"))
+        @stream.seek(0)
+      end
+
+      def headers
+        super.merge({ 'Content-Type' => 'application/x-www-form-urlencoded' })
+      end
+    end
+
+    class Multipart < Base
+      EOL = "\r\n"
+
+      def build_stream(params)
+        b = "--#{boundary}"
+
+        @stream = Tempfile.new("RESTClient.Stream.#{rand(1000)}")
+        @stream.write(b + EOL)
+
+        if params.is_a? Hash
+          x = flatten_params(params).to_a
+        else
+          x = params.to_a
+        end
+
+        last_index = x.length - 1
+        x.each_with_index do |a, index|
+          k, v = *a
+          if v.respond_to?(:read) && v.respond_to?(:path)
+            create_file_field(@stream, k, v)
+          else
+            create_regular_field(@stream, k, v)
+          end
+          @stream.write(EOL + b)
+          @stream.write(EOL) unless last_index == index
+        end
+        @stream.write('--')
+        @stream.write(EOL)
+        @stream.seek(0)
+      end
+
+      def create_regular_field(s, k, v)
+        s.write("Content-Disposition: multipart/form-data; name=\"#{k}\"")
+        s.write(EOL)
+        s.write(EOL)
+        s.write(v)
+      end
+
+      def create_file_field(s, k, v)
+        begin
+          s.write("Content-Disposition: multipart/form-data; name=\"#{k}\"; filename=\"#{v.respond_to?(:original_filename) ? v.original_filename : File.basename(v.path)}\"#{EOL}")
+          s.write("Content-Type: #{v.respond_to?(:content_type) ? v.content_type : mime_for(v.path)}#{EOL}")
+          s.write(EOL)
+          while data = v.read(8124)
+            s.write(data)
+          end
+        ensure
+          v.close
+        end
+      end
+
+      def mime_for(path)
+        mime = MIME::Types.type_for path
+        mime.empty? ? 'text/plain' : mime[0].content_type
+      end
+
+      def boundary
+        @boundary ||= rand(1_000_000).to_s
+      end
+
+      def headers
+        super.merge({'Content-Type' => %Q{multipart/form-data; boundary="#{boundary}"}})
+      end
+
+      def close
+        @stream.close
+      end
+    end
+  end
 end