batchy 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.rdoc

@@ -0,0 +1,34 @@
+= Batchy
+
+A wrapper for batch processes.  It was designed to be used with an asynchronous library like delayed_job 
+or resque.  Code wrapped in a batchy block will have it's start and end time logged.  Batchy will keep track of 
+the current state of the batch from new to running to completion.  Errors not handled in the batched code will
+be caught by batchy and logged.  Callbacks can be defined for success, failure or both.
+
+{<img src="https://secure.travis-ci.org/Raybeam/batchy.png?branch=master" />}[http://travis-ci.org/Raybeam/batchy]
+
+== Installation
+
+  gem install batchy
+
+== Examples
+
+=== Configuration
+
+For a full list of configuration options, check the documentation.
+
+  Batchy.configure do | c |
+    c.allow_duplicates = false
+    c.raise_errors = false
+    c.name_process = true
+    c.allow_mass_sigkill = false
+    c.add_global_success_callback do | bch |
+      # do something on success
+    end
+    c.add_global_failure_callback do | bch |
+      # do something on failure
+    end
+    c.add_global_ensure_callback do | bch |
+      # do something regardless of end state
+    end
+  end

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Batchy'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+Dir['lib/tasks/*.rake'].each do | f |
+  load f
+end
+

data/lib/batchy.rb

@@ -0,0 +1,84 @@
+require 'active_record'
+require 'active_support'
+require 'addressable/uri'
+require 'andand'
+require 'state_machine/core'
+require 'sys/proctable'
+
+require 'batchy/batch'
+require 'batchy/configuration'
+require 'batchy/version'
+
+require 'generators/batchy/templates/migration'
+
+module Batchy
+  extend self
+
+  # Get configuration options
+  # If a block is provided, it sets the contained
+  # configuration options.
+  def configure
+    @configuration ||= Configuration.new
+    if block_given?
+      yield @configuration
+    end
+    @configuration
+  end
+
+  # Issue a SIGTERM to all expired batches.  This will result in an error
+  # being raised inside the batchy block and a final error state
+  # for the batch.
+  def clean_expired
+    Batchy::Batch.expired.each do | b |
+      b.kill
+    end
+  end
+
+  # This is dangerous.  If you open a batch inside your main program
+  # this process could kill your main application.
+  # It is turned off by default.
+  def clean_expired!
+    unless Batchy.configure.allow_mass_sigkill
+      Kernel.warn 'Mass sigkill is not allowed.  Use "clean_expired" to issue a mass SIGTERM, or set the "allow_mass_sigkill" config option to true'
+      return false
+    end
+
+    Batchy::Batch.expired.each do | b |
+      b.kill!
+    end
+  end
+
+  # Sets all configuration options back to
+  # default
+  def clear_configuration
+    @configuration = nil
+  end
+
+  # Sets the logger for batchy
+  def logger
+    @logger ||= Logger.new(STDOUT)
+    @logger
+  end
+
+  def logger=(logger)
+    @logger = logger
+  end
+
+  # The main entry point for batchy.  It wraps code in a batchy
+  # block.  Batchy handles errors, logging and allows for
+  # callbacks.
+  def run *args
+    options = args.extract_options!
+
+    batch = Batch.create options
+    batch.start!
+    return false if batch.ignored?
+    begin
+      yield batch
+    rescue Exception => e
+      batch.error = "{#{e.message}\n#{e.backtrace.join('\n')}"
+    ensure
+      batch.finish!
+    end
+  end
+end

data/lib/batchy/batch.rb

@@ -0,0 +1,195 @@
+module Batchy
+  class Batch < ActiveRecord::Base
+    extend StateMachine::MacroMethods
+
+    self.table_name = 'batchy_batches'
+
+    attr_reader :failure_callbacks
+    attr_reader :success_callbacks
+    attr_reader :ensure_callbacks
+    attr_reader :ignore_callbacks
+
+    validates_presence_of :name
+
+    state_machine :state, :initial => :new do
+      event :start do
+        transition :new => :ignored, :if => :invalid_duplication
+        transition :new => :running
+      end
+      after_transition :new => :running do | batch, transition |
+        batch.started_at = DateTime.now
+        batch.pid = Process.pid
+        batch.save!
+
+        # Set the proclist process name
+        $0 = batch.name if Batchy.configure.name_process
+      end
+      
+      # Ignored
+      after_transition :new => :ignored do | batch, transition |
+        batch.started_at = DateTime.now
+        batch.finished_at = DateTime.now
+        batch.pid = Process.pid
+        batch.save!
+      end
+      after_transition :new => :ignored, :do => :run_ignore_callbacks
+      after_transition :new => :ignored, :do => :run_ensure_callbacks
+
+      event :finish do
+        transition :running => :success, :unless => :has_errors
+        transition :running => :errored
+      end
+      after_transition :running => [:success, :errored] do | batch, transition |
+        batch.finished_at = DateTime.now
+        batch.save!
+      end
+      after_transition :running => :success, :do => :run_success_callbacks
+      after_transition :running => :errored, :do => :run_failure_callbacks
+      after_transition :running => [:success, :errored], :do => :run_ensure_callbacks
+    end
+
+    class << self
+      # Return all expired batches that are still running
+      def expired
+        where('expire_at < ? and state = ?', DateTime.now, 'running')
+      end
+    end
+
+    # Set up callback queues and states
+    def initialize *args
+      create_callback_queues
+      super
+    end
+
+    # Is there batch with the same guid already running?
+    def already_running
+      duplicate_batches.count > 0
+    end
+
+    # Find all batches with the same guid that are
+    # running.
+    def duplicate_batches
+      rel = self.class.where(:guid => guid, :state => "running")
+      return rel if new_record?
+
+      rel.where("id <> ?", id)
+    end
+
+    # Is this batch expired
+    def expired?
+      expire_at < DateTime.now && state == 'running'
+    end
+
+    # Does this batch have errors?
+    def has_errors
+      error?
+    end
+
+    # Is this an unwanted duplicate process?
+    def invalid_duplication
+      !Batchy.configure.allow_duplicates && already_running
+    end
+
+    # Issues a SIGTERM to the process running this batch
+    def kill
+      Process.kill('TERM', pid)
+    end
+
+    # Issue a SIGKILL to the process running this batch
+    # BE CAREFUL! This will kill your application or
+    # server if this batch has the same PID.
+    def kill!
+      Process.kill('KILL', pid)
+    end
+
+    # Adds a callback that runs no matter what the
+    # exit state of the batchy block
+    def on_ensure *args, &block
+      if block_given?
+        @ensure_callbacks << block
+      else
+        @ensure_callbacks << args.shift
+      end
+    end
+
+    # Add a callback to run on failure of the 
+    # batch
+    def on_failure *args, &block
+      if block_given?
+        @failure_callbacks << block
+      else
+        @failure_callbacks << args.shift
+      end
+    end
+
+    # Adds a callback that runs if the
+    # process is a duplicate
+    def on_ignore *args, &block
+      if block_given?
+        @ignore_callbacks << block
+      else
+        @ignore_callbacks << args.shift
+      end
+    end
+
+    # Add a callback to run on successful
+    # completion of the batch
+    def on_success *args, &block
+      if block_given?
+        @success_callbacks << block
+      else
+        @success_callbacks << args.shift
+      end
+    end
+
+    # :nodoc:
+    def run_ensure_callbacks
+      Batchy.configure.global_ensure_callbacks.each do | ec |
+        ec.call(self)
+      end
+      ensure_callbacks.each do | ec |
+        ec.call(self)
+      end
+    end
+
+    # :nodoc:
+    def run_ignore_callbacks
+      Batchy.configure.global_ignore_callbacks.each do | ic |
+        ic.call(self)
+      end
+      ignore_callbacks.each do | ic |
+        ic.call(self)
+      end
+    end
+
+    # :nodoc:
+    def run_success_callbacks
+      Batchy.configure.global_success_callbacks.each do | sc |
+        sc.call(self)
+      end
+      success_callbacks.each do | sc |
+        sc.call(self)
+      end
+    end
+
+    # :nodoc:
+    def run_failure_callbacks
+      Batchy.configure.global_failure_callbacks.each do | fc |
+        fc.call(self)
+      end
+      failure_callbacks.each do | fc |
+        fc.call(self)
+      end
+    end
+
+    private
+
+    # :nodoc:
+    def create_callback_queues
+      @success_callbacks = []
+      @failure_callbacks = []
+      @ensure_callbacks = []
+      @ignore_callbacks = []
+    end
+  end
+end

data/lib/batchy/configuration.rb

@@ -0,0 +1,81 @@
+module Batchy
+  class Configuration
+
+    def initialize
+      @global_success_callbacks = []
+      @global_failure_callbacks = []
+      @global_ensure_callbacks = []
+      @global_ignore_callbacks = []
+    end
+  
+    # Whether the batch can run multiple processes
+    # with the same GUID. If set to false,
+    # a request to run a batch while another
+    # with the same GUID is still running will result
+    # in an ignored state and the batch will not run  
+    # Defaults to true
+    attr_writer :allow_duplicates
+    def allow_duplicates
+      @allow_duplicates.nil? ? true : @allow_duplicates
+    end
+
+    # When a batch encounters an error, the error is caught
+    # and logged while the batch exits with an "errored" state.
+    # If you wish to error to continue to be raised up
+    # the stack, set this to true
+    # Defaults to false
+    attr_writer :raise_errors
+    def raise_errors
+      @raise_errors.nil? ? false : @raise_errors
+    end
+
+    # This sets the name of the process in the proclist to
+    # the name of the current batch.  It defaults to true
+    attr_writer :name_process
+    def name_process
+      @name_process.nil? ? true : @name_process
+    end
+
+    # This library has the ability to issue a SIGKILL
+    # to all expired batch processes.  If batchy is
+    # being used by a server process or the main
+    # application process, this will kill it.  Only
+    # set this to true if you're sure you're only
+    # going to use batches as async processes that
+    # nothing else depends on.  Defaults to false.
+    attr_writer :allow_mass_sigkill
+    def allow_mass_sigkill
+      @allow_mass_sigkill.nil? ? false : @allow_mass_sigkill
+    end
+
+    # Global callbacks will be called on all batches. They
+    # will be added to the batch on initialization and
+    # so they will be executed first, before any batch-specific
+    # callbacks
+
+    # Global callback for failures
+    attr_reader :global_failure_callbacks
+    def add_global_failure_callback *args, &block
+      @global_failure_callbacks << block
+    end
+
+    # Global callback for ignore
+    attr_reader :global_ignore_callbacks
+    def add_global_ignore_callback *args, &block
+      @global_ignore_callbacks << block
+    end
+
+    # Global callback for successes
+    attr_reader :global_success_callbacks
+    def add_global_success_callback *args, &block
+      @global_success_callbacks << block
+    end
+
+    # Global callbacks that execute no matter
+    # what the end state
+    attr_reader :global_ensure_callbacks
+    def add_global_ensure_callback *args, &block
+      @global_ensure_callbacks << block
+    end
+  end
+end

data/lib/batchy/version.rb

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

data/lib/generators/batchy/templates/migration.rb

@@ -0,0 +1,24 @@
+class CreateBatchy < ActiveRecord::Migration
+  def self.up
+    create_table :batchy_batches, :force => true do |table|
+      table.datetime  :started_at     # When the batch started
+      table.datetime  :finished_at    # When the batch finished
+      table.datetime  :expire_at      # When this batch should expire
+      table.string    :state          # Current state of the batch
+      table.text      :error          # Reason for failure (if there is one)
+      table.string    :hostname       # Host the batch is running on
+      table.integer   :pid            # Process ID of the current batch
+      table.string    :name           # Name of the batch job
+      table.string    :guid           # Field to be used for unique identification of the calling job
+      table.integer   :batch_id       # Self-referential ID for identifying parent batches
+      table.timestamps
+    end
+
+    add_index :batchy_batches, :guid
+    add_index :batchy_batches, :state
+  end
+
+  def self.down
+    drop_table :batchy_batches
+  end
+end

data/lib/tasks/batchy_tasks.rake

@@ -0,0 +1,11 @@
+namespace :batchy do
+  task :rename do
+    $0 = 'Doing things .... xxxxx'
+    puts $1
+    sleep 60
+  end
+
+  task :check do
+    puts Sys::ProcTable.fields
+  end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification 
+name: batchy
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Bob Briski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: addressable
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.2"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: andand
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: state_machine
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: sys-proctable
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: factory_girl
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id011
+description: For handling all of the exceptions, states, timeouts, etc of batch processes
+email: 
+- bbriski@raybeam.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/batchy/batch.rb
+- lib/batchy/configuration.rb
+- lib/batchy/version.rb
+- lib/batchy.rb
+- lib/generators/batchy/templates/migration.rb
+- lib/tasks/batchy_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/Raybeam/batchy
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 1244919966576900379
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 1244919966576900379
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Set up and tear down a batch
+test_files: []
+