bbqueue 0.0.1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,11 @@
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+
+install:
+  - "travis_retry bundle install"
+
+script: "bundle exec rake test"
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bbqueue.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Benjamin Vetter
+
+MIT License
+
+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/README.md

@@ -0,0 +1,130 @@
+# BBQueue
+
+[![Build Status](https://secure.travis-ci.org/mrkamel/bbqueue.png?branch=master)](http://travis-ci.org/mrkamel/bbqueue)
+[![Code Quality](https://codeclimate.com/github/mrkamel/bbqueue.png)](https://codeclimate.com/github/mrkamel/bbqueue)
+[![Still Maintained](http://stillmaintained.com/mrkamel/bbqueue.png)](http://stillmaintained.com/mrkamel/bbqueue)
+[![Dependency Status](https://gemnasium.com/mrkamel/bbqueue.png?travis)](https://gemnasium.com/mrkamel/bbqueue)
+
+BBQueue is an opinionated ruby gem to queue and process background jobs. Other
+gems for this purpose usually don't work with ruby objects and serialize only
+method arguments. Instead, BBQueue jobs are simple ruby objects:
+
+```ruby
+MyQueue.enqueue MyJob.new
+```
+
+BBQueue jobs need to fulfill the following interface:
+
+1. The object contains an instance method `#work` without any arguments
+2. The object must be serializable via `Marshal.dump` and `Marshal.load`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bbqueue'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bbqueue
+
+## Usage
+
+BBQueue is currently built on top of the `stalking` gem. Therefore, you have to
+install beanstalkd.
+
+### Producer
+
+To enqueue a job, first create a queue, aka Producer:
+
+```ruby
+SomeQueue = BBQueue::Producer.new("default")
+```
+
+where `default` is the queue name. You can pass `stalking`-specific options via:
+
+```ruby
+AnotherQueue = BBQueue::Producer.new("another", :logger => ..., :delay => ..., :servers => ..., :ttr => ..., ...)
+```
+
+Then enqueue a job:
+
+```ruby
+SomeQueue.enqueue MyJob.new("Some argument")
+```
+
+You can pass `stalking`-specific options here as well:
+
+```ruby
+SomeQueue.enqueue MyJob.new("Some argument"), :delay => 5, ...
+```
+
+where `MyJob` looks like:
+
+```ruby
+class MyJob
+  attr_accessor :argument
+
+  def initialize(argument)
+    self.argument = argument
+  end
+
+  def work
+    # Do some work
+  end
+end
+```
+
+### Consumer
+
+To process the enqueued jobs, create a file, e.g. jobs.rb:
+
+```ruby
+require "bbqueue"
+
+BBQueue::Consumer.new "default"
+```
+
+and run it via:
+
+    $ bbqueue jobs.rb
+
+BBQueue will loop through all the jobs, run them, and will then wait for new
+ones. You can pass multiple queue names and `stalking`-specific options:
+
+```ruby
+BBQueue.new ["default", "important"], :logger => ..., :servers => ...
+```
+
+By using a separate file like `jobs.rb`, you can load your environment or do
+other fancy things before finally calling `BBQueue::Consumer.new`. You can e.g.
+load your rails environment:
+
+```ruby
+require File.expand_path("../environment", __FILE__)
+
+Rails.application.eager_load!
+
+SomeLogger.info "jobs booted into #{Rails.env.inspect} environment"
+
+BBQueue::Consumer.new "background", :logger => SomeLogger
+```
+
+## Graceful Termination
+
+Like for the `stalking` gem, you can stop a worker gracefully by sending a QUIT
+signal to it. The worker will finish its current job and terminate afterwards.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/bbqueue/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+

data/bbqueue.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bbqueue/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bbqueue"
+  spec.version       = BBQueue::VERSION
+  spec.authors       = ["Benjamin Vetter"]
+  spec.email         = ["vetter@plainpicture.de"]
+  spec.summary       = %q{Queue and process ruby job objects in the background}
+  spec.description   = %q{Queue and process ruby job objects in the background}
+  spec.homepage      = "https://github.com/mrkamel/bbqueue"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+
+  spec.add_dependency "stalking"
+end

data/bin/bbqueue

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require "bbqueue"
+
+file = ARGV.shift or abort("Usage: bbqueue [file]")
+file = "./#{file}" unless file.match(/^[\/.]/)
+
+load file
+

data/lib/bbqueue.rb

@@ -0,0 +1,12 @@
+
+require "stalking"
+
+require "bbqueue/version"
+require "bbqueue/serializer"
+require "bbqueue/null_logger"
+require "bbqueue/fatal_logger"
+require "bbqueue/producer"
+require "bbqueue/consumer"
+
+module BBQueue; end
+

data/lib/bbqueue/consumer.rb

@@ -0,0 +1,30 @@
+
+module BBQueue
+  class Consumer
+    def initialize(queue_names, options = {})
+      logger = options[:logger] || BBQueue::NullLogger.new
+
+      Stalking::Consumer.new options.merge(:logger => BBQueue::FatalLogger.new(logger)) do
+        Array(queue_names).each do |queue_name|
+          job queue_name do |args|
+            BBQueue::Serializer.load(args["object"]).work
+          end
+        end
+
+        before do |queue_name, args|
+          logger.info "Job #{BBQueue::Serializer.load(args["object"]).inspect} on #{queue_name.inspect} started"
+        end
+
+        after do |queue_name, args|
+          logger.info "Job #{BBQueue::Serializer.load(args["object"]).inspect} on #{queue_name.inspect} finished"
+        end
+
+        error do |e, queue_name, args|
+          logger.error "Job #{BBQueue::Serializer.load(args["object"]).inspect} on #{queue_name.inspect} failed"
+          logger.error e
+        end
+      end
+    end
+  end
+end
+

data/lib/bbqueue/fatal_logger.rb

@@ -0,0 +1,18 @@
+
+module BBQueue
+  class FatalLogger
+    def initialize(logger)
+      @logger = logger
+    end
+
+    def debug(*args); end
+    def info(*args); end
+    def warn(*args); end
+    def error(*args); end
+
+    def fatal(*args)
+      @logger.error(*args)
+    end
+  end
+end
+

data/lib/bbqueue/null_logger.rb

@@ -0,0 +1,11 @@
+
+module BBQueue
+  class NullLogger
+    def debug(*args); end
+    def info(*args); end
+    def warn(*args); end
+    def error(*args); end
+    def fatal(*args); end
+  end
+end
+

data/lib/bbqueue/producer.rb

@@ -0,0 +1,27 @@
+
+module BBQueue
+  class Producer
+    attr_accessor :queue_name, :logger, :stalking
+
+    def initialize(queue_name, options = {})
+      self.queue_name = queue_name
+      self.logger = options[:logger] || BBQueue::NullLogger.new
+      self.stalking = Stalking::Producer.new(options.merge(:logger => BBQueue::FatalLogger.new(logger)))
+    end
+
+    def enqueue(object, options = {})
+      logger.info "Enqueue #{object.inspect} with #{options.inspect} on #{queue_name.inspect}"
+
+      obj = BBQueue::Serializer.dump(object)
+
+      unless stalking.enqueue(queue_name, { "object" => obj }, options)
+        logger.error "Enqueue #{obj.inspect} with #{options.inspect} on #{queue_name.inspect} failed"
+
+        return false
+      end
+
+      true
+    end
+  end
+end
+

data/lib/bbqueue/serializer.rb

@@ -0,0 +1,15 @@
+
+require "base64"
+
+module BBQueue
+  module Serializer
+    def self.dump(object)
+      Base64.strict_encode64 Marshal.dump(object)
+    end
+
+    def self.load(object)
+      Marshal.load Base64.strict_decode64(object)
+    end
+  end
+end
+

data/lib/bbqueue/version.rb

@@ -0,0 +1,3 @@
+module BBQueue
+  VERSION = "0.0.1"
+end

data/test/bbqueue/consumer_test.rb

@@ -0,0 +1,38 @@
+
+require File.expand_path("../../test_helper", __FILE__)
+
+class BBQueue::ConsumerTest < MiniTest::Test
+  def test_job
+    consumer = BBQueue::Consumer.new("default")
+
+    assert_equal 3, Stalking::Consumer.instances.last.run_job("default", { "object" => BBQueue::Serializer.dump(BBQueue::TestJob.new(1, 2)) })
+  end
+
+  def test_error
+    logger = BBQueue::TestLogger.new
+    consumer = BBQueue::Consumer.new("default", :logger => logger)
+
+    assert_difference "logger.count", 2 do
+      Stalking::Consumer.instances.last.run_error("Error", "default", { "object" => BBQueue::Serializer.dump(BBQueue::TestJob.new(1, 2)) })
+    end
+  end
+
+  def test_before
+    logger = BBQueue::TestLogger.new
+    consumer = BBQueue::Consumer.new("default", :logger => logger)
+
+    assert_difference "logger.count" do
+      Stalking::Consumer.instances.last.run_before("default", { "object" => BBQueue::Serializer.dump(BBQueue::TestJob.new(1, 2)) })
+    end
+  end
+
+  def test_after
+    logger = BBQueue::TestLogger.new
+    consumer = BBQueue::Consumer.new("default", :logger => logger)
+
+    assert_difference "logger.count" do
+      Stalking::Consumer.instances.last.run_after("default", { "object" => BBQueue::Serializer.dump(BBQueue::TestJob.new(1, 2)) })
+    end
+  end
+end
+

data/test/bbqueue/fatal_logger_test.rb

@@ -0,0 +1,29 @@
+
+require File.expand_path("../../test_helper", __FILE__)
+
+class BBQueue::FatalLoggerTest < MiniTest::Test
+  def setup
+    @logger = BBQueue::FatalLogger.new(BBQueue::NullLogger.new)
+  end
+
+  def test_debug
+    assert_nothing_raised { @logger.debug "Debug" }
+  end
+
+  def test_info
+    assert_nothing_raised { @logger.info "Info" }
+  end
+
+  def test_warn
+    assert_nothing_raised { @logger.warn "Warn" }
+  end
+
+  def test_error
+    assert_nothing_raised { @logger.error "Error" }
+  end
+
+  def test_fatal
+    assert_nothing_raised { @logger.fatal "Fatal" }
+  end
+end
+

data/test/bbqueue/null_logger_test.rb

@@ -0,0 +1,29 @@
+
+require File.expand_path("../../test_helper", __FILE__)
+
+class BBQueue::NullLoggerTest < MiniTest::Test
+  def setup
+    @logger = BBQueue::NullLogger.new
+  end
+
+  def test_debug
+    assert_nothing_raised { @logger.debug "Debug" }
+  end
+
+  def test_info
+    assert_nothing_raised { @logger.info "Info" }
+  end
+
+  def test_warn
+    assert_nothing_raised { @logger.warn "Warn" }
+  end
+
+  def test_error
+    assert_nothing_raised { @logger.error "Error" }
+  end
+
+  def test_fatal
+    assert_nothing_raised { @logger.fatal "Fatal" }
+  end
+end
+

data/test/bbqueue/producer_test.rb

@@ -0,0 +1,14 @@
+
+require File.expand_path("../../test_helper", __FILE__)
+
+class BBQueue::ProducerTest < MiniTest::Test
+  def test_enqueue
+    test_job = BBQueue::TestJob.new(1, 2)
+
+    producer = BBQueue::Producer.new("queue")
+    producer.enqueue test_job, :delay => 10
+
+    assert_equal ["queue", { "object" => BBQueue::Serializer.dump(test_job) }, { :delay => 10 }], producer.stalking.queue.last
+  end
+end
+

data/test/bbqueue/serializer_test.rb

@@ -0,0 +1,11 @@
+
+require File.expand_path("../../test_helper", __FILE__)
+
+class BBQueue::SerializerTest < MiniTest::Test
+  def test_dump_and_load
+    test_job = BBQueue::TestJob.new(1, 2)
+
+    assert_equal test_job, BBQueue::Serializer.load(BBQueue::Serializer.dump(test_job))
+  end
+end
+

data/test/bbqueue/stalking.rb

@@ -0,0 +1,78 @@
+
+module Stalking
+  class Consumer
+    class Handlers
+      attr_accessor :job_handlers, :error_handlers, :before_handlers, :after_handlers
+
+      def initialize
+        self.job_handlers = {}
+
+        self.error_handlers = []
+        self.before_handlers = []
+        self.after_handlers = []
+      end
+
+      def job(name, &block)
+        self.job_handlers[name] = block
+      end
+
+      def error(&block)
+        self.error_handlers.push block
+      end
+
+      def before(&block)
+        self.before_handlers.push block
+      end
+
+      def after(&block)
+        self.after_handlers.push block
+      end
+    end
+
+    def self.instances=(instances)
+      @instances = instances
+    end
+
+    def self.instances
+      @instances
+    end
+
+    self.instances = []
+
+    def initialize(options = {}, &block)
+      @handlers = Handlers.new
+      @handlers.instance_exec(&block)
+
+      self.class.instances.push self
+    end
+
+    def run_job(name, args)
+      @handlers.job_handlers[name].call(args)
+    end
+
+    def run_error(e, name, args)
+      @handlers.error_handlers.each { |error| error.call e, name, args }
+    end
+
+    def run_before(name, args)
+      @handlers.before_handlers.each { |before| before.call name, args }
+    end
+
+    def run_after(name, args)
+      @handlers.after_handlers.each { |after| after.call name, args }
+    end
+  end
+
+  class Producer
+    attr_accessor :queue
+
+    def initialize(options = {})
+      self.queue = []
+    end
+
+    def enqueue(name, args = {}, options = {})
+      queue.push [name, args, options]
+    end
+  end
+end
+

data/test/bbqueue/test_job.rb

@@ -0,0 +1,19 @@
+
+class BBQueue::TestJob
+  attr_accessor :x, :y
+
+  def initialize(x, y)
+    self.x = x
+    self.y = y
+  end
+
+  def ==(test_object)
+    [self.x, self.y] == [test_object.x, test_object.y]
+  end
+
+  def work
+    x + y
+  end
+end
+
+

data/test/bbqueue/test_logger.rb

@@ -0,0 +1,31 @@
+
+class BBQueue::TestLogger
+  def initialize
+    @messages = []
+  end
+
+  def debug(object)
+    @messages.push object
+  end
+
+  def info(object)
+    @messages.push object
+  end
+
+  def warn(object)
+    @messages.push object
+  end
+
+  def error(object)
+    @messages.push object
+  end
+
+  def fatal(object)
+    @messages.push object
+  end
+
+  def count
+    @messages.size
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,34 @@
+
+require "bbqueue"
+require "minitest"
+require "minitest/autorun"
+
+require File.expand_path("../bbqueue/stalking", __FILE__)
+require File.expand_path("../bbqueue/test_job", __FILE__)
+require File.expand_path("../bbqueue/test_logger", __FILE__)
+
+class MiniTest::Test
+  def assert_nothing_raised
+    yield
+  rescue => e
+    raise "Exception #{e.message} should be raised"
+  end 
+
+  def assert_difference(expression, difference = 1, message = nil, &block)
+    expressions = Array(expression)
+
+    exps = expressions.map { |e|
+      e.respond_to?(:call) ? e : lambda { eval(e, block.binding) }
+    }
+    before = exps.map { |e| e.call }
+
+    yield
+
+    expressions.zip(exps).each_with_index do |(code, e), i|
+      error  = "#{code.inspect} didn't change by #{difference}"
+      error  = "#{message}.\n#{error}" if message
+      assert_equal(before[i] + difference, e.call, error)
+    end
+  end
+end
+

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: bbqueue
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Benjamin Vetter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stalking
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Queue and process ruby job objects in the background
+email:
+- vetter@plainpicture.de
+executables:
+- bbqueue
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bbqueue.gemspec
+- bin/bbqueue
+- lib/bbqueue.rb
+- lib/bbqueue/consumer.rb
+- lib/bbqueue/fatal_logger.rb
+- lib/bbqueue/null_logger.rb
+- lib/bbqueue/producer.rb
+- lib/bbqueue/serializer.rb
+- lib/bbqueue/version.rb
+- test/bbqueue/consumer_test.rb
+- test/bbqueue/fatal_logger_test.rb
+- test/bbqueue/null_logger_test.rb
+- test/bbqueue/producer_test.rb
+- test/bbqueue/serializer_test.rb
+- test/bbqueue/stalking.rb
+- test/bbqueue/test_job.rb
+- test/bbqueue/test_logger.rb
+- test/test_helper.rb
+homepage: https://github.com/mrkamel/bbqueue
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Queue and process ruby job objects in the background
+test_files:
+- test/bbqueue/consumer_test.rb
+- test/bbqueue/fatal_logger_test.rb
+- test/bbqueue/null_logger_test.rb
+- test/bbqueue/producer_test.rb
+- test/bbqueue/serializer_test.rb
+- test/bbqueue/stalking.rb
+- test/bbqueue/test_job.rb
+- test/bbqueue/test_logger.rb
+- test/test_helper.rb