http_resque 0.0.1 → 0.0.2

data/README.markdown

@@ -0,0 +1,3 @@
+HTTP Resque
+===========
+Docs forthcoming.

data/bin/http_resque

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+
+# This wraps the Resque process with a thin HTTP API which enables you to manipulate jobs using HTTP requests
+# and run jobs synchronously, off-box, for the purposes of integration testing background jobs. This is
+# necessary because background jobs fail notoriously often in production and so they need integration -- not
+# unit -- tests. This helps you to cleanly write those integration tests.
+#
+# Usage:
+# QUEUE=* http_resque -p 8080
+# The server uses port 4567 by default. Use -p to specify an alternate port.
+# You'll note that the QUEUE environment variable is used just like it is when running `rake resque:work`.
+
+# Once it's started, you can access these URLs to manipulate jobs:
+#   GET    /queues/:queue/jobs
+#   DELETE /queues/:queue/jobs
+#   POST   /queues/:queue/jobs
+#   GET    /queues/:queue/result_of_oldest_job
+
+require "sinatra/base"
+require "thin"
+require "resque"
+require "rake"
+require "json"
+
+# Load the Rakefile which should in turn require all of their Resque job classes.
+# TODO(philc): The path to this Rakefile should be an argument.
+load "./Rakefile"
+
+class HttpResque < Sinatra::Base
+  settings.server = "thin"
+
+  STDOUT.sync = STDERR.sync = true
+
+  # Run rake resque:work in a background process. It will exit when this process exits.
+  fork { Rake::Task["resque:work"].invoke }
+
+  settings.port = ARGV.include?("-p") ? ARGV[ARGV.index("-p") + 1] : ENV["PORT"]
+
+  get "/" do
+    "http_resque is here."
+  end
+
+  # The Resque representation of up to 25 jobs in this queue, *oldest* first. Resque jobs look like this:
+  #   { "class"=>"DeployBuild", "args"=>["my_embed_code", "my_youtube_synd_id"] }
+  get "/queues/:queue/jobs" do
+    (Resque.peek(params[:queue], 0, 25) || []).to_json
+  end
+
+  delete "/queues/:queue/jobs" do
+    Resque.remove_queue(params[:queue])
+    nil
+  end
+
+  # Create a new job.
+  # - queue: the queue to enqueue this job into.
+  # - arguments: optional; an array of arguments for the Resque job.
+  post "/queues/:queue/jobs" do
+    halt(400, "Provide a valid JSON body.") unless json_body
+    klass = json_body["class"]
+    halt(400, "Specify a class.") unless klass
+    klass = Object.const_get(klass)
+    Resque.enqueue_to(params[:queue], klass, *json_body["arguments"])
+    nil
+  end
+
+  # Executes the job at the head of this queue (the oldest job), and blocks until it's finished.
+  # This is useful for scripting integration tests which verify that a background job is working correctly.
+  get "/queues/:queue/result_of_oldest_job" do
+    job = Resque::Job.reserve(params[:queue])
+    halt(404, "No jobs left in #{params[:queue]}") unless job
+    begin
+      job.perform
+    rescue => error
+      halt(500, "This job raised an exception when run: " +
+          "#{job.inspect}\n#{error.class}: #{error.message}\n#{error.backtrace.join("\n")}")
+    end
+    nil
+  end
+
+  def json_body() @json_body ||= JSON.parse(request.body.read) rescue nil end
+
+  run! if app_file == $0
+end

data/http_resque.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Phil Crosby"]
   s.email       = ["phil.crosby@gmail.com"]
   s.homepage    = "http://github.com/philc/http_resque"
-  s.summary     = "A light HTTP wrapper around Resque, so you can schedule and test jobs programmatically."
+  s.summary     = "A small HTTP wrapper around Resque, so you can schedule and test jobs over HTTP."
 
   s.rubyforge_project = "http_resque"
 

data/lib/http_resque/version.rb

@@ -1,3 +1,3 @@
 module HttpResque
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: http_resque
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Phil Crosby
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-19 00:00:00 -07:00
+date: 2012-03-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -91,8 +91,8 @@ dependencies:
 description: 
 email: 
 - phil.crosby@gmail.com
-executables: []
-
+executables: 
+- http_resque
 extensions: []
 
 extra_rdoc_files: []
@@ -100,7 +100,9 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README.markdown
 - Rakefile
+- bin/http_resque
 - http_resque.gemspec
 - lib/http_resque.rb
 - lib/http_resque/version.rb
@@ -137,6 +139,6 @@ rubyforge_project: http_resque
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: A light HTTP wrapper around Resque, so you can schedule and test jobs programmatically.
+summary: A small HTTP wrapper around Resque, so you can schedule and test jobs over HTTP.
 test_files: []