asyncapi-server 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc1e5729a68ac1d07a41e52ce742a35dc36ff5be
+  data.tar.gz: 4bc45e530b4b9f0ff4bbc6ba515a6bd753aafd00
+SHA512:
+  metadata.gz: 9631bfcc20b0d4e3327caab6872caa4288f16c7909f3eb9b3075315c2b1a0d649d024dbf362acb3a6fe894a6166dce8235101f9c02b8acdc4bbf5cb0a2d29f25
+  data.tar.gz: e6a08f0a83bbd0ab17d81efc472259634dbf485cbb2b4f65435b3311d5b65c5a6e23d6f89683dc61763571f2ea23e82c8647bf04274ad8f676f59c7f3c88b510

data/MIT-LICENSE

@@ -0,0 +1,9 @@
+Copyright 2015 G5
+
+MIT License
+
+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,83 @@
+# Asyncapi::Server
+
+`Asyncapi::Server` is a Rails engine that allows asynchronous responses for API calls made by [Asyncapi::Client](https://github.com/G5/asyncapi-client).
+
+# Installation
+
+Add `asyncapi-server` into your Gemfile, `bundle install`, then run the following commands:
+
+```bash
+rails g asyncapi:server:config
+rake asyncapi_server:install:migrations
+rake db:migrate
+```
+
+Make sure you have `:host` in the `default_url_options` set up for your server. Example `config/initializers/default_url_options.rb`:
+
+```ruby
+Rails.application.routes.default_url_options ||= {}
+Rails.application.routes.default_url_options[:host] = ENV["HOST"]
+```
+
+# Usage
+
+In your controller where you want a `create` action:
+
+```ruby
+# some_controller.rb
+class SomeController < ApplicationController
+  async :create, CreateSomething
+end
+```
+
+Create the `CreateSomething` runner class that will be called in the background:
+
+```ruby
+# create_something.rb
+class CreateSomething
+  def self.call(params)
+    something = Something.new(params)
+
+    # the last line in this method is sent back to Asyncapi::Client as the `message`
+    if something.save
+      something.to_json
+    else
+      something.errors.messages
+    end
+  end
+end
+```
+
+If you use `protected_attributes`, in an initializer:
+
+```ruby
+Asyncapi::Server::Job.attr_accessible :status, :callback_url, :class_name, :params, :secret
+```
+
+### RSpec
+
+If you want to create an integration spec for you Asyncapi server endpoint, make sure you require the helper:
+
+```ruby
+require "asyncapi/server/rspec"
+```
+
+When you make a request, instead of `post`, use `asyncapi_post`. Ex:
+
+```ruby
+asyncapi_post("/api/v1/long_running_job", name: "Compute")
+```
+
+This helper calls `post` underneath but builds the request in a way that Asyncapi server understands.
+
+## License
+
+Copyright (c) 2015 G5
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1,33 @@
+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    = 'AsyncapiServer'
+  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/controllers/asyncapi/server/v1/jobs_controller.rb

@@ -0,0 +1,34 @@
+module Asyncapi
+  module Server
+    module V1
+      class JobsController < ApplicationController # TODO: Asyncapi::Server.parent_controller
+
+        protect_from_forgery with: :null_session
+        respond_to :json
+
+        def index
+          jobs = paginate Job.all
+          serializer = ActiveModel::ArraySerializer.new(jobs)
+          render json: serializer
+        end
+
+        def show
+          job = Job.find(params[:id])
+          job = JobSerializer.new(job)
+          render json: job
+        end
+
+        def destroy
+          job = Job.find_by(id: params[:id], secret: params[:secret])
+          if job
+            job.destroy
+            respond_with job
+          else
+            render nothing: true, status: 404
+          end
+        end
+
+      end
+    end
+  end
+end

data/app/models/asyncapi/server/job.rb

@@ -0,0 +1,14 @@
+module Asyncapi
+  module Server
+    class Job < ActiveRecord::Base
+
+      self.table_name = "asyncapi_server_jobs"
+      enum status: %i[queued success error]
+
+      def url
+        Engine.routes.url_helpers.v1_job_url(self)
+      end
+
+    end
+  end
+end

data/app/serializers/asyncapi/server/job_serializer.rb

@@ -0,0 +1,10 @@
+module Asyncapi
+  module Server
+    class JobSerializer < ActiveModel::Serializer
+
+      attributes :id, :url, :secret
+
+    end
+  end
+end
+

data/app/workers/asyncapi/server/job_worker.rb

@@ -0,0 +1,41 @@
+module Asyncapi::Server
+  class JobWorker
+
+    include Sidekiq::Worker
+    sidekiq_options retry: false
+
+    def perform(job_id)
+      job = Job.find(job_id)
+      runner_class = job.class_name.constantize
+
+      job_status = :success
+      job_message = runner_class.call(job.params)
+    rescue => e
+      job_status = :error
+      job_message = [e.message, e.backtrace].flatten.join("\n")
+    ensure
+      job.update_attributes(status: job_status)
+      report_job_status(job, job_message)
+    end
+
+    private
+
+    def report_job_status(job, job_message)
+      Typhoeus.put(
+        job.callback_url,
+        body: {
+          job: {
+            status: job.status,
+            message: job_message,
+            secret: job.secret,
+          }
+        }.to_json,
+        headers: {
+          "Content-Type" => "application/json",
+          Accept: "application/json"
+        }
+      )
+    end
+
+  end
+end

data/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/config/routes.rb

@@ -0,0 +1,7 @@
+Asyncapi::Server::Engine.routes.draw do
+
+  namespace :v1 do
+    resources :jobs
+  end
+
+end

data/db/migrate/20141112034324_create_asyncapi_server_jobs.rb

@@ -0,0 +1,10 @@
+class CreateAsyncapiServerJobs < ActiveRecord::Migration
+  def change
+    create_table :asyncapi_server_jobs do |t|
+      t.integer :status
+      t.string :callback_url
+      t.string :class_name
+      t.text :params
+    end
+  end
+end

data/db/migrate/20141212064931_add_secret_to_asyncapi_server_job.rb

@@ -0,0 +1,5 @@
+class AddSecretToAsyncapiServerJob < ActiveRecord::Migration
+  def change
+    add_column :asyncapi_server_jobs, :secret, :string
+  end
+end

data/db/migrate/20150130062520_add_expired_at_to_asyncapi_server_job.rb

@@ -0,0 +1,11 @@
+class AddExpiredAtToAsyncapiServerJob < ActiveRecord::Migration
+  def change
+    add_column :asyncapi_server_jobs, :expired_at, :datetime
+
+    Asyncapi::Server::Job.reset_column_information
+
+    Asyncapi::Server::Job.
+      where(Asyncapi::Server::Job.arel_table[:expired_at].eq(nil)).
+      update_all(expired_at: Asyncapi::Server.expiry_threshold.from_now)
+  end
+end

data/db/migrate/20150201231018_drop_expired_at_from_asyncapi_server_jobs.rb

@@ -0,0 +1,9 @@
+class DropExpiredAtFromAsyncapiServerJobs < ActiveRecord::Migration
+  def up
+    remove_column :asyncapi_server_jobs, :expired_at
+  end
+
+  def down
+    add_column :asyncapi_server_jobs, :expired_at, :datetime
+  end
+end

data/lib/asyncapi-server.rb

@@ -0,0 +1 @@
+require "asyncapi/server"

data/lib/asyncapi/server.rb

@@ -0,0 +1,16 @@
+require "asyncapi/server/engine"
+
+module Asyncapi
+  module Server
+
+    CONFIGURATION = {
+      expiry_threshold: 10.days,
+    }
+
+    CONFIGURATION.each do |var, default|
+      mattr_accessor var
+      self.send(:"#{var}=", default)
+    end
+
+  end
+end

data/lib/asyncapi/server/engine.rb

@@ -0,0 +1,23 @@
+require "api-pagination"
+require "kaminari"
+require "typhoeus"
+require "sidekiq"
+require "asyncapi/server/rails_ext/controller"
+require "active_model/serializer"
+
+module Asyncapi
+  module Server
+    class Engine < ::Rails::Engine
+      isolate_namespace Asyncapi::Server
+      engine_name "asyncapi_server"
+
+      config.to_prepare do
+        ::ApplicationController.send :include, RailsExt::Controller
+
+        Engine.routes.default_url_options =
+          Rails.application.routes.default_url_options
+      end
+
+    end
+  end
+end

data/lib/asyncapi/server/rails_ext/controller.rb

@@ -0,0 +1,32 @@
+module Asyncapi
+  module Server
+    module RailsExt
+      module Controller
+
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          def async(method_name, klass)
+            define_method(method_name) do
+              job = Job.create(job_params_with(klass.name))
+              serializer = JobSerializer.new(job)
+              JobWorker.perform_async(job.id)
+              render json: serializer
+            end
+          end
+        end
+
+        def job_params_with(class_name)
+          params[:job].merge!(class_name: class_name)
+          params.require(:job).permit(
+            :callback_url,
+            :class_name,
+            :params,
+            :secret,
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/asyncapi/server/rspec.rb

@@ -0,0 +1,19 @@
+module Asyncapi
+  module Server
+    module RSpec
+
+      def asyncapi_post(url, params)
+        post(url, {
+          job: {
+            callback_url: "callback_url",
+            params: params,
+            secret: "sekret",
+          }
+        })
+      end
+
+    end
+  end
+end
+
+RSpec.configuration.include Asyncapi::Server::RSpec, type: :request

data/lib/asyncapi/server/version.rb

@@ -0,0 +1,5 @@
+module Asyncapi
+  module Server
+    VERSION = "1.0.0"
+  end
+end

data/lib/asyncapi_server/engine.rb

@@ -0,0 +1 @@
+require "asyncapi/server/engine"

data/lib/generators/asyncapi/server/config_generator.rb

@@ -0,0 +1,17 @@
+require "asyncapi/server/engine"
+
+module Asyncapi::Server
+  class ConfigGenerator < Rails::Generators::Base
+
+    desc "Inserts routes code for Asyncapi::Server"
+
+    def mount_on_routes
+      inject_into_file(
+        "config/routes.rb",
+        %Q(  mount Asyncapi::Server::Engine, at: "/asyncapi/server"\n),
+        before: /^end/
+      )
+    end
+
+  end
+end