Module: ClockworkWeb

Defined in:
lib/clockwork_web.rb,
lib/clockwork_web/engine.rb,
lib/clockwork_web/version.rb,
app/helpers/clockwork_web/home_helper.rb,
app/controllers/clockwork_web/home_controller.rb

Defined Under Namespace

Modules: HomeHelper Classes: Engine, HomeController

Constant Summary collapse

LAST_RUNS_KEY = 
"clockwork:last_runs"
DISABLED_KEY = 
"clockwork:disabled"
HEARTBEAT_KEY = 
"clockwork:heartbeat"
STATUS_KEY = 
"clockwork:status"
VERSION = 
"0.4.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.clock_path ⇒ Object

Returns the value of attribute clock_path.



16
17
18
 
# File 'lib/clockwork_web.rb', line 16

def clock_path
  @clock_path
end

.monitor ⇒ Object

Returns the value of attribute monitor.



18
19
20
 
# File 'lib/clockwork_web.rb', line 18

def monitor
  @monitor
end

.on_job_update ⇒ Object

Returns the value of attribute on_job_update.



20
21
22
 
# File 'lib/clockwork_web.rb', line 20

def on_job_update
  @on_job_update
end

.redis ⇒ Object

Returns the value of attribute redis.



17
18
19
 
# File 'lib/clockwork_web.rb', line 17

def redis
  @redis
end

.running_threshold ⇒ Object

Returns the value of attribute running_threshold.



19
20
21
 
# File 'lib/clockwork_web.rb', line 19

def running_threshold
  @running_threshold
end

.user_method ⇒ Object

Returns the value of attribute user_method.



21
22
23
 
# File 'lib/clockwork_web.rb', line 21

def user_method
  @user_method
end

Class Method Details

.disable(job) ⇒ Object 



36
37
38
39
40
41
42
43
 
# File 'lib/clockwork_web.rb', line 36

def self.disable(job)
  if redis
    redis.sadd(DISABLED_KEY, job)
    true
  else
    false
  end
end

.disabled_jobs ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/clockwork_web.rb', line 53

def self.disabled_jobs
  if redis
    Set.new(redis.smembers(DISABLED_KEY))
  else
    Set.new
  end
end

.enable(job) ⇒ Object 



27
28
29
30
31
32
33
34
 
# File 'lib/clockwork_web.rb', line 27

def self.enable(job)
  if redis
    redis.srem(DISABLED_KEY, job)
    true
  else
    false
  end
end

.enabled?(job) ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
48
49
50
51
 
# File 'lib/clockwork_web.rb', line 45

def self.enabled?(job)
  if redis
    !redis.sismember(DISABLED_KEY, job)
  else
    true
  end
end

.heartbeat ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/clockwork_web.rb', line 84

def self.heartbeat
  if redis
    heartbeat = Time.now.to_i
    if heartbeat % 10 == 0
      prev_heartbeat = redis.getset(HEARTBEAT_KEY, heartbeat).to_i
      if prev_heartbeat >= heartbeat
        redis.setex(STATUS_KEY, 60, "multiple")
      end
    end
  end
end

.last_heartbeat ⇒ Object 



75
76
77
78
79
80
81
82
 
# File 'lib/clockwork_web.rb', line 75

def self.last_heartbeat
  if redis
    timestamp = redis.get(HEARTBEAT_KEY)
    if timestamp
      Time.at(timestamp.to_i)
    end
  end
end

.last_runs ⇒ Object 



61
62
63
64
65
66
67
 
# File 'lib/clockwork_web.rb', line 61

def self.last_runs
  if redis
    Hash[redis.hgetall(LAST_RUNS_KEY).map { |job, timestamp| [job, Time.at(timestamp.to_i)] }.sort_by { |job, time| [time, job] }]
  else
    {}
  end
end

.multiple? ⇒ Boolean

Returns:

  • (Boolean) 


100
101
102
 
# File 'lib/clockwork_web.rb', line 100

def self.multiple?
  redis && redis.get(STATUS_KEY) == "multiple"
end

.running? ⇒ Boolean

Returns:

  • (Boolean) 


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

def self.running?
  last_heartbeat && last_heartbeat > Time.now - running_threshold
end

.set_last_run(job) ⇒ Object 



69
70
71
72
73
 
# File 'lib/clockwork_web.rb', line 69

def self.set_last_run(job)
  if redis
    redis.hset(LAST_RUNS_KEY, job, Time.now.to_i)
  end
end