faraday-http-cache 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03db6f441525313b0456fb22845a0273138a1c50
+  data.tar.gz: 7ede80de69498baf306b98be866b37f3b04e4683
+SHA512:
+  metadata.gz: f3136959afbad718ce611169c3cf86f3721360c4b9bb44fca9db13fcca5e9013dc144a5a40f180ed904757c9e286c009bccd80672bb145fcde1769c84713acac
+  data.tar.gz: 4c66329f3810782ac4a586cc69d94e14ad4e1353b4cba5da928b8230a9821593a4be2ba538c20c4bb37baff75849a9ce2f30be5c7299f0bb7b562fcaeeadc6f5

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012 Plataformatec.
+Copyright 2012-2013 Plataformatec.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://secure.travis-ci.org/plataformatec/faraday-http-cache.png)](https://travis-ci.org/plataformatec/faraday-http-cache)
 
-a [Faraday](https://github.com/technoweenie/faraday) middleware that respects HTTP cache,
+a [Faraday](https://github.com/lostisland/faraday) middleware that respects HTTP cache,
 by checking expiration and validation of the stored responses.
 
 ## Installation
@@ -73,4 +73,4 @@ Twitter API again.
 
 ## License
 
-Copyright (c) 2012 Plataformatec. See LICENSE file.
+Copyright (c) 2012-2013 Plataformatec. See LICENSE file.

data/lib/faraday/http_cache.rb

@@ -105,7 +105,7 @@ module Faraday
       method == :get || method == :head
     end
 
-    # Internal: Tries to located a valid response or forwards the call to the stack.
+    # Internal: Tries to locate a valid response or forwards the call to the stack.
     # * If no entry is present on the storage, the 'fetch' method will forward
     # the call to the remaining stack and return the new response.
     # * If a fresh response is found, the middleware will abort the remaining
@@ -151,8 +151,10 @@ module Faraday
         response = Response.new(env)
         if response.not_modified?
           trace :valid
-          env.merge!(entry.payload)
-          response = entry
+          updated_payload = entry.payload
+          updated_payload[:response_headers].update(response.payload[:response_headers])
+          env.update(updated_payload)
+          response = Response.new(updated_payload)
         end
         store(response)
       end
@@ -204,7 +206,7 @@ module Faraday
     # Returns a 'Hash' containing the ':status', ':body' and 'response_headers'
     # entries.
     def create_response(env)
-      env.slice(:status, :body, :response_headers)
+      env.to_hash.slice(:status, :body, :response_headers)
     end
 
     # Internal: Creates a new 'Hash' containing the request information.
@@ -214,8 +216,8 @@ module Faraday
     # Returns a 'Hash' containing the ':method', ':url' and 'request_headers'
     # entries.
     def create_request(env)
-      request = env.slice(:method, :url)
-      request[:request_headers] = env[:request_headers].dup
+      request = env.to_hash.slice(:method, :url, :request_headers)
+      request[:request_headers] = request[:request_headers].dup
       request
     end
 
@@ -228,11 +230,15 @@ module Faraday
       return unless @logger
 
       method = @request[:method].to_s.upcase
-      path = @request[:url].path
+      path = @request[:url].request_uri
       line = "HTTP Cache: [#{method} #{path}] #{@trace.join(', ')}"
       @logger.debug(line)
     end
   end
 end
 
-Faraday.register_middleware :http_cache => lambda { Faraday::HttpCache }
+if Faraday.respond_to?(:register_middleware)
+  Faraday.register_middleware :http_cache => Faraday::HttpCache
+elsif Faraday::Middleware.respond_to?(:register_middleware)
+  Faraday::Middleware.register_middleware :http_cache => Faraday::HttpCache
+end

data/lib/faraday/http_cache/cache_control.rb

@@ -7,9 +7,8 @@ module Faraday
     class CacheControl
 
       # Internal: Initialize a new CacheControl.
-      def initialize(string)
-        @directives = {}
-        parse(string)
+      def initialize(header)
+        @directives = parse(header.to_s)
       end
 
       # Internal: Checks if the 'public' directive is present.
@@ -79,33 +78,31 @@ module Faraday
 
       private
 
-      # Internal: Parses the Cache Control string into the directives Hash.
-      # Existing whitespaces are removed, and the string is splited on commas.
-      # For each segment, everything before a '=' will be treated as the key
-      # and the excedding will be treated as the value. If only the key is
-      # present the assigned value will defaults to true.
+      # Internal: Parses the Cache Control string to a Hash.
+      # Existing whitespace will be removed and the string is split on commas.
+      # For each part everything before a '=' will be treated as the key
+      # and the exceeding will be treated as the value. If only the key is
+      # present then the assigned value will default to true.
       #
       # Examples:
       #   parse("max-age=600")
-      #   @directives
-      #    # => { "max-age" => "600"}
+      #   # => { "max-age" => "600"}
       #
       #   parse("max-age")
-      #   @directives
-      #    # => { "max-age" => true }
+      #   # => { "max-age" => true }
       #
-      # Returns nothing.
-      def parse(string)
-        string = string.to_s
+      # Returns a Hash.
+      def parse(header)
+        directives = {}
 
-        return if string.empty?
-
-        string.delete(' ').split(',').each do |part|
+        header.delete(' ').split(',').each do |part|
           next if part.empty?
 
           name, value = part.split('=', 2)
-          @directives[name.downcase] = (value || true) unless name.empty?
+          directives[name.downcase] = (value || true) unless name.empty?
         end
+
+        directives
       end
     end
   end

data/lib/faraday/http_cache/response.rb

@@ -114,7 +114,16 @@ module Faraday
       #
       # Returns a new instance of a 'Faraday::Response' with the payload.
       def to_response(env)
-        Faraday::Response.new(env.merge(@payload))
+        env.update(@payload)
+        Faraday::Response.new(env)
+      end
+
+      # Internal: Exposes a representation of the current
+      # payload that we can serialize and cache properly.
+      #
+      # Returns a 'Hash'.
+      def serializable_hash
+        @payload.slice(:status, :body, :response_headers)
       end
 
       private

data/lib/faraday/http_cache/storage.rb

@@ -32,8 +32,7 @@ module Faraday
       # response - The Faraday::HttpCache::Response instance to be stored.
       def write(request, response)
         key = cache_key_for(request)
-        value = MultiJson.dump(response.payload)
-
+        value = MultiJson.dump(response.serializable_hash)
         cache.write(key, value)
       end
 

data/spec/json_spec.rb

@@ -6,19 +6,16 @@ describe Faraday::HttpCache do
   let(:client) do
     Faraday.new(:url => ENV['FARADAY_SERVER']) do |stack|
       stack.response :json, :content_type => /\bjson$/
-      stack.use Faraday::HttpCache, :logger => logger
+      stack.use :http_cache, :logger => logger
       adapter = ENV['FARADAY_ADAPTER']
       stack.headers['X-Faraday-Adapter'] = adapter
       stack.adapter adapter.to_sym
     end
   end
 
-  before do
-    client.get('clear')
-  end
-
   it "works fine with other middlewares" do
+    client.get('clear')
     client.get('json').body['count'].should == 1
     client.get('json').body['count'].should == 1
   end
-end
+end

data/spec/middleware_spec.rb

@@ -83,6 +83,13 @@ describe Faraday::HttpCache do
     client.get('get')
   end
 
+  it "differs requests with different query strings in the log" do
+    logger.should_receive(:debug).with('HTTP Cache: [GET /get] miss, store')
+    logger.should_receive(:debug).with('HTTP Cache: [GET /get?q=what] miss, store')
+    client.get('get')
+    client.get('get', :q => "what")
+  end
+
   it "logs that a stored GET response is fresh" do
     client.get('get')
     logger.should_receive(:debug).with('HTTP Cache: [GET /get] fresh')
@@ -121,6 +128,26 @@ describe Faraday::HttpCache do
     date.should =~ /^\w{3}, \d{2} \w{3} \d{4} \d{2}:\d{2}:\d{2} GMT$/
   end
 
+  it "updates the 'Cache-Control' header when a response is validated" do
+    cache_control = client.get('etag').headers['Cache-Control']
+    client.get('etag').headers['Cache-Control'].should_not == cache_control
+  end
+
+  it "updates the 'Date' header when a response is validated" do
+    date = client.get('etag').headers['Date']
+    client.get('etag').headers['Date'].should_not == date
+  end
+
+  it "updates the 'Expires' header when a response is validated" do
+    expires = client.get('etag').headers['Expires']
+    client.get('etag').headers['Expires'].should_not == expires
+  end
+  
+  it "updates the 'Vary' header when a response is validated" do
+    vary = client.get('etag').headers['Vary']
+    client.get('etag').headers['Vary'].should_not == vary
+  end
+
   describe 'Configuration options' do
     let(:app) { double("it's an app!") }
 

data/spec/response_spec.rb

@@ -128,12 +128,12 @@ describe Faraday::HttpCache::Response do
 
   describe "response unboxing" do
     subject { described_class.new(:status => 200, :response_headers => {}, :body => "Hi!") }
-    let(:env) { { :resquest => mock } }
 
+    let(:env) { { :method => :get } }
     let(:response) { subject.to_response(env) }
 
     it "merges the supplied env object with the response data" do
-      response.env[:resquest].should be
+      response.env[:method].should be
     end
 
     it "returns a Faraday::Response" do

data/spec/storage_spec.rb

@@ -5,7 +5,7 @@ describe Faraday::HttpCache::Storage do
     { :method => :get, :request_headers => {}, :url => URI.parse("http://foo.bar/") }
   end
 
-  let(:response) { double(:payload => {}) }
+  let(:response) { double(:serializable_hash => {}) }
 
   let(:cache) { ActiveSupport::Cache.lookup_store }
 
@@ -20,7 +20,7 @@ describe Faraday::HttpCache::Storage do
 
   describe 'storing responses' do
     it 'writes the response json to the underlying cache using a digest as the key' do
-      json = MultiJson.dump(response.payload)
+      json = MultiJson.dump(response.serializable_hash)
 
       cache.should_receive(:write).with('503ac9f7180ca1cdec49e8eb73a9cc0b47c27325', json)
       subject.write(request, response)

data/spec/support/test_app.rb

@@ -69,9 +69,9 @@ class TestApp < Sinatra::Base
     tag = settings.counter > 2 ? '1' : '2'
 
     if env['HTTP_IF_NONE_MATCH'] == tag
-      [304, { 'ETag' => tag }, ""]
+      [304, { 'ETag' => tag, 'Cache-Control' => 'max-age=200', 'Date' => Time.now.httpdate, 'Expires' => (Time.now + 200).httpdate, 'Vary' => '*' }, ""]
     else
-      [200, { 'ETag' => tag }, "#{settings.requests += 1}"]
+      [200, { 'ETag' => tag, 'Cache-Control' => 'max-age=0', 'Date' => settings.yesterday, 'Expires' => Time.now.httpdate, 'Vary' => 'Accept' }, "#{settings.requests += 1}"]
     end
   end
 end

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: faraday-http-cache
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Lucas Mazza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-20 00:00:00.000000000 Z
+date: 2013-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -83,33 +76,26 @@ files:
 - spec/support/test_server.rb
 homepage: https://github.com/plataformatec/faraday-http-cache
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4216884502397664395
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4216884502397664395
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Faraday middleware that stores and validates cache expiration.
 test_files:
 - spec/cache_control_spec.rb