activejob_disque_adapter 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf837908a2b09ae4eeaa6070e358602a58573f56
-  data.tar.gz: 9faa17b8dd76fcd5f4dc3b41e64e05f79d3cc591
+  metadata.gz: 2352c90c6cef05344971d8a1e0eb428f4a2d51e2
+  data.tar.gz: b3f180d5e6ee0306d1877bd0f976df34950d6d00
 SHA512:
-  metadata.gz: a22a16531b5cb3fb978e90823ac9e66939f210eaa2d18c0a9d9c144e2c9904ecbad65ddd728d5159d08cbbc931a65d89d6e9ccdf3cc5cba90f6aad9b781fbc19
-  data.tar.gz: 616f08c902ff86c3109808a8653db030d660c02b779ebebffda513c5df9473fba462e2974ea749e48ebe3af1c06ef08ff3b26145718f4e80887b844290f4dd25
+  metadata.gz: efdc2b46c01b8869665704fe1e5fa367a88837227fd7bdaf74bc119825226f5915f91bc86bf7c71b82961a8735046527a5d8123e6833afbe6ba5a5f8baa5e2f2
+  data.tar.gz: 819e1e9b9e3e77397fa5aa4f58b2e6f0a99eb102fb5848a65fe8d17bae76f3b354b780f20b88e4083838654d99ae26659fec1b8993872f3b331130910f6b946f

data/README.md

@@ -0,0 +1,66 @@
+## Rails <3 Disque
+
+This gem provides a simple way to use [antirez](http://antirez.com/)'s [Disque](https://github.com/antirez/disque) as a backend for your Rails [ActiveJob](http://edgeguides.rubyonrails.org/active_job_basics.html) workers.
+
+
+### Installation and Setup
+
+Add this gem to your Gemfile.
+
+```ruby
+gem 'rails', '4.2.3'
+gem 'activejob_disque_adapter'
+```
+
+And set your Rails application to use it in `config/application.rb` (or `config/environments/*`, depending on your preference)
+
+```ruby
+module YourApp
+  class Application < Rails::Application
+    config.active_job.queue_adapter = :disque
+  end
+end
+```
+
+That's all you need! You can then go on to write standard ActiveJob classes, which will be enqueued to Disque when you call `#perform_later` on them.
+
+
+## Running your jobs
+
+This gem also includes a handy class called `Disque::ActiveJobWorker` and a rake task that leverages it. In order to run your jobs you can simply call `rake disque:work` from your Procfile, like so:
+
+```Procfile
+disque_high: DISQUE_QUEUES=urgent  rake disque:work
+disque_all: DISQUE_QUEUES=urgent,medium,low rake disque:work
+```
+
+## Configuration
+
+You can configure the Disque adapter and Worker programatically or via environment variables, this is the list of configurable parameters:
+
+| Parameter | ENV Variable    |  Default Value   | Description
+|:---------:|:---------------:|:-----------------|:-----------:|
+| Nodes     | DISQUE_NODES    | 'localhost:7711' | This is the list of Disque servers to connect to, it can be a single node, a list of comma-separated nodes or an array of nodes (when done programatically) |
+| Auth      | DISQUE_AUTH     | ''               | Authorization credentials for Disque. |
+| Timeout   | DISQUE_TIMEOUT  | '100'            | Time in milliseconds that the client will wait for the Disque server to acknowledge and replicate a job |
+| Cycle     | DISQUE_CYCLE    | '1000'           | The client keeps track of which nodes are providing more jobs, after the amount of operations specified in cycle it tries to connect to the preferred node. |
+| Queues    | DISQUE_QUEUES   | 'default'        | The list of queues that `Disque::ActiveJobWorker` will listen to, it can be a single queue name, a list of comma-separated queues or an array of queue names (when done programatically) |
+
+
+
+#### Environment Variables
+
+```.env
+DISQUE_QUEUES="urgent,medium,low"
+DISQUE_NODES="localhost:7711,localhost:8822"
+DISQUE_TIMEOUT=200
+```
+
+#### Programatically
+
+```Ruby
+# Keep in mind #run is a blocking action, it will loop through the queues finding jobs to execute.
+Disque::ActiveJobWorker.new(
+  queues: %w(urgent medium)
+).run
+```

data/activejob_disque_adapter.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "activejob_disque_adapter"
-  s.version           = "0.0.2"
+  s.version           = "0.0.3"
   s.summary           = "ActiveJob adapter for Disque backends"
   s.description       = "Fills the gap between ActiveJob and Disque"
   s.authors           = ["pote"]
@@ -11,5 +11,6 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n")
 
   s.add_dependency "disque"
+  s.add_dependency "activesupport"
   s.add_development_dependency "cutest"
 end

data/lib/active_job/queue_adapters/disque_adapter.rb

@@ -1,4 +1,5 @@
 require 'disque'
+require 'active_support/json'
 
 module ActiveJob
   module QueueAdapters
@@ -6,7 +7,7 @@ module ActiveJob
       def self.enqueue(job)
         client.push(
           job.queue_name,
-          job.serialize,
+          ActiveSupport::JSON.encode(job.serialize),
           @disque_timeout
         )
       end
@@ -14,7 +15,7 @@ module ActiveJob
       def self.enqueue_at(job, timestamp)
         client.push(
           job.queue_name,
-          job.serialize,
+          ActiveSupport::JSON.encode(job.serialize),
           @disque_timeout,
           delay: timestamp.to_i - Time.now.to_i
         )
@@ -26,7 +27,7 @@ module ActiveJob
         @disque_client ||= client || Disque.new(
           ENV.fetch('DISQUE_NODES', 'localhost:7711'),
           auth: ENV.fetch('DISQUE_AUTH', nil),
-          cycle: ENV.fetch('DISQUE_CYCLE', '20000').to_i
+          cycle: ENV.fetch('DISQUE_CYCLE', '1000').to_i
         )
       end
     end

data/lib/activejob_disque_adapter.rb

@@ -0,0 +1,8 @@
+require 'active_job/queue_adapters/disque_adapter'
+require 'disque/active_job_worker'
+
+class Disque::WorkTask < Rails::Railtie
+  rake_tasks do
+    load 'disque/tasks/work.rake'
+  end
+end

data/lib/{active_job/disque_worker.rb → disque/active_job_worker.rb}

@@ -1,9 +1,8 @@
-require 'activesupport'
 require 'disque'
-require 'json'
+require 'active_support/json'
 
-module ActiveJob
-  class DisqueWorker
+class Disque
+  class ActiveJobWorker
     attr_reader :disque_client,
                 :disque_queues,
                 :disque_timeout,
@@ -20,7 +19,18 @@ module ActiveJob
         cycle: ENV.fetch('DISQUE_CYCLE', '20000').to_i
       )
 
-      @disque_queues = (queues || ENV.fetch('DISQUE_QUEUES','default')).split(',')
+      @disque_queues = case
+                       when queues.is_a?(Array)
+                         queues
+                       when queues.is_a?(String)
+                         queues.split(',')
+                       when queues.nil?
+                        ENV.fetch('DISQUE_QUEUES', 'default').split(',')
+                       else
+                        raise 'Invalid Disque Queues'
+                       end
+
+
       @disque_count = count
       @disque_timeout = timeout
 
@@ -34,11 +44,9 @@ module ActiveJob
           timeout: disque_timeout,
           count: disque_count
         ) do |serialized_job, _|
-          job = JSON.parse(serialized_job)
-          puts "Processing Job: #{ job }"
-          klass = job.fetch('job_class').classify.constantize
-          klass.new(job.fetch('arguments')).perform_now
-          puts "Done"
+          ActiveJob::Base.deserialize(
+            ActiveSupport::JSON.decode(serialized_job)
+          ).perform_now
         end
       end
     end

data/lib/disque/tasks/work.rake

@@ -0,0 +1,9 @@
+require 'disque/active_job_worker'
+
+namespace :disque do
+  desc 'Listens to and executes ActiveJob Disque jobs'
+  task work: :environment do
+    Disque::ActiveJobWorker.run
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob_disque_adapter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - pote
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2015-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: disque
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cutest
   requirement: !ruby/object:Gem::Requirement
@@ -46,11 +60,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- README.md
 - activejob_disque_adapter.gemspec
-- lib/active_job.rb
-- lib/active_job/disque_worker.rb
-- lib/active_job/queue_adapters.rb
 - lib/active_job/queue_adapters/disque_adapter.rb
+- lib/activejob_disque_adapter.rb
+- lib/disque/active_job_worker.rb
+- lib/disque/tasks/work.rake
 homepage: https://github.com/pote/activejob_disque_adapter
 licenses:
 - MIT

data/lib/active_job.rb

@@ -1,6 +0,0 @@
-require 'activesupport'
-
-module ActiveJob
-  extend ActiveSupport::Autoload
-  autoload :DisqueWorker
-end

data/lib/active_job/queue_adapters.rb

@@ -1,4 +0,0 @@
-module ActiveJob::QueueAdapters
-  extend ActiveSupport::Autoload
-  autoload :DisqueAdapter
-end