cryx-rest-client 0.9.1

data/lib/restclient/resource.rb

@@ -0,0 +1,146 @@
+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)
+	#
+	# With an open timeout (seconds):
+	#
+	#   RestClient::Resource.new('http://behindfirewall', :open_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
+		
+		def open_timeout
+		  options[:open_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,93 @@
+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
+	  include Logging
+		attr_reader :net_http_res
+    
+    # the headers that makes a response cacheable
+    REQUIRED_HEADERS = [
+        [:date, :last_modified], [:date, :expires_value], [:date, :cache_control], [:etag]
+      ].freeze 
+      
+    REGEXP = {
+      :max_age => /max-age\s?=\s?(\d+)/
+    }.freeze
+    
+		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
+
+    # 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.beautify_headers(headers)
+			headers.inject({}) do |out, (key, value)|
+				out[key.gsub(/-/, '_').to_sym] = value.first
+				out
+			end
+		end
+
+    # Checks if the response is still fresh by comparing its current age to the max allowed age or the expires value.
+    # http://tools.ietf.org/html/rfc2616#section-13.2.3
+    def fresh?(options = {})
+      date_value              = Time.parse(headers[:date]) rescue nil
+      return false if date_value.nil?
+      local_response_time     = headers[:local_response_time] || date_value
+      local_request_time      = headers[:local_request_time] || date_value
+      age_value               = headers[:age].to_i rescue 0
+      expires_value           = Time.parse(headers[:expires]) rescue nil
+      max_age_value           = headers[:cache_control].scan(REGEXP[:max_age]).flatten[0].to_i rescue nil
+      user_max_age            = options[:cache_control].scan(REGEXP[:max_age]).flatten[0].to_i rescue nil
+      # age calculation
+      apparent_age            = [0, local_response_time - date_value].max
+      corrected_received_age  = [apparent_age, age_value].max
+      response_delay          = local_response_time - local_request_time;
+      corrected_initial_age   = corrected_received_age + response_delay;
+      resident_time           = Time.now - local_response_time;
+      current_age             = corrected_initial_age + resident_time;
+      max_age = max_age_value ? (user_max_age ? [max_age_value, user_max_age].min : max_age_value) : (user_max_age ? user_max_age : nil)
+      if max_age then current_age < max_age
+      elsif expires_value then current_age < (expires_value - date_value)        
+      else  false;  end
+    end
+
+    # Checks if the response is cacheable by comparing its headers to the set of headers that make a response cacheable.
+    # See the REQUIRED_HEADERS constant for more information
+    def cacheable?
+      REQUIRED_HEADERS.each do |required_headers|
+        available_headers = headers.keys & required_headers
+        has_required_headers = available_headers.length == required_headers.length
+        required_headers_are_not_empty = !headers.values_at(*available_headers).map{|value| value.nil? || value.empty?}.include?(true)
+        return true if has_required_headers && required_headers_are_not_empty
+      end
+      display_log "# [cache] the response is not cacheable"
+      false
+    end
+	end
+end

data/lib/restclient.rb

@@ -0,0 +1,95 @@
+require 'uri'
+require 'net/https'
+require 'zlib'
+require 'stringio'
+require 'time'
+
+require File.dirname(__FILE__) + '/restclient/logging'
+require File.dirname(__FILE__) + '/restclient/request'
+require File.dirname(__FILE__) + '/restclient/response'
+require File.dirname(__FILE__) + '/restclient/resource'
+require File.dirname(__FILE__) + '/restclient/cacheable_resource'
+require File.dirname(__FILE__) + '/restclient/exceptions'
+
+
+# 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'
+#
+#   # retreive the response http code and headers
+#   res = RestClient.get 'http://example.com/some.jpg'
+#   res.code                    # => 200
+#   res.headers[:content_type]  # => 'image/jpg'
+#
+#   # HEAD
+#   RestClient.head('http://example.com').headers
+#
+# To use with a proxy, just set RestClient.proxy to the proper http proxy:
+#
+#   RestClient.proxy = "http://proxy.example.com/"
+#
+# Or inherit the proxy from the environment:
+#
+#   RestClient.proxy = ENV['http_proxy']
+#
+# 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={})
+		Request.execute(:method => :get, :url => url, :headers => headers)
+	end
+
+	def self.post(url, payload, headers={})
+		Request.execute(:method => :post, :url => url, :payload => payload, :headers => headers)
+	end
+
+	def self.put(url, payload, headers={})
+		Request.execute(:method => :put, :url => url, :payload => payload, :headers => headers)
+	end
+
+	def self.delete(url, headers={})
+		Request.execute(:method => :delete, :url => url, :headers => headers)
+	end
+
+	def self.head(url, headers={})
+		Request.execute(:method => :head, :url => url, :headers => headers)
+	end
+
+	class << self
+		attr_accessor :proxy
+	end
+
+	# Print log of RestClient calls.  Value can be stdout, stderr, or a filename.
+	# You can also configure logging by the environment variable RESTCLIENT_LOG.
+	def self.log=(log)
+		@@log = log
+	end
+
+	def self.log    # :nodoc:
+		return ENV['RESTCLIENT_LOG'] if ENV['RESTCLIENT_LOG']
+		return @@log if defined? @@log
+		nil
+	end
+end

data/rest-client.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+    s.name = "rest-client"
+    s.version = "0.9.1"
+    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/rest_client.rb lib/restclient.rb
+                 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,12 @@
+require 'rubygems'
+require 'spec'
+
+require File.dirname(__FILE__) + '/../lib/restclient'
+
+def cacheable_headers 
+  {:etag => '9d265df2cff9bd59703e518d50efcf99457f2085'}
+end
+
+def basic_headers
+  {:date => Time.now.httpdate}
+end

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