integration_pal 0.1.0

data/app/controllers/integration_pal/workers_controller.rb

@@ -0,0 +1,62 @@
+require_dependency "integration_pal/application_controller"
+
+module IntegrationPal
+  class WorkersController < ApplicationController
+    before_action :set_worker, only: [:show, :edit, :update, :destroy]
+
+    # GET /workers
+    def index
+      @workers = Worker.all
+    end
+
+    # GET /workers/1
+    def show
+    end
+
+    # GET /workers/new
+    def new
+      @worker = Worker.new
+    end
+
+    # GET /workers/1/edit
+    def edit
+    end
+
+    # POST /workers
+    def create
+      @worker = Worker.new(worker_params)
+
+      if @worker.save
+        redirect_to @worker, notice: 'Worker was successfully created.'
+      else
+        render :new
+      end
+    end
+
+    # PATCH/PUT /workers/1
+    def update
+      if @worker.update(worker_params)
+        redirect_to @worker, notice: 'Worker was successfully updated.'
+      else
+        render :edit
+      end
+    end
+
+    # DELETE /workers/1
+    def destroy
+      @worker.destroy
+      redirect_to workers_url, notice: 'Worker was successfully destroyed.'
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_worker
+        @worker = Worker.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def worker_params
+        params.require(:worker).permit(:name, :access_id, :secret_key, :settings, :job_type)
+      end
+  end
+end

data/app/helpers/integration_pal/application_helper.rb

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

data/app/jobs/integration_pal/application_job.rb

@@ -0,0 +1,4 @@
+module IntegrationPal
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/integration_pal/application_mailer.rb

@@ -0,0 +1,6 @@
+module IntegrationPal
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/integration_pal/application_record.rb

@@ -0,0 +1,5 @@
+module IntegrationPal
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/integration_pal/job.rb

@@ -0,0 +1,22 @@
+module IntegrationPal
+  class Job < ApplicationRecord
+    PENDING_STATUS = 'pending'.freeze
+    COMPLETED_STATUS = 'completed'.freeze
+    IN_PROGRESS_STATUS = 'in_progress'.freeze
+    FAILED_STATUS = 'failed'.freeze
+    STATUSES = [PENDING_STATUS, COMPLETED_STATUS, IN_PROGRESS_STATUS, FAILED_STATUS].freeze
+
+    store :job_params, coder: Hash
+
+    belongs_to :worker
+
+    validates :worker, presence: true
+    validates :status, presence: true, inclusion: { in: STATUSES }
+
+    before_validation :set_status
+    def set_status
+      self.status ||= PENDING_STATUS
+    end
+  end
+
+end

data/app/models/integration_pal/worker.rb

@@ -0,0 +1,29 @@
+module IntegrationPal
+  class Worker < ApplicationRecord
+    include ActiveModel
+    store :settings, coder: Hash
+    attr_encrypted :settings, key: ENV['ENCRYPTION_KEY'], salt: ENV['SALT_KEY'], marshal: true
+
+    validates :name, presence: true
+    validates :access_id, presence: true
+    validates :secret_key, presence: true
+    validates :job_type, presence: true
+
+    has_many :jobs
+
+    before_create :generate_api_key
+    def generate_api_key
+      ApiAuth.generate_secret_key
+    end
+
+    after_initialize do |user|
+      self.settings ||= {}
+      self.secret_key ||= ApiAuth.generate_secret_key
+    end
+
+    def job_class
+      self.job_type.constantize
+    end
+
+  end
+end

data/app/views/integration_pal/jobs/_form.html.erb

@@ -0,0 +1,32 @@
+<%= form_with(model: job, local: true) do |form| %>
+  <% if job.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(job.errors.count, "error") %> prohibited this job from being saved:</h2>
+
+      <ul>
+      <% job.errors.full_messages.each do |message| %>
+        <li><%= message %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= form.label :status %>
+    <%= form.text_field :status, id: :job_status %>
+  </div>
+
+  <div class="field">
+    <%= form.label :progress %>
+    <%= form.text_field :progress, id: :job_progress %>
+  </div>
+
+  <div class="field">
+    <%= form.label :worker_id %>
+    <%= form.number_field :worker_id, id: :job_worker_id %>
+  </div>
+
+  <div class="actions">
+    <%= form.submit %>
+  </div>
+<% end %>

data/app/views/integration_pal/jobs/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing Job</h1>
+
+<%= render 'form', job: @job %>
+
+<%= link_to 'Show', @job %> |
+<%= link_to 'Back', jobs_path %>

data/app/views/integration_pal/jobs/index.html.erb

@@ -0,0 +1,25 @@
+<p id="notice"><%= notice %></p>
+
+<h1>Jobs</h1>
+
+<table class='table'>
+  <thead>
+    <tr>
+      <th>ID</th>
+      <th>Worker</th>
+      <th>Status</th>
+      <th>Progress</th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @jobs.each do |job| %>
+      <tr>
+        <td><%= job.id %></td>
+        <td><%= job.worker.name %></td>
+        <td><%= job.status %></td>
+        <td><%= job.progress %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/integration_pal/jobs/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New Job</h1>
+
+<%= render 'form', job: @job %>
+
+<%= link_to 'Back', jobs_path %>

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

@@ -0,0 +1,19 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <strong>Status:</strong>
+  <%= @job.status %>
+</p>
+
+<p>
+  <strong>Progress:</strong>
+  <%= @job.progress %>
+</p>
+
+<p>
+  <strong>Worker:</strong>
+  <%= @job.worker_id %>
+</p>
+
+<%= link_to 'Edit', edit_job_path(@job) %> |
+<%= link_to 'Back', jobs_path %>

data/app/views/integration_pal/workers/_form.html.erb

@@ -0,0 +1,48 @@
+<%= form_with(model: worker, local: true) do |form| %>
+  <% if worker.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(worker.errors.count, "error") %> prohibited this worker from being saved:</h2>
+
+      <ul>
+      <% worker.errors.full_messages.each do |message| %>
+        <li><%= message %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="form-group">
+    <%= form.label :name %>
+    <%= form.text_field :name, class: 'form-control' %>
+  </div>
+
+  <div class="form-group">
+    <%= form.label :access_id, 'Access ID' %>
+    <%= form.text_field :access_id, class: 'form-control' %>
+  </div>
+
+  <div class="form-group">
+    <%= form.label :secret_key %>
+    <%= form.text_field :secret_key, class: 'form-control' %>
+  </div>
+
+  <div class="form-group">
+    <%= form.label :job_type %>
+    <%= form.select :job_type, JOB_TYPES, {}, class: 'form-control' %>
+  </div>
+
+  <% if worker.settings.present? %>
+    <strong>Settings</strong>
+    <hr />
+    <div class="form-group">
+      <% worker.settings.each do |key, value| %>
+        <%= form.label key %>
+        <input name="worker[settings][<%= key %>]" type="text" value="<%= value %>" />
+      <% end %>
+    </div>
+  <% end %>
+
+  <div class="actions">
+    <%= form.submit 'Update Worker', class: 'btn btn-primary' %>
+  </div>
+<% end %>

data/app/views/integration_pal/workers/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing Worker</h1>
+
+<%= render 'form', worker: @worker %>
+
+<%= link_to 'Show', @worker %> |
+<%= link_to 'Back', workers_path %>

data/app/views/integration_pal/workers/index.html.erb

@@ -0,0 +1,32 @@
+<p id="notice"><%= notice %></p>
+
+<h1>Workers</h1>
+
+<table class='table'>
+  <thead>
+    <tr>
+      <th>ID</th>
+      <th>Name</th>
+      <th>Access ID</th>
+      <th>Job Type</th>
+      <th colspan="2"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @workers.each do |worker| %>
+      <tr>
+        <td><%= worker.id %></td>
+        <td><%= worker.name %></td>
+        <td><%= worker.access_id %></td>
+        <td><%= worker.job_type %></td>
+        <td><%= link_to 'Edit', edit_worker_path(worker) %></td>
+        <td><%= link_to 'Destroy', worker, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<br>
+
+<%= link_to 'New Worker', new_worker_path, class: 'btn btn-primary' %>

data/app/views/integration_pal/workers/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New Worker</h1>
+
+<%= render 'form', worker: @worker %>
+
+<%= link_to 'Back', workers_path %>

data/app/views/integration_pal/workers/show.html.erb

@@ -0,0 +1,14 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <strong>Name:</strong>
+  <%= @worker.name %>
+</p>
+
+<p>
+  <strong>Access ID:</strong>
+  <%= @worker.access_id %>
+</p>
+
+<%= link_to 'Edit', edit_worker_path(@worker) %> |
+<%= link_to 'Back', workers_path %>

data/app/views/layouts/_navbar.html.erb

@@ -0,0 +1,24 @@
+<nav class="navbar navbar-default">
+  <div class="container-fluid">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1" aria-expanded="false">
+        <span class="sr-only">Toggle navigation</span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <%= link_to Rails.application.class.parent_name.underscore.humanize, root_path, class: "navbar-brand" %>
+    </div>
+
+    <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
+      <ul class="nav navbar-nav">
+        <li><%= link_to 'Workers', workers_path %></li>
+        <li><%= link_to 'Jobs', jobs_path %></li>
+      </ul>
+
+      <ul class="nav navbar-nav navbar-right">
+        <li><%= link_to 'Logout', logout_url if logout_url.present? %></li>
+      </ul>
+    </div>
+  </div>
+</nav>

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Integration pal</title>
+  <%= stylesheet_link_tag    "integration_pal/application", media: "all" %>
+  <%= javascript_include_tag "integration_pal/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <div class='container'>
+    <%= render 'layouts/navbar' %>
+    <%= yield %>
+  </div>
+</body>
+</html>

data/config/initializers/encryption.rb

@@ -0,0 +1,2 @@
+ENV['ENCRYPTION_KEY'] ||= Rails.application.secrets.encryption_key
+ENV['SALT_KEY'] ||= Rails.application.secrets.salt_key

data/config/initializers/jobs.rb

@@ -0,0 +1,4 @@
+jobs = Dir.glob("#{Rails.root}/app/jobs/*.rb")
+job_types = jobs.map{ |job| File.basename(job).to_s.gsub('.rb', '').camelcase }
+job_types.delete('ApplicationJob')
+JOB_TYPES = job_types

data/config/routes.rb

@@ -0,0 +1,11 @@
+IntegrationPal::Engine.routes.draw do
+  root to: 'workers#index'
+  resources :jobs
+  resources :workers
+
+  namespace :api do
+    namespace :v1 do
+      resources :jobs, only: [:create, :show]
+    end
+  end
+end

data/db/migrate/20170524203831_create_integration_pal_workers.rb

@@ -0,0 +1,14 @@
+class CreateIntegrationPalWorkers < ActiveRecord::Migration[5.1]
+  def change
+    create_table :integration_pal_workers do |t|
+      t.string :name
+      t.string :access_id
+      t.string :secret_key
+      t.string :job_type
+      t.text :encrypted_settings
+      t.string :encrypted_settings_iv
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20170525153603_create_integration_pal_jobs.rb

@@ -0,0 +1,14 @@
+class CreateIntegrationPalJobs < ActiveRecord::Migration[5.1]
+  def change
+    create_table :integration_pal_jobs do |t|
+      t.text :job_params
+      t.string :status
+      t.datetime :started_at
+      t.datetime :finished_at
+      t.string :progress
+      t.integer :worker_id
+
+      t.timestamps
+    end
+  end
+end

data/lib/integration_pal/engine.rb

@@ -0,0 +1,25 @@
+module IntegrationPal
+  class Engine < ::Rails::Engine
+    require 'api-auth'
+    require 'rack-cas-rails'
+    require 'attr_encrypted'
+
+    config.autoload_once_paths += Dir["#{config.root}/lib/**/"]
+
+    isolate_namespace IntegrationPal
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+    end
+
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+        ActiveRecord::Migrator.migrations_paths = Rails.application.paths['db/migrate'].to_a
+      end
+    end
+  end
+end

data/lib/integration_pal/version.rb

@@ -0,0 +1,3 @@
+module IntegrationPal
+  VERSION = '0.1.0'
+end

data/lib/integration_pal.rb

@@ -0,0 +1,5 @@
+require "integration_pal/engine"
+
+module IntegrationPal
+  # Your code goes here...
+end

data/lib/tasks/integration_pal_tasks.rake

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

data/spec/controllers/integration_pal/api/v1/jobs_controller_spec.rb

@@ -0,0 +1,74 @@
+require 'rails_helper'
+
+module IntegrationPal
+  describe Api::V1::JobsController, :type => :controller do
+    routes { IntegrationPal::Engine.routes }
+
+    context 'unauthorized' do
+      describe '#index' do
+        let(:job) { create(:integration_pal_job) }
+
+        it 'restricts access to authorized users' do
+          get :show, params: {id: job.to_param}
+          expect(response.status).to eq(401)
+        end
+      end
+    end
+
+    context 'authorized' do
+      let!(:worker) { create(:integration_pal_worker) }
+
+      describe '#show' do
+        let(:job) { create(:integration_pal_job) }
+        let(:controller_path) { "/api/v1/jobs/#{job.id}"}
+
+        before(:each) do
+          allow_any_instance_of(ActionDispatch::TestRequest).to receive(:fullpath).and_return(controller_path)
+          request.env["HTTP_ACCEPT"] = "application/json"
+          ApiAuth.sign!(request, worker.access_id, worker.secret_key)
+        end
+
+        it 'returns workers as @workers' do
+          get :show, params: {id: job.to_param}
+          expect(response.body).to eq job.to_json
+        end
+      end
+
+      describe "POST #create" do
+        before(:each) do
+          controller.class.skip_before_action :authenticate_api rescue nil
+        end
+
+        context "with valid params" do
+          let(:valid_attributes) {
+            build(:integration_pal_job).attributes
+          }
+
+          it "creates a new Job" do
+            expect {
+              post :create, params: {job: valid_attributes}
+            }.to change(Job, :count).by(1)
+          end
+
+          it "assigns a newly created job as @job" do
+            post :create, params: {job: valid_attributes}
+            expect(assigns(:job)).to be_a(Job)
+            expect(assigns(:job)).to be_persisted
+          end
+        end
+
+        context "with invalid params" do
+          let(:invalid_attributes) {
+            build(:integration_pal_job, worker_id: nil).attributes
+          }
+
+          it "doesn't create the job" do
+            expect {
+              post :create, params: {job: invalid_attributes}
+            }.to change(Job, :count).by(0)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/controllers/integration_pal/jobs_controller_spec.rb

@@ -0,0 +1,107 @@
+require 'rails_helper'
+
+module IntegrationPal
+  describe JobsController, :type => :controller do
+    routes { IntegrationPal::Engine.routes }
+
+    context 'unauthorized' do
+      describe '#index' do
+        let!(:job) { create(:integration_pal_job) }
+
+        it 'restricts access to authorized users' do
+          get :index
+          expect(response.status).to eq(401)
+        end
+      end
+    end
+
+    context 'authorized' do
+      before(:each) do
+        controller.class.skip_before_action :authenticate! rescue nil
+      end
+
+      describe '#index' do
+        let!(:job) { create(:integration_pal_job) }
+
+        it 'returns jobs as @jobs' do
+          get :index
+          expect(assigns(:jobs)).to match_array([job])
+          expect(response).to render_template(:index)
+        end
+      end
+
+      describe "POST #create" do
+        context "with valid params" do
+          let(:valid_attributes) {
+            build(:integration_pal_job).attributes
+          }
+
+          it "creates a new Job" do
+            expect {
+              post :create, params: {job: valid_attributes}
+            }.to change(Job, :count).by(1)
+          end
+
+          it "assigns a newly created job as @job" do
+            post :create, params: {job: valid_attributes}
+            expect(assigns(:job)).to be_a(Job)
+            expect(assigns(:job)).to be_persisted
+          end
+        end
+
+        context "with invalid params" do
+          let(:invalid_attributes) {
+            build(:integration_pal_job, worker_id: nil).attributes
+          }
+
+          it "doesn't create the job" do
+            expect {
+              post :create, params: {job: invalid_attributes}
+            }.to change(Job, :count).by(0)
+          end
+        end
+      end
+
+      describe "PUT #update" do
+        let(:job) { create(:integration_pal_job) }
+
+        context "with valid params" do
+          let(:new_attributes) {
+            {name: 'New Name'}
+          }
+
+          it "updates the requested job" do
+            put :update, params: {id: job.to_param, job: new_attributes}
+            job.reload
+            skip("Add assertions for updated state")
+          end
+
+          it "assigns the requested job as @job" do
+            put :update, params: {id: job.to_param, job: new_attributes}
+            expect(assigns(:job)).to eq(job)
+          end
+
+          it "redirects to the job" do
+            put :update, params: {id: job.to_param, job: new_attributes}
+            expect(response).to redirect_to(job)
+          end
+        end
+
+        context "with invalid params" do
+          let(:invalid_attributes) {
+            {worker_id: ''}
+          }
+          it "assigns the job as @job" do
+            put :update, params: {id: job.to_param, job: invalid_attributes}
+            expect(assigns(:job)).to eq(job)
+          end
+
+          it "re-renders the 'edit' template" do
+            put :update, params: {id: job.to_param, job: invalid_attributes}
+            expect(response).to render_template("edit")
+          end
+        end
+      end
+    end
+  end
+end