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/errors.rb,
lib/resque/server.rb,
lib/resque/worker.rb,
lib/resque/failure.rb,
lib/resque/helpers.rb,
lib/resque/version.rb,
lib/resque/failure/base.rb,
lib/resque/failure/redis.rb,
lib/resque/failure/hoptoad.rb,
lib/resque/failure/multiple.rb

Defined Under Namespace

Modules: Failure, Helpers, Stat Classes: Job, NoClassError, NoQueueError, Server, Worker

Constant Summary collapse

Version = 
'0.0.5'

Instance Method Summary collapse

Methods included from Helpers

#classify, #constantize, #decode, #encode

Instance Method Details

#after_fork ⇒ Object

Returns the after_fork proc



67
68
69
 
# File 'lib/resque.rb', line 67

def after_fork
  @after_fork
end

#after_fork=(after_fork) ⇒ Object

Set a proc that will be called after the worker forks



62
63
64
 
# File 'lib/resque.rb', line 62

def after_fork=(after_fork)
  @after_fork = after_fork
end

#before_fork ⇒ Object

Returns the before_fork proc



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

def before_fork
  @before_fork
end

#before_fork=(before_fork) ⇒ Object

Set a proc that will be called once before the worker forks



52
53
54
 
# File 'lib/resque.rb', line 52

def before_fork=(before_fork)
  @before_fork = before_fork
end

#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.



190
191
192
 
# File 'lib/resque.rb', line 190

def dequeue(klass, *args)
  Job.destroy(queue_from_class(klass), klass, *args)
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`

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



159
160
161
 
# File 'lib/resque.rb', line 159

def enqueue(klass, *args)
  Job.create(queue_from_class(klass), klass, *args)
end

#info ⇒ Object

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



237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/resque.rb', line 237

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.server]
  }
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.



251
252
253
254
255
 
# File 'lib/resque.rb', line 251

def keys
  redis.keys("*").map do |key|
    key.sub('resque:', '')
  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.



114
115
116
117
118
119
120
121
122
 
# File 'lib/resque.rb', line 114

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)



108
109
110
 
# File 'lib/resque.rb', line 108

def peek(queue, start = 0, count = 1)
  list_range("queue:#{queue}", start, count)
end

#pop(queue) ⇒ Object

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

Returns a Ruby object.



90
91
92
 
# File 'lib/resque.rb', line 90

def pop(queue)
  decode redis.lpop("queue:#{queue}")
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.



82
83
84
85
 
# File 'lib/resque.rb', line 82

def push(queue, item)
  watch_queue(queue)
  redis.rpush "queue:#{queue}", encode(item)
end

#queue_from_class(klass) ⇒ Object

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



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

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.



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

def queues
  redis.smembers(:queues)
end

#redis ⇒ Object

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



45
46
47
48
49
 
# File 'lib/resque.rb', line 45

def redis
  return @redis if @redis
  self.redis = '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. An instance of `Redis`



29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/resque.rb', line 29

def redis=(server)
  case server
  when String
    host, port, db = server.split(':')
    redis = Redis.new(:host => host, :port => port,
      :thread_safe => true, :db => db)
    @redis = Redis::Namespace.new(:resque, :redis => redis)
  when Redis
    @redis = Redis::Namespace.new(:resque, :redis => server)
  else
    raise "I don't know what to do with #{server.inspect}"
  end
end

#remove_queue(queue) ⇒ Object

Given a queue name, completely deletes the queue.



130
131
132
133
 
# File 'lib/resque.rb', line 130

def remove_queue(queue)
  redis.srem(:queues, queue.to_s)
  redis.del("queue:#{queue}")
end

#remove_worker(worker_id) ⇒ Object

A shortcut to unregister_worker useful for command line tool



227
228
229
230
 
# File 'lib/resque.rb', line 227

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.



206
207
208
 
# File 'lib/resque.rb', line 206

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

#size(queue) ⇒ Object

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



96
97
98
 
# File 'lib/resque.rb', line 96

def size(queue)
  redis.llen("queue:#{queue}").to_i
end

#to_s ⇒ Object 



71
72
73
 
# File 'lib/resque.rb', line 71

def to_s
  "Resque Client connected to #{redis.server}"
end

#watch_queue(queue) ⇒ Object

Used internally to keep track of which queues we’ve created. Don’t call this directly.



137
138
139
 
# File 'lib/resque.rb', line 137

def watch_queue(queue)
  redis.sadd(:queues, queue.to_s)
end

#workers ⇒ Object

A shortcut to Worker.all



216
217
218
 
# File 'lib/resque.rb', line 216

def workers
  Worker.all
end

#working ⇒ Object

A shortcut to Worker.working



221
222
223
 
# File 'lib/resque.rb', line 221

def working
  Worker.working
end