tread_mill 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f5cc9f12b5f080934e1e27c98fdd6c8bd1d49a7a
+  data.tar.gz: 860247bf4d4a9fc23508e41b5b2798c3c7ded808
+SHA512:
+  metadata.gz: c3777805116b0a99afe44bf77be919099c3c7a075001e1be7e43ffb08557163b619c4c6ed80671abe575e0de80f38fe145cd3ef123cd10dbc56ef45c573d0e26
+  data.tar.gz: 63d5bb6e9f193a1003eab217155fc2ad7caa8f3415181da9a98f1718b79f6c30acdd8e249679408338a11bc17e9d25081756cae692e986ce3ea723ddb56a82e1

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2014, Protobit
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the {organization} nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,152 @@
+# TreadMill
+
+TreadMill Rails plugin for background workers.  This gem is designed to integrate into an existing Rails application and provide immediate RabbitMQ integration using the Sneakers worker gem and Rails 4.2.0.beta1 ActiveJob.
+
+## Notes
+
+Tags:
+
+* [0.0.1](/Protobit/tread_mill/wiki/0.0.1) tag for Rails 4.1
+* [0.0.2](/Protobit/tread_mill/wiki/0.0.1) tag for Rails 4.2.0.beta1
+* HEAD or 0.0.3 tag for Rails 4.2 stable
+
+## Installation
+
+Add this line to your applications's Gemfile:
+
+```
+gem 'tread_mill'
+```
+
+And then execute:
+
+```
+bundle install
+```
+
+## Usage
+
+### Options
+
+```RUBY
+module MyApp
+  class Application < Rails::Application
+    # Queues you wish to listen on.
+    config.active_job.queue_name_delimiter = '.'
+    config.active_job.queue_adapter = :sneakers
+    config.active_job.queue_base_name = 'amqp.myapplication'
+
+    # configure queues: amqp.myapplication.my_queue and amqp.myapplication.my_second_queue
+    config.tread_mill.queues = %w(my_queue my_second_queue)
+
+    # Configure 'ActionMailer#deliver_later': amqp.myapplication.mailers
+    config.tread_mill.queues << 'mailers'
+
+    # Optional: Probably best set in your sneakers configuration.
+    # config.tread_mill.workers = # of workers
+
+  end
+end
+```
+
+### Running your ActiveJob based workers.
+
+```
+rake tread_mill:run
+```
+
+**That's it.**
+
+### Example Upstart:
+
+As suggested by jondot, the Sneakers maintainer, daemons used to run jobs with
+Sneakers, and thusly TreadMill, should be done so using Upstart (or whatever
+flavor other of daemon management subsystems your chosen OS uses).  Sneakers
+no longer supports the ability to daemonize.
+
+The following a sample upstart config file to get you started:
+
+```
+description 'Application Tread Mill Server'
+
+env ENVIRONMENT_VAR='VALUE'
+
+setuid deploy
+setgid www-data
+
+chdir /srv/www/application/current
+
+start on [2345]
+stop on [!2345]
+
+exec /usr/local/bin/ruby /usr/local/bin/bundle exec rake tread_mill:run
+```
+
+This file will go in `/etc/init` on Ubuntu systems.  Should be named with the 
+service name followed by `.conf`: `application-treadmill.conf`.
+
+Now to start/stop your service:
+
+```BASH
+root@nix:/root# start application-treadmill
+application-treadmill start/running, process 27996
+...
+root@nix:/root# stop application-treadmill
+application-treadmill stop/waiting
+```
+
+More information on Upstart can be found [here](http://upstart.ubuntu.com/cookbook/#console).
+
+**NOTE: Upstart `restart` is not the command you are looking for *waves 2
+fingers from left to right in front of you*.  You must stop/start between
+configuration changes for the changes to take effect.**
+
+### Example workers:
+
+Assuming you are using the ActiveJob::Base worker class:
+
+```Ruby
+# app/workers/my_worker.rb
+
+# Assuming: config.active_job.queue_name_delimiter = '.'
+
+class Workers::MyWorker < ActiveJob::Base
+  queue_as :my_queue # queue used will be 'amqp.myapplication.my_queue'
+
+  def perform(user)
+    user.do_work
+  end
+
+  class << self
+    def work_for(user)
+      self.enqueue(user)
+    end
+  end
+end
+```
+
+Then you are set to use your workers wherever you want:
+
+```Ruby
+# app/models/user.rb
+
+class User
+  def work_later
+    Workers::MyWorker.work_for(self)
+  end
+end
+```
+
+### Support Versions
+
+#### Rails 4.2.0
+
+Should be working now.  If you see any issues, feel free to submit a Pull Request.
+
+#### Rails 4.2.0.beta1
+
+TreadMill should work out of the box with a valid Sneakers configuration. For ActionMailer::DeliverLater integration, all you need to do is include a `:mailer` queue, which should be prefixed by your selected `queue_name_prefix` (`config.tread_mill.queues = %(amqp.myapplication.mailers)`).
+
+#### Rails <=4.1
+
+Due to a pretty large set of API changes between ActiveJob's github repository pre-merge and now, it doesn't make sense to support pre-4.2 ActiveJob, especially considering the Rails team has flatly rejected supporting pre-4.2.  As a result, this gem as of version `0.0.2`, only supports `>= 4.2.0.beta1`.

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TreadMill'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/tasks/tread_mill_tasks.rake

@@ -0,0 +1,8 @@
+require 'tread_mill'
+
+namespace :tread_mill do
+  desc 'Run ActiveJob workers against environment specified queues.'
+  task run: :environment do
+    TreadMill.run_queues(ENV['QUEUE'] || ENV['QUEUES'])
+  end
+end

data/lib/tread_mill.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+# Load sneakers...
+require 'sneakers'
+require 'sneakers/runner'
+
+require 'tread_mill/fork_callbacks'
+require 'tread_mill/queue_listener'
+
+module TreadMill
+  include ActiveSupport::Configurable
+
+  config_accessor :queues, :workers
+
+  # Check to see if we're properly configured to send messages.
+  # Unfortunately, sneakers/bunny doesn't have a real method check because
+  # the connections are setup at request time.  This is really just a best
+  # guess.
+  def self.configured?
+    Sneakers.configured? &&
+      !Sneakers::Config[:amqp]
+        .match(/^amqps?:\/\/([^:]+(:[^@]+)?@)?[^:]+(:[0-9]+)?\/?$/).nil?
+  end
+
+  # Process input queues to ensure QueueListener#for_queues gets the proper
+  # input.
+  def self.process_queues(queues)
+    case queues
+    when Array
+      queues.flatten
+    when String
+      queues.split(',')
+    else
+      fail ArgumentError, 'TreadMill#run_queues must be passed an Array of '\
+        'queues or comma separated list of queues.'
+    end
+  end
+
+  mattr_accessor :runner
+
+  # Setup QueueListeners for each queue and run them in a Sneakers::Runner.
+  # Take the passed in queues first if provided, then use any application
+  # configured queues.
+  def self.run_queues(ques = nil, options = {})
+    ques = self.process_queues(ques) if ques
+    queue_listeners = QueueListener.for_queues(ques || queues)
+
+    sneakers_config = {
+      before_fork: ForkCallbacks.method(:before_fork),
+      after_fork: ForkCallbacks.method(:after_fork)
+    }
+
+    # Let these primarily reside in the sneakers config unless explicitly set.
+    sneakers_config[:workers] = workers if workers
+
+    Sneakers.configure(sneakers_config.merge(options))
+
+    self.runner = Sneakers::Runner.new(queue_listeners)
+    self.runner.run
+  end
+
+  # If a runner is running, stop it.
+  def self.stop_queues
+    self.runner.stop unless self.runner.nil?
+  end
+end
+
+require 'tread_mill/railtie' if defined?(Rails)

data/lib/tread_mill/fork_callbacks.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module TreadMill
+  # Encapsulate before and after fork collbacks.
+
+  module ForkCallbacks
+    def self.before_fork
+      # as there's no need for the master process to hold a connection
+      if defined?(ActiveRecord::Base)
+        ActiveRecord::Base.connection.disconnect!
+      end
+    end
+
+    def self.after_fork
+      if defined?(ActiveRecord::Base)
+        ActiveRecord::Base.establish_connection
+      end
+    end
+  end
+end

data/lib/tread_mill/queue_listener.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'active_job/queue_adapters/sneakers_adapter'
+
+module TreadMill
+  # We want to subclass the JobWrapper to ensure the messages are deserialized
+  # properly.
+  class QueueListener < ActiveJob::QueueAdapters::SneakersAdapter::JobWrapper
+    include ActiveSupport::Rescuable
+
+    # Generate a worker for each queue specified.
+    def self.for_queues(*queues)
+      queues.flatten.map do |queue|
+        # Sneakers::Runner wants a worker class, not an instance.
+        # So, here we are creating anonymous classes and setting the queue
+        # accordingly.
+        Class.new(QueueListener) do
+          from_queue queue
+        end
+      end
+    end
+  end
+end

data/lib/tread_mill/railtie.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module TreadMill
+  class Railtie < Rails::Railtie
+    railtie_name :tread_mill
+
+    config.tread_mill = ActiveSupport::OrderedOptions.new
+
+    rake_tasks do
+      load "tasks/tread_mill_tasks.rake"
+    end
+
+    initializer "tread_mill.set_configs" do |app|
+      options = app.config.tread_mill
+      options.queues ||= []
+      options.each { |k,v| TreadMill.send("#{k}=", v.flatten) }
+    end
+  end
+end

data/lib/tread_mill/version.rb

@@ -0,0 +1,3 @@
+module TreadMill
+  VERSION = '0.0.3'
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end