async_job 0.0.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jimmy Thrasher
+
+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.rdoc

@@ -0,0 +1,19 @@
+= async_job
+
+Description goes here.
+
+== Contributing to async_job
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Jimmy Thrasher. See LICENSE.txt for
+further details.
+

data/lib/async_job.rb

@@ -0,0 +1,3 @@
+require 'async_job/results'
+require 'async_job/job'
+require 'async_job/controller_methods'

data/lib/async_job/controller_methods.rb

@@ -0,0 +1,31 @@
+module AsyncJob
+  module ControllerMethods
+    module Client
+      def render_job_queued(results, options = {})
+        response['Location'] = make_results_url(results)
+        response['Retry-Interval'] = options[:retry_interval].to_s || '1.0'
+        head 202
+      end
+    end
+
+    def show
+      results = AsyncJob::Results.find(params[:id])
+
+      if results.results
+        logger.debug "Returning async job results: #{results.inspect}"
+        if results.success?
+          if stale?(:etag => results.results)
+            render :json => results.results, :status => :ok
+          end
+        else
+          render :json => results.results, :status => :unprocessable_entity
+        end
+        results.destroy
+      else
+        render_job_queued(results)
+      end
+    end
+
+    include Client
+  end
+end

data/lib/async_job/job.rb

@@ -0,0 +1,30 @@
+module AsyncJob
+  class Job < Delayed::PerformableMethod
+    def self.perform_async(user, object, method, *args)
+      AsyncJob::Results.create.tap do |results|
+        Delayed::Job.enqueue(self.new(object, method, args, results.id))
+      end
+    end
+
+    def initialize(object, method, args, results_id)
+      super(object, method, args)
+      @results_id = results_id
+    end
+
+    def perform
+      job_results = AsyncJob::Results.find(@results_id)
+
+      begin
+        results = super
+        job_results.success = true
+        job_results.results = results
+      rescue => error
+        job_results.success = false
+        job_results.results = [error.message, error.backtrace]
+        Rails.logger.error "Error processing async job: #{error.message}\n#{error.backtrace.join("\n")}"
+      end
+
+      job_results.save
+    end
+  end
+end

data/lib/async_job/results.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+
+module AsyncJob
+  class Results < ActiveRecord::Base
+    set_table_name "async_job_results"
+
+    serialize :results
+  end
+end

data/lib/generators/async_job_migration/async_job_migration_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class AsyncJobMigrationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  # Implement the required interface for Rails::Generators::Migration.
+  #
+  def self.next_migration_number(dirname) #:nodoc:
+    next_migration_number = current_migration_number(dirname) + 1
+    if ActiveRecord::Base.timestamped_migrations
+      [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+    else
+      "%.3d" % next_migration_number
+    end
+  end
+
+  def create_migration_file
+    if defined?(ActiveRecord)
+      migration_template 'migration.rb', 'db/migrate/create_async_job_results.rb'
+    end
+  end
+end

data/lib/generators/async_job_migration/templates/migration.rb

@@ -0,0 +1,15 @@
+class CreateAsyncJobResults < ActiveRecord::Migration
+  def self.up
+    create_table :async_job_results, :force => true do |t|
+      t.boolean :success
+      t.text :results
+      t.timestamps
+    end
+
+    add_index :async_job_results, [:id], :name => 'async_job_results_id'
+  end
+
+  def self.down
+    drop_table :async_job_results
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'async_job'
+
+class Test::Unit::TestCase
+end

data/test/test_async_job.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestAsyncJob < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: async_job
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jimmy Thrasher
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-14 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+description: ""
+email: jimmy@jimmythrasher.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- lib/async_job.rb
+- lib/async_job/controller_methods.rb
+- lib/async_job/job.rb
+- lib/async_job/results.rb
+- lib/generators/async_job_migration/async_job_migration_generator.rb
+- lib/generators/async_job_migration/templates/migration.rb
+- LICENSE.txt
+- README.rdoc
+- test/helper.rb
+- test/test_async_job.rb
+has_rdoc: true
+homepage: http://github.com/jjthrash/async_job
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -4254545143270447403
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Simple asynchronous jobs for Rails
+test_files: 
+- test/helper.rb
+- test/test_async_job.rb