francois-rest-client 1.1.5

data/lib/restclient/request.rb

@@ -0,0 +1,241 @@
+require 'tempfile'
+
+module RestClient
+	# 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')
+	#
+	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
+					nil
+				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

data/lib/restclient/resource.rb

@@ -0,0 +1,146 @@
+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
+
+		def initialize(url, options={}, backwards_compatibility=nil)
+			@url = url
+			if options.class == Hash
+				@options = options
+			else # compatibility with previous versions
+				@options = { :user => options, :password => backwards_compatibility }
+			end
+		end
+
+		def get(additional_headers={}, &b)
+			headers = (options[:headers] || {}).merge(additional_headers)
+			Request.execute(options.merge(
+				:method => :get,
+				:url => url,
+				:headers => headers), &b)
+		end
+
+		def post(payload, additional_headers={}, &b)
+			headers = (options[:headers] || {}).merge(additional_headers)
+			Request.execute(options.merge(
+				:method => :post,
+				:url => url,
+				:payload => payload,
+				:headers => headers), &b)
+		end
+
+		def put(payload, additional_headers={}, &b)
+			headers = (options[:headers] || {}).merge(additional_headers)
+			Request.execute(options.merge(
+				:method => :put,
+				:url => url,
+				:payload => payload,
+				:headers => headers), &b)
+		end
+
+		def delete(additional_headers={}, &b)
+			headers = (options[:headers] || {}).merge(additional_headers)
+			Request.execute(options.merge(
+				:method => :delete,
+				:url => url,
+				:headers => headers), &b)
+		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)
+			self.class.new(concat_urls(url, suburl), options)
+		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

data/lib/restclient/response.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/mixin/response'
+
+module RestClient
+	# The response from RestClient 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]
+	#
+	class Response < String
+
+		include RestClient::Mixin::Response
+
+		def initialize(string, net_http_res)
+			@net_http_res = net_http_res
+			super(string || "")
+		end
+
+	end
+end

data/lib/restclient.rb

@@ -0,0 +1,107 @@
+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/request'
+require File.dirname(__FILE__) + '/restclient/mixin/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/exceptions'
+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={})
+		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.put(url, payload, headers={})
+		Request.execute(:method => :put, :url => url, :payload => payload, :headers => headers)
+	end
+
+	def self.delete(url, headers={})
+		Request.execute(:method => :delete, :url => url, :headers => headers)
+	end
+
+	def self.head(url, headers={})
+		Request.execute(:method => :head, :url => url, :headers => headers)
+	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.version
+    version_path = File.dirname(__FILE__) + "/../VERSION"
+    return File.read(version_path).chomp if File.file?(version_path)
+    "0.0.0"
+  end
+end

data/spec/base.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'spec'
+
+begin
+  require "ruby-debug"
+rescue LoadError
+  # NOP, ignore
+end
+
+require File.dirname(__FILE__) + '/../lib/restclient'

data/spec/exceptions_spec.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/base'
+
+describe RestClient::Exception do
+	it "sets the exception message to ErrorMessage" do
+		RestClient::ResourceNotFound.new.message.should == 'Resource not found'
+	end
+
+	it "contains exceptions in RestClient" do
+		RestClient::Unauthorized.new.should be_a_kind_of(RestClient::Exception)
+		RestClient::ServerBrokeConnection.new.should be_a_kind_of(RestClient::Exception)
+	end
+end
+
+describe RestClient::RequestFailed do
+	before do
+		@response = mock('HTTP Response', :code => '502')
+	end
+
+	it "stores the http response on the exception" do
+		begin
+			raise RestClient::RequestFailed, :response
+		rescue RestClient::RequestFailed => e
+			e.response.should == :response
+		end
+	end
+
+	it "http_code convenience method for fetching the code as an integer" do
+		RestClient::RequestFailed.new(@response).http_code.should == 502
+	end
+
+	it "http_body convenience method for fetching the body (decoding when necessary)" do
+		@response.stub!(:[]).with('content-encoding').and_return('gzip')
+		@response.stub!(:body).and_return('compressed body')
+		RestClient::Request.should_receive(:decode).with('gzip', 'compressed body').and_return('plain body')
+		RestClient::RequestFailed.new(@response).http_body.should == 'plain body'
+	end
+
+	it "shows the status code in the message" do
+		RestClient::RequestFailed.new(@response).to_s.should match(/502/)
+	end
+end
+
+describe RestClient::ResourceNotFound do
+	it "also has the http response attached" do
+		begin
+			raise RestClient::ResourceNotFound, :response
+		rescue RestClient::ResourceNotFound => e
+			e.response.should == :response
+		end
+	end
+end
+
+describe "backwards compatibility" do
+	it "alias RestClient::Request::Redirect to RestClient::Redirect" do
+		RestClient::Request::Redirect.should == RestClient::Redirect
+	end
+
+	it "alias RestClient::Request::Unauthorized to RestClient::Unauthorized" do
+		RestClient::Request::Unauthorized.should == RestClient::Unauthorized
+	end
+
+	it "alias RestClient::Request::RequestFailed to RestClient::RequestFailed" do
+		RestClient::Request::RequestFailed.should == RestClient::RequestFailed
+	end
+end

data/spec/mixin/response_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/../base'
+
+class MockResponse
+	include RestClient::Mixin::Response
+
+	def initialize(body, res)
+		@net_http_res = res
+		@body = @body
+	end
+end
+
+describe RestClient::Mixin::Response do
+	before do
+		@net_http_res = mock('net http response')
+		@response = MockResponse.new('abc', @net_http_res)
+	end
+
+	it "fetches the numeric response code" do
+		@net_http_res.should_receive(:code).and_return('200')
+		@response.code.should == 200
+	end
+
+	it "beautifies the headers by turning the keys to symbols" do
+		h = RestClient::Response.beautify_headers('content-type' => [ 'x' ])
+		h.keys.first.should == :content_type
+	end
+
+	it "beautifies the headers by turning the values to strings instead of one-element arrays" do
+		h = RestClient::Response.beautify_headers('x' => [ 'text/html' ] )
+		h.values.first.should == 'text/html'
+	end
+
+	it "fetches the headers" do
+		@net_http_res.should_receive(:to_hash).and_return('content-type' => [ 'text/html' ])
+		@response.headers.should == { :content_type => 'text/html' }
+	end
+
+	it "extracts cookies from response headers" do
+		@net_http_res.should_receive(:to_hash).and_return('set-cookie' => ['session_id=1; path=/'])
+		@response.cookies.should == { 'session_id' => '1' }
+	end
+
+	it "can access the net http result directly" do
+		@response.net_http_res.should == @net_http_res
+	end
+end