beaneater 0.3.0 → 1.1.0

data/lib/beaneater/errors.rb

@@ -1,4 +1,4 @@
-module Beaneater
+class Beaneater
   # Raises when a beanstalkd instance is no longer accessible.
   class NotConnected < RuntimeError; end
   # Raises when the tube name specified is invalid.
@@ -66,11 +66,11 @@ module Beaneater
   # Raises when a command was sent that is unknown.
   class UnknownCommandError < UnexpectedResponse; end
   # Raises when command does not have proper CRLF suffix.
-  class ExpectedCRLFError < UnexpectedResponse; end
+  class ExpectedCrlfError < UnexpectedResponse; end
   # Raises when the body of a job was too large.
   class JobTooBigError < UnexpectedResponse; end
-  # Raises when a job was attempted to be reserved but the timeout occured.
+  # Raises when a job was attempted to be reserved but the timeout occurred.
   class TimedOutError < UnexpectedResponse; end
   # Raises when a tube could not be ignored because it is the last watched tube.
   class NotIgnoredError < UnexpectedResponse; end
-end
+end

data/lib/beaneater/job/collection.rb

@@ -1,14 +1,18 @@
-module Beaneater
+class Beaneater
   # Exception to stop processing jobs during a `process!` loop.
   # Simply `raise AbortProcessingError` in any job process handler to stop the processing loop.
   class AbortProcessingError < RuntimeError; end
 
   # Represents collection of job-related commands.
-  class Jobs < PoolCommand
+  class Jobs
 
     # @!attribute processors
     #   @return [Array<Proc>] returns Collection of proc to handle beanstalkd jobs
-    attr_reader :processors
+    # @!attribute client
+    #   @return [Beaneater] returns the client instance
+    # @!attribute current_job
+    #   @return [Beaneater] returns the currently processing job in the process loop
+    attr_reader :processors, :client, :current_job
 
     # Number of retries to process a job.
     MAX_RETRIES = 3
@@ -16,39 +20,44 @@ module Beaneater
     # Delay in seconds before to make job ready again.
     RELEASE_DELAY = 1
 
-    # Peek (or find) first job from beanstalkd pool.
+    # Number of seconds to wait for a job before checking a different server.
+    RESERVE_TIMEOUT = nil
+
+    # Creates new jobs instance.
     #
-    # @param [Integer] id Job id to find
-    # @return [Beaneater::Job] Job matching given id
+    # @param [Beaneater] client The beaneater client instance.
     # @example
-    #   @beaneater_pool.jobs[123] # => <Beaneater::Job>
-    #   @beaneater_pool.jobs.find(123) # => <Beaneater::Job>
-    #   @beaneater_pool.jobs.peek(123) # => <Beaneater::Job>
+    #  Beaneater::Jobs.new(@client)
     #
-    # @api public
-    def find(id)
-      res = transmit_until_res("peek #{id}", :status => "FOUND")
-      Job.new(res)
-    rescue Beaneater::NotFoundError => ex
-      nil
+    def initialize(client)
+      @client = client
+    end
+
+    # Delegates transmit to the connection object.
+    #
+    # @see Beaneater::Connection#transmit
+    def transmit(command, options={})
+      client.connection.transmit(command, options)
     end
-    alias_method :peek, :find
-    alias_method :[], :find
 
-    # Find all jobs with specified id fromm all beanstalkd servers in pool.
+    # Peek (or find) job by id from beanstalkd.
     #
     # @param [Integer] id Job id to find
-    # @return [Array<Beaneater::Job>] Jobs matching given id
+    # @return [Beaneater::Job] Job matching given id
     # @example
-    #   @beaneater_pool.jobs.find_all(123) # => [<Beaneater::Job>, <Beaneater::Job>]
+    #   @beaneater.jobs[123] # => <Beaneater::Job>
+    #   @beaneater.jobs.find(123) # => <Beaneater::Job>
+    #   @beaneater.jobs.peek(123) # => <Beaneater::Job>
     #
     # @api public
-    def find_all(id)
-      res = transmit_to_all("peek #{id}")
-      res.compact.map { |r| Job.new(r) }
-    rescue Beaneater::NotFoundError => ex
-      []
+    def find(id)
+      res = transmit("peek #{id}")
+      Job.new(client, res)
+    rescue Beaneater::NotFoundError
+      nil
     end
+    alias_method :peek, :find
+    alias_method :[], :find
 
     # Register a processor to handle beanstalkd job on particular tube.
     #
@@ -75,31 +84,52 @@ module Beaneater
       @processors[tube_name.to_s] = { :block => block, :retry_on => retry_on, :max_retries => max_retries }
     end
 
+    # Sets flag to indicate that process loop should stop after current job
+    def stop!
+      @stop = true
+    end
+
+    # Returns whether the process loop should stop
+    #
+    # @return [Boolean] if true the loop should stop after current processing
+    def stop?
+      !!@stop
+    end
+
     # Watch, reserve, process and delete or bury or release jobs.
     #
     # @param [Hash{String => Integer}] options Settings for processing
     # @option options [Integer] release_delay Delay in seconds before to make job ready again
+    # @option options [Integer] reserve_timeout Number of seconds to wait for a job before checking a different server
     #
     # @api public
     def process!(options={})
       release_delay = options.delete(:release_delay) || RELEASE_DELAY
-      tubes.watch!(*processors.keys)
-      loop do
-        job = tubes.reserve
-        processor = processors[job.tube]
+      reserve_timeout = options.delete(:reserve_timeout) || RESERVE_TIMEOUT
+      client.tubes.watch!(*processors.keys)
+      while !stop? do
         begin
-          processor[:block].call(job)
-          job.delete
+          @current_job = client.tubes.reserve(reserve_timeout)
+          processor = processors[@current_job.tube]
+          begin
+            processor[:block].call(@current_job)
+            @current_job.delete
+          rescue *processor[:retry_on]
+            if @current_job.stats.releases < processor[:max_retries]
+              @current_job.release(:delay => release_delay)
+            end
+          end
         rescue AbortProcessingError
           break
-        rescue *processor[:retry_on]
-          job.release(:delay => release_delay) if job.stats.releases < processor[:max_retries]
-        rescue StandardError => e # handles unspecified errors
-          job.bury
+        rescue Beaneater::JobNotReserved, Beaneater::NotFoundError, Beaneater::TimedOutError
+          retry
+        rescue StandardError # handles unspecified errors
+          @current_job.bury if @current_job
         ensure # bury if still reserved
-          job.bury if job.exists? && job.reserved?
+          @current_job.bury if @current_job && @current_job.exists? && @current_job.reserved?
+          @current_job = nil
         end
       end
     end # process!
   end # Jobs
-end # Beaneater
+end # Beaneater

data/lib/beaneater/job/record.rb

@@ -1,4 +1,4 @@
-module Beaneater
+class Beaneater
   # Represents job related commands.
   class Job
 
@@ -6,21 +6,21 @@ module Beaneater
     #   @return [Integer] id for the job.
     # @!attribute body
     #   @return [String] the job's body.
-    # @!attribute connection
-    #   @return [Beaneater::Connection] connection which has retrieved job.
     # @!attribute reserved
     #   @return [Boolean] whether the job has been reserved.
-    attr_reader :id, :body, :connection, :reserved
+    # @!attribute client
+    #   @return [Beaneater] returns the client instance
+    attr_reader :id, :body, :reserved, :client
 
 
     # Initializes a new job object.
     #
     # @param [Hash{Symbol => String,Number}] res Result from beanstalkd response
     #
-    def initialize(res)
+    def initialize(client, res)
+      @client     = client
       @id         = res[:id]
       @body       = res[:body]
-      @connection = res[:connection]
       @reserved   = res[:status] == 'RESERVED'
     end
 
@@ -28,9 +28,11 @@ module Beaneater
     #
     # @param [Hash{Symbol => Integer}] options Settings to bury job
     # @option options [Integer] pri Assign new priority to job
+    # @return [Hash{Symbol => String,Number}] Beanstalkd response for the command.
     #
     # @example
-    #   @beaneater_connection.bury({:pri => 100})
+    #   @job.bury({:pri => 100})
+    #     # => {:status=>"BURIED", :body=>nil}
     #
     # @api public
     def bury(options={})
@@ -45,8 +47,10 @@ module Beaneater
     # @param [Hash{String => Integer}] options Settings to release job
     # @option options [Integer] pri Assign new priority to job
     # @option options [Integer] delay Assign new delay to job
+    # @return [Hash{Symbol => String,Number}] Beanstalkd response for the command.
     # @example
-    #   @beaneater_connection.jobs.find(123).release(:pri => 10, :delay => 5)
+    #   @beaneater.jobs.find(123).release(:pri => 10, :delay => 5)
+    #     # => {:status=>"RELEASED", :body=>nil}
     #
     # @api public
     def release(options={})
@@ -58,8 +62,10 @@ module Beaneater
 
     # Sends command to touch job which extends the ttr.
     #
+    # @return [Hash{Symbol => String,Number}] Beanstalkd response for the command.
     # @example
-    #   @beaneater_connection.jobs.find(123).touch
+    #   @beaneater.jobs.find(123).touch
+    #     # => {:status=>"TOUCHED", :body=>nil}
     #
     # @api public
     def touch
@@ -68,8 +74,10 @@ module Beaneater
 
     # Sends command to delete a job.
     #
+    # @return [Hash{Symbol => String,Number}] Beanstalkd response for the command.
     # @example
-    #   @beaneater_connection.jobs.find(123).delete
+    #   @beaneater.jobs.find(123).delete
+    #     # => {:status=>"DELETED", :body=>nil}
     #
     # @api public
     def delete
@@ -78,8 +86,10 @@ module Beaneater
 
     # Sends command to kick a buried job.
     #
+    # @return [Hash{Symbol => String,Number}] Beanstalkd response for the command.
     # @example
-    #   @beaneater_connection.jobs.find(123).kick
+    #   @beaneater.jobs.find(123).kick
+    #     # => {:status=>"KICKED", :body=>nil}
     #
     # @api public
     def kick
@@ -90,7 +100,7 @@ module Beaneater
     #
     # @return [Beaneater::StatStruct] struct filled with relevant job stats
     # @example
-    #   @beaneater_connection.jobs.find(123).stats
+    #   @beaneater.jobs.find(123).stats
     #   @job.stats.tube # => "some-tube"
     #
     # @api public
@@ -103,7 +113,7 @@ module Beaneater
     #
     # @return [Boolean] Returns true if the job is in a reserved state
     # @example
-    #   @beaneater_connection.jobs.find(123).reserved?
+    #   @beaneater.jobs.find(123).reserved?
     #
     # @api public
     def reserved?
@@ -114,7 +124,7 @@ module Beaneater
     #
     # @return [Boolean] Returns true if the job still exists
     # @example
-    #   @beaneater_connection.jobs.find(123).exists?
+    #   @beaneater.jobs.find(123).exists?
     #
     # @api public
     def exists?
@@ -127,52 +137,54 @@ module Beaneater
     #
     # @return [String] The name of the tube for this job
     # @example
-    #   @beaneater_connection.jobs.find(123).tube
+    #   @beaneater.jobs.find(123).tube
     #     # => "some-tube"
     #
+    # @api public
     def tube
-      self.stats && self.stats.tube
+      @tube ||= self.stats.tube
     end
 
     # Returns the ttr of this job
     #
-    # @return [String] The ttr of this job
+    # @return [Integer] The ttr of this job
     # @example
-    #   @beaneater_connection.jobs.find(123).ttr
+    #   @beaneater.jobs.find(123).ttr
     #     # => 123
     #
+    # @api public
     def ttr
-      self.stats && self.stats.ttr
+      @ttr ||= self.stats.ttr
     end
 
     # Returns the pri of this job
     #
-    # @return [String] The pri of this job
+    # @return [Integer] The pri of this job
     # @example
-    #   @beaneater_connection.jobs.find(123).pri
+    #   @beaneater.jobs.find(123).pri
     #     # => 1
     #
     def pri
-      self.stats && self.stats.pri
+      self.stats.pri
     end
 
     # Returns the delay of this job
     #
-    # @return [String] The delay of this job
+    # @return [Integer] The delay of this job
     # @example
-    #   @beaneater_connection.jobs.find(123).delay
+    #   @beaneater.jobs.find(123).delay
     #     # => 5
     #
     def delay
-      self.stats && self.stats.delay
+      self.stats.delay
     end
 
     # Returns string representation of job
     #
     # @return [String] string representation
     # @example
-    #   @beaneater_connection.jobs.find(123).to_s
-    #   @beaneater_connection.jobs.find(123).inspect
+    #   @beaneater.jobs.find(123).to_s
+    #   @beaneater.jobs.find(123).inspect
     #
     def to_s
       "#<Beaneater::Job id=#{id} body=#{body.inspect}>"
@@ -181,7 +193,7 @@ module Beaneater
 
     protected
 
-    # Transmit command to beanstalkd instances and fetch response.
+    # Transmit command to beanstalkd instance and fetch response.
     #
     # @param [String] cmd Beanstalkd command to send.
     # @return [Hash{Symbol => String,Number}] Beanstalkd response for the command.
@@ -190,7 +202,7 @@ module Beaneater
     #  transmit('stats') { 'success' }
     #
     def transmit(cmd, &block)
-      res = connection.transmit(cmd)
+      res = client.connection.transmit(cmd)
       yield if block_given?
       res
     end
@@ -209,4 +221,4 @@ module Beaneater
     end
 
   end # Job
-end # Beaneater
+end # Beaneater

data/lib/beaneater/stats.rb

@@ -1,9 +1,24 @@
 require 'beaneater/stats/fast_struct'
 require 'beaneater/stats/stat_struct'
 
-module Beaneater
+class Beaneater
   # Represents stats related to the beanstalkd pool.
-  class Stats < PoolCommand
+  class Stats
+
+    # @!attribute client
+    #   @return [Beaneater] returns the client instance
+    attr_reader :client
+
+    # Creates new stats instance.
+    #
+    # @param [Beaneater] client The beaneater client instance.
+    # @example
+    #  Beaneater::Stats.new(@client)
+    #
+    def initialize(client)
+      @client = client
+    end
+
     # Returns keys for stats data
     #
     # @return [Array<String>] Set of keys for stats.
@@ -26,6 +41,14 @@ module Beaneater
       data[key]
     end
 
+    # Delegates inspection to the real data structure
+    #
+    # @return [String] returns a string containing a detailed stats summary
+    def inspect
+      data.to_s
+    end
+    alias :to_s :inspect
+
     # Defines a cached method for looking up data for specified key
     # Protects against infinite loops by checking stacktrace
     # @api public
@@ -42,15 +65,15 @@ module Beaneater
 
     protected
 
-    # Returns struct based on stats data merged from all connections.
+    # Returns struct based on stats data from response.
     #
-    # @return [Beaneater::StatStruct] the combined stats for all beanstalk connections in the pool
+    # @return [Beaneater::StatStruct] the stats
     # @example
     #  self.data # => { 'version' : 1.7, 'total_connections' : 23 }
     #  self.data.total_connections # => 23
     #
     def data
-      StatStruct.from_hash(transmit_to_all('stats', :merge => true)[:body])
+      StatStruct.from_hash(client.connection.transmit('stats')[:body])
     end
   end # Stats
 end # Beaneater

data/lib/beaneater/stats/fast_struct.rb

@@ -1,4 +1,4 @@
-module Beaneater
+class Beaneater
   #
   # Borrowed from:
   # https://github.com/dolzenko/faster_open_struct/blob/master/lib/faster_open_struct.rb

data/lib/beaneater/stats/stat_struct.rb

@@ -1,4 +1,4 @@
-module Beaneater
+class Beaneater
   # Represents a stats hash with proper underscored keys
   class StatStruct < FasterOpenStruct
     # Convert a stats hash into a struct.
@@ -35,5 +35,11 @@ module Beaneater
     def keys
       @hash.keys.map { |k| k.to_s }
     end
+
+    # Returns the initialization hash
+    #
+    def to_h
+      @hash
+    end
   end # StatStruct
-end # Beaneater
+end # Beaneater