Allow write_options to be specified for FaradayMiddleware::Caching

lib/faraday_middleware/response/caching.rb

@@ -27,6 +27,9 @@ class Caching < Faraday::Middleware
     #           :ignore_params - String name or Array names of query params
     #                            that should be ignored when forming the cache
     #                            key (default: []).
+    #           :write_options - Hash of settings that should be passed as the third
+    #                            options parameter to the cache's #write method. If not
+    #                            specified, no options parameter will be passed.
     #
     # Yields if no cache is given. The block should return a cache object.
     def initialize(app, cache = nil, options = {})
@@ -48,7 +51,11 @@ def call(env)
             response = @app.call(env)
 
             if CACHEABLE_STATUS_CODES.include?(response.status)
-              cache.write(key, response)
+              if @options[:write_options]
+                cache.write(key, response, @options[:write_options])
+              else
+                cache.write(key, response)
+              end
             end
           end
           finalize_response(response, env)
@@ -81,7 +88,11 @@ def cache_on_complete(env)
         # response.status is nil at this point, any checks need to be done inside on_complete block
         @app.call(env).on_complete do |response_env|
           if CACHEABLE_STATUS_CODES.include?(response_env.status)
-            cache.write(key, response_env.response)
+            if @options[:write_options]
+              cache.write(key, response_env.response, @options[:write_options])
+            else
+              cache.write(key, response_env.response)
+            end
           end
           response_env
         end

spec/unit/caching_spec.rb

@@ -78,14 +78,34 @@
     end
   end
 
+  context ":write_options" do
+    let(:options) { {:write_options => {:expires_in => 9000 } } }
+
+    it "passes on the options when writing to the cache" do
+      expect(@cache).to receive(:write).with("/",
+                                             instance_of(Faraday::Response),
+                                             options[:write_options])
+      get('/')
+    end
+
+    context "with no :write_options" do
+      let(:options) { {} }
+
+      it "doesn't pass a third options parameter to the cache's #write" do
+        expect(@cache).to receive(:write).with("/", instance_of(Faraday::Response))
+        get('/')
+      end
+    end
+  end
+
   class TestCache < Hash
     def read(key)
       if cached = self[key]
         Marshal.load(cached)
       end
     end
 
-    def write(key, data)
+    def write(key, data, options = nil)
       self[key] = Marshal.dump(data)
     end