faraday-http-cache 0.2.1 → 0.3.0

data/spec/spec_helper.rb

@@ -21,8 +21,11 @@ RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
+  config.order = 'random'
 
   config.after(:suite) do
     server.stop
   end
 end
+
+ActiveSupport::Deprecation.silenced = true

data/spec/storage_spec.rb

@@ -2,40 +2,59 @@ require 'spec_helper'
 
 describe Faraday::HttpCache::Storage do
   let(:request) do
-    { :method => :get, :request_headers => {}, :url => URI.parse("http://foo.bar/") }
+    { method: :get, request_headers: {}, url: URI.parse('http://foo.bar/') }
   end
 
-  let(:response) { double(:serializable_hash => {}) }
+  let(:response) { double(serializable_hash: {}) }
 
   let(:cache) { ActiveSupport::Cache.lookup_store }
 
-  subject { Faraday::HttpCache::Storage.new(cache) }
+  let(:storage) { Faraday::HttpCache::Storage.new(store: cache) }
+  subject { storage }
 
   describe 'Cache configuration' do
     it 'lookups a ActiveSupport cache store' do
-      ActiveSupport::Cache.should_receive(:lookup_store).with(:file_store, '/tmp')
-      Faraday::HttpCache::Storage.new(:file_store, '/tmp')
+      expect(ActiveSupport::Cache).to receive(:lookup_store).with(:file_store, ['/tmp'])
+      Faraday::HttpCache::Storage.new({ store: :file_store, store_options: ['/tmp'] })
     end
   end
 
   describe 'storing responses' do
-    it 'writes the response json to the underlying cache using a digest as the key' do
-      json = MultiJson.dump(response.serializable_hash)
 
-      cache.should_receive(:write).with('503ac9f7180ca1cdec49e8eb73a9cc0b47c27325', json)
-      subject.write(request, response)
+    shared_examples 'serialization' do
+      it 'writes the response json to the underlying cache using a digest as the key' do
+        expect(cache).to receive(:write).with(cache_key, serialized)
+        subject.write(request, response)
+      end
+    end
+
+    context 'with default serializer' do
+      let(:serialized) { MultiJson.dump(response.serializable_hash) }
+      let(:cache_key)  { '503ac9f7180ca1cdec49e8eb73a9cc0b47c27325' }
+      it_behaves_like 'serialization'
     end
+
+    context 'with Marshal serializer' do
+      let(:storage)    { Faraday::HttpCache::Storage.new store: cache, serializer: Marshal }
+      let(:serialized) { Marshal.dump(response.serializable_hash) }
+      let(:cache_key) do
+        array = request.stringify_keys.to_a.sort
+        Digest::SHA1.hexdigest(Marshal.dump(array))
+      end
+      it_behaves_like 'serialization'
+    end
+
   end
 
   describe 'reading responses' do
-    it "returns nil if the response isn't cached" do
-      subject.read(request).should be_nil
+    it 'returns nil if the response is not cached' do
+      expect(subject.read(request)).to be_nil
     end
 
     it 'decodes a stored response' do
       subject.write(request, response)
 
-      subject.read(request).should be_a(Faraday::HttpCache::Response)
+      expect(subject.read(request)).to be_a(Faraday::HttpCache::Response)
     end
   end
 
@@ -48,13 +67,13 @@ describe Faraday::HttpCache::Storage do
           'Expires' => 37.seconds.from_now.httpdate,
           'Last-Modified' => 300.seconds.ago.httpdate
       }
-      response = Faraday::HttpCache::Response.new(:response_headers => headers)
-      response.should be_fresh
+      response = Faraday::HttpCache::Response.new(response_headers: headers)
+      expect(response).to be_fresh
       subject.write(request, response)
 
       cached_response = subject.read(request)
-      cached_response.max_age.should == 34
-      cached_response.should_not be_fresh
+      expect(cached_response.max_age).to eq(34)
+      expect(cached_response).not_to be_fresh
     end
 
     it 'is fresh until cached and that 1 second elapses then the response is no longer fresh' do
@@ -62,13 +81,13 @@ describe Faraday::HttpCache::Storage do
           'Date' => 39.seconds.ago.httpdate,
           'Expires' => 40.seconds.from_now.httpdate,
       }
-      response = Faraday::HttpCache::Response.new(:response_headers => headers)
-      response.should be_fresh
+      response = Faraday::HttpCache::Response.new(response_headers: headers)
+      expect(response).to be_fresh
       subject.write(request, response)
 
       sleep(1)
       cached_response = subject.read(request)
-      cached_response.should_not be_fresh
+      expect(cached_response).not_to be_fresh
     end
   end
 

data/spec/support/test_app.rb

@@ -11,7 +11,7 @@ class TestApp < Sinatra::Base
   set :yesterday, 1.day.ago.httpdate
 
   get '/ping' do
-    "PONG"
+    'PONG'
   end
 
   get '/clear' do
@@ -21,36 +21,42 @@ class TestApp < Sinatra::Base
   end
 
   get '/json' do
-    json = MultiJson.encode(:count => settings.requests += 1)
+    json = MultiJson.encode(count: increment_counter.to_i)
     [200, { 'Cache-Control' => 'max-age=400', 'Content-Type' => 'application/json' }, json]
   end
 
+  get '/image' do
+    image = File.expand_path('../empty.png', __FILE__)
+    data  = IO.binread(image)
+    [200, { 'Cache-Control' => 'max-age=400', 'Content-Type' => 'image/png' }, data]
+  end
+
   post '/post' do
-    [200, { 'Cache-Control' => 'max-age=400' }, "#{settings.requests += 1}"]
+    [200, { 'Cache-Control' => 'max-age=400' }, increment_counter]
   end
 
   get '/broken' do
-    [500, { 'Cache-Control' => 'max-age=400' }, "#{settings.requests += 1}"]
+    [500, { 'Cache-Control' => 'max-age=400' }, increment_counter]
   end
 
   get '/get' do
-    [200, { 'Cache-Control' => 'max-age=200' }, "#{settings.requests += 1}"]
+    [200, { 'Cache-Control' => 'max-age=200' }, increment_counter]
   end
 
   get '/private' do
-    [200, { 'Cache-Control' => 'private' }, "#{settings.requests += 1}"]
+    [200, { 'Cache-Control' => 'private' }, increment_counter]
   end
 
   get '/dontstore' do
-    [200, { 'Cache-Control' => 'no-store' }, "#{settings.requests += 1}"]
+    [200, { 'Cache-Control' => 'no-store' }, increment_counter]
   end
 
   get '/expires' do
-    [200, { 'Expires' => (Time.now + 10).httpdate }, "#{settings.requests += 1}"]
+    [200, { 'Expires' => (Time.now + 10).httpdate }, increment_counter]
   end
 
   get '/yesterday' do
-    [200, { 'Date' => settings.yesterday, 'Expires' => settings.yesterday }, "#{settings.requests += 1}"]
+    [200, { 'Date' => settings.yesterday, 'Expires' => settings.yesterday }, increment_counter]
   end
 
   get '/timestamped' do
@@ -58,9 +64,9 @@ class TestApp < Sinatra::Base
     header = settings.counter > 2 ? '1' : '2'
 
     if env['HTTP_IF_MODIFIED_SINCE'] == header
-      [304, {}, ""]
+      [304, {}, '']
     else
-      [200, { 'Last-Modified' => header }, "#{settings.requests += 1}"]
+      [200, { 'Last-Modified' => header }, increment_counter]
     end
   end
 
@@ -71,7 +77,12 @@ class TestApp < Sinatra::Base
     if env['HTTP_IF_NONE_MATCH'] == tag
       [304, { 'ETag' => tag, 'Cache-Control' => 'max-age=200', 'Date' => Time.now.httpdate, 'Expires' => (Time.now + 200).httpdate, 'Vary' => '*' }, ""]
     else
-      [200, { 'ETag' => tag, 'Cache-Control' => 'max-age=0', 'Date' => settings.yesterday, 'Expires' => Time.now.httpdate, 'Vary' => 'Accept' }, "#{settings.requests += 1}"]
+      [200, { 'ETag' => tag, 'Cache-Control' => 'max-age=0', 'Date' => settings.yesterday, 'Expires' => Time.now.httpdate, 'Vary' => 'Accept' }, increment_counter]
     end
   end
-end
+
+  # Increments the 'requests' counter to act as a newly processed response.
+  def increment_counter
+    (settings.requests += 1).to_s
+  end
+end

data/spec/support/test_server.rb

@@ -26,9 +26,9 @@ class TestServer
       log = File.open('log/test.log', 'w+')
       log.sync = true
       webrick_opts = {
-       :Port => @port,
-       :Logger => WEBrick::Log::new(log),
-       :AccessLog => [[log, "[%{X-Faraday-Adapter}i] %m  %U  ->  %s %b"]]
+       Port: @port,
+       Logger:  WEBrick::Log::new(log),
+       AccessLog: [[log, '[%{X-Faraday-Adapter}i] %m  %U  ->  %s %b']]
       }
       Rack::Handler::WEBrick.run(TestApp, webrick_opts)
     end
@@ -51,7 +51,7 @@ class TestServer
     begin
       server_pings += 1
       sleep 0.05
-      abort "test server didn't manage to start" if server_pings >= 50
+      abort 'test server did not managed to start' if server_pings >= 50
     end until responsive.call('/ping')
   end
 
@@ -61,4 +61,4 @@ class TestServer
   ensure
     server.close if server
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-http-cache
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Lucas Mazza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-26 00:00:00.000000000 Z
+date: 2013-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,16 +66,19 @@ files:
 - lib/faraday/http_cache/storage.rb
 - lib/faraday/http_cache.rb
 - lib/faraday-http-cache.rb
+- spec/binary_spec.rb
 - spec/cache_control_spec.rb
 - spec/json_spec.rb
 - spec/middleware_spec.rb
 - spec/response_spec.rb
 - spec/spec_helper.rb
 - spec/storage_spec.rb
+- spec/support/empty.png
 - spec/support/test_app.rb
 - spec/support/test_server.rb
 homepage: https://github.com/plataformatec/faraday-http-cache
-licenses: []
+licenses:
+- Apache 2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -93,16 +96,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A Faraday middleware that stores and validates cache expiration.
 test_files:
+- spec/binary_spec.rb
 - spec/cache_control_spec.rb
 - spec/json_spec.rb
 - spec/middleware_spec.rb
 - spec/response_spec.rb
 - spec/spec_helper.rb
 - spec/storage_spec.rb
+- spec/support/empty.png
 - spec/support/test_app.rb
 - spec/support/test_server.rb