beanstalk_farmer 0.1.2 → 0.2.0

data/.gitignore

@@ -2,3 +2,5 @@ Gemfile.lock
 doc/
 .yardoc/
 pkg/*.gem
+coverage/
+log/

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.2
+script: bundle exec rspec --tag "~beanstalk_required" -f d spec

data/.yardopts

@@ -1,5 +1,4 @@
 --no-private
---title "Farmer: a Beanstalk Job Queue Gem"
+--title "Beanstalk Farmer: a Beanstalk Job Queue Gem"
 lib/**/*.rb -
-README.md
 LICENSE

data/README.md

@@ -12,18 +12,12 @@ la Rack (e.g. `Proc`s, `procs`s). The payload of the job will be passed into
 the arguments of this method. Bear in mind that the payload for a Beanstalk job
 is de-serialized JSON.
 
-### Example
+For usage examples, see the examples directory in the source code.
 
-    BeanstalkFarmer::Runner.register_handlers do
-      # You can use objects
-      tube 'email.welcome_message', WelcomeMessageHandler
+##  Development
 
-      # You can use Procs
-      tube 'push.message', Proc.new { |args| PushService.send_message(args) }
-    end
+* [Continuous integration](http://travis-ci.org/#!/jherdman/beanstalk_farmer)
 
-    BeanstalkFarmer::Runner.run!
+## Shout Outs
 
-## Configuration
-
-Easy as pie! See `BeanstalkFarmer::Config` for all available options.
+Many thanks to [nulayer](http://nulayer.com/).

data/Rakefile

@@ -6,11 +6,13 @@ Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = %w[--color]
+RSpec::Core::RakeTask.new("spec") do |t|
   t.verbose = false
+  t.rspec_opts = "--tag ~beanstalk_required -f d"
 end
 
+task default: "spec"
+
 require 'yard'
 require 'yard/rake/yardoc_task'
 

data/beanstalk_farmer.gemspec

@@ -20,8 +20,9 @@ Gem::Specification.new do |s|
   s.add_dependency 'beanstalk-client', ['~> 1.1.0']
   s.add_dependency 'multi_json',       ['~> 1.0.2']
 
-  s.add_development_dependency 'rake',  ['~> 0.8.7']
-  s.add_development_dependency 'rspec', ['~> 2.6']
+  s.add_development_dependency 'rake',      ['~> 0.8.7']
+  s.add_development_dependency 'rspec',     ['~> 2.6']
+  s.add_development_dependency 'simplecov', ['~> 0.4.2']
 
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files -- {spec}/*`.split("\n")

data/example/echo.rb

@@ -5,9 +5,27 @@
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 require 'beanstalk_farmer'
 
+class ObjectHandler
+  attr_accessor :args
+
+  def initialize(args)
+    self.args = args
+  end
+
+  def call
+    BeanstalkFarmer.logger.info "Object handler says #{args.inspect}"
+  end
+
+  def self.call(args)
+    new(args).call
+  end
+end
+
 BeanstalkFarmer::Runner.register_handlers do
+  tube 'echo.object',     ObjectHandler
   tube 'echo.small_proc', proc { |args| BeanstalkFarmer.logger.info "Small proc says: #{args.inspect}" }
-  tube 'echo.big_proc', Proc.new { |args| BeanstalkFarmer.logger.info "Big Proc says: #{args.inspect}" }
+  tube 'echo.big_proc',   Proc.new { |args| BeanstalkFarmer.logger.info "Big Proc says: #{args.inspect}" }
+  tube 'echo.block',      do |args| BeanstalkFarmer.logger.info "Block handler says: #{args.inspect}"; end
 end
 
 trap 'INT' do

data/example/echo_enqueuer.rb

@@ -0,0 +1,15 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'beanstalk_farmer'
+
+loop do
+  handler_types = %w[object small_proc big_proc block]
+  handler_type  = handler_types[rand(handler_types.length).round]
+  BeanstalkFarmer::Service.instance.enqueue "echo.#{handler_type}", "Hello, world!"
+  sleep 10
+end
+
+trap 'INT' do
+  puts "\rExiting"
+  BeanstalkFarmer::Runner.close_connection
+  exit
+end

data/lib/beanstalk_farmer/dsl.rb

@@ -1,7 +1,9 @@
 module BeanstalkFarmer
   # @private Provides a clean slate object that we can safely instance eval on.
   class DSL
-    def tube(tube_name, job_handler)
+    def tube(tube_name, job_handler=nil, &block)
+      job_handler = block.to_proc if block_given?
+
       Job.handler_pool[tube_name] = job_handler
     end
 

data/lib/beanstalk_farmer/job.rb

@@ -3,6 +3,8 @@ require 'timeout'
 
 module BeanstalkFarmer
   class Job
+    include BeanstalkFarmer
+
     # Raised when a job cannot complete in time
     class OutOfTimeError < Timeout::Error; end
 
@@ -13,6 +15,7 @@ module BeanstalkFarmer
     def initialize(job)
       self.job = job
       set_name_and_arguments
+      logger.info "JOB (#{name}) reserved"
     end
 
     # Performs work for this job
@@ -21,13 +24,16 @@ module BeanstalkFarmer
       # TTR value. I'm not sure why at this point in time. Maybe to compensate
       # for Job setup time.
       Timeout.timeout(job.ttr) do
+        logger.info "JOB (#{name}) working"
         handler = self.class.handler_pool[name]
         handler.call(args)
       end
     rescue Timeout::Error
+      logger.error "JOB (#{name}) out of time"
       raise OutOfTimeError, "#{name} could not finish in #{job.ttr} seconds"
     ensure
       job.delete
+      logger.info "JOB (#{name}) done"
     end
 
     # A pool of job handlers that can work on jobs in our queue

data/lib/beanstalk_farmer/runner.rb

@@ -12,7 +12,7 @@ module BeanstalkFarmer
 
     # @return [Farmer::BeanstalkService] a connection to the Beanstalk queue
     def service
-      @service ||= Service.new
+      @service ||= Service.instance
     end
 
     # Prepares tubes for watching

data/lib/beanstalk_farmer/service.rb

@@ -1,5 +1,6 @@
 require 'beanstalk-client'
 require 'multi_json'
+require 'singleton'
 
 module BeanstalkFarmer
   ##
@@ -11,35 +12,44 @@ module BeanstalkFarmer
   #
   # @private
   class Service
+    include BeanstalkFarmer
+    include Singleton
+
     DEFAULT_DELAY    = 0
     DEFAULT_PRIORITY = 65536
     DEFAULT_TTR      = 120
 
-    # Raised when we cannot connect to the Beanstalk queue
-    class NotConnectedError < Beanstalk::NotConnected; end
-
-    attr_accessor :uri
+    attr_accessor :host, :port
 
-    # Sets the URI of your Beanstalk queue.
+    # Sets the host and port of your Beanstalk queue.
     #
     # @param [String] host (DEFAULT_HOST) the host name to of your Beanstalk queue
     #
     # @param [String] port (DEFAULT_PORT) the port that your Beanstalk queue is on
     def initialize(host=Config.host, port=Config.port)
-      self.uri = build_uri(host, port)
+      self.host = host
+      self.port = port
+    end
+
+    # @return [String] a formatted URI for a Beanstalk queue
+    def uri
+      build_uri(host, port)
     end
 
     # @return [Beanstalk::Pool] a connection to Beanstalk
     def connection
       @connection ||= Beanstalk::Pool.new([uri])
+    rescue Beanstalk::NotConnected
+      raise NotConnectedError
     end
 
     # Closes the Beanstalk connection
     #
     # @return [nil] Nothing. Absolutely nothing.
     def close
-      @connection.close
-      @connection = nil
+      logger.warn "Closing connection to Beanstalk"
+      connection.close
+      delete_connection
     end
 
     # @param [Array<String>] tube_names The tube names to be watched
@@ -50,13 +60,17 @@ module BeanstalkFarmer
 
     # @param [Array<String>] tube_names The tube names to be watched
     def watch_tubes(tube_names)
+      logger.info "Watching tubes: #{tube_names.inspect}"
       tube_names.each { |tube_name| connection.watch(tube_name) }
     end
 
     # Ignores any tubes that aren't of interest, excluding the default tube.
     def ignore_unwatched_tubes(watched_tube_names)
       connection.list_tubes_watched.values do |tube_name|
-        connection.ignore(tube_name) unless watched_tube_names.include?(tube_name)
+        unless watched_tube_names.include?(tube_name)
+          logger.info "Ignoring tube: #{tube_name}"
+          connection.ignore(tube_name)
+        end
       end
     end
 
@@ -79,5 +93,14 @@ module BeanstalkFarmer
     def build_uri(host, port)
       [host, port].join(':')
     end
+
+    def delete_connection
+      @connection = nil
+    end
   end
+
+  ## Errors
+
+  # Raised when a connection cannot be made
+  class NotConnectedError < Beanstalk::NotConnected; end
 end

data/lib/beanstalk_farmer/version.rb

@@ -1,3 +1,3 @@
 module BeanstalkFarmer
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/beanstalk_farmer.rb

@@ -9,9 +9,23 @@ module BeanstalkFarmer
   autoload :Job,     'beanstalk_farmer/job'
   autoload :Runner,  'beanstalk_farmer/runner'
 
+  # @private
+  def logger
+    Config.logger
+  end
+
   # @return [Logger] the logger, defaulting to a STDOUT logger
   def self.logger
-    @logger ||= Config.logger
-    @logger
+    Config.logger
+  end
+
+  # @yield [BeanstalkFarmer::Config] a block that allows for convenient configuration
+  #
+  # @example Usage
+  #   BeanstalkFarmer.config do |c|
+  #     c.logger = Rails.logger
+  #   end
+  def self.config
+    yield Config
   end
 end

data/spec/beanstalk_farmer/config_spec.rb

@@ -1,6 +1,14 @@
 require 'spec_helper'
 
 describe BeanstalkFarmer::Config do
+  its(:host) { should == described_class::DEFAULT_HOST }
+
+  its(:port) { should == described_class::DEFAULT_PORT }
+
+  its(:logger) { should be_a(Logger) }
+
+  its(:json_engine) { should == MultiJson.engine }
+
   describe ".option" do
     before(:all) do
       described_class.option(:test_setting, default: true)

data/spec/beanstalk_farmer/dsl_spec.rb

@@ -13,5 +13,13 @@ describe BeanstalkFarmer::DSL do
       subject.tube(tube_name, handler)
       BeanstalkFarmer::Job.handler_pool[tube_name].should == handler
     end
+
+    it 'can add a block as a handler' do
+      subject.tube 'block', do |args|
+        args
+      end
+
+      BeanstalkFarmer::Job.handler_pool['block'].should be_a(Proc)
+    end
   end
 end

data/spec/beanstalk_farmer/service_spec.rb

@@ -1,9 +1,15 @@
 require 'spec_helper'
 
-describe BeanstalkFarmer::Service do
-  describe '.new' do
-    it 'sets the `uri` attribute' do
-      described_class.new.uri.should =~ /\A#{BeanstalkFarmer::Config.host}:#{BeanstalkFarmer::Config.port}\z/
+describe BeanstalkFarmer::Service, :beanstalk_required do
+  subject { described_class.instance }
+
+  its(:host) { should == BeanstalkFarmer::Config.host }
+
+  its(:port) { should == BeanstalkFarmer::Config.port }
+
+  describe '#uri' do
+    it 'is a formatted URI for a Beanstalk queue' do
+      subject.uri.should =~ /\A#{subject.host}:#{subject.port}\z/
     end
   end
 
@@ -14,8 +20,8 @@ describe BeanstalkFarmer::Service do
 
     it 'establishes a connection to Beanstalk' do
       expect {
-        subject.connection.put 'Hello'
-      }.to_not raise_error(BeanstalkFarmer::Service::NotConnectedError)
+        subject.connection.use 'fake.tube'
+      }.to_not raise_error(BeanstalkFarmer::NotConnectedError)
     end
   end
 
@@ -28,6 +34,10 @@ describe BeanstalkFarmer::Service do
   end
 
   describe '#watch_tubes' do
+    after(:each) do
+      subject.close
+    end
+
     it 'adds a tube to the list of watched tubes' do
       subject.watch_tubes(%w[bacon])
       subject.connection.list_tubes_watched.should have_tube_named('bacon')
@@ -35,6 +45,10 @@ describe BeanstalkFarmer::Service do
   end
 
   describe '#ignore_unwatched_tubes' do
+    after(:each) do
+      subject.close
+    end
+
     it 'ignores tubes that are not being watched' do
       pending 'a creative way to test this problem'
     end
@@ -49,6 +63,10 @@ describe BeanstalkFarmer::Service do
       subject.connection.stub(:reserve) { job }
     end
 
+    after(:each) do
+      subject.close
+    end
+
     it 'builds a Farmer::Job' do
       subject.reserve.should be_a_kind_of(BeanstalkFarmer::Job)
     end

data/spec/beastalk_farmer_spec.rb

@@ -2,4 +2,17 @@ require 'spec_helper'
 
 describe BeanstalkFarmer do
   its(:logger) { should be_a_kind_of(Logger) }
+
+  describe '.config' do
+    after(:each) do
+      BeanstalkFarmer::Config.port = BeanstalkFarmer::Config::DEFAULT_PORT
+    end
+
+    it 'yields a Config module' do
+      described_class.config do |c|
+        c.port = 3000
+        c.port.should == 3000
+      end
+    end
+  end
 end

data/spec/integration/working_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+class ClassWorker
+  def self.call(args)
+    $stderr << args
+  end
+end unless defined?(ClassWorker)
+
+describe 'Workers do work', :beanstalk_required do
+  before(:each) do
+    @old_stderr = $stderr
+    @capture    = StringIO.new
+    $stderr     = @capture
+
+    BeanstalkFarmer::Runner.register_handlers do
+      tube 'echo.small_proc', proc { |args| $stderr << args }
+      tube 'echo.big_proc',   Proc.new { |args| $stderr << args }
+      tube 'echo.class',      ClassWorker
+      tube 'echo.block',      do |args| $stderr << args; end
+    end
+
+    BeanstalkFarmer::Runner.instance.prep_tubes
+  end
+
+  after(:each) do
+    $stderr  = @old_stderr
+    @capture = nil
+    BeanstalkFarmer::Service.instance.close
+  end
+
+  it 'performs enqueued work with small procs' do
+    message = 'Hello, proc'
+
+    BeanstalkFarmer::Service.instance.enqueue 'echo.small_proc', message
+    BeanstalkFarmer::Runner.instance.reserve_and_work_job
+
+    @capture.string.should == message
+  end
+
+  it 'performs enqueued work with blocks' do
+    message = 'Hello, block'
+
+    BeanstalkFarmer::Service.instance.enqueue 'echo.block', message
+    BeanstalkFarmer::Runner.instance.reserve_and_work_job
+
+    @capture.string.should == message
+  end
+
+  it 'performs enqueued work with big procs' do
+    message = 'Hello, big Proc'
+
+    BeanstalkFarmer::Service.instance.enqueue 'echo.big_proc', message
+    BeanstalkFarmer::Runner.instance.reserve_and_work_job
+
+    @capture.string.should == message
+  end
+
+  it 'performs enqueued work with class' do
+    message = 'Hello, Class'
+
+    BeanstalkFarmer::Service.instance.enqueue 'echo.class', message
+    BeanstalkFarmer::Runner.instance.reserve_and_work_job
+
+    @capture.string.should == message
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,19 @@
 require 'rubygems'
 require 'bundler/setup'
+
+# Must be loaded *before* the application starts
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
 require 'beanstalk_farmer'
 
 Dir['./spec/support/**/*.rb'].each { |support_file| require support_file }
 
+BeanstalkFarmer::Config.logger = Logger.new('./log/test.log')
+
 RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
 end

metadata

@@ -2,7 +2,7 @@
 name: beanstalk_farmer
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - James Herdamn
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 -04:00
-default_executable: 
+date: 2011-05-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: beanstalk-client
@@ -57,6 +56,17 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: *id005
 description: Farmer is a nice little kit to manage a Beanstalk job queue
 email: 
 - james.herdman@me.com
@@ -70,6 +80,7 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - .yardopts
 - Gemfile
 - LICENSE
@@ -77,6 +88,7 @@ files:
 - Rakefile
 - beanstalk_farmer.gemspec
 - example/echo.rb
+- example/echo_enqueuer.rb
 - lib/beanstalk_farmer.rb
 - lib/beanstalk_farmer/config.rb
 - lib/beanstalk_farmer/dsl.rb
@@ -84,15 +96,16 @@ files:
 - lib/beanstalk_farmer/runner.rb
 - lib/beanstalk_farmer/service.rb
 - lib/beanstalk_farmer/version.rb
+- log/.gitkeep
 - spec/beanstalk_farmer/config_spec.rb
 - spec/beanstalk_farmer/dsl_spec.rb
 - spec/beanstalk_farmer/job_spec.rb
 - spec/beanstalk_farmer/runner_spec.rb
 - spec/beanstalk_farmer/service_spec.rb
 - spec/beastalk_farmer_spec.rb
+- spec/integration/working_spec.rb
 - spec/spec_helper.rb
 - spec/support/have_tube_named.rb
-has_rdoc: true
 homepage: https://github.com/jherdman/beanstalk_farmer
 licenses: []
 
@@ -106,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3918122291663500270
+      hash: 3832172194492424674
       segments: 
       - 0
       version: "0"
@@ -119,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: farmer
-rubygems_version: 1.6.2
+rubygems_version: 1.8.2
 signing_key: 
 specification_version: 3
 summary: A nice little kit to manage a Beanstalk job queue