beanqueue 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2011-10-19
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,5 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/beanqueue.rb

data/README.rdoc

@@ -0,0 +1,95 @@
+= beanqueue
+
+* http://github.com/GearHead90/beanqueue
+
+== DESCRIPTION:
+
+This is a beanstalk-based job-queueing-manager, replacement for gem 'stalker' with additions:
+
+1. jobs grouping
+2. jobs threading and forking
+3. logging
+4. background run (as daemon)
+5. stalker makes to include full gem in application, but needed only client-side
+
+This is a client-side gem. For a worker you need
+
+* http://github.com/GearHead90/beanworker
+
+== INSTALL:
+
+gem install beanqueue
+
+== CONFIGURATION:
+
+in regular app:
+
+    require 'beanqueue'    
+    Beanqueue.connect 'localhost:11300'
+
+for multiple servers:
+
+    Beanqueue.connect 'localhost:11300', '192.168.1.1:11300', '192.168.1.1:11301'
+
+in rails app just make config/beanstalk.yml:
+
+    host: localhost
+    port: 11300
+
+or for multiple servers:
+   
+    nodes:
+      - host: localhost
+        port: 11300
+
+      - host: 192.168.1.1
+        port: 11300
+
+      - host: 192.168.1.1
+        port: 11301
+
+you can load YAML from non-Rails app with:
+
+    Beanqueue.load './config/beanstalk.yml'
+
+== USAGE:
+
+    Beanqueue.push 'some.job', param1: 'val1', param2: 'val2'
+
+or with params:
+
+    Beanqueue.push 'some.job', 
+       { param1: 'val1', param2: 'val2' },
+       timeout: 60.seconds, # job will be re-put after this time of execution
+                            # default is 2.minutes
+       priority: 100,       # beanstalk inner priority
+                            # I prefer to use grouping instead
+       delay: 5,            # delay job queuing
+                            # default is 0
+       fork: true           # does job should be performed in fork
+                            # default is set in worker/job definition
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Andrew Shaydurov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/beanqueue'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'beanqueue' do
+  self.developer 'Andrew Shaydurov', 'gearhead@it-primorye.ru'
+  self.rubyforge_name     = self.name
+  self.extra_deps         = {'beanstalk-client' => '>=0'}
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/beanqueue.rb

@@ -0,0 +1,30 @@
+require 'beanstalk-client'
+
+module Beanqueue
+  VERSION = '0.0.1'
+
+  class << self
+    def load(yaml_path)
+      config = YAML.load(open(yaml_path))
+      if config['nodes']
+        connect *(config['nodes'].map { |node| "#{node['host']}:#{node['port']}" })
+      else
+        connect "#{config['host']}:#{config['port']}"
+      end
+    end
+
+    def connect(*nodes)
+      @connection = Beanstalk::Pool.new nodes.to_a
+    end
+
+    def push(name, args={}, opts={})
+      args['__fork__'] = opts[:fork] if opts[:fork]
+      @connection.use name
+      @connection.yput args, (opts[:priority] || 65536), [0, opts[:delay].to_i].max, (opts[:timeout] || 120)
+    end
+  end
+end
+
+if defined? Rails
+  Beanqueue.load Rails.root.join('config', 'beanstalk.yml')
+end

data/test/test_beanqueue.rb

@@ -0,0 +1,52 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/beanqueue'
+
+puts 'Be sure to set up beanstalk daemon on localhost:11300, also be sure to clean all queues'
+
+class TestBeanqueue < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_connect
+    conn = Beanqueue.connect 'localhost:11300'
+    assert conn && conn.instance_eval { @connections['localhost:11300'] }, 'connection should be set up'
+    puts conn
+  end
+
+  def test_load
+    conn = Beanqueue.load File.expand_path('../configs/one.yml', __FILE__)
+    assert conn && conn.instance_eval { @connections['localhost:11300'] }, 'connection from one-node YAML config should be set up'
+
+    conn = Beanqueue.load File.expand_path('../configs/many.yml', __FILE__)
+    assert conn && conn.instance_eval { @connections['localhost:11300'] }, 'connection from many-nodes YAML config should be set up'
+  end
+
+  def test_push
+    conn_receiver = Beanstalk::Pool.new ['localhost:11300']
+    conn = Beanqueue.connect 'localhost:11300'
+    Beanqueue.push 'some.job'
+
+    conn_receiver.watch 'some.job'
+
+    job = nil
+    assert_nothing_raised do
+      job = conn_receiver.reserve(2)
+    end
+    job.delete
+    
+    Beanqueue.push 'some.job', param1: 'val1', param2: 666, 'param3' => true
+    job = conn_receiver.reserve(2)
+    args = job.ybody
+    assert_equal({ param1: 'val1', param2: 666, 'param3' => true }, args, 'arguments are stored incorrectly')
+    job.delete
+
+    Beanqueue.push 'some.job', {}, fork: true, delay: 2, timeout: 300, priority: 100
+    job = conn_receiver.reserve(3)
+    assert_equal({ '__fork__' => true }, job.ybody, 'fork param is not stored')
+    assert_equal 2, job.delay, 'delay is not stored'
+    assert_equal 300, job.ttr, 'ttr is not stored'
+    assert_equal 100, job.pri, 'pri is not stored'
+    job.delete
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: beanqueue
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Shaydurov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: beanstalk-client
+  requirement: &7981320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7981320
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &7980780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: *7980780
+description: ! 'This is a beanstalk-based job-queueing-manager, replacement for gem
+  ''stalker'' with additions:
+
+
+  1. jobs grouping
+
+  2. jobs threading and forking
+
+  3. logging
+
+  4. background run (as daemon)
+
+  5. stalker makes to include full gem in application, but needed only client-side
+
+
+  This is a client-side gem. For a worker you need
+
+
+  * http://github.com/GearHead90/beanworker'
+email:
+- gearhead@it-primorye.ru
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+files:
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/beanqueue.rb
+- test/test_beanqueue.rb
+- .gemtest
+homepage: http://github.com/GearHead90/beanqueue
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: beanqueue
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: ! 'This is a beanstalk-based job-queueing-manager, replacement for gem ''stalker''
+  with additions:  1'
+test_files:
+- test/test_beanqueue.rb