response_bank 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22412918297172ba47f51811bb250ace6dbb2b3d8eb26405f0f970a18b2479de
-  data.tar.gz: 94022c0b2e796e9a0a8a0fcc47f7f4ba40f64118458695554683d21452009388
+  metadata.gz: 2a5d65c4fd4310708e807cde576efeebdc590c16eb8e16190aef77a715ed48c2
+  data.tar.gz: 498da7cd7cfcc2da09b517e6694093551e79288ec4e52e815950448353ba4a0f
 SHA512:
-  metadata.gz: eb15b72956d34a954d829f1ac5666568e5b0c1b4eeebd7a127d8f88b5d103efbd856fe0d4466c675826868a2e8fb8fd572004891753a0bf1799ba3bc04a1cc81
-  data.tar.gz: 86ac266abcbe74dbf7fb72c833def9283fdd5943c0666fc1bf6dbed34008161c3458d85f1d365f7b8d6aacdd4af1a5b8822bc792c33de094668490d6108d4a87
+  metadata.gz: 5985c959c55ebf8917d9687dd0e3c3d82cae36684f7466d7c1d1805097da2fd57cadaa6efa9f7d618a757e24949a7e493aefe0e298f5c0254d9b595f7871bba8
+  data.tar.gz: 5bc8ac60f2d2ce149120a8f0bc98aca57899511359f5a67a125b6cc3894edf0043dffad8be635ae9fa95a9d1b295220a091b0d2faa118982f9740eac5e3d6786

data/README.md

@@ -22,7 +22,32 @@ This gem supports the following versions of Ruby and Rails:
 gem 'response_bank'
 ```
 
-2. use `#response_cache` method to any desired controller's action
+2. add an initializer file. We need to configure the `acquire_lock` method, set the cache store and the logger
+
+```ruby
+require 'response_bank'
+
+module ResponseBank
+  LOCK_TTL = 90
+
+  class << self
+    def acquire_lock(cache_key)
+      cache_store.write("#{cache_key}:lock", '1', unless_exist: true, expires_in: LOCK_TTL, raw: true)
+    end
+  end
+end
+
+ResponseBank.cache_store = ActiveSupport::Cache.lookup_store(Rails.configuration.cache_store)
+ResponseBank.logger = Rails.logger
+
+```
+
+3. enables caching on your application
+```ruby
+config.action_controller.perform_caching = true
+```
+
+4. use `#response_cache` method to any desired controller's action
 
 ```ruby
 class PostsController < ApplicationController
@@ -35,7 +60,17 @@ class PostsController < ApplicationController
 end
 ```
 
-3. **(optional)** override custom cache key data. For default, cache key is defined by URL and query string
+5. **(optional)** set a custom TTL for the cache by overriding the `write_to_backing_cache_store` method in your initializer file
+```ruby
+module ResponseBank
+  CACHE_TTL = 30.minutes
+  def write_to_backing_cache_store(_env, key, payload, expires_in: CACHE_TTL)
+    cache_store.write(key, payload, raw: true, expires_in: expires_in)
+  end
+end
+```
+
+6. **(optional)** override custom cache key data. For default, cache key is defined by URL and query string
 
 ```ruby
 class PostsController < ApplicationController

data/lib/response_bank.rb

@@ -21,6 +21,14 @@ module ResponseBank
       yield
     end
 
+    def write_to_backing_cache_store(_env, key, payload, expires_in: nil)
+      cache_store.write(key, payload, raw: true, expires_in: expires_in)
+    end
+
+    def read_from_backing_cache_store(_env, cache_key, backing_cache_store: cache_store)
+      backing_cache_store.read(cache_key, raw: true)
+    end
+
     def compress(content)
       io = StringIO.new
       gz = Zlib::GzipWriter.new(io)

data/lib/response_bank/middleware.rb

@@ -44,10 +44,15 @@ module ResponseBank
 
           ResponseBank.write_to_cache(env['cacheable.key']) do
             payload = MessagePack.dump(cache_data)
-            ResponseBank.cache_store.write(env['cacheable.key'], payload, raw: true)
+            ResponseBank.write_to_backing_cache_store(
+              env,
+              env['cacheable.key'],
+              payload,
+              expires_in: env['cacheable.versioned-cache-expiry'],
+            )
 
             if env['cacheable.unversioned-key']
-              ResponseBank.cache_store.write(env['cacheable.unversioned-key'], payload, raw: true)
+              ResponseBank.write_to_backing_cache_store(env, env['cacheable.unversioned-key'], payload)
             end
           end
 

data/lib/response_bank/response_cache_handler.rb

@@ -127,7 +127,7 @@ module ResponseBank
     end
 
     def serve_from_cache(cache_key_hash, message, cache_age_tolerance = nil)
-      raw = @cache_store.read(cache_key_hash)
+      raw = ResponseBank.read_from_backing_cache_store(@env, cache_key_hash, backing_cache_store: @cache_store)
 
       if raw
         hit = MessagePack.load(raw)

data/lib/response_bank/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ResponseBank
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: response_bank
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tobias Lütke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-27 00:00:00.000000000 Z
+date: 2021-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: useragent
@@ -129,7 +129,8 @@ files:
 homepage: ''
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -145,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Simple response caching for Ruby applications