async_response 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e9ee6073be567656ec7aedd34628c898f0a4271
+  data.tar.gz: 62d9a52443f0c23e3530812b7272bee504312d7d
+SHA512:
+  metadata.gz: 2d2c552386489bb71f79704d3c9b08d5332abb11c348e33a9572a0e573390af7d41e9b21c4c469f9b187d7fcd2f80c1b6719a4973e491adb2ce66aaa34fbb3f6
+  data.tar.gz: f7ad030d35a4e9796590717da3343d8af17063e4a803a59699407a236c8c7f0e22ffaa2ed516a96dd13f18282de54b0907a3c2e515be3dea498506667161328c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Daniel Alves
+
+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 @@
+= AsyncResponse
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,31 @@
+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    = 'AsyncResponse'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+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/async_response/application.js

@@ -0,0 +1,35 @@
+//= require jquery_ujs
+
+var Responses = (function($){
+
+  var bindClicks = function(module) {
+    $('.btn-show').on('click', function(){
+      var id = $(this).data('id'),
+          content = $(this).data('content');
+
+      module.showResponse(id, content);
+      return false;
+    });
+  }
+
+  function Module(baseUrl) {
+    this.baseUrl = baseUrl;
+
+    bindClicks(this);
+  }
+
+  Module.prototype.showResponse = function(id, content) {
+    $.getJSON(this.baseUrl+'/'+id+'.json', function(data){
+      var showResponseHolder = $('#showResponseHolder'),
+          display = content == 'data' ? data.data : data.error;
+
+      if (content == 'params') display = JSON.parse(data.params_json);
+
+      showResponseHolder.html(JSON.stringify(display));
+
+      $('.modal').modal({show: true});
+    });
+  };
+
+  return Module;
+})(jQuery);

data/app/assets/javascripts/async_response/async_response.js

@@ -0,0 +1,34 @@
+var AsyncResponse = (function($){
+  function Module() {}
+
+  var loadAsyncJSON = function(url, onProgress, onLoad){
+    $.getJSON(url, function(data) {
+      if (!data.status) {
+        loadAsyncJSON(url, onProgress, onLoad);
+        return;
+      }
+
+      var status = data.status;
+      if (status == 'finished') {
+        onLoad(data.data);
+        return;
+      } else {
+
+        onProgress(data.status, data.percentage_completion);
+        loadAsyncJSON(url, onProgress, onLoad);
+      }
+    });
+  }
+
+  Module.prototype.loadJSON = function(options) {
+    var url = options.url;
+    var onLoad = options.onLoad || function() {};
+    var onProgress = options.onProgress || function() {};
+
+    loadAsyncJSON(url, onProgress, onLoad);
+    return url;
+  }
+
+  return Module;
+
+})(jQuery);

data/app/assets/stylesheets/async_response/application.css

@@ -0,0 +1,14 @@
+/*
+ *= require_self
+ */
+
+
+.finished {
+  color: green;
+  font-weight: bold;
+}
+
+.errored {
+  background-color: #f0d8d8;
+  color: red;
+}

data/app/controllers/async_response/application_controller.rb

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

data/app/controllers/async_response/concerns/async_controller.rb

@@ -0,0 +1,24 @@
+module AsyncResponse
+  module Concerns
+    module AsyncController
+      extend ActiveSupport::Concern
+
+      included do
+      end
+
+      def async_response(worker_class, expires_at: 5.minutes_from_now,
+                         job_key: nil, params: nil)
+
+        response_json = AsyncResponse::Builder
+          .new(worker_class, expires_at, job_key)
+          .build(params)
+
+        render(json: response_json)
+      end
+
+      def async_response_expire!(worker_class, job_key: nil)
+        AsyncResponse::Expirer.new(worker_class, job_key).expire!
+      end
+    end
+  end
+end

data/app/controllers/async_response/responses_controller.rb

@@ -0,0 +1,28 @@
+module AsyncResponse
+  class ResponsesController < ApplicationController
+
+    def index
+      render locals: { jobs: jobs }
+    end
+
+    def show
+      render json: job
+    end
+
+    def destroy
+      job.destroy
+      redirect_to async_response.responses_path
+    end
+
+    protected
+
+    def jobs
+      @jobs ||= AsyncResponse::Job.order(id: :desc)
+        .limit(10)
+    end
+
+    def job
+      @job ||= AsyncResponse::Job.find(params[:id])
+    end
+  end
+end

data/app/helpers/async_response/application_helper.rb

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

data/app/models/async_response/job.rb

@@ -0,0 +1,57 @@
+module AsyncResponse
+  class Job < ActiveRecord::Base
+    enum status: [:started, :running, :finished, :errored]
+    serialize :data, JSON
+    validates :job_type, :expires_at, presence: true
+
+    def self.valid_job(type, key)
+      record = where(job_type: type, job_key: key).last
+      return nil unless record
+      return nil if record.expired?
+      return nil if record.errored?
+
+      record
+    end
+
+    def self.expire!(type, key)
+      record = valid_job(type, key)
+      return nil unless record
+      record.expire!
+      record
+    end
+
+    def params=(hash)
+      self.params_json = hash.to_json
+    end
+
+    def params
+      JSON.parse(params_json).deep_symbolize_keys rescue nil
+    end
+
+    def expired?
+      expires_at < Time.now
+    end
+
+    def expire!
+      self.expires_at = Time.now - 1.minute
+      save(validate: false)
+    end
+
+    def finished!
+      increment_percentage(100)
+      self.status = :finished
+      save!
+    end
+
+    def increment_percentage(increment)
+      total = (percentage_completion || 0) + increment
+      total = [[total, 100].min, 0].max
+      self.percentage_completion = total
+    end
+
+    def increment_percentage!(increment)
+      increment_percentage(increment)
+      save!
+    end
+  end
+end

data/app/views/async_response/responses/index.html.haml

@@ -0,0 +1,44 @@
+.page-header
+  %h1 Async Responses
+
+%table.table
+  %tr
+    %th ID
+    %th Status
+    %th Type
+    %th Key
+    %th Expires at
+    %th
+
+  - jobs.each do |job|
+    %tr{ class: job.status }
+      %td= job.id
+      %td= job.status.titleize
+      %td= job.job_type
+      %td= job.job_key
+      %td{ nowrap: true }
+        = job.expires_at
+
+      %td{ align: 'right', nowrap: true }
+        = link_to 'Params', '#',
+          class: 'btn btn-sm btn-default btn-show',
+          data: { id: job.id, content: 'params' }
+
+        - if job.finished?
+          = link_to 'Data', '#',
+            class: 'btn btn-sm btn-default btn-show',
+            data: { id: job.id, content: 'data' }
+        - elsif job.errored?
+          = link_to 'Error', '#',
+            class: 'btn btn-sm btn-default btn-show',
+            data: { id: job.id, content: 'error' }
+
+        = link_to '<span class="glyphicon glyphicon-trash"></span>'.html_safe,
+          async_response.response_path(job.id),
+          method: :delete,
+          class: 'btn btn-sm btn-danger',
+          data: { confirm: 'Are you sure?' }
+
+- content_for :after_javascript do
+  :javascript
+    var responses = new Responses("#{async_response.responses_path}");

data/app/views/layouts/async_response/application.html.haml

@@ -0,0 +1,28 @@
+!!!
+%html
+  %head
+    %title AsyncResponse
+    = stylesheet_link_tag "//maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css"
+    = stylesheet_link_tag "async_response/application", media: "all"
+    = csrf_meta_tags
+
+  %body
+    .container
+      .row
+        .col-sm-12
+          = yield
+
+    = javascript_include_tag "//ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"
+    = javascript_include_tag "//maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"
+    = javascript_include_tag "async_response/application"
+    = content_for :after_javascript
+
+    .modal.fade
+      .modal-dialog
+        .modal-content
+          .modal-header
+            .modal-title
+              Show Response
+          .modal-body
+            #showResponseHolder
+

data/config/routes.rb

@@ -0,0 +1,4 @@
+AsyncResponse::Engine.routes.draw do
+  root to: 'responses#index'
+  resources :responses, only: [:index, :show, :destroy]
+end

data/db/migrate/20150702102322_create_async_response_jobs.rb

@@ -0,0 +1,15 @@
+class CreateAsyncResponseJobs < ActiveRecord::Migration
+  def change
+    create_table :async_response_jobs do |t|
+      t.string :job_type
+      t.string :job_key
+      t.string :scope
+      t.integer :percentage_completion, default: 0
+      t.integer :status, default: 0
+      t.text :error
+      t.text :data
+      t.timestamp :expires_at
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20150702131057_add_params_json_to_async_response_jobs.rb

@@ -0,0 +1,5 @@
+class AddParamsJsonToAsyncResponseJobs < ActiveRecord::Migration
+  def change
+    add_column :async_response_jobs, :params_json, :text
+  end
+end

data/lib/async_response/builder.rb

@@ -0,0 +1,47 @@
+module AsyncResponse
+  class Builder
+    include AsyncResponse::Helper
+    attr_reader :worker_class, :expires_at, :job_key
+    def initialize(worker_class, expires_at, job_key)
+      @worker_class = worker_class
+      @expires_at = expires_at
+      @job_key = job_key
+    end
+
+    def build(params)
+      respond_with(async_job || create_job(params))
+    end
+
+    private
+
+    def async_job
+      @async_job ||= AsyncResponse::Job.valid_job(job_type,
+                                                  hashed_job_key)
+    end
+
+    def create_job(params)
+      @new_job ||= AsyncResponse::Job.create!(
+        job_type: job_type,
+        job_key: hashed_job_key,
+        expires_at: expires_at,
+        params: params
+      )
+
+      schedule_job(@new_job)
+      @new_job
+    end
+
+    def respond_with(job)
+      {
+        status: job.status,
+        percentage_completion: job.percentage_completion,
+        data: job.data,
+        error: job.error
+      }
+    end
+
+    def schedule_job(job)
+      worker_class.perform_async(job.id)
+    end
+  end
+end

data/lib/async_response/engine.rb

@@ -0,0 +1,12 @@
+module AsyncResponse
+  class Engine < ::Rails::Engine
+    isolate_namespace AsyncResponse
+
+    config.generators do |g|
+      g.test_framework :rspec,:fixture => false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/async_response/expirer.rb

@@ -0,0 +1,14 @@
+module AsyncResponse
+  class Expirer
+    include Helper
+    attr_reader :worker_class, :job_key
+    def initialize(worker_class, job_key)
+      @worker_class = worker_class
+      @job_key = job_key
+    end
+
+    def expire!
+      AsyncResponse::Job.expire!(job_type, hashed_job_key)
+    end
+  end
+end

data/lib/async_response/version.rb

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

data/lib/async_response/workers/sidekiq.rb

@@ -0,0 +1,43 @@
+module AsyncResponse
+  module Workers
+    module Sidekiq
+      extend ActiveSupport::Concern
+
+      def response_for(job_id, &block)
+        job = AsyncResponse::Job.find(job_id)
+        return unless job
+
+        worker_response = WorkerResponse.new(job)
+        data = block.call(worker_response)
+        worker_response.finished!(data)
+
+      rescue StandardError => e
+        job.error = e.message
+        job.errored!
+        raise e
+      end
+
+      private
+
+      class WorkerResponse
+        attr_reader :job
+        def initialize(job)
+          @job = job
+        end
+
+        def params
+          job.params
+        end
+
+        def finished!(data)
+          job.data = data
+          job.finished!
+        end
+
+        def increment_percentage!(increment)
+          job.increment_percentage!(increment)
+        end
+      end
+    end
+  end
+end

data/lib/async_response.rb

@@ -0,0 +1,20 @@
+require "haml"
+require "jquery-rails"
+
+module AsyncResponse
+  module Helper
+    def job_type
+      worker_class.name
+    end
+
+    def hashed_job_key
+      joined_job_key = job_key.join if job_key.respond_to?(:join)
+      Digest::SHA1.hexdigest(joined_job_key || job_key)
+    end
+  end
+end
+
+require "async_response/engine"
+require "async_response/builder"
+require "async_response/expirer"
+require "async_response/workers/sidekiq"

data/lib/tasks/async_response_tasks.rake

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

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# 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 File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/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/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 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/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

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

@@ -0,0 +1,34 @@
+class ProjectsController < ApplicationController
+  include AsyncResponse::Concerns::AsyncController
+
+  def index
+    respond_to do |format|
+      format.json do
+        async_response(
+          ProjectsIndexWorker,
+          expires_at: 5.minutes.from_now,
+          job_key: 'projects_index',
+          params: {
+            page: 1,
+            limit: 10
+          }
+        )
+      end
+    end
+  end
+end
+
+class ProjectsIndexWorker
+  include AsyncResponse::Workers::Sidekiq
+
+  def self.perform_async(job_id)
+    new.perform(job_id)
+  end
+
+  def perform(job_id)
+    response_for(job_id) do |response|
+      { job_a: 1 }
+    end
+  end
+end
+

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

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

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

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

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', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'