afterparty 0.0.21 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: 1746d9cd2e5dee4f459c02cf8a0bef335de1a05d
-  data.tar.gz: 86b2eb38f0c9113b8515fbe18ad8d3635a9dc0e9
+  metadata.gz: 5d17a9d413c53f3fbac4701c2c6b3019141b94f3
+  data.tar.gz: de82e598bc016faa80d7fa4879ca0084f372588c
 !binary "U0hBNTEy":
-  metadata.gz: 431465cc60c4fb3abbfc63f8f4294367baa94507c4ce04b9181d3afbd5ed4546d3b3d9a79a0178a37814fcbfe468def7fd8c36633baf47d7d55ce384c6929828
-  data.tar.gz: a8bcde980355c3a56a668450e274452d0ef10c0274e15bcc609a1a8ae3eb9d596c854ff60616e8b9e0648388c7f19974fdcfc6bb64dd8d806f0e37424355f093
+  metadata.gz: abb7fba4469a92003e3a439ae9514088e5f9312547216a75386856af95cd3e6ecda7d7e0b4259556fb778bc67a4d3db0b10618a3c01a13dcd15545901ac49472
+  data.tar.gz: 7d475a34daa110341d5401cb08a6f1186add9a584aaffe4f0551e5337d8633e4431aca2c9b66d2c91d45e87827975d9e6f9712aa7c2ba64038925f2fbfd5b45a

data/.rspec

@@ -1,2 +1 @@
 --color
---format documentation

data/.travis.yml

@@ -3,4 +3,6 @@ rvm:
   - 1.9.3
   - 2.0.0
 services:
-  - redis-server
+  - redis-server
+env:
+  - AFTERPARTY_JOB_TIME=15 AFTERPARTY_SLOW_TIME=50

data/Gemfile

@@ -7,4 +7,6 @@ gem 'rails', github: "rails/rails", branch: "jobs", tag: "v4.0.0.rc1"
 gem 'awesome_print'
 gem 'guard-rspec'
 gem 'ruby_gntp'
-gem 'redis'
+gem 'redis'
+gem 'sqlite3'
+gem 'genspec'

data/README.md

@@ -1,10 +1,10 @@
 # Afterparty
 
-A Rails 4 compatible queue with support for executing jobs in the future and serialization with Redis.
+[![Build Status](https://travis-ci.org/hstove/afterparty.png?branch=master)](https://travis-ci.org/hstove/afterparty)
 
-## Installation
+A Rails 3 & 4 compatible queue with support for executing jobs in the future and persistence with ActiveRecord.
 
-Make sure you've installed [redis](http://redis.io) on your machine.
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -15,16 +15,11 @@ gem 'afterparty'
 And then execute:
 
     $ bundle
+    $ rails g afterparty
+    $ rake db:migrate
 
-Or install it yourself as:
-
-    $ gem install afterparty
-
-In your desired application environment, like `application.rb`:
-
-~~~Ruby
-config.queue = Afterparty::RedisQueue.new
-~~~
+This will create an initializer in `config/initializers/afterparty.rb`. It initializes a queue at
+`Rails.configuration.queue` for you to pass jobs to.
 
 ## Usage
 
@@ -41,11 +36,60 @@ end
 Then add it to the queue at any time.
 
 ~~~Ruby
-Rails.queue << Job.new
+Rails.configuration.queue << Job.new
 ~~~
 
 If your job responds to an `execute_at` method, the queue will wait to process that job until the specified time.
 
+### Running jobs
+
+You can start a worker in a separate process for executing jobs by calling `rake jobs:work`.
+
+### Helper jobs
+
+Afterparty provides helper job wrappers for executing arbitrary methods or mailers.
+
+~~~Ruby
+# pass an object, method, and arguments 
+
+mailer_job = Afterparty::MailerJob.new UserMailer, :welcome, @user
+mailer_job.execute_at = Time.now + 20.minutes
+Rails.configuration.queue << mailer_job
+
+job = Afterparty::BasicJob.new @user, :reset_password
+Rails.configuration.queue << mailer_job
+~~~
+
+### Dashboard
+
+This gem provides a handy dashboard for inspecting, debugging, and re-running jobs.
+
+Visit [http://localhost:3000/afterparty/](http://localhost:3000/afterparty/) and login with
+`admin` and `password`. You can change the authentication strategy in `config/initializers/afterparty.rb` to something like this:
+
+~~~Ruby
+Rails.configuration.queue.config_login do |username, password|
+  user = User.authenticate(username, password)
+  !user.nil? && user.is_admin?
+end
+~~~
+
+### Unicorn configuration
+
+If you're using Unicorn as your application server, you can run a worker thread asynchronously by adding a few lines to your `unicorn.rb`:
+
+~~~Ruby
+
+@jobs_pid = nil
+
+before_fork do |server, worker|
+  @jobs_pid ||= spawn("bundle exec rake jobs:work")
+
+  # ... the rest of your configuration
+~~~
+
+This has the advantage of, for example, staying within Heroku's free tier by not running a worker dyno.
+
 ## Contributing
 
 1. Fork it

data/afterparty.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   
   spec.add_dependency "redis"
+  spec.add_dependency "iconv"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/app/assets/javascripts/afterparty.js.coffee

@@ -0,0 +1,14 @@
+$(document).ready ->
+  # $('.debug').click (e) ->
+  #   $el = $(e.target)
+  #   $tr = $el.parents('tr')
+  #   $tr.next().toggle()
+  #   $tr.toggleClass('debugged')
+  #   false
+  $('.job-row').click (e) ->
+    $el = $(e.target)
+    return true if $el.hasClass('job-action')
+    $tr = $el.parents('tr')
+    $tr.next().toggle()
+    $tr.toggleClass('debugged')
+    false

data/app/assets/stylesheets/afterparty.css.sass

@@ -0,0 +1,91 @@
+body
+  :font-family helvetica
+  :background-color whitesmoke
+  :color lighten(black,30%)
+  :margin 0 20px
+
+a:visited, a
+  :color rgb(96, 89, 180)
+  :text-decoration none
+
+span
+  :font-size 12px
+
+.job-table
+  :border-spacing 0
+  :max-width 100%
+  :margin 0px auto
+  thead tr:first-child
+    th
+      :border-width 1px 1px 1px 0
+      &:first-child
+        :border-width 1px 1px 1px 1px
+    th:first-child
+      :border-top-left-radius 2px
+    th:last-child
+      :border-top-right-radius 2px
+  tbody tr:last-child
+    td:first-child
+      :border-bottom-left-radius 2px
+    td:last-child
+      :border-bottom-right-radius 2px
+  tr
+    td, th
+      :border 1px solid #ccc
+      :border-width 0 1px 1px 0
+      :background-color lighten(whitesmoke, 5%)
+      :padding 12px 5px
+      :text-align left
+      :vertical-align middle
+      :word-wrap break-word
+      &:nth-child(2)
+        :width 70%
+      &:first-child
+        :border-width 0 1px 1px 1px
+      &:first-child, &:last-child
+        :width 15% !important
+    &.debugged
+      td
+        :background-color rgba(255,255,0,0.25)
+    &.job-row
+      :cursor pointer
+      h3
+        :margin 0
+      &:hover
+        td
+          :background-color rgba(0,0,0,0.15)
+        .description
+          :color white
+  .debug-row
+    :display none
+    :max-width 100%
+    td pre
+      :word-wrap break-word
+      :white-space pre-wrap 
+
+.distance-past, .distance-future
+  :font-size 12px
+.distance-future
+  :color darken(rgb(0,255,0), 20%)
+.distance-past
+  :color rgba(255,0,0,0.6)
+
+.description
+  :font-size 12px
+  :color #bbb
+  :margin-left 10px
+
+.error-description
+  :color lighten(red, 10%)
+
+.job-action
+  :text-decoration underline
+  :font-size 12px
+  :margin 0 2px
+
+.job_id
+  :color #bbb
+  :font-weight 700
+
+.notice
+  :color lighten(green, 10%)

data/app/controllers/afterparty/dashboard_controller.rb

@@ -0,0 +1,44 @@
+module Afterparty
+  class DashboardController < ApplicationController
+    before_filter :authenticate
+    layout false
+    before_filter :find_job, only: [:run, :destroy, :run_again]
+
+    def index
+      @queues = Afterparty.queues
+      if params[:completed]
+        @jobs = AfterpartyJob.completed.limit(20)
+      else
+        @jobs = queue.jobs
+      end
+    end
+
+    def run
+      queue.run @job
+      flash[:notice] = "You successfully completed job ##{@job.id}."
+      redirect_to afterparty_engine.dashboard_path(completed: true)
+    end
+
+    def destroy
+      @job.destroy
+      flash[:notice] = "You have successfully destroyed job ##{@job.id}."
+      redirect_to afterparty_engine.dashboard_path
+    end
+
+    private
+
+    def queue
+      Rails.configuration.queue
+    end
+
+    def find_job
+      @job = AfterpartyJob.find(params[:id])
+    end
+
+    def authenticate
+      authenticate_or_request_with_http_basic do |username, password|
+        queue.authenticate(username, password)
+      end
+    end
+  end
+end

data/app/views/afterparty/dashboard/index.html.haml

@@ -0,0 +1,85 @@
+!!!
+%html
+
+  %head
+    %title== #{Rails.application.class.parent_name} Job Queue
+    %meta{"http-equiv"=>"Content-Type", :content=>"text/html; charset=utf-8"}
+    / %meta{name: "viewport", content: "width=device-width, initial-scale=1.0"}
+    = stylesheet_link_tag "afterparty"
+    = javascript_include_tag "jquery", "afterparty"
+    = csrf_meta_tag
+    = favicon_link_tag
+    = yield(:head)
+
+  %body
+    %h1
+      Viewing
+      - if params[:completed]
+        = pluralize @jobs.size, "completed job"
+        %h3= link_to "View Job Queue", afterparty_engine.dashboard_path
+      - else
+        = pluralize @jobs.size, "job"
+        %h3= link_to "View Completed Jobs", afterparty_engine.dashboard_path(completed: true)
+    - if notice
+      %p.notice= notice
+    %table.job-table
+      %thead
+        %tr
+          %th Execute At
+      %tbody
+        - if @jobs.empty?
+          %tr
+            %td{colspan: 3}
+              %em No jobs to show...
+        - else
+          - @jobs.each do |job_container|
+            - job = job_container.reify
+            %tr.job-row
+              %td
+                %h3
+                  - if job
+                    = link_to job.class.to_s, "#", class: 'debug'
+                    - if job.respond_to? :description
+                      %span.description= job.description.html_safe
+                  - elsif job_container.has_error
+                    %sp.error-description= job_container.error_message
+                  - else
+                    %em Error marshaling job
+                - if job_container.completed_at
+                  %span.distance-future= "Completed #{time_ago_in_words(job_container.completed_at)} ago"
+                - else
+                  - distance = time_ago_in_words(job_container.execute_at)
+                  - if job_container.execute_at > Time.now
+                    %span.distance-future= "Scheduled to execute in #{distance}"
+                  - else
+                    %span.distance-past= "Scheduled to execute #{distance} ago"
+                %span.job_id== ##{job_container.id} #{job_container.queue}
+                - if params[:completed]
+                  = link_to "run again", afterparty_engine.run_job_path(id: job_container.id), class: 'job-action'
+                - else
+                  = link_to "run", afterparty_engine.run_job_path(id: job_container.id), class: 'job-action'
+                  = link_to "delete", afterparty_engine.destroy_job_path(id: job_container.id), class: 'job-action'
+            %tr.debug-row
+              %td
+                - if job
+                  = debug job
+                - else
+                  %p
+                    %strong YAML dump:
+                    = job_container.job_dump
+                - if job_container.has_error
+                  %p
+                    %strong Error Message:
+                    = job_container.error_message
+                  - if job_container.error_backtrace
+                    %p
+                      %strong Error Backtrace:
+                      = job_container.error_backtrace.gsub("\n","<br>")
+                - if job_container.completed_at
+                  %p
+                    %strong Completed At:
+                    = job_container.completed_at.strftime("%B %d, %Y at %l:%I %P")
+
+%p
+  Current Time:
+  = Time.now.strftime("%B %d, %Y at %l:%M %P")

data/config/routes.rb

@@ -0,0 +1,9 @@
+Afterparty::Engine.routes.draw do
+  get "/" => "afterparty/dashboard#index", as: :dashboard
+  get "/run" => "afterparty/dashboard#run", as: :run_job
+  get "/delete" => "afterparty/dashboard#destroy", as: :destroy_job
+end
+
+Rails.application.routes.draw do
+  mount Afterparty::Engine, at: "afterparty", as: "afterparty_engine"
+end

data/lib/afterparty.rb

@@ -1,17 +1,61 @@
 require 'logger'
 require 'afterparty/queue_helpers'
-require 'afterparty/redis_queue'
-require 'redis'
+require 'yaml'
 Dir[File.expand_path('../afterparty/*', __FILE__)].each { |f| require f }
 
 
 module Afterparty
-  @@redis = Redis.new
+  def self.clear namespace=:default
+    redis_call namespace, :del
+  end
+
+  def self.redis_call namespace, command, *args
+    @@redis.send(command, redis_queue_name(namespace), *args)
+  end
+
+  def self.redis_queue_name namespace=:default
+    "afterparty_#{namespace}_queue"
+  end
 
-  def self.redis
-    @@redis
+  def self.queues
+    # @@redis.smembers "afterparty_queues"
   end
-  def self.redis=(redis)
-    @@redis = redis
+
+  # return timestamp of :execute_at or current time
+  def self.queue_time job
+    time = job_valid?(job) ? job.execute_at : DateTime.now
+  end
+
+  # returns true if job has an :execute_at value
+  def self.job_valid? job
+    job.respond_to?(:execute_at) && !job.execute_at.nil?
   end
+  
+  def self.load(raw)
+    begin
+      # postgres converts it to utf-8
+      # raw.encode!("ascii")
+      begin
+        # job = Marshal.load(raw)
+        # job = Marshal.load(job) if String === job
+        return YAML.load(raw)
+      rescue ArgumentError => e
+        # lots of yaml load errors are because something that hasn't been
+        # required. recursively require on these errors
+        # Invoke the autoloader and try again if object's class is undefined
+        if e.message =~ /undefined class\/module (.*)$/
+          # puts "autoloading #{$1}"
+          $1.constantize rescue return nil
+        end
+        return load(raw)
+      end
+    rescue Exception => e
+      puts e
+      puts "Exception while unmarshaling a job:"
+      puts e.message
+      puts e.backtrace
+      return nil
+    end
+  end
+
 end