rabbit-wq 0.0.1 → 0.1.0

data/README.md

@@ -22,7 +22,45 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Queueing Work
 
+    class SomeWorker < Struct.new( :some_variable )
+      def call
+        # do some work
+      end
+    end
+    
+    worker = SomeWorker.new( 1 )
+    RabbitWQ::Work.enqueue( worker )
 
-## Contributing
+### Queueing Work in the Future
+
+    RabbitWQ::Work.enqueue( worker, delay: 30000 )
+
+### Queueing Work with a Retry
+
+    RabbitWQ::Work.enqueue( worker, retry: 1 )
+
+### Queueing Work with a Retry and a Retry Delay
+
+    RabbitWQ::Work.enqueue( worker, retry: 1, retry_delay: 30000 )
+
+### Queueing Work with a Retry and Auto-Scaling Retry Dealy
+
+    RabbitWQ::Work.enqueue( worker, retry: 1, retry_delay: 'auto-scale' )
+
+Auto-scale will set up retries at the following intervals: 1 min, 5 mins, 15 mins, 30 mins, 
+1 hr, 6 hrs, 12 hrs, 24 hrs. and 48 hrs.
+
+### Using the Worker Module
+
+    class SomeWorker < Struct.new( :some_variable )
+      include RabbitWQ::Worker
+
+      def call
+        # do some work
+      end
+    end
+    
+    worker = SomeWorker.new( 1 )
+    worker.work # same as RabbitWQ::Work.enqueue( worker )

data/lib/rabbit_wq/command.rb

@@ -0,0 +1,47 @@
+module RabbitWQ
+  class Command
+
+    attr_reader :options
+
+    def initialize( args )
+      @options = {
+        :quiet => true,
+        :pid_dir => "#{Rails.root}/tmp/pids"
+      }
+
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: #{File.basename($0)} [options] start|stop|restart"
+
+        opts.on('-h', '--help', 'Show this message') do
+          puts opts
+          exit 1
+        end
+        opts.on('--pid-dir=DIR', 'Specifies an alternate directory in which to store the process ids.') do |dir|
+          @options[:pid_dir] = dir
+        end
+        opts.on('-i', '--interactive', 'Start the process in interactive mode.') do |n|
+          @options[:interactive] = true
+        end
+      end
+
+      @args = opts.parse!( args )
+    end
+
+    def start
+      if options[:interactive]
+        start_interactive( options )
+      else
+        start_daemonized( options )
+      end
+    end
+
+    def start_interactive( options )
+      server = RabbitWQ::Server.new( options.merge( log: nil ))
+      server.start
+    end
+
+    def start_daemonized( options )
+    end
+
+  end
+end

data/lib/rabbit_wq/logging.rb

@@ -1,3 +1,5 @@
+require 'yell'
+
 module RabbitWQ
   module Logging
 

data/lib/rabbit_wq/message_handler.rb

@@ -1,10 +1,12 @@
 require 'celluloid/autostart'
+require 'yaml'
 
 module RabbitWQ
   class MessageHandler
 
     include Celluloid
     include Logging
+    include Queues
 
     REQUEUE = true
 
@@ -12,18 +14,57 @@ module RabbitWQ
       channel       = options[:channel]
       delivery_info = options[:delivery_info]
       metadata      = options[:metadata]
+      headers       = metadata[:headers]
       payload       = options[:payload]
 
-      info "PAYLOAD ARRIVED #{payload}"
+      debug "PAYLOAD ARRIVED #{payload}"
+
+      $stdout.puts headers.inspect
+      worker = YAML::load( payload )
+      worker.call
       channel.ack delivery_info.delivery_tag
+    rescue => e
+      debug e.message
+      handle_error( e, channel, delivery_info, payload, metadata )
     end
 
   protected
 
+    def handle_error( e, channel, delivery_info, payload, metadata )
+      headers = metadata[:headers]
+
+      if headers['retry']
+        retry_delay = headers.fetch( 'retry_delay', 30000 )
+        attempt = headers.fetch( 'attempt', 1 ).to_i
+
+        if retry_delay == 'auto-scale'
+          retry_delay = retry_delays( attempt )
+        end
+
+        Work.enqueue_payload( payload, headers.merge( delay: retry_delay, attempt: attempt + 1 ))
+        channel.nack delivery_info.delivery_tag
+
+        return
+      end
+    end
+
     def requeue( channel, delivery_info, e=nil )
       info ANSI.yellow { 'REQUEUE ' + e.message }
       channel.reject delivery_info.delivery_tag, REQUEUE
     end
 
+    def retry_delays( retry_num )
+      {
+        1 => 1,
+        2 => 5,
+        3 => 15,
+        4 => 30,
+        5 => 60,
+        6 => 360, # 6 hrs
+        7 => 720, # 12 hrs
+        8 => 1440, # 24 hrs
+        9 => 2880, # 48 hrs
+      }[retry_num] * 60000
+    end
   end
 end

data/lib/rabbit_wq/queues.rb

@@ -0,0 +1,27 @@
+module RabbitWQ
+  module Queues
+
+  protected
+
+    def mq
+      @mq ||= ::Bunny.new.tap do |bunny|
+        bunny.start
+      end
+    end
+
+    def channel
+      @channel ||= mq.create_channel
+    end
+
+    #def work_exchange
+      #@work_exchange ||= channel.direct( WORK_EXCHANGE, durable: true )
+    #end
+
+    #def work_queue
+      #@work_queue ||= channel.queue( QUEUE,
+                                     #durable: true ).
+                              #bind( work_exchange )
+    #end
+
+  end
+end

data/lib/rabbit_wq/server.rb

@@ -3,11 +3,12 @@ require 'bunny'
 module RabbitWQ
   class Server
 
-    include ServerLogging
     include Logging
+    include Queues
+    include ServerLogging
 
-    attr_reader :message_consumer,
-                :options,
+    attr_reader :options,
+                :work_consumer,
                 :work_exchange
 
     def initialize( options )
@@ -29,28 +30,18 @@ module RabbitWQ
 
     def finalize
       info "SHUTTING DOWN"
-      message_consumer.cancel
+      work_consumer.cancel
       mq.close
     end
 
-    def mq
-      @mq ||= ::Bunny.new.tap do |bunny|
-        bunny.start
-      end
-    end
-
-    def channel
-      @channel ||= mq.create_channel
-    end
-
     def work_exchange
       @work_exchange ||= channel.direct( WORK_EXCHANGE, durable: true )
     end
 
-    def queue
-      @queue ||= channel.queue( QUEUE,
-                                durable: true ).
-                         bind( work_exchange )
+    def work_queue
+      @work_queue ||= channel.queue( QUEUE,
+                                     durable: true ).
+                              bind( work_exchange )
     end
 
     def pool
@@ -58,8 +49,8 @@ module RabbitWQ
     end
 
     def run
-      @message_consumer = queue.subscribe( manual_ack: true ) do |delivery_info, metadata, payload|
-        debug "LISTENER RECEIVED #{payload}"
+      @work_consumer = work_queue.subscribe( manual_ack: true ) do |delivery_info, metadata, payload|
+        info "LISTENER RECEIVED #{payload}"
 
         pool.async.call( payload: payload,
                          delivery_info: delivery_info,

data/lib/rabbit_wq/version.rb

@@ -1,3 +1,3 @@
 module RabbitWQ
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/rabbit_wq/work.rb

@@ -4,27 +4,37 @@ module RabbitWQ
   module Work
 
     def self.enqueue( worker, options={} )
-      options[:delay] = nil if options[:delay] && options[:delay] < 5000
+      payload = worker.to_yaml
+      enqueue_payload( payload, options )
+    end
+
+    def self.enqueue_payload( payload, options={} )
+      delay = options.delete( :delay )
+      delay = nil if delay && delay < 5000
 
       mq = ::Bunny.new.tap { |bunny| bunny.start }
       channel = mq.create_channel
 
-      if options[:delay]
-        delay_x = channel.direct( "#{DELAY_EXCHANGE_PREFIX}-#{options[:delay]}ms", durable: true )
-        work_x = channel.direct( WORK_EXCHANGE, durable: true )
-        queue = channel.queue( "#{DELAY_QUEUE_PREFIX}-#{options[:delay]}ms",
-                               durable: true,
-                               arguments: { "x-dead-letter-exchange" => work_x.name,
-                                            "x-message-ttl" => options[:delay] } ).
-                        bind( delay_x )
+      if delay
+        delay_x = channel.direct( "#{DELAY_EXCHANGE_PREFIX}-#{delay}ms", durable: true )
+        work_x  = channel.direct( WORK_EXCHANGE, durable: true )
 
-        delay_x.publish( 'hello', durable: true )
+        channel.queue( "#{DELAY_QUEUE_PREFIX}-#{delay}ms",
+                       durable: true,
+                       arguments: { "x-dead-letter-exchange" => work_x.name,
+                                    "x-message-ttl" => delay } ).
+                bind( delay_x )
+
+        delay_x.publish( payload, durable: true,
+                                  headers: options )
         return
       end
 
       work_q = channel.queue( QUEUE, durable: true )
-      work_q.publish( 'hello', durable: true )
+      work_q.publish( payload, durable: true,
+                               headers: options )
     end
 
+
   end
 end

data/lib/rabbit_wq/worker.rb

@@ -0,0 +1,10 @@
+module RabbitWQ
+  module Worker
+
+    def work( options={} )
+      RabbitWQ::Work.enqueue( self, options )
+      self
+    end
+
+  end
+end

data/lib/rabbit_wq.rb

@@ -4,20 +4,23 @@ module RabbitWQ
 
   APP_ID                = "rabbit-wq"
   APP_NAME              = "Rabbit Work Queue"
-  COMPANY               = "Look Forward Enterprises"
   DELAY_QUEUE_PREFIX    = "work-delay" # TODO: Make this configurable (from ENV, or file?)
   DELAY_EXCHANGE_PREFIX = "work-delay" # TODO: Make this configurable (from ENV, or file?)
+  ERROR_QUEUE           = "work-error"
   INT                   = "INT"
   QUEUE                 = "work" # TODO: Make this configurable (from ENV, or file?)
-  VERSION_COPYRIGHT     = "v#{VERSION} \u00A9#{Time.now.year} #{COMPANY}"
+  VERSION_COPYRIGHT     = "v#{VERSION} \u00A9#{Time.now.year}"
   WORK_EXCHANGE         = "work" # TODO: Make this configurable (from ENV, or file?)
 
+  autoload :Command,        'rabbit_wq/command'
   autoload :Configuration,  'rabbit_wq/configuration'
   autoload :Logging,        'rabbit_wq/logging'
+  autoload :Queues,         'rabbit_wq/queues'
   autoload :MessageHandler, 'rabbit_wq/message_handler'
   autoload :Server,         'rabbit_wq/server'
   autoload :ServerLogging,  'rabbit_wq/server_logging'
   autoload :Work,           'rabbit_wq/work'
+  autoload :Worker,         'rabbit_wq/worker'
 
   def self.configuration
     @configuration ||= Configuration.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabbit-wq
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-27 00:00:00.000000000 Z
+date: 2013-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,13 +126,16 @@ files:
 - lib/rabbit-wq.rb
 - lib/rabbit_wq.rb
 - lib/rabbit_wq/cli.rb
+- lib/rabbit_wq/command.rb
 - lib/rabbit_wq/configuration.rb
 - lib/rabbit_wq/logging.rb
 - lib/rabbit_wq/message_handler.rb
+- lib/rabbit_wq/queues.rb
 - lib/rabbit_wq/server.rb
 - lib/rabbit_wq/server_logging.rb
 - lib/rabbit_wq/version.rb
 - lib/rabbit_wq/work.rb
+- lib/rabbit_wq/worker.rb
 - rabbit-wq.gemspec
 homepage: ''
 licenses:
@@ -149,7 +152,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1285656029023150188
+      hash: 2689177657118754314
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -158,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1285656029023150188
+      hash: 2689177657118754314
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25