faraday-http-cache 0.1.0 → 0.1.1

data/lib/faraday/http_cache/response.rb

@@ -109,11 +109,12 @@ module Faraday
           (expires && (expires - date))
       end
 
-      # Internal: Creates a new 'Faraday::Response'.
+      # Internal: Creates a new 'Faraday::Response', merging the stored
+      # response with the supplied 'env' object.
       #
       # Returns a new instance of a 'Faraday::Response' with the payload.
-      def to_response
-        Faraday::Response.new(@payload)
+      def to_response(env)
+        Faraday::Response.new(env.merge(@payload))
       end
 
       private

data/lib/faraday/http_cache.rb

@@ -115,14 +115,14 @@ module Faraday
     #
     # env - the environment 'Hash' provided from the 'Faraday' stack.
     #
-    # Returns the actual 'Faraday::Response' instance to be served.
+    # Returns the 'Faraday::Response' instance to be served.
     def process(env)
       entry = @storage.read(@request)
 
       return fetch(env) if entry.nil?
 
       if entry.fresh?
-        response = entry.to_response
+        response = entry.to_response(env)
         trace :fresh
       else
         response = validate(entry, env)
@@ -192,11 +192,21 @@ module Faraday
     def fetch(env)
       trace :miss
       @app.call(env).on_complete do |env|
-        response = Response.new(env)
+        response = Response.new(create_response(env))
         store(response)
       end
     end
 
+    # Internal: Creates a new 'Hash' containing the response information.
+    #
+    # env - the environment 'Hash' from the Faraday stack.
+    #
+    # Returns a 'Hash' containing the ':status', ':body' and 'response_headers'
+    # entries.
+    def create_response(env)
+      env.slice(:status, :body, :response_headers)
+    end
+
     # Internal: Creates a new 'Hash' containing the request information.
     #
     # env - the environment 'Hash' from the Faraday stack.
@@ -204,9 +214,9 @@ 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
+      request = env.slice(:method, :url)
+      request[:request_headers] = env[:request_headers].dup
+      request
     end
 
     # Internal: Logs the trace info about the incoming request

data/spec/json_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Faraday::HttpCache do
+  let(:logger) { double('a Logger object', :debug => nil) }
+
+  let(:client) do
+    Faraday.new(:url => ENV['FARADAY_SERVER']) do |stack|
+      stack.response :json, :content_type => /\bjson$/
+      stack.use Faraday::HttpCache, :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('json').body['count'].should == 1
+    client.get('json').body['count'].should == 1
+  end
+end

data/spec/middleware_spec.rb

@@ -135,7 +135,6 @@ describe Faraday::HttpCache do
     end
 
     it "consumes the 'logger' key" do
-      logger = double('a logger object')
       ActiveSupport::Cache.should_receive(:lookup_store).with(:memory_store, {})
       Faraday::HttpCache.new(app, :memory_store, :logger => logger)
     end

data/spec/response_spec.rb

@@ -1,30 +1,30 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Faraday::HttpCache::Response do
-  describe 'cacheable?' do
-    it "the response isn't' cacheable if the response is marked as private" do
-      headers  = { 'Cache-Control' => 'private' }
+  describe "cacheable?" do
+    it "the response isn't cacheable if the response is marked as private" do
+      headers  = { "Cache-Control" => "private" }
       response = Faraday::HttpCache::Response.new(:response_headers => headers)
 
       response.should_not be_cacheable
     end
 
-    it "the response isn't' cacheable if it shouldn't be stored" do
-      headers  = { 'Cache-Control' => 'no-store' }
+    it "the response isn't cacheable if it shouldn't be stored" do
+      headers  = { "Cache-Control" => "no-store" }
       response = Faraday::HttpCache::Response.new(:response_headers => headers)
 
       response.should_not be_cacheable
     end
 
     it "the response isn't cacheable when the status code isn't acceptable" do
-      headers  = { 'Cache-Control' => 'max-age=400' }
+      headers  = { "Cache-Control" => "max-age=400" }
       response = Faraday::HttpCache::Response.new(:status => 503, :response_headers => headers)
       response.should_not be_cacheable
     end
 
     [200, 203, 300, 301, 302, 404, 410].each do |status|
       it "the response is cacheable if the status code is #{status} and the response is fresh" do
-        headers  = { 'Cache-Control' => 'max-age=400' }
+        headers  = { "Cache-Control" => "max-age=400" }
         response = Faraday::HttpCache::Response.new(:status => status, :response_headers => headers)
 
         response.should be_cacheable
@@ -32,10 +32,10 @@ describe Faraday::HttpCache::Response do
     end
   end
 
-  describe 'freshness' do
+  describe "freshness" do
     it "is fresh if the response still has some time to live" do
       date = 200.seconds.ago.httpdate
-      headers = { 'Cache-Control' => 'max-age=400', 'Date' => date }
+      headers = { "Cache-Control" => "max-age=400", 'Date' => date }
       response = Faraday::HttpCache::Response.new(:response_headers => headers)
 
       response.should be_fresh
@@ -43,7 +43,7 @@ describe Faraday::HttpCache::Response do
 
     it "isn't fresh when the ttl has expired" do
       date = 500.seconds.ago.httpdate
-      headers = { 'Cache-Control' => 'max-age=400', 'Date' => date }
+      headers = { "Cache-Control" => "max-age=400", 'Date' => date }
       response = Faraday::HttpCache::Response.new(:response_headers => headers)
 
       response.should_not be_fresh
@@ -63,33 +63,32 @@ describe Faraday::HttpCache::Response do
   end
 
   it "returns the 'Last-Modified' header on the #last_modified method" do
-    headers = { 'Last-Modified' => '123'}
+    headers = { "Last-Modified" => "123"}
     response = Faraday::HttpCache::Response.new(:response_headers => headers)
-    response.last_modified.should == '123'
+    response.last_modified.should == "123"
   end
 
   it "returns the 'ETag' header on the #etag method" do
-    headers = { 'ETag' => 'tag'}
+    headers = { "ETag" => "tag"}
     response = Faraday::HttpCache::Response.new(:response_headers => headers)
-    response.etag.should == 'tag'
+    response.etag.should == "tag"
   end
 
-  describe 'max age calculation' do
-
-    it 'uses the shared max age directive when present' do
-      headers = { 'Cache-Control' => 's-maxage=200, max-age=0'}
+  describe "max age calculation" do
+    it "uses the shared max age directive when present" do
+      headers = { "Cache-Control" => "s-maxage=200, max-age=0"}
       response = Faraday::HttpCache::Response.new(:response_headers => headers)
       response.max_age.should == 200
     end
 
-    it 'uses the max age directive when present' do
-      headers = { 'Cache-Control' => 'max-age=200'}
+    it "uses the max age directive when present" do
+      headers = { "Cache-Control" => "max-age=200"}
       response = Faraday::HttpCache::Response.new(:response_headers => headers)
       response.max_age.should == 200
     end
 
     it "fallsback to the expiration date leftovers" do
-      headers = { 'Expires' => (Time.now + 100).httpdate, 'Date' => Time.now.httpdate }
+      headers = { "Expires" => (Time.now + 100).httpdate, 'Date' => Time.now.httpdate }
       response = Faraday::HttpCache::Response.new(:response_headers => headers)
       response.max_age.should == 100
     end
@@ -100,9 +99,9 @@ describe Faraday::HttpCache::Response do
     end
   end
 
-  describe 'age calculation' do
+  describe "age calculation" do
     it "uses the 'Age' header if it's present" do
-      response = Faraday::HttpCache::Response.new(:response_headers => { 'Age' => '3' })
+      response = Faraday::HttpCache::Response.new(:response_headers => { "Age" => "3" })
       response.age.should == 3
     end
 
@@ -118,32 +117,38 @@ describe Faraday::HttpCache::Response do
     end
   end
 
-  describe 'time to live calculation' do
+  describe "time to live calculation" do
     it "returns the time to live based on the max age limit" do
       date = 200.seconds.ago.httpdate
-      headers = { 'Cache-Control' => 'max-age=400', 'Date' => date }
+      headers = { "Cache-Control" => "max-age=400", 'Date' => date }
       response = Faraday::HttpCache::Response.new(:response_headers => headers)
       response.ttl.should == 200
     end
   end
 
   describe "response unboxing" do
-    subject { described_class.new(:status => 200, :response_headers => {}, :body => 'Hi!') }
-    let(:response) { subject.to_response }
+    subject { described_class.new(:status => 200, :response_headers => {}, :body => "Hi!") }
+    let(:env) { { :resquest => mock } }
+
+    let(:response) { subject.to_response(env) }
+
+    it "merges the supplied env object with the response data" do
+      response.env[:resquest].should be
+    end
 
-    it 'returns a Faraday::Response' do
+    it "returns a Faraday::Response" do
       response.should be_a Faraday::Response
     end
 
-    it 'merges the status code' do
+    it "merges the status code" do
       response.status.should == 200
     end
 
-    it 'merges the headers' do
+    it "merges the headers" do
       response.headers.should be_a Faraday::Utils::Headers
     end
 
-    it 'merges the body' do
+    it "merges the body" do
       response.body.should == "Hi!"
     end
   end

data/spec/spec_helper.rb

@@ -2,9 +2,10 @@ require 'uri'
 require 'socket'
 
 require 'faraday-http-cache'
+require 'faraday_middleware'
 require 'active_support/core_ext/date/calculations'
 require 'active_support/core_ext/numeric/time'
-require 'yajl'
+require 'json'
 
 require 'support/test_app'
 require 'support/test_server'

data/spec/support/test_app.rb

@@ -20,6 +20,11 @@ class TestApp < Sinatra::Base
     status 204
   end
 
+  get '/json' do
+    json = MultiJson.encode(:count => settings.requests += 1)
+    [200, { 'Cache-Control' => 'max-age=400', 'Content-Type' => 'application/json' }, json]
+  end
+
   post '/post' do
     [200, { 'Cache-Control' => 'max-age=400' }, "#{settings.requests += 1}"]
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday-http-cache
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-03 00:00:00.000000000 Z
+date: 2012-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -59,86 +59,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: em-http-request
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.2
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yajl-ruby
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Middleware to handle HTTP caching
 email:
 - contact@plataformatec.com.br
@@ -154,6 +74,7 @@ files:
 - lib/faraday/http_cache.rb
 - lib/faraday-http-cache.rb
 - spec/cache_control_spec.rb
+- spec/json_spec.rb
 - spec/middleware_spec.rb
 - spec/response_spec.rb
 - spec/spec_helper.rb
@@ -172,12 +93,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !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
@@ -186,10 +113,10 @@ specification_version: 3
 summary: A Faraday middleware that stores and validates cache expiration.
 test_files:
 - 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/test_app.rb
 - spec/support/test_server.rb
-has_rdoc: