activejob-dispatch_rider 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad8cd41d0e457743dd03943aba4efc40af19e52c
+  data.tar.gz: 5e59ba98d4aa917747e82772361b46ab3b3e3fd0
+SHA512:
+  metadata.gz: 47b37f3ba16b43eb15f8fbbbf22303befdc0064e940d78ea5893c45ed8685c4adfce13caaf5e155b702d4f1cb276fa99aaefb99af58476dbb989cde3677a9599
+  data.tar.gz: 10c278700fc385c817c430e0f9a5ad6bb87b689674b4d7bdac4179288a20839759e085f0eb8fd8daee401c2f3664c423dbcbc48b042895510ed110764291dce4

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/README.md

@@ -0,0 +1,141 @@
+# ActiveJob::DispatchRider
+
+[![Gem Version](https://badge.fury.io/rb/activejob-dispatch_rider.svg)](http://badge.fury.io/rb/activejob-dispatch_rider)
+[![Code Climate](https://codeclimate.com/github/payrollhero/activejob-dispatch_rider/badges/gpa.svg)](https://codeclimate.com/github/payrollhero/activejob-dispatch_rider)
+[![Test Coverage](https://codeclimate.com/github/payrollhero/activejob-dispatch_rider/badges/coverage.svg)](https://codeclimate.com/github/payrollhero/activejob-dispatch_rider)
+
+[![Circle CI](https://circleci.com/gh/payrollhero/activejob-dispatch_rider.png?style=badge)](https://circleci.com/gh/payrollhero/activejob-dispatch_rider)
+
+
+'ActiveJob::DispatchRider' adds `DispatchRider` support for `ActiveJob`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "activejob-dispatch_rider"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activejob-dispatch_rider
+
+## Usage
+
+Configure `ActiveJob` and `DispatchRider`.
+
+### Stand-alone
+
+```ruby
+# publisher app
+
+# Set the ActiveJob's queue adapter
+ActiveJob::Base.queue_adapter = :dispatch_rider
+
+# Configure DispatchRider::Publisher as you would normally do
+DispatchRider::Publisher.configure notification_services: { file_system: {} },
+                                   destinations: {
+                                     low_priority: {
+                                       service: :file_system,
+                                       channel: :low_priority,
+                                       options: { path: "tmp/queue/low" }
+                                     },
+                                     high_priority: {
+                                       service: :file_system,
+                                       channel: :high_priority,
+                                       options: { path: "tmp/queue/high" }
+                                     }
+                                   }
+```
+
+```ruby
+# subscriber app for low priority channel
+DispatchRider.configure do |config|
+  config.queue_kind = "file_system"
+  config.queue_info = { path: "tmp/queue/low" }
+end
+```
+
+```ruby
+# subscriber app for high priority channel
+DispatchRider.configure do |config|
+  config.queue_kind = "file_system"
+  config.queue_info = { path: "tmp/queue/high" }
+end
+```
+
+### Rails
+
+
+```ruby
+# config/application.rb
+module YourApp
+  class Application < Rails::Application
+    # ...
+    config.active_job.queue_adapter = :dispatch_rider
+    # ...
+  end
+end
+```
+
+```ruby
+# Configure DispatchRider::Publisher as you would normally do
+
+# config/initializers/dispatch_rider.rb
+DispatchRider::Publisher.configure notification_services: { file_system: {} },
+                                   destinations: {
+                                     low_priority: {
+                                       service: :file_system,
+                                       channel: :low_priority,
+                                       options: { path: "tmp/queue/low" }
+                                     },
+                                     high_priority: {
+                                       service: :file_system,
+                                       channel: :high_priority,
+                                       options: { path: "tmp/queue/high" }
+                                     }
+                                   }
+
+# subscriber app for low priority channel
+DispatchRider.configure do |config|
+  config.queue_kind = "file_system"
+  config.queue_info = { path: "tmp/queue/low" }
+end
+```
+
+Once the preliminary setup is done create active jobs like you normally would.
+Match the destination channel name of `DispatchRider` with the queue name of
+`ActiveJob`.
+
+```ruby
+# call_and_welcome_customer.rb
+class CallAndWelcomeCustomer < ActiveJob::Base
+  queue_as :high_priority
+
+  def perform(customer, welcome_message:)
+    call_phone customer.phone_number
+    say welcome_message
+    # ...
+  end
+  # ...
+end
+```
+
+To perform the job later enqueue it by calling `.perform_later`.
+```ruby
+CallAndWelcomeCustomer.perform_later Customer.find_by_name!("Smith"),
+                                     welcome_message: "Welcome Mr. Smith!"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/payrollhero/activejob-dispatch_rider/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/activejob-dispatch_rider.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activejob/dispatch_rider/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activejob-dispatch_rider"
+  spec.version       = ActiveJob::DispatchRider::VERSION
+  spec.authors       = ["Ronald Maravilla", "Fred Baa"]
+  spec.email         = ["more.ron.too@gmail.com", "frederickbaa@gmail.com"]
+  spec.summary       = %q{'ActiveJob::DispatchRider' adds `DispatchRider` support for `ActiveJob`.}
+  spec.description   = %q{'ActiveJob::DispatchRider' adds `DispatchRider` support for `ActiveJob`.}
+  spec.homepage      = "https://github.com/payrollhero/activejob-dispatch_rider"
+  spec.license       = "BSD-3-Clause"
+
+  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_dependency "activejob"
+  spec.add_dependency "dispatch-rider"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.2.2

data/lib/activejob/dispatch_rider.rb

@@ -0,0 +1,12 @@
+require "activejob/dispatch_rider/version"
+require "active_job"
+require "dispatch-rider"
+require "dispatch_rider_active_job_handler"
+
+module ActiveJob
+  module DispatchRider
+    # Your code goes here...
+  end
+end
+
+require "activejob/queue_adapters/dispatch_rider_adapter"

data/lib/activejob/dispatch_rider/version.rb

@@ -0,0 +1,5 @@
+module ActiveJob
+  module DispatchRider
+    VERSION = "1.0.0"
+  end
+end

data/lib/activejob/queue_adapters/dispatch_rider_adapter.rb

@@ -0,0 +1,30 @@
+module ActiveJob
+  module QueueAdapters
+    # Adds support for DispatchRider to ActiveJob.
+    class DispatchRiderAdapter
+      class << self
+        # @param [ActiveJob::Base] job
+        def enqueue(job)
+          publisher.publish destinations: Array(job.queue_name),
+                            message: {
+                              subject: "dispatch_rider_active_job_handler",
+                              body: job.serialize
+                            }
+        end
+
+        def enqueue_at(*)
+          raise NotImplementedError,
+                "This queueing backend does not support scheduling jobs. To "\
+                "see what features are supported go to "\
+                "http://api.rubyonrails.org/classes/ActiveJob/QueueAdapters.html"
+        end
+
+        private
+
+        def publisher
+          @publisher ||= ::DispatchRider::Publisher.new
+        end
+      end
+    end
+  end
+end

data/lib/dispatch_rider_active_job_handler.rb

@@ -0,0 +1,6 @@
+# Generic DispatchRider handler for ActiveJob.
+class DispatchRiderActiveJobHandler < DispatchRider::Handlers::Base
+  def process(job_data)
+    ::ActiveJob::Base.execute job_data
+  end
+end

data/spec/activejob/queue_adapters/dispatch_rider_adapter_spec.rb

@@ -0,0 +1,73 @@
+require "spec_helper"
+
+describe ActiveJob::QueueAdapters::DispatchRiderAdapter do
+  let(:foo_job_class) {
+    job_class = Class.new(ActiveJob::Base) do
+      queue_as :foo
+
+      def perform(*)
+      end
+    end
+
+    stub_const "FooAjJob", job_class
+
+    FooAjJob
+  }
+
+  let(:bar_job_class) {
+    job_class = Class.new(ActiveJob::Base) do
+      queue_as :bar
+
+      def perform(*)
+      end
+    end
+
+    stub_const "BarAjJob", job_class
+
+    BarAjJob
+  }
+
+  describe "class methods" do
+    subject(:adapter) { described_class }
+
+    let(:foo_queue_path_pattern) { "tmp/queue/foo_channel/*.*" }
+    let(:bar_queue_path_pattern) { "tmp/queue/bar_channel/*.*" }
+    let(:foo_queued_item) { JSON.parse(File.read Dir[foo_queue_path_pattern].first) }
+    let(:bar_queued_item) { JSON.parse(File.read Dir[bar_queue_path_pattern].first) }
+
+    describe ".enqueue" do
+      around do |test|
+        FileUtils.rmtree "tmp/queue/"
+        test.run
+        FileUtils.rmtree "tmp/queue/"
+      end
+
+      it("is called when performing later") {
+        expect(adapter).to receive(:enqueue).with instance_of(foo_job_class)
+        foo_job_class.perform_later foo: "bar"
+      }
+
+      example("queued item") {
+        foo_job_class.perform_later foo: "bar"
+
+        expect(foo_queued_item["subject"]).to eq("dispatch_rider_active_job_handler")
+        expect(foo_queued_item["body"]["job_class"]).to eq("FooAjJob")
+        expect(foo_queued_item["body"]["queue_name"]).to eq("foo")
+        expect(foo_queued_item["body"]["arguments"].first).to include("foo" => "bar")
+      }
+
+      describe "switching channel depending on the queue name" do
+        example { expect { foo_job_class.perform_later foo: "bar" }.to change { Dir[foo_queue_path_pattern].count }.by(1) }
+        example { expect { bar_job_class.perform_later foo: "bar" }.to change { Dir[bar_queue_path_pattern].count }.by(1) }
+        example { expect { foo_job_class.perform_later foo: "bar" }.to_not change { Dir[bar_queue_path_pattern].count } }
+      end
+    end
+
+    describe ".enqueue_at" do
+      let(:job) { double :job }
+      let(:timestamp) { Time.now }
+
+      example { expect { adapter.enqueue_at job, timestamp }.to raise_error NotImplementedError }
+    end
+  end
+end

data/spec/dispatch_rider_active_job_handler_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+describe DispatchRiderActiveJobHandler do
+
+  let!(:job_class) {
+    job_class = Class.new(ActiveJob::Base) do
+      queue_as :foo
+
+      def perform(foo:)
+        "foo is #{foo}"
+      end
+    end
+
+    stub_const "AjJob", job_class
+
+    AjJob
+  }
+
+  let(:job_data) {
+    {
+      "job_class" => "AjJob",
+      "job_id" => "8b71ac6b-2854-4287-8d1b-15085b70280b",
+      "queue_name" => "foo",
+      "arguments" => [
+        {
+          "foo" => "bar",
+          "_aj_symbol_keys" => ["foo"]
+        }
+      ],
+      "guid" => "d9188320-580d-481f-a579-c3c521beccb8",
+    }
+  }
+
+  subject(:job_handler) { described_class.new }
+
+  it("performs the job") { expect(job_handler.process job_data).to eq "foo is bar" }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,112 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "activejob/dispatch_rider"
+
+ActiveJob::Base.queue_adapter = :dispatch_rider
+
+DispatchRider::Publisher.configure notification_services: { file_system: {} },
+destinations: {
+  foo: {
+    service: :file_system,
+    channel: :foo_channel,
+    options: { path: "tmp/queue/foo_channel" }
+  },
+  bar: {
+    service: :file_system,
+    channel: :bar_channel,
+    options: { path: "tmp/queue/bar_channel" }
+  }
+}
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: activejob-dispatch_rider
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ronald Maravilla
+- Fred Baa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  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: dispatch-rider
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: codeclimate-test-reporter
+  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: "'ActiveJob::DispatchRider' adds `DispatchRider` support for `ActiveJob`."
+email:
+- more.ron.too@gmail.com
+- frederickbaa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- activejob-dispatch_rider.gemspec
+- circle.yml
+- lib/activejob/dispatch_rider.rb
+- lib/activejob/dispatch_rider/version.rb
+- lib/activejob/queue_adapters/dispatch_rider_adapter.rb
+- lib/dispatch_rider_active_job_handler.rb
+- spec/activejob/queue_adapters/dispatch_rider_adapter_spec.rb
+- spec/dispatch_rider_active_job_handler_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/payrollhero/activejob-dispatch_rider
+licenses:
+- BSD-3-Clause
+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.2.2
+signing_key: 
+specification_version: 4
+summary: "'ActiveJob::DispatchRider' adds `DispatchRider` support for `ActiveJob`."
+test_files:
+- spec/activejob/queue_adapters/dispatch_rider_adapter_spec.rb
+- spec/dispatch_rider_active_job_handler_spec.rb
+- spec/spec_helper.rb
+has_rdoc: