adamwiggins-rest-client 0.9 → 0.9.1

data/README.rdoc

@@ -21,7 +21,7 @@ See RestClient module docs for details.
   resource = RestClient::Resource.new 'http://example.com/resource'
   resource.get
 
-  private_resource = RestClient::Resource.new 'https://example.com/private/resource', :user => 'adam', :password => 'secret', :timeout => 20
+  private_resource = RestClient::Resource.new 'https://example.com/private/resource', :user => 'adam', :password => 'secret', :timeout => 20, :open_timeout => 5
   private_resource.put File.read('pic.jpg'), :content_type => 'image/jpg'
 
 See RestClient::Resource module docs for details.
@@ -105,13 +105,30 @@ use whatever proxy the system is configured to use:
 
   RestClient.proxy = ENV['http_proxy']
 
+== Cookies
+
+Request and Response objects know about HTTP cookies, and will automatically
+extract and set headers for them as needed:
+
+  response = RestClient.get 'http://example.com/action_which_sets_session_id'
+  response.cookies
+  # => {"_applicatioN_session_id" => "1234"}
+
+  response2 = RestClient.post(
+    'http://localhost:3000/',
+    {:param1 => "foo"},
+    {:cookies => {:session_id => "1234"}}
+  )
+  # ...response body
+
 == Meta
 
 Written by Adam Wiggins (adam at heroku dot com)
 
 Patches contributed by: Chris Anderson, Greg Borenstein, Ardekantur, Pedro
 Belo, Rafael Souza, Rick Olson, Aman Gupta, Blake Mizerany, Brian Donovan, Ivan
-Makfinsky, Marc-André Cournoyer, Coda Hale, and Tetsuo Watanabe
+Makfinsky, Marc-André Cournoyer, Coda Hale, Tetsuo Watanabe, Dusty Doris,
+Lennon Day-Reynolds, James Edward Gray II, and Cyril Rohr
 
 Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
 

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,91 @@
+require 'uri'
+require 'net/https'
+require 'zlib'
+require 'stringio'
+
+require File.dirname(__FILE__) + '/restclient/request'
+require File.dirname(__FILE__) + '/restclient/response'
+require File.dirname(__FILE__) + '/restclient/resource'
+require File.dirname(__FILE__) + '/restclient/exceptions'
+
+# 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
+end

data/lib/restclient/exceptions.rb

@@ -30,7 +30,7 @@ module RestClient
 		end
 	end
 
-	class NotModified < Exception
+	class NotModified < ExceptionWithResponse
 		ErrorMessage = 'NotModified'
 	end
 

data/lib/restclient/request.rb

@@ -6,7 +6,7 @@ module RestClient
 	#   RestClient::Request.execute(:method => :head, :url => 'http://example.com')
    #
 	class Request
-		attr_reader :method, :url, :payload, :headers, :user, :password, :timeout
+		attr_reader :method, :url, :payload, :headers, :cookies, :user, :password, :timeout, :open_timeout
 
 		def self.execute(args)
 			new(args).execute
@@ -16,10 +16,12 @@ module RestClient
 			@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 = process_payload(args[:payload])
 			@user = args[:user]
 			@password = args[:password]
 			@timeout = args[:timeout]
+			@open_timeout = args[:open_timeout]
 		end
 
 		def execute
@@ -35,6 +37,10 @@ module RestClient
 		end
 
 		def make_headers(user_headers)
+      unless @cookies.empty?
+        user_headers[:cookie] = @cookies.map {|key, val| "#{key.to_s}=#{val}" }.join('; ')
+      end
+
 			default_headers.merge(user_headers).inject({}) do |final, (key, value)|
 				final[key.to_s.gsub(/_/, '-').capitalize] = value.to_s
 				final
@@ -89,15 +95,17 @@ module RestClient
 			net = net_http_class.new(uri.host, uri.port)
 			net.use_ssl = uri.is_a?(URI::HTTPS)
 			net.verify_mode = OpenSSL::SSL::VERIFY_NONE
+			net.read_timeout = @timeout if @timeout
+			net.open_timeout = @open_timeout if @open_timeout
 
 			display_log request_log
 
 			net.start do |http|
-				http.read_timeout = @timeout if @timeout
 				res = http.request(req, payload)
 				display_log response_log(res)
 				string = process_result(res)
-				if string
+
+				if string or @method == :head
 					Response.new(string, res)
 				else
 					nil
@@ -114,7 +122,7 @@ module RestClient
 		end
 
 		def process_result(res)
-			if %w(200 201 202).include? res.code
+			if res.code =~ /\A2\d{2}\z/
 				decode res['content-encoding'], res.body
 			elsif %w(301 302 303).include? res.code
 				url = res.header['Location']
@@ -127,7 +135,7 @@ module RestClient
 
 				raise Redirect, url
 			elsif res.code == "304"
-				raise NotModified
+				raise NotModified, res
 			elsif res.code == "401"
 				raise Unauthorized, res
 			elsif res.code == "404"
@@ -138,7 +146,7 @@ module RestClient
 		end
 
 		def decode(content_encoding, body)
-			if content_encoding == 'gzip'
+			if content_encoding == 'gzip' and not body.empty?
 				Zlib::GzipReader.new(StringIO.new(body)).read
 			elsif content_encoding == 'deflate'
 				Zlib::Inflate.new.inflate(body)

data/lib/restclient/resource.rb

@@ -16,6 +16,10 @@ module RestClient
 	#
 	#   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:
 	#
@@ -94,6 +98,10 @@ module RestClient
 		def timeout
 			options[:timeout]
 		end
+		
+		def open_timeout
+		  options[:open_timeout]
+	  end
 
 		# Construct a subresource, preserving authentication.
 		#

data/lib/restclient/response.rb

@@ -10,7 +10,7 @@ module RestClient
 
 		def initialize(string, net_http_res)
 			@net_http_res = net_http_res
-			super string
+			super(string || "")
 		end
 
 		# HTTP status code, always 200 since RestClient throws exceptions for
@@ -25,6 +25,17 @@ module RestClient
 			@headers ||= self.class.beautify_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.beautify_headers(headers)
 			headers.inject({}) do |out, (key, value)|
 				out[key.gsub(/-/, '_').to_sym] = value.first

data/rest-client.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
     s.name = "rest-client"
-    s.version = "0.9"
+    s.version = "0.9.1"
     s.summary = "Simple REST client for Ruby, inspired by microframework syntax for specifying actions."
     s.description = "A simple REST client for Ruby, inspired by the Sinatra microframework style of specifying actions: get, put, post, delete."
     s.author = "Adam Wiggins"
@@ -10,6 +10,7 @@ Gem::Specification.new do |s|
     s.has_rdoc = true
     s.platform = Gem::Platform::RUBY
     s.files = %w(Rakefile README.rdoc rest-client.gemspec
+                 lib/rest_client.rb lib/restclient.rb
                  lib/restclient/request.rb lib/restclient/response.rb
                  lib/restclient/exceptions.rb lib/restclient/resource.rb
                  spec/base.rb spec/request_spec.rb spec/response_spec.rb

data/spec/request_spec.rb

@@ -28,18 +28,32 @@ describe RestClient::Request do
 	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 "ingores gzip for empty bodies" do
+		@request.decode('gzip', '').should be_empty
+	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
+  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
+
+  it "doesn't classify successful requests as failed" do
+    203.upto(206) do |code|
+      res = mock("result")
+      res.stub!(:code).and_return(code.to_s)
+      res.stub!(:body).and_return("")
+      res.stub!(:[]).with('content-encoding').and_return(nil)
+      @request.process_result(res).should be_empty
+    end
+  end
 
 	it "parses a url into a URI object" do
 		URI.should_receive(:parse).with('http://example.com/resource')
@@ -66,6 +80,13 @@ describe RestClient::Request do
 		@request.password.should == 'pass2'
 	end
 
+  it "correctly formats cookies provided to the constructor" do
+    URI.stub!(:parse).and_return(mock('uri', :user => nil, :password => nil))
+    @request = RestClient::Request.new(:method => 'get', :url => 'example.com', :cookies => {:session_id => '1' })
+    @request.should_receive(:default_headers).and_return({'foo' => 'bar'})
+    headers = @request.make_headers({}).should == { 'Foo' => 'bar', 'Cookie' => 'session_id=1'}
+  end
+
 	it "determines the Net::HTTP class to instantiate by the method name" do
 		@request.net_http_request_class(:put).should == Net::HTTP::Put
 	end
@@ -289,7 +310,18 @@ describe RestClient::Request do
 		@request.stub!(:process_result)
 		@request.stub!(:response_log)
 		
-		@http.should_receive(:read_timeout=).with(123)
+		@net.should_receive(:read_timeout=).with(123)
+		
+		@request.transmit(@uri, 'req', nil)
+	end
+	
+	it "set open_timeout" do
+		@request = RestClient::Request.new(:method => :put, :url => 'http://some/resource', :payload => 'payload', :open_timeout => 123)
+		@http.stub!(:request)
+		@request.stub!(:process_result)
+		@request.stub!(:response_log)
+		
+		@net.should_receive(:open_timeout=).with(123)
 		
 		@request.transmit(@uri, 'req', nil)
 	end

data/spec/response_spec.rb

@@ -30,7 +30,16 @@ describe RestClient::Response do
 		@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
+
+	it "accepts nil strings and sets it to empty for the case of HEAD" do
+		RestClient::Response.new(nil, @net_http_res).should == ""
+	end
 end

data/spec/restclient_spec.rb

@@ -21,6 +21,11 @@ describe RestClient do
 			RestClient::Request.should_receive(:execute).with(:method => :delete, :url => 'http://some/resource', :headers => {})
 			RestClient.delete('http://some/resource')
 		end
+
+		it "HEAD" do
+			RestClient::Request.should_receive(:execute).with(:method => :head, :url => 'http://some/resource', :headers => {})
+			RestClient.head('http://some/resource')
+		end
 	end
 
 	describe "logging" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: adamwiggins-rest-client
 version: !ruby/object:Gem::Version 
-  version: "0.9"
+  version: 0.9.1
 platform: ruby
 authors: 
 - Adam Wiggins
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-11 00:00:00 -08:00
+date: 2009-02-13 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -25,6 +25,8 @@ files:
 - Rakefile
 - README.rdoc
 - rest-client.gemspec
+- lib/rest_client.rb
+- lib/restclient.rb
 - lib/restclient/request.rb
 - lib/restclient/response.rb
 - lib/restclient/exceptions.rb