reviewed 0.5.0 → 0.6.0

data/lib/faraday/cache.rb

@@ -0,0 +1,47 @@
+require 'active_support/cache'
+
+module Faraday
+  class Cache
+
+    def self.store
+      @store ||= ActiveSupport::Cache.lookup_store(:redis_store,
+                                                   ENV['REVIEWED_CACHE_REDIS_URL'],
+                                                   { expires_in: Integer(ENV['REVIEWED_CACHE_TIMEOUT'] || 90).minutes } )
+    end
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @url = env[:url]
+      @auth_header = env[:request_headers]['X-Reviewed-Authorization']
+
+      if serve_from_cache && self.class.store.exist?(cache_key)
+        Hashie::Mash.new(Marshal.load( self.class.store.read(cache_key) ))
+      else
+        @app.call(env).on_complete do |response|
+          if store_response
+            self.class.store.delete(cache_key)
+            self.class.store.write(cache_key, Marshal.dump(response))
+          end
+        end
+      end
+    end
+
+    private
+
+    def serve_from_cache
+      @url.query.blank? || !@url.query.match(/\b(skip|reset)-cache\b/)
+    end
+
+    def store_response
+      @url.query.blank? || !@url.query.match(/\bskip-cache\b/)
+    end
+
+    def cache_key
+      [@auth_header, @url.request_uri].join(':')
+    end
+
+  end
+end

data/lib/reviewed/client.rb

@@ -59,6 +59,7 @@ module Reviewed
 
     def connection
       @connection ||= ::Faraday.new(url: base_uri) do |faraday|
+        faraday.use      Faraday::Cache if ENV['REVIEWED_CACHE_REDIS_URL']
         faraday.response :mashify
         faraday.response :errors
         faraday.response :json
@@ -78,12 +79,9 @@ module Reviewed
         end
         raise Reviewed::ApiError.new(msg: "API connection returned redirect or error: status=#{res.status}") if res.status > 204 and res.status != 404
         res
-      rescue Faraday::Error::ClientError => e
-        message = <<-EOS.gsub(/^[ ]*/, '')
-          API Error. method: #{method} url: #{base_uri} path: #{path} params: #{params.to_s} api_key: #{self.api_key}
-          Original exception message:
-          #{e.message}
-        EOS
+      rescue Errno::ETIMEDOUT, Faraday::Error::ClientError => e
+        message = %Q!API Error. method: #{method} url: #{base_uri} path: #{path} params: #{params.to_s} api_key: #{self.api_key}!
+        message << " Original exception message: #{e.message}"
         new_exception = Reviewed::ApiError.new(msg: message)
         new_exception.set_backtrace(e.backtrace) # TODO not seeing in Airbrake
         raise new_exception

data/lib/reviewed/request.rb

@@ -6,6 +6,8 @@ module Reviewed
       @resource = opts[:resource]
       @scope = opts[:scope]
       @client = opts[:client] || Reviewed::Client.new
+      @skip_cache = false
+      @reset_cache = false
     end
 
     def path
@@ -33,13 +35,48 @@ module Reviewed
     end
 
     def object_from_response(method, url, params={})
-      response = client.send(method, url, params)
+      response = client.send(method, url, params.merge(cache_control_params))
       resource.new(response.body)
     end
 
+    def cached?
+      !uncached?
+    end
+
+    def uncached?
+      skip_cache? || reset_cache?
+    end
+
+    def with_no_cache
+      @skip_cache = true
+      self
+    end
+
+    def with_new_cache
+      @reset_cache = true
+      self
+    end
+
     def collection_from_response(method, url, params={})
-      response = client.send(method, url, params)
+      response = client.send(method, url, params.merge(cache_control_params))
       Reviewed::Collection.new(client, resource, response, params)
     end
+
+    def cache_control_params
+      params = {}
+      params.merge!({:"skip-cache" => true}) if skip_cache?
+      params.merge!({:"reset-cache" => true}) if reset_cache?
+      params
+    end
+
+    private
+
+    def skip_cache?
+      @skip_cache
+    end
+
+    def reset_cache?
+      @reset_cache
+    end
   end
 end

data/lib/reviewed/version.rb

@@ -1,4 +1,4 @@
 module Reviewed
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
   API_VERSION = 'v1'
 end

data/lib/reviewed.rb

@@ -4,6 +4,7 @@ require 'faraday'
 require 'faraday_middleware'
 require 'faraday/api_key'
 require 'faraday/errors'
+require 'faraday/cache'
 require 'active_support/inflector'
 require 'active_support/core_ext'
 require 'active_model'

data/reviewed.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'faraday_middleware', '>= 0.9.0'
   gem.add_dependency 'hashie', '~> 1.2'
   gem.add_dependency 'rack'
+  gem.add_dependency 'redis-rails'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '>= 2.10'

data/spec/article_spec.rb

@@ -7,6 +7,7 @@ describe Reviewed::Article, vcr: true do
   end
 
   before(:each) do
+    Faraday::Cache.store.clear
     @article = client.articles.find('big-green-egg-medium-charcoal-grill-review', { with_attachments: true })
   end
 
@@ -63,11 +64,8 @@ describe Reviewed::Article, vcr: true do
       end
 
       it 'finds attachments by tag' do
-        attachments = @article.attachments('old-hero')
-        attachments.length.should == 1
-        attachments.each do |attachment|
-          attachment.tags.join(',').should match(/hero/i)
-        end
+        attachments = @article.attachments('hero')
+        attachments.map(&:tags).flatten.should == ['hero']
       end
 
       it 'does not have any matching attachments' do

data/spec/client_spec.rb

@@ -2,6 +2,10 @@ require 'spec_helper.rb'
 
 describe Reviewed::Client do
 
+  before do
+    Faraday::Cache.store.clear
+  end
+
   let(:client) { Reviewed::Client.new }
 
   describe 'config' do

data/spec/collection_spec.rb

@@ -12,7 +12,8 @@ describe Reviewed::Collection, vcr: true do
   end
 
   before(:each) do
-    @collection = client.products.all # creates a collection
+    Faraday::Cache.store.clear
+    @collection = client.products.with_no_cache.all # creates a collection
   end
 
   describe 'collection data' do

data/spec/faraday/cache_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+
+describe Faraday::Cache do
+
+  describe 'call' do
+
+    conn = Faraday.new do |builder|
+      builder.use Faraday::Cache
+      builder.adapter :test, Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get('/articles') { [200, {}, 'I like turtles'] }
+        stub.get('/products') { [200, {}, 'Weee products'] }
+      end
+    end
+
+    conn.headers = { "X-Reviewed-Authorization" => TEST_KEY }
+
+    it "caches anything that doesn't have skip-cache or reset-cache" do
+      mock_cache_val = mock
+      Marshal.stub(:dump).with(hash_including(:body => 'I like turtles')).and_return(mock_cache_val)
+      Faraday::Cache.store.should_receive(:write).with("#{TEST_KEY}:/articles", mock_cache_val)
+      conn.get('/articles')
+    end
+
+    it "can cache more than one thing" do
+      mock_cache_val = mock
+      Marshal.stub(:dump => mock_cache_val)
+      Faraday::Cache.store.should_receive(:write).with("#{TEST_KEY}:/articles", mock_cache_val)
+      Faraday::Cache.store.should_receive(:write).with("#{TEST_KEY}:/products", mock_cache_val)
+
+      conn.get('/articles')
+      conn.get('/products')
+    end
+
+    it "serves responses from the cache when fresh and does not call the app" do
+      marshalled_response = Marshal.dump(body: 'old musty response')
+      Faraday::Cache.store.stub(:exist? => true)
+      Faraday::Cache.store.should_receive(:read).with("#{TEST_KEY}:/articles").and_return(marshalled_response)
+      resp = conn.get '/articles'
+      resp[:body].should eq("old musty response")
+    end
+
+    describe "cache busting and skipping" do
+      it "does not cache responses with skip-cache as a query param" do
+        Faraday::Cache.store.should_not_receive(:read)
+        Faraday::Cache.store.should_not_receive(:write)
+        conn.get '/articles', {:"skip-cache" => true}
+      end
+
+      it "replaces cached content with app response when reset-cache is a query param" do
+        Faraday::Cache.store.should_not_receive(:read)
+        Faraday::Cache.store.should_receive(:write)
+        conn.get '/articles', {:"reset-cache" => true}
+      end
+    end
+
+  end
+
+end