DanaDanger-ruby_tubesday 0.1 → 0.2

data/lib/ruby_tubesday.rb

@@ -36,6 +36,8 @@ class RubyTubesday
 	# cache::           An instance of an ActiveSupport::Cache subclass to use
 	#                   as a content cache. You can set this to false to disable
 	#                   caching. Default is a new MemoryStore.
+	# force_cache::     An amount of time to cache requests, regardless of the
+	#                   request's cache control policy. Default is nil.
 	# params::          Parameters to include in every request. For example, if
 	#                   the service you're accessing requires an API key, you can
 	#                   set it here and it will be included in every request made
@@ -53,18 +55,21 @@ class RubyTubesday
 	#                   request.
 	# password::        Username to send using basic authentication with every
 	#                   request.
+	# headers::         Hash of HTTP headers to set for every request.
 	#
 	# All of these options can be overriden on a per-request basis.
 	def initialize(options = {})
 		@default_options = {
 			:raw           => false,
 			:cache         => ActiveSupport::Cache::MemoryStore.new,
+			:force_cache   => nil,
 			:params        => {},
 			:max_redirects => 5,
 			:ca_file       => (File.dirname(__FILE__) + '/../ca-bundle.crt'),
 			:verify_ssl    => true,
 			:username      => nil,
-			:password      => nil
+			:password      => nil,
+			:headers       => nil
 		}
 		@default_options = normalize_options(options)
 	end
@@ -129,17 +134,20 @@ protected
 		normalized_options = {
 			:raw           => options.delete(:raw),
 			:cache         => options.delete(:cache),
+			:force_cache   => options.delete(:force_cache),
 			:params        => options.delete(:params)        || @default_options[:params],
 	    :max_redirects => options.delete(:max_redirects) || @default_options[:max_redirects],
 	    :ca_file       => options.delete(:ca_file)       || @default_options[:ca_file],
 	    :verify_ssl    => options.delete(:verify_ssl),
 	    :username      => options.delete(:username)      || @default_options[:username],
-	    :password      => options.delete(:password)      || @default_options[:password]
+	    :password      => options.delete(:password)      || @default_options[:password],
+	    :headers       => options.delete(:headers)       || @default_options[:headers]
 	  }
 	  
-    normalized_options[:raw]        = @default_options[:raw]        if normalized_options[:raw].nil?
-    normalized_options[:cache]      = @default_options[:cache]      if normalized_options[:cache].nil?
-    normalized_options[:verify_ssl] = @default_options[:verify_ssl] if normalized_options[:verify_ssl].nil?
+    normalized_options[:raw]         = @default_options[:raw]         if normalized_options[:raw].nil?
+    normalized_options[:cache]       = @default_options[:cache]       if normalized_options[:cache].nil?
+    normalized_options[:force_cache] = @default_options[:force_cache] if normalized_options[:force_cache].nil?
+    normalized_options[:verify_ssl]  = @default_options[:verify_ssl]  if normalized_options[:verify_ssl].nil?
     
     unless options.empty?
       raise ArgumentError, "unrecognized keys: `#{options.keys.join('\', `')}'"
@@ -157,7 +165,7 @@ protected
 			response = Marshal.load(options[:cache].read(url.to_s))
 			response_age = Time.now - Time.parse(response['Last-Modified'] || response['Date'])
 			cache_policy = CachePolicy.new(response['Cache-Control'], cache_policy_options)
-			if cache_policy.fetch_action(response_age)
+			if (options[:force_cache] && (options[:force_cache] < response_age)) || cache_policy.fetch_action(response_age)
 				response = nil
 			end
 		end
@@ -166,6 +174,12 @@ protected
 		if response.nil?
 			redirects_left = options[:max_redirects]
 			
+			# Configure headers.
+			headers = options[:headers] || {}
+			headers.each do |key, value|
+			  request[key] = value
+		  end
+			
 			while !response.is_a?(Net::HTTPSuccess)
 				client = Net::HTTP.new(url.host, url.port)
 				
@@ -196,7 +210,7 @@ protected
 			# Write the response to the cache if we're allowed to.
 			if request.is_a?(Net::HTTP::Get) && options[:cache]
 				cache_policy = CachePolicy.new(response['Cache-Control'], cache_policy_options)
-				if cache_policy.may_cache?
+				if cache_policy.may_cache? || options[:force_cache]
 					options[:cache].write(url.to_s, Marshal.dump(response))
 				end
 			end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: DanaDanger-ruby_tubesday
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
 - DanaDanger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-13 00:00:00 -07:00
+date: 2008-10-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency