rest-client 0.1 → 0.2

data/Rakefile

@@ -30,7 +30,7 @@ require 'rake/gempackagetask'
 require 'rake/rdoctask'
 require 'fileutils'
 
-version = "0.1"
+version = "0.2"
 name = "rest-client"
 
 spec = Gem::Specification.new do |s|
@@ -75,7 +75,7 @@ Rake::RDocTask.new do |t|
 	t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
 	t.options << '--charset' << 'utf-8'
 	t.rdoc_files.include('README')
-	t.rdoc_files.include('lib/rest_client.rb')
+	t.rdoc_files.include('lib/*.rb')
 end
 
 CLEAN.include [ 'pkg', '*.gem', '.config' ]

data/lib/resource.rb

@@ -0,0 +1,58 @@
+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', 'pass')
+	#   resource.delete
+	#
+	class Resource
+		attr_reader :url, :user, :password
+
+		def initialize(url, user=nil, password=nil)
+			@url = url
+			@user = user
+			@password = password
+		end
+
+		def get(headers={})
+			Request.execute(:method => :get,
+				:url => url,
+				:user => user,
+				:password => password,
+				:headers => headers)
+		end
+
+		def post(payload, headers={})
+			Request.execute(:method => :post,
+				:url => url,
+				:payload => payload,
+				:user => user,
+				:password => password,
+				:headers => headers)
+		end
+
+		def put(payload, headers={})
+			Request.execute(:method => :put,
+				:url => url,
+				:payload => payload,
+				:user => user,
+				:password => password,
+				:headers => headers)
+		end
+
+		def delete(headers={})
+			Request.execute(:method => :delete,
+				:url => url,
+				:user => user,
+				:password => password,
+				:headers => headers)
+		end
+	end
+end

data/lib/rest_client.rb

@@ -1,33 +1,51 @@
 require 'uri'
 require 'net/http'
 
+require File.dirname(__FILE__) + '/resource'
+
 # This module's static methods are the entry point for using the REST client.
 module RestClient
 	def self.get(url, headers={})
-		Request.new(:get, url, nil, headers).execute
+		Request.execute(:method => :get,
+			:url => url,
+			:headers => headers)
 	end
 
-	def self.post(url, payload=nil, headers={})
-		Request.new(:post, url, payload, headers).execute
+	def self.post(url, payload, headers={})
+		Request.execute(:method => :post,
+			:url => url,
+			:payload => payload,
+			:headers => headers)
 	end
 
-	def self.put(url, payload=nil, headers={})
-		Request.new(:put, url, payload, headers).execute
+	def self.put(url, payload, headers={})
+		Request.execute(:method => :put,
+			:url => url,
+			:payload => payload,
+			:headers => headers)
 	end
 
 	def self.delete(url, headers={})
-		Request.new(:delete, url, nil, headers).execute
+		Request.execute(:method => :delete,
+			:url => url,
+			:headers => headers)
 	end
 
 	# Internal class used to build and execute the request.
 	class Request
-		attr_reader :method, :url, :payload, :headers
+		attr_reader :method, :url, :payload, :headers, :user, :password
+
+		def self.execute(args)
+			new(args).execute
+		end
 
-		def initialize(method, url, payload, headers)
-			@method = method
-			@url = url
-			@payload = payload
-			@headers = headers
+		def initialize(args)
+			@method = args[:method] or raise ArgumentError, "must pass :method"
+			@url = args[:url] or raise ArgumentError, "must pass :url"
+			@payload = args[:payload]
+			@headers = args[:headers] || {}
+			@user = args[:user]
+			@password = args[:password]
 		end
 
 		def execute
@@ -70,11 +88,17 @@ module RestClient
 		class Unauthorized < Exception; end
 
 		def transmit(uri, req, payload)
+			setup_credentials(req)
+
 			Net::HTTP.start(uri.host, uri.port) do |http|
 				process_result http.request(req, payload || "")
 			end
 		end
 
+		def setup_credentials(req)
+			req.basic_auth(user, password) if user
+		end
+
 		def process_result(res)
 			if %w(200 201 202).include? res.code
 				res.body

data/spec/resource_spec.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/base'
+
+describe RestClient::Resource do
+	before do
+		@resource = RestClient::Resource.new('http://some/resource', 'jane', 'mypass')
+	end
+
+	it "GET" do
+		RestClient::Request.should_receive(:execute).with(:method => :get, :url => 'http://some/resource', :headers => {}, :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 "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 "DELETE" do
+		RestClient::Request.should_receive(:execute).with(:method => :delete, :url => 'http://some/resource', :headers => {}, :user => 'jane', :password => 'mypass')
+		@resource.delete
+	end
+
+	it "can instantiate with no user/password" do
+		@resource = RestClient::Resource.new('http://some/resource')
+	end
+end

data/spec/rest_client_spec.rb

@@ -2,38 +2,30 @@ require File.dirname(__FILE__) + '/base'
 
 describe RestClient do
 	context "public API" do
-		before do
-			@request = mock("restclient request")
-		end
-
 		it "GET" do
-			RestClient::Request.should_receive(:new).with(:get, 'http://some/resource', nil, {}).and_return(@request)
-			@request.should_receive(:execute)
+			RestClient::Request.should_receive(:execute).with(:method => :get, :url => 'http://some/resource', :headers => {})
 			RestClient.get('http://some/resource')
 		end
 
 		it "POST" do
-			RestClient::Request.should_receive(:new).with(:post, 'http://some/resource', 'payload', {}).and_return(@request)
-			@request.should_receive(:execute)
+			RestClient::Request.should_receive(:execute).with(:method => :post, :url => 'http://some/resource', :payload => 'payload', :headers => {})
 			RestClient.post('http://some/resource', 'payload')
 		end
 
 		it "PUT" do
-			RestClient::Request.should_receive(:new).with(:put, 'http://some/resource', 'payload', {}).and_return(@request)
-			@request.should_receive(:execute)
+			RestClient::Request.should_receive(:execute).with(:method => :put, :url => 'http://some/resource', :payload => 'payload', :headers => {})
 			RestClient.put('http://some/resource', 'payload')
 		end
 
 		it "DELETE" do
-			RestClient::Request.should_receive(:new).with(:delete, 'http://some/resource', nil, {}).and_return(@request)
-			@request.should_receive(:execute)
+			RestClient::Request.should_receive(:execute).with(:method => :delete, :url => 'http://some/resource', :headers => {})
 			RestClient.delete('http://some/resource')
 		end
 	end
 
 	context RestClient::Request do
 		before do
-			@request = RestClient::Request.new(:put, 'http://some/resource', 'payload', {})
+			@request = RestClient::Request.new(:method => :put, :url => 'http://some/resource', :payload => 'payload')
 
 			@uri = mock("uri")
 			@uri.stub!(:path).and_return('/resource')
@@ -106,9 +98,44 @@ describe RestClient do
 			@request.transmit(@uri, 'req', nil)
 		end
 
+		it "sets up the credentials prior to the request" do
+			http = mock("net::http connection")
+			Net::HTTP.should_receive(:start).and_yield(http)
+			http.stub!(:request)
+			@request.stub!(:process_result)
+
+			@request.stub!(:user).and_return('joe')
+			@request.stub!(:password).and_return('mypass')
+			@request.should_receive(:setup_credentials).with('req')
+
+			@request.transmit(@uri, 'req', nil)
+		end
+
+		it "does not attempt to send any credentials if user is nil" do
+			@request.stub!(:user).and_return(nil)
+			req = mock("request")
+			req.should_not_receive(:basic_auth)
+			@request.setup_credentials(req)
+		end
+
+		it "does not attempt to send any credentials if user is nil" do
+			@request.stub!(:user).and_return('joe')
+			@request.stub!(:password).and_return('mypass')
+			req = mock("request")
+			req.should_receive(:basic_auth).with('joe', 'mypass')
+			@request.setup_credentials(req)
+		end
+
 		it "execute calls execute_inner" do
 			@request.should_receive(:execute_inner)
 			@request.execute
 		end
+
+		it "class method execute wraps constructor" do
+			req = mock("rest request")
+			RestClient::Request.should_receive(:new).with(1 => 2).and_return(req)
+			req.should_receive(:execute)
+			RestClient::Request.execute(1 => 2)
+		end
 	end
 end

metadata

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