francois-rest-client 1.1.5

data/README.rdoc

@@ -0,0 +1,104 @@
+= 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'
+  
+== Multipart
+
+Yeah, that's right!  This does multipart sends for you!
+
+  RestClient.post '/data', :myfile => File.new("/path/to/image.jpg")
+
+This does two things for you:
+
+* Auto-detects that you have a File value sends it as multipart
+* Auto-detects the mime of the file and sets it in the HEAD of the payload for each entry
+
+If you are sending params that do not contain a File object but the payload needs to be multipart then:
+
+  RestClient.post '/data', :foo => 'bar', :multipart => true
+
+== Streaming downloads
+
+RestClient.get('http://some/resource/lotsofdata') do |res|
+  res.read_body do |chunk|
+    .. do something with chunk ..
+  end
+end
+
+See RestClient module docs for more 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', 'pass'
+  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
+  
+== Meta
+
+Written by Adam Wiggins (adam at heroku dot com)
+
+Major modifications by Blake Mizerany
+
+Patches contributed by: Chris Anderson, Greg Borenstein, Ardekantur, Pedro Belo, Rafael Souza, Rick Olson, and Aman Gupta
+
+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,57 @@
+require 'rake'
+
+require 'jeweler'
+
+Jeweler::Tasks.new do |s|
+	s.name = "rest-client"
+	s.description = "A simple REST client for Ruby, inspired by the Sinatra microframework style of specifying actions: get, put, post, delete."
+	s.summary = "Simple REST client for Ruby, inspired by microframework syntax for specifying actions."
+	s.author = "Adam Wiggins"
+	s.email = "adam@heroku.com"
+	s.homepage = "http://rest-client.heroku.com/"
+	s.rubyforge_project = "rest-client"
+	s.has_rdoc = true
+	s.files = FileList["[A-Z]*", "{bin,lib,spec}/**/*"]
+	s.executables = %w(restclient)
+end
+
+Jeweler::RubyforgeTasks.new
+
+############################
+
+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/rdoctask'
+
+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/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+1.1.5

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/rest_client.rb

@@ -0,0 +1,2 @@
+# This file exists for backward compatbility with require 'rest_client'
+require File.dirname(__FILE__) + '/restclient'

data/lib/restclient/exceptions.rb

@@ -0,0 +1,88 @@
+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
+
+		def http_body
+			RestClient::Request.decode(@response['content-encoding'], @response.body) 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 < ExceptionWithResponse
+		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/mixin/response.rb

@@ -0,0 +1,43 @@
+module RestClient
+	module Mixin
+		module Response
+			attr_reader :net_http_res
+
+			# 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
+
+			# Hash of cookies extracted from response headers
+			def cookies
+				@cookies ||= (self.headers[:set_cookie] || "").split('; ').inject({}) do |out, raw_c|
+					key, val = raw_c.split('=')
+					unless %w(expires domain path secure).member?(key)
+						out[key] = val
+					end
+					out
+				end
+			end
+
+			def self.included(receiver)
+				receiver.extend(RestClient::Mixin::Response::ClassMethods)
+			end
+
+			module ClassMethods
+				def beautify_headers(headers)
+					headers.inject({}) do |out, (key, value)|
+						out[key.gsub(/-/, '_').to_sym] = value.first
+					out
+					end
+				end
+			end
+		end
+	end
+end

data/lib/restclient/net_http_ext.rb

@@ -0,0 +1,21 @@
+#
+# Replace the request method in Net::HTTP to sniff the body type
+# and set the stream if appropriate
+#
+# Taken from:	
+# http://www.missiondata.com/blog/ruby/29/streaming-data-to-s3-with-ruby/
+
+module Net
+	class HTTP
+		alias __request__ request
+
+		def request(req, body=nil, &block)
+			if body != nil && body.respond_to?(:read)
+				req.body_stream = body
+				return __request__(req, nil, &block)
+			else
+				return __request__(req, body, &block)
+			end
+		end
+	end
+end

data/lib/restclient/payload.rb

@@ -0,0 +1,206 @@
+require "tempfile"
+require "stringio"
+
+module RestClient
+	module Payload
+		extend self
+
+		def generate(params)
+			if params.is_a?(String)
+				Base.new(params)
+			elsif params
+				if params.delete(:multipart) == true || has_file?(params)
+					Multipart.new(params)
+				else
+					UrlEncoded.new(params)
+				end
+			else
+				nil
+			end
+		end
+
+		def has_file?(params)
+			params.any? do |_, v|
+				case v
+				when Hash
+					has_file?(v)
+				else
+					v.respond_to?(:path) && v.respond_to?(:read)
+				end
+			end
+		end
+
+		class Base
+			def initialize(params)
+				build_stream(params)
+			end
+
+			def build_stream(params)
+				@stream = StringIO.new(params)
+				@stream.seek(0)
+			end
+
+			def read(bytes=nil)
+				@stream.read(bytes)
+			end
+			alias :to_s :read
+
+			def escape(v)
+				URI.escape(v.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+			end
+
+			def headers
+				{ 'Content-Length' => size.to_s }
+			end
+
+			def size
+				@stream.size
+			end
+			alias :length :size
+
+			def close
+				@stream.close
+			end
+
+			def inspect
+				to_s.inspect
+			end
+		end
+
+		class UrlEncoded < Base
+			def build_stream(params)
+				@stream = StringIO.new(params.map do |k,v| 
+					"#{escape(k)}=#{escape(v)}"
+				end.join("&"))
+				@stream.seek(0)
+			end
+
+			def headers
+				super.merge({ 'Content-Type' => 'application/x-www-form-urlencoded' })
+			end
+		end
+
+		class Multipart < Base
+			EOL = "\r\n"
+
+			def build_stream(params)
+				b = "--#{boundary}"
+
+				@stream = Tempfile.new("RESTClient.Stream.#{rand(1000)}")
+				@stream.write(b + EOL)
+				x = params.to_a
+				last_index = x.length - 1
+				x.each_with_index do |a, index|
+					k, v = *a
+					if v.respond_to?(:read) && v.respond_to?(:path)
+						create_file_field(@stream, k,v)
+					else
+						create_regular_field(@stream, k,v)
+					end
+					@stream.write(EOL + b)
+					@stream.write(EOL) unless last_index == index
+				end
+				@stream.write('--')
+				@stream.write(EOL)
+				@stream.seek(0)
+			end
+
+			def create_regular_field(s, k, v)
+				s.write("Content-Disposition: multipart/form-data; name=\"#{k}\"")
+				s.write(EOL)
+				s.write(EOL)
+				s.write(v)
+			end
+
+			def create_file_field(s, k, v)
+				begin
+					s.write("Content-Disposition: multipart/form-data; name=\"#{k}\"; filename=\"#{File.basename(v.path)}\"#{EOL}")
+					s.write("Content-Type: #{mime_for(v.path)}#{EOL}")
+					s.write(EOL)
+					while data = v.read(8124)
+						s.write(data)
+					end
+				ensure
+					v.close
+				end
+			end
+
+			def mime_for(path)
+				ext = File.extname(path)[1..-1]
+				MIME_TYPES[ext] || 'text/plain'
+			end
+
+			def boundary
+				@boundary ||= rand(1_000_000).to_s
+			end
+
+			def headers
+				super.merge({'Content-Type' => %Q{multipart/form-data; boundary="#{boundary}"}})
+			end
+
+			def close
+				@stream.close
+			end
+		end
+
+		# :stopdoc:
+		# From WEBrick.
+		MIME_TYPES = {
+			"ai"    => "application/postscript",
+			"asc"   => "text/plain",
+			"avi"   => "video/x-msvideo",
+			"bin"   => "application/octet-stream",
+			"bmp"   => "image/bmp",
+			"class" => "application/octet-stream",
+			"cer"   => "application/pkix-cert",
+			"crl"   => "application/pkix-crl",
+			"crt"   => "application/x-x509-ca-cert",
+			"css"   => "text/css",
+			"dms"   => "application/octet-stream",
+			"doc"   => "application/msword",
+			"dvi"   => "application/x-dvi",
+			"eps"   => "application/postscript",
+			"etx"   => "text/x-setext",
+			"exe"   => "application/octet-stream",
+			"gif"   => "image/gif",
+			"gz"   => "application/x-gzip",
+			"htm"   => "text/html",
+			"html"  => "text/html",
+			"jpe"   => "image/jpeg",
+			"jpeg"  => "image/jpeg",
+			"jpg"   => "image/jpeg",
+			"js"    => "text/javascript",
+			"lha"   => "application/octet-stream",
+			"lzh"   => "application/octet-stream",
+			"mov"   => "video/quicktime",
+			"mpe"   => "video/mpeg",
+			"mpeg"  => "video/mpeg",
+			"mpg"   => "video/mpeg",
+			"pbm"   => "image/x-portable-bitmap",
+			"pdf"   => "application/pdf",
+			"pgm"   => "image/x-portable-graymap",
+			"png"   => "image/png",
+			"pnm"   => "image/x-portable-anymap",
+			"ppm"   => "image/x-portable-pixmap",
+			"ppt"   => "application/vnd.ms-powerpoint",
+			"ps"    => "application/postscript",
+			"qt"    => "video/quicktime",
+			"ras"   => "image/x-cmu-raster",
+			"rb"    => "text/plain",
+			"rd"    => "text/plain",
+			"rtf"   => "application/rtf",
+			"sgm"   => "text/sgml",
+			"sgml"  => "text/sgml",
+			"tif"   => "image/tiff",
+			"tiff"  => "image/tiff",
+			"txt"   => "text/plain",
+			"xbm"   => "image/x-xbitmap",
+			"xls"   => "application/vnd.ms-excel",
+			"xml"   => "text/xml",
+			"xpm"   => "image/x-xpixmap",
+			"xwd"   => "image/x-xwindowdump",
+			"zip"   => "application/zip",
+		}
+		# :startdoc:
+	end
+end

data/lib/restclient/raw_response.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/mixin/response'
+
+module RestClient
+	# The response from RestClient on a raw request 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]
+	#
+	# In addition, if you do not use the response as a string, you can access
+	# a Tempfile object at res.file, which contains the path to the raw 
+	# downloaded request body.  
+	class RawResponse 
+		include RestClient::Mixin::Response
+
+		attr_reader :file
+
+		def initialize(tempfile, net_http_res)
+			@net_http_res = net_http_res
+			@file = tempfile
+		end
+
+		def to_s
+			@file.open
+			@file.read
+		end
+
+	end
+end