tickwork 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0f55ef5fd21a2a08cc0a9f43a35c3ff6d419de8
+  data.tar.gz: e524021956050752db8dfe4d493313c5791ed065
+SHA512:
+  metadata.gz: f6bdf37dc8d00f9eaa5c2d193007e90ccb8379003b2179609468811f42c41843b204794d167db3b1a0716d1a54df6be7b548094613e33fadb8478566947d2158
+  data.tar.gz: 8e7abceaab3cf06d8e7424fcf7591f86685d4b02de9644b4baf4b8f037109c83cec1c4e5f54bb6b22083fa64600b97d73305aacd1207efaa7c01b60235cbb3a5

data/.gitignore

@@ -0,0 +1,6 @@
+pkg
+tmp
+/.bundle
+Gemfile.lock
+*.swo
+*.swp

data/.ruby-gemset

@@ -0,0 +1,2 @@
+tickwork
+

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.1

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - jruby-19mode
+  - # rbx-2.2.7
+gemfile:
+  - gemfiles/activesupport3.gemfile
+  - gemfiles/activesupport4.gemfile

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2010-2014 Adam Wiggins, tomykaira <tomykaira@gmail.com>
+
+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,373 @@
+Tickwork - a scheduler library that requires an external call to tick to run scheduled events 
+===========================================
+
+[![Build Status](https://secure.travis-ci.org/softwaregravy/tickwork.png?branch=master)](http://travis-ci.org/softwaregravy/tickwork) [![Dependency Status](https://gemnasium.com/softwaregravy/tickwork.png)](https://gemnasium.com/softwaregravy/tickwork)
+
+This started as a stripped down version of [clockwork](https://github.com/tomykaira/clockwork). 
+
+Tickwork provides a familiar and compatible config file for scheduled jobs, but instead of it being driven by a background process, it relies on regular calls to `Tickwork.run`. `Tickwork.run` efectively ticks the clock forward from the last time it was called scheduling jobs as it goes. By tuning the paramters below, you can call `Tickwork.run` as little or as often as you like. 
+
+Tickwork keeps track of time using a datastore. Right now, nothing is supported. 
+
+Note that clockwork allowed schedules to be dynamically set via the database. This functionality does not exist in Tickwork.
+
+Quickstart
+----------
+
+Create tick.rb:
+
+```ruby
+require 'tickwork'
+module Tickwork
+  handler do |job|
+    puts "Running #{job}"
+  end
+
+  # handler receives the time when job is prepared to run in the 2nd argument
+  # handler do |job, time|
+  #   puts "Running #{job}, at #{time}"
+  # end
+
+  every(10.seconds, 'frequent.job')
+  every(3.minutes, 'less.frequent.job')
+  every(1.hour, 'hourly.job')
+
+  every(1.day, 'midnight.job', :at => '00:00')
+end
+```
+
+If you need to load your entire environment for your jobs, simply add:
+
+```ruby
+require './config/boot'
+require './config/environment'
+```
+
+under the `require 'tickwork'` declaration.
+
+Then, somewhere else in your app, you need to regularly call `Tickwork.run`. 
+
+Use with queueing
+-----------------
+
+The clock process only makes sense as a place to schedule work to be done, not
+to do the work.  It avoids locking by running as a single process, but this
+makes it impossible to parallelize.  For doing the work, you should be using a
+job queueing system, such as
+[Delayed Job](http://www.therailsway.com/2009/7/22/do-it-later-with-delayed-job),
+[Beanstalk/Stalker](http://adam.heroku.com/past/2010/4/24/beanstalk_a_simple_and_fast_queueing_backend/),
+[RabbitMQ/Minion](http://adam.heroku.com/past/2009/9/28/background_jobs_with_rabbitmq_and_minion/),
+[Resque](http://github.com/blog/542-introducing-resque), or
+[Sidekiq](https://github.com/mperham/sidekiq).  This design allows a
+simple clock process with no locks, but also offers near infinite horizontal
+scalability.
+
+For example, if you're using Beanstalk/Stalker:
+
+```ruby
+require 'stalker'
+
+module Tickwork
+  handler { |job| Stalker.enqueue(job) }
+
+  every(1.hour, 'feeds.refresh')
+  every(1.day, 'reminders.send', :at => '01:30')
+end
+```
+
+Using a queueing system which doesn't require that your full application be
+loaded is preferable, because the clock process can keep a tiny memory
+footprint.  If you're using DJ or Resque, however, you can go ahead and load
+your full application enviroment, and use per-event blocks to call DJ or Resque
+enqueue methods.  For example, with DJ/Rails:
+
+```ruby
+require 'config/boot'
+require 'config/environment'
+
+every(1.hour, 'feeds.refresh') { Feed.send_later(:refresh) }
+every(1.day, 'reminders.send', :at => '01:30') { Reminder.send_later(:send_reminders) }
+```
+
+
+
+Event Parameters
+----------
+
+### :at
+
+`:at` parameter specifies when to trigger the event:
+
+#### Valid formats:
+
+    HH:MM
+     H:MM
+    **:MM
+    HH:**
+    (Mon|mon|Monday|monday) HH:MM
+
+#### Examples
+
+The simplest example:
+
+```ruby
+every(1.day, 'reminders.send', :at => '01:30')
+```
+
+You can omit the leading 0 of the hour:
+
+```ruby
+every(1.day, 'reminders.send', :at => '1:30')
+```
+
+Wildcards for hour and minute are supported:
+
+```ruby
+every(1.hour, 'reminders.send', :at => '**:30')
+every(10.seconds, 'frequent.job', :at => '9:**')
+```
+
+You can set more than one timing:
+
+```ruby
+every(1.day, 'reminders.send', :at => ['12:00', '18:00'])
+# send reminders at noon and evening
+```
+
+You can specify the day of week to run:
+
+```ruby
+every(1.week, 'myjob', :at => 'Monday 16:20')
+```
+
+If another task is already running at the specified time, clockwork will skip execution of the task with the `:at` option.
+If this is a problem, please use the `:thread` option to prevent the long running task from blocking clockwork's scheduler.
+
+### :tz
+
+`:tz` parameter lets you specify a timezone (default is the local timezone):
+
+```ruby
+every(1.day, 'reminders.send', :at => '00:00', :tz => 'UTC')
+# Runs the job each day at midnight, UTC.
+# The value for :tz can be anything supported by [TZInfo](http://tzinfo.rubyforge.org/)
+```
+
+### :if
+
+`:if` parameter is invoked every time the task is ready to run, and run if the
+return value is true.
+
+Run on every first day of month.
+
+```ruby
+Tickwork.every(1.day, 'myjob', :if => lambda { |t| t.day == 1 })
+```
+
+The argument is an instance of `ActiveSupport::TimeWithZone` if the `:tz` option is set. Otherwise, it's an instance of `Time`.
+
+This argument cannot be omitted.  Please use _ as placeholder if not needed.
+
+```ruby
+Tickwork.every(1.second, 'myjob', :if => lambda { |_| true })
+```
+
+### :thread
+
+By default, clockwork runs in a single-process and single-thread.
+If an event handler takes a long time, the main routine of clockwork is blocked until it ends.
+Tickwork does not misbehave, but the next event is blocked, and runs when the process is returned to the clockwork routine.
+
+The `:thread` option is to avoid blocking. An event with `thread: true` runs in a different thread.
+
+```ruby
+Tickwork.every(1.day, 'run.me.in.new.thread', :thread => true)
+```
+
+If a job is long-running or IO-intensive, this option helps keep the clock precise.
+
+Configuration
+-----------------------
+
+Tickwork exposes a couple of configuration options:
+
+### :logger
+
+By default Tickwork logs to `STDOUT`. In case you prefer your
+own logger implementation you have to specify the `logger` configuration option. See example below.
+
+### :tz
+
+This is the default timezone to use for all events.  When not specified this defaults to the local
+timezone.  Specifying :tz in the parameters for an event overrides anything set here.
+
+### :max_threads
+
+Tickwork runs handlers in threads. If it exceeds `max_threads`, it will warn you (log an error) about missing
+jobs.
+
+
+### :thread
+
+Boolean true or false. Default is false. If set to true, every event will be run in its own thread. Can be overridden on a per event basis (see the ```:thread``` option in the Event Parameters section above)
+
+### :namespace
+
+This prefixes keys with a namespace which is useful to prevent colisions if you are using redis or memcache as the datastore. Defautls to `_tickwork_`.
+
+### Stepping forward in time from the past
+
+Think about Tickwork as having a concept of now built into it, but rather than now moving with the clock, it only moves forward (ticks forward) when you tell it to. You tell it to tick forward through time by calling `Tickwork.run`. How much it ticks forward is controlled by the following variables. 
+
+If you think of a clock, each tick is 1 second, and you take 1 tick each second. With tickwork, you control the size of the ticks, how many you take, and how often you take them.
+
+Tickwork will never tick into the future.
+
+### :tick_size
+
+This is the interval in seconds that each tick will step forward. The original clockwork implementation would (by default) wake up every second to check for work. Tickwork defaults to 60 seconds. This effectively puts a floor on your frequency of events you can schedule. So if you scheduled something to run every 30 seconds, it would only be run every other time -- so don't do that. 
+
+In general, set this to at least as small as your most frequently run job. If you set this to a value larger than 60, then events schedule to run at a particular time may be missed. 
+
+### :max_ticks
+
+This is the most number of ticks executed per run. If you have `tick_size` set to 60, then each tick will be 1 minute. If `max_ticks` is set to 10, then a call to `Tickwork.run` could result in as many as 10 minutes worth of jobs being scheduled. If you had 1 job that ran every minute, up to 10 jobs would be run. Tickwork will not tick into the future, so you may run fewer than this number of jobs. 
+
+In any given call to `Tickwork.run`, you can move foward through time at most tick_size * max_ticks
+
+### :max_catchup
+
+When running tickwork, the last time you run it is important since that is what now. But what if your system goes down? `max_catchup` sets a floor on how far back Tickwork look back for jobs. This defaults to 3600 which is 1 hour. This means that if you run Tickwork for a day, then turn your system off for a day, then start running Tickwork again, it will start scheduling jobs from 1 hour ago.
+
+Setting to 0 or nil disables the feature, and Tickwork will start from where it left off.
+
+If there is no last timestamp, Tickwork starts from now. 
+
+This must be larger than your `tick_size`, and probably significantly larger to avoid missing any jobs.
+
+### Configuration example
+
+```ruby
+module Tickwork
+  configure do |config|
+    config[:logger] = Logger.new(log_file_path)
+    config[:tz] = 'EST'
+    config[:max_threads] = 15
+    config[:thread] = true
+    config[:tick_size] = 60
+    config[:max_ticks] = 10
+    config[:max_catchup] = 3600
+  end
+end
+```
+
+### External call frequency & configs
+
+Since tickwork requires on some external system to make calls into `Tickwork.run`, you must balance whatever that system is against the config settings.
+
+Lets say you call `Tickwork.run` every 5 minutes and you have no jobs trying to run faster than 1x/min. The default values will work well (`tick_size: 60, max_ticks: 10`). Every 5 minutes, you would expect to run 5 minutes worth of jobs. If you miss 1 period, you will catch up and run 10 minutes worth of jobs. However, if you miss 2 periods, then call back (after 15 min), it will take 2 calls to catch up since there are 15 minutes waiting to run, but `max_ticks` limits this to just 10 per call.
+
+
+### error_handler
+
+You can add error_handler to define your own logging or error rescue.
+
+```ruby
+module Tickwork
+  error_handler do |error|
+    Airbrake.notify_or_ignore(error)
+  end
+end
+```
+
+Current specifications are as follows.
+
+- defining error_handler does not disable original logging
+- errors from error_handler itself are not rescued, and stop clockwork
+
+Any suggestion about these specifications is welcome.
+
+
+Anatomy of a tick file
+-----------------------
+
+tick.rb is standard Ruby.  Since we include the Tickwork module, this
+exposes a small DSL to define the handler for events, and then the events themselves.
+
+The handler typically looks like this:
+
+```ruby
+handler { |job| enqueue_your_job(job) }
+```
+
+This block will be invoked every time an event is triggered, with the job name
+passed in.  In most cases, you should be able to pass the job name directly
+through to your queueing system.
+
+The second part of the file, which lists the events, roughly resembles a crontab:
+
+```ruby
+every(5.minutes, 'thing.do')
+every(1.hour, 'otherthing.do')
+```
+
+In the first line of this example, an event will be triggered once every five
+minutes, passing the job name 'thing.do' into the handler.  The handler shown
+above would thus call enqueue_your_job('thing.do').
+
+You can also pass a custom block to the handler, for job queueing systems that
+rely on classes rather than job names (i.e. DJ and Resque).  In this case, you
+need not define a general event handler, and instead provide one with each
+event:
+
+```ruby
+every(5.minutes, 'thing.do') { Thing.send_later(:do) }
+```
+
+If you provide a custom handler for the block, the job name is used only for
+logging.
+
+You can also use blocks to do more complex checks:
+
+```ruby
+every(1.day, 'check.leap.year') do
+  Stalker.enqueue('leap.year.party') if Date.leap?(Time.now.year)
+end
+```
+
+In addition, Tickwork also supports `:before_tick` and `after_tick` callbacks.
+They are optional, and run every tick (a tick being whatever your `:sleep_timeout`
+is set to, default is 1 second):
+
+```ruby
+on(:before_tick) do
+  puts "tick"
+end
+
+on(:after_tick) do
+  puts "tock"
+end
+```
+
+Use cases
+---------
+
+Feel free to add your idea or experience and send a pull-request.
+
+- [Sending errors to Airbrake](https://github.com/tomykaira/clockwork/issues/58)
+
+Meta
+----
+
+Created by Adam Wiggins
+
+Inspired by [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler) and [resque-scheduler](https://github.com/bvandenbos/resque-scheduler)
+
+Design assistance from Peter van Hardenberg and Matthew Soldo
+
+Patches contributed by Mark McGranaghan and Lukáš Konarovský
+
+Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
+
+http://github.com/tomykaira/clockwork
+http://github.com/softwaregravy/tickwork

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = false
+end
+
+task :default => :test

data/example.rb

@@ -0,0 +1,28 @@
+require 'tickwork'
+
+module Tickwork
+  handler do |job|
+    puts "Queueing job: #{job}"
+  end
+
+  every(10.seconds, 'run.me.every.10.seconds')
+  every(1.minute, 'run.me.every.minute')
+  every(1.hour, 'run.me.every.hour')
+
+  every(1.day, 'run.me.at.midnight', :at => '00:00')
+
+  every(1.day, 'custom.event.handler', :at => '00:30') do
+    puts 'This event has its own handler'
+  end
+
+  # note: callbacks that return nil or false will cause event to not run
+  on(:before_tick) do
+    puts "tick"
+    true
+  end
+
+  on(:after_tick) do
+    puts "tock"
+    true
+  end
+end

data/gemfiles/activesupport3.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubysl-test-unit'
+  gem 'rubinius-developer_tools'
+end
+
+gem 'activesupport', '~> 3.2.14'
+gemspec :path=>"../"

data/gemfiles/activesupport4.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubysl-test-unit'
+  gem 'rubinius-developer_tools'
+end
+
+gem 'activesupport', '~> 4.0.0'
+gem 'minitest', '~> 4.2'
+gemspec :path=>"../"

data/lib/tickwork/at.rb

@@ -0,0 +1,62 @@
+module Tickwork
+  class At
+    class FailedToParse < StandardError; end
+
+    NOT_SPECIFIED = nil
+    WDAYS = %w[sunday monday tuesday wednesday thursday friday saturday].each.with_object({}).with_index do |(w, wdays), index|
+      [w, w.capitalize, w[0...3], w[0...3].capitalize].each do |k|
+        wdays[k] = index
+      end
+    end
+
+    def self.parse(at)
+      return unless at
+      case at
+      when /\A([[:alpha:]]+)\s(.*)\z/
+        if wday = WDAYS[$1]
+          parsed_time = parse($2)
+          parsed_time.wday = wday
+          parsed_time
+        else
+          raise FailedToParse, at
+        end
+      when /\A(\d{1,2}):(\d\d)\z/
+        new($2.to_i, $1.to_i)
+      when /\A\*{1,2}:(\d\d)\z/
+        new($1.to_i)
+      when /\A(\d{1,2}):\*\*\z/
+        new(NOT_SPECIFIED, $1.to_i)
+      else
+        raise FailedToParse, at
+      end
+    rescue ArgumentError
+      raise FailedToParse, at
+    end
+
+    attr_accessor :min, :hour, :wday
+
+    def initialize(min, hour=NOT_SPECIFIED, wday=NOT_SPECIFIED)
+      @min = min
+      @hour = hour
+      @wday = wday
+      raise ArgumentError unless valid?
+    end
+
+    def ready?(t)
+      (@min == NOT_SPECIFIED or t.min == @min) and
+        (@hour == NOT_SPECIFIED or t.hour == @hour) and
+        (@wday == NOT_SPECIFIED or t.wday == @wday)
+    end
+
+    def == other
+      @min == other.min && @hour == other.hour && @wday == other.wday
+    end
+
+    private
+    def valid?
+      @min == NOT_SPECIFIED || (0..59).cover?(@min) &&
+        @hour == NOT_SPECIFIED || (0..23).cover?(@hour) &&
+        @wday == NOT_SPECIFIED || (0..6).cover?(@wday)
+    end
+  end
+end

data/lib/tickwork/data_store.rb

@@ -0,0 +1,28 @@
+module Tickwork
+  class DataStore
+
+    # This is an abstract parent class, ruby style :)
+    #
+    # Tickwork requires a data store to record the last time events ran
+    # Ideally, this would be an optimistic write, but it doesn't really matter.
+    # It doesn't matter because our goal is errrs for at least once, vs. at most or exactly
+    # So we run, we record that we ran. There's a chance that another process also ran at the same time
+    # e.g we both read the same 'last time running'
+    # In practice, this shouldn't happen unless our external ticker is called faster than our jobs can run
+
+
+    # Providers should implement
+    #
+    # def get(key)
+    #
+    # end
+    # 
+    # def set(key, value)
+    #
+    # end
+    #
+    # note: keys will be prefixed with '_tickwork_' both for easy identification and also to 
+    # help avoid conflicts with the rest of the app
+
+  end
+end

data/lib/tickwork/event.rb

@@ -0,0 +1,83 @@
+module Tickwork
+  class Event
+    class IllegalJobName < RuntimeError; end
+
+    attr_accessor :job, :data_store_key
+
+    def initialize(manager, period, job, block, options={})
+      validate_if_option(options[:if])
+      @manager = manager
+      @period = period
+      raise IllegalJobName unless job.is_a?(String) && !job.empty? && Tickwork::Manager::MANAGER_KEY != job
+      @job = job
+      @at = At.parse(options[:at])
+      @block = block
+      @if = options[:if]
+      @thread = options.fetch(:thread, @manager.config[:thread])
+      @timezone = options.fetch(:tz, @manager.config[:tz])
+      namespace = options[:namespace] 
+      namespace ||= '_tickwork_'
+      @data_store_key = namespace + @job
+    end
+
+    def last
+      @manager.data_store.get(data_store_key)
+    end
+
+    def last=(value)
+      @manager.data_store.set(data_store_key, value)
+    end
+
+    def convert_timezone(t)
+      @timezone ? t.in_time_zone(@timezone) : t
+    end
+
+    def run_now?(t)
+      t = convert_timezone(t)
+      elapsed_ready(t) and (@at.nil? or @at.ready?(t)) and (@if.nil? or @if.call(t))
+    end
+
+    def elapsed_ready(t)
+      last.nil? || (t - last.to_i).to_i >= @period
+    end
+
+    def thread?
+      @thread
+    end
+
+    def run(t)
+      @manager.log "Triggering '#{self}'"
+      self.last = convert_timezone(t)
+      if thread?
+        if @manager.thread_available?
+          t = Thread.new do
+            execute
+          end
+          t['creator'] = @manager
+        else
+          @manager.log_error "Threads exhausted; skipping #{self}"
+        end
+      else
+        execute
+      end
+    end
+
+    def to_s
+      job
+    end
+
+    private
+    def execute
+      @block.call(@job, last)
+    rescue => e
+      @manager.log_error e
+      @manager.handle_error e
+    end
+
+    def validate_if_option(if_option)
+      if if_option && !if_option.respond_to?(:call)
+        raise ArgumentError.new(':if expects a callable object, but #{if_option} does not respond to call')
+      end
+    end
+  end
+end