faraday-manual-cache 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72ed2d3a4eb4bacc4e2f682d7d2f0621aecfc2ae
-  data.tar.gz: 1ff4fcf690ae465b312fa324152d40bd4bc1910a
+  metadata.gz: 9908ab5ca8956f133b3371bb8313fc70eefa01e9
+  data.tar.gz: 71e6b04c0c4bd4f512acab094c09cc4c68f60c41
 SHA512:
-  metadata.gz: 781465c3431f1167f6dea2df07b617b1a4b8de965dbfd890e6a018ea50792a2b84d7a630760d67bafa611d82c061fc68bc6b6393ef4849225670f42719469d24
-  data.tar.gz: 5dd8050ea269687ce3ccf5137d42ae20001382f11763ddf5cb4088deeb43be7575e4e6513d9e5a7c2f9d89e43c8f10fb744ccb8332aa8c37af7d98e064fcbce0
+  metadata.gz: c46b3edf75261d00b1c039fa77f03c247b4cbec6acc21421b6a574f308c034937072347d52d9cbbc5f7f234b96d6a5f73d41f89364dbaedef825ff4e50891b4e
+  data.tar.gz: 254fa5f85405e188bcc66f97275fd0dcd086f418275a79c61c95133c4757b4318342f9b073a9cc211180968c5f90d1f145f3d553def7fa4bc5a1648afe28f6c7

data/README.md

@@ -52,6 +52,10 @@ end
 
 As with `faraday-http-cache` it's recommended that `faraday-manual-cache` be fairly low in the middleware stack.
 
+## TODO
+
+  * Additional cache key options.
+
 ## Contributing
 
 1. Fork it ( http://github.com/dobs/faraday-manual-cache/fork )

data/faraday-manual-cache.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = 'faraday-manual-cache'
-  spec.version       = '0.0.1'
+  spec.version       = '0.1.0'
   spec.authors       = ['Daniel O\'Brien']
   spec.email         = ['dan@dobs.org']
   spec.summary       = %q(A super simple Faraday cache implementation.)
@@ -14,6 +14,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 1.9'
+
   spec.add_dependency 'activesupport', '>= 3.0.0'
   spec.add_dependency 'faraday', '~> 0.9'
 

data/lib/faraday/manual_cache.rb

@@ -9,6 +9,7 @@ module Faraday
   # Currently accepts four arguments:
   #
   #   :expires_in    - Cache expiry, in seconds (default: 30).
+  #   :logger        - A logger object to send cache hit/miss/write messages.
   #   :store         - An object (or lookup symbol) for an
   #                    ActiveSupport::Cache::Store instance. (default:
   #                    MemoryStore).
@@ -19,9 +20,13 @@ module Faraday
       super(app)
       options = args.first || {}
       @expires_in    = options.fetch(:expires_in, 30)
+      @logger        = options.fetch(:logger, nil)
+      @namespace     = options.fetch(:namespace, 'faraday-manual-cache')
       @store         = options.fetch(:store, :memory_store)
       @store_options = options.fetch(:store_options, {})
 
+      @store_options[:namespace] ||= @namespace
+
       initialize_store
     end
 
@@ -32,31 +37,42 @@ module Faraday
     protected
 
     def call!(env)
-      return to_response(cached_response(env)) if cacheable?(env) &&
-        cached_response(env)
+      response_env = cached_response(env)
 
-      @app.call(env).on_complete do |response_env|
-        cache_response(response_env) if cacheable?(env)
+      if response_env && !env.request_headers['x-faraday-manual-cache']
+        info "Cache HIT: #{key(env)}"
+        response_env.response_headers['x-faraday-manual-cache'] = 'HIT'
+        to_response(cached_response(env)) 
+      else
+        info "Cache MISS: #{key(env)}"
+        @app.call(env).on_complete do |response_env|
+          response_env.response_headers['x-faraday-manual-cache'] = 'MISS'
+          cache_response(response_env) if cacheable?(env)
+        end
       end
     end
 
-    # Cache the env to the store.
     def cache_response(env)
-      @store.write(env.url, env, expires_in: @expires_in)
+      info "Cache WRITE: #{key(env)}"
+      @store.write(key(env), env, expires_in: @expires_in)
     end
 
-    # Whether or not the env is cacheable.
     def cacheable?(env)
       env.method == :get || env.method == :head
     end
 
-    # Retrieve (and memoize) cached response matching current env.
     def cached_response(env)
-      @cached_response ||= @store.fetch(env.url)
+      @store.fetch(key(env)) if cacheable?(env)
+    end
+
+    def info(message)
+      @logger.info(message) unless @logger.nil?
+    end
+
+    def key(env)
+      env.url
     end
 
-    # Checks whether the specified store is a symbol, and if so attempts to
-    # do a lookup against ActiveSupport::Cache.
     def initialize_store
       return unless @store.is_a? Symbol
 
@@ -64,8 +80,9 @@ module Faraday
       @store = ActiveSupport::Cache.lookup_store(@store, @store_options)
     end
 
-    # Massage env into a Response object.
     def to_response(env)
+      env = env.dup
+      env.response_headers['x-faraday-manual-cache'] = 'HIT'
       response = Response.new
       response.finish(env) unless env.parallel?
       env.response = response

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-manual-cache
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Daniel O'Brien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -102,9 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A super simple Faraday cache implementation.
 test_files: []
-has_rdoc: