async_request 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cdb61fdcbf0c00605261d249aa526c7b62cc5937
+  data.tar.gz: aba340ec4b640116ff853c007ac7ab2c92e2b7c5
+SHA512:
+  metadata.gz: befccc1cecbbd1d08e04d1899f5e494febe13675e6b91266e2ee8bca2ddf9aff520277914d88235c7a68e75f56b62310c0cb13bfd6f69022aa09dee191d4a6d4
+  data.tar.gz: a8d8ae4c2d99e4d9ae078868390bca2320d4e9b18f89fb1d09f9285dfca070d2710271dfee303546b67c2fdafbe9b54735d761a73c9853e6ff3f9d03404628c8

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    = 'AsyncRequest'
+  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'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/async_request/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/stylesheets/async_request/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/async_request/application_controller.rb

@@ -0,0 +1,4 @@
+module AsyncRequest
+  class ApplicationController < ::ApplicationController
+  end
+end

data/app/controllers/async_request/jobs_controller.rb

@@ -0,0 +1,19 @@
+module AsyncRequest
+  class JobsController < ActionController::Base
+    def show
+      job = Job.find_by(uid: params[:id])
+      return head :not_found unless job.present?
+      job.processed? ? render_finished_job(job) : render_pending(job)
+    end
+
+    private
+
+    def render_pending(job)
+      render json: { status: job.status }, status: :accepted
+    end
+
+    def render_finished_job(job)
+      render json: JSON.parse(job.response), status: job.status_code
+    end
+  end
+end

data/app/helpers/async_request/application_helper.rb

@@ -0,0 +1,15 @@
+module AsyncRequest
+  module ApplicationHelper
+    def execute_async(worker_class, *params)
+      raise ArgumentError if worker_class.nil?
+      job = Job.create(
+        worker: worker_class,
+        params: params,
+        status: Job.statuses[:waiting],
+        uid: SecureRandom.uuid
+      )
+      JobProcessor.perform_async(job.id)
+      job.uid
+    end
+  end
+end

data/app/models/async_request/job.rb

@@ -0,0 +1,6 @@
+module AsyncRequest
+  class Job < ActiveRecord::Base
+    serialize :params, Array
+    enum status: [:waiting, :processing, :processed]
+  end
+end

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

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

data/app/workers/async_request/job_processor.rb

@@ -0,0 +1,16 @@
+module AsyncRequest
+  class JobProcessor
+    include Sidekiq::Worker
+
+    def perform(id)
+      job = Job.find(id)
+      job.processing!
+      status, response = job.worker.constantize.new.execute(*job.params)
+      job.update_attributes!(
+        status: Job.statuses[:processed],
+        status_code: status,
+        response: response.to_json
+      )
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+AsyncRequest::Engine.routes.draw do
+  resources :jobs, only: [:show]
+end

data/db/migrate/20160411190611_create_async_request_jobs.rb

@@ -0,0 +1,16 @@
+class CreateAsyncRequestJobs < ActiveRecord::Migration
+  def change
+    create_table :async_request_jobs do |t|
+      t.string :worker
+      t.integer :status
+      t.integer :status_code
+      t.text :response
+      t.string :uid
+      t.text :params
+
+      t.timestamps null: false
+    end
+    add_index :async_request_jobs, :status
+    add_index :async_request_jobs, :uid, unique: true
+  end
+end

data/lib/async_request.rb

@@ -0,0 +1,4 @@
+require "async_request/engine"
+
+module AsyncRequest
+end

data/lib/async_request/engine.rb

@@ -0,0 +1,23 @@
+require 'sidekiq'
+module AsyncRequest
+  class Engine < ::Rails::Engine
+    isolate_namespace AsyncRequest
+
+    initializer "async_request", before: :load_config_initializers do |app|
+      Rails.application.routes.append do
+        mount AsyncRequest::Engine, at: "/async_request"
+      end
+
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          Rails.application.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+    end
+  end
+end

data/lib/async_request/version.rb

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

data/lib/tasks/async_request_tasks.rake

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

data/spec/controllers/async_request/jobs_controller_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module AsyncRequest
+  describe JobsController do
+    routes { AsyncRequest::Engine.routes }
+
+    describe '#show' do
+      context 'when there is no job with the given id' do
+        let!(:job) { FactoryGirl.create(:async_request_job, :waiting) }
+        it 'returns 404' do
+          get :show, id: job.uid + 'ABC'
+          expect(response.status).to eq(404)
+        end
+      end
+
+      context 'when the job exists but it is in a waiting status' do
+        let!(:job) { FactoryGirl.create(:async_request_job, :waiting) }
+        it 'returns 202' do
+          get :show, id: job.uid
+          expect(response.status).to eq(202)
+        end
+      end
+
+      context 'when the job exists but it is in a processing status' do
+        let!(:job) { FactoryGirl.create(:async_request_job, :processing) }
+        it 'returns 202' do
+          get :show, id: job.uid
+          expect(response.status).to eq(202)
+        end
+      end
+
+      context 'when the job exists and has finished' do
+        let!(:job) { FactoryGirl.create(:async_request_job, :processed) }
+
+        it 'returns the saved status code' do
+          get :show, id: job.uid
+          expect(response.status).to eq(job.status_code)
+        end
+
+        it 'returns the saved status code' do
+          get :show, id: job.uid
+          expect(response_body).to eq(JSON.parse(job.response))
+        end
+      end
+    end
+  end
+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,10 @@
+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
+
+  def async
+    id = execute_async(Test, 'a')
+    render json: { id: id, url: async_request.job_url(id) }, status: 202
+  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/app/workers/test.rb

@@ -0,0 +1,7 @@
+class Test
+
+  def execute(params)
+    puts params
+    [200, { message: 'you did it!' }]
+  end
+end

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'

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,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.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 || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "async_request"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+