ayl-beanstalk 0.1.0 → 0.1.1

data/README.rdoc

@@ -3,6 +3,68 @@
 This gem provides a reference implementation of a beanstalk Engine for the
 {ayl}[https://github.com/j0hnds/ayl] gem.
 
+If you want to use this technology in a Rails 3.* application you can do the 
+following in your config/environments/*.rb files:
+
+    YourApp::Application.configure do
+
+    ...
+
+    config.after_initialize do
+      # Set up a delay for AYL so we make sure the object is
+      # saved before we pick it up off the queue. Defaults to 0
+      # Ayl::MessageOptions.default_delay = 2 
+
+      # Set up a priority fo AYL. The lower the priority number
+      # the higher the priority. The default is 512.
+      # Ayl::MessageOptions.default_priority = 1
+
+      # Set up a time to run for AYL. This is the number of seconds
+      # that a worker has to complete the job before the queuing engine
+      # re-inserts the message into the queue. Defaults to 120 seconds
+      # Ayl::MessageOptions.default_time_to_run = 120
+
+      # Set up the name of the queue to use in the queuing engine for
+      # messages. Typically, you will use the application version for
+      # the name of the queue so that you won't have problems with items
+      # left in the queue when the version of the software changes.
+      # The default is 'default'.
+      # Ayl::MessageOptions.default_queue_name = '1.2.3'
+
+      # Set up the logger for Ayl
+      Ayl::Logger.instance.logger = ::Rails.logger
+
+      # Set up the beanstalk engine for use
+      Ayl::Engine.add_engine(Ayl::Beanstalk::Engine.new('localhost', 8903)
+    end
+
+    end
+
+If beanstalkd is running at the time your application starts up, your async messages
+will be sent to beanstalkd. If beanstalkd is NOT running, your messages will be 
+invoked synchronously (without errors).
+
+Once you get your messages in beanstalkd, you will probably want them to get executed
+(or what would be the point?). This gem provides a couple of scripts to assist in 
+starting up a worker process to read messages off the beanstalkd queue and process them.
+
+* ayl_worker - This script runs in the foreground and processes messages off the beanstalkd queue.
+* ayl_worker_control - This script runs the ayl_worker script as a daemon to process messages in the background.
+
+For example, if you want to run the worker in the foreground you would invoke the following:
+
+    ayl_worker -a /var/www/application/current -r -e production -t default
+
+If you want to have the script run in the background:
+
+    ayl_worker_control start -- -a /var/www/application/current -r -e production -t default -p /tmp
+
+or to stop the background script:
+
+    ayl_worker_control stop -- -a /var/www/application/current -r -e production -t default -p /tmp
+
+The ayl_worker_control script can easily be invoked by an /etc/init.d script to allow your workers to start at server boot time.
+
 == Contributing to ayl-beanstalk
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/ayl-beanstalk.gemspec

@@ -0,0 +1,85 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "ayl-beanstalk"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["j0hnds@gmail.com"]
+  s.date = "2011-11-26"
+  s.description = "Ayl extension to provide beanstalk support."
+  s.email = "j0hnds@gmail.com"
+  s.executables = ["ayl_beanstalk", "ayl_worker", "ayl_worker_control"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "ayl-beanstalk.gemspec",
+    "bin/ayl_beanstalk",
+    "bin/ayl_worker",
+    "bin/ayl_worker_control",
+    "lib/ayl-beanstalk.rb",
+    "lib/ayl-beanstalk/command_line.rb",
+    "lib/ayl-beanstalk/engine.rb",
+    "lib/ayl-beanstalk/pool.rb",
+    "lib/ayl-beanstalk/worker.rb",
+    "spec/ayl_worker_spec.rb",
+    "spec/command_line_spec.rb",
+    "spec/engine_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/config/environment.rb",
+    "spec/support/exit_code_matchers.rb",
+    "spec/worker_spec.rb"
+  ]
+  s.homepage = "http://github.com/j0hnds/ayl-beanstalk"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Ayl extension to provide beanstalk support."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ayl>, [">= 0.1.0"])
+      s.add_runtime_dependency(%q<beanstalk-client>, [">= 1.1.0"])
+      s.add_runtime_dependency(%q<daemons>, [">= 1.1.0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.3.0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+    else
+      s.add_dependency(%q<ayl>, [">= 0.1.0"])
+      s.add_dependency(%q<beanstalk-client>, [">= 1.1.0"])
+      s.add_dependency(%q<daemons>, [">= 1.1.0"])
+      s.add_dependency(%q<rspec>, [">= 2.3.0"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<ayl>, [">= 0.1.0"])
+    s.add_dependency(%q<beanstalk-client>, [">= 1.1.0"])
+    s.add_dependency(%q<daemons>, [">= 1.1.0"])
+    s.add_dependency(%q<rspec>, [">= 2.3.0"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+  end
+end
+

data/lib/ayl-beanstalk/engine.rb

@@ -6,6 +6,8 @@ module Ayl
       include Ayl::Logging
       include Ayl::Beanstalk::Pool
 
+      attr_reader :host, :port
+
       def initialize(host='localhost', port=11300)
         logger.info "#{self.class.name}.initialize(#{host.inspect}, #{port})"
         @host = host

data/spec/engine_spec.rb

@@ -14,6 +14,11 @@ describe Ayl::Beanstalk::Engine do
       @engine.stub_chain(:logger, :error)
     end
 
+    it "should default to localhost and 11300 as the host port for the beanstalkd server" do
+      @engine.host.should == 'localhost'
+      @engine.port.should == 11300
+    end
+
     it "should respond true to the asynchronous? message" do
       @engine.asynchronous?.should be_true
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ayl-beanstalk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-20 00:00:00.000000000Z
+date: 2011-11-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ayl
-  requirement: &87968020 !ruby/object:Gem::Requirement
+  requirement: &76745740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *87968020
+  version_requirements: *76745740
 - !ruby/object:Gem::Dependency
   name: beanstalk-client
-  requirement: &87967750 !ruby/object:Gem::Requirement
+  requirement: &76745460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *87967750
+  version_requirements: *76745460
 - !ruby/object:Gem::Dependency
   name: daemons
-  requirement: &87967500 !ruby/object:Gem::Requirement
+  requirement: &76745190 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *87967500
+  version_requirements: *76745190
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &87967220 !ruby/object:Gem::Requirement
+  requirement: &76744930 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *87967220
+  version_requirements: *76744930
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &87966960 !ruby/object:Gem::Requirement
+  requirement: &76744580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *87966960
+  version_requirements: *76744580
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &87966690 !ruby/object:Gem::Requirement
+  requirement: &76744270 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *87966690
+  version_requirements: *76744270
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &87966350 !ruby/object:Gem::Requirement
+  requirement: &76743930 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *87966350
+  version_requirements: *76743930
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &87966010 !ruby/object:Gem::Requirement
+  requirement: &76743560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *87966010
+  version_requirements: *76743560
 description: Ayl extension to provide beanstalk support.
 email: j0hnds@gmail.com
 executables:
@@ -118,6 +118,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- ayl-beanstalk.gemspec
 - bin/ayl_beanstalk
 - bin/ayl_worker
 - bin/ayl_worker_control
@@ -148,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 349899887
+      hash: 36129679
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: