async_cache 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d672798f9a1aac8ba14134c46379e28dd0eb1de4
-  data.tar.gz: c590ed218b9717d22a02e5e4583f8210e38ea9ed
+  metadata.gz: 6ebb087efa77e51ac632b1fdb6e5bc646c8fc924
+  data.tar.gz: 87c132d6f30e941a877bf2c5b221a2ab657e7aa9
 SHA512:
-  metadata.gz: aaf71d240d334648fc1816fa060ca35eb9b497fc02e03b81c59666f22668feb6dbfdcb680263e2ad4a41fda4ed0d8933612e3a946d7756cb1443753158f228e8
-  data.tar.gz: 28bb134215e14a0fe25723ab0ecee482db0eb5147bcdc301e8e3e63356daaa854710f00ade60a08c0c244d206bd3a1e22ac6c98cc155c3c16de8c2dc2260e2aa
+  metadata.gz: 3249570fd6634cca700cb69a4de34c2f4a9966df8db958ac4d701da432ae8b51e81730fd26b91d5a8e2e557bcf3d8c5a47f5bba815617675564dee07cdfcc506
+  data.tar.gz: 1b00cf6f828c2d61497979df32cff4e4f76853e9bb13b2765a6dbb84dcecdd9c267394a8888950790a5a505007b9de64452974a5fcac6332ab9d40f92b6168de

data/.gitignore

@@ -1 +1,2 @@
 .DS_Store
+pkg

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    async_cache (0.0.2)
+    async_cache (1.0.0)
       sourcify (~> 0.5.0)
 
 GEM

data/README.md

@@ -15,25 +15,32 @@ gem 'async_cache'
 Then set up a store and fetch from it:
 
 ```ruby
-# Storing entries in `Rails.cache` and enqueueing via ActiveJob
-# (a Sidekiq worker is also available with additional
-# deduplication features).
-async_cache = AsyncCache::Store.new(
+# (in config/initializers/async_cache.rb)
+ASYNC_CACHE = AsyncCache::Store.new(
   backend: Rails.cache,
   worker:  :active_job
 )
 
-# Then use it to do some heavy lifting asychronously
-id      = params[:id]
-key     = "big_model/#{id}"
-version = BigModel.where(:id => id).pluck(:updated_at).first
+# (in app/controllers/things_controller.rb)
+def show
+  # Then use it to do some heavy lifting asychronously
+  id      = params[:id]
+  key     = "thing/#{id}"
+  version = Thing.select(:updated_at).find(id).updated_at
 
-async_cache.fetch(key, version, arguments: [id]) do |id|
-  BigModel.find(id).to_json
+  json = ASYNC_CACHE.fetch(key, version, arguments: [id]) do |id|
+    Thing.find(id).to_json
+  end
+
+  render body: json, content_type: 'application/json'
 end
 ```
 
-For additional examples see the [`examples`](examples/) folder.
+For additional examples see the [`examples`](examples/) directory.
+
+#### Workers
+
+Async-cache provides a generic [ActiveJob](https://github.com/rails/rails/tree/master/activejob) worker as well as a specialized [Sidekiq](https://github.com/mperham/sidekiq) worker (see the [`workers`](lib/async_cache/workers/) directory). The ActiveJob worker should work out of the box is most cases. The Sidekiq worker provides special deduplication functionality which should significantly reduce the queue size/worker process load for high-traffic sites.
 
 ## Strategy
 

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+
+# No-op to make Travis CI happy
+task 'default'

data/lib/async_cache/version.rb

@@ -1,3 +1,3 @@
 module AsyncCache
-  VERSION = '0.0.2'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async_cache
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Adam Derewecki
@@ -66,6 +66,7 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
 - async_cache.gemspec
 - examples/examples_controller.rb
 - lib/async_cache.rb