active_job_channel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad57a5886e8787709e6718d796716f8db4fe46277a5a39640733bd71fd501aa4
+  data.tar.gz: 889415f0b22a6643c56d66a5670567c6389a0d51cc4b9fb5397dc4788b924d02
+SHA512:
+  metadata.gz: a3591e02038d4f092854d33c62d11d565d11bae3ae7b2eea2f180ba643166ded21b63c364475f509a41006f7db7e10f1edcb7ac211d450b08118b9fa93271db5
+  data.tar.gz: f43ee93d22a5b3629f821ea0ea1ceb34af3fcfe0c522a274721285ed8ea44ee22abb4f709fd9c4df7e20f3106b37156790bad233759162e45af01fe18d1478fa

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Shane Cavanaugh
+
+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,64 @@
+# `ActiveJobChannel`
+Uses `ActionCable` to alert front-end users of finished `ActiveJobs`
+
+## Installation
+1. Install in your Gemfile
+
+    ```ruby
+    gem 'active_job_channel'
+    ```
+
+2. Setup an [`ActionCable` subscription adapter](http://edgeguides.rubyonrails.org/action_cable_overview.html#subscription-adapter)
+    * Note: A persisted subscription adapter is required for handling notifications
+    from background `ActiveJob` processes. Currently only PostgreSQL and Redis
+    are supported.
+
+3. Include `active_job_channel.js` in your layouts
+
+    ```ruby
+    javascript_include_tag 'active_job_channel'
+    ```
+
+    or include it in your `app/assets/javascripts/application.js`
+
+    ```javascript
+      //= require active_job_channel
+    ```
+
+## Usage
+For each job you'd like to be notified about, enable `active_job_channel`
+
+```ruby
+class MyJob < ActiveJob::Base
+  active_job_channel
+end
+```
+
+To customize the client-side notification, define `ActiveJobChannel.received`
+after including `active_job_channel.js`. The current default simply logs the 
+job status to the javascript console.
+
+```javascript
+  //= require notifyjs
+  //= require active_job_channel
+
+  ActiveJobChannel.received = function(data) {
+    var status = data.status;
+    var job_name = data.job_name;
+    if (status === 'success') { $.notify(job_name + ' succeeded!') }
+    else if (status === 'failure') { $.notify(job_name + ' failed!') }
+  }
+```
+
+## Caveats
+`ActiveJobChannel` depends on `ActiveJob` and `ActionCable`, and, as such, is
+subject to their limitations:
+
+* A persisted [subscription adapter](http://guides.rubyonrails.org/action_cable_overview.html#subscription-adapter)
+is required for `ActionCable` to handle notifications from background 
+`ActiveJob` processes
+* Because `ActiveJob` does not know when a job has permanently failed, 
+`ActiveJobChannel` sends notfications for each failure, retried or final
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/assets/javascripts/active_job_channel.js

@@ -0,0 +1,27 @@
+//= require action_cable
+
+(function() {
+  // Setup ActionCable connection
+  this.App || (this.App = {});
+  App.active_job_channel_cable = ActionCable.createConsumer('/cable/active_job_channel');
+
+  // Setup up ActiveJobChannel received method
+  this.ActiveJobChannel || (this.ActiveJobChannel = {});
+  ActiveJobChannel.received = ActiveJobChannel.received || function(data) {
+    var status = data.status;
+    var job_name = data.job_name;
+    if (status === 'success') { console.log(job_name + ' succeeded!'); }
+    else if (status === 'failure') { console.log(job_name + ' failed!'); }
+    else { console.error('Job status could not be determined'); }
+  }
+
+}).call(this);
+
+// Setup ActionCable subscriber
+document.addEventListener("DOMContentLoaded", function (_event) {
+  const CHANNEL = "::ActiveJobChannel::Channel";
+  App.active_job_channel = App.active_job_channel_cable.subscriptions.create(
+    { channel: CHANNEL },
+    { received: function (data) { ActiveJobChannel.received(data); } }
+  );
+});

data/app/channels/active_job_channel/channel.rb

@@ -0,0 +1,7 @@
+module ActiveJobChannel
+  class Channel < ::ActionCable::Channel::Base
+    def subscribed
+      stream_for 'active_job_channel'
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  mount ActionCable.server => '/cable/active_job_channel'
+end

data/lib/active_job_channel.rb

@@ -0,0 +1,10 @@
+require 'active_job_channel/engine'
+require 'active_job_channel/broadcaster'
+require 'action_cable/engine'
+require 'active_job/railtie'
+
+# Top-level namespace
+module ActiveJobChannel
+end
+
+ActiveJob::Base.send :extend, ActiveJobChannel::Broadcaster::ClassMethods

data/lib/active_job_channel/broadcaster.rb

@@ -0,0 +1,33 @@
+module ActiveJobChannel
+  module Broadcaster
+    module ClassMethods
+      def active_job_channel
+        after_perform :broadcast_success
+        rescue_from '::StandardError' do |exception|
+          broadcast_failure
+          raise exception
+        end
+
+        include ActiveJobChannel::Broadcaster::InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+      def broadcast_failure
+        ActiveJobChannel::Channel.broadcast_to(
+          'active_job_channel',
+          status: 'failure',
+          job_name: self.class.to_s
+        )
+      end
+
+      def broadcast_success
+        ActiveJobChannel::Channel.broadcast_to(
+          'active_job_channel',
+          status: 'success',
+          job_name: self.class.to_s
+        )
+      end
+    end
+  end
+end

data/lib/active_job_channel/engine.rb

@@ -0,0 +1,5 @@
+module ActiveJobChannel
+  class Engine < ::Rails::Engine
+    isolate_namespace ActiveJobChannel
+  end
+end

data/lib/active_job_channel/version.rb

@@ -0,0 +1,3 @@
+module ActiveJobChannel
+  VERSION = '0.0.1'.freeze
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be
+# available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .
+//= require 'active_job_channel/application'

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+// //= require action_cable
+// //= require_self
+// //= require_tree ./channels
+//
+// (function() {
+//   this.App || (this.App = {});
+//
+//   App.cable = ActionCable.createConsumer();
+//
+// }).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  # protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/front_controller.rb

@@ -0,0 +1,6 @@
+class FrontController < ::ApplicationController
+  def index
+    ::ApplicationJob.new.enqueue(wait: 5.seconds)
+    render 'front/index'
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,11 @@
+class ApplicationJob < ActiveJob::Base
+  active_job_channel
+
+  def perform
+    fake
+  end
+
+  private
+
+  def fake; end
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end