adamwiggins-rest-client 0.9

data/README.rdoc

@@ -0,0 +1,121 @@
+= REST Client -- simple DSL for accessing REST resources
+
+A simple REST client for Ruby, inspired by the Sinatra's microframework style
+of specifying actions: get, put, post, delete.
+
+== Usage: Raw URL
+
+  require 'rest_client'
+
+  RestClient.get 'http://example.com/resource'
+  RestClient.get 'https://user:password@example.com/private/resource'
+
+  RestClient.post 'http://example.com/resource', :param1 => 'one', :nested => { :param2 => 'two' }
+
+  RestClient.delete 'http://example.com/resource'
+
+See RestClient module docs for details.
+
+== Usage: ActiveResource-Style
+
+  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.put File.read('pic.jpg'), :content_type => 'image/jpg'
+
+See RestClient::Resource module docs for details.
+
+== Usage: Resource Nesting
+
+  site = RestClient::Resource.new('http://example.com')
+  site['posts/1/comments'].post 'Good article.', :content_type => 'text/plain'
+
+See RestClient::Resource docs for details.
+
+== Shell
+
+The restclient shell command gives an IRB session with RestClient already loaded:
+
+  $ restclient
+  >> RestClient.get 'http://example.com'
+
+Specify a URL argument for get/post/put/delete on that resource:
+
+  $ restclient http://example.com
+  >> put '/resource', 'data'
+
+Add a user and password for authenticated resources:
+
+  $ restclient https://example.com user pass
+  >> delete '/private/resource'
+
+Create ~/.restclient for named sessions:
+
+  sinatra:
+    url: http://localhost:4567
+  rack:
+    url: http://localhost:9292
+  private_site:
+    url: http://example.com
+    username: user
+    password: pass
+
+Then invoke:
+
+  $ restclient private_site
+  
+Use as a one-off, curl-style:
+
+  $ restclient get http://example.com/resource > output_body
+
+  $ restclient put http://example.com/resource < input_body
+
+== Logging
+
+Write calls to a log filename (can also be "stdout" or "stderr"):
+
+  RestClient.log = '/tmp/restclient.log'
+
+Or set an environment variable to avoid modifying the code:
+
+  $ RESTCLIENT_LOG=stdout path/to/my/program
+
+Either produces logs like this:
+
+  RestClient.get "http://some/resource"
+  # => 200 OK | text/html 250 bytes
+  RestClient.put "http://some/resource", "payload"
+  # => 401 Unauthorized | application/xml 340 bytes
+
+Note that these logs are valid Ruby, so you can paste them into the restclient
+shell or a script to replay your sequence of rest calls.
+
+== Proxy
+
+All calls to RestClient, including Resources, will use the proxy specified by
+RestClient.proxy:
+
+  RestClient.proxy = "http://proxy.example.com/"
+  RestClient.get "http://some/resource"
+  # => response from some/resource as proxied through proxy.example.com
+
+Often the proxy url is set in an environment variable, so you can do this to
+use whatever proxy the system is configured to use:
+
+  RestClient.proxy = ENV['http_proxy']
+
+== 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
+
+Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
+
+http://rest-client.heroku.com
+
+http://github.com/adamwiggins/rest-client
+

data/Rakefile

@@ -0,0 +1,85 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+	t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+	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.9"
+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 Sinatra microframework 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.executables = ['restclient']
+	
+	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.rdoc')
+	t.rdoc_files.include('lib/restclient.rb')
+	t.rdoc_files.include('lib/restclient/*.rb')
+end
+
+CLEAN.include [ 'pkg', '*.gem', '.config' ]
+

data/bin/restclient

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__) + "/../lib"
+require 'restclient'
+
+require "yaml"
+
+def usage(why = nil)
+	puts "failed for reason: #{why}" if why
+	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 {}
+
+@url, @username, @password = if c = config[@url]
+	[c['url'], c['username'], c['password']]
+else
+	[@url, *ARGV]
+end
+
+usage("invalid url '#{@url}") unless @url =~ /^https?/
+usage("too few args") unless ARGV.size < 3
+
+def r
+	@r ||= RestClient::Resource.new(@url, @username, @password)
+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)
+	r[path].#{m}(*args, &b)
+end
+ end_eval
+end
+
+def method_missing(s, *args, &b)
+	super unless r.respond_to?(s)
+	begin
+		r.send(s, *args, &b)
+	rescue RestClient::RequestFailed => e
+		print STDERR, e.response.body
+		raise e
+	end
+end
+
+require 'irb'
+require 'irb/completion'
+
+if File.exists? ".irbrc"
+	ENV['IRBRC'] = ".irbrc"
+end
+
+if File.exists?(rcfile = "~/.restclientrc")
+	load(rcfile)
+end
+
+ARGV.clear
+
+IRB.start
+exit!

data/lib/restclient/exceptions.rb

@@ -0,0 +1,84 @@
+module RestClient
+	# This is the base RestClient exception class. Rescue it if you want to
+	# catch any exception that your request might raise
+	class Exception < RuntimeError
+		def message(default=nil)
+			self.class::ErrorMessage
+		end
+	end
+
+	# Base RestClient exception when there's a response available
+	class ExceptionWithResponse < Exception
+		attr_accessor :response
+
+		def initialize(response=nil)
+			@response = response
+		end
+
+		def http_code
+			@response.code.to_i if @response
+		end
+	end
+
+	# A redirect was encountered; caught by execute to retry with the new url.
+	class Redirect < Exception
+		ErrorMessage = "Redirect"
+
+		attr_accessor :url
+		def initialize(url)
+			@url = url
+		end
+	end
+
+	class NotModified < Exception
+		ErrorMessage = 'NotModified'
+	end
+
+	# Authorization is required to access the resource specified.
+	class Unauthorized < ExceptionWithResponse
+		ErrorMessage = 'Unauthorized'
+	end
+
+	# No resource was found at the given URL.
+	class ResourceNotFound < ExceptionWithResponse
+		ErrorMessage = 'Resource not found'
+	end
+
+	# The server broke the connection prior to the request completing.  Usually
+	# this means it crashed, or sometimes that your network connection was
+	# severed before it could complete.
+	class ServerBrokeConnection < Exception
+		ErrorMessage = 'Server broke connection'
+	end
+
+	# The server took too long to respond.
+	class RequestTimeout < Exception
+		ErrorMessage = 'Request timed out'
+	end
+
+	# The request failed, meaning the remote HTTP server returned a code other
+	# than success, unauthorized, or redirect.
+	#
+	# The exception message attempts to extract the error from the XML, using
+	# format returned by Rails: <errors><error>some message</error></errors>
+	#
+	# You can get the status code by e.http_code, or see anything about the
+	# response via e.response.  For example, the entire result body (which is
+	# probably an HTML error page) is e.response.body.
+	class RequestFailed < ExceptionWithResponse
+		def message
+			"HTTP status code #{http_code}"
+		end
+
+		def to_s
+			message
+		end
+	end
+end
+
+# backwards compatibility
+class RestClient::Request
+	Redirect = RestClient::Redirect
+	Unauthorized = RestClient::Unauthorized
+	RequestFailed = RestClient::RequestFailed
+end

data/lib/restclient/request.rb

@@ -0,0 +1,178 @@
+module RestClient
+	# This class is used internally by RestClient to send the request, but you can also
+	# access it internally if you'd like to use a method not directly supported by the
+	# main API.  For example:
+	#
+	#   RestClient::Request.execute(:method => :head, :url => 'http://example.com')
+   #
+	class Request
+		attr_reader :method, :url, :payload, :headers, :user, :password, :timeout
+
+		def self.execute(args)
+			new(args).execute
+		end
+
+		def initialize(args)
+			@method = args[:method] or raise ArgumentError, "must pass :method"
+			@url = args[:url] or raise ArgumentError, "must pass :url"
+			@headers = args[:headers] || {}
+			@payload = process_payload(args[:payload])
+			@user = args[:user]
+			@password = args[:password]
+			@timeout = args[:timeout]
+		end
+
+		def execute
+			execute_inner
+		rescue Redirect => e
+			@url = e.url
+			execute
+		end
+
+		def execute_inner
+			uri = parse_url_with_auth(url)
+			transmit uri, net_http_request_class(method).new(uri.request_uri, make_headers(headers)), payload
+		end
+
+		def make_headers(user_headers)
+			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
+		end
+
+		def net_http_request_class(method)
+			Net::HTTP.const_get(method.to_s.capitalize)
+		end
+
+		def parse_url(url)
+			url = "http://#{url}" unless url.match(/^http/)
+			URI.parse(url)
+		end
+
+		def parse_url_with_auth(url)
+			uri = parse_url(url)
+			@user = uri.user if uri.user
+			@password = uri.password if uri.password
+			uri
+		end
+
+		def process_payload(p=nil, parent_key=nil)
+			unless p.is_a?(Hash)
+				p
+			else
+				@headers[:content_type] ||= 'application/x-www-form-urlencoded'
+				p.keys.map do |k|
+					key = parent_key ? "#{parent_key}[#{k}]" : k
+					if p[k].is_a? Hash
+						process_payload(p[k], key)
+					else
+						value = URI.escape(p[k].to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+						"#{key}=#{value}"
+					end
+				end.join("&")
+			end
+		end
+
+		def transmit(uri, req, payload)
+			setup_credentials(req)
+
+			net = net_http_class.new(uri.host, uri.port)
+			net.use_ssl = uri.is_a?(URI::HTTPS)
+			net.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+			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
+					Response.new(string, res)
+				else
+					nil
+				end
+			end
+		rescue EOFError
+			raise RestClient::ServerBrokeConnection
+		rescue Timeout::Error
+			raise RestClient::RequestTimeout
+		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
+				decode res['content-encoding'], res.body
+			elsif %w(301 302 303).include? res.code
+				url = res.header['Location']
+
+				if url !~ /^http/
+					uri = URI.parse(@url)
+					uri.path = "/#{url}".squeeze('/')
+					url = uri.to_s
+				end
+
+				raise Redirect, url
+			elsif res.code == "304"
+				raise NotModified
+			elsif res.code == "401"
+				raise Unauthorized, res
+			elsif res.code == "404"
+				raise ResourceNotFound, res
+			else
+				raise RequestFailed, res
+			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) ? res.body.size : nil} 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_encoding => 'gzip, deflate' }
+		end
+	end
+end

data/lib/restclient/resource.rb

@@ -0,0 +1,138 @@
+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 => 'user', :password => 'password')
+	#   resource.delete
+	#
+	# With a timeout (seconds):
+	#
+	#   RestClient::Resource.new('http://slow', :timeout => 10)
+	#
+	# 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', :user => 'adam', :password => 'mypasswd')
+	#   site['posts/1/comments'].post 'Good article.', :content_type => 'text/plain'
+	#
+	class Resource
+		attr_reader :url, :options
+
+		def initialize(url, options={}, backwards_compatibility=nil)
+			@url = url
+			if options.class == Hash
+				@options = options
+			else # compatibility with previous versions
+				@options = { :user => options, :password => backwards_compatibility }
+			end
+		end
+
+		def get(additional_headers={})
+			Request.execute(options.merge(
+				:method => :get,
+				:url => url,
+				:headers => headers.merge(additional_headers)
+			))
+		end
+
+		def post(payload, additional_headers={})
+			Request.execute(options.merge(
+				:method => :post,
+				:url => url,
+				:payload => payload,
+				:headers => headers.merge(additional_headers)
+			))
+		end
+
+		def put(payload, additional_headers={})
+			Request.execute(options.merge(
+				:method => :put,
+				:url => url,
+				:payload => payload,
+				:headers => headers.merge(additional_headers)
+			))
+		end
+
+		def delete(additional_headers={})
+			Request.execute(options.merge(
+				:method => :delete,
+				:url => url,
+				:headers => headers.merge(additional_headers)
+			))
+		end
+
+		def to_s
+			url
+		end
+
+		def user
+			options[:user]
+		end
+
+		def password
+			options[:password]
+		end
+
+		def headers
+			options[:headers] || {}
+		end
+
+		def timeout
+			options[:timeout]
+		end
+
+		# Construct a subresource, preserving authentication.
+		#
+		# Example:
+		#
+		#   site = RestClient::Resource.new('http://example.com', 'adam', 'mypasswd')
+		#   site['posts/1/comments'].post 'Good article.', :content_type => 'text/plain'
+		#
+		# This is especially useful if you wish to define your site in one place and
+		# call it in multiple locations:
+		#
+		#   def orders
+		#     RestClient::Resource.new('http://example.com/orders', 'admin', 'mypasswd')
+		#   end
+		#
+		#   orders.get                     # GET http://example.com/orders
+		#   orders['1'].get                # GET http://example.com/orders/1
+		#   orders['1/items'].delete       # DELETE http://example.com/orders/1/items
+		#
+		# Nest resources as far as you want:
+		#
+		#   site = RestClient::Resource.new('http://example.com')
+		#   posts = site['posts']
+		#   first_post = posts['1']
+		#   comments = first_post['comments']
+		#   comments.post 'Hello', :content_type => 'text/plain'
+		#
+		def [](suburl)
+			self.class.new(concat_urls(url, suburl), options)
+		end
+
+		def concat_urls(url, suburl)   # :nodoc:
+			url = url.to_s
+			suburl = suburl.to_s
+			if url.slice(-1, 1) == '/' or suburl.slice(0, 1) == '/'
+				url + suburl
+			else
+				"#{url}/#{suburl}"
+			end
+		end
+	end
+end

data/lib/restclient/response.rb

@@ -0,0 +1,35 @@
+module RestClient
+	# The response from RestClient looks like a string, but is actually one of
+	# these.  99% of the time you're making a rest call all you care about is
+	# the body, but on the occassion you want to fetch the headers you can:
+	#
+	#   RestClient.get('http://example.com').headers[:content_type]
+	#
+	class Response < String
+		attr_reader :net_http_res
+
+		def initialize(string, net_http_res)
+			@net_http_res = net_http_res
+			super string
+		end
+
+		# HTTP status code, always 200 since RestClient throws exceptions for
+		# other codes.
+		def code
+			@code ||= @net_http_res.code.to_i
+		end
+
+		# A hash of the headers, beautified with symbols and underscores.
+		# e.g. "Content-type" will become :content_type.
+		def headers
+			@headers ||= self.class.beautify_headers(@net_http_res.to_hash)
+		end
+
+		def self.beautify_headers(headers)
+			headers.inject({}) do |out, (key, value)|
+				out[key.gsub(/-/, '_').to_sym] = value.first
+				out
+			end
+		end
+	end
+end

data/rest-client.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+    s.name = "rest-client"
+    s.version = "0.9"
+    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"
+    s.email = "adam@heroku.com"
+    s.rubyforge_project = "rest-client"
+    s.homepage = "http://rest-client.heroku.com/"
+    s.has_rdoc = true
+    s.platform = Gem::Platform::RUBY
+    s.files = %w(Rakefile README.rdoc rest-client.gemspec
+                 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
+                 spec/exceptions_spec.rb spec/resource_spec.rb spec/restclient_spec.rb
+                 bin/restclient)
+    s.executables = ['restclient']
+    s.require_path = "lib"
+end

data/spec/base.rb

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

data/spec/exceptions_spec.rb

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + '/base'
+
+describe RestClient::Exception do
+	it "sets the exception message to ErrorMessage" do
+		RestClient::ResourceNotFound.new.message.should == 'Resource not found'
+	end
+
+	it "contains exceptions in RestClient" do
+		RestClient::Unauthorized.new.should be_a_kind_of(RestClient::Exception)
+		RestClient::ServerBrokeConnection.new.should be_a_kind_of(RestClient::Exception)
+	end
+end
+
+describe RestClient::RequestFailed do
+	it "stores the http response on the exception" do
+		begin
+			raise RestClient::RequestFailed, :response
+		rescue RestClient::RequestFailed => e
+			e.response.should == :response
+		end
+	end
+
+	it "http_code convenience method for fetching the code as an integer" do
+		RestClient::RequestFailed.new(mock('res', :code => '502')).http_code.should == 502
+	end
+
+	it "shows the status code in the message" do
+		RestClient::RequestFailed.new(mock('res', :code => '502')).to_s.should match(/502/)
+	end
+end
+
+describe RestClient::ResourceNotFound do
+	it "also has the http response attached" do
+		begin
+			raise RestClient::ResourceNotFound, :response
+		rescue RestClient::ResourceNotFound => e
+			e.response.should == :response
+		end
+	end
+end
+
+describe "backwards compatibility" do
+	it "alias RestClient::Request::Redirect to RestClient::Redirect" do
+		RestClient::Request::Redirect.should == RestClient::Redirect
+	end
+
+	it "alias RestClient::Request::Unauthorized to RestClient::Unauthorized" do
+		RestClient::Request::Unauthorized.should == RestClient::Unauthorized
+	end
+
+	it "alias RestClient::Request::RequestFailed to RestClient::RequestFailed" do
+		RestClient::Request::RequestFailed.should == RestClient::RequestFailed
+	end
+end

data/spec/request_spec.rb

@@ -0,0 +1,296 @@
+require File.dirname(__FILE__) + '/base'
+
+describe RestClient::Request do
+	before do
+		@request = RestClient::Request.new(:method => :put, :url => 'http://some/resource', :payload => 'payload')
+
+		@uri = mock("uri")
+		@uri.stub!(:request_uri).and_return('/resource')
+		@uri.stub!(:host).and_return('some')
+		@uri.stub!(:port).and_return(80)
+
+		@net = mock("net::http base")
+		@http = mock("net::http connection")
+		Net::HTTP.stub!(:new).and_return(@net)
+		@net.stub!(:start).and_yield(@http)
+		@net.stub!(:use_ssl=)
+		@net.stub!(:verify_mode=)
+	end
+
+	it "requests xml mimetype" 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
+
+	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 "extracts the username and password when parsing http://user:password@example.com/" do
+		URI.stub!(:parse).and_return(mock('uri', :user => 'joe', :password => 'pass1'))
+		@request.parse_url_with_auth('http://joe:pass1@example.com/resource')
+		@request.user.should == 'joe'
+		@request.password.should == 'pass1'
+	end
+
+	it "doesn't overwrite user and password (which may have already been set by the Resource constructor) if there is no user/password in the url" do
+		URI.stub!(:parse).and_return(mock('uri', :user => nil, :password => nil))
+		@request = RestClient::Request.new(:method => 'get', :url => 'example.com', :user => 'beth', :password => 'pass2')
+		@request.parse_url_with_auth('http://example.com/resource')
+		@request.user.should == 'beth'
+		@request.password.should == 'pass2'
+	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
+
+	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 "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_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
+	end
+
+	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
+
+	it "uses SSL when the URI refers to a https address" do
+		@uri.stub!(:is_a?).with(URI::HTTPS).and_return(true)
+		@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 "sends nil payloads" do
+		@http.should_receive(:request).with('req', nil)
+		@request.should_receive(:process_result)
+		@request.stub!(:response_log)
+		@request.transmit(@uri, 'req', nil)
+	end
+
+	it "passes non-hash payloads straight through" do
+		@request.process_payload("x").should == "x"
+	end
+
+	it "converts a hash payload to urlencoded data" do
+		@request.process_payload(:a => 'b c+d').should == "a=b%20c%2Bd"
+	end
+
+	it "accepts nested hashes in payload" do
+		payload = @request.process_payload(:user => { :name => 'joe', :location => { :country => 'USA', :state => 'CA' }})
+		payload.should include('user[name]=joe')
+		payload.should include('user[location][country]=USA')
+		payload.should include('user[location][state]=CA')
+	end
+
+	it "set urlencoded content_type header on hash payloads" do
+		@request.process_payload(:a => 1)
+		@request.headers[:content_type].should == 'application/x-www-form-urlencoded'
+	end
+
+	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')
+		@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 "setup credentials when there's a user" 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 "catches EOFError and shows the more informative ServerBrokeConnection" do
+		@http.stub!(:request).and_raise(EOFError)
+		lambda { @request.transmit(@uri, 'req', nil) }.should raise_error(RestClient::ServerBrokeConnection)
+	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
+
+	it "raises a Redirect with the new location when the response is in the 30x range" do
+		res = mock('response', :code => '301', :header => { 'Location' => 'http://new/resource' })
+		lambda { @request.process_result(res) }.should raise_error(RestClient::Redirect) { |e| e.url.should == 'http://new/resource'}
+	end
+
+	it "handles redirects with relative paths" do
+		res = mock('response', :code => '301', :header => { 'Location' => 'index' })
+		lambda { @request.process_result(res) }.should raise_error(RestClient::Redirect) { |e| e.url.should == 'http://some/index' }
+	end
+
+	it "handles redirects with absolute paths" do
+		@request.instance_variable_set('@url', 'http://some/place/else')
+		res = mock('response', :code => '301', :header => { 'Location' => '/index' })
+		lambda { @request.process_result(res) }.should raise_error(RestClient::Redirect) { |e| e.url.should == 'http://some/index' }
+	end
+
+	it "raises Unauthorized when the response is 401" do
+		res = mock('response', :code => '401')
+		lambda { @request.process_result(res) }.should raise_error(RestClient::Unauthorized)
+	end
+
+	it "raises ResourceNotFound when the response is 404" do
+		res = mock('response', :code => '404')
+		lambda { @request.process_result(res) }.should raise_error(RestClient::ResourceNotFound)
+	end
+
+	it "raises RequestFailed otherwise" do
+		res = mock('response', :code => '500')
+		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"'
+	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
+	
+	it "set read_timeout" do
+		@request = RestClient::Request.new(:method => :put, :url => 'http://some/resource', :payload => 'payload', :timeout => 123)
+		@http.stub!(:request)
+		@request.stub!(:process_result)
+		@request.stub!(:response_log)
+		
+		@http.should_receive(:read_timeout=).with(123)
+		
+		@request.transmit(@uri, 'req', nil)
+	end
+end

data/spec/resource_spec.rb

@@ -0,0 +1,75 @@
+require File.dirname(__FILE__) + '/base'
+
+describe RestClient::Resource do
+	before do
+		@resource = RestClient::Resource.new('http://some/resource', :user => 'jane', :password => 'mypass', :headers => { 'X-Something' => '1'})
+	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', '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', '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 "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
+
+	it "concatinates urls, using no slash if the first url ends with a slash" do
+		@resource.concat_urls('http://example.com/', 'resource').should == 'http://example.com/resource'
+	end
+
+	it "concatinates urls, using no slash if the second url starts with a slash" do
+		@resource.concat_urls('http://example.com', '/resource').should == 'http://example.com/resource'
+	end
+
+	it "concatinates even non-string urls, :posts + 1 => 'posts/1'" do
+		@resource.concat_urls(:posts, 1).should == 'posts/1'
+	end
+
+	it "offers subresources via []" 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
+
+	it "prints its url with to_s" do
+		RestClient::Resource.new('x').to_s.should == 'x'
+	end
+end

data/spec/response_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/base'
+
+describe RestClient::Response do
+	before do
+		@net_http_res = mock('net http response')
+		@response = RestClient::Response.new('abc', @net_http_res)
+	end
+
+	it "behaves like string" do
+		@response.should == 'abc'
+	end
+
+	it "fetches the numeric response code" do
+		@net_http_res.should_receive(:code).and_return('200')
+		@response.code.should == 200
+	end
+
+	it "beautifies the headers by turning the keys to symbols" do
+		h = RestClient::Response.beautify_headers('content-type' => [ 'x' ])
+		h.keys.first.should == :content_type
+	end
+
+	it "beautifies the headers by turning the values to strings instead of one-element arrays" do
+		h = RestClient::Response.beautify_headers('x' => [ 'text/html' ] )
+		h.values.first.should == 'text/html'
+	end
+
+	it "fetches the headers" do
+		@net_http_res.should_receive(:to_hash).and_return('content-type' => [ 'text/html' ])
+		@response.headers.should == { :content_type => 'text/html' }
+	end
+
+	it "can access the net http result directly" do
+		@response.net_http_res.should == @net_http_res
+	end
+end

data/spec/restclient_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/base'
+
+describe RestClient do
+	describe "API" do
+		it "GET" do
+			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(: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(: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(:execute).with(:method => :delete, :url => 'http://some/resource', :headers => {})
+			RestClient.delete('http://some/resource')
+		end
+	end
+
+	describe "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
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: adamwiggins-rest-client
+version: !ruby/object:Gem::Version 
+  version: "0.9"
+platform: ruby
+authors: 
+- Adam Wiggins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-11 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: "A simple REST client for Ruby, inspired by the Sinatra microframework style of specifying actions: get, put, post, delete."
+email: adam@heroku.com
+executables: 
+- restclient
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README.rdoc
+- rest-client.gemspec
+- 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
+- spec/exceptions_spec.rb
+- spec/resource_spec.rb
+- spec/restclient_spec.rb
+- bin/restclient
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Simple REST client for Ruby, inspired by microframework syntax for specifying actions.
+test_files: []
+