active_waiter 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 397d4a3c5c8b298ae3d6dc7c5d9c8ee5a0ac5b7a
-  data.tar.gz: 5a6781a8b4925cc22ff4ab7d8444032bf159ff16
+  metadata.gz: 68c332e792c09a74047e5bd43c141f56f0c9a884
+  data.tar.gz: 704c364920f7e00e2ee326f4821cfa88cd7bccc8
 SHA512:
-  metadata.gz: b53766bdfb8bdf4017d4459d4fc5d89fda011e23e3e0aface14af12fba6268aacc9265e996b03540e88cf68ee995f0941bdccd366c3a2fd9589fad74299ee032
-  data.tar.gz: 0c49d57ac9c125492b736057ee8ff039b8b5f7093f7e249925b945d5f4243b3027a4421235d41c9773130dc44776f9b0606b3a745b0d52dcb9debdbd78387d06
+  metadata.gz: 562bf267da981984180e6fa34ad21096c0ac3521d573ca9ffedead6f6bf5b1344e3cad03a13fab7b88496fcc941fd3ae32ddc7d328c7ecf271075a262333a84e
+  data.tar.gz: ead53d29b6d49e1e439e5b9c647ca363c6864cdab37f904ca43ec91386915a5c6bec0ffca83b42ec71ed68638f94b2f010ac8ef0c65716735ae8d18bce99062e

data/README.md

@@ -37,7 +37,7 @@ def index
     format.html
     format.pdf {
       uid = ActiveWaiter.enqueue(ExportPdfJob, @things, current_user)
-      redirect_to active_waiter_path(uid)
+      redirect_to active_waiter_path(id: uid)
     }
   end
 end
@@ -45,13 +45,13 @@ end
 
 ``` ruby
 # routes.rb
-mount ActiveWaiter::Engine => "/active_waiter(/:id)"
+mount ActiveWaiter::Engine => "/active_waiter"
 ```
 
 When the job completes, the user will be redirected to the `url` returned by the job. However, if you want the user to be presented with a download link, add `download: 1` params instead
 
 ``` ruby
-redirect_to active_waiter_path(uid, download: 1)
+redirect_to active_waiter_path(id: uid, download: 1)
 ```
 
 ![active_waiter mov](https://cloud.githubusercontent.com/assets/473/7785141/c4667734-01b4-11e5-8974-3a3b00b3a4b6.gif)
@@ -108,6 +108,29 @@ Next, prefix any routes used in your application's layout with `main_app.`, e.g.
 This is required because `ActiveWaiter` is a Rails Engine mounted into your application,
 and it doesn't know about the routes declared within your application.
 
+#### Changing the shared cache
+
+For deploying in production environments, `ActiveWaiter` requires a shared cache to
+track the status of downloads. By default it uses the Rails cache. If you want to
+use something else other than the Rails cache like redis for example, you may specify
+your own implementation:
+
+```ruby
+class RedisStore
+  def write(uid, value)
+    $redis.set("active_waiter:#{uid}", value)
+  end
+
+  def read(uid)
+    $redis.get("active_waiter:#{uid}")
+  end
+end
+
+ActiveWaiter.configure do |config|
+  config.store = RedisStore.new
+end
+```
+
 #### Exceptions
 
 When your job gets an exception, the error message will be written in the error message and passed along

data/app/views/active_waiter/jobs/_reload.html.erb

@@ -1,3 +1,3 @@
 <script>
-  setTimeout(function() { window.location.href = <%= url_for(params.merge(retries: @retries)).to_json.html_safe %>; }, 2000);
+  setTimeout(function() { window.location.href = <%= url_for(params.permit!.merge(retries: @retries)).to_json.html_safe %>; }, 2000);
 </script>

data/lib/active_waiter.rb

@@ -1,4 +1,5 @@
 require "active_waiter/engine"
+require "active_waiter/store"
 require "active_waiter/configuration"
 require "active_waiter/job"
 require "active_waiter/enumerable_job"
@@ -17,11 +18,11 @@ module ActiveWaiter
     end
 
     def write(uid, value)
-      Rails.cache.write("active_waiter:#{uid}", value)
+      ActiveWaiter.configuration.store.write(uid, value)
     end
 
     def read(uid)
-      Rails.cache.read("active_waiter:#{uid}")
+      ActiveWaiter.configuration.store.read(uid)
     end
   end
 end

data/lib/active_waiter/configuration.rb

@@ -12,6 +12,10 @@ module ActiveWaiter
   end
 
   class Configuration
-    attr_accessor :layout
+    attr_accessor :layout, :store
+
+    def initialize
+      @store = ActiveWaiter::Store.new
+    end
   end
 end

data/lib/active_waiter/store.rb

@@ -0,0 +1,11 @@
+module ActiveWaiter
+  class Store
+    def write(uid, value)
+      Rails.cache.write("active_waiter:#{uid}", value)
+    end
+
+    def read(uid)
+      Rails.cache.read("active_waiter:#{uid}")
+    end
+  end
+end

data/lib/active_waiter/version.rb

@@ -1,3 +1,3 @@
 module ActiveWaiter
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: active_waiter
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - choonkeat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2016-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +72,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails-controller-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple mechanism allowing your users to wait for the completion of
   your `ActiveJob`
 email:
@@ -94,6 +114,7 @@ files:
 - lib/active_waiter/engine.rb
 - lib/active_waiter/enumerable_job.rb
 - lib/active_waiter/job.rb
+- lib/active_waiter/store.rb
 - lib/active_waiter/version.rb
 - lib/tasks/waiter_tasks.rake
 homepage: https://github.com/choonkeat/active_waiter
@@ -116,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: ActiveWaiter for background jobs to finish