beaneater 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a211158cb51e20a41be4ef98ca2b4dc18bfe4a8e
-  data.tar.gz: 2a566e5850566082b6439fd13b63a559ecaa7720
+  metadata.gz: b2177aa90f9a3a7017a9df9295ce6105f9d40e22
+  data.tar.gz: 5f77980dcbee480728ee7723c2c67d2cd0138f25
 SHA512:
-  metadata.gz: b8914a8f0f867f1be89e293b172b5d47ab16dedcffb2e60bcf5d852831e163817fa1d8ec2fc3a42b5964da96f2573704fe19808884f1765c354b9a2e5e2a057c
-  data.tar.gz: 74ea34bfd7adc36b94c3c0823407466a5d14597f1fe145fe26e8788427f3817c180e705fa10f0d5900a30b0ed2cd017c82f6b97969dd956e056bfe6bf549bd60
+  metadata.gz: 8246d9cf93f51481b0d8cdd16129aa44fe6d47c9b0ce702735a44396c364bf5f200e75e4da84857fd9b302fe89dce64f22345e0f0e79b1242c235b73bda7026c
+  data.tar.gz: ca040b82353afa029e60554d45747dc63a14bce3f8fd0e40a7d455e42873a1bebcd05441959a789c89f7dc615a8826164f300ae1e98bcf83e1fe0d68be9016ef

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+before_install:
+  - curl -L https://github.com/kr/beanstalkd/archive/v1.9.tar.gz | tar xz -C /tmp
+  - cd /tmp/beanstalkd-1.9/
+  - make
+  - ./beanstalkd &
+  - cd $TRAVIS_BUILD_DIR
+script:
+  - bundle install
+  - bundle exec rake test:full

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # CHANGELOG for Beaneater
 
-## 0.3.3 (Unreleased)
+## 0.3.3 (August 16th 2014)
+
+* Fix failure when job is not defined and fix exception handling for jobs (@nicholasorenrawlings)
+* Add reserve_timeout option to job processing (@nicholasorenrawlings)
+* Add travis-ci badge (@tdg5)
+* Fix tests to run more reliably (@tdg5)
+
 
 ## 0.3.2 (Sept 15 2013)
 

data/Gemfile

@@ -7,4 +7,8 @@ group :development do
   gem 'redcarpet', '~> 1'
   gem 'github-markup'
   gem 'yard'
-end
+end
+
+group :development, :test do
+  gem 'coveralls', :require => false
+end

data/README.md

@@ -1,4 +1,6 @@
 # Beaneater
+[![Build Status](https://secure.travis-ci.org/beanstalkd/beaneater.png)](http://travis-ci.org/beanstalkd/beaneater)
+[![Coverage Status](https://coveralls.io/repos/beanstalkd/beaneater/badge.png?branch=master)](https://coveralls.io/r/beanstalkd/beaneater)
 
 Beaneater is the best way to interact with beanstalkd from within Ruby.
 [Beanstalkd](http://kr.github.com/beanstalkd/) is a simple, fast work queue. Its interface is generic, but was
@@ -95,7 +97,7 @@ The concise summary of how to use beaneater:
 # Process jobs from tube
 while @tube.peek(:ready)
   job = @tube.reserve
-  puts "job value is #{job.body["key"]}!"
+  puts "job value is #{JSON.parse(job.body)["key"]}!"
   job.delete
 end
 # Disconnect the pool
@@ -456,6 +458,7 @@ There are other resources helpful when learning about beanstalk:
  * [beanstalk on github](https://github.com/kr/beanstalkd)
  * [beanstalk protocol](https://github.com/kr/beanstalkd/blob/master/doc/protocol.md)
  * [Backburner](https://github.com/nesquena/backburner) - Ruby job queue for Rails/Sinatra
+ * [BeanCounter](https://github.com/gemeraldbeanstalk/bean_counter) - TestUnit/MiniTest assertions and RSpec matchers for testing code that relies on Beaneater
 
 ## Contributors
 

data/Rakefile

@@ -28,4 +28,6 @@ end
 YARD::Rake::YardocTask.new do |t|
   t.files   = ['lib/beaneater/**/*.rb']
   t.options = []
-end
+end
+
+task :default => 'test:full'

data/beaneater.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Simple beanstalkd client for ruby}
   gem.summary       = %q{Simple beanstalkd client for ruby.}
   gem.homepage      = ""
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/beaneater/job/collection.rb

@@ -16,6 +16,9 @@ module Beaneater
     # Delay in seconds before to make job ready again.
     RELEASE_DELAY = 1
 
+    # Number of seconds to wait for a job before checking a different server.
+    RESERVE_TIMEOUT = nil
+
     # Peek (or find) first job from beanstalkd pool.
     #
     # @param [Integer] id Job id to find
@@ -79,25 +82,31 @@ module Beaneater
     #
     # @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
+      reserve_timeout = options.delete(:reserve_timeout) || RESERVE_TIMEOUT
       tubes.watch!(*processors.keys)
       loop do
-        job = tubes.reserve
-        processor = processors[job.tube]
         begin
-          processor[:block].call(job)
-          job.delete
+          job = tubes.reserve(reserve_timeout)
+          processor = processors[job.tube]
+          begin
+            processor[:block].call(job)
+            job.delete
+          rescue *processor[:retry_on]
+            job.release(:delay => release_delay) if job.stats.releases < processor[:max_retries]
+          end
         rescue AbortProcessingError
           break
-        rescue *processor[:retry_on]
-          job.release(:delay => release_delay) if job.stats.releases < processor[:max_retries]
+        rescue Beaneater::JobNotReserved, Beaneater::NotFoundError, Beaneater::TimedOutError
+          retry
         rescue StandardError => e # handles unspecified errors
           job.bury
         ensure # bury if still reserved
-          job.bury if job.exists? && job.reserved?
+          job.bury if job && job.exists? && job.reserved?
         end
       end
     end # process!

data/lib/beaneater/job/record.rb

@@ -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})
+    #     # => {:status=>"BURIED", :body=>nil, :connection=>#<Beaneater::Connection host="localhost" port=11300>}
     #
     # @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)
+    #     # => {:status=>"RELEASED", :body=>nil, :connection=>#<Beaneater::Connection host="localhost" port=11300>}
     #
     # @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
+    #     # => {:status=>"TOUCHED", :body=>nil, :connection=>#<Beaneater::Connection host="localhost" port=11300>}
     #
     # @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
+    #     # => {:status=>"DELETED", :body=>nil, :connection=>#<Beaneater::Connection host="localhost" port=11300>}
     #
     # @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
+    #     # => {:status=>"KICKED", :body=>nil, :connection=>#<Beaneater::Connection host="localhost" port=11300>}
     #
     # @api public
     def kick
@@ -130,41 +140,43 @@ module Beaneater
     #   @beaneater_connection.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
     #     # => 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
     #     # => 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
     #     # => 5
     #
     def delay
-      self.stats && self.stats.delay
+      self.stats.delay
     end
 
     # Returns string representation of job
@@ -209,4 +221,4 @@ module Beaneater
     end
 
   end # Job
-end # Beaneater
+end # Beaneater

data/lib/beaneater/tube/record.rb

@@ -89,7 +89,7 @@ module Beaneater
     #
     # @return [Beaneater::StatStruct] Struct of tube related values
     # @example
-    #  @tube.stats.delayed # => 24
+    #  @tube.stats.current_jobs_delayed # => 24
     #
     # @api public
     def stats

data/lib/beaneater/version.rb

@@ -1,4 +1,4 @@
 module Beaneater
   # Current version of gem.
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/test/beaneater_test.rb

@@ -23,12 +23,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 +52,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
 

data/test/errors_test.rb

@@ -1,4 +1,4 @@
-# test/connection_test.rb
+# test/errors_test.rb
 
 require File.expand_path('../test_helper', __FILE__)
 

data/test/job_test.rb

@@ -1,4 +1,4 @@
-# test/connection_test.rb
+# test/job_test.rb
 
 require File.expand_path('../test_helper', __FILE__)
 
@@ -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 @pool.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,9 @@ describe Beaneater::Job do
     it("should return delay") do
       assert_equal 5, @job.delay
     end
-  end # tube
+  end # delay
 
   after do
     cleanup_tubes!(['tube'])
   end
-end # Beaneater::Tubes
+end # Beaneater::Job

data/test/jobs_test.rb

@@ -1,4 +1,4 @@
-# test/connection_test.rb
+# test/jobs_test.rb
 
 require File.expand_path('../test_helper', __FILE__)
 
@@ -123,9 +123,9 @@ describe Beaneater::Jobs do
     it "should bury unexpected exception" do
       assert_equal 1, @pool.tubes.find('tube_buried').stats.current_jobs_buried
     end
-  end
+  end # for_process!
 
   after do
     cleanup_tubes!(['baz', 'tube_success', 'tube_release', 'tube_buried'])
   end
-end
+end # Beaneater::Jobs

data/test/pool_command_test.rb

@@ -1,4 +1,4 @@
-# test/connection_test.rb
+# test/pool_command_test.rb
 
 require File.expand_path('../test_helper', __FILE__)
 
@@ -44,7 +44,7 @@ describe Beaneater::PoolCommand do
         assert_equal 4, cmd[:body]['x']
         assert_equal Set[1.1, 1.2], cmd[:body]['version']
       end
-    end # merged command
+    end # merge command
 
     describe 'for merge command with arrays' do
       before do
@@ -60,7 +60,7 @@ describe Beaneater::PoolCommand do
         assert_equal "OK", cmd[:status]
         assert_equal ['foo', 'bar', 'baz'].sort, cmd[:body].sort
       end
-    end # merged command
+    end # merge command
   end # transmit_to_all
 
   describe 'for #method_missing' do
@@ -85,6 +85,6 @@ describe Beaneater::PoolCommand do
       it 'raises no method error' do
         assert_raises(NoMethodError) { @command.foo('foo') }
       end
-    end # transmit_to_rand
-  end
-end # Beaneater::PoolCommand
+    end # invalid method
+  end # method_missing
+end # Beaneater::PoolCommand

data/test/pool_test.rb

@@ -1,4 +1,4 @@
-# test/connection_test.rb
+# test/pool_test.rb
 
 require File.expand_path('../test_helper', __FILE__)
 
@@ -169,7 +169,7 @@ describe Beaneater::Pool do
       TCPSocket.any_instance.expects(:gets).once.returns('DEADLINE_SOON')
       assert_raises(Beaneater::DeadlineSoonError) { @bp.transmit_to_rand 'expecting deadline' }
     end
-  end
+  end # safe_transmit
 
   describe "for #close" do
     it "should support closing the pool" do

data/test/prompt_regexp_test.rb

@@ -31,11 +31,22 @@ describe "Reading from socket client" do
         end
       end
     end
+
+    slept = 0
+    while @pool.nil?
+      begin
+        @pool = Beaneater::Pool.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 = @pool.tubes[@tube_name].reserve
     assert_equal '[first part][second part]', job.body
   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,4 @@ describe Beaneater::StatStruct do
       assert_equal ['foo', 'bar', 'baz', 'under_score'].sort, @struct.keys.sort
     end
   end # keys
-end
+end # Beaneater::StatStruct

data/test/stats_test.rb

@@ -1,4 +1,4 @@
-# test/connection_test.rb
+# test/stats_test.rb
 
 require File.expand_path('../test_helper', __FILE__)
 
@@ -40,4 +40,4 @@ describe Beaneater::Stats do
       assert_raises(NoMethodError) { @stats.cmd }
     end
   end # method_missing
-end # Beaneater::Stats
+end # Beaneater::Stats

data/test/test_helper.rb

@@ -1,10 +1,12 @@
 ENV["TEST"] = 'true'
 require 'rubygems'
+require 'coveralls'
+Coveralls.wear!
 require 'minitest/autorun'
 $:.unshift File.expand_path("../../lib")
 require 'beaneater'
 require 'timeout'
-require 'mocha'
+require 'mocha/setup' rescue require 'mocha'
 require 'json'
 
 class MiniTest::Unit::TestCase
@@ -17,4 +19,4 @@ class MiniTest::Unit::TestCase
       bp.tubes.find(name).clear
     end
   end
-end
+end

data/test/tube_test.rb

@@ -1,4 +1,4 @@
-# test/connection_test.rb
+# test/tube_test.rb
 
 require File.expand_path('../test_helper', __FILE__)
 
@@ -206,4 +206,4 @@ describe Beaneater::Tube do
   after do
     cleanup_tubes!(['baz'])
   end
-end # Beaneater::Tubes
+end # Beaneater::Tube

data/test/tubes_test.rb

@@ -1,4 +1,4 @@
-# test/connection_test.rb
+# test/tubes_test.rb
 
 require File.expand_path('../test_helper', __FILE__)
 
@@ -155,4 +155,4 @@ describe Beaneater::Tubes do
       cleanup_tubes!(['foo', 'tube'])
     end
   end # reserve
-end # Beaneater::Tubes
+end # Beaneater::Tubes

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaneater
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Nico Taing
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-16 00:00:00.000000000 Z
+date: 2014-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - .yardopts
 - CHANGELOG.md
 - Gemfile
@@ -127,7 +128,8 @@ files:
 - test/tube_test.rb
 - test/tubes_test.rb
 homepage: ''
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []