active_waiter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40b620ca2093c8981a36cef260acdfbee3b40b02
+  data.tar.gz: 3d7e0355a38d34dc8849122b7abe827781d3adb5
+SHA512:
+  metadata.gz: 8c0b232a90f377c2b832e47a2ada6c893debd0963b754350c5ccf6b2a0f5df4416e1cece8b029952f16a795080c541d2fa501028aa57f08117c4d7296b4dfab1
+  data.tar.gz: 76e3708ae6fe264d1e4172dacee1826820e3161b00cdd20ace53b52663dcc7c78fcb2ad1e2a4bf86ec3bfc2bf3398e0c6bed94a3ae153d61cd4f9c0f0702e5d1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 choonkeat
+
+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,93 @@
+# ActiveWaiter
+
+A simple mechanism allowing your users to wait for the completion of your `ActiveJob`
+
+## Scenario
+
+You have an export PDF feature that you've implemented directly in the controller action.
+
+As data grows, your HTTP request takes longer and starts timing out. So you decide to move the PDF generating code into a background job.
+
+``` ruby
+def index
+  respond_to do |format|
+    format.html
+    format.pdf {
+      ExportPdfJob.perform_later(@things, current_user)
+      redirect_to :back, notice: "We'll email your PDF when it's done!"
+    }
+  end
+end
+```
+
+
+But how do you get that PDF into the hands of your users now? Email? Push notification? Manual reload?
+
+> You have no PDF ready for download (yet). Please reload.
+
+
+## Solution
+
+Let `ActiveWaiter` enqueue that job instead and redirect to it's progress tracking page.
+
+``` ruby
+def index
+  respond_to do |format|
+    format.html
+    format.pdf {
+      # yay ActiveWaiter.enqueue
+      redirect_to active_waiter_path(ActiveWaiter.enqueue(ExportPdfJob, @things, current_user))
+    }
+  end
+end
+```
+
+``` ruby
+# routes.rb
+mount ActiveWaiter::Engine => "/active_waiter(/:id)"
+```
+
+![active_waiter mov](https://cloud.githubusercontent.com/assets/473/7785141/c4667734-01b4-11e5-8974-3a3b00b3a4b6.gif)
+
+And we need to add a bit of code into your `ActiveJob` class
+
+- 1) add `include ActiveWaiter::Job`
+- 2) return a `url` from your `perform` method to link to the result page (or file)
+
+``` ruby
+class ExportPdfJob < ActiveJob::Base
+  queue_as :default
+
+  # (1)
+  include ActiveWaiter::Job
+
+  def perform(things, current_user)
+    count = things.count.to_f
+    files = []
+    things.each_with_index do |thing, index|
+      files << generate_pdf(thing)
+
+      # (a)
+      update_active_waiter percentage: (100 * (index+1) / count)
+    end
+
+    # (2)
+    upload(combine(files)).s3_url
+  rescue Exception => e
+
+    # (b)
+    update_active_waiter error: e.to_s
+  end
+
+  # (c)
+  def self.download?
+    true
+  end
+end
+```
+
+Optionally, you can also
+
+- a) report progress while your job runs, using `update_active_waiter(percentage:)`
+- b) report if there were any errors, using `update_active_waiter(error:)`
+- c) indicate if you want the user to "download" the url manually or be redirected there automatically (default: redirect)

data/Rakefile

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

data/app/assets/javascripts/active_waiter/application.js

@@ -0,0 +1,16 @@
+// 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.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/app/assets/stylesheets/active_waiter/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 styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/active_waiter/application_controller.rb

@@ -0,0 +1,4 @@
+module ActiveWaiter
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/active_waiter/jobs_controller.rb

@@ -0,0 +1,36 @@
+require_dependency "active_waiter/application_controller"
+
+module ActiveWaiter
+  class JobsController < ApplicationController
+    def show
+      data = ActiveWaiter.read(params[:id])
+      return on_not_found(data) unless data.respond_to?(:[])
+      return on_error(data)     if data[:error]
+      return on_redirect(data)  if data[:redirect_to]
+      return on_link_to(data)   if data[:link_to]
+      return on_progress(data)  if data[:percentage]
+    end
+
+    protected
+
+      def on_not_found(data)
+        raise ActionController::RoutingError.new('Not Found')
+      end
+
+      def on_error(data)
+        render template: "active_waiter/jobs/error", status: :internal_server_error, locals: data
+      end
+
+      def on_redirect(data)
+        redirect_to data[:redirect_to]
+      end
+
+      def on_link_to(data)
+        render template: "active_waiter/jobs/link_to",  locals: data
+      end
+
+      def on_progress(data)
+        render template: "active_waiter/jobs/progress", locals: data
+      end
+  end
+end

data/app/helpers/active_waiter/application_helper.rb

@@ -0,0 +1,4 @@
+module ActiveWaiter
+  module ApplicationHelper
+  end
+end

data/app/views/active_waiter/jobs/_reload.html.erb

@@ -0,0 +1,3 @@
+<script>
+  setTimeout(function() { Turbolinks.visit(window.location); }, 2000);
+</script>

data/app/views/active_waiter/jobs/error.html.erb

@@ -0,0 +1,6 @@
+<div class="progress">
+  <div class="progress-bar progress-bar-danger" role="progressbar" aria-valuenow="80" aria-valuemin="0" aria-valuemax="100" style="width: 80%; min-width: 3em;">
+    <span class="glyphicon glyphicon-exclamation-sign"></span>
+    <span><%= error %></span>
+  </div>
+</div>

data/app/views/active_waiter/jobs/link_to.html.erb

@@ -0,0 +1,12 @@
+<div class="progress">
+  <div class="progress-bar progress-bar-success active" role="progressbar" aria-valuenow="100" aria-valuemin="0" aria-valuemax="100" style="width: 100%; min-width: 3em;">
+    <span>100% Complete</span>
+  </div>
+</div>
+<p class="text-right">
+  <a href="<%= link_to %>" class="btn btn-primary">
+    Click to
+    Download
+    <span class="glyphicon glyphicon-download"></span>
+  </a>
+<p>

data/app/views/active_waiter/jobs/progress.html.erb

@@ -0,0 +1,6 @@
+<div class="progress">
+  <div class="progress-bar progress-bar-success progress-bar-striped active" role="progressbar" aria-valuenow="<%= percentage %>" aria-valuemin="0" aria-valuemax="100" style="width: <%= percentage %>%; min-width: 3em;">
+    <span><%= number_to_percentage(percentage, precision: 1, strip_insignificant_zeros: true) %> Complete</span>
+  </div>
+</div>
+<%= render partial: 'reload' %>

data/app/views/active_waiter/jobs/show.html.erb

@@ -0,0 +1,6 @@
+<div class="progress">
+  <div class="progress-bar progress-bar-striped active" role="progressbar" aria-valuenow="50" aria-valuemin="0" aria-valuemax="100" style="width: 50%; min-width: 3em;">
+    <span>Please wait&hellip;</span>
+  </div>
+</div>
+<%= render partial: 'reload' %>

data/app/views/layouts/active_waiter/application.html.erb

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ActiveWaiter</title>
+  <%= stylesheet_link_tag    "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css", media: "all" %>
+  <%= stylesheet_link_tag    "active_waiter/application", media: "all" %>
+  <%= javascript_include_tag "active_waiter/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <div class="content">
+    <div class="container">
+      <div class="row">
+        <div class="col-sm-6 col-sm-offset-3">
+          <div class="header">
+            <h2/>
+          </div>
+          <%= yield %>
+        </div>
+      </div>
+    </div>
+  </div>
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+ActiveWaiter::Engine.routes.draw do
+  get '/:id' => 'jobs#show'
+  root to: 'jobs#show'
+end

data/lib/active_waiter.rb

@@ -0,0 +1,25 @@
+require "active_waiter/engine"
+require "active_waiter/job"
+
+module ActiveWaiter
+  class << self
+    def next_uuid
+      SecureRandom.uuid
+    end
+
+    def enqueue(klass, *arguments)
+      next_uuid.tap do |uid|
+        ActiveWaiter.write(uid, {})
+        klass.perform_later({ uid: uid }, *arguments)
+      end
+    end
+
+    def write(uid, value)
+      Rails.cache.write("active_waiter:#{uid}", value)
+    end
+
+    def read(uid)
+      Rails.cache.read("active_waiter:#{uid}")
+    end
+  end
+end

data/lib/active_waiter/engine.rb

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

data/lib/active_waiter/job.rb

@@ -0,0 +1,28 @@
+module ActiveWaiter::Job
+  extend ActiveSupport::Concern
+
+  included do
+    around_perform do |job, block|
+      @active_waiter_options = job.arguments.shift
+      begin
+        key = (self.class.try(:download?) ? :link_to : :redirect_to)
+        ::ActiveWaiter.write(@active_waiter_options[:uid], {
+          percentage: 100,
+          key => block.call,
+        })
+      rescue Exception
+        ::ActiveWaiter.write(@active_waiter_options[:uid], {
+          error: $!.to_s,
+        })
+        raise
+      end
+    end
+  end
+
+  def update_active_waiter(percentage: nil, error: nil)
+    ::ActiveWaiter.write(@active_waiter_options[:uid], {
+      percentage: percentage && [percentage, 99].min,
+      error: error,
+    })
+  end
+end

data/lib/active_waiter/version.rb

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

data/lib/tasks/waiter_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :active_waiter do
+#   # Task goes here
+# end

data/test/active_waiter/job_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class DummyJob < ActiveJob::Base
+  include ActiveWaiter::Job
+
+  def perform(one, two, three: 3, four: [1,2,3,4])
+    [one, two, three, four].to_json
+  end
+end
+
+class ActiveWaiter::JobTest < Minitest::Test
+  include ActiveJob::TestHelper
+
+  def teardown
+    clear_enqueued_jobs
+  end
+
+  def test_normal
+    assert_equal expected_return_value, DummyJob.new.perform(*arguments)
+  end
+
+  def test_active_waiter_enqueue
+    ActiveWaiter.stub :next_uuid, uid = "hello" do
+      perform_enqueued_jobs do
+        assert_equal uid, ActiveWaiter.enqueue(DummyJob, *arguments)
+        assert_equal Hash(percentage: 100, redirect_to: expected_return_value), ActiveWaiter.read(uid)
+      end
+    end
+  end
+
+  private
+
+    def arguments
+      ['a', 'b', four: ['a', 'b', 'c']]
+    end
+
+    def expected_return_value
+      ['a', 'b', 3, ['a', 'b', 'c']].to_json
+    end
+end

data/test/controllers/active_waiter/jobs_controller_test.rb

@@ -0,0 +1,87 @@
+require 'test_helper'
+require 'minitest/mock'
+
+class RedirectJob < ActiveJob::Base
+  include ActiveWaiter::Job
+
+  def perform
+    "http://other.com/12345"
+  end
+end
+
+class DownloadJob < RedirectJob
+  def self.download?
+    true
+  end
+end
+
+class ActiveWaiter::JobsControllerTest < ActionDispatch::IntegrationTest
+  include ActiveJob::TestHelper
+
+  def setup
+    @routes = ActiveWaiter::Engine.routes
+  end
+
+  def teardown
+    clear_enqueued_jobs
+  end
+
+  def test_show_non_existent
+    assert_raises ActionController::RoutingError do
+      get '/active_waiter', id: "nosuchjob"
+    end
+  end
+
+  def test_show_started
+    ActiveWaiter.stub :next_uuid, uid do
+      assert_equal uid, ActiveWaiter.enqueue(DownloadJob)
+      get '/active_waiter', id: uid
+      assert_equal 200, status
+      assert_match "Please wait", document_root_element.to_s
+    end
+  end
+
+  def test_show_error
+    ActiveWaiter.write(uid, error: "oops")
+    get '/active_waiter', id: uid
+    assert_equal 500, status
+    assert_match "oops", document_root_element.to_s
+  end
+
+  def test_show_progress
+    ActiveWaiter.write(uid, percentage: 42)
+    get '/active_waiter', id: uid
+    assert_equal 200, status
+    assert_match "42%", document_root_element.to_s
+  end
+
+  def test_show_completed
+    ActiveWaiter.stub :next_uuid, uid do
+      perform_enqueued_jobs do
+        assert_equal uid, ActiveWaiter.enqueue(DownloadJob)
+        get '/active_waiter', id: uid
+        assert_equal 200, status
+        link = document_root_element.css("a[href='http://other.com/12345']").first
+        assert link, "missing hyperlink to returned value"
+        assert_match "Click", link.text
+      end
+    end
+  end
+
+  def test_show_completed_redirect
+    ActiveWaiter.stub :next_uuid, uid do
+      perform_enqueued_jobs do
+        assert_equal uid, ActiveWaiter.enqueue(RedirectJob)
+        get '/active_waiter', id: uid
+        assert_equal 302, status
+        assert_equal "http://other.com/12345", response.location
+      end
+    end
+  end
+
+  private
+
+    def uid
+      "hello"
+    end
+end