rest-client 0.6.2 → 0.7

data/Rakefile

@@ -31,7 +31,7 @@ require 'rake/gempackagetask'
 require 'rake/rdoctask'
 require 'fileutils'
 
-version = "0.6.2"
+version = "0.7"
 name = "rest-client"
 
 spec = Gem::Specification.new do |s|

data/lib/rest_client.rb

@@ -1,5 +1,7 @@
 require 'uri'
 require 'net/https'
+require 'zlib'
+require 'stringio'
 
 require File.dirname(__FILE__) + '/resource'
 require File.dirname(__FILE__) + '/request_errors'
@@ -59,6 +61,18 @@ module RestClient
 			: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
+
+	def self.log    # :nodoc:
+		return ENV['RESTCLIENT_LOG'] if ENV['RESTCLIENT_LOG']
+		return @@log if defined? @@log
+		nil
+	end
+
 	# Internal class used to build and execute the request.
 	class Request
 		attr_reader :method, :url, :payload, :headers, :user, :password
@@ -136,8 +150,12 @@ module RestClient
 			net = Net::HTTP.new(uri.host, uri.port)
 			net.use_ssl = uri.is_a?(URI::HTTPS)
 
+			display_log request_log
+
 			net.start do |http|
-				process_result http.request(req, payload || "")
+				res = http.request(req, payload || "")
+				display_log response_log(res)
+				process_result res
 			end
 		rescue EOFError
 			raise RestClient::ServerBrokeConnection
@@ -151,7 +169,7 @@ module RestClient
 
 		def process_result(res)
 			if %w(200 201 202).include? res.code
-				res.body
+				decode res['content-encoding'], res.body
 			elsif %w(301 302 303).include? res.code
 				url = res.header['Location']
 
@@ -171,8 +189,42 @@ module RestClient
 			end
 		end
 
+		def decode(content_encoding, body)
+			if content_encoding == 'gzip'
+				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)
+			"# => #{res.code} #{res.class.to_s.gsub(/^Net::HTTP/, '')} | #{(res['Content-type'] || '').gsub(/;.*$/, '')} #{res.body.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 => 'application/xml' }
+			{ :accept => 'application/xml', :accept_encoding => 'gzip, deflate' }
 		end
 	end
 end

data/spec/rest_client_spec.rb

@@ -23,6 +23,29 @@ describe RestClient do
 		end
 	end
 
+	context "logging" do
+		after do
+			RestClient.log = nil
+		end
+
+		it "gets the log source from the RESTCLIENT_LOG environment variable" do
+			ENV.stub!(:[]).with('RESTCLIENT_LOG').and_return('from env')
+			RestClient.log = 'from class method'
+			RestClient.log.should == 'from env'
+		end
+
+		it "sets a destination for log output, used if no environment variable is set" do
+			ENV.stub!(:[]).with('RESTCLIENT_LOG').and_return(nil)
+			RestClient.log = 'from class method'
+			RestClient.log.should == 'from class method'
+		end
+
+		it "returns nil (no logging) if neither are set (default)" do
+			ENV.stub!(:[]).with('RESTCLIENT_LOG').and_return(nil)
+			RestClient.log.should == nil
+		end
+	end
+	
 	context RestClient::Request do
 		before do
 			@request = RestClient::Request.new(:method => :put, :url => 'http://some/resource', :payload => 'payload')
@@ -43,10 +66,23 @@ describe RestClient do
 			@request.default_headers[:accept].should == 'application/xml'
 		end
 
+		it "decodes an uncompressed result body by passing it straight through" do
+			@request.decode(nil, 'xyz').should == 'xyz'
+		end
+
+		it "decodes a gzip body" do
+			@request.decode('gzip', "\037\213\b\b\006'\252H\000\003t\000\313T\317UH\257\312,HM\341\002\000G\242(\r\v\000\000\000").should == "i'm gziped\n"
+		end
+
+		it "decodes a deflated body" do
+			@request.decode('deflate', "x\234+\316\317MUHIM\313I,IMQ(I\255(\001\000A\223\006\363").should == "some deflated text"
+		end
+
 		it "processes a successful result" do
 			res = mock("result")
 			res.stub!(:code).and_return("200")
 			res.stub!(:body).and_return('body')
+			res.stub!(:[]).with('content-encoding').and_return(nil)
 			@request.process_result(res).should == 'body'
 		end
 
@@ -106,6 +142,7 @@ describe RestClient do
 		it "transmits the request with Net::HTTP" do
 			@http.should_receive(:request).with('req', 'payload')
 			@request.should_receive(:process_result)
+			@request.should_receive(:response_log)
 			@request.transmit(@uri, 'req', 'payload')
 		end
 
@@ -114,12 +151,14 @@ describe RestClient do
 			@net.should_receive(:use_ssl=).with(true)
 			@http.stub!(:request)
 			@request.stub!(:process_result)
+			@request.stub!(:response_log)
 			@request.transmit(@uri, 'req', 'payload')
 		end
 
 		it "doesn't send nil payloads" do
 			@http.should_receive(:request).with('req', '')
 			@request.should_receive(:process_result)
+			@request.stub!(:response_log)
 			@request.transmit(@uri, 'req', nil)
 		end
 
@@ -146,6 +185,7 @@ describe RestClient do
 		it "sets up the credentials prior to the request" do
 			@http.stub!(:request)
 			@request.stub!(:process_result)
+			@request.stub!(:response_log)
 
 			@request.stub!(:user).and_return('joe')
 			@request.stub!(:password).and_return('mypass')
@@ -216,5 +256,63 @@ describe RestClient do
 			res = mock('response', :code => '500')
 			lambda { @request.process_result(res) }.should raise_error(RestClient::RequestFailed)
 		end
+
+		it "logs a get request" do
+			RestClient::Request.new(:method => :get, :url => 'http://url').request_log.should ==
+			'RestClient.get "http://url"'
+		end
+
+		it "logs a post request with a small payload" do
+			RestClient::Request.new(:method => :post, :url => 'http://url', :payload => 'foo').request_log.should ==
+			'RestClient.post "http://url", "foo"'
+		end
+
+		it "logs a post request with a large payload" do
+			RestClient::Request.new(:method => :post, :url => 'http://url', :payload => ('x' * 1000)).request_log.should ==
+			'RestClient.post "http://url", "(1000 byte payload)"'
+		end
+
+		it "logs input headers as a hash" do
+			RestClient::Request.new(:method => :get, :url => 'http://url', :headers => { :accept => 'text/plain' }).request_log.should ==
+			'RestClient.get "http://url", :accept=>"text/plain"'
+		end
+
+		it "logs a response including the status code, content type, and result body size in bytes" do
+			res = mock('result', :code => '200', :class => Net::HTTPOK, :body => 'abcd')
+			res.stub!(:[]).with('Content-type').and_return('text/html')
+			@request.response_log(res).should == "# => 200 OK | text/html 4 bytes"
+		end
+
+		it "logs a response with a nil Content-type" do
+			res = mock('result', :code => '200', :class => Net::HTTPOK, :body => 'abcd')
+			res.stub!(:[]).with('Content-type').and_return(nil)
+			@request.response_log(res).should == "# => 200 OK |  4 bytes"
+		end
+
+		it "strips the charset from the response content type" do
+			res = mock('result', :code => '200', :class => Net::HTTPOK, :body => 'abcd')
+			res.stub!(:[]).with('Content-type').and_return('text/html; charset=utf-8')
+			@request.response_log(res).should == "# => 200 OK | text/html 4 bytes"
+		end
+
+		it "displays the log to stdout" do
+			RestClient.stub!(:log).and_return('stdout')
+			STDOUT.should_receive(:puts).with('xyz')
+			@request.display_log('xyz')
+		end
+
+		it "displays the log to stderr" do
+			RestClient.stub!(:log).and_return('stderr')
+			STDERR.should_receive(:puts).with('xyz')
+			@request.display_log('xyz')
+		end
+
+		it "append the log to the requested filename" do
+			RestClient.stub!(:log).and_return('/tmp/restclient.log')
+			f = mock('file handle')
+			File.should_receive(:open).with('/tmp/restclient.log', 'a').and_yield(f)
+			f.should_receive(:puts).with('xyz')
+			@request.display_log('xyz')
+		end
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rest-client
 version: !ruby/object:Gem::Version 
-  version: 0.6.2
+  version: "0.7"
 platform: ruby
 authors: 
 - Adam Wiggins
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-01 00:00:00 -07:00
+date: 2008-08-18 00:00:00 -07:00
 default_executable: 
 dependencies: []