rest-client-multipart 1.1.0

data/lib/restclient/mixin/response.rb

@@ -0,0 +1,48 @@
+module RestClient
+	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
+
+			# 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
+
+			# 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
+
+			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

@@ -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

data/lib/restclient/payload.rb

@@ -0,0 +1,171 @@
+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
+end

data/lib/restclient/raw_response.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/mixin/response'
+
+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 RestClient::Mixin::Response
+
+		attr_reader :file
+
+		def initialize(tempfile, net_http_res)
+			@net_http_res = net_http_res
+			@file = tempfile
+		end
+
+		def to_s
+			@file.open
+			@file.read
+		end
+
+	end
+end

data/lib/restclient/request.rb

@@ -0,0 +1,252 @@
+require 'tempfile'
+
+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, :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 = 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
+		end
+
+		def execute
+			execute_inner
+		rescue Redirect => e
+			@url = e.url
+			@method = :get
+			@payload = nil
+			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
+
+			headers = default_headers.merge(user_headers).inject({}) do |final, (key, value)|
+				final[key.to_s.gsub(/_/, '-').capitalize] = value.to_s
+				final
+			end
+
+			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 = 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)
+			if @verify_ssl == false
+				net.verify_mode = OpenSSL::SSL::VERIFY_NONE
+			elsif @verify_ssl.is_a? Integer
+				net.verify_mode = @verify_ssl
+			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
+
+			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
+					Response.new(nil, res)
+				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
+					self.class.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 self.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.nil? ? 0 : 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 => '*/*; q=0.5, application/xml', :accept_encoding => 'gzip, deflate' }
+		end
+	end
+end