jobler 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b10be50515f5770dc9da54cedb9f700550c8a9bb
+  data.tar.gz: f274e293bd5c22da12da7ef1d2bcdc32de3c0ed7
+SHA512:
+  metadata.gz: 43e45f56fdd80700e80e09a15e3c6b8ecf6857b3e5c2a4fde0037b0ef449fbd0ef2045680b86ebef9427204840e4041941d5c12b63c31d87d62b6d462d66974f
+  data.tar.gz: 56097d69f110d225413778b01c2d0b64c47c3b9505033de03acec159ea9099516c3ca152452cb591a8318dfa0f41f6ceb4836e467043a69cf53103459ce66c44

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 kaspernj
+
+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,82 @@
+# Jobler
+
+Jobler helps you generate large reports or very large and slow pages through background jobs.
+
+## Install
+
+Add it to your Gemfile and bundle it:
+
+```ruby
+gem "jobler"
+```
+
+Install the migrations and run them:
+```bash
+rake railties:install:migrations
+rake db:migrate
+```
+
+Add it to your routes:
+
+```ruby
+mount Jobler::Engine => "/jobler"
+```
+
+Autoload the "Joblers" you are going to write through application.rb:
+
+```ruby
+config.autoload_paths << Rails.root.join("app", "joblers")
+```
+
+Add a ApplicationJobler to follow the ApplicationController and ApplicationRecord pattern:
+```ruby
+class ApplicationJobler < Jobler::BaseJobler
+end
+```
+
+Jobler is going to queue its jobs through the ActiveJob queue called `:jobler`, so make sure a worker is listening to that queue.
+
+## Usage
+
+Write a new Jobler located in "app/joblers":
+
+```ruby
+class MyJobler < ApplicationJobler
+  # This method will be executed in the background
+  def execute!
+    my_temp_file = Tempfile.new
+
+    # Do some heavy lifting code wise...
+
+    create_result!(name: "my-file", temp_file: my_temp_file)
+  end
+
+  # This method will be called from the web when the execute is completed and successful
+  def result
+    Jobler::FileDownload.new(
+      file_name: "some-file.zip",
+      temp_file: temp_file_for_result(name: "my-file")
+    )
+  end
+end
+```
+
+You can do something like this in your controller:
+```ruby
+class MyController < ApplicationController
+  def some_action
+    scheduler = Jobler::JobScheduler.create! jobler_type: "MyJobler", job_args: {
+      current_user_id: current_user.id,
+      query_parameters: request.query_parameters
+    }
+
+    redirect_to jobler.job_path(scheduler.job)
+  end
+end
+```
+
+This will show a wait page and them a complete page with a download link, once the job is completed.
+
+## License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,27 @@
+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    = "Jobler"
+  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"
+
+if Rails.env.development? || Rails.env.test?
+  require "best_practice_project"
+  BestPracticeProject.load_tasks
+end
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/jobler/application.js

@@ -0,0 +1,2 @@
+//= require jquery
+//= require jobler/jobs

data/app/assets/javascripts/jobler/jobs.js

@@ -0,0 +1,29 @@
+function updateJobProgress() {
+  console.log("updateJobProgress()")
+  job = $(".job")
+
+  $.ajax({type: "GET", url: job.data("job-path"), complete: function(data) {
+    console.log(data.responseText)
+
+    result = $.parseJSON(data.responseText)
+
+    $(".job-progress").text((result.job.progress * 100).toFixed(2) + "%")
+
+    if (result.job.state == "completed") {
+      console.log("Job is completed - reload!")
+      location.reload()
+    }
+  }})
+
+  if (job.data("state") != "completed") {
+    setTimeout("updateJobProgress()", 5000)
+  }
+}
+
+$(document).ready(function() {
+  job = $(".job")
+
+  if (job.data("state") != "completed") {
+    updateJobProgress()
+  }
+})

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

@@ -0,0 +1,3 @@
+class Jobler::ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/app/controllers/jobler/downloads_controller.rb

@@ -0,0 +1,13 @@
+class Jobler::DownloadsController < Jobler::ApplicationController
+  def show
+    @job = Jobler::Job.find(params[:id])
+    @result = @job.jobler.result
+
+    if @result.is_a?(Jobler::FileDownload)
+      send_file @result.temp_file.path, disposition: "attachment", filename: @result.file_name
+    else
+      flash[:error] = "The result wasn't a file download"
+      redirect_to :back
+    end
+  end
+end

data/app/controllers/jobler/jobs_controller.rb

@@ -0,0 +1,18 @@
+class Jobler::JobsController < Jobler::ApplicationController
+  def show
+    @job = Jobler::Job.find(params[:id])
+    @result = @job.jobler.result if @job.completed?
+
+    respond_to do |format|
+      format.json do
+        render json: {
+          job: {
+            progress: @job.progress,
+            state: @job.state
+          }
+        }
+      end
+      format.html
+    end
+  end
+end

data/app/helpers/jobler/application_helper.rb

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

data/app/models/jobler/job.rb

@@ -0,0 +1,16 @@
+class Jobler::Job < ActiveRecord::Base
+  has_many :results, class_name: "Jobler::Result", dependent: :destroy
+
+  validates :jobler_type, :state, presence: true
+
+  def jobler
+    user_jobler = jobler_type.constantize.new
+    user_jobler.instance_variable_set(:@args, YAML.load(parameters)) # rubocop:disable Security/YAMLLoad
+    user_jobler.instance_variable_set(:@job, self)
+    user_jobler
+  end
+
+  def completed?
+    state == "completed"
+  end
+end

data/app/models/jobler/result.rb

@@ -0,0 +1,5 @@
+class Jobler::Result < ActiveRecord::Base
+  belongs_to :job, class_name: "Jobler::Job"
+
+  validates :job, :name, presence: true
+end

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

@@ -0,0 +1,17 @@
+<div class="job" data-id="<%= @job.id %>" data-path="<%= job_path(@job) %>" data-state="<%= @job.state %>"></div>
+
+<% if @job.completed? %>
+  <h1>Completed</h1>
+
+  <% if @result.is_a?(Jobler::FileDownload) %>
+    <%= link_to "Download", download_path(@job) %>
+  <% end %>
+<% else %>
+  <h1>Waiting</h1>
+
+  <div class="job-progress">
+    <% if @job.progress? %>
+      <%= number_with_precision @job.progress, precision: 2 %>%
+    <% end %>
+  </div>
+<% end %>

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Jobler</title>
+  <%= stylesheet_link_tag "jobler/application", media: "all" %>
+  <%= javascript_include_tag "jobler/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body class="controller-<%= controller_name %> action-<%= action_name %>">
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+Jobler::Engine.routes.draw do
+  resources :downloads, only: :show
+  resources :jobs, only: :show
+end

data/db/migrate/20170130220604_create_jobs.rb

@@ -0,0 +1,13 @@
+class CreateJobs < ActiveRecord::Migration
+  def change
+    create_table :jobler_jobs do |t|
+      t.string :jobler_type, null: false
+      t.string :state, default: "new", null: false
+      t.float :progress, default: 0.0, null: false
+      t.text :parameters
+      t.datetime :started_at
+      t.datetime :ended_at
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20170130220734_create_jobler_results.rb

@@ -0,0 +1,12 @@
+class CreateJoblerResults < ActiveRecord::Migration
+  def change
+    create_table :jobler_results do |t|
+      t.belongs_to :job, index: true, null: false
+      t.string :name, index: true, null: false
+      t.binary :result, limit: 16.megabyte
+      t.timestamps null: false
+    end
+
+    add_foreign_key :jobler_results, :jobler_jobs, column: "job_id"
+  end
+end

data/lib/jobler.rb

@@ -0,0 +1,11 @@
+require "jobler/engine"
+
+module Jobler
+  path = "#{File.dirname(__FILE__)}/jobler"
+
+  autoload :BaseJobler, "#{path}/base_jobler"
+  autoload :FileDownload, "#{path}/file_download"
+  autoload :JobScheduler, "#{path}/job_scheduler"
+  autoload :JobRunner, "#{path}/job_runner"
+  autoload :TemplateRenderer, "#{path}/template_renderer"
+end

data/lib/jobler/base_jobler.rb

@@ -0,0 +1,56 @@
+class Jobler::BaseJobler
+  attr_reader :args, :job
+
+  def create_result!(args)
+    temp_file = args.fetch(:temp_file)
+    temp_file.close unless temp_file.closed?
+
+    job.results.create!(
+      name: args.fetch(:name),
+      result: File.read(temp_file.path)
+    )
+  end
+
+  def execute!
+    raise NoMethodError, "You should define the 'execute!' method on #{self.class.name}"
+  end
+
+  def increment_progress!
+    @_progress_count ||= 0.0
+    @_progress_count += 1.0
+
+    new_progress = @_progress_count / @_progress_total
+
+    if @_current_progress.nil?
+      update = true
+    else
+      progress_difference = new_progress - @_current_progress
+      update = true if progress_difference > 0.01
+    end
+
+    if update
+      job.update_columns(progress: new_progress)
+      @_current_progress = new_progress
+    end
+  end
+
+  def progress_total(new_total)
+    @_progress_total = new_total.to_f
+  end
+
+  def result
+    raise NoMethodError, "You should define the 'result' method on #{self.class.name}"
+  end
+
+  def temp_file_for_result(args)
+    job_result = job.results.where(name: args.fetch(:name)).first
+
+    raise "No result by that name: #{args.fetch(:name)}" unless job_result
+
+    temp_file = Tempfile.new
+    temp_file.binmode
+    temp_file.write(job_result.result)
+    temp_file.close
+    temp_file
+  end
+end

data/lib/jobler/engine.rb

@@ -0,0 +1,3 @@
+class Jobler::Engine < ::Rails::Engine
+  isolate_namespace Jobler
+end

data/lib/jobler/file_download.rb

@@ -0,0 +1,8 @@
+class Jobler::FileDownload
+  attr_reader :file_name, :temp_file
+
+  def initialize(args)
+    @file_name = args.fetch(:file_name)
+    @temp_file = args.fetch(:temp_file)
+  end
+end

data/lib/jobler/job_runner.rb

@@ -0,0 +1,16 @@
+class Jobler::JobRunner < ActiveJob::Base
+  queue_as :jobler
+
+  def perform(job_id)
+    job = Jobler::Job.find(job_id)
+    job.update_attributes!(started_at: Time.zone.now, state: "started")
+
+    begin
+      job.jobler.execute!
+      job.update_attributes!(ended_at: Time.zone.now, progress: 1.0, state: "completed")
+    rescue Exception => e # rubocop:disable Lint/RescueException
+      job.update_attributes!(ended_at: Time.zone.now, state: "error")
+      raise e
+    end
+  end
+end

data/lib/jobler/job_scheduler.rb

@@ -0,0 +1,23 @@
+class Jobler::JobScheduler
+  attr_reader :job
+
+  def self.create!(args)
+    scheduler = Jobler::JobScheduler.new(args)
+    scheduler.create_job
+    scheduler.perform_job_later
+    scheduler
+  end
+
+  def initialize(args)
+    @jobler_type = args.fetch(:jobler_type)
+    @job_args = args[:job_args]
+  end
+
+  def create_job
+    @job = Jobler::Job.create!(jobler_type: @jobler_type, parameters: YAML.dump(@job_args))
+  end
+
+  def perform_job_later
+    Jobler::JobRunner.perform_later(job.id)
+  end
+end

data/lib/jobler/template_renderer.rb

@@ -0,0 +1,3 @@
+class TemplateRenderer
+  include RenderAnywhere
+end

data/lib/jobler/version.rb

@@ -0,0 +1,3 @@
+module Jobler
+  VERSION = "0.0.1".freeze
+end

data/lib/tasks/jobler_tasks.rake

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

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: jobler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kaspernj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7.1
+description: Generate pages or files in the background
+email:
+- kaspernj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/jobler.js
+- app/assets/javascripts/jobler/application.js
+- app/assets/javascripts/jobler/jobs.js
+- app/assets/stylesheets/jobler/application.css
+- app/controllers/jobler/application_controller.rb
+- app/controllers/jobler/downloads_controller.rb
+- app/controllers/jobler/jobs_controller.rb
+- app/helpers/jobler/application_helper.rb
+- app/models/jobler/job.rb
+- app/models/jobler/result.rb
+- app/views/jobler/jobs/show.html.erb
+- app/views/layouts/jobler/application.html.erb
+- config/routes.rb
+- db/migrate/20170130220604_create_jobs.rb
+- db/migrate/20170130220734_create_jobler_results.rb
+- lib/jobler.rb
+- lib/jobler/base_jobler.rb
+- lib/jobler/engine.rb
+- lib/jobler/file_download.rb
+- lib/jobler/job_runner.rb
+- lib/jobler/job_scheduler.rb
+- lib/jobler/template_renderer.rb
+- lib/jobler/version.rb
+- lib/tasks/jobler_tasks.rake
+homepage: https://www.github.com/kaspernj/jobler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Generate pages or files in the background
+test_files: []