delayed_action 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5176c203ab1ccd4a7ac188b2845c5ea29417e69d
+  data.tar.gz: a0702cc4d56330bc796c46f47897ebf01a60a117
+SHA512:
+  metadata.gz: f67543c008bf1942c6510a451d8f57904dc88588bfdbcefd2de49cb194994e2b72153b79f10d3c8e091e362fae54d18be206e97d252c172d21606474ac129902
+  data.tar.gz: d0729a08e3b538ac40b4cecefab77390a3b10df82d84a3b9a8bb9cce096a793e515ae243630ef6ec1fbedd12e5733d4a113ac4d4be2030df3ec77e95787d8a81

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Douglas Tarr
+
+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.rdoc

@@ -0,0 +1,3 @@
+= DelayedAction
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DelayedAction'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

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

@@ -0,0 +1,13 @@
+// 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_tree .

data/app/assets/javascripts/delayed_action/delayed_action_results.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/delayed_action/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/assets/stylesheets/delayed_action/delayed_action_results.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/controllers/delayed_action/application_controller.rb

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

data/app/controllers/delayed_action/delayed_action_results_controller.rb

@@ -0,0 +1,62 @@
+require_dependency "delayed_action/application_controller"
+
+module DelayedAction
+  class DelayedActionResultsController < ApplicationController
+    before_action :set_delayed_action_result, only: [:show, :edit, :update, :destroy]
+
+    # GET /delayed_action_results
+    def index
+      @delayed_action_results = DelayedActionResult.all
+    end
+
+    # GET /delayed_action_results/1
+    def show
+    end
+
+    # GET /delayed_action_results/new
+    def new
+      @delayed_action_result = DelayedActionResult.new
+    end
+
+    # GET /delayed_action_results/1/edit
+    def edit
+    end
+
+    # POST /delayed_action_results
+    def create
+      @delayed_action_result = DelayedActionResult.new(delayed_action_result_params)
+
+      if @delayed_action_result.save
+        redirect_to @delayed_action_result, notice: 'Delayed action result was successfully created.'
+      else
+        render :new
+      end
+    end
+
+    # PATCH/PUT /delayed_action_results/1
+    def update
+      if @delayed_action_result.update(delayed_action_result_params)
+        redirect_to @delayed_action_result, notice: 'Delayed action result was successfully updated.'
+      else
+        render :edit
+      end
+    end
+
+    # DELETE /delayed_action_results/1
+    def destroy
+      @delayed_action_result.destroy
+      redirect_to delayed_action_results_url, notice: 'Delayed action result was successfully destroyed.'
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_delayed_action_result
+        @delayed_action_result = DelayedActionResult.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def delayed_action_result_params
+        params.require(:delayed_action_result).permit(:result, :request_env, :uuid, :content_type)
+      end
+  end
+end

data/app/helpers/delayed_action/application_helper.rb

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

data/app/helpers/delayed_action/delayed_action_results_helper.rb

@@ -0,0 +1,4 @@
+module DelayedAction
+  module DelayedActionResultsHelper
+  end
+end

data/app/models/delayed_action/delayed_action_result.rb

@@ -0,0 +1,7 @@
+module DelayedAction
+  class DelayedActionResult < ActiveRecord::Base
+    before_create do
+      self.uuid = SecureRandom.uuid
+    end
+  end
+end

data/app/views/delayed_action/delayed_action_results/_form.html.erb

@@ -0,0 +1,33 @@
+<%= form_for(@delayed_action_result) do |f| %>
+  <% if @delayed_action_result.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@delayed_action_result.errors.count, "error") %> prohibited this delayed_action_result from being saved:</h2>
+
+      <ul>
+      <% @delayed_action_result.errors.full_messages.each do |message| %>
+        <li><%= message %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :result %><br>
+    <%= f.text_area :result %>
+  </div>
+  <div class="field">
+    <%= f.label :request_env %><br>
+    <%= f.text_area :request_env %>
+  </div>
+  <div class="field">
+    <%= f.label :uuid %><br>
+    <%= f.text_field :uuid %>
+  </div>
+  <div class="field">
+    <%= f.label :content_type %><br>
+    <%= f.text_field :content_type %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/app/views/delayed_action/delayed_action_results/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing Delayed Action Result</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Show', @delayed_action_result %> |
+<%= link_to 'Back', delayed_action_results_path %>

data/app/views/delayed_action/delayed_action_results/index.html.erb

@@ -0,0 +1,33 @@
+<p id="notice"><%= notice %></p>
+
+<h1>Listing Delayed Action Results</h1>
+
+<table>
+  <thead>
+    <tr>
+      <th>Result</th>
+      <th>Request env</th>
+      <th>Uuid</th>
+      <th>Content type</th>
+      <th colspan="3"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @delayed_action_results.each do |delayed_action_result| %>
+      <tr>
+        <td><%= delayed_action_result.result %></td>
+        <td><%= delayed_action_result.request_env %></td>
+        <td><%= delayed_action_result.uuid %></td>
+        <td><%= delayed_action_result.content_type %></td>
+        <td><%= link_to 'Show', delayed_action_result %></td>
+        <td><%= link_to 'Edit', edit_delayed_action_result_path(delayed_action_result) %></td>
+        <td><%= link_to 'Destroy', delayed_action_result, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<br>
+
+<%= link_to 'New Delayed action result', new_delayed_action_result_path %>

data/app/views/delayed_action/delayed_action_results/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New Delayed Action Result</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', delayed_action_results_path %>

data/app/views/delayed_action/delayed_action_results/show.html.erb

@@ -0,0 +1,24 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <strong>Result:</strong>
+  <%= @delayed_action_result.result %>
+</p>
+
+<p>
+  <strong>Request env:</strong>
+  <%= @delayed_action_result.request_env %>
+</p>
+
+<p>
+  <strong>Uuid:</strong>
+  <%= @delayed_action_result.uuid %>
+</p>
+
+<p>
+  <strong>Content type:</strong>
+  <%= @delayed_action_result.content_type %>
+</p>
+
+<%= link_to 'Edit', edit_delayed_action_result_path(@delayed_action_result) %> |
+<%= link_to 'Back', delayed_action_results_path %>

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

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

data/config/routes.rb

@@ -0,0 +1,3 @@
+DelayedAction::Engine.routes.draw do
+  resources :delayed_action_results
+end

data/db/migrate/20151003163407_create_delayed_action_delayed_action_results.rb

@@ -0,0 +1,14 @@
+class CreateDelayedActionDelayedActionResults < ActiveRecord::Migration
+  def change
+    create_table :delayed_action_delayed_action_results do |t|
+      t.text :result
+      t.text :request_env
+      t.string :uuid
+      t.string :content_type
+
+      t.timestamps null: false
+    end
+
+    add_index "delayed_action_delayed_action_results", ["uuid"], name: "index_delayed_action_results_on_uuid", unique: true
+  end
+end

data/lib/delayed_action.rb

@@ -0,0 +1,5 @@
+require "delayed_action/engine"
+require "delayed_action/delayed_action_active_job"
+require "delayed_action/delayed_action_concern"
+module DelayedAction
+end

data/lib/delayed_action/delayed_action_active_job.rb

@@ -0,0 +1,28 @@
+class DelayedActionActiveJob < ActiveJob::Base
+
+  queue_as :default
+
+  def perform(result)
+
+    begin
+      # TODO: remove this hack
+      Rack::Timeout.timeout = 0
+    rescue
+
+    end
+
+    env = JSON.parse(result.request_env)
+    session = ActionDispatch::Integration::Session.new(Rails.application)
+    if env["QUERY_STRING"]
+      env["QUERY_STRING"] = "force=true&#{env["QUERY_STRING"]}"
+      path = "#{env["PATH_INFO"]}?force=true&#{env["QUERY_STRING"]}"
+    else
+      path = "#{env["PATH_INFO"]}?force=true"
+    end
+    puts path
+    session.get path, nil, env
+    result.update(result: session.response.body, content_type: session.response.content_type)
+
+  end
+
+end

data/lib/delayed_action/delayed_action_concern.rb

@@ -0,0 +1,66 @@
+module DelayedAction
+  extend ActiveSupport::Concern
+
+  included do
+    # raise an error if we are using the inline active job
+    if Rails.env.development?
+      if Rails.application.config.active_job.queue_adapter == :inline
+         raise  "ERROR: DelayedAction will cause deadlocks with the :inline active_job queue adapter.  Please switch to another adapter, such as delayed_job or resque"
+      end
+    end
+
+    private
+
+    def delayed_action_queue
+      params_to_copy = ["SCRIPT_NAME", "PATH_INFO", "QUERY_STRING", "REQUEST_METHOD", "HTTP_COOKIE", "REQUEST_URI", "SERVER_NAME", "SERVER_PORT", "REMOTE_ADDR", "SERVER_PROTOCOL", "HTTP_HOST", "HTTP_USER_AGENT" , "HTTP_VERSION", "HTTP_X_FORWARDED_PROTO"]
+      request_env = {}
+      params_to_copy.each do |p|
+        request_env[p] = request.env[p]
+      end
+
+      result = DelayedAction::DelayedActionResult.create request_env: request_env.to_json
+      job = DelayedActionActiveJob.perform_later result
+      if request.fullpath.include?("?")
+        path = "#{request.fullpath}&delayed_uuid=#{result.uuid}"
+      else
+        path = "#{request.fullpath}?delayed_uuid=#{result.uuid}"
+      end
+
+      redirect_to path
+
+
+    end
+
+    def delayed_action_view
+      # unwrap the job, get the results and view it here
+      result = DelayedAction::DelayedActionResult.find_by_uuid(params[:delayed_uuid])
+      if result.result.blank?
+        render html: "<html><head><title>Loading</title><meta http-equiv='refresh' content='5'></head><body>Loading, this page will refresh in 5 seconds.  Or, <a href='#{request.fullpath}'>refresh this page</a> for results...</body></html>".html_safe
+      else
+        render body: "#{result.result}", content_type: result.content_type
+      end
+    end
+
+    def delayed_action_dispatch
+      return if params[:force]
+
+      if params[:delayed_uuid]
+        delayed_action_view
+      else
+        delayed_action_queue
+      end
+    end
+
+  end
+
+  module ClassMethods
+    def delayed_action(options = {})
+      actions = options
+
+      before_action :delayed_action_dispatch, only: actions
+
+    end
+  end
+
+end
+