cryx-rest-client 0.9.1 → 0.9.2

data/Rakefile

@@ -31,7 +31,7 @@ require 'rake/gempackagetask'
 require 'rake/rdoctask'
 require 'fileutils'
 
-version = "0.9"
+version = "0.9.2"
 name = "rest-client"
 
 spec = Gem::Specification.new do |s|

data/lib/restclient.rb

@@ -8,7 +8,6 @@ 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'
 
 

data/lib/restclient/request.rb

@@ -7,7 +7,7 @@ module RestClient
    #
 	class Request
 	  include Logging
-		attr_reader :method, :url, :payload, :headers, :cookies, :user, :password, :timeout, :open_timeout
+		attr_reader :method, :url, :payload, :headers, :cookies, :user, :password, :timeout, :open_timeout, :ssl
 
 		def self.execute(args)
 			new(args).execute
@@ -23,6 +23,7 @@ module RestClient
 			@password = args[:password]
 			@timeout = args[:timeout]
 			@open_timeout = args[:open_timeout]
+			@ssl = args[:ssl] || {}
 		end
 
 		def execute
@@ -95,7 +96,12 @@ module RestClient
 
 			net = net_http_class.new(uri.host, uri.port)
 			net.use_ssl = uri.is_a?(URI::HTTPS)
-			net.verify_mode = OpenSSL::SSL::VERIFY_NONE
+			if net.use_ssl?
+    		net.verify_mode = ssl[:verify_mode] || OpenSSL::SSL::VERIFY_NONE
+    		net.ca_file = ssl[:ca_file] if ssl[:ca_file]
+    		net.cert = ssl[:cert] if ssl[:cert]
+    		net.key = ssl[:key] if ssl[:key]
+  		end
 			net.read_timeout = @timeout if @timeout
 			net.open_timeout = @open_timeout if @open_timeout
 

data/lib/restclient/resource.rb

@@ -12,6 +12,18 @@ module RestClient
 	#   resource = RestClient::Resource.new('http://protected/resource', :user => 'user', :password => 'password')
 	#   resource.delete
 	#
+	# With SSL Client Certificates:
+	#
+	#   key = OpenSSL::PKey::RSA.new( File.open("mykey.pem").read, "mypassphrase or nil for interactive prompt" )
+	#   cert = OpenSSL::X509::Certificate.new( File.open("mycert.pem").read )
+	#   ca_file = "CAcert.pem"
+	#   resource = RestClient::Resource.new('https://protected/resource', :ssl => {:key => key, :cert => cert, :ca_file => ca_file, :verify_mode => OpenSSL::SSL::VERIFY_PEER})
+	#   resource.delete
+	# 
+	# or (without peer verification):
+	#   resource = RestClient::Resource.new('https://protected/resource', :ssl => {:key => key, :cert => cert})
+	#   resource.delete
+	# 
 	# With a timeout (seconds):
 	#
 	#   RestClient::Resource.new('http://slow', :timeout => 10)

data/lib/restclient/response.rb

@@ -9,15 +9,6 @@ module RestClient
 	  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 || "")
@@ -52,42 +43,5 @@ module RestClient
 				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/rest-client.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
     s.name = "rest-client"
-    s.version = "0.9.1"
+    s.version = "0.9.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"

data/spec/request_spec.rb

@@ -14,6 +14,7 @@ describe RestClient::Request do
 		Net::HTTP.stub!(:new).and_return(@net)
 		@net.stub!(:start).and_yield(@http)
 		@net.stub!(:use_ssl=)
+		@net.stub!(:use_ssl?)
 		@net.stub!(:verify_mode=)
 	end
 
@@ -135,6 +136,21 @@ describe RestClient::Request do
 		@request.transmit(@uri, 'req', 'payload')
 	end
 
+  it "uses the key, cert, ca_file and verify_mode provided by the user when SSL is used" do
+    @uri.stub!(:is_a?).with(URI::HTTPS).and_return(true)
+    ssl = {:ca_file => mock('ca_file'), :key => mock('key'), :cert => mock('cert'), :verify_mode => OpenSSL::SSL::VERIFY_PEER}
+		@net.should_receive(:use_ssl?).and_return(true)
+		@net.should_receive(:ca_file=).with(ssl[:ca_file])
+		@net.should_receive(:key=).with(ssl[:key])
+		@net.should_receive(:cert=).with(ssl[:cert])
+		@net.should_receive(:verify_mode=).with(ssl[:verify_mode])
+		@http.stub!(:request)
+		@request.stub!(:ssl).and_return(ssl)
+		@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)

data/spec/response_spec.rb

@@ -38,67 +38,6 @@ describe RestClient::Response do
 	it "can access the net http result directly" do
 		@response.net_http_res.should == @net_http_res
 	end  
-	
-	context "response cacheability" do
-    it "should not be cacheable if the headers do not contain freshness or validation information" do
-      @response.stub!(:headers).and_return({})
-      @response.should_not be_cacheable
-    end
-    it "should be cacheable if the headers include at least an etag (not empty)" do
-      @response.stub!(:headers).and_return({:etag => 'whatever'})
-      @response.should be_cacheable
-    end  
-    it "should be cacheable if the headers include at least the date and last-modified values (not empty)" do
-      @response.stub!(:headers).and_return(basic_headers.merge( {:last_modified => (Time.now-10).httpdate} ))
-      @response.should be_cacheable
-    end
-    it "should not be cacheable (last-modified not empty but date not valid)" do
-      @response.stub!(:headers).and_return( {:last_modified => (Time.now-10).httpdate} )
-      @response.should_not be_cacheable
-    end
-    it "should not be cacheable (date OK but last-modified empty)" do
-      @response.stub!(:headers).and_return( {:date => (Time.now-10).httpdate, :last_modified => nil} )
-      @response.should_not be_cacheable
-    end
-    it "should not be cacheable (date OK but expires empty)" do
-      @response.stub!(:headers).and_return( {:date => (Time.now-10).httpdate, :expires => nil} )
-      @response.should_not be_cacheable
-    end  
-    it "should not be cacheable (expires OK but date empty)" do
-      @response.stub!(:headers).and_return( {:date => nil, :expires => (Time.now+10).httpdate} )
-      @response.should_not be_cacheable
-    end
-  end
-  context "response freshness" do
-  	it "should not be fresh if there is no Date header" do
-      @response.stub!(:headers).and_return(basic_headers.merge( {:date => nil} ))
-      @response.should_not be_fresh
-    end
-    it "should be fresh if Expires is in the future" do
-      @response.stub!(:headers).and_return(basic_headers.merge({:expires => (Time.now+1).httpdate}))
-      @response.should be_fresh  
-    end
-    it "should not be fresh if Expires is in the past" do
-      @response.stub!(:headers).and_return(basic_headers.merge({:expires => (Time.now-1).httpdate}))
-      @response.should_not be_fresh
-    end
-    it "should not be fresh if its current age is greater than or equal to the max-age allowed" do
-      @response.stub!(:headers).and_return(basic_headers.merge({:date => (Time.now-10).httpdate, :cache_control => 'max-age=10'}))
-      @response.should_not be_fresh
-    end
-    it "should be fresh if its current age is lower than the max-age allowed" do
-      @response.stub!(:headers).and_return(basic_headers.merge({:date => (Time.now-10).httpdate, :cache_control => 'max-age=11'}))
-      @response.should be_fresh
-    end
-    it "should not be fresh if its current age is greater than the user defined max-age" do
-      @response.stub!(:headers).and_return(basic_headers.merge({:date => (Time.now-10).httpdate, :cache_control => 'max-age=11'}))
-      @response.should_not be_fresh(:cache_control => 'max-age=10')
-    end
-    it "should not be fresh even if the user defined max-age is greater than the response max-age" do
-      @response.stub!(:headers).and_return(basic_headers.merge({:date => (Time.now-10).httpdate, :cache_control => 'max-age=10'}))
-      @response.should_not be_fresh(:cache_control => 'max-age=11')
-    end
-  end
 
 	it "accepts nil strings and sets it to empty for the case of HEAD" do
 		RestClient::Response.new(nil, @net_http_res).should == ""

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cryx-rest-client
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors: 
 - Adam Wiggins
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-13 00:00:00 -08:00
+date: 2009-02-25 00:00:00 -08:00
 default_executable: 
 dependencies: []