steve 1.0.4 → 2.0.2

data/lib/steve.rb

@@ -10,6 +10,9 @@ module Steve
     
     ## The name of the table where jobs are stored (default 'jobs')
     attr_accessor :jobs_table_name
+
+    ## The name of the table where completed jobs are stored
+    attr_accessor :archived_jobs_table_name
     
     ## The period of time to wait before looking for new jobs
     attr_accessor :worker_sleep_time
@@ -54,6 +57,7 @@ end
 
 require 'steve/job'
 require 'steve/queued_job'
+require 'steve/archived_job'
 require 'steve/worker'
 require 'steve/interface'
 

data/lib/steve/archived_job.rb

@@ -0,0 +1,33 @@
+module Steve
+  class ArchivedJob < ActiveRecord::Base
+
+    self.table_name = Steve.archived_jobs_table_name || 'archived_jobs'
+
+    serialize :params
+
+    scope :completed, lambda { where(:status => 'completed') }
+    scope :failed, lambda { where(:status => 'failed') }
+
+    scope :asc, lambda { order('id desc') }
+
+    def self.archive_job(job)
+      return if job.status == 'completed' && Steve.delete_successful_jobs
+
+      job_attributes = job.attributes
+      job_attributes.delete('id')
+
+      archive_job = self.new(job_attributes)
+      archive_job.save
+    ensure
+      job.destroy
+    end
+
+    def retry!
+      job_requeued = Steve::QueuedJob.queue(self.job, self.params) do |job|
+        job.queue = self.queue
+        job.priority = self.priority
+      end
+    end
+
+  end
+end

data/lib/steve/interface.rb

@@ -1,23 +1,41 @@
 require 'haml'
+require 'will_paginate/view_helpers'
+require 'will_paginate/view_helpers/link_renderer'
 
 module Steve
   class Interface
-    
+    include WillPaginate::ViewHelpers
+
     def call(env)
       @req = Rack::Request.new(env)
       case env['PATH_INFO'].to_s
-      when ''
+      when '/', ''
         [200, {'Content-type' => 'text/html'}, [haml(:index)]]
       when /failed/
+        @jobs = Steve::ArchivedJob.failed.asc.paginate(:page => @req.params['page'], :per_page => 50)
         [200, {'Content-type' => 'text/html'}, [haml(:failed)]]
       when /completed/
+        @jobs = Steve::ArchivedJob.completed.asc.paginate(:page => @req.params['page'], :per_page => 50)
         [200, {'Content-type' => 'text/html'}, [haml(:completed)]]
+      when /archived\/object/
+        @jobs = Steve::ArchivedJob.where(:associated_object_type => @req.params['type'], :associated_object_id => @req.params['id']).order('created_at desc').limit(25)
+        [200, {'Content-type' => 'text/html'}, [haml(:object)]]
+      when /archived\/view/
+        @job = Steve::ArchivedJob.find(@req.params['id'])
+        [200, {'Content-type' => 'text/html'}, [haml(:view)]]
       when /object/
         @jobs = Steve::QueuedJob.where(:associated_object_type => @req.params['type'], :associated_object_id => @req.params['id']).order('created_at desc').limit(25)
         [200, {'Content-type' => 'text/html'}, [haml(:object)]]
       when /view/
         @job = Steve::QueuedJob.find(@req.params['id'])
         [200, {'Content-type' => 'text/html'}, [haml(:view)]]
+      when /retry/
+        @archived_job = Steve::ArchivedJob.find(@req.params['id'])
+        if @archived_job.retry!
+          [302, {'Location' => '/jobs/?status=retried'}]
+        else
+          [302, {'Location' => '/jobs/?status=retryfailed'}]
+        end
 
       else
         path = static_path(env['PATH_INFO'])

data/lib/steve/interface/public/style.css

@@ -27,6 +27,10 @@ body { margin:0;}
 #header h1 span { font-weight:bold; font-size:90%; color:#fff;}
 #header h1 em { color:yellow; font-weight:bold;}
 
+#status { font-size:120%; font-weight:bold; text-align:center; }
+#status span.success { color:#11772d; }
+#status span.failure { color:#fe3939; }
+
 #content { margin:15px 2%;}
 #content h2 { font-size:150%; font-weight:bold; margin:15px 0;}
 #content table.data {width:100%;}
@@ -39,7 +43,9 @@ body { margin:0;}
 #content p { margin:10px 0; line-height:1.5;}
 #content a { color:#333;}
 
+#content .pagination-details { float:right; margin-top:10px;  }
+
 #content dl {margin:40px 0; font-size:110%;}
 #content dl dt { font-weight:bold; float:left; width:150px; text-align:right;}
 #content dl dd { margin-left:180px; margin-bottom:10px;}
-#content dl dd pre { background:#000; color:#fff; line-height:1.3;  padding:6px;}
+#content dl dd pre { background:#000; color:#fff; line-height:1.3;  padding:6px;}

data/lib/steve/interface/views/completed.haml

@@ -10,6 +10,7 @@
     #content
       #recent
         %h2 Recently completed jobs
+
         %table.data
           %thead
             %tr
@@ -19,13 +20,13 @@
               %td{:width => '15%'} Run at
               %td{:width => '5%'} Retries
           %tbody
-            - jobs = Steve::QueuedJob.completed.limit(15).order('run_at desc')
-            - for job in jobs
+            - for job in @jobs
               %tr
                 %td
                   %code
-                    %a{:href => "view?id=#{job.id}"}= job.job
-                    %span= job.params.inspect
+                    %a{:href => "archived/view?id=#{job.id}"}= job.job
+                    - unless job.params.empty?
+                      %span= job.params.inspect
                 %td
                   - if job.associated_object_type.blank?
                     —
@@ -34,8 +35,11 @@
                 %td= job.created_at.to_s(:db)
                 %td= job.run_at.to_s(:db)
                 %td= job.retries
-            - if jobs.empty?
+            - if @jobs.empty?
               %tr
                 %td.none{:colspan => 7} There are no jobs recently completed
+
+      .pagination-details
+        = page_entries_info @jobs
       %p
-        %a{:href => "/jobs"} Back to overview
+        %a{:href => "/jobs"} Back to overview

data/lib/steve/interface/views/failed.haml

@@ -12,6 +12,7 @@
       %p
         The jobs listed below have failed to execute recently. You can clear all the jobs using the button below, this will
         remove them from the database and you will not be able to retry once removed.
+      
       %table.data
         %thead
           %tr
@@ -22,22 +23,27 @@
             %td{:width => '35%'} Error
             %td{:width => '10%'}
         %tbody
-          - jobs = Steve::QueuedJob.failed
-          - for job in jobs
+          - for job in @jobs
             %tr
               %td= job.finished_at.to_s(:short)
               %td= job.id
               %td
                 %code
-                  %a{:href => "view?id=#{job.id}"}= job.job
-                  %span= job.params.inspect
+                  %a{:href => "archived/view?id=#{job.id}"}= job.job
+                  - unless job.params.empty?
+                    %span= job.params.inspect
               %td= job.queue
               %td
-                %code{:style => 'font-size:90%', :title => job.error}= ERB::Util.html_escape(job.error.split("\n").first)\
+                %code{:style => 'font-size:90%', :title => job.error}= ERB::Util.html_escape(job.error.to_s.split("\n").first)\
               %td
-                %a{:href => '#'} Retry
-          - if jobs.empty?
+                %form{:action => "/jobs/retry?id=#{job.id}", :method => :post}
+                  %input{:type => 'submit', :value => 'Retry'} 
+          - if @jobs.empty?
             %tr
               %td.none{:colspan => 6} There are no jobs currently running
+              
+      .pagination-details
+        = page_entries_info @jobs
+
       %p
-        %a{:href => "/jobs"} Back to overview
+        %a{:href => "/jobs"} Back to overview

data/lib/steve/interface/views/index.haml

@@ -8,27 +8,38 @@
       %h1 <span>Steve</span>&mdash;Job Queue Monitor
 
     #content
+      #status
+        - case @req.params['status']
+        - when 'retried'
+          %span.success Job successfully requeued.
+        - when 'retry_failed'
+          %span.failure Job could not be requeued for some reason.
+
       #active
         %h2 Jobs being executed at the moment
         %table.data
           %thead
             %tr
               %td{:width => '25%'} Job
-              %td{:width => '25%'} Queue
-              %td{:width => '50%'} Worker
+              %td{:width => '15%'} Queue
+              %td{:width => '40%'} Worker
+              %td{:width => '20%'} Started at
+
           %tbody
             - jobs = Steve::QueuedJob.running
             - for job in jobs
               %tr
                 %td
                   %code
-                    %b= job.job
+                    %b
+                      %a{:href => "jobs/view?id=#{job.id}"}= job.job
                     %span= job.params.inspect
                 %td= job.queue
                 %td= job.worker
+                %td= job.started_at.to_s(:db)
             - if jobs.empty?
               %tr
-                %td.none{:colspan => 3} There are no jobs currently running
+                %td.none{:colspan => 4} There are no jobs currently running
   
       #queues
         %h2 Jobs which are pending execution
@@ -48,7 +59,8 @@
               %tr
                 %td
                   %code
-                    %b= job.job
+                    %b
+                      %a{:href => "jobs/view?id=#{job.id}"}= job.job
                     %span= job.params.inspect
                 %td= job.queue
                 %td= job.status
@@ -65,11 +77,10 @@
       #stats
         %h2 Statistics
         %ul
-          %li== #{Steve::QueuedJob.count} jobs stored
-          %li== #{Steve::QueuedJob.pending.count} pending execution
           %li== #{Steve::QueuedJob.running.count} running now
+          %li== #{Steve::QueuedJob.pending.count} pending execution
           - unless Steve.delete_successful_jobs
             %li
-              %a{:href => 'jobs/completed'}== #{Steve::QueuedJob.completed.count} completed successfully
+              %a{:href => 'jobs/completed'}== #{Steve::ArchivedJob.completed.count} completed successfully
           %li
-            %a{:href => 'jobs/failed'}== #{Steve::QueuedJob.failed.count} failed to execute
+            %a{:href => 'jobs/failed'}== #{Steve::ArchivedJob.failed.count} failed to execute

data/lib/steve/interface/views/view.haml

@@ -31,10 +31,10 @@
         %dd= @job.created_at
         
         %dt Started at
-        %dd= @job.started_at
+        %dd= @job.started_at || " "
         
         %dt Finished at
-        %dd= @job.finished_at
+        %dd= @job.finished_at || " "
         
         - unless @job.output.blank?
           %dt Output
@@ -49,4 +49,4 @@
         %dt Worker
         %dd= @job.worker
       %p
-        %a{:href => "/jobs"} Back to overview
+        %a{:href => "/jobs"} Back to overview

data/lib/steve/job.rb

@@ -6,6 +6,7 @@ module Steve
     
     class Delay < StandardError; end
     class Error < StandardError; end
+    class Aborted < StandardError; end
     
     attr_reader :job
     attr_reader :params

data/lib/steve/queued_job.rb

@@ -13,10 +13,8 @@ module Steve
     belongs_to :associated_object, :polymorphic => true
     
     ## Scopes
-    scope :pending, where(:status => ['pending', 'delayed'])
-    scope :running, where(:status => 'running')
-    scope :completed, where(:status => 'completed')
-    scope :failed, where(:status => 'failed')
+    scope :pending, lambda { where(:status => ['pending', 'delayed']) }
+    scope :running, lambda { where(:status => 'running') }
     
     ## Automatically set defaults for new jobs
     before_create do
@@ -26,6 +24,11 @@ module Steve
       self.run_at   ||= Time.now.utc
     end
     
+    after_save do
+      Steve::ArchivedJob.archive_job(self) if self.archive_job?
+      true
+    end
+
     ## Queue a new job for processing. Returns true or false depending whether
     ## the job has been queued or not.
     def self.queue(klass, params = {}, &block)
@@ -33,6 +36,7 @@ module Steve
       job.job = klass.to_s
       job.params = params
       job.queue = klass.instance_variable_get('@queue')
+      job.priority = klass.instance_variable_get('@priority')
       block.call(job) if block_given?
       job.save
     end
@@ -77,11 +81,10 @@ module Steve
     ## Execute this job, catching any errors if they occur and ensuring the
     ## job is started & finished as appropriate.
     def execute
-      @output_file = File.join('', 'tmp', "steve-job-#{self.id}")
       job = self.job.constantize.new(self)
       if job.respond_to?(:perform)
         start!
-        STDOUT.reopen(@output_file) && STDERR.reopen(@output_file)
+        STDOUT.reopen(output_file) && STDERR.reopen(output_file)
         begin
           job.perform
           success!
@@ -117,14 +120,21 @@ module Steve
       end
     ensure
       STDOUT.flush && STDERR.flush
-      if File.exist?(@output_file)
-        self.output = File.read(@output_file)
-        FileUtils.rm(@output_file)
+      if File.exist?(output_file)
+        self.output = File.read(output_file)
+        FileUtils.rm(output_file)
       end
-      if self.status == 'completed' && Steve.delete_successful_jobs
-        self.destroy
-      else
-        self.save(:validate => false)
+      self.save(:validate => false)
+    end
+
+    ## Get the output of a job, even if the job is in progress,
+    ## live output won't work very well in a multiple app-server
+    ## environment
+    def output
+      if read_attribute(:output)
+        read_attribute(:output)
+      elsif File.exist?(output_file)
+        File.read(output_file) 
       end
     end
     
@@ -164,6 +174,7 @@ module Steve
       self.finished_at = nil
       self.started_at = Time.now.utc
       self.status = 'running'
+      self.job_pid = Process.pid
       self.save(:validate => false)
     end
     
@@ -183,6 +194,15 @@ module Steve
       self.save(:validate => false)
     end
     
+    ## In a state appropriate to be archived?
+    def archive_job?
+      ['failed', 'completed'].include?(self.status)
+    end
+
+    def output_file
+      @output_file ||= File.join('', 'tmp', "steve-job-#{self.id}")
+    end
+
     ## Remove old completed jobs from the database
     def self.cleanup(age = 5.days.ago)
       self.delete_all(["status = 'completed' and run_at < ?", age])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: steve
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 2.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,31 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-18 00:00:00.000000000Z
-dependencies: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: 
 email: support@atechmedia.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/steve/archived_job.rb
 - lib/steve/interface/public/style.css
 - lib/steve/interface/views/completed.haml
 - lib/steve/interface/views/failed.haml
@@ -48,8 +65,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23.2
 signing_key: 
 specification_version: 3
-summary: Deployment Recipes for Appli
+summary: Steve Jobs background job runner
 test_files: []