beanstalk-client 0.1

data/History.txt

@@ -0,0 +1,3 @@
+== 0.1 2007-12-12
+
+* Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 FIXME full name
+
+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/Manifest.txt

@@ -0,0 +1,27 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/beanstalk-client.rb
+lib/beanstalk-client/bag.rb
+lib/beanstalk-client/connection.rb
+lib/beanstalk-client/job.rb
+lib/beanstalk-client/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_beanstalk-client.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1 @@
+README

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'beanstalk-client/version'
+
+AUTHOR = 'Keith Rarick'  # can also be an array of Authors
+EMAIL = 'kr@essembly.com'
+DESCRIPTION = 'Ruby client library for the Beanstalk protocol'
+GEM_NAME = 'beanstalk-client' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'beanstalk' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Beanstalk::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'beanstalk-client documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'beanstalk-client'

data/lib/beanstalk-client.rb

@@ -0,0 +1,29 @@
+# beanstalk-client.rb - client library for beanstalk
+
+# Copyright (C) 2007 Philotic Inc.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+$:.unshift(File.dirname(__FILE__))
+
+module Beanstalk
+  extend self
+
+  attr_accessor :select
+
+  class UnexpectedResponse < RuntimeError
+  end
+end
+
+require 'beanstalk-client/connection'

data/lib/beanstalk-client/bag.rb

@@ -0,0 +1,36 @@
+# beanstalk-client/bag.rb - client library for beanstalk
+
+# Copyright (C) 2007 Philotic Inc.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+class Beanstalk::Bag
+  def initialize(initial_size=0, &default)
+    @default = default
+    @items = []
+    initial_size.times{give(default.call())}
+  end
+
+  def give(x)
+    (@items << x)[-1]
+  end
+
+  def take()
+    @items.pop or @default.call()
+  end
+
+  def size()
+    @items.size
+  end
+end

data/lib/beanstalk-client/connection.rb

@@ -0,0 +1,265 @@
+# beanstalk-client/connection.rb - client library for beanstalk
+
+# Copyright (C) 2007 Philotic Inc.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'socket'
+require 'fcntl'
+require 'yaml'
+require 'beanstalk-client/bag'
+require 'beanstalk-client/job'
+
+module Beanstalk
+  class RawConnection
+    attr_reader :addr
+
+    def initialize(addr, jptr=self)
+      @addr = addr
+      @jptr = jptr
+      host, port = addr.split(':')
+      @socket = TCPSocket.new(host, port.to_i)
+
+      # Don't leak fds when we exec.
+      @socket.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+    end
+
+    def put(body, pri=65536, delay=0)
+      @socket.write("put #{pri} #{delay} #{body.size}\r\n#{body}\r\n")
+      check_resp('INSERTED')
+      :ok
+    end
+
+    def yput(obj, pri=65536, delay=0)
+      put(YAML.dump(obj), pri, delay)
+    end
+
+    def peek()
+      @socket.write("peek\r\n")
+      begin
+        Job.new(@jptr, *read_job('FOUND'))
+      rescue UnexpectedResponse
+        nil
+      end
+    end
+
+    def peek_job(id)
+      @socket.write("peek #{id}\r\n")
+      Job.new(@jptr, *read_job('FOUND'))
+    end
+
+    def reserve()
+      @socket.write("reserve\r\n")
+      Job.new(@jptr, *read_job('RESERVED'))
+    end
+
+    def delete(id)
+      @socket.write("delete #{id}\r\n")
+      check_resp('DELETED')
+      :ok
+    end
+
+    def release(id, pri, delay)
+      @socket.write("release #{id} #{pri} #{delay}\r\n")
+      check_resp('RELEASED')
+      :ok
+    end
+
+    def bury(id, pri)
+      @socket.write("bury #{id} #{pri}\r\n")
+      check_resp('BURIED')
+      :ok
+    end
+
+    def stats()
+      @socket.write("stats\r\n")
+      read_yaml('OK')
+    end
+
+    def job_stats(id)
+      @socket.write("stats #{id}\r\n")
+      read_yaml('OK')
+    end
+
+    private
+
+    def get_resp()
+      r = @socket.gets("\r\n")
+      raise EOFError if r == nil
+      r[0...-2]
+    end
+
+    def check_resp(word)
+      r = get_resp()
+      rword, *vals = r.split(/\s+/)
+      raise UnexpectedResponse.new(r) if word and rword != word
+      vals
+    end
+
+    def read_job(word)
+      # Give the user a chance to select on multiple fds.
+      Beanstalk.select.call([@socket]) if Beanstalk.select
+
+      id, pri, bytes = check_resp(word).map{|s| s.to_i}
+      body = read_bytes(bytes)
+      raise 'bad trailer' if read_bytes(2) != "\r\n"
+      [id, pri, body]
+    end
+
+    def read_yaml(word)
+      bytes_s, = check_resp(word)
+      yaml = read_bytes(bytes_s.to_i)
+      raise 'bad trailer' if read_bytes(2) != "\r\n"
+      YAML::load(yaml)
+    end
+
+    def read_bytes(n)
+      str = @socket.read(n)
+      raise EOFError, 'End of file reached' if str == nil
+      raise EOFError, 'End of file reached' if str.size < n
+      str
+    end
+  end
+
+  # Same interface as RawConnection.
+  # With this you can reserve more than one job at a time.
+  class Connection
+    attr_reader :addr
+
+    def initialize(addr, jptr=self)
+      @addr = addr
+      @misc = RawConnection.new(addr, jptr)
+      @free = Bag.new{RawConnection.new(addr, jptr)}
+      @used = {}
+    end
+
+    def reserve()
+      c = @free.take()
+      j = c.reserve()
+      @used[j.id] = c
+      j
+    ensure
+      @free.give(c) if c and not j
+    end
+
+    def delete(id)
+      @used[id].delete(id)
+      @free.give(@used.delete(id))
+    end
+
+    def release(id, pri, delay)
+      @used[id].release(id, pri, delay)
+      @free.give(@used.delete(id))
+    end
+
+    def bury(id, pri)
+      @used[id].bury(id, pri)
+      @free.give(@used.delete(id))
+    end
+
+    def method_missing(selector, *args, &block)
+      @misc.send(selector, *args, &block)
+    end
+  end
+
+  class CleanupWrapper
+    def initialize(addr, multi)
+      @conn = Connection.new(addr, self)
+      @multi = multi
+    end
+
+    def method_missing(selector, *args, &block)
+      begin
+        @conn.send(selector, *args, &block)
+      rescue EOFError, Errno::ECONNRESET => ex
+        @multi.remove(@conn)
+        raise ex
+      end
+    end
+  end
+
+  class Pool
+    def initialize(addrs)
+      @addrs = addrs
+      connect()
+    end
+
+    def connect()
+      @connections ||= {}
+      @addrs.each do |addr|
+        begin
+          if !@connections.include?(addr)
+            puts "connecting to beanstalk at #{addr}"
+            @connections[addr] = CleanupWrapper.new(addr, self)
+          end
+        rescue Exception => ex
+          puts "#{ex.class}: #{ex}"
+          #puts begin ex.fixed_backtrace rescue ex.backtrace end
+        end
+      end
+      @connections.size
+    end
+
+    def open_connections()
+      @connections.values()
+    end
+
+    def put(body, pri=65536)
+      pick_connection.put(body, pri)
+    rescue EOFError, Errno::ECONNRESET
+      connect()
+      retry
+    end
+
+    def yput(obj, pri=65536)
+      pick_connection.yput(obj, pri)
+    rescue EOFError, Errno::ECONNRESET
+      connect()
+      retry
+    end
+
+    def reserve()
+      pick_connection.reserve()
+    rescue EOFError, Errno::ECONNRESET
+      connect()
+      retry
+    end
+
+    def raw_stats()
+      Hash[*@connections.map{|a,c| [a, c.stats()]}.inject([]){|a,b|a+b}]
+    end
+
+    def stats()
+      raw_stats.values.inject({}){|sums,h| sums.merge(h) {|k,o,n| o + n}}
+    end
+
+    def remove(conn)
+      @connections.delete(conn.addr)
+    end
+
+    def peek()
+      open_connections.each do |c|
+        job = c.peek
+        return job if job
+      end
+      nil
+    end
+
+    private
+
+    def pick_connection()
+      open_connections[rand(open_connections.size)] or raise 'not connected'
+    end
+  end
+end