sidekiq_schedulable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 558a8b58ecf33d2edc81636f2f5ba511100a6378
+  data.tar.gz: 8a4596c211c0f8c14a4dfbe2afe14f1a26c312c9
+SHA512:
+  metadata.gz: 8b0da8f414f5fc013f18dd7f4d1c321662f883c3e5e94ccd780f7b280430b86ae76c9f34793508b3e951a7bc3dc2b943e4abeeabe141a7066edda7c31f72c18d
+  data.tar.gz: 2a7ffab36ba92166caffe4e197b86784e4d327a2b484e3d30ee00325ff4bb24e873f7ce868490e36911e1b9d36378bd88995e154bb7a62823ee657a425657b5e

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/Gemfile

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

data/README.md

@@ -0,0 +1,23 @@
+# Sidekiq Schedulable
+
+Schedule Cron style Sidekiq jobs
+
+## Usage
+
+```ruby
+require 'sidekiq_schedulable'
+```
+
+```ruby
+class MyJob
+  include Sidekiq::Worker
+  include Sidekiq::Schedulable
+
+  sidekiq_options retry: false, queue: 'my_scheduled_jobs_queue'
+  sidekiq_schedule '*/5 * * * * *'
+
+  def perform
+    RunReport.call
+  end
+end
+```

data/lib/sidekiq/schedulable.rb

@@ -0,0 +1,16 @@
+module Sidekiq
+  module Schedulable
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def sidekiq_schedule(schedule)
+        SidekiqSchedulable.schedules[self.to_s] = {
+          worker: self,
+          at: schedule
+        }
+      end
+    end
+  end
+end

data/lib/sidekiq_schedulable.rb

@@ -0,0 +1,35 @@
+require 'sidekiq'
+require 'sidekiq/schedulable'
+require 'sidekiq_schedulable/startup'
+require 'sidekiq_schedulable/middleware/server'
+require 'sidekiq_schedulable/middleware/client'
+
+module SidekiqSchedulable
+  def self.schedules
+    @schedules ||= {}
+  end
+
+  def self.boot!
+    Sidekiq.configure_server do |config|
+      config.server_middleware do |chain|
+        chain.add Middleware::Server
+      end
+
+      config.client_middleware do |chain|
+        chain.add Middleware::Client, schedules
+      end
+
+      config.on(:startup) do
+        Startup.new(schedules, Sidekiq::ScheduledSet.new).schedule!
+      end
+    end
+
+    Sidekiq.configure_client do |config|
+      config.client_middleware do |chain|
+        chain.add Middleware::Client, schedules
+      end
+    end
+  end
+end
+
+SidekiqSchedulable.boot!

data/lib/sidekiq_schedulable/middleware/client.rb

@@ -0,0 +1,16 @@
+module SidekiqSchedulable
+  module Middleware
+    class Client
+      def initialize(schedules = {})
+        @schedules = schedules
+      end
+
+      def call(worker_class, item, queue, redis_pool)
+        if schedule = @schedules[worker_class]
+          item['schedule'] = schedule[:at]
+        end
+        yield
+      end
+    end
+  end
+end

data/lib/sidekiq_schedulable/middleware/server.rb

@@ -0,0 +1,21 @@
+require 'sidekiq_schedulable/schedule'
+
+module SidekiqSchedulable
+  module Middleware
+    class Server
+      def call(worker, item, queue)
+        yield
+      ensure
+        schedule_next_job(worker, item) if item['schedule']
+      end
+
+      private
+
+      def schedule_next_job(worker, item)
+        schedule = item['schedule']
+        time = Schedule.next_time(schedule)
+        worker.class.perform_at(time)
+      end
+    end
+  end
+end

data/lib/sidekiq_schedulable/schedule.rb

@@ -0,0 +1,9 @@
+require 'parse-cron'
+
+module SidekiqSchedulable
+  module Schedule
+    def self.next_time(schedule)
+      CronParser.new(schedule).next(Time.now)
+    end
+  end
+end

data/lib/sidekiq_schedulable/startup.rb

@@ -0,0 +1,40 @@
+require 'sidekiq_schedulable/schedule'
+
+module SidekiqSchedulable
+  class Startup
+    def self.schedule!(schedules, current_jobs)
+      new(schedules, current_jobs).schedule!
+    end
+
+    def initialize(schedules, current_jobs)
+      @schedules = schedules
+      @current_jobs = current_jobs
+    end
+
+    def schedule!
+      schedules.each do |worker_class, schedule|
+        unless already_scheduled?(worker_class)
+          time = Schedule.next_time(schedule[:at])
+          worker = schedule[:worker]
+          worker.perform_at(time)
+        end
+      end
+    end
+
+    private
+
+    attr_reader :schedules, :current_jobs
+
+    def already_scheduled?(worker_class)
+      scheduled_jobs.any? do |job|
+        job.item['class'] == worker_class
+      end
+    end
+
+    def scheduled_jobs
+      @scheduled_jobs ||= current_jobs.select do |job|
+        job.item['schedule']
+      end
+    end
+  end
+end

data/lib/sidekiq_schedulable/version.rb

@@ -0,0 +1,3 @@
+module SidekiqSchedulable
+  VERSION = '0.0.1'
+end

data/sidekiq_schedulable.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq_schedulable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq_schedulable"
+  spec.version       = SidekiqSchedulable::VERSION
+  spec.authors       = ["Kevin Buchanan"]
+  spec.summary       = "Scheduled Sidekiq jobs"
+  spec.description   = "Schedule Cron style Sidekiq jobs"
+  spec.homepage      = "https://github.com/kevinbuch/sidekiq_schedulable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq", "~> 3.0"
+  spec.add_dependency "parse-cron", "~> 0.1.4"
+
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "timecop", "~> 0.8.0"
+end

data/spec/sidekiq_schedulable_spec.rb

@@ -0,0 +1,110 @@
+require 'sidekiq_schedulable'
+require 'sidekiq'
+require 'sidekiq/testing'
+require 'timecop'
+
+describe SidekiqSchedulable do
+
+  Sidekiq::Testing.fake!
+
+  class TestWorker
+    include Sidekiq::Worker
+    include Sidekiq::Schedulable
+
+    sidekiq_schedule '*/10 * * * * *'
+  end
+
+  let(:midnight) { Time.new(2015, 10, 1, 0, 0, 0) }
+  let(:next_ten_minutes) { midnight + 10 * 60 }
+
+  before do
+    Timecop.freeze(midnight)
+  end
+
+  after do
+    TestWorker.jobs.clear
+  end
+
+  it "adds the schedule to the schedules" do
+    schedule = SidekiqSchedulable.schedules["TestWorker"]
+
+    expect(schedule[:at]).to eq('*/10 * * * * *')
+    expect(schedule[:worker]).to eq(TestWorker)
+  end
+
+  describe SidekiqSchedulable::Middleware::Server do
+    let(:worker) { TestWorker.new }
+    let(:middleware) { SidekiqSchedulable::Middleware::Server.new }
+
+    it "ensures the job is re-enqueued for next time" do
+      expect {
+        middleware.call(worker, { 'schedule' => '*/10 * * * * *' }, 'a queue') do
+          raise "Error"
+        end
+      }.to raise_error RuntimeError, "Error"
+
+      jobs = TestWorker.jobs
+
+      expect(jobs.size).to eq(1)
+      expect(jobs.first['at']).to eq(next_ten_minutes.to_f)
+    end
+
+    it "does not re-schedule if the job has no schedule" do
+      middleware.call(worker, {}, 'a queue') do
+        true
+      end
+
+      expect(TestWorker.jobs.size).to eq(0)
+    end
+  end
+
+  let(:schedules) {
+    { "TestWorker" => { worker: TestWorker, at: '*/10 * * * * *' } }
+  }
+
+  describe SidekiqSchedulable::Middleware::Client do
+    let(:middleware) { SidekiqSchedulable::Middleware::Client.new(schedules) }
+
+    it "adds the schedule to the job item" do
+      item = {}
+
+      middleware.call("TestWorker", item, "a queue", nil) do
+        true
+      end
+
+      expect(item['schedule']).to eq('*/10 * * * * *')
+    end
+
+    it "does not add the schedule if the worker has no schedule" do
+      item = {}
+
+      middleware.call("Array", item, "a queue", nil) do
+        true
+      end
+
+      expect(item['schedule']).to be_nil
+    end
+  end
+
+  describe SidekiqSchedulable::Startup do
+    Job = Struct.new(:item)
+
+    def current_jobs
+      TestWorker.jobs.map { |item| Job.new(item) }
+    end
+
+    it "enqueues a job for the given worker on an empty queue" do
+      SidekiqSchedulable::Startup.schedule!(schedules, current_jobs)
+
+      expect(TestWorker.jobs.size).to eq(1)
+      expect(TestWorker.jobs.first['at']).to eq(next_ten_minutes.to_f)
+    end
+
+    it "does not enqueue a duplicate job for the given worker" do
+      SidekiqSchedulable::Startup.schedule!(schedules, current_jobs)
+      SidekiqSchedulable::Startup.schedule!(schedules, current_jobs)
+
+      expect(TestWorker.jobs.size).to eq(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+
+RSpec.configure do |config|
+  config.order = :random
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_schedulable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Buchanan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: parse-cron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: Schedule Cron style Sidekiq jobs
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- lib/sidekiq/schedulable.rb
+- lib/sidekiq_schedulable.rb
+- lib/sidekiq_schedulable/middleware/client.rb
+- lib/sidekiq_schedulable/middleware/server.rb
+- lib/sidekiq_schedulable/schedule.rb
+- lib/sidekiq_schedulable/startup.rb
+- lib/sidekiq_schedulable/version.rb
+- sidekiq_schedulable.gemspec
+- spec/sidekiq_schedulable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kevinbuch/sidekiq_schedulable
+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.5
+signing_key: 
+specification_version: 4
+summary: Scheduled Sidekiq jobs
+test_files: []