rufus-runner 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 026ca77e2c60d3b31c2930dd9c8bf03e5fb08478
+  data.tar.gz: f20bf4a2f524d4700765805266a6592436655c59
+SHA512:
+  metadata.gz: c3ad75069a777e751f8d57b6b440061b69cc3bccf85d31580d1e85cfd4b44258ee6a3d864ed974c437d521e979d0a00f7e59d7be30f6d1f35f6b6eee1bef7811
+  data.tar.gz: 5cbd8a66992378eea954e891845c585368b401f641d9b0e8384158f7e8d50b40200e6821821ba815205445641aa0694711f9e60bea8bc875406b83af5e1bbbf5

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 HouseTrip
+
+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,67 @@
+# rufus-runner
+
+[![Build Status](https://travis-ci.org/HouseTrip/rufus-runner.png)](https://travis-ci.org/HouseTrip/rufus-runner)
+
+Wraps [rufus-scheduler](http://github.com/jmettraux/rufus-scheduler) in a
+standalone process, with job timing, logging, and safe defaults.
+
+**Note: I did not write this gem, only deployed it to RubyGems. The project appears to be dead and I'll provide
+support the best I can. If the original authors decide they want to take it back over, just let me know.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rufus-runner'
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rufus-runner
+
+Create a configuration file:
+
+    # config/schedule.rb
+    Rufus::TrackingScheduler.start do |scheduler|
+      # sentinel job that keeps running to prove Rufus is still alive
+      scheduler.run :name => 'no-op', :every => '60s' do
+        Kernel.sleep(1e-3)
+      end
+    end
+
+The `#run` method simply takes the same options as Rufus's `#every` method,
+with these safe defaults:
+
+    :mutex             => <m>       # because Rails is not thread-safe
+    :timeout           => 60        # we don't want no long-running jobs, they should be DJ'd (seconds)
+    :discard_past      => true      # don't catch up with past jobs
+    :allow_overlapping => false     # don't try to run the same job twice simultaneously
+
+Where `<m>` is a shared, global instance of `Mutex`.
+
+Finally, run it:
+
+    $ rufus-runner config/schedule.rb
+
+
+### Rails
+
+If you're running Rails, you might want to have an environment loaded in the
+scheduler. Simply add on top of your schedule:
+
+    # Rails 2
+    require 'config/boot'
+    require 'config/environment'
+
+    # Rails 3
+    require 'config/application'
+
+When Rails is present, `rufus-runner` will call `ActiveRecord::Base.clear_active_connections!` after each job for you.
+
+## 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/bin/rufus-runner

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+#
+# Driver for Rufus-scheduler.
+# Pass it a schedule file as a command-line argument
+#
+$PROGRAM_NAME = 'rufus'
+
+require 'rubygems'
+require 'pathname'
+require 'bundler/setup'
+require 'rufus-runner'
+
+if ARGV.empty?
+  puts 'Sorry, but I need a schedule. Pass it to me as the first command-line argument.'
+  Process.exit! 1
+end
+
+load File.expand_path(ARGV[0])

data/lib/rufus-runner/tracking_scheduler/forking_job_runner.rb

@@ -0,0 +1,37 @@
+require 'rufus-runner/tracking_scheduler/job_runner'
+
+class Rufus::TrackingScheduler::ForkingJobRunner < Rufus::TrackingScheduler::JobRunner
+
+  class UnexpectedExitStatus < StandardError; end
+
+  def run_block
+    @pid = fork do
+      $PROGRAM_NAME = "rufus: #{@name}"
+      @block.call
+      exit 0
+    end
+    status = Process.wait2(@pid)[1]
+    unless status.success?
+      raise UnexpectedExitStatus.new(status.exitstatus)
+    end
+  rescue Rufus::Scheduler::TimeOutError
+    log("timed out, killing")
+    kill
+    raise
+  end
+
+  def shutdown
+    kill
+  end
+
+
+  private
+
+  def kill
+    Process.kill("KILL", @pid)
+    Process.wait(@pid)
+  rescue Errno::ESRCH, Errno::ECHILD
+    # process already dead, which is fine
+  end
+
+end

data/lib/rufus-runner/tracking_scheduler/job_runner.rb

@@ -0,0 +1,56 @@
+class Rufus::Scheduler::Job
+  attr_accessor :job_runner
+end
+
+class Rufus::TrackingScheduler::JobRunner
+
+  def initialize(options)
+    @name = options.fetch(:name)
+    @job = options.fetch(:job)
+    @block = options.fetch(:block)
+    @scheduler = options.fetch(:scheduler)
+  end
+
+  def run
+    return if @scheduler.shutting_down?
+    @job.job_runner = self
+    start_time = Time.now
+    log("starting")
+
+    begin
+      run_block
+    rescue Exception => exception
+      log("failed with #{exception.class.name} (#{exception.message})")
+      if defined?(ActiveRecord::ConnectionTimeoutError) && exception.kind_of?(ActiveRecord::ConnectionTimeoutError)
+        log("connection broken, exiting scheduler")
+        exit 0
+      end
+    else
+      total_time = Time.now - start_time
+      log("completed in %.3f s" % total_time)
+    end
+
+    if defined?(ActiveRecord::Base)
+      ActiveRecord::Base.clear_active_connections!
+    end
+  end
+
+  def shutdown
+    raise NotImplementedError.new
+  end
+
+  private
+
+  def run_block
+    raise NotImplementedError.new
+  end
+
+  def job_id
+    @job_id ||= '%08x' % @job.job_id.gsub(/\D/,'')
+  end
+
+  def log(message)
+    @scheduler.log("#{@name}(#{job_id}): #{message}")
+  end
+
+end

data/lib/rufus-runner/tracking_scheduler/threading_job_runner.rb

@@ -0,0 +1,16 @@
+require 'rufus-runner/tracking_scheduler/job_runner'
+
+class Rufus::TrackingScheduler::ThreadingJobRunner < Rufus::TrackingScheduler::JobRunner
+
+  def shutdown
+    # nothing to do, threads will die automatically
+  end
+
+
+  private
+
+  def run_block
+    @block.call
+  end
+
+end

data/lib/rufus-runner/tracking_scheduler.rb

@@ -0,0 +1,159 @@
+class Rufus::TrackingScheduler
+end
+
+require 'rufus/scheduler'
+require 'eventmachine'
+require 'rufus-runner/tracking_scheduler/threading_job_runner'
+require 'rufus-runner/tracking_scheduler/forking_job_runner'
+
+#
+# Wraps Rufus's scheduler class with signal handling,
+# cancellation of jobs, and logging.
+#
+class Rufus::TrackingScheduler
+  # wait that long for jobs to complete before quitting (seconds)
+  GRACE_DELAY = 10
+
+  def initialize(options = {})
+    @options = DefaultOptions.merge(options)
+    @scheduler = Rufus::Scheduler::EmScheduler.start_new
+    log('scheduler started')
+  end
+
+  def run(options={}, &block)
+    return unless rails_environment_matches?(options.delete(:environments))
+    options = @options.merge(options)
+
+    name = options.delete(:name) || 'noname'
+    case options.delete(:fork) || :thread
+    when :thread
+      job_runner_class = ThreadingJobRunner
+    when :process
+      job_runner_class = ForkingJobRunner
+    else
+      fail ArgumentError.new("option :fork needs to be either :thread or :process")
+    end
+
+    schedule(options) do |job|
+      job_runner = job_runner_class.new(
+        :name => name,
+        :job => job,
+        :block => block,
+        :scheduler => self
+      )
+      job_runner.run
+    end
+
+    log("scheduled '#{name}'")
+    nil
+  end
+
+  def self.start(options = {})
+    EM.run do
+      scheduler = new(options)
+      scheduler.send :setup_traps
+      yield scheduler
+    end
+  end
+
+  def shutting_down!
+    @shutting_down = true
+  end
+
+  def shutting_down?
+    !!@shutting_down
+  end
+
+
+  def log(string)
+    $stdout.write "[#{$PROGRAM_NAME} #{format_time Time.now}] #{string}\n"
+    $stdout.flush
+  end
+
+  private
+
+  def schedule(options, &block)
+    if frequency = options.delete(:every)
+      scheduling_method = :every
+    elsif frequency = options.delete(:cron)
+      scheduling_method = :cron
+    else
+      raise ArgumentError.new('You need to specify either :every or :cron')
+    end
+
+    @scheduler.send(scheduling_method, frequency, options, &block)
+  end
+
+  def setup_traps
+    %w(INT TERM).each do |signal|
+      Signal.trap(signal) do
+        log "SIG#{signal} received"
+        # EM uses mutexes, which cannot be used in the context of a trap.
+        # Just do the cleanup in a thread
+        Thread.new {
+          stop_all_jobs
+          EM.stop_event_loop
+        }.join
+      end
+    end
+  end
+
+  def stop_all_jobs
+    shutting_down!
+    @scheduler.jobs.each_pair do |job_id, job|
+      job.unschedule
+    end
+    log "all jobs unscheduled"
+    if running_jobs_count == 0
+      log "no more jobs running"
+      return
+    end
+
+    log "waiting for #{running_jobs_count} still running jobs"
+    start_time = Time.now
+    while (Time.now <= start_time + GRACE_DELAY) && (running_jobs_count > 0)
+      Kernel.sleep(100e-3)
+    end
+
+    if running_jobs_count > 0
+      log "#{running_jobs_count} jobs did not complete"
+      @scheduler.running_jobs.collect(&:job_runner).each(&:shutdown)
+    else
+      log "all jobs completed"
+    end
+  end
+
+  def running_jobs_count
+    @scheduler.running_jobs.length
+  end
+
+  def format_time(time)
+    "%s.%03d" % [time.strftime('%F %T'), ((time.to_f - time.to_i) * 1e3).to_i]
+  end
+
+  def rails_environment_matches?(environments)
+    return true unless rails_environment
+    return true if environments.nil?
+
+    Array(environments).any? do |environment|
+      # environment can be a string or a regexp
+      environment === rails_environment
+    end
+  end
+
+  def rails_environment
+    if defined?(Rails)
+      Rails.env
+    else
+      ENV['RAILS_ENV'] || ENV['RACK_ENV']
+    end
+  end
+
+  DefaultOptions = {
+    :fork              => :process,  # safety first
+    :mutex             => Mutex.new, # because Rails is not thread-safe
+    :timeout           => 60,        # we don't want no long-running jobs, they should be DJ'd (seconds)
+    :discard_past      => true,      # don't catch up with past jobs
+    :allow_overlapping => false,     # don't try to run the same job twice simultaneously
+  }
+end

data/lib/rufus-runner/version.rb

@@ -0,0 +1,5 @@
+module Rufus
+  module Runner
+    VERSION = "0.0.3"
+  end
+end

data/lib/rufus-runner.rb

@@ -0,0 +1,2 @@
+require "rufus-runner/version"
+require "rufus-runner/tracking_scheduler"

data/rufus-runner.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+require 'rufus-runner/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rufus-runner"
+  gem.version       = Rufus::Runner::VERSION
+  gem.license       = 'MIT'
+  gem.authors       = ["Julien Letessier", "Chuck Callebs"]
+  gem.email         = ["julien.letessier@gmail.com", "chuck@callebs.io"]
+  gem.description   = %q{Wrapper process around rufus-scheduler}
+  gem.summary       = %q{Wrapper process around rufus-scheduler}
+  gem.homepage      = "http://github.com/ccallebs/rufus-runner"
+
+  gem.add_runtime_dependency 'eventmachine'
+  gem.add_runtime_dependency 'rufus-scheduler', '~> 2.0.23'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 2'
+  gem.add_development_dependency 'rb-inotify'
+  gem.add_development_dependency 'rb-fsevent'
+  gem.add_development_dependency 'rb-fchange'
+  gem.add_development_dependency 'terminal-notifier-guard'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'pry-nav'
+  gem.add_development_dependency 'rspec-instafail'
+
+  gem.files = %w(
+    LICENSE.txt
+    README.md
+    bin/rufus-runner
+    lib/rufus-runner.rb
+    lib/rufus-runner/tracking_scheduler.rb
+    lib/rufus-runner/tracking_scheduler/job_runner.rb
+    lib/rufus-runner/tracking_scheduler/threading_job_runner.rb
+    lib/rufus-runner/tracking_scheduler/forking_job_runner.rb
+    lib/rufus-runner/version.rb
+    rufus-runner.gemspec
+  )
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: rufus-runner
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Julien Letessier
+- Chuck Callebs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rufus-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.23
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.23
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fchange
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-instafail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper process around rufus-scheduler
+email:
+- julien.letessier@gmail.com
+- chuck@callebs.io
+executables:
+- rufus-runner
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/rufus-runner
+- lib/rufus-runner.rb
+- lib/rufus-runner/tracking_scheduler.rb
+- lib/rufus-runner/tracking_scheduler/forking_job_runner.rb
+- lib/rufus-runner/tracking_scheduler/job_runner.rb
+- lib/rufus-runner/tracking_scheduler/threading_job_runner.rb
+- lib/rufus-runner/version.rb
+- rufus-runner.gemspec
+homepage: http://github.com/ccallebs/rufus-runner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Wrapper process around rufus-scheduler
+test_files: []