rest-client 0.1

data/Rakefile

@@ -0,0 +1,82 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+	t.spec_files = FileList['spec/*_spec.rb']
+end
+
+desc "Print specdocs"
+Spec::Rake::SpecTask.new(:doc) do |t|
+	t.spec_opts = ["--format", "specdoc", "--dry-run"]
+	t.spec_files = FileList['spec/*_spec.rb']
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+	t.spec_files = FileList['spec/*_spec.rb']
+	t.rcov = true
+	t.rcov_opts = ['--exclude', 'examples']
+end
+
+task :default => :spec
+
+######################################################
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'fileutils'
+
+version = "0.1"
+name = "rest-client"
+
+spec = Gem::Specification.new do |s|
+	s.name = name
+	s.version = version
+	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 microframework (Camping, Sinatra...) style of specifying actions: get, put, post, delete."
+	s.author = "Adam Wiggins"
+	s.email = "adam@heroku.com"
+	s.homepage = "http://rest-client.heroku.com/"
+	s.rubyforge_project = "rest-client"
+
+	s.platform = Gem::Platform::RUBY
+	s.has_rdoc = true
+	
+	s.files = %w(Rakefile) + Dir.glob("{lib,spec}/**/*")
+	
+	s.require_path = "lib"
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+	p.need_tar = true if RUBY_PLATFORM !~ /mswin/
+end
+
+task :install => [ :package ] do
+	sh %{sudo gem install pkg/#{name}-#{version}.gem}
+end
+
+task :uninstall => [ :clean ] do
+	sh %{sudo gem uninstall #{name}}
+end
+
+Rake::TestTask.new do |t|
+	t.libs << "spec"
+	t.test_files = FileList['spec/*_spec.rb']
+	t.verbose = true
+end
+
+Rake::RDocTask.new do |t|
+	t.rdoc_dir = 'rdoc'
+	t.title    = "rest-client, fetch RESTful resources effortlessly"
+	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')
+end
+
+CLEAN.include [ 'pkg', '*.gem', '.config' ]
+

data/lib/rest_client.rb

@@ -0,0 +1,98 @@
+require 'uri'
+require 'net/http'
+
+# 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
+	end
+
+	def self.post(url, payload=nil, headers={})
+		Request.new(:post, url, payload, headers).execute
+	end
+
+	def self.put(url, payload=nil, headers={})
+		Request.new(:put, url, payload, headers).execute
+	end
+
+	def self.delete(url, headers={})
+		Request.new(:delete, url, nil, headers).execute
+	end
+
+	# Internal class used to build and execute the request.
+	class Request
+		attr_reader :method, :url, :payload, :headers
+
+		def initialize(method, url, payload, headers)
+			@method = method
+			@url = url
+			@payload = payload
+			@headers = headers
+		end
+
+		def execute
+			execute_inner
+		rescue Redirect => e
+			@url = e.message
+			execute
+		end
+
+		def execute_inner
+			uri = parse_url(url)
+			transmit uri, net_http_class(method).new(uri.path, 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]
+			end
+			final
+		end
+
+		def net_http_class(method)
+			Object.module_eval "Net::HTTP::#{method.to_s.capitalize}"
+		end
+
+		def parse_url(url)
+			url = "http://#{url}" unless url.match(/^http/)
+			URI.parse(url)
+		end
+
+		# A redirect was encountered; caught by execute to retry with the new url.
+		class Redirect < Exception; end
+
+		# Request failed with an unhandled http error code.
+		class RequestFailed < Exception; end
+
+		# Authorization is required to access the resource specified.
+		class Unauthorized < Exception; end
+
+		def transmit(uri, req, payload)
+			Net::HTTP.start(uri.host, uri.port) do |http|
+				process_result http.request(req, payload || "")
+			end
+		end
+
+		def process_result(res)
+			if %w(200 201 202).include? res.code
+				res.body
+			elsif %w(301 302 303).include? res.code
+				raise Redirect, res.header['Location']
+			elsif res.code == "401"
+				raise Unauthorized
+			else
+				raise RequestFailed, error_message(res)
+			end
+		end
+
+		def error_message(res)
+			"HTTP code #{res.code}: #{res.body}"
+		end
+
+		def default_headers
+			{ :accept => 'application/xml' }
+		end
+	end
+end

data/spec/base.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'spec'
+
+require File.dirname(__FILE__) + '/../lib/rest_client'

data/spec/rest_client_spec.rb

@@ -0,0 +1,114 @@
+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.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.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.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.delete('http://some/resource')
+		end
+	end
+
+	context RestClient::Request do
+		before do
+			@request = RestClient::Request.new(:put, 'http://some/resource', 'payload', {})
+
+			@uri = mock("uri")
+			@uri.stub!(:path).and_return('/resource')
+			@uri.stub!(:host).and_return('some')
+			@uri.stub!(:port).and_return(80)
+		end
+
+		it "requests xml mimetype" do
+			@request.default_headers[:accept].should == 'application/xml'
+		end
+
+		it "processes a successful result" do
+			res = mock("result")
+			res.stub!(:code).and_return("200")
+			res.stub!(:body).and_return('body')
+			@request.process_result(res).should == 'body'
+		end
+
+		it "parses a url into a URI object" do
+			URI.should_receive(:parse).with('http://example.com/resource')
+			@request.parse_url('http://example.com/resource')
+		end
+
+		it "adds http:// to the front of resources specified in the syntax example.com/resource" do
+			URI.should_receive(:parse).with('http://example.com/resource')
+			@request.parse_url('example.com/resource')
+		end
+
+		it "determines the Net::HTTP class to instantiate by the method name" do
+			@request.net_http_class(:put).should == Net::HTTP::Put
+		end
+
+		it "merges user headers with the default headers" do
+			@request.should_receive(:default_headers).and_return({ '1' => '2' })
+			@request.make_headers('3' => '4').should == { '1' => '2', '3' => '4' }
+		end
+
+		it "prefers the user header when the same header exists in the defaults" do
+			@request.should_receive(:default_headers).and_return({ '1' => '2' })
+			@request.make_headers('1' => '3').should == { '1' => '3' }
+		end
+
+		it "converts header symbols from :content_type to 'Content-type'" do
+			@request.should_receive(:default_headers).and_return({})
+			@request.make_headers(:content_type => 'abc').should == { 'Content-type' => 'abc' }
+		end
+
+		it "executes by constructing the Net::HTTP object, headers, and payload and calling transmit" do
+			@request.should_receive(:parse_url).with('http://some/resource').and_return(@uri)
+			klass = mock("net:http class")
+			@request.should_receive(:net_http_class).with(:put).and_return(klass)
+			klass.should_receive(:new).and_return('result')
+			@request.should_receive(:transmit).with(@uri, 'result', 'payload')
+			@request.execute_inner
+		end
+
+		it "transmits the request with Net::HTTP" do
+			http = mock("net::http connection")
+			Net::HTTP.should_receive(:start).and_yield(http)
+			http.should_receive(:request).with('req', 'payload')
+			@request.should_receive(:process_result)
+			@request.transmit(@uri, 'req', 'payload')
+		end
+
+		it "doesn't send nil payloads" do
+			http = mock("net::http connection")
+			Net::HTTP.should_receive(:start).and_yield(http)
+			http.should_receive(:request).with('req', '')
+			@request.should_receive(:process_result)
+			@request.transmit(@uri, 'req', nil)
+		end
+
+		it "execute calls execute_inner" do
+			@request.should_receive(:execute_inner)
+			@request.execute
+		end
+	end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+name: rest-client
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Adam Wiggins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-08 23:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: "A simple REST client for Ruby, inspired by the microframework (Camping, Sinatra...) style of specifying actions: get, put, post, delete."
+email: adam@heroku.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/rest_client.rb
+- spec/base.rb
+- spec/rest_client_spec.rb
+has_rdoc: true
+homepage: http://rest-client.heroku.com/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rest-client
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Simple REST client for Ruby, inspired by microframework syntax for specifying actions.
+test_files: []
+