entp-astrotrain 0.2.0

data/lib/vendor/rest-client/lib/rest_client.rb

@@ -0,0 +1,189 @@
+require 'uri'
+require 'net/https'
+
+require File.dirname(__FILE__) + '/rest_client/resource'
+require File.dirname(__FILE__) + '/rest_client/request_errors'
+require File.dirname(__FILE__) + '/rest_client/payload'
+require File.dirname(__FILE__) + '/rest_client/net_http_ext'
+
+# 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'
+#
+# 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={}, &b)
+		Request.execute(:method => :get,
+			:url => url,
+			:headers => headers, &b)
+	end
+
+	def self.post(url, payload, headers={}, &b)
+		Request.execute(:method => :post,
+			:url => url,
+			:payload => payload,
+			:headers => headers, &b)
+	end
+
+	def self.put(url, payload, headers={}, &b)
+		Request.execute(:method => :put,
+			:url => url,
+			:payload => payload,
+			:headers => headers, &b)
+	end
+
+	def self.delete(url, headers={}, &b)
+		Request.execute(:method => :delete,
+			:url => url,
+			:headers => headers, &b)
+	end
+
+	# Internal class used to build and execute the request.
+	class Request
+		attr_reader :method, :url, :headers, :user, :password
+
+		def self.execute(args, &b)
+			new(args).execute(&b)
+		end
+
+		def initialize(args)
+			@method = args[:method] or raise ArgumentError, "must pass :method"
+			@url = args[:url] or raise ArgumentError, "must pass :url"
+			@payload = Payload.generate(args[:payload] || '')
+			@headers = args[:headers] || {}
+			@user = args[:user]
+			@password = args[:password]
+		end
+
+		def execute(&b)
+			execute_inner(&b)
+		rescue Redirect => e
+			@url = e.url
+			execute(&b)
+		end
+
+		def execute_inner(&b)
+			uri = parse_url_with_auth(url)
+			transmit(uri, net_http_class(method).new(uri.request_uri, make_headers(headers)), payload, &b)
+		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)
+			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, &b)
+			setup_credentials(req)
+
+			net = Net::HTTP.new(uri.host, uri.port)
+			net.use_ssl = uri.is_a?(URI::HTTPS)
+
+			net.start do |http|
+				## Ok. I know this is weird but it's a hack for now
+				## this lets process_result determine if it should read the body
+				## into memory or not
+				process_result(http.request(req, payload || "", &b), &b)
+			end
+		rescue EOFError
+			raise RestClient::ServerBrokeConnection
+		rescue Timeout::Error
+			raise RestClient::RequestTimeout
+		ensure
+			payload.close
+		end
+
+		def setup_credentials(req)
+			req.basic_auth(user, password) if user
+		end
+
+		def process_result(res, &b)
+			if %w(200 201 202).include? res.code
+				return res.body unless b
+			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 == "401"
+				raise Unauthorized
+			elsif res.code == "404"
+				raise ResourceNotFound
+			else
+				raise RequestFailed, res
+			end
+		end
+		
+		def payload
+			@payload
+		end
+
+		def default_headers
+			@payload.headers.merge({ :accept => 'application/xml' })
+		end
+	end
+end

data/lib/vendor/rest-client/rest-client.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+    s.name = "rest-client"
+    s.version = "0.6.2"
+    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/request_errors.rb lib/resource.rb lib/rest_client.rb 
+                 spec/base.rb spec/request_errors_spec.rb spec/resource_spec.rb spec/rest_client_spec.rb
+                 bin/restclient)
+    s.executables = ['restclient']
+    s.require_path = "lib"
+end

data/lib/vendor/rest-client/spec/base.rb

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

data/lib/vendor/rest-client/spec/payload_spec.rb

@@ -0,0 +1,71 @@
+require File.dirname(__FILE__) + "/base"
+
+describe RestClient::Payload do
+	context "A regular Payload" do
+		it "should should default content-type to standard enctype" do
+			RestClient::Payload::UrlEncoded.new({}).headers['Content-Type'].
+				should == 'application/x-www-form-urlencoded'
+		end
+
+		it "should form properly encoded params" do
+			RestClient::Payload::UrlEncoded.new({:foo => 'bar'}).to_s.
+				should == "foo=bar"
+		end
+	end
+
+	context "A multipart Payload" do
+		it "should should default content-type to standard enctype" do
+			m = RestClient::Payload::Multipart.new({})
+			m.stub!(:boundary).and_return(123)
+			m.headers['Content-Type'].should == 'multipart/form-data; boundary="123"'
+		end
+
+		it "should form properly seperated multipart data" do
+			m = RestClient::Payload::Multipart.new({:foo => "bar", :bar => 'foo'})
+			m.to_s.should == <<-EOS
+--#{m.boundary}\r
+Content-Disposition: multipart/form-data; name="bar"\r
+\r
+foo\r
+--#{m.boundary}\r
+Content-Disposition: multipart/form-data; name="foo"\r
+\r
+bar\r
+--#{m.boundary}--\r
+EOS
+		end
+
+		it "should form properly seperated multipart data" do
+			f = File.new(File.dirname(__FILE__) + "/master_shake.jpg")
+			m = RestClient::Payload::Multipart.new({:foo => f})
+			m.to_s.should == <<-EOS
+--#{m.boundary}\r
+Content-Disposition: multipart/form-data; name="foo"; filename="./spec/master_shake.jpg"\r
+Content-Type: image/jpeg\r
+\r
+#{IO.read(f.path)}\r
+--#{m.boundary}--\r
+EOS
+		end
+	end
+
+	context "Payload generation" do
+		it "should recognize standard urlencoded params" do
+			RestClient::Payload.generate({"foo" => 'bar'}).should be_kind_of(RestClient::Payload::UrlEncoded)
+		end
+		
+		it "should recognize multipart params" do
+			f = File.new(File.dirname(__FILE__) + "/master_shake.jpg")
+
+			RestClient::Payload.generate({"foo" => f}).should be_kind_of(RestClient::Payload::Multipart)
+		end
+		
+		it "should be multipart if forced" do
+			RestClient::Payload.generate({"foo" => "bar", :multipart => true}).should be_kind_of(RestClient::Payload::Multipart)
+		end
+
+		it "should return data if no of the above" do
+		  RestClient::Payload.generate("data").should be_kind_of(RestClient::Payload::Base)
+		end
+	end
+end

data/lib/vendor/rest-client/spec/request_errors_spec.rb

@@ -0,0 +1,44 @@
+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 "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/lib/vendor/rest-client/spec/resource_spec.rb

@@ -0,0 +1,52 @@
+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
+
+	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
+end

data/lib/vendor/rest-client/spec/rest_client_spec.rb

@@ -0,0 +1,219 @@
+require File.dirname(__FILE__) + '/base'
+
+def generate_payload(v)
+	RestClient::Payload::Base.new(v)
+end
+
+describe RestClient do
+	context "public 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
+
+	context 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=)
+		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 "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_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_auth).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', be_kind_of(RestClient::Payload::Base))
+			@request.execute_inner
+		end
+
+		it "transmits the request with Net::HTTP" do
+			@http.should_receive(:request).with('req', be_kind_of(RestClient::Payload::Base))
+			@request.should_receive(:process_result)
+			@request.transmit(@uri, 'req', generate_payload('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.transmit(@uri, 'req', generate_payload('payload'))
+		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!(:user).and_return('joe')
+			@request.stub!(:password).and_return('mypass')
+			@request.should_receive(:setup_credentials).with('req')
+
+			@request.transmit(@uri, 'req', generate_payload(''))
+		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', generate_payload('')) }.
+				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
+	end
+end