kjess 1.0.0

data/lib/kjess/error.rb

@@ -0,0 +1,5 @@
+module KJess
+  class Error < ::StandardError; end
+  class ClientError < Error; end
+  class ServerError < Error; end
+end

data/lib/kjess/protocol.rb

@@ -0,0 +1,76 @@
+module KJess
+  # Protocl is the base class that all Kestrel requests and responses are
+  # developed on. it defines the DSL for creating the Request and Response
+  # objects that make up the Protocol.
+  #
+  class Protocol
+
+    CRLF = "\r\n"
+
+    class << self
+      # Internal: The keyword that starts this protocol message
+      #
+      # name - the keyword to define this portion of the protocol
+      #
+      # Returns the name
+      def keyword( name = nil )
+        if name then
+          register( name )
+          @keyword = name
+        end
+        @keyword
+      end
+
+      # Internal: define or return the arity of this protocol item
+      #
+      # arity - the number of args this protocol item has
+      #
+      # Returns the arity
+      def arity( a = nil )
+        @arity = a if a
+        @arity
+      end
+
+      # Internal: register this protocol item with its registry
+      #
+      # name - the name under which to register the protocol
+      #
+      # Returns nothing
+      def register( name )
+        registry[name] ||= self
+      end
+    end
+
+    attr_reader :args
+    attr_reader :raw_args
+
+    def initialize( opts = {} )
+      @raw_args = opts
+      @args = parse_options_to_args( opts ) || []
+    end
+
+    # Internal: callback that child classes may use to further parse the
+    # initialization arguments
+    #
+    # Returns Array
+    def parse_options_to_args( opts ); end
+
+    # Internal: Convert the object to its protocol serialized format.
+    #
+    # This may be overridden in child classes
+    #
+    # Return a String
+    def to_protocol
+      s = keyword
+      s += " #{args.join(' ')}" unless args.empty?
+      s += CRLF
+    end
+
+    # Internal: return the keyword
+    #
+    # Returns a String
+    def keyword
+      self.class.keyword
+    end
+  end
+end

data/lib/kjess/request.rb

@@ -0,0 +1,31 @@
+module KJess
+  # Request is the base Request Protocol. All Requests made to the Kestrel
+  # server are decendants of this class.
+  #
+  # The Request class holds the registry of all the Request decendent classes.
+  class Request < Protocol
+    Registry = Hash.new
+
+    def self.registry
+      Registry
+    end
+
+    def self.valid_responses( list = nil )
+      @valid_responses = [ list ].flatten if list
+      @valid_responses
+    end
+  end
+end
+require 'kjess/response'
+require 'kjess/request/flush'
+require 'kjess/request/flush_all'
+require 'kjess/request/delete'
+require 'kjess/request/dump_stats'
+require 'kjess/request/get'
+require 'kjess/request/quit'
+require 'kjess/request/reload'
+require 'kjess/request/set'
+require 'kjess/request/shutdown'
+require 'kjess/request/stats'
+require 'kjess/request/status'
+require 'kjess/request/version'

data/lib/kjess/request/delete.rb

@@ -0,0 +1,11 @@
+class KJess::Request
+  class Delete < KJess::Request
+    keyword 'DELETE'
+    arity   1
+    valid_responses [ KJess::Response::Deleted, KJess::Response::NotFound ]
+
+    def parse_options_to_args( opts )
+      [ opts[:queue_name] ]
+    end
+  end
+end

data/lib/kjess/request/dump_stats.rb

@@ -0,0 +1,7 @@
+class KJess::Request
+  class DumpStats < KJess::Request
+    keyword 'DUMP_STATS'
+    arity   0
+    valid_responses [ KJess::Response::DumpedStats ]
+  end
+end

data/lib/kjess/request/flush.rb

@@ -0,0 +1,11 @@
+class KJess::Request
+  class Flush < KJess::Request
+    keyword 'FLUSH'
+    arity   1
+    valid_responses [ KJess::Response::End ]
+
+    def parse_options_to_args( opts )
+      [ opts[:queue_name] ]
+    end
+  end
+end

data/lib/kjess/request/flush_all.rb

@@ -0,0 +1,7 @@
+class KJess::Request
+  class FlushAll < KJess::Request
+    keyword 'FLUSH_ALL'
+    arity    0
+    valid_responses [ KJess::Response::FlushedAllQueues ]
+  end
+end

data/lib/kjess/request/get.rb

@@ -0,0 +1,21 @@
+class KJess::Request
+  class Get < KJess::Request
+    keyword 'GET'
+    arity   1
+    valid_responses [ KJess::Response::Value ]
+
+    def parse_options_to_args( opts )
+      a = [ opts[:queue_name] ]
+
+      a << "t=#{opts[:wait_for]}" if opts[:wait_for]
+
+      [ :open, :close, :abort, :peek ].each do |o|
+        a << o.to_s if opts[o]
+      end
+
+      [ a.join("/") ]
+    end
+  end
+end
+
+

data/lib/kjess/request/quit.rb

@@ -0,0 +1,7 @@
+class KJess::Request
+  class Quit < KJess::Request
+    keyword 'QUIT'
+    arity   0
+    valid_responses [ KJess::Response::Eof ]
+  end
+end

data/lib/kjess/request/reload.rb

@@ -0,0 +1,7 @@
+class KJess::Request
+  class Reload < KJess::Request
+    keyword 'RELOAD'
+    arity   0
+    valid_responses [ KJess::Response::ReloadedConfig ]
+  end
+end

data/lib/kjess/request/set.rb

@@ -0,0 +1,19 @@
+class KJess::Request
+  class Set < KJess::Request
+    keyword 'SET'
+    arity   4
+    valid_responses [ KJess::Response::Stored, KJess::Response::NotStored ]
+
+    attr_reader :data
+
+    def parse_options_to_args( opts )
+      @data = opts[:data].to_s
+      [ opts[:queue_name], 0, opts[:expiration] || 0 , data.bytesize ]
+    end
+
+    def to_protocol
+      s = super
+      s += "#{data}#{CRLF}"
+    end
+  end
+end

data/lib/kjess/request/shutdown.rb

@@ -0,0 +1,7 @@
+class KJess::Request
+  class Shutdown < KJess::Request
+    keyword 'SHUTDOWN'
+    arity   0
+    valid_responses [ KJess::Response::Eof ]
+  end
+end

data/lib/kjess/request/stats.rb

@@ -0,0 +1,7 @@
+class KJess::Request
+  class Stats < KJess::Request
+    keyword 'STATS'
+    arity   0
+    valid_responses [ KJess::Response::Stats ]
+  end
+end

data/lib/kjess/request/status.rb

@@ -0,0 +1,8 @@
+class KJess::Request
+  # This is not yet in a released version of Kestrel
+  class Status < KJess::Request
+    keyword 'STATUS'
+    arity   1
+    #valid_responses [ KJess::Response::Eof ]
+  end
+end

data/lib/kjess/request/version.rb

@@ -0,0 +1,8 @@
+require 'kjess/response'
+class KJess::Request
+  class Version < KJess::Request
+    keyword         'VERSION'
+    arity           0
+    valid_responses KJess::Response::Version
+  end
+end

data/lib/kjess/response.rb

@@ -0,0 +1,76 @@
+module KJess
+  # Response is the parent class of all Response derived objects that come back
+  # from the Kestrel server. It holds the registry of all the Response objects
+  # and is responsible for parsing the initial line from the Kestrel server and
+  # determinig which Response child object to instantiate.
+  class Response < Protocol
+    arity 0
+
+    Registry = Hash.new
+    def self.registry
+      Registry
+    end
+
+    # Internal: parse the string and create the appropriate Response child
+    # object.
+    #
+    # str - a String from the Kestrel server
+    #
+    # Returns a new Response child object
+    def self.parse( str )
+      keyword, *args = str.strip.split
+      klass = Registry.fetch( keyword, KJess::Response::Unknown )
+      klass.new( args )
+    end
+
+    # Internal: callback to create the @args member
+    #
+    # opts - the opts that were passed to initialize
+    #
+    # Returns an Array
+    def parse_options_to_args( opts )
+      [ opts ].flatten
+    end
+
+    # Internal: create the human readable version of this response
+    #
+    # Returns a String
+    def message
+      [ keyword, raw_args ].flatten.join(' ')
+    end
+
+    # Internal: callback that is used by some Responses that have more complex
+    # response creation.
+    #
+    # connection - the KJess::Connection object to continue to read from
+    #
+    # Returns nothing
+    def read_more( connection ); end
+
+    # Internal: is this Response object an error object.
+    #
+    # This is overwritte in those objects that create Exceptions
+    #
+    # Returns false
+    def error?
+      false
+    end
+  end
+end
+
+require 'kjess/response/client_error'
+require 'kjess/response/deleted'
+require 'kjess/response/dumped_stats'
+require 'kjess/response/end'
+require 'kjess/response/eof'
+require 'kjess/response/error'
+require 'kjess/response/flushed_all_queues'
+require 'kjess/response/not_found'
+require 'kjess/response/not_stored'
+require 'kjess/response/reloaded_config'
+require 'kjess/response/server_error'
+require 'kjess/response/stats'
+require 'kjess/response/stored'
+require 'kjess/response/unknown'
+require 'kjess/response/value'
+require 'kjess/response/version'

data/lib/kjess/response/client_error.rb

@@ -0,0 +1,19 @@
+require 'kjess/error'
+class KJess::Response
+  class ClientError < KJess::Response
+    keyword 'CLIENT_ERROR'
+    arity    1
+
+    def message
+      args.join(' ')
+    end
+
+    def error?
+      true
+    end
+
+    def exception
+      KJess::ClientError.new( message )
+    end
+  end
+end

data/lib/kjess/response/deleted.rb

@@ -0,0 +1,5 @@
+class KJess::Response
+  class Deleted < KJess::Response
+    keyword 'DELETED'
+  end
+end

data/lib/kjess/response/dumped_stats.rb

@@ -0,0 +1,48 @@
+class KJess::Response
+  class DumpedStats < KJess::Response
+    keyword 'queue'
+    arity    2
+
+    attr_accessor :data
+
+    # Internal: Read the extra data from the value
+    #
+    # Read the datablock that is after the value and then the final END marker.
+    #
+    # Returns nothing
+    def read_more( connection )
+      queue_line_re = /\Aqueue\s+'(\S+)' \{\Z/
+      stat_line_re  = /\A(\w+)=(\S+)\Z/
+      stats         = Hash.new
+      line          = message.strip
+      current_queue = nil
+
+      begin
+        line.strip!
+        if md = stat_line_re.match( line ) then
+          stats[current_queue][md.captures[0]] = convert_value( md.captures[1] )
+        elsif md = queue_line_re.match( line ) then
+          current_queue = md.captures.first
+          stats[current_queue] = Hash.new
+        elsif line == "}" then
+          current_queue = nil
+        elsif line == "END" then
+          break
+        else
+          # do nothing -- empty line
+        end
+      end while line = connection.readline
+      @data = stats
+    end
+
+    def convert_value( value )
+      if value =~ /\A\d+\Z/ then
+        Float( value ).to_i
+      elsif value =~ /\A\d+\.\d+\Z/
+        Float( value )
+      else
+        value
+      end
+    end
+  end
+end

data/lib/kjess/response/end.rb

@@ -0,0 +1,5 @@
+class KJess::Response
+  class End < KJess::Response
+    keyword 'END'
+  end
+end

data/lib/kjess/response/eof.rb

@@ -0,0 +1,5 @@
+class KJess::Response
+  class Eof < KJess::Response
+    keyword 'EOF'
+  end
+end

data/lib/kjess/response/error.rb

@@ -0,0 +1,13 @@
+class KJess::Response
+  class Error < KJess::Response
+    keyword 'ERROR'
+
+    def error?
+      true
+    end
+
+    def exception
+      raise KJess::Error
+    end
+  end
+end

data/lib/kjess/response/flushed_all_queues.rb

@@ -0,0 +1,6 @@
+class KJess::Response
+  class FlushedAllQueues < KJess::Response
+    keyword 'Flushed'
+    arity    2 # 'all queues.'
+  end
+end