resque-mongo 1.3.1

data/init.rb

@@ -0,0 +1 @@
+require 'resque'

data/lib/resque.rb

@@ -0,0 +1,224 @@
+require 'mongo'
+
+begin
+  require 'yajl'
+rescue LoadError
+  require 'json'
+end
+
+require 'resque/errors'
+
+require 'resque/failure'
+require 'resque/failure/base'
+
+require 'resque/helpers'
+require 'resque/stat'
+require 'resque/job'
+require 'resque/worker'
+
+module Resque
+  include Helpers
+  extend self
+
+  # Accepts a 'hostname:port' string or a Redis server.
+  def mongo=(server)
+    case server
+    when String
+      host, port = server.split(':')
+      @con = Mongo::Connection.new(host, port)
+      @db = @con.db('monque')
+      @mongo = @db.collection('monque')
+      @workers = @db.collection('workers')
+      @failures = @db.collection('failures')
+      @stats = @db.collection('stats')
+
+      add_indexes
+    else
+      raise "I don't know what to do with #{server.inspect}"
+    end
+  end
+
+
+  # Returns the current Redis connection. If none has been created, will
+  # create a new one.
+  def mongo
+    return @mongo if @mongo
+    self.mongo = 'localhost:27017'
+    self.mongo
+  end
+
+  def mongo_workers
+    return @workers if @workers
+    self.mongo = 'localhost:27017'
+    @workers
+  end
+
+  def mongo_failures
+    return @failures if @failures
+    self.mongo = 'localhost:27017'
+    @failures
+  end
+
+  def mongo_stats
+    return @stats if @stats
+    self.mongo = 'localhost:27017'
+    @stats
+  end
+  
+  def to_s
+    "Mongo Client connected to #{@con.host}"
+  end
+
+  def add_indexes
+    @mongo.create_index :queue
+    @workers.create_index :worker
+    @stats.create_index :stat
+  end
+
+  def drop
+    @mongo.drop
+    @workers.drop
+    @failures.drop
+    @stats.drop
+    @mongo = nil
+  end
+  
+  #
+  # queue manipulation
+  #
+
+  # Pushes a job onto a queue. Queue name should be a string and the
+  # item should be any JSON-able Ruby object.
+  def push(queue, item)
+    watch_queue(queue)
+    mongo << { :queue => queue.to_s, :item => encode(item) }
+  end
+
+  # Pops a job off a queue. Queue name should be a string.
+  #
+  # Returns a Ruby object.
+  def pop(queue)
+    doc = mongo.find_modify( :query => { :queue => queue },
+                             :sort => [:natural, :desc],
+                             :remove => true )
+    decode doc['item']
+  rescue Mongo::OperationFailure => e
+    return nil if e.message =~ /No matching object/
+    raise e
+  end
+
+  # Returns an int representing the size of a queue.
+  # Queue name should be a string.
+  def size(queue)
+    mongo.find(:queue => queue).count
+  end
+
+  # Returns an array of items currently queued. Queue name should be
+  # a string.
+  #
+  # start and count should be integer and can be used for pagination.
+  # start is the item to begin, count is how many items to return.
+  #
+  # To get the 3rd page of a 30 item, paginatied list one would use:
+  #   Resque.peek('my_list', 59, 30)
+  def peek(queue, start = 0, count = 1)
+    res = mongo.find(:queue => queue).sort([:natural, :desc]).skip(start).limit(count).to_a
+    res.collect! { |doc| decode(doc['item']) }
+    
+    if count == 1
+      return nil if res.empty?
+      res.first
+    else
+      return [] if res.empty?
+      res
+    end
+  end
+
+  # Returns an array of all known Resque queues as strings.
+  def queues
+    mongo.distinct(:queue)
+  end
+  
+  # Given a queue name, completely deletes the queue.
+  def remove_queue(queue)
+    mongo.remove(:queue => queue)
+  end
+
+  # Used internally to keep track of which queues we've created.
+  # Don't call this directly.
+  def watch_queue(queue)
+#    redis.sadd(:queues, queue.to_s)
+  end
+
+
+  #
+  # job shortcuts
+  #
+
+  # This method can be used to conveniently add a job to a queue.
+  # It assumes the class you're passing it is a real Ruby class (not
+  # a string or reference) which either:
+  #
+  #   a) has a @queue ivar set
+  #   b) responds to `queue`
+  #
+  # If either of those conditions are met, it will use the value obtained
+  # from performing one of the above operations to determine the queue.
+  #
+  # If no queue can be inferred this method will return a non-true value.
+  #
+  # This method is considered part of the `stable` API.
+  def enqueue(klass, *args)
+    queue = klass.instance_variable_get(:@queue)
+    queue ||= klass.queue if klass.respond_to?(:queue)
+    Job.create(queue, klass, *args)
+  end
+
+  # This method will return a `Resque::Job` object or a non-true value
+  # depending on whether a job can be obtained. You should pass it the
+  # precise name of a queue: case matters.
+  #
+  # This method is considered part of the `stable` API.
+  def reserve(queue)
+    Job.reserve(queue)
+  end
+
+
+  #
+  # worker shortcuts
+  #
+
+  # A shortcut to Worker.all
+  def workers
+    Worker.all
+  end
+
+  # A shortcut to Worker.working
+  def working
+    Worker.working
+  end
+
+
+  #
+  # stats
+  #
+
+  # Returns a hash, similar to redis-rb's #info, of interesting stats.
+  def info
+    return {
+      :pending   => queues.inject(0) { |m,k| m + size(k) },
+      :processed => Stat[:processed],
+      :queues    => queues.size,
+      :workers   => workers.size.to_i,
+      :working   => working.size,
+      :failed    => Stat[:failed],
+      :servers   => ["#{@con.host}:#{@con.port}"]
+    }
+  end
+
+  # Returns an array of all known Resque keys in Redis. Redis' KEYS operation
+  # is O(N) for the keyspace, so be careful - this can be slow for big databases.
+  def keys
+    queues
+  end
+end

data/lib/resque/errors.rb

@@ -0,0 +1,7 @@
+module Resque
+  # Raised whenever we need a queue but none is provided.
+  class NoQueueError < RuntimeError; end
+
+  # Raised when trying to create a job without a class
+  class NoClassError < RuntimeError; end
+end

data/lib/resque/failure.rb

@@ -0,0 +1,63 @@
+module Resque
+  # The Failure module provides an interface for working with different
+  # failure backends.
+  #
+  # You can use it to query the failure backend without knowing which specific
+  # backend is being used. For instance, the Resque web app uses it to display
+  # stats and other information.
+  module Failure
+    # Creates a new failure, which is delegated to the appropriate backend.
+    #
+    # Expects a hash with the following keys:
+    #   :exception - The Exception object
+    #   :worker    - The Worker object who is reporting the failure
+    #   :queue     - The string name of the queue from which the job was pulled
+    #   :payload   - The job's payload
+    def self.create(options = {})
+      backend.new(*options.values_at(:exception, :worker, :queue, :payload)).save
+    end
+
+    #
+    # Sets the current backend. Expects a class descendent of
+    # `Resque::Failure::Base`.
+    #
+    # Example use:
+    #   require 'resque/failure/hoptoad'
+    #   Resque::Failure.backend = Resque::Failure::Hoptoad
+    def self.backend=(backend)
+      @backend = backend
+    end
+
+    # Returns the current backend class. If none has been set, falls
+    # back to `Resque::Failure::Redis`
+    def self.backend
+      return @backend if @backend
+      require 'resque/failure/mongo'
+      @backend = Failure::Mongo
+    end
+
+    # Returns the int count of how many failures we have seen.
+    def self.count
+      backend.count
+    end
+
+    # Returns an array of all the failures, paginated.
+    #
+    # `start` is the int of the first item in the page, `count` is the
+    # number of items to return.
+    def self.all(start = 0, count = 1)
+      backend.all(start, count)
+    end
+
+    # The string url of the backend's web interface, if any.
+    def self.url
+      backend.url
+    end
+    
+    # Clear all failure jobs
+    def self.clear
+      backend.clear
+    end
+    
+  end
+end

data/lib/resque/failure/base.rb

@@ -0,0 +1,58 @@
+module Resque
+  module Failure
+    # All Failure classes are expected to subclass Base.
+    #
+    # When a job fails, a new instance of your Failure backend is created
+    # and #save is called.
+    class Base
+      # The exception object raised by the failed job
+      attr_accessor :exception
+
+      # The worker object who detected the failure
+      attr_accessor :worker
+
+      # The string name of the queue from which the failed job was pulled
+      attr_accessor :queue
+
+      # The payload object associated with the failed job
+      attr_accessor :payload
+
+      def initialize(exception, worker, queue, payload)
+        @exception = exception
+        @worker    = worker
+        @queue     = queue
+        @payload   = payload
+      end
+
+      # When a job fails, a new instance of your Failure backend is created
+      # and #save is called.
+      #
+      # This is where you POST or PUT or whatever to your Failure service.
+      def save
+      end
+
+      # The number of failures.
+      def self.count
+        0
+      end
+
+      # Returns a paginated array of failure objects.
+      def self.all(start = 0, count = 1)
+        []
+      end
+
+      # A URL where someone can go to view failures.
+      def self.url
+      end
+      
+      # Clear all failure objects
+      def self.clear
+      end
+
+      # Logging!
+      def log(message)
+        @worker.log(message)
+      end
+    end
+  end
+end

data/lib/resque/failure/hoptoad.rb

@@ -0,0 +1,88 @@
+require 'net/http'
+
+module Resque
+  module Failure
+    # A Failure backend that sends exceptions raised by jobs to Hoptoad.
+    #
+    # To use it, put this code in an initializer, Rake task, or wherever:
+    #
+    #   Resque::Failure::Hoptoad.configure do |config|
+    #     config.api_key = 'blah'
+    #     config.secure = true
+    #     config.subdomain = 'your_hoptoad_subdomain'
+    #   end
+    class Hoptoad < Base
+      class << self
+        attr_accessor :secure, :api_key, :subdomain
+      end
+
+      def self.url
+        "http://#{subdomain}.hoptoadapp.com/" if subdomain
+      end
+
+      def self.count
+        # We can't get the total # of errors from Hoptoad so we fake it
+        # by asking Resque how many errors it has seen.
+        Stat[:failed]
+      end
+
+      def self.configure
+        yield self
+        Resque::Failure.backend = self
+      end
+
+      def save
+        data = {
+          :api_key       => api_key,
+          :error_class   => exception.class.name,
+          :error_message => "#{exception.class.name}: #{exception.message}",
+          :backtrace     => exception.backtrace,
+          :environment   => {},
+          :session       => {},
+          :request       => {
+            :params => payload.merge(:worker => worker.to_s, :queue => queue.to_s)
+          }
+        }
+
+        send_to_hoptoad(:notice => data)
+      end
+
+      def send_to_hoptoad(data)
+        http = use_ssl? ? :https : :http
+        url = URI.parse("#{http}://hoptoadapp.com/notices/")
+
+        http = Net::HTTP.new(url.host, url.port)
+        headers = {
+          'Content-type' => 'application/json',
+          'Accept' => 'text/xml, application/xml'
+        }
+
+        http.read_timeout = 5 # seconds
+        http.open_timeout = 2 # seconds
+        http.use_ssl = use_ssl?
+
+        begin
+          response = http.post(url.path, Resque.encode(data), headers)
+        rescue TimeoutError => e
+          log "Timeout while contacting the Hoptoad server."
+        end
+
+        case response
+        when Net::HTTPSuccess then
+          log "Hoptoad Success: #{response.class}"
+        else
+          body = response.body if response.respond_to? :body
+          log "Hoptoad Failure: #{response.class}\n#{body}"
+        end
+      end
+
+      def use_ssl?
+        self.class.secure
+      end
+
+      def api_key
+        self.class.api_key
+      end
+    end
+  end
+end

data/lib/resque/failure/mongo.rb

@@ -0,0 +1,32 @@
+module Resque
+  module Failure
+    # A Failure backend that stores exceptions in Mongo. Very simple but
+    # works out of the box, along with support in the Resque web app.
+    class Mongo < Base
+      def save
+        data = {
+          :failed_at => Time.now.strftime("%Y/%m/%d %H:%M:%S"),
+          :payload   => payload,
+          :error     => exception.to_s,
+          :backtrace => exception.backtrace,
+          :worker    => worker.to_s,
+          :queue     => queue
+        }
+        Resque.mongo_failures << data
+      end
+
+      def self.count
+        Resque.mongo_failures.count
+      end
+
+      def self.all(start = 0, count = 1)
+        Resque.mongo_failures.find().sort([:natural, :desc]).skip(start).limit(count).to_a
+      end
+      
+      def self.clear
+        Resque.mongo_failures.remove
+      end
+      
+    end
+  end
+end