Module: Resque

Extended by:
Resque
Includes:
Helpers
Included in:
Resque
Defined in:
lib/resque.rb,
lib/resque/job.rb,
lib/resque/stat.rb,
lib/resque/coder.rb,
lib/resque/queue.rb,
lib/resque/errors.rb,
lib/resque/plugin.rb,
lib/resque/server.rb,
lib/resque/worker.rb,
lib/resque/failure.rb,
lib/resque/helpers.rb,
lib/resque/version.rb,
lib/resque/multi_queue.rb,
lib/resque/failure/base.rb,
lib/resque/failure/redis.rb,
lib/resque/failure/hoptoad.rb,
lib/resque/failure/airbrake.rb,
lib/resque/failure/multiple.rb,
lib/resque/multi_json_coder.rb,
lib/resque/failure/thoughtbot.rb,
lib/resque/server/test_helper.rb

Defined Under Namespace

Modules: Failure, Helpers, Plugin, Stat, TestHelper Classes: Coder, DecodeException, DirtyExit, EncodeException, Job, MultiJsonCoder, MultiQueue, NoClassError, NoQueueError, Queue, QueueDestroyed, Server, Worker

Constant Summary collapse

Version = 
VERSION = '1.20.0'

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Helpers

#classify, #constantize, #decode, #encode

Instance Attribute Details

#after_fork(&block) ⇒ Object

The ‘after_fork` hook will be run in the child process and is passed the current job. Any changes you make, therefore, will only live as long as the job currently being processed.

Call with a block to set the hook. Call with no arguments to return the hook.



115
116
117
 
# File 'lib/resque.rb', line 115

def after_fork(&block)
  block ? (@after_fork = block) : @after_fork
end

#before_first_fork(&block) ⇒ Object

The ‘before_first_fork` hook will be run in the parent process only once, before forking to run the first job. Be careful- any changes you make will be permanent for the lifespan of the worker.

Call with a block to set the hook. Call with no arguments to return the hook.



88
89
90
 
# File 'lib/resque.rb', line 88

def before_first_fork(&block)
  block ? (@before_first_fork = block) : @before_first_fork
end

#before_fork(&block) ⇒ Object

The ‘before_fork` hook will be run in the parent process before every job, so be careful- any changes you make will be permanent for the lifespan of the worker.

Call with a block to set the hook. Call with no arguments to return the hook.



102
103
104
 
# File 'lib/resque.rb', line 102

def before_fork(&block)
  block ? (@before_fork = block) : @before_fork
end

#coder ⇒ Object

Encapsulation of encode/decode. Overwrite this to use it across Resque. This defaults to MultiJson for backwards compatibilty.



57
58
59
 
# File 'lib/resque.rb', line 57

def coder
  @coder ||= MultiJsonCoder.new
end

#inline ⇒ Object Also known as: inline?

Returns the value of attribute inline.



126
127
128
 
# File 'lib/resque.rb', line 126

def inline
  @inline
end

Instance Method Details

#dequeue(klass, *args) ⇒ Object

This method can be used to conveniently remove a job from 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 raise a ‘Resque::NoQueueError`

If no args are given, this method will dequeue all jobs matching the provided class. See ‘Resque::Job.destroy` for more information.

Returns the number of jobs destroyed.

Example:

# Removes all jobs of class `UpdateNetworkGraph`
Resque.dequeue(GitHub::Jobs::UpdateNetworkGraph)

# Removes all jobs of class `UpdateNetworkGraph` with matching args.
Resque.dequeue(GitHub::Jobs::UpdateNetworkGraph, 'repo:135325')

This method is considered part of the ‘stable` API.



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/resque.rb', line 290

def dequeue(klass, *args)
  # Perform before_dequeue hooks. Don't perform dequeue if any hook returns false
  before_hooks = Plugin.before_dequeue_hooks(klass).collect do |hook|
    klass.send(hook, *args)
  end
  return if before_hooks.any? { |result| result == false }

  Job.destroy(queue_from_class(klass), klass, *args)

  Plugin.after_dequeue_hooks(klass).each do |hook|
    klass.send(hook, *args)
  end
end

#enqueue(klass, *args) ⇒ Object

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 raise a ‘Resque::NoQueueError`

Returns true if the job was queued, nil if the job was rejected by a before_enqueue hook.

This method is considered part of the ‘stable` API.



234
235
236
 
# File 'lib/resque.rb', line 234

def enqueue(klass, *args)
  enqueue_to(queue_from_class(klass), klass, *args)
end

#enqueue_to(queue, klass, *args) ⇒ Object

Just like ‘enqueue` but allows you to specify the queue you want to use. Runs hooks.

‘queue` should be the String name of the queue you’re targeting.

Returns true if the job was queued, nil if the job was rejected by a before_enqueue hook.

This method is considered part of the ‘stable` API.



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/resque.rb', line 247

def enqueue_to(queue, klass, *args)
  # Perform before_enqueue hooks. Don't perform enqueue if any hook returns false
  before_hooks = Plugin.before_enqueue_hooks(klass).collect do |hook|
    klass.send(hook, *args)
  end
  return nil if before_hooks.any? { |result| result == false }

  Job.create(queue, klass, *args)

  Plugin.after_enqueue_hooks(klass).each do |hook|
    klass.send(hook, *args)
  end

  return true
end

#info ⇒ Object

Returns a hash, similar to redis-rb’s #info, of interesting stats.



364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/resque.rb', line 364

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   => [redis_id],
    :environment  => ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
  }
end

#keys ⇒ Object

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.



379
380
381
382
383
 
# File 'lib/resque.rb', line 379

def keys
  redis.keys("*").map do |key|
    key.sub("#{redis.namespace}:", '')
  end
end

#list_range(key, start = 0, count = 1) ⇒ Object

Does the dirty work of fetching a range of items from a Redis list and converting them into Ruby objects.



187
188
189
190
191
192
193
194
195
 
# File 'lib/resque.rb', line 187

def list_range(key, start = 0, count = 1)
  if count == 1
    decode redis.lindex(key, start)
  else
    Array(redis.lrange(key, start, start+count-1)).map do |item|
      decode item
    end
  end
end

#peek(queue, start = 0, count = 1) ⇒ Object

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)



181
182
183
 
# File 'lib/resque.rb', line 181

def peek(queue, start = 0, count = 1)
  queue(queue).slice start, count
end

#pop(queue) ⇒ Object

Pops a job off a queue. Queue name should be a string.

Returns a Ruby object.



159
160
161
162
163
164
165
 
# File 'lib/resque.rb', line 159

def pop(queue)
  begin
    queue(queue).pop(true)
  rescue ThreadError
    nil
  end
end

#push(queue, item) ⇒ Object

Pushes a job onto a queue. Queue name should be a string and the item should be any JSON-able Ruby object.

Resque works generally expect the ‘item` to be a hash with the following keys:

class - The String name of the job to run.
 args - An Array of arguments to pass the job. Usually passed
        via `class.to_class.perform(*args)`.

Example

Resque.push('archive', :class => 'Archive', :args => [ 35, 'tar' ])

Returns nothing



152
153
154
 
# File 'lib/resque.rb', line 152

def push(queue, item)
  queue(queue) << item
end

#queue(name) ⇒ Object

Return the Resque::Queue object for a given name



209
210
211
 
# File 'lib/resque.rb', line 209

def queue(name)
  @queues[name.to_s]
end

#queue_from_class(klass) ⇒ Object

Given a class, try to extrapolate an appropriate queue based on a class instance variable or ‘queue` method.



306
307
308
309
 
# File 'lib/resque.rb', line 306

def queue_from_class(klass)
  klass.instance_variable_get(:@queue) ||
    (klass.respond_to?(:queue) and klass.queue)
end

#queues ⇒ Object

Returns an array of all known Resque queues as strings.



198
199
200
 
# File 'lib/resque.rb', line 198

def queues
  Array(redis.smembers(:queues))
end

#redis ⇒ Object

Returns the current Redis connection. If none has been created, will create a new one.



64
65
66
67
68
 
# File 'lib/resque.rb', line 64

def redis
  return @redis if @redis
  self.redis = Redis.respond_to?(:connect) ? Redis.connect : "localhost:6379"
  self.redis
end

#redis=(server) ⇒ Object

Accepts:

1. A 'hostname:port' String
2. A 'hostname:port:db' String (to select the Redis db)
3. A 'hostname:port/namespace' String (to set the Redis namespace)
4. A Redis URL String 'redis://host:port'
5. An instance of `Redis`, `Redis::Client`, `Redis::DistRedis`,
   or `Redis::Namespace`.



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/resque.rb', line 31

def redis=(server)
  case server
  when String
    if server =~ /redis\:\/\//
      redis = Redis.connect(:url => server, :thread_safe => true)
    else
      server, namespace = server.split('/', 2)
      host, port, db = server.split(':')
      redis = Redis.new(:host => host, :port => port,
        :thread_safe => true, :db => db)
    end
    namespace ||= :resque

    @redis = Redis::Namespace.new(namespace, :redis => redis)
  when Redis::Namespace
    @redis = server
  else
    @redis = Redis::Namespace.new(:resque, :redis => server)
  end
  @queues = Hash.new { |h,name|
    h[name] = Resque::Queue.new(name, @redis, coder)
  }
end

#redis_id ⇒ Object 



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/resque.rb', line 70

def redis_id
  # support 1.x versions of redis-rb
  if redis.respond_to?(:server)
    redis.server
  elsif redis.respond_to?(:nodes) # distributed
    redis.nodes.map { |n| n.id }.join(', ')
  else
    redis.client.id
  end
end

#remove_queue(queue) ⇒ Object

Given a queue name, completely deletes the queue.



203
204
205
206
 
# File 'lib/resque.rb', line 203

def remove_queue(queue)
  queue(queue).destroy
  @queues.delete(queue.to_s)
end

#remove_worker(worker_id) ⇒ Object

A shortcut to unregister_worker useful for command line tool



354
355
356
357
 
# File 'lib/resque.rb', line 354

def remove_worker(worker_id)
  worker = Resque::Worker.find(worker_id)
  worker.unregister_worker
end

#reserve(queue) ⇒ Object

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.



316
317
318
 
# File 'lib/resque.rb', line 316

def reserve(queue)
  Job.reserve(queue)
end

#size(queue) ⇒ Object

Returns an integer representing the size of a queue. Queue name should be a string.



169
170
171
 
# File 'lib/resque.rb', line 169

def size(queue)
  queue(queue).size
end

#to_s ⇒ Object 



122
123
124
 
# File 'lib/resque.rb', line 122

def to_s
  "Resque Client connected to #{redis_id}"
end

#validate(klass, queue = nil) ⇒ Object

Validates if the given klass could be a valid Resque job

If no queue can be inferred this method will raise a ‘Resque::NoQueueError`

If given klass is nil this method will raise a ‘Resque::NoClassError`



325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/resque.rb', line 325

def validate(klass, queue = nil)
  queue ||= queue_from_class(klass)

  if !queue
    raise NoQueueError.new("Jobs must be placed onto a queue.")
  end

  if klass.to_s.empty?
    raise NoClassError.new("Jobs must be given a class.")
  end
end

#workers ⇒ Object

A shortcut to Worker.all



343
344
345
 
# File 'lib/resque.rb', line 343

def workers
  Worker.all
end

#working ⇒ Object

A shortcut to Worker.working



348
349
350
 
# File 'lib/resque.rb', line 348

def working
  Worker.working
end