beaneater 0.1.2 → 0.2.0

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # CHANGELOG for Beaneater
 
-## 0.1.3 (Unreleased)
+## 0.2.1 (Unreleased)
+
+## 0.2.0 (Nov 12 2012)
+* Fix 1.8.7 compatibility issues
+* Add configuration block to beaneater and better job parsing
+* BREAKING: json jobs now return as string by default not hashes
 
 ## 0.1.2 (Nov 7 2012)
 

data/README.md

@@ -101,6 +101,20 @@ For a more detailed rundown, check out the __Usage__ section below.
 
 ## Usage
 
+### Configuration
+
+To setup advanced options for beaneater
+
+```ruby
+Beaneater.configure do |config|
+  # config.default_put_delay   = 0
+  # config.default_put_pri     = 65536
+  # config.default_put_ttr     = 120
+  # config.job_parser          = lambda { |body| body }
+  # config.beanstalkd_url      = ['localhost:11300']
+end
+```
+
 ### Connection
 
 To interact with a beanstalk queue, first establish a connection by providing a set of addresses:

data/beaneater.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'mocha'
   gem.add_development_dependency 'fakeweb'
   gem.add_development_dependency 'term-ansicolor'
+  gem.add_development_dependency 'json'
 end

data/lib/beaneater.rb

@@ -1,9 +1,33 @@
 require 'net/telnet'
+require 'thread' unless defined?(Mutex)
 
-%w(version errors pool_command pool connection stats tube job).each do |f|
+%w(version configuration errors pool_command pool connection stats tube job).each do |f|
   require "beaneater/#{f}"
 end
 
 module Beaneater
   # Simple ruby client for beanstalkd.
-end
+
+  class << self
+    # Yields a configuration block
+    #
+    # @example
+    #   Beaneater.configure do |config|
+    #     config.job_parser = lamda { |body| Yaml.load(body)}
+    #   end
+    #
+    def configure(&block)
+      yield(configuration) if block_given?
+      configuration
+    end
+
+    # Returns the configuration options set for Backburner
+    #
+    # @example
+    #   Beaneater.configuration.default_put_ttr => 120
+    #
+    def configuration
+      @_configuration ||= Configuration.new
+    end
+  end
+end # Beaneater

data/lib/beaneater/configuration.rb

@@ -0,0 +1,17 @@
+module Beaneater
+  class Configuration
+    attr_accessor :default_put_delay   # default delay value to put a job
+    attr_accessor :default_put_pri     # default priority value to put a job
+    attr_accessor :default_put_ttr     # default ttr value to put a job
+    attr_accessor :job_parser          # default job_parser to parse job body
+    attr_accessor :beanstalkd_url      # default beanstalkd url
+
+    def initialize
+      @default_put_delay   = 0
+      @default_put_pri     = 65536
+      @default_put_ttr     = 120
+      @job_parser          = lambda { |body| body }
+      @beanstalkd_url      = nil
+    end
+  end # Configuration
+end # Beaneater

data/lib/beaneater/connection.rb

@@ -112,10 +112,19 @@ module Beaneater
       status = res_lines.first
       status, id = status.scan(/\w+/)
       raise UnexpectedResponse.from_status(status, cmd) if UnexpectedResponse::ERROR_STATES.include?(status)
-      response = { :status => status, :body => YAML.load(res_lines[1..-1].join("\n")) }
+      raw_body = res_lines[1..-1].join("\n")
+      body = ['FOUND', 'RESERVED'].include?(status) ? config.job_parser.call(raw_body) : YAML.load(raw_body)
+      response = { :status => status, :body => body }
       response[:id] = id if id
       response[:connection] = self
       response
     end
+
+    # Returns configuration options for beaneater
+    #
+    # @return [Beaneater::Configuration] configuration object
+    def config
+      Beaneater.configuration
+    end
   end # Connection
 end # Beaneater

data/lib/beaneater/pool.rb

@@ -21,7 +21,7 @@ module Beaneater
     #   @bp.connections.last.host # => '127.0.0.1'
     #
     def initialize(addresses=nil)
-      addresses = addresses || host_from_env
+      addresses = addresses || host_from_env || Beaneater.configuration.beanstalkd_url
       @connections = Array(addresses).map { |a| Connection.new(a) }
     end
 

data/lib/beaneater/tube/record.rb

@@ -1,12 +1,6 @@
 module Beaneater
   # Beanstalk tube which contains jobs which can be inserted, reserved, et al.
   class Tube < PoolCommand
-    # The default delay for inserted jobs.
-    DEFAULT_DELAY = 0
-    # Default priority for inserted jobs, 0 is the highest.
-    DEFAULT_PRIORITY = 65536
-    # Default time to respond for inserted jobs.
-    DEFAULT_TTR = 120
 
     # @!attribute name
     #   @return [String] name of the tube
@@ -39,7 +33,8 @@ module Beaneater
     # @api public
     def put(body, options={})
       safe_use do
-        options = { :pri => DEFAULT_PRIORITY, :delay => DEFAULT_DELAY, :ttr => DEFAULT_TTR }.merge(options)
+        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}\n#{body}")
       end
@@ -60,6 +55,7 @@ module Beaneater
       end
     rescue Beaneater::NotFoundError => ex
       # Return nil if not found
+      nil
     end
 
     # Reserves the next job from tube.
@@ -158,5 +154,13 @@ module Beaneater
     ensure
       @mutex.unlock
     end
+
+    # Returns configuration options for beaneater
+    #
+    # @return [Beaneater::Configuration] configuration object
+    def config
+      Beaneater.configuration
+    end
+
   end # Tube
 end # Beaneater

data/lib/beaneater/version.rb

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

data/test/pool_test.rb

@@ -64,6 +64,33 @@ describe Beaneater::Pool do
         assert_equal '127.0.0.1', bc2.host
         assert_equal 11300, bc2.port
       end
+
+      after do
+        ENV['BEANSTALKD_URL'] = nil
+      end
+    end
+
+    describe "by configuring via Beaneater.configure" do
+      before do
+        Beaneater.configure.beanstalkd_url = ['0.0.0.0:11300', '127.0.0.1:11300']
+      end
+
+      it "should create 1 connection" do
+        bp = Beaneater::Pool.new
+        bc = bp.connections.first
+        bc2 = bp.connections.last
+
+        assert_equal 2, bp.connections.size
+        assert_equal '0.0.0.0', bc.host
+        assert_equal 11300, bc.port
+
+        assert_equal '127.0.0.1', bc2.host
+        assert_equal 11300, bc2.port
+      end
+
+      after do
+        Beaneater.configure.beanstalkd_url = ['0.0.0.0:11300']
+      end
     end
   end # new
 

data/test/stat_struct_test.rb

@@ -35,7 +35,7 @@ describe Beaneater::StatStruct do
     end
 
     it "should return expected keys" do
-      assert_equal ['foo', 'bar', 'baz', 'under_score'], @struct.keys
+      assert_equal ['foo', 'bar', 'baz', 'under_score'].sort, @struct.keys.sort
     end
   end # keys
 end

data/test/test_helper.rb

@@ -5,6 +5,7 @@ $:.unshift File.expand_path("../../lib")
 require 'beaneater'
 require 'fakeweb'
 require 'mocha'
+require 'json'
 
 FakeWeb.allow_net_connect = false
 

data/test/tube_test.rb

@@ -16,6 +16,9 @@ describe Beaneater::Tube do
     it "should insert a job" do
       @tube.put "bar put #{@time}"
       assert_equal "bar put #{@time}", @tube.peek(:ready).body
+      assert_equal 120, @tube.peek(:ready).ttr
+      assert_equal 65536, @tube.peek(:ready).pri
+      assert_equal 0, @tube.peek(:ready).delay
     end
 
     it "should insert a delayed job" do
@@ -37,12 +40,6 @@ describe Beaneater::Tube do
       assert_raises(Beaneater::DrainingError) { @tube.put "bar put #{@time}" }
     end
 
-    it "supports JSON" do
-      json = "{ 'foo' : 'bar' }"
-      @tube.put(json)
-      assert_equal 'bar', @tube.peek(:ready).body['foo']
-    end
-
     after do
       Beaneater::Connection.any_instance.unstub(:transmit)
     end
@@ -73,22 +70,59 @@ describe Beaneater::Tube do
     it "should return nil for empty peek" do
       assert_nil @tube.peek(:buried)
     end
+
+    it "supports valid JSON" do
+      json = '{ "foo" : "bar" }'
+      @tube.put(json)
+      assert_equal 'bar', JSON.parse(@tube.peek(:ready).body)['foo']
+    end
+
+    it "supports non valid JSON" do
+      json = '{"message":"hi"}'
+      @tube.put(json)
+      assert_equal 'hi', JSON.parse(@tube.peek(:ready).body)['message']
+    end
+
+    it "should support custom parser" do
+      Beaneater.configure.job_parser = lambda { |b| JSON.parse(b) }
+      json = '{"message":"hi"}'
+      @tube.put(json)
+      assert_equal 'hi', @tube.peek(:ready).body['message']
+    end
+
+    after do
+      Beaneater.configure.job_parser = lambda { |b| b }
+    end
   end # peek
 
   describe "for #reserve" do
     before do
       @time = Time.now.to_i
-      @tube.put "foo reserve #{@time}"
+      @json = %Q&{ "foo" : "#{@time} bar" }&
+      @tube.put @json
     end
 
     it "should reserve job" do
-      assert_equal "foo reserve #{@time}", @tube.reserve.body
+      @job = @tube.reserve
+      assert_equal "#{@time} bar", JSON.parse(@job.body)['foo']
+      @job.delete
     end
 
     it "should reserve job with block" do
       job = nil
       @tube.reserve { |j| job = j; job.delete }
-      assert_equal "foo reserve #{@time}", job.body
+      assert_equal "#{@time} bar", JSON.parse(job.body)['foo']
+    end
+
+    it "should support custom parser" do
+      Beaneater.configure.job_parser = lambda { |b| JSON.parse(b) }
+      @job = @tube.reserve
+      assert_equal "#{@time} bar", @job.body['foo']
+      @job.delete
+    end
+
+    after do
+      Beaneater.configure.job_parser = lambda { |b| b }
     end
   end # reserve
 

data/test/tubes_test.rb

@@ -134,7 +134,7 @@ describe Beaneater::Tubes do
 
     it "should raise TimedOutError no delete, with timeout" do
       @pool.tubes.watch 'tube'
-      @pool.tubes.reserve(0)
+      @pool.tubes.reserve(0)  { |j| job = j; job.delete }
       assert_raises(Beaneater::TimedOutError) { @pool.tubes.reserve(0) }
     end
 

metadata

@@ -1,103 +1,118 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: beaneater
-version: !ruby/object:Gem::Version
-  version: 0.1.2
+version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
-authors:
+authors: 
 - Nico Taing
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-07 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-11-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: minitest
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 4
+        - 1
+        - 0
         version: 4.1.0
   type: :development
+  requirement: *id001
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 4.1.0
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  requirement: *id002
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
   name: mocha
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  requirement: *id003
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
   name: fakeweb
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  requirement: *id004
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
   name: term-ansicolor
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  requirement: *id005
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id006
+  prerelease: false
 description: Simple beanstalkd client for ruby
-email:
+email: 
 - nico.taing@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .yardopts
 - CHANGELOG.md
@@ -109,6 +124,7 @@ files:
 - beaneater.gemspec
 - examples/demo.rb
 - lib/beaneater.rb
+- lib/beaneater/configuration.rb
 - lib/beaneater/connection.rb
 - lib/beaneater/errors.rb
 - lib/beaneater/job.rb
@@ -135,31 +151,40 @@ files:
 - test/test_helper.rb
 - test/tube_test.rb
 - test/tubes_test.rb
-homepage: ''
+homepage: ""
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Simple beanstalkd client for ruby.
-test_files:
+test_files: 
 - test/beaneater_test.rb
 - test/connection_test.rb
 - test/errors_test.rb