career 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c571636304becef9f1dd5988f5606d88e8b608ce706772d3d8841a263fd8a80
+  data.tar.gz: 291e46357b476a6ddb3beac09d39c3995dc6b0f8a832c2631e56480009889a86
+SHA512:
+  metadata.gz: 7ad2d7798f5e3e39b65584e38b650b35d5dc824b6c40bc4b418062ac0bd07a7a39ade83af2a5628b5af84df6b053ea2523dbd510ddefbf63e2736a662e1ca3b8
+  data.tar.gz: 042a6eb56e0e0b4dcde9862f0a50d6b8f74be5cf25816e5b026d2a7babbcc45e2bc27f28f72468145aa25747c8e9692e117bd1bde1f6a6d8609ef0e289a0255c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Casey Li
+
+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,174 @@
+# Career
+
+It's more than just a job, it's a career. 
+
+Career provides persistent data to supplement your background jobs providing insight into things like status, percent complete, started at, and stopped at. Combined with ActionCable, it can provide a powerful UI for your background jobs.
+
+**Currently, we only support [Resque](https://github.com/resque/resque).**
+
+## Usage
+
+### Tasks
+
+The main model that Career introduces is tasks in the form of `Career::Task`.
+
+1. Create a task:
+
+```ruby
+task = Career::Task.create(status: 'scheduled', description: 'My task', class_name: 'MyBackgroundJob')
+```
+
+2. Enqueue the task:
+
+```ruby
+task.enqueue
+```
+
+### Writing jobs for Tasks
+
+`Career::Task#enqueue` always passes in its own ID as the first argument to your background jobs. So, to make your background jobs compatible with `Career::Task`, you'll want the first argument to be `task_id`.
+
+```ruby
+require "resque/errors"
+
+class TestJob
+  @queue = :default_queue
+
+  def self.perform(task_id, my_param_1, my_param_2)
+    # Load Task
+    task = Career::Task.find(task_id)
+
+    task.log "Started my job..."
+
+    # Do stuff
+
+    task.log "...finished this part of the job..."
+    task.update_percent_complete(50)
+
+    # Do Stuff
+
+    task.log "...complete"
+    task.update_percent_complete(100)
+  end
+end
+```
+
+### Using Tasks in your jobs
+
+Once you has access to your task in your job, you can start updating the task within your job with methods like
+
+```ruby
+require "resque/errors"
+
+class TestJob
+  @queue = :default_queue
+
+  def self.perform(task_id, my_param_1, my_param_2)
+    # Load Task
+    task = Career::Task.find(task_id)
+
+    # Log messages
+    task.log "...info message...", "info"
+    task.log "...successful message...", "success"
+    task.log "...error message...", "error"
+
+    # Update percent
+    task.update_percent_complete(50)
+    task.update_percent_complete(100)
+
+    # Update status
+    task.update_status('scheduled')
+    task.update_status('started') # which also sets the started_at timestamp
+    task.update_status('failed')
+    task.update_status('interrupted')
+    task.update_status('canceled')
+    task.update_status('complete') # which also sets the completed_at timestamp
+  end
+end
+```
+
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'career'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install career
+```
+
+### Run Migrations
+
+This gem comes packaged with some database tables so be sure to run your migrations:
+
+```
+rails career:install:migrations
+rails db:migrate
+```
+
+### Setup CSS
+
+Add the following line to your Manifest if you're using Rails 6
+
+```
+# app/assets/config/manifest.js
+//= link career/application.css
+```
+
+### Want a free UI?
+
+If you want to use our built-in UI, then add this to your `config/routes.rb`:
+
+```
+Rails.application.routes.draw do
+  ...
+  mount Career::Engine => "/career"
+  ...
+end
+```
+
+## Contributing
+Contribution directions go here.
+
+### Development
+
+#### Testing
+
+To run rspec, be sure to
+
+1. Setup your dummy database
+
+```
+cd spec/dummy
+cp config/database.yml.tmpl config/database.yml
+```
+
+Then edit the `config/database.yml` for your database and run `rails db:create`
+
+2. Copy engine migrations
+
+The main engine migrations are managed in the top level directory and need to be copied down to `spec`:
+
+```
+cd spec/dummy
+rails career:install:migrations
+rails db:migrate
+```
+
+*Note: We use `ActiveRecord::Migrator.migrations_paths = './dummy/db/migrate'` to deal with the new timestamp that gets created when copying migrations.*
+
+3. Run rspec
+
+At this point, you should be able to run `rspec` from the root folder.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/setup"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/career_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/career .css

data/app/assets/stylesheets/career/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 other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/career/application_controller.rb

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

data/app/controllers/career/tasks_controller.rb

@@ -0,0 +1,13 @@
+module Career
+  class TasksController < ApplicationController
+    def index
+      @tasks = Task.reverse_chronological
+    end
+
+    def show
+      @task = Task.find params[:id]
+    end
+    
+    
+  end
+end

data/app/helpers/career/application_helper.rb

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

data/app/jobs/career/application_job.rb

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

data/app/mailers/career/application_mailer.rb

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

data/app/models/career/application_record.rb

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

data/app/models/career/task.rb

@@ -0,0 +1,62 @@
+module Career
+  class Task < ApplicationRecord
+    has_many :task_log_entries, dependent: :destroy
+    belongs_to :user, optional: true
+    
+    VALID_STATUSES = ['scheduled', 'started', 'complete', 'failed', 'interrupted', 'canceled']
+    
+    serialize :params, Array
+    
+    validates :description, :class_name, :percent_complete, presence: true
+    validates :status, presence: true, inclusion: { in: VALID_STATUSES, message: "%{value} is not a valid status" }
+
+    scope :reverse_chronological, -> { order(created_at: :desc) }
+
+    VALID_STATUSES.each do |method_name|
+      define_method "#{method_name}?" do
+        status == method_name
+      end
+    end
+
+    def enqueue
+      Resque.enqueue(class_name.constantize, id, *params)
+    end
+
+    def enqueue_at(scheduled_date)
+      Resque.enqueue_at(scheduled_date, class_name.constantize, id, *params)
+    end
+
+    def log(content, entry_type='info', data=nil)
+      task_log_entry = task_log_entries.create(content: content, entry_type: entry_type, data: data)    
+      
+      # TODO: Implement
+      #TaskLogEntriesChannel.broadcast_to(self, task_log_entry)
+    end
+
+    def set_status(status)
+      updated_attributes = { status: status }
+      
+      if status == 'started'
+        updated_attributes[:percent_complete] = 0
+        updated_attributes[:started_at] = Time.now
+      end
+
+      if status == 'complete'
+        updated_attributes[:percent_complete] = 100
+        updated_attributes[:completed_at] = Time.now
+      end
+
+      self.update(updated_attributes)
+
+      # TODO: Implement
+      #TasksChannel.broadcast_to(self, self)
+    end
+
+    def update_percent_complete(percent_complete)
+      self.update(percent_complete: percent_complete)
+      
+      # TODO: Implement
+      #TasksChannel.broadcast_to(self, self)
+    end
+  end
+end

data/app/models/career/task_log_entry.rb

@@ -0,0 +1,11 @@
+module Career
+  class TaskLogEntry < ApplicationRecord
+    belongs_to :task
+  
+    validates :content, :entry_type, presence: true
+  
+    scope :chronological, -> { order(created_at: :asc) }
+  end
+end
+
+

data/app/views/career/tasks/index.html.erb

@@ -0,0 +1,28 @@
+<h1>Tasks</h1>
+
+<table>
+  <thead>
+    <tr>
+      <th>ID</th>
+      <th>Description</th>
+      <th>Status</th>
+      <th>Started at</th>
+      <th>Completed at</th>
+      <th>% complete</th>
+      <th></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @tasks.each do |task| %>
+      <tr>
+        <td><%= task.id %></td>
+        <td><%= task.description %></td>
+        <td><%= task.status %></td>
+        <td><%= task.started_at %></td>
+        <td><%= task.completed_at %></td>
+        <td><%= task.percent_complete %></td>
+        <td><%= link_to 'View', task %></td>
+      </tr>
+    <% end %>    
+  </tbody>
+</table>

data/app/views/career/tasks/show.html.erb

@@ -0,0 +1,16 @@
+<h1>Task <%= @task.id %></h1>
+
+<%= @task.description %><br />
+<%= @task.status %><br />
+<%= @task.started_at %><br />
+<%= @task.completed_at %><br />
+<%= @task.percent_complete %><br />
+
+<h2>Log</h2>
+<div>
+  <% @task.task_log_entries.chronological.each do |task_log_entry| %>
+    <div>
+      <%= "#{[task_log_entry.created_at]} - #{task_log_entry.content}" %>
+    </div>
+  <% end %>
+</div>

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Career</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "career/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Career::Engine.routes.draw do
+  resources :tasks, only: [:index, :show]
+end

data/db/migrate/20210423134400_create_career_tasks.rb

@@ -0,0 +1,17 @@
+class CreateCareerTasks < ActiveRecord::Migration[6.1]
+  def change
+    create_table :career_tasks do |t|
+      t.string :status
+      t.float :percent_complete
+      t.string :description
+      t.string :class_name
+      t.datetime :started_at
+      t.datetime :completed_at
+      t.integer :user_id
+      t.text :params
+      t.datetime :scheduled_at
+
+      t.timestamps
+    end
+  end
+end