beaneater 0.3.0 → 1.1.1

data/lib/beaneater/tube/record.rb

@@ -1,22 +1,31 @@
-module Beaneater
+class Beaneater
   # Beanstalk tube which contains jobs which can be inserted, reserved, et al.
-  class Tube < PoolCommand
+  class Tube
 
     # @!attribute name
     #   @return [String] name of the tube
-    attr_reader :name
+    # @!attribute client
+    #   @return [Beaneater] returns the client instance
+    attr_reader :name, :client
 
     # Fetches the specified tube.
     #
-    # @param [Beaneater::Pool] pool The beaneater pool for this tube.
+    # @param [Beaneater] client The beaneater client instance.
     # @param [String] name The name for this tube.
     # @example
-    #  Beaneater::Tube.new(@pool, 'tube-name')
+    #  Beaneater::Tube.new(@client, 'tube-name')
     #
-    def initialize(pool, name)
+    def initialize(client, name)
+      @client = client
       @name = name.to_s
       @mutex = Mutex.new
-      super(pool)
+    end
+
+    # Delegates transmit to the connection object.
+    #
+    # @see Beaneater::Connection#transmit
+    def transmit(command, options={})
+      client.connection.transmit(command, **options)
     end
 
     # Inserts job with specified body onto tube.
@@ -33,10 +42,16 @@ module Beaneater
     # @api public
     def put(body, options={})
       safe_use do
-        options = { :pri => config.default_put_pri, :delay => config.default_put_delay,
-                    :ttr => config.default_put_ttr }.merge(options)
-        cmd_options = "#{options[:pri]} #{options[:delay]} #{options[:ttr]} #{body.bytesize}"
-        transmit_to_rand("put #{cmd_options}\r\n#{body}")
+        serialized_body = config.job_serializer.call(body)
+
+        options = {
+          :pri   => config.default_put_pri,
+          :delay => config.default_put_delay,
+          :ttr   => config.default_put_ttr
+        }.merge(options)
+
+        cmd_options = "#{options[:pri]} #{options[:delay]} #{options[:ttr]} #{serialized_body.bytesize}"
+        transmit("put #{cmd_options}\r\n#{serialized_body}")
       end
     end
 
@@ -50,10 +65,10 @@ module Beaneater
     # @api public
     def peek(state)
       safe_use do
-        res = transmit_until_res "peek-#{state}", :status => "FOUND"
-        Job.new(res)
+        res = transmit("peek-#{state}")
+        Job.new(client, res)
       end
-    rescue Beaneater::NotFoundError => ex
+    rescue Beaneater::NotFoundError
       # Return nil if not found
       nil
     end
@@ -69,8 +84,8 @@ module Beaneater
     #
     # @api public
     def reserve(timeout=nil, &block)
-      pool.tubes.watch!(self.name)
-      pool.tubes.reserve(timeout, &block)
+      client.tubes.watch!(self.name)
+      client.tubes.reserve(timeout, &block)
     end
 
     # Kick specified number of jobs from buried to ready state.
@@ -82,18 +97,18 @@ module Beaneater
     #
     # @api public
     def kick(bounds=1)
-      safe_use { transmit_to_rand("kick #{bounds}") }
+      safe_use { transmit("kick #{bounds}") }
     end
 
     # Returns related stats for this tube.
     #
     # @return [Beaneater::StatStruct] Struct of tube related values
     # @example
-    #  @tube.stats.delayed # => 24
+    #  @tube.stats.current_jobs_delayed # => 24
     #
     # @api public
     def stats
-      res = transmit_to_all("stats-tube #{name}", :merge => true)
+      res = transmit("stats-tube #{name}")
       StatStruct.from_hash(res[:body])
     end
 
@@ -106,7 +121,7 @@ module Beaneater
     #
     # @api public
     def pause(delay)
-      transmit_to_all("pause-tube #{name} #{delay}")
+      transmit("pause-tube #{name} #{delay}")
     end
 
     # Clears all unreserved jobs in all states from the tube
@@ -115,14 +130,18 @@ module Beaneater
     #   @tube.clear
     #
     def clear
-      pool.tubes.watch!(self.name)
+      client.tubes.watch!(self.name)
       %w(delayed buried ready).each do |state|
         while job = self.peek(state.to_sym)
-          job.delete
+          begin
+            job.delete
+          rescue Beaneater::UnexpectedResponse, Beaneater::NotFoundError
+            # swallow any issues
+          end
         end
       end
-      pool.tubes.ignore(name)
-    rescue Beaneater::UnexpectedResponse
+      client.tubes.ignore(name)
+    rescue Beaneater::NotIgnoredError
       # swallow any issues
     end
 
@@ -144,12 +163,12 @@ module Beaneater
     # @param [Proc] block Beanstalk command to transmit.
     # @return [Object] Result of block passed
     # @example
-    #  safe_use { transmit_to_rand("kick 1") }
+    #  safe_use { transmit("kick 1") }
     #    # => "Response to kick command"
     #
     def safe_use(&block)
       @mutex.lock
-      tubes.use(self.name)
+      client.tubes.use(self.name)
       yield
     ensure
       @mutex.unlock
@@ -161,6 +180,5 @@ module Beaneater
     def config
       Beaneater.configuration
     end
-
   end # Tube
 end # Beaneater

data/lib/beaneater/version.rb

@@ -1,4 +1,4 @@
-module Beaneater
+class Beaneater
   # Current version of gem.
-  VERSION = "0.3.0"
+  VERSION = "1.1.1"
 end

data/lib/beaneater.rb

@@ -1,11 +1,64 @@
 require 'thread' unless defined?(Mutex)
 
-%w(version configuration errors pool_command pool connection stats tube job).each do |f|
+%w(version configuration errors connection tube job stats).each do |f|
   require "beaneater/#{f}"
 end
 
-module Beaneater
-  # Simple ruby client for beanstalkd.
+class Beaneater
+
+  # @!attribute connection
+  #   @return <Beaneater::Connection> returns the associated connection object
+  attr_reader :connection
+
+  # Initialize new instance of Beaneater
+  #
+  # @param [String] address in the form "host:port"
+  # @example
+  #   Beaneater.new('127.0.0.1:11300')
+  #
+  #   ENV['BEANSTALKD_URL'] = '127.0.0.1:11300'
+  #   @b = Beaneater.new
+  #   @b.connection.host # => '127.0.0.1'
+  #   @b.connection.port # => '11300'
+  #
+  def initialize(address=nil)
+    @connection =  Connection.new(address)
+  end
+
+  # Returns Beaneater::Tubes object for accessing tube related functions.
+  #
+  # @return [Beaneater::Tubes] tubes object
+  # @api public
+  def tubes
+    @tubes ||= Beaneater::Tubes.new(self)
+  end
+
+  # Returns Beaneater::Jobs object for accessing job related functions.
+  #
+  # @return [Beaneater::Jobs] jobs object
+  # @api public
+  def jobs
+    @jobs ||= Beaneater::Jobs.new(self)
+  end
+
+  # Returns Beaneater::Stats object for accessing beanstalk stats.
+  #
+  # @return [Beaneater::Stats] stats object
+  # @api public
+  def stats
+    @stats ||= Stats.new(self)
+  end
+
+  # Closes the related connection
+  #
+  # @example
+  #  @beaneater_instance.close
+  #
+  def close
+    connection.close if connection
+  end
+
+  protected
 
   class << self
     # Yields a configuration block
@@ -29,4 +82,4 @@ module Beaneater
       @_configuration ||= Configuration.new
     end
   end
-end # Beaneater
+end # Beaneater

data/test/beaneater_test.rb

@@ -2,8 +2,7 @@ require File.expand_path('../test_helper', __FILE__)
 
 describe "beanstalk-client" do
   before do
-    @beanstalk = Beaneater::Pool.new(['127.0.0.1:11300'])
-    # @beanstalk = Beaneater::Pool.new(['127.0.0.1:11300', '127.0.0.1:11301'])
+    @beanstalk = Beaneater.new('127.0.0.1:11300')
     @tubes = ['one', 'two', 'three']
 
     # Put something on each tube so they exist
@@ -23,12 +22,12 @@ describe "beanstalk-client" do
       # A: put one
       a = Thread.new do
         tube_one = @beanstalk.tubes.find('one')
-        sleep 4
+        sleep 0.5
         tube_one.put('one')
       end
 
       b = Thread.new do
-        sleep 1
+        sleep 0.125
         tube_two = @beanstalk.tubes.find('two')
         tube_two.put('two')
       end
@@ -52,13 +51,13 @@ describe "beanstalk-client" do
     before do
       a = Thread.new do
         tube_one = @beanstalk.tubes.find('one')
-        sleep 4
+        sleep 0.5
         tube_one.put('one')
       end
 
       b = Thread.new do
         tube_two = @beanstalk.tubes.find('two')
-        sleep 1
+        sleep 0.125
         tube_two.put('two')
       end
 
@@ -108,9 +107,4 @@ describe "beanstalk-client" do
       assert_nil @beanstalk.jobs.find(@job.id)
     end
   end
-
-  after do
-    cleanup_tubes!(@tubes, @beanstalk)
-  end
-
 end

data/test/connection_test.rb

@@ -18,13 +18,25 @@ describe Beaneater::Connection do
 
     it "should init connection" do
       assert_kind_of TCPSocket, @bc.connection
-      assert_equal '127.0.0.1', @bc.connection.peeraddr[3]
+      if @bc.connection.peeraddr[0] == 'AF_INET'
+        assert_equal '127.0.0.1', @bc.connection.peeraddr[3]
+      else
+        assert_equal 'AF_INET6', @bc.connection.peeraddr[0]
+        assert_equal '::1', @bc.connection.peeraddr[3]
+      end
       assert_equal 11300, @bc.connection.peeraddr[1]
     end
 
     it "should raise on invalid connection" do
       assert_raises(Beaneater::NotConnected) { Beaneater::Connection.new("localhost:8544") }
     end
+
+    it "should support array connection to single connection" do
+      @bc2 = Beaneater::Connection.new([@host])
+      assert_equal 'localhost', @bc.address
+      assert_equal 'localhost', @bc.host
+      assert_equal 11300, @bc.port
+    end
   end # new
 
   describe 'for #transmit' do
@@ -60,6 +72,48 @@ describe Beaneater::Connection do
       res = @bc.transmit "put 0 0 100 256\r\n"+(0..255).to_a.pack("c*")
       assert_equal 'INSERTED', res[:status]
     end
+
+    it "should retry command with success after one connection failure" do
+      TCPSocket.any_instance.expects(:readline).times(2).
+        raises(EOFError.new).then.
+        returns("DELETED 56\nFOO")
+
+      res = @bc.transmit "delete 56\r\n"
+      assert_equal 'DELETED', res[:status]
+    end
+
+    it "should fail after exceeding retries with DrainingError" do
+      TCPSocket.any_instance.expects(:readline).times(3).
+        raises(Beaneater::UnexpectedResponse.from_status("DRAINING", "delete 56"))
+
+      assert_raises(Beaneater::DrainingError) { @bc.transmit "delete 56\r\n" }
+    end
+
+    it "should fail after exceeding reconnect max retries" do
+      # next connection attempts should fail
+      TCPSocket.stubs(:new).times(3).raises(Errno::ECONNREFUSED.new)
+      TCPSocket.any_instance.stubs(:readline).times(1).raises(EOFError.new)
+
+      assert_raises(Beaneater::NotConnected) { @bc.transmit "delete 56\r\n" }
+    end
+
+    it "tubes_watched are restored after reconnect" do
+      client = Beaneater.new('127.0.0.1:11300')
+      client.tubes.watch! "another"
+
+      TCPSocket.prepend Module.new {
+        def readline
+          if !$called
+            $called = true
+            raise EOFError
+          end
+
+          super
+        end
+      }
+
+      assert_equal %w[another], client.tubes.watched.map(&:name)
+    end
   end # transmit
 
   describe 'for #close' do

data/test/errors_test.rb

@@ -1,4 +1,4 @@
-# test/connection_test.rb
+# test/errors_test.rb
 
 require File.expand_path('../test_helper', __FILE__)
 
@@ -23,4 +23,11 @@ describe "Beaneater::Errors" do
     assert_equal 'reserve 0', @klazz.cmd
     assert_equal 'DEADLINE_SOON', @klazz.status
   end
-end
+
+  it 'should raise proper exception for invalid status EXPECTED_CRLF' do
+    @klazz = Beaneater::UnexpectedResponse.from_status("EXPECTED_CRLF", "reserve 0")
+    assert_kind_of(Beaneater::ExpectedCrlfError, @klazz)
+    assert_equal 'reserve 0', @klazz.cmd
+    assert_equal 'EXPECTED_CRLF', @klazz.status
+  end
+end

data/test/job_test.rb

@@ -1,11 +1,11 @@
-# test/connection_test.rb
+# test/job_test.rb
 
 require File.expand_path('../test_helper', __FILE__)
 
 describe Beaneater::Job do
   before do
-    @pool  = Beaneater::Pool.new(['localhost'])
-    @tube  = @pool.tubes.find 'tube'
+    @beanstalk  = Beaneater.new('localhost')
+    @tube  = @beanstalk.tubes.find 'tube'
   end
 
   describe "for #bury" do
@@ -139,7 +139,7 @@ describe Beaneater::Job do
       assert_equal 'foo touch', job.body
       job.bury
       assert_equal 1, @tube.stats.current_jobs_buried
-      if @pool.stats.version > 1.7
+      if @beanstalk.stats.version.to_f > 1.7
         job.kick
         assert_equal 0, @tube.stats.current_jobs_buried
         assert_equal 1, @tube.stats.current_jobs_ready
@@ -218,7 +218,7 @@ describe Beaneater::Job do
       assert_equal 1, job.pri
       job.release
     end
-  end # tube
+  end # pri
 
 
   describe "for #ttr" do
@@ -232,7 +232,7 @@ describe Beaneater::Job do
       assert_equal 5, job.ttr
       job.release
     end
-  end # tube
+  end # ttr
 
   describe "for #delay" do
     before do
@@ -243,9 +243,5 @@ describe Beaneater::Job do
     it("should return delay") do
       assert_equal 5, @job.delay
     end
-  end # tube
-
-  after do
-    cleanup_tubes!(['tube'])
-  end
-end # Beaneater::Tubes
+  end # delay
+end # Beaneater::Job

data/test/jobs_test.rb

@@ -1,12 +1,12 @@
-# test/connection_test.rb
+# test/jobs_test.rb
 
 require File.expand_path('../test_helper', __FILE__)
 
 describe Beaneater::Jobs do
   before do
-    @pool = Beaneater::Pool.new(['localhost'])
-    @jobs = Beaneater::Jobs.new(@pool)
-    @tube = @pool.tubes.find('baz')
+    @beanstalk = Beaneater.new('localhost')
+    @jobs = Beaneater::Jobs.new(@beanstalk)
+    @tube = @beanstalk.tubes.find('baz')
   end
 
   describe "for #find" do
@@ -33,30 +33,6 @@ describe Beaneater::Jobs do
     end
   end # find
 
-  describe "for #find_all" do
-    before do
-      @time = Time.now.to_i
-      @tube.put("foo find #{@time}")
-      @job = @tube.peek(:ready)
-    end
-
-      it "should return job from id" do
-        assert_equal "foo find #{@time}", @jobs.find_all(@job.id).first.body
-      end
-
-      it "should return job using peek" do
-        assert_equal "foo find #{@time}", @jobs.find_all(@job.id).first.body
-      end
-
-      it "should return job using hash syntax" do
-        assert_equal "foo find #{@time}", @jobs.find_all(@job.id).first.body
-      end
-
-      it "should return nil for invalid id" do
-        assert_equal [], @jobs.find_all(-1)
-      end
-  end # find_all
-
   describe "for #register!" do
     before do
       $foo = 0
@@ -98,10 +74,10 @@ describe Beaneater::Jobs do
 
       cleanup_tubes!(['tube_success', 'tube_release', 'tube_buried'])
 
-      @pool.tubes.find('tube_success').put("success abort", :pri => 2**31 + 1)
-      @pool.tubes.find('tube_success').put("success 2", :pri => 1)
-      @pool.tubes.find('tube_release').put("released")
-      @pool.tubes.find('tube_buried').put("buried")
+      @beanstalk.tubes.find('tube_success').put("success abort", :pri => 2**31 + 1)
+      @beanstalk.tubes.find('tube_success').put("success 2", :pri => 1)
+      @beanstalk.tubes.find('tube_release').put("released")
+      @beanstalk.tubes.find('tube_buried').put("buried")
 
       @jobs.process!(:release_delay => 0)
     end
@@ -111,21 +87,17 @@ describe Beaneater::Jobs do
     end
 
     it "should clear successful_jobs" do
-      assert_equal 0, @pool.tubes.find('tube_success').stats.current_jobs_ready
-      assert_equal 1, @pool.tubes.find('tube_success').stats.current_jobs_buried
-      assert_equal 0, @pool.tubes.find('tube_success').stats.current_jobs_reserved
+      assert_equal 0, @beanstalk.tubes.find('tube_success').stats.current_jobs_ready
+      assert_equal 1, @beanstalk.tubes.find('tube_success').stats.current_jobs_buried
+      assert_equal 0, @beanstalk.tubes.find('tube_success').stats.current_jobs_reserved
     end
 
     it "should retry release jobs 2 times" do
-      assert_equal 2, @pool.tubes.find('tube_release').peek(:buried).stats.releases
+      assert_equal 2, @beanstalk.tubes.find('tube_release').peek(:buried).stats.releases
     end
 
     it "should bury unexpected exception" do
-      assert_equal 1, @pool.tubes.find('tube_buried').stats.current_jobs_buried
+      assert_equal 1, @beanstalk.tubes.find('tube_buried').stats.current_jobs_buried
     end
-  end
-
-  after do
-    cleanup_tubes!(['baz', 'tube_success', 'tube_release', 'tube_buried'])
-  end
-end
+  end # for_process!
+end # Beaneater::Jobs

data/test/prompt_regexp_test.rb

@@ -31,15 +31,27 @@ describe "Reading from socket client" do
         end
       end
     end
+
+    slept = 0
+    while @beanstalk.nil?
+      begin
+        @beanstalk = Beaneater.new("localhost:#{@fake_port}")
+      rescue Beaneater::NotConnected
+        raise 'Could not connect to fake beanstalkd server' if slept > 1
+        sleep 0.1
+        slept += 0.1
+      end
+    end
+
   end
 
   it 'should reserve job with full body' do
-    pool = Beaneater::Pool.new("localhost:#{@fake_port}")
-    job = pool.tubes[@tube_name].reserve
+    job = @beanstalk.tubes[@tube_name].reserve
     assert_equal '[first part][second part]', job.body
   end
 
   after do
+    @beanstalk.close
     @fake_server.kill
   end
 end

data/test/stat_struct_test.rb

@@ -1,4 +1,4 @@
-# test/connection_test.rb
+# test/stat_struct_test.rb
 
 require File.expand_path('../test_helper', __FILE__)
 
@@ -38,4 +38,14 @@ describe Beaneater::StatStruct do
       assert_equal ['foo', 'bar', 'baz', 'under_score'].sort, @struct.keys.sort
     end
   end # keys
-end
+
+  describe "for #to_h" do
+    it "should return 4 keys / values" do
+      assert_equal 4, @struct.to_h.size
+    end
+
+    it "should return expect hash" do
+      assert_equal [['foo', 'bar'], ['bar', 'baz'], ['baz', 'foo'], ['under_score', 'demo']].sort, @struct.to_h.sort
+    end
+  end # to_h
+end # Beaneater::StatStruct

data/test/stats_test.rb

@@ -1,21 +1,21 @@
-# test/connection_test.rb
+# test/stats_test.rb
 
 require File.expand_path('../test_helper', __FILE__)
 
 describe Beaneater::Stats do
   before do
-    @pool =  stub(:transmit_to_all => [{ :body => { 'uptime' => 1, 'cmd-use' => 2 }, :status => "OK"},
-      {:body => { 'uptime' => 3,'cmd-use' => 4 }, :status => "OK" }])
-    @stats = Beaneater::Stats.new(@pool)
+    connection = stub(:transmit => { :body => { 'uptime' => 1, 'cmd-use' => 2 }, :status => "OK"})
+    @beanstalk = stub(:connection => connection)
+    @stats = Beaneater::Stats.new(@beanstalk)
   end
 
   describe 'for #[]' do
     it "should return stats by key" do
-      assert_equal 4, @stats[:uptime]
+      assert_equal 1, @stats[:uptime]
     end
 
     it "should return stats by underscore key" do
-      assert_equal 6, @stats[:'cmd_use']
+      assert_equal 2, @stats[:'cmd_use']
     end
   end # []
 
@@ -29,15 +29,15 @@ describe Beaneater::Stats do
 
   describe 'for #method_missing' do
     it "should return stats by key" do
-      assert_equal 4, @stats.uptime
+      assert_equal 1, @stats.uptime
     end
 
     it "should return stats by underscore key" do
-      assert_equal 6, @stats.cmd_use
+      assert_equal 2, @stats.cmd_use
     end
 
     it "should raise NoMethodError" do
       assert_raises(NoMethodError) { @stats.cmd }
     end
   end # method_missing
-end # Beaneater::Stats
+end # Beaneater::Stats

data/test/test_helper.rb

@@ -1,22 +1,46 @@
 ENV["TEST"] = 'true'
 require 'rubygems'
+require 'coveralls'
+Coveralls.wear!
 require 'minitest/autorun'
 $:.unshift File.expand_path("../../lib")
 require 'beaneater'
-require 'fakeweb'
-require 'mocha'
+require 'timeout'
+begin
+  require 'mocha/setup'
+rescue LoadError
+  require 'mocha'
+end
 require 'json'
 
-FakeWeb.allow_net_connect = false
-
 class MiniTest::Unit::TestCase
 
-  # Cleans up all jobs from tubes
-  # cleanup_tubes!(['foo'], @bp)
-  def cleanup_tubes!(tubes, bp=nil)
-    bp ||= @pool
+  # Cleans up all jobs from specific tubes
+  #
+  # @example
+  #   cleanup_tubes!(['foo'], @beanstalk)
+  #
+  def cleanup_tubes!(tubes, client=nil)
+    client ||= @beanstalk
     tubes.each do |name|
-      bp.tubes.find(name).clear
+      client.tubes.find(name).clear
+    end
+  end
+
+  # Cleans up all jobs from all tubes known to the connection
+  def flush_all(client=nil)
+    client ||= @beanstalk
+
+    # Do not continue if it is a mock or the connection has been closed
+    return if !client.is_a?(Beaneater) || !client.connection.connection
+
+    client.tubes.all.each do |tube|
+      tube.clear
     end
   end
-end
+
+  # Run clean up after each test to ensure clean state in all tests
+  def teardown
+    flush_all
+  end
+end