background_bunnies 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Johan Hernandez
+
+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,29 @@
+# BackgroundBunnies
+
+Background workers based on AMQP Bunny gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'background_bunnies'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install background_bunnies
+
+## Usage
+
+See the examples ;)
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/background_bunnies'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/background_bunnies.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'background_bunnies/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "background_bunnies"
+  gem.version       = BackgroundBunnies::VERSION
+  gem.authors       = ["Firebaseco"]
+  gem.email         = ["hello@firebase.co"]
+  gem.description   = %q{AMQP based workers}
+  gem.summary       = %q{Background workers based on AMQP and the bunny gem}
+  gem.homepage      = "https://github.com/firebaseco/background_bunnies"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency "bunny", ">= 0.9.0.pre7"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest"
+end

data/examples/increments.rb

@@ -0,0 +1,36 @@
+require "bundler"
+Bundler.setup
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require 'background_bunnies'
+require 'bunny'
+
+class BackgroundBunnies::Workers::IncrementCounter
+  include BackgroundBunnies::Bunny
+  group :default
+  def process(job)
+    step = job.payload['step'] || 1
+    self.class.counter += step
+    p "Incrementing: #{step} for a total of #{self.class.counter}"
+  end
+
+  def on_error(job, err)
+    super # log the error to stderr
+  end
+
+  def self.counter
+    @counter || 0
+  end
+
+  def self.counter=(c)
+    @counter = c
+  end
+
+end
+
+class BackgroundBunnies::Workers::ResetCounter
+  include BackgroundBunnies::Bunny
+  def process(job)
+    BackgroundBunnies::Workers::IncrementCounter.counter = 0
+    p "Reseting the count"
+  end
+end

data/examples/increments_producer.rb

@@ -0,0 +1,13 @@
+require_relative 'increments'
+require 'thread'
+connection = Bunny.new
+connection.start
+
+producer = BackgroundBunnies::Workers::IncrementCounter.create_producer connection
+step = 0.1
+while true 
+  step += 0.1
+  sleep 1
+  producer.enqueue({'step'=>step})
+  p "Enqueued #{step}"
+end

data/examples/increments_producer_reset.rb

@@ -0,0 +1,7 @@
+require_relative 'increments'
+
+connection = Bunny.new
+connection.start
+
+producer = BackgroundBunnies::Workers::ResetCounter.create_producer connection
+producer.enqueue({})

data/examples/increments_worker.rb

@@ -0,0 +1,7 @@
+require_relative "increments"
+
+connection = Bunny.new
+connection.start
+BackgroundBunnies.configure(:default, connection)
+
+BackgroundBunnies.run :default

data/lib/background_bunnies.rb

@@ -0,0 +1,56 @@
+require "background_bunnies/version"
+require "background_bunnies/logger"
+require "background_bunnies/bunny"
+require "background_bunnies/producer"
+require "background_bunnies/job"
+require "background_bunnies/workers"
+require "thread"
+
+module BackgroundBunnies
+
+  class << self
+
+    #
+    # Group Connection Configurations
+    #
+    def configurations
+      @configs || @configs = {}
+    end
+
+    #
+    # Configures the connection of a group
+    #
+    def configure(group, connection)
+      info "Configuring #{group} connection"
+      configurations[group] = connection
+      if connection.status == :not_connected
+        connection.start
+      end
+    end
+
+    #
+    # Runs all the tasks in the given group and waits.
+    #
+    def run(group)
+      connection = configurations[group]
+      klasses = describe_group(group)
+      info "Running #{group} workers: #{ klasses.join(',') }"
+      klasses.each do |klass|
+        instance = klass.new
+        instance.start connection
+        info "Started worker: #{klass.demodulized_class_name}"
+      end
+      Thread.current.join
+    end
+
+    #
+    # Describe types in BackgroundBunnies::Workers::* in the given group.
+    #
+    def describe_group(group)
+      worker_names = BackgroundBunnies::Workers.constants.collect! { |worker_name| BackgroundBunnies::Workers.const_get(worker_name) }
+      worker_names.select {|klass| klass.group_name == group }
+    end
+
+  end
+
+end

data/lib/background_bunnies/bunny.rb

@@ -0,0 +1,103 @@
+require 'thread'
+require_relative 'job'
+
+module BackgroundBunnies
+  module Bunny
+
+    module BunnyConfigurators
+
+      def group(group_name)
+        @group_name = group_name
+      end
+
+      def queue(queue_name)
+        @queue_name = queue_name.to_s
+      end
+
+      def group_name
+        @group_name || :default
+      end
+
+      def queue_name
+        @queue_name || demodulized_class_name
+      end
+
+      def demodulized_class_name
+        path = name
+        if i = path.rindex('::')
+          path[(i+2)..-1]
+        else
+          path
+        end
+      end
+
+      def create_producer(connection)
+        BackgroundBunnies::Producer.new(connection, queue_name)
+      end
+
+    end
+
+    def self.included(base)
+      base.extend(BunnyConfigurators)
+    end
+
+    #
+    # Returns the name of the queue for the Worker
+    #
+    def queue_name
+      self.class.queue_name
+    end
+
+    attr_reader :channel
+    attr_reader :queue
+    attr_reader :consumer
+
+    #
+    # Starts the Worker
+    #
+    def start(connection)
+      @channel = connection.create_channel
+      @queue = @channel.queue(queue_name)
+      @consumer = @queue.subscribe(block: false, ack: true) do |info, properties, payload|
+        job = Job.new(JSON.parse!(payload), info, properties)
+        err = nil
+        begin 
+          self.process(job) 
+        rescue =>e
+          err = e
+        end
+        unless err
+          @channel.ack(info.delivery_tag, false)
+        else
+          # processing went wrong, requeing message
+          @channel.reject(info.delivery_tag, true)
+          on_error(job, err)
+        end
+      end
+    end
+
+    def on_error(job, err)
+        log_error "Error processing #{job.info.delivery_tag}: #{err.message}, #{err.backtrace.join('\n')}"
+    end
+
+    def log_error(a)
+      BackgroundBunnies.error "#{queue_name}: #{a}"
+    end
+
+    #
+    # Process a Job. Implemented by the class.
+    #
+    def process(job)
+
+    end
+
+    #
+    # Starts the worker instance and blocks the current thread.
+    #
+    def run(connection)
+      start connection
+      Thread.current.join
+    end
+
+  end
+end

data/lib/background_bunnies/job.rb

@@ -0,0 +1,13 @@
+module BackgroundBunnies
+  class Job
+    attr_reader :info
+    attr_reader :properties
+    attr_reader :payload
+
+    def initialize(payload, info = nil, properties = nil)
+      @info = info
+      @properties = properties
+      @payload = payload
+    end
+  end
+end

data/lib/background_bunnies/logger.rb

@@ -0,0 +1,15 @@
+module BackgroundBunnies
+
+  def self.log(a)
+    p "[log] BackgroundBunnies -> #{a}"
+  end
+
+  def self.info(a)
+    p "[info] BackgroundBunnies -> #{a}"
+  end
+
+  def self.error(a)
+    $stderr.puts "[error] BackgroundBunnies -> #{a}"
+  end
+
+end

data/lib/background_bunnies/producer.rb

@@ -0,0 +1,23 @@
+require 'json'
+
+module BackgroundBunnies
+  class Producer
+    attr_reader :channel
+    attr_reader :queue
+    attr_reader :queue_name
+
+    def initialize(connection, queue_name)
+      @queue_name = queue_name.to_s
+      @channel = connection.create_channel
+      @queue = connection.queue(@queue_name)
+    end
+
+    #
+    # Publishes a Job for the Worker
+    #
+    def enqueue(payload)
+      @queue.publish(JSON.generate(payload), :routing_key => @queue.name)
+    end
+
+  end
+end

data/lib/background_bunnies/version.rb

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

data/lib/background_bunnies/workers.rb

@@ -0,0 +1,5 @@
+module BackgroundBunnies
+  module Workers
+    # Workers goes here
+  end
+end

data/test/background_bunnies_test.rb

@@ -0,0 +1,150 @@
+require 'bunny'
+require_relative 'test_helper'
+
+describe BackgroundBunnies::Bunny do
+  describe :queue_name do
+
+    it "should return the default name based on the worker class name" do 
+      class WorkerDefault
+        include BackgroundBunnies::Bunny
+      end
+      worker = WorkerDefault.new
+      worker.queue_name.must_equal "WorkerDefault"
+    end
+
+    it "should return the custom name or symbol is set" do 
+      class WorkerNonDefault
+        include BackgroundBunnies::Bunny
+        queue :explicit_queue_name
+      end
+      worker = WorkerNonDefault.new
+      worker.queue_name.must_equal "explicit_queue_name"
+    end
+
+  end
+  
+  describe :start do
+    it "should subscribe to queue" do
+      class StartTest
+        include BackgroundBunnies::Bunny
+      end
+      connection_klass = Struct.new("ConnectionStub", :last_channel) do
+        def create_channel
+          channel_klass = Struct.new("StubChannel", :hook_queue_name) do
+            def queue(name)
+              self.hook_queue_name= name
+              queue_klass = Struct.new("StubQueue", :options) do
+                def subscribe(options, &block)
+                  self.options = options
+                end
+              end
+              queue_klass.new
+            end
+          end
+          self.last_channel = channel_klass.new
+        end
+        
+        def start
+
+        end
+      end
+      connection = connection_klass.new
+      connection.start
+      worker = StartTest.new
+      worker.start connection
+      worker.channel.must_equal connection.last_channel
+      worker.channel.hook_queue_name.must_equal "StartTest"
+      worker.queue.options[:block].must_equal false
+      worker.queue.options[:ack].must_equal true
+    end
+  end
+
+  describe :process, "success" do
+    it "should ack success jobs" do
+      class StartTest
+        include BackgroundBunnies::Bunny
+        attr_reader :product_id
+
+        def process(job)
+          @product_id = job.payload['product_id']
+        end
+
+      end
+      connection_klass = Struct.new("StubConnectionSuccess") do
+        def create_channel
+          channel_klass = Struct.new("StubChannelSuccess", :delivery_tag) do
+            def queue(name)
+              queue_klass = Struct.new("StubQueueSuccess", :options) do
+                def subscribe(options, &block)
+                  self.options = options
+                  yield(Struct.new(:delivery_tag).new("tag0"), {}, JSON.generate({:product_id=>560}))
+                end
+              end
+              queue_klass.new
+            end
+
+            def ack(delivery_tag, multiple)
+              self.delivery_tag = delivery_tag
+            end
+
+          end
+          channel_klass.new
+        end
+        def start
+
+        end
+      end
+      connection = connection_klass.new
+      connection.start
+      worker = StartTest.new
+      worker.start connection
+      worker.channel.delivery_tag.must_equal "tag0"
+      worker.product_id.must_equal 560
+    end
+  end
+
+  describe :process, "exceptions" do
+    it "should not ack failed jobs" do
+      class StartTest
+        include BackgroundBunnies::Bunny
+
+        def process(job)
+          raise "some error"
+        end
+
+      end
+      connection_klass = Struct.new("StubExceptionsConnections") do
+        def create_channel
+          channel_klass = Struct.new("StubChannelExceptions", :delivery_tag) do
+            def queue(name)
+              queue_klass = Struct.new("StubQueueExceptions", :options) do
+                def subscribe(options, &block)
+                  self.options = options
+                  yield(Struct.new(:delivery_tag).new("tag0"), {}, JSON.generate({:product_id=>1}))
+                end
+              end
+              queue_klass.new
+            end
+
+            def ack(delivery_tag, multiple)
+              self.delivery_tag = delivery_tag
+            end
+
+          end
+          channel_klass.new
+        end
+
+        def start
+
+        end
+      end
+      connection = connection_klass.new
+      connection.start
+      worker = StartTest.new
+      worker.start connection
+      worker.channel.delivery_tag.must_be_nil
+    end
+  end
+
+end
+

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/background_bunnies.rb', __FILE__)

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: background_bunnies
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Firebaseco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0.pre7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0.pre7
+- !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'
+description: AMQP based workers
+email:
+- hello@firebase.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- background_bunnies.gemspec
+- examples/increments.rb
+- examples/increments_producer.rb
+- examples/increments_producer_reset.rb
+- examples/increments_worker.rb
+- lib/background_bunnies.rb
+- lib/background_bunnies/bunny.rb
+- lib/background_bunnies/job.rb
+- lib/background_bunnies/logger.rb
+- lib/background_bunnies/producer.rb
+- lib/background_bunnies/version.rb
+- lib/background_bunnies/workers.rb
+- test/background_bunnies_test.rb
+- test/test_helper.rb
+homepage: https://github.com/firebaseco/background_bunnies
+licenses: []
+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.25
+signing_key: 
+specification_version: 3
+summary: Background workers based on AMQP and the bunny gem
+test_files:
+- test/background_bunnies_test.rb
+- test/test_helper.rb