rekiq 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc545471fb04e687f4cf1cc9e9289db9060b579c
+  data.tar.gz: 74cc308381099f8711c6a27b16f3875c2d29168f
+SHA512:
+  metadata.gz: fae12ce36fd971421f930c9195434b186c968cc8a82cec9c546a332f9551500635ca30f0d83d35426d25ea0b844596a89ef06e48400bef1d5d988cc01b77ab18
+  data.tar.gz: 730dbbba9558c1a9d80e30f2f8707ad102de3faf272e404c9ff65ea155fafd803ae01d99548725645176d1011087ade597e7032d0351913432548bf30cc9c538

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+example/tmp

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format documentation
+--format html -o "tmp/rspec.html"

data/.ruby-gemset

@@ -0,0 +1 @@
+rekiq

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.1

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3
+script: CODECLIMATE_REPO_TOKEN=13221c16cb92c5dc8312b2f2f9f4960271e67845ba5e2852dbba3d786ccf2c81 bundle exec rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 junhanamaki
+
+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,80 @@
+# Rekiq
+
+[![Build Status](https://travis-ci.org/junhanamaki/rekiq.svg?branch=master)](https://travis-ci.org/junhanamaki/rekiq)
+[![Code Climate](https://codeclimate.com/github/junhanamaki/rekiq.png)](https://codeclimate.com/github/junhanamaki/rekiq)
+[![Test Coverage](https://codeclimate.com/github/junhanamaki/rekiq/coverage.png)](https://codeclimate.com/github/junhanamaki/rekiq)
+[![Dependency Status](https://gemnasium.com/junhanamaki/rekiq.svg)](https://gemnasium.com/junhanamaki/rekiq)
+
+**Rekiq is a recurring worker extension for
+[Sidekiq](https://github.com/mperham/sidekiq).**
+
+Rekiq extends Sidekiq and adds functionality to schedule recurring workers.
+
+Sidekiq is an amazing gem that allows us delegate time consuming work to a
+worker, or even to schedule a time for the worker to start. Now wouldn't it be
+nice if it also allowed us to schedule a worker to do work recurringly? That's
+what rekiq purposes to do.
+
+In pratical means, rekiq allows you to schedule a worker to repeat the same
+work friday at 23:00, for example.
+
+## Requirements
+
+Tested with:
+
+  * Ruby version 2.1.1, 2.0.0 and 1.9.3
+  * Sidekiq 3.2.1
+  * ice_cube 0.12.1
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rekiq', git: 'https://github.com/junhanamaki/rekiq'
+
+And then execute:
+
+    $ bundle
+
+Or compile source by hand, since for now it's not published.
+
+## Usage
+
+Require rekiq after sidekiq:
+
+    require 'sidekiq'
+    require 'rekiq'
+
+We need a 'schedule' object (responsible for returning the time at which the
+worker should start) which must respond to method next_occurrence and
+receives one argument of type Time more at [schedule](). For our example we'll use gem
+[ice_cube](https://github.com/seejohnrun/ice_cube) (don't forget to require it):
+
+    # define worker as normal
+    class ExampleWorker
+      include Sidekiq::Worker
+
+      def perform(arg1, arg2)
+        # Do some work
+      end
+    end
+
+    # create schedule for worker to repeat every friday at 2am
+    schedule = IceCube::Schedule.new do |s|
+        s.rrule IceCube::Rule.daily.day(:friday).hour_of_day(2)
+      end
+
+    # now just start your worker
+    ExampleWorker.perform_recurringly(schedule, 'argument_1', 'argument_2')
+
+You can use your own schedule object, configure worker to reschedule before or
+after work is done, set margin, and much more! So please check
+[wiki](https://github.com/junhanamaki/rekiq/wiki) for more details.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rekiq/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/example/sidekiq.yml

@@ -0,0 +1,6 @@
+:verbose: false
+:pidfile: ./tmp/sidekiq.pid
+# :logfile: ./tmp/log/sidekiq.log
+:concurrency: 5
+:queues:
+  - [rekiq_test_worker, 10]

data/example/test_app.rb

@@ -0,0 +1,30 @@
+# install gem and run with:
+# bundle exec sidekiq -C example/sidekiq.yml -r ./example/test_app.rb
+
+require 'ice_cube'
+require 'sidekiq'
+require 'rekiq'
+
+# define sidekiq worker as you normally would
+class TestWorker1
+  include Sidekiq::Worker
+
+  sidekiq_options queue: "rekiq_test_worker", retry: false
+
+  def perform(arg1, arg2)
+    puts "\n\nhello from TestWorker1, arg1 is #{arg1}, arg2 is #{arg2}" \
+         "scheduled work time was #{scheduled_work_time}\n\n"
+  end
+end
+
+# create ice cube schedule
+schedule = IceCube::Schedule.new(Time.now) do |s|
+    s.rrule IceCube::Rule.minutely
+  end
+
+# invoke method
+TestWorker1.perform_recurringly(
+  schedule,
+  ['Rekiq', 'ola', '!!!'],
+  { 'complex' => { 'hash' => 'woot!' } }
+)

data/lib/rekiq/configuration.rb

@@ -0,0 +1,33 @@
+module Rekiq
+  class Configuration
+    attr_accessor :reschedule_post_work, :schedule_expired,
+                  :expiration_margin
+
+    def initialize
+      # if work is rescheduled after or before the worker completes
+      self.reschedule_post_work = false
+
+      # if expired works are to be scheduled
+      # an expired work is a work that has a time bellow current_time - margin
+      self.schedule_expired = false
+
+      # indicates the margin after which a work is considered expired
+      # default to 0
+      self.expiration_margin = 0
+    end
+  end
+
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset_configuration
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/rekiq/exceptions.rb

@@ -0,0 +1,4 @@
+module Rekiq
+  class StandardError < ::StandardError; end
+  class SidekiqNotLoaded < StandardError; end
+end

data/lib/rekiq/job.rb

@@ -0,0 +1,103 @@
+require 'yaml'
+require 'rekiq/schedule_format_validator'
+
+module Rekiq
+  class Job
+    include ActiveModel::Validations
+    include ActiveModel::Validations::Callbacks
+
+    attr_accessor :schedule, :shift, :reschedule_post_work, :schedule_expired,
+                  :expiration_margin
+
+    validates :schedule, 'rekiq::_schedule_format' => true
+    validates :shift, numericality: true
+    validates :reschedule_post_work, :schedule_expired,
+              inclusion: { in: [true, false], allow_nil: true }
+    validates :expiration_margin,
+              numericality: { greater_than_or_equal_to: 0, allow_nil: true }
+
+    def self.from_short_key_hash(hash)
+      hash['schedule']             = YAML::load(hash['sch'])
+      hash['shift']                = hash['sft']
+      hash['reschedule_post_work'] = hash['rpw']
+      hash['schedule_expired']     = hash['se']
+      hash['expiration_margin']    = hash['em']
+
+      new(hash)
+    end
+
+    def initialize(attributes = {})
+      self.schedule             = attributes['schedule']
+      self.shift                = attributes['shift'] || 0
+      self.reschedule_post_work = attributes['reschedule_post_work']
+      self.schedule_expired     = attributes['schedule_expired']
+      self.expiration_margin    = attributes['expiration_margin']
+    end
+
+    def to_short_key_hash
+      {
+        'sch' => YAML::dump(schedule),
+        'sft' => shift,
+        'rpw' => reschedule_post_work,
+        'se'  => schedule_expired,
+        'em'  => expiration_margin
+      }
+    end
+
+    def next_work_time(from = Time.now)
+      shifted_from = shift > 0 ? from - shift : from
+
+      search_next_work_time(shifted_from)
+    end
+
+    def next_work_time_from_work_time(from)
+      shifted_from = from - shift
+
+      search_next_work_time(shifted_from)
+    end
+
+    def reschedule_post_work?
+      unless reschedule_post_work.nil?
+        reschedule_post_work
+      else
+        Rekiq.configuration.reschedule_post_work
+      end
+    end
+
+  private
+
+    def search_next_work_time(from)
+      if schedule_expired?
+        from = schedule.next_occurrence(from)
+        work_time = from.nil? ? nil : from + shift
+      else
+        begin
+          from = schedule.next_occurrence(from)
+          work_time = from.nil? ? nil : from + shift
+        end until work_time.nil? || work_time > expiration_time
+      end
+
+      work_time
+    end
+
+    def schedule_expired?
+      unless schedule_expired.nil?
+        schedule_expired
+      else
+        Rekiq.configuration.schedule_expired
+      end
+    end
+
+    def expiration_margin_val
+      unless expiration_margin.nil?
+        expiration_margin
+      else
+        Rekiq.configuration.expiration_margin
+      end
+    end
+
+    def expiration_time
+      Time.now - expiration_margin_val
+    end
+  end
+end

data/lib/rekiq/middleware/utils.rb

@@ -0,0 +1,14 @@
+module Rekiq
+  module Middleware
+    class Utils
+      def call(worker, msg, queue)
+        if worker.respond_to?(:scheduled_work_time) and
+           msg.key?('rq:at')
+          worker.scheduled_work_time = Time.at(msg['rq:at']).utc
+        end
+
+        yield
+      end
+    end
+  end
+end

data/lib/rekiq/middleware/work_overseer.rb

@@ -0,0 +1,58 @@
+require 'sidekiq'
+require 'sidekiq/util'
+require 'rekiq/configuration'
+require 'rekiq/job'
+require 'rekiq/scheduler'
+
+module Rekiq
+  module Middleware
+    class WorkOverseer
+      include ::Sidekiq::Util
+
+      attr_accessor :worker_name, :queue, :args, :job, :addon,
+                    :scheduled_work_time
+
+      def call(worker, msg, queue)
+        return yield unless msg['rq:job']
+
+        self.worker_name = worker.class.name
+        self.queue       = queue
+        self.args        = msg['args']
+        self.job         = Job.from_short_key_hash(msg['rq:job'])
+        self.addon       = msg['rq:addon']
+
+        if msg['retry_count'].nil?
+          self.scheduled_work_time = Time.at(msg['rq:at'].to_f)
+          reschedule_post_work = job.reschedule_post_work?
+
+          if reschedule_post_work
+            begin
+              yield
+            ensure
+              reschedule
+            end
+          else
+            reschedule
+            yield
+          end
+        else
+          yield
+        end
+      end
+
+      def reschedule
+        jid, work_time =
+          Rekiq::Scheduler
+            .new(worker_name, queue, args, job, addon)
+            .schedule_from_work_time(scheduled_work_time)
+
+        unless jid.nil?
+          logger.info "recurring work for #{worker_name} scheduled for " \
+                      "#{work_time} with jid #{jid}"
+        else
+          logger.info 'recurrence terminated, job terminated'
+        end
+      end
+    end
+  end
+end

data/lib/rekiq/schedule_format_validator.rb

@@ -0,0 +1,16 @@
+require 'active_model'
+
+module Rekiq
+  class ScheduleFormatValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      unless value.respond_to?(:next_occurrence) and
+             value.method(:next_occurrence).arity.abs > 0
+        record.errors[attribute] <<
+          "invalid value for #{attribute}, value must be an object that " \
+          'responds to next_occurrence, and that receives at least one ' \
+          'argument of type Time, representing Time from which to calculate ' \
+          'next occurrence time'
+      end
+    end
+  end
+end

data/lib/rekiq/scheduler.rb

@@ -0,0 +1,42 @@
+module Rekiq
+  class Scheduler
+    attr_accessor :worker_name, :queue, :args, :job, :addon, :work_time
+
+    def initialize(worker_name, queue, args, job, addon)
+      self.worker_name = worker_name
+      self.queue       = queue
+      self.args        = args
+      self.job         = job
+      self.addon       = addon
+    end
+
+    def schedule(from = Time.now)
+      self.work_time = job.next_work_time(from)
+
+      work_time.nil? ? nil : [schedule_work, work_time]
+    end
+
+    def schedule_from_work_time(from)
+      self.work_time = job.next_work_time_from_work_time(from)
+
+      work_time.nil? ? nil : [schedule_work, work_time]
+    end
+
+  private
+
+    def schedule_work
+      client_args = {
+          'at'     => work_time.to_f,
+          'queue'  => queue,
+          'class'  => worker_name,
+          'args'   => args,
+          'rq:job' => job.to_short_key_hash,
+          'rq:at'  => work_time.to_f
+        }.tap do |hash|
+          hash['rq:addon'] = addon unless addon.nil?
+        end
+
+      Sidekiq::Client.push(client_args)
+    end
+  end
+end

data/lib/rekiq/version.rb

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

data/lib/rekiq/worker.rb

@@ -0,0 +1,62 @@
+require 'rekiq/exceptions'
+require 'rekiq/job'
+require 'rekiq/scheduler'
+
+module Rekiq
+  module Worker
+    class Configuration
+      attr_accessor :shift, :reschedule_post_work, :schedule_expired,
+                    :expiration_margin, :addon
+
+      def append_to_msg(addon)
+        self.addon = addon
+      end
+    end
+
+    module ClassMethods
+      def perform_recurringly(schedule, *args)
+        config = Configuration.new
+        yield config if block_given?
+
+        job =
+          Rekiq::Job
+            .new 'schedule'             => schedule,
+                 'shift'                => config.shift,
+                 'reschedule_post_work' => config.reschedule_post_work,
+                 'schedule_expired'     => config.schedule_expired,
+                 'expiration_margin'    => config.expiration_margin
+
+        queue = get_sidekiq_options['queue']
+
+        jid, work_time =
+          Rekiq::Scheduler
+            .new(name, queue, args, job, config.addon)
+            .schedule
+
+        return if jid.nil?
+
+        ::Sidekiq.logger.info "recurring work for #{name} scheduled for " \
+                              "#{work_time} with jid #{jid}"
+
+        jid
+      rescue StandardError => e
+        raise Rekiq::StandardError,
+              'unable to schedule worker',
+              e.backtrace
+      end
+    end
+  end
+end
+
+module Sidekiq
+  module Worker
+    attr_accessor :scheduled_work_time
+
+    original_included_method = method(:included)
+
+    define_singleton_method :included do |base|
+      original_included_method.call(base)
+      base.extend(Rekiq::Worker::ClassMethods)
+    end
+  end
+end

data/lib/rekiq.rb

@@ -0,0 +1,22 @@
+require 'rekiq/version'
+require 'rekiq/exceptions'
+
+unless defined?(Sidekiq)
+  raise Rekiq::SidekiqNotLoaded,
+        'sidekiq must be required before requiring rekiq'
+end
+
+require 'rekiq/middleware/work_overseer'
+require 'rekiq/middleware/utils'
+require 'rekiq/worker'
+
+module Rekiq
+
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Rekiq::Middleware::Utils
+    chain.add Rekiq::Middleware::WorkOverseer
+  end
+end

data/rekiq.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rekiq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rekiq"
+  spec.version       = Rekiq::VERSION
+  spec.authors       = ["junhanamaki"]
+  spec.email         = ["jun.hanamaki@gmail.com"]
+  spec.summary       = %q{recurring worker extension for sidekiq}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.3'
+  spec.add_development_dependency 'factory_girl', '~> 4.4'
+  spec.add_development_dependency 'jazz_hands', '~> 0.5'
+  spec.add_development_dependency 'ice_cube', '~> 0.12'
+  spec.add_development_dependency 'sidekiq', '~> 3.2'
+
+  spec.add_runtime_dependency 'activemodel', '~> 4.1'
+end

data/spec/factories/job.rb

@@ -0,0 +1,15 @@
+require 'ice_cube'
+
+FactoryGirl.define do
+  factory :job, class: Rekiq::Job do
+    shift    0
+    schedule { IceCube::Schedule.new(Time.now + 3600) }
+
+    trait :randomized_attributes do
+      shift                { [*0..100].sample }
+      reschedule_post_work { [nil, false, true].sample }
+      schedule_expired     { [nil, false, true].sample }
+      expiration_margin    { [*0..100].sample }
+    end
+  end
+end