rack-rabbit 0.5.0

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/unit/**/test_*.rb"
+end

data/bin/rack-rabbit

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+#
+# Run a RackRabbit server.
+#
+
+#==============================================================================
+# PARSE COMMAND LINE OPTIONS
+#==============================================================================
+
+require 'optparse'
+
+action  = :run
+options = { :rabbit => {} }
+
+config_help        = "provide options using a rack-rabbit configuration file"
+queue_help         = "subscribe to a queue for incoming requests"
+exchange_help      = "subscribe to an exchange for incoming requests"
+exchange_type_help = "subscribe to an exchange for incoming requests - type (e.g. :direct, :fanout, :topic)"
+routing_key_help   = "subscribe to an exchange for incoming requests - routing key"
+app_id_help        = "an app_id for this application server"
+host_help          = "the rabbitMQ broker IP address (default: 127.0.0.1)"
+port_help          = "the rabbitMQ broker port (default: 5672)"
+
+workers_help       = "the number of worker processes (default: 1)"
+daemonize_help     = "run daemonized in the background (default: false)"
+pidfile_help       = "the pid filename (default when daemonized: /var/run/<app_id>.pid)"
+logfile_help       = "the log filename (default when daemonized: /var/log/<app_id>.log)"
+log_level_help     = "the log level for rack rabbit output (default: info)"
+preload_help       = "preload the rack app before forking worker processes (default: false)"
+include_help       = "an additional $LOAD_PATH (may be used more than once)"
+debug_help         = "set $DEBUG to true"
+warn_help          = "enable warnings"
+
+op = OptionParser.new
+op.banner =  "A load balanced rack server for hosting rabbitMQ consumer processes."
+op.separator ""
+op.separator "Usage:   rack-rabbit [options] rack-file"
+op.separator ""
+op.separator "Examples:"
+op.separator ""
+op.separator "  rack-rabbit -h broker -q my.queue                          # subscribe to a named queue"
+op.separator "  rack-rabbit -h broker -e my.exchange -t fanout             # subscribe to a fanout exchange"
+op.separator "  rack-rabbit -h broker -e my.exchange -t topic -r my.topic  # subscribe to a topic exchange with a routing key"
+op.separator "  rack-rabbit -c rack-rabbit.conf                            # subscribe with advanced options provided by a config file"
+
+op.separator ""
+op.separator "RackRabbit options:"
+op.on("-c", "--config CONFIG",     config_help)        { |value| options[:config_file]   = value      }
+op.on("-q", "--queue QUEUE",       queue_help)         { |value| options[:queue]         = value      }
+op.on("-e", "--exchange EXCHANGE", exchange_help)      { |value| options[:exchange]      = value      }
+op.on("-t", "--type TYPE",         exchange_type_help) { |value| options[:exchange_type] = value      }
+op.on("-r", "--route ROUTE",       routing_key_help)   { |value| options[:routing_key]   = value      }
+op.on("-a", "--app_id ID",         app_id_help)        { |value| options[:app_id]        = value      }
+op.on(      "--host HOST",         host_help)          { |value| options[:rabbit][:host] = value      }
+op.on(      "--port PORT",         port_help)          { |value| options[:rabbit][:port] = value      }
+
+op.separator ""
+op.separator "Process options:"
+op.on("-w", "--workers COUNT",     workers_help)       { |value| options[:workers]       = value.to_i }
+op.on("-d", "--daemonize",         daemonize_help)     {         options[:daemonize]     = true       }
+op.on("-p", "--pid PIDFILE",       pidfile_help)       { |value| options[:pidfile]       = value      }
+op.on("-l", "--log LOGFILE",       logfile_help)       { |value| options[:logfile]       = value      }
+op.on(      "--log-level LEVEL",   log_level_help)     { |value| options[:log_level]     = value      }
+op.on(      "--preload",           preload_help)       {         options[:preload_app]   = true       }
+
+op.separator ""
+op.separator "Ruby options:"
+op.on("-I", "--include PATH", include_help) { |value| $LOAD_PATH.unshift(*value.split(":").map{|v| File.expand_path(v)}) }
+op.on(      "--debug",        debug_help)   { $DEBUG = true }
+op.on(      "--warn",         warn_help)    { $-w = true    }
+
+op.separator ""
+op.separator "Common options:"
+op.on("-h", "--help")    { action = :help    }
+op.on("-v", "--version") { action = :version }
+
+op.separator ""
+op.parse!(ARGV)
+
+options[:rack_file] = ARGV[0] unless ARGV.empty?
+
+#==============================================================================
+# EXECUTE script
+#==============================================================================
+
+require 'rack-rabbit'
+
+case action
+when :help    then puts op.to_s
+when :version then puts RackRabbit::VERSION
+else
+  RackRabbit.run!(options)
+end
+
+#==============================================================================

data/bin/rr

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+#==============================================================================
+# PARSE COMMAND LINE OPTIONS
+#==============================================================================
+
+require 'optparse'
+
+COMMANDS           = [ :request, :enqueue, :publish ]
+METHODS            = [ :get, :post, :put, :delete ]
+HOST_HELP          = "the rabbitMQ broker IP address (default: 127.0.0.1)"
+PORT_HELP          = "the rabbitMQ broker port (default: 5672)"
+QUEUE_HELP         = "a queue for publishing outgoing requests"
+EXCHANGE_HELP      = "publish to a non-default exchange - name"
+EXCHANGE_TYPE_HELP = "publish to a non-default exchange - type (e.g. :direct, :fanout, :topic)"
+ROUTING_KEY_HELP   = "a routing key when publishing to a non-default exchange"
+INCLUDE_HELP       = "specify an additional $LOAD_PATH (may be used more than once)"
+DEBUG_HELP         = "set $DEBUG to true"
+WARN_HELP          = "enable warnings"
+
+options = { :rabbit => {} }
+parser  = OptionParser.new
+
+parser.banner = "Make a request to a RackRabbit service."
+parser.separator ""
+parser.separator "Usage: rr <command> [options] [METHOD] [PATH] [BODY]"
+parser.separator ""
+parser.separator "list of commands:"
+parser.separator ""
+parser.separator " request      make  a synchronous  request to a rabbitMQ queue and wait for a reply"
+parser.separator " enqueue      make an asynchronous request to a rabbitMQ queue and continue"
+parser.separator " publish      make an asynchronous request to a rabbitMQ exchange with a routing key"
+parser.separator " help         show help for a given topic or a help overview"
+parser.separator " version      show version"
+parser.separator ""
+parser.separator "Examples:"
+parser.separator ""
+parser.separator " rr request -q queue              GET    /hello          # submit GET to queue and WAIT for reply" 
+parser.separator " rr request -q queue              POST   /submit 'data'  # submit POST to queue and WAIT for reply"
+parser.separator " rr enqueue -q queue              POST   /submit 'data'  # submit POST to queue and CONTINUE"
+parser.separator " rr enqueue -q queue              DELETE /resource       # submit DELETE to queue and CONTINUE"
+parser.separator " rr publish -e ex -t fanout       POST   /event          # submit POST to a fanout exchange and CONTINUE"
+parser.separator " rr publish -e ex -t topic -r foo POST   /submit 'data'  # submit POST to a topic exchange with routing key and CONTINUE"
+parser.separator ""
+parser.separator "RackRabbit options:"
+parser.on(      "--host HOST",         HOST_HELP)          { |value| options[:rabbit][:host] = value }
+parser.on(      "--port PORT",         PORT_HELP)          { |value| options[:rabbit][:port] = value }
+parser.on("-q", "--queue QUEUE",       QUEUE_HELP)         { |value| options[:queue]         = value }
+parser.on("-e", "--exchange EXCHANGE", EXCHANGE_HELP)      { |value| options[:exchange]      = value }
+parser.on("-t", "--type TYPE",         EXCHANGE_TYPE_HELP) { |value| options[:exchange_type] = value }
+parser.on("-r", "--route ROUTE",       ROUTING_KEY_HELP)   { |value| options[:routing_key]   = value }
+parser.separator ""
+parser.separator "Ruby options:"
+parser.on("-I", "--include PATH", INCLUDE_HELP) { |value| $LOAD_PATH.unshift(*value.split(":")) }
+parser.on(      "--debug",        DEBUG_HELP)   {         $DEBUG = true }
+parser.on(      "--warn",         WARN_HELP)    {         $-w    = true }
+parser.separator ""
+parser.separator "Common options:"
+parser.on("-h", "--help")    { options[:help]    = true }
+parser.on("-v", "--version") { options[:version] = true }
+parser.separator ""
+
+def pluck(args, values, default = nil)
+  if value = values.find{|v| v.to_s.downcase.to_sym == args[0].to_s.downcase.to_sym }
+    args.delete_at(0)
+    value
+  else
+    default
+  end
+end
+
+parser.parse!(ARGV)
+
+options[:command] = pluck(ARGV, COMMANDS, :request)
+options[:method]  = pluck(ARGV, METHODS,  :get)
+options[:path]    = ARGV.shift
+options[:body]    = ARGV.shift
+
+#==============================================================================
+# EXECUTE script
+#==============================================================================
+
+require 'rack-rabbit/client'
+
+case
+when options[:help]    then puts parser.to_s
+when options[:version] then puts RackRabbit::VERSION
+else
+  case options[:command]
+  when :request then puts RR.request(options[:queue],    options[:path], options[:body], options)
+  when :enqueue then puts RR.enqueue(options[:queue],    options[:path], options[:body], options)
+  when :publish then puts RR.publish(options[:exchange], options[:path], options[:body], options)
+  else
+    puts "Invalid command"
+  end
+end
+
+#==============================================================================

data/lib/rack-rabbit.rb

@@ -0,0 +1,63 @@
+module RackRabbit
+
+  #============================================================================
+  # CONSTANTS
+  #============================================================================
+
+  VERSION = "0.5.0"
+  SUMMARY = "A Unicorn-style forking, rack-based server for hosting rabbitMQ consumer processes"
+
+  DEFAULT_RABBIT = {
+    :host    => "127.0.0.1",
+    :port    => "5672",
+    :adapter => "bunny"
+  }.freeze
+
+  #----------------------------------------------------------------------------
+
+  module HEADER
+    METHOD           = "Request-Method"
+    PATH             = "Request-Path"
+    STATUS           = "Status-Code"
+    CONTENT_TYPE     = "Content-Type"
+    CONTENT_ENCODING = "Content-Encoding"
+  end
+
+  #----------------------------------------------------------------------------
+
+  module STATUS
+    SUCCESS     = 200     # re-purpose common HTTP status codes
+    CREATED     = 201     # ...
+    ACCEPTED    = 202     # ...
+    BAD_REQUEST = 400     # ...
+    NOT_FOUND   = 404     # ...
+    FAILED      = 500     # ...
+  end
+
+  #============================================================================
+  # ENTRY POINT
+  #============================================================================
+
+  def self.run!(options)
+    require 'rack-rabbit/server'
+    Server.new(options).run
+  end
+
+  #============================================================================
+  # HELPER METHODS
+  #============================================================================
+
+  def self.friendly_signal(sig)
+    case sig
+    when :QUIT then "QUIT"
+    when :INT  then "INTERRUPT"
+    when :TERM then "TERMINATE"
+    else
+      sig
+    end
+  end
+
+  #----------------------------------------------------------------------------
+
+end
+

data/lib/rack-rabbit/adapter.rb

@@ -0,0 +1,85 @@
+require 'rack-rabbit/message'
+
+module RackRabbit
+  class Adapter
+
+    #--------------------------------------------------------------------------
+
+    def self.load(options)
+      adapter = options.delete(:adapter) || :bunny
+      if adapter.is_a?(Symbol) || adapter.is_a?(String)
+        adapter = case adapter.to_s.downcase.to_sym
+                  when :bunny
+                    require 'rack-rabbit/adapter/bunny'
+                    RackRabbit::Adapter::Bunny
+                  when :amqp
+                    require 'rack-rabbit/adapter/amqp'
+                    RackRabbit::Adapter::AMQP
+                  when :mock
+                    require 'rack-rabbit/adapter/mock'
+                    RackRabbit::Adapter::Mock
+                  else
+                    raise ArgumentError, "unknown rabbitMQ adapter #{adapter}"
+                  end
+      end
+      adapter.new(options)
+    end
+
+    #--------------------------------------------------------------------------
+
+    attr_reader :connection_options
+
+    def initialize(options)
+      @connection_options = options
+    end
+
+    def startup
+      # derived classes optionally override this (e.g. to startup EventMachine)
+    end
+
+    def shutdown
+      # derived classes optionally override this (e.g. to shutdown EventMachine)
+    end
+
+    def started?
+      true  # derived classes optionally override this (e.g. if running inside EventMachine)
+    end
+
+    def connect
+      raise NotImplementedError, "derived classes must implement this"
+    end
+
+    def disconnect
+      raise NotImplementedError, "derived classes must implement this"
+    end
+
+    def connected?
+      raise NotImplementedError, "derived classes must implement this"
+    end
+
+    def subscribe(options = {}, &block)
+      raise NotImplementedError, "derived classes must implement this"
+    end
+
+    def publish(payload, properties)
+      raise NotImplementedError, "derived classes must implement this"
+    end
+
+    def with_reply_queue(&block)
+      raise NotImplementedError, "derived classes must implement this"
+    end
+
+    #--------------------------------------------------------------------------
+
+    def ack(delivery_tag)
+      raise NotImplementedError, "derived classes must implement this"
+    end
+
+    def reject(delivery_tag)
+      raise NotImplementedError, "derived classes must implement this"
+    end
+
+    #--------------------------------------------------------------------------
+
+  end
+end

data/lib/rack-rabbit/adapter/amqp.rb

@@ -0,0 +1,114 @@
+begin
+  require 'amqp'
+rescue LoadError
+  abort "missing 'amqp' gem"
+end
+
+module RackRabbit
+  class Adapter
+    class AMQP < RackRabbit::Adapter
+
+      attr_accessor :connection, :channel
+
+      def startup
+        startup_eventmachine
+      end
+
+      def shutdown
+        shutdown_eventmachine
+      end
+
+      def started?
+        !@thread.nil?
+      end
+
+      def connect
+        return if connected?
+        @connection = ::AMQP.connect(connection_options)
+        @channel = ::AMQP::Channel.new(connection)
+        channel.prefetch(1)
+      end
+
+      def disconnect
+        channel.close unless channel.nil?
+        connection.close unless connection.nil?
+      end
+
+      def connected?
+        !@connection.nil?
+      end
+
+      def subscribe(options = {}, &block)
+        queue = get_queue(options.delete(:queue)) || channel.queue("", :exclusive => true)
+        exchange = get_exchange(options.delete(:exchange), options.delete(:exchange_type))
+        if exchange
+          queue.bind(exchange, :routing_key => options.delete(:routing_key))
+        end
+        queue.subscribe(options) do |properties, payload|
+          yield Message.new(properties.delivery_tag, properties, payload, self)
+        end
+      end
+
+      def publish(payload, properties)
+        exchange = get_exchange(properties.delete(:exchange), properties.delete(:exchange_type))
+        exchange ||= channel.default_exchange
+        exchange.publish(payload || "", properties)
+      end
+
+      def with_reply_queue
+        channel.queue("", :exclusive => true, :auto_delete => true) do |reply_queue, declare_ok|
+          yield reply_queue
+        end
+      end
+
+      def ack(delivery_tag)
+        channel.acknowledge(delivery_tag, false)
+      end
+
+      def reject(delivery_tag)
+        channel.reject(delivery_tag, false)
+      end
+
+      #========================================================================
+      # PRIVATE IMPLEMENTATION
+      #========================================================================
+
+      private
+
+      def startup_eventmachine
+        raise RuntimeError, "already started" if started?
+        ready = false
+        @thread = Thread.new { EventMachine.run { ready = true } }
+        sleep(1) until ready
+        sleep(1) # warmup
+      end
+
+      def shutdown_eventmachine
+        sleep(1) # warmdown
+        EventMachine.stop
+        @thread = nil
+      end
+
+      def get_exchange(ex = :default, type = :direct)
+        case ex
+        when ::AMQP::Exchange then ex
+        when Symbol, String    then channel.send(type || :direct, ex) unless ex.to_s.downcase.to_sym == :default
+        else
+          nil
+        end
+      end
+
+      def get_queue(q)
+        case q
+        when ::AMQP::Queue then q
+        when Symbol, String then channel.queue(q)
+        else
+          nil
+        end
+      end
+
+      #------------------------------------------------------------------------
+
+    end
+  end
+end