dispatch-rider 1.6.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 697069b0aff03bae879decd081323fe5c90441b1
-  data.tar.gz: 25ae5e9c896c920864800e9dea6e7421cafe3aee
+  metadata.gz: ceff36f00f29c392c12751a5b9be98ded76af731
+  data.tar.gz: 4252fb5a29899475e8dd465cd9d9073a81c8bd4e
 SHA512:
-  metadata.gz: a0496f4be0ffffa3bcf025abc4a92dd8fc42c621a667bf8c69841120a8472cf0c37f37663b2fc0226b59b7e01990219eb8eec528fcb851974f0848eb4f6af445
-  data.tar.gz: 407419063fd8c30148d644156ddbaba8342250f9310dc6323d5affa259ec15dcf2ba9694893d209530f978ff7fb5cee5c21551b8d00652c71584fbcc47b8a3b8
+  metadata.gz: 3f1f68c73b69964a68b0222fc02319e0f954d380af74a255d5eb69c15ca48c3c6374a0d14f29a81f41f7be664edf43cf785f223d8b2f4b1b0f853246242011bb
+  data.tar.gz: cf671844773968e6930f9e2ff3245903e658c04bbf40f2c41eac2a01b7ca6b7f2ce8c4dad9c6a77042163897800ec777c2ec4620c302303b7814788e0e7c179c

data/.gitignore

@@ -15,6 +15,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spectmp
 log
 .rvmrc
 .ruby*

data/README.md

@@ -448,6 +448,61 @@ DispatchRider.config do |config|
   config.error_handler = DispatchRider::AirbrakeErrorHandler
 end
 ```
+## Scheduling Job
+
+Scheduled jobs currently require `ActiveRecord`. Support for other ORM will be added in the future depending on demand.
+
+1. Add and run the DB migration below:
+  ```ruby
+  class CreateScheduledJobsTable < ActiveRecord::Migration
+    include DispatchRider::ScheduledJob::Migration
+
+    def change
+      create_scheduled_jobs_table
+    end
+  end
+  ```
+
+2. Schedule jobs:
+  ```ruby
+  # Use `#publish_later`
+  class NewsPublisher < DispatchRider::Publisher::Base
+    destinations :sns_message_queue
+    subject "read_news"
+
+    def self.midnight_publish(news)
+      new.publish_later("headlines" => news.headlines, at: Date.tomorrow.midnight)
+    end
+  end
+
+  # Or create a scheduled job manually
+  DispatchRider::ScheduledJob.create! scheduled_at: Date.tomorrow.midnight,
+                                      destinations: [:sns_message_queue],
+                                      message: {
+                                        subject: "read_news",
+                                        body: { "headlines" => news.headlines }
+                                      }
+  ```
+
+3. Run scheduled publishing.
+  ```ruby
+  # Run once
+
+  # Ideally run on a cron. Where the cron is responsible for the publishing
+  # frequency. Any jobs due at the time this is run by the cron  will be
+  # published.
+  DispatchRider::ScheduledJob.publish_due_jobs
+
+  # Loop. Warning: Loops are blocking. Run this on a separate thread if it's not
+  # the sole purpose of the app.
+
+  # publish every minute
+  DispatchRider::ScheduledJob.publish_due_jobs every: 1.minute
+
+  # publish every half an hour
+  DispatchRider::ScheduledJob.publish_due_jobs every: 30.minutes
+  ```
+
 ## Deployment
 
 In order to deploy a new version of the gem into the wild ...

data/dispatch-rider.gemspec

@@ -41,6 +41,9 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'activesupport', ">= 3.2.0"
   gem.add_runtime_dependency 'activemodel', ">= 3.2.0"
+  gem.add_runtime_dependency "activerecord", ">= 3.2.0"
   gem.add_runtime_dependency 'daemons', "~> 1.2"
   gem.add_runtime_dependency 'retries', "~> 0.0", ">= 0.0.5"
+
+  gem.add_development_dependency "sqlite3"
 end

data/lib/dispatch-rider.rb

@@ -41,4 +41,5 @@ require "dispatch-rider/demultiplexer"
 require "dispatch-rider/runner"
 require "dispatch-rider/publisher"
 require "dispatch-rider/subscriber"
+require "dispatch-rider/scheduled_job"
 require "dispatch-rider/logging"

data/lib/dispatch-rider/publisher/base.rb

@@ -30,10 +30,19 @@ module DispatchRider
 
     # @param [Hash] body
     def publish(body)
-      raise ArgumentError, 'body should be a hash' unless body.kind_of?(Hash)
+      validate_body(body)
       publisher.publish(destinations: destinations, message: { subject: subject, body: body })
     end
 
+    # @param [Hash] body
+    # @param [Time] at
+    def publish_later(body, at:)
+      validate_body(body)
+      DispatchRider::ScheduledJob.create! scheduled_at: at,
+                                          destinations: destinations,
+                                          message: { subject: subject, body: body }
+    end
+
     private
 
     def publisher
@@ -47,5 +56,9 @@ module DispatchRider
     def subject
       self.class.instance_variable_get(:@subject)
     end
+
+    def validate_body(body)
+      raise ArgumentError, 'body should be a hash' unless body.is_a?(Hash)
+    end
   end
 end

data/lib/dispatch-rider/scheduled_job.rb

@@ -0,0 +1,59 @@
+require "active_record"
+
+# @note: Later this could be pulled out to its own gem and included depending on what ORM the user
+# prefers. Something like:
+# @example
+#  gem "dispatch_rider-active_record"
+#  gem "dispatch_rider-rom" # Ruby Object Mapper
+#  gem "dispatch_rider-mongo_mapper"
+#  gem "dispatch_rider-ohm"
+module DispatchRider
+  class ScheduledJob < ActiveRecord::Base
+    class << self
+      def publisher
+        @publisher ||= Publisher.new
+      end
+
+      # @param [ActiveSupport::Duration] every
+      # @example: DispatchRider::ScheduledJob.publish_due_jobs every 1.minute
+      def publish_due_jobs(every: nil)
+        loop {
+          claim_stub = get_new_claim_stub
+          due.unclaimed.update_all claim_stub
+          due.claimed_by(claim_stub[:claim_id]).find_each(&:publish)
+          every ? sleep(every) : break # until the next loop
+        }
+      end
+
+      private
+
+      def get_new_claim_stub
+        { claim_id: SecureRandom.uuid, claim_expires_at: 30.minutes.from_now }
+      end
+    end
+
+    serialize :destinations
+    serialize :message
+
+    validates :scheduled_at,
+              :destinations,
+              :message,
+              presence: true
+
+    scope :due, -> (time = Time.now) { where "scheduled_at <= ?", time }
+    scope :claimed_by, -> (claim_id) { where(claim_id: claim_id).where "claim_expires_at > ?", Time.now }
+    scope :unclaimed, -> { where "claim_expires_at IS NULL OR claim_expires_at <= ?", Time.now }
+
+    def publish
+      publisher.publish(destinations: destinations, message: message)
+
+      destroy # once published
+    end
+
+    private
+
+    delegate :publisher, to: :"self.class"
+  end
+end
+
+require_relative "scheduled_job/migration"

data/lib/dispatch-rider/scheduled_job/migration.rb

@@ -0,0 +1,15 @@
+module DispatchRider
+  module ScheduledJob::Migration
+    def create_scheduled_jobs_table
+      create_table :scheduled_jobs do |t|
+        t.datetime :scheduled_at
+        t.text :destinations
+        t.text :message
+        t.string :claim_id
+        t.datetime :claim_expires_at
+
+        t.index :scheduled_at
+      end
+    end
+  end
+end

data/lib/dispatch-rider/version.rb

@@ -1,4 +1,4 @@
 # This file specifies the current version of the gem.
 module DispatchRider
-  VERSION = "1.6.2"
+  VERSION = "1.7.0"
 end

data/spec/lib/dispatch-rider/scheduled_job_spec.rb

@@ -0,0 +1,73 @@
+require "spec_helper"
+
+describe DispatchRider::ScheduledJob do
+  let(:message_details) {
+    {
+      destinations: [:allied_forces],
+      message: {
+        subject: :war_update,
+        body: { enigma_machine: :broken }
+      }
+    }
+  }
+
+  let!(:due_job) { described_class.create! message_details.merge(scheduled_at: 1.minute.ago) }
+  let!(:later_job) { described_class.create! message_details.merge(scheduled_at: 30.minutes.since) }
+
+  describe ".due" do
+    describe "due now" do
+      subject(:due_jobs) { described_class.due }
+
+      it { expect(due_jobs).to include due_job }
+      it { expect(due_jobs).to_not include later_job }
+    end
+
+    describe "due tomorrow" do
+      subject(:due_jobs) { described_class.due Date.tomorrow.midnight }
+
+      it { expect(due_jobs).to include due_job }
+      it { expect(due_jobs).to include later_job }
+    end
+  end
+
+  describe ".publish_due_jobs" do
+    example {
+      expect(described_class.publisher).to receive(:publish).once.with destinations: [:allied_forces],
+                                                                       message: {
+                                                                         subject: :war_update,
+                                                                         body: { enigma_machine: :broken }
+                                                                       }
+
+      2.times { described_class.publish_due_jobs }
+    }
+  end
+
+  describe "#destinations serialization" do
+    subject { described_class.find(due_job.id).destinations }
+
+    it { is_expected.to eq [:allied_forces] }
+  end
+
+  describe "#message serialization" do
+    subject { described_class.find(due_job.id).message }
+
+    it {
+      is_expected.to eq subject: :war_update,
+                        body: { enigma_machine: :broken }
+    }
+  end
+
+  describe "#publish" do
+    subject(:job) { described_class.find(due_job.id) }
+
+    example {
+      expect(described_class.publisher).to receive(:publish).with destinations: [:allied_forces],
+                                                                  message: {
+                                                                    subject: :war_update,
+                                                                    body: { enigma_machine: :broken }
+                                                                  }
+
+      job.publish
+    }
+  end
+end

data/spec/spec_helper.rb

@@ -6,6 +6,8 @@ Bundler.require
 require 'aws'
 require 'rake'
 require 'tempfile'
+require "sqlite3"
+
 
 require 'dispatch-rider'
 Dir['./spec/support/**/*.rb'].each { |fn| require(fn) }
@@ -25,10 +27,26 @@ RSpec.configure do |config|
 
   config.include IntegrationSupport
 
+  config.before(:suite) do
+    FileUtils.mkdir_p "tmp"
+    FileUtils.rm_f "tmp/lite.db"
+    FileUtils.rm_rf "spectmp"
+    SQLite3::Database.new "tmp/lite.db"
+    ActiveRecord::Base.establish_connection adapter: :sqlite3, database: File.dirname(__FILE__) + "tmp/lite.db"
+    ActiveRecord::Schema.define(version: 1) do
+      extend DispatchRider::ScheduledJob::Migration
+      create_scheduled_jobs_table
+    end
+  end
+
   config.before do
     DispatchRider.config.logger = NullLogger.new
   end
 
+  config.after do
+    DispatchRider::ScheduledJob.destroy_all
+  end
+
   config.include FactoryGirl::Syntax::Methods
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dispatch-rider
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Suman Mukherjee
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-25 00:00:00.000000000 Z
+date: 2015-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -41,6 +41,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: daemons
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +89,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: "\n    Messaging system based on the reactor pattern.\n\n    You can
   publish messages to a queue and then a demultiplexer\n    runs an event loop which
   pops items from the queue and hands\n    it over to a dispatcher.\n\n    The dispatcher
@@ -159,6 +187,8 @@ files:
 - lib/dispatch-rider/registrars/queue_service.rb
 - lib/dispatch-rider/registrars/sns_channel.rb
 - lib/dispatch-rider/runner.rb
+- lib/dispatch-rider/scheduled_job.rb
+- lib/dispatch-rider/scheduled_job/migration.rb
 - lib/dispatch-rider/subscriber.rb
 - lib/dispatch-rider/version.rb
 - lib/generators/dispatch_rider/install/USAGE
@@ -216,6 +246,7 @@ files:
 - spec/lib/dispatch-rider/registrars/sns_channel_spec.rb
 - spec/lib/dispatch-rider/registrars_spec.rb
 - spec/lib/dispatch-rider/runner_spec.rb
+- spec/lib/dispatch-rider/scheduled_job_spec.rb
 - spec/lib/dispatch-rider/subscriber_spec.rb
 - spec/lib/dispatch-rider_spec.rb
 - spec/spec_helper.rb
@@ -295,6 +326,7 @@ test_files:
 - spec/lib/dispatch-rider/registrars/sns_channel_spec.rb
 - spec/lib/dispatch-rider/registrars_spec.rb
 - spec/lib/dispatch-rider/runner_spec.rb
+- spec/lib/dispatch-rider/scheduled_job_spec.rb
 - spec/lib/dispatch-rider/subscriber_spec.rb
 - spec/lib/dispatch-rider_spec.rb
 - spec/spec_helper.rb