rest-client 0.7 → 0.8

data/Rakefile

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

data/bin/restclient

@@ -7,10 +7,18 @@ require "yaml"
 
 def usage(why = nil)
 	puts "failed for reason: #{why}" if why
-	puts "usage: restclient url|name [username] [password]"
+	puts "usage: restclient [get|put|post|delete] url|name [username] [password]"
+	puts "  The verb is optional, if you leave it off you'll get an interactive shell."
+	puts "  put and post both take the input body on stdin."
 	exit(1)
 end
 
+if %w(get put post delete).include? ARGV.first
+	@verb = ARGV.shift
+else
+	@verb = nil
+end
+
 @url = ARGV.shift || 'http://localhost:4567'
 
 config = YAML.load(File.read(ENV['HOME'] + "/.restclient")) rescue {}
@@ -22,7 +30,7 @@ else
 end
 
 usage("invalid url '#{@url}") unless @url =~ /^https?/
-usage("to few args") unless ARGV.size < 3
+usage("too few args") unless ARGV.size < 3
 
 def r
 	@r ||= RestClient::Resource.new(@url, @username, @password)
@@ -30,6 +38,20 @@ end
 
 r # force rc to load
 
+if @verb
+	begin
+		if %w(put post).include? @verb
+			puts r.send(@verb, STDIN.read)
+		else
+			puts r.send(@verb)
+		end
+		exit 0
+	rescue RestClient::Exception => e
+		puts e.response.body if e.respond_to? :response
+		raise
+	end
+end
+
 %w(get post put delete).each do |m|
  eval <<-end_eval
 def #{m}(path, *args, &b)
@@ -43,7 +65,7 @@ def method_missing(s, *args, &b)
 	begin
 		r.send(s, *args, &b)
 	rescue RestClient::RequestFailed => e
-		puts e.response.body
+		print STDERR, e.response.body
 		raise e
 	end
 end

data/lib/resource.rb

@@ -9,55 +9,78 @@ module RestClient
 	#
 	# With HTTP basic authentication:
 	#
-	#   resource = RestClient::Resource.new('http://protected/resource', 'user', 'pass')
+	#   resource = RestClient::Resource.new('http://protected/resource', :user => 'user', :password => 'password')
 	#   resource.delete
 	#
+	# 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', 'adam', 'mypasswd')
+	#   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, :user, :password
+		attr_reader :url, :options
 
-		def initialize(url, user=nil, password=nil)
+		def initialize(url, options={}, backwards_compatibility=nil)
 			@url = url
-			@user = user
-			@password = password
+			if options.class == Hash
+				@options = options
+			else # compatibility with previous versions
+				@options = { :user => options, :password => backwards_compatibility }
+			end
 		end
 
-		def get(headers={})
+		def get(additional_headers={})
 			Request.execute(:method => :get,
 				:url => url,
 				:user => user,
 				:password => password,
-				:headers => headers)
+				:headers => headers.merge(additional_headers))
 		end
 
-		def post(payload, headers={})
+		def post(payload, additional_headers={})
 			Request.execute(:method => :post,
 				:url => url,
 				:payload => payload,
 				:user => user,
 				:password => password,
-				:headers => headers)
+				:headers => headers.merge(additional_headers))
 		end
 
-		def put(payload, headers={})
+		def put(payload, additional_headers={})
 			Request.execute(:method => :put,
 				:url => url,
 				:payload => payload,
 				:user => user,
 				:password => password,
-				:headers => headers)
+				:headers => headers.merge(additional_headers))
 		end
 
-		def delete(headers={})
+		def delete(additional_headers={})
 			Request.execute(:method => :delete,
 				:url => url,
 				:user => user,
 				:password => password,
-				:headers => headers)
+				:headers => headers.merge(additional_headers))
+		end
+
+		def user
+			options[:user]
+		end
+
+		def password
+			options[:password]
+		end
+
+		def headers
+			options[:headers] || {}
 		end
 
 		# Construct a subresource, preserving authentication.
@@ -87,7 +110,7 @@ module RestClient
 		#   comments.post 'Hello', :content_type => 'text/plain'
 		#
 		def [](suburl)
-			self.class.new(concat_urls(url, suburl), user, password)
+			self.class.new(concat_urls(url, suburl), options)
 		end
 
 		def concat_urls(url, suburl)   # :nodoc:

data/lib/rest_client.rb

@@ -29,6 +29,14 @@ require File.dirname(__FILE__) + '/request_errors'
 #   # DELETE
 #   RestClient.delete 'http://example.com/resource'
 #
+# 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'
@@ -61,6 +69,10 @@ module RestClient
 			: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)
@@ -99,19 +111,26 @@ module RestClient
 
 		def execute_inner
 			uri = parse_url_with_auth(url)
-			transmit uri, net_http_class(method).new(uri.request_uri, make_headers(headers)), payload
+			transmit uri, net_http_request_class(method).new(uri.request_uri, make_headers(headers)), payload
 		end
 
 		def make_headers(user_headers)
-			final = {}
-			merged = default_headers.merge(user_headers)
-			merged.keys.each do |key|
-				final[key.to_s.gsub(/_/, '-').capitalize] = merged[key]
+			default_headers.merge(user_headers).inject({}) do |final, (key, value)|
+				final[key.to_s.gsub(/_/, '-').capitalize] = value.to_s
+				final
+			end
+		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
-			final
 		end
 
-		def net_http_class(method)
+		def net_http_request_class(method)
 			Net::HTTP.const_get(method.to_s.capitalize)
 		end
 
@@ -147,7 +166,7 @@ module RestClient
 		def transmit(uri, req, payload)
 			setup_credentials(req)
 
-			net = Net::HTTP.new(uri.host, uri.port)
+			net = net_http_class.new(uri.host, uri.port)
 			net.use_ssl = uri.is_a?(URI::HTTPS)
 
 			display_log request_log

data/spec/resource_spec.rb

@@ -2,33 +2,46 @@ require File.dirname(__FILE__) + '/base'
 
 describe RestClient::Resource do
 	before do
-		@resource = RestClient::Resource.new('http://some/resource', 'jane', 'mypass')
+		@resource = RestClient::Resource.new('http://some/resource', :user => 'jane', :password => 'mypass', :headers => { 'X-Something' => '1'})
 	end
 
-	it "GET" do
-		RestClient::Request.should_receive(:execute).with(:method => :get, :url => 'http://some/resource', :headers => {}, :user => 'jane', :password => 'mypass')
-		@resource.get
-	end
+	context "Resource delegation" do
+		it "GET" do
+			RestClient::Request.should_receive(:execute).with(:method => :get, :url => 'http://some/resource', :headers => { 'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
+			@resource.get
+		end
 
-	it "POST" do
-		RestClient::Request.should_receive(:execute).with(:method => :post, :url => 'http://some/resource', :payload => 'abc', :headers => { :content_type => 'image/jpg' }, :user => 'jane', :password => 'mypass')
-		@resource.post 'abc', :content_type => 'image/jpg'
-	end
+		it "POST" do
+			RestClient::Request.should_receive(:execute).with(:method => :post, :url => 'http://some/resource', :payload => 'abc', :headers => { :content_type => 'image/jpg', 'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
+			@resource.post 'abc', :content_type => 'image/jpg'
+		end
 
-	it "PUT" do
-		RestClient::Request.should_receive(:execute).with(:method => :put, :url => 'http://some/resource', :payload => 'abc', :headers => { :content_type => 'image/jpg' }, :user => 'jane', :password => 'mypass')
-		@resource.put 'abc', :content_type => 'image/jpg'
-	end
+		it "PUT" do
+			RestClient::Request.should_receive(:execute).with(:method => :put, :url => 'http://some/resource', :payload => 'abc', :headers => { :content_type => 'image/jpg', 'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
+			@resource.put 'abc', :content_type => 'image/jpg'
+		end
+
+		it "DELETE" do
+			RestClient::Request.should_receive(:execute).with(:method => :delete, :url => 'http://some/resource', :headers => { 'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
+			@resource.delete
+		end
 
-	it "DELETE" do
-		RestClient::Request.should_receive(:execute).with(:method => :delete, :url => 'http://some/resource', :headers => {}, :user => 'jane', :password => 'mypass')
-		@resource.delete
+		it "overrides resource headers" do
+			RestClient::Request.should_receive(:execute).with(:method => :get, :url => 'http://some/resource', :headers => { 'X-Something' => '2'}, :user => 'jane', :password => 'mypass')
+			@resource.get 'X-Something' => '2'
+		end
 	end
 
 	it "can instantiate with no user/password" do
 		@resource = RestClient::Resource.new('http://some/resource')
 	end
 
+	it "is backwards compatible with previous constructor" do
+		@resource = RestClient::Resource.new('http://some/resource', 'user', 'pass')
+		@resource.user.should == 'user'
+		@resource.password.should == 'pass'
+	end
+
 	it "concatinates urls, inserting a slash when it needs one" do
 		@resource.concat_urls('http://example.com', 'resource').should == 'http://example.com/resource'
 	end
@@ -49,4 +62,10 @@ describe RestClient::Resource do
 		parent = RestClient::Resource.new('http://example.com')
 		parent['posts'].url.should == 'http://example.com/posts'
 	end
+
+	it "transports options to subresources" do
+		parent = RestClient::Resource.new('http://example.com', :user => 'user', :password => 'password')
+		parent['posts'].user.should == 'user'
+		parent['posts'].password.should == 'password'
+	end
 end

data/spec/rest_client_spec.rb

@@ -112,7 +112,7 @@ describe RestClient do
 		end
 
 		it "determines the Net::HTTP class to instantiate by the method name" do
-			@request.net_http_class(:put).should == Net::HTTP::Put
+			@request.net_http_request_class(:put).should == Net::HTTP::Put
 		end
 
 		it "merges user headers with the default headers" do
@@ -130,10 +130,14 @@ describe RestClient do
 			@request.make_headers(:content_type => 'abc').should == { 'Content-type' => 'abc' }
 		end
 
+		it "converts header values to strings" do
+			@request.make_headers('A' => 1)['A'].should == '1'
+		end
+
 		it "executes by constructing the Net::HTTP object, headers, and payload and calling transmit" do
 			@request.should_receive(:parse_url_with_auth).with('http://some/resource').and_return(@uri)
 			klass = mock("net:http class")
-			@request.should_receive(:net_http_class).with(:put).and_return(klass)
+			@request.should_receive(:net_http_request_class).with(:put).and_return(klass)
 			klass.should_receive(:new).and_return('result')
 			@request.should_receive(:transmit).with(@uri, 'result', 'payload')
 			@request.execute_inner
@@ -257,6 +261,15 @@ describe RestClient do
 			lambda { @request.process_result(res) }.should raise_error(RestClient::RequestFailed)
 		end
 
+		it "creates a proxy class if a proxy url is given" do
+			RestClient.stub!(:proxy).and_return("http://example.com/")
+			@request.net_http_class.should include(Net::HTTP::ProxyDelta)
+		end
+
+		it "creates a non-proxy class if a proxy url is not given" do
+		  @request.net_http_class.should_not include(Net::HTTP::ProxyDelta)
+		end
+
 		it "logs a get request" do
 			RestClient::Request.new(:method => :get, :url => 'http://url').request_log.should ==
 			'RestClient.get "http://url"'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rest-client
 version: !ruby/object:Gem::Version 
-  version: "0.7"
+  version: "0.8"
 platform: ruby
 authors: 
 - Adam Wiggins
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-18 00:00:00 -07:00
+date: 2008-10-13 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -23,13 +23,13 @@ extra_rdoc_files: []
 
 files: 
 - Rakefile
-- lib/request_errors.rb
 - lib/resource.rb
 - lib/rest_client.rb
-- spec/base.rb
-- spec/request_errors_spec.rb
+- lib/request_errors.rb
 - spec/resource_spec.rb
+- spec/request_errors_spec.rb
 - spec/rest_client_spec.rb
+- spec/base.rb
 has_rdoc: true
 homepage: http://rest-client.heroku.com/
 post_install_message: