Class: Sidekiq::Web

Inherits:
Object
  • Object
show all
Defined in:
lib/sidekiq/web.rb,
lib/sidekiq/web/csrf_protection.rb

Defined Under Namespace

Classes: CsrfProtection

Constant Summary collapse

ROOT = 
File.expand_path("#{File.dirname(__FILE__)}/../../web")
VIEWS = 
"#{ROOT}/views"
LOCALES = 
["#{ROOT}/locales"]
LAYOUT = 
"#{VIEWS}/layout.erb"
ASSETS = 
"#{ROOT}/assets"
DEFAULT_TABS = 
{
  "Dashboard" => "",
  "Busy" => "busy",
  "Queues" => "queues",
  "Retries" => "retries",
  "Scheduled" => "scheduled",
  "Dead" => "morgue"
}

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

.app_url ⇒ Object

Returns the value of attribute app_url.



86
87
88
 
# File 'lib/sidekiq/web.rb', line 86

def app_url
  @app_url
end

.locales ⇒ Object 



50
51
52
 
# File 'lib/sidekiq/web.rb', line 50

def locales
  @locales ||= LOCALES
end

.redis_pool ⇒ Object

Returns the value of attribute redis_pool.



86
87
88
 
# File 'lib/sidekiq/web.rb', line 86

def redis_pool
  @redis_pool
end

.views ⇒ Object 



54
55
56
 
# File 'lib/sidekiq/web.rb', line 54

def views
  @views ||= VIEWS
end

Class Method Details

.call(env) ⇒ Object 



111
112
113
114
 
# File 'lib/sidekiq/web.rb', line 111

def self.call(env)
  @app ||= new
  @app.call(env)
end

.custom_tabs ⇒ Object Also known as: tabs 



45
46
47
 
# File 'lib/sidekiq/web.rb', line 45

def custom_tabs
  @custom_tabs ||= {}
end

.default_tabs ⇒ Object 



41
42
43
 
# File 'lib/sidekiq/web.rb', line 41

def default_tabs
  DEFAULT_TABS
end

.disable(*opts) ⇒ Object 



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

def disable(*opts)
  opts.each { |key| set(key, false) }
end

.enable(*opts) ⇒ Object 



58
59
60
 
# File 'lib/sidekiq/web.rb', line 58

def enable(*opts)
  opts.each { |key| set(key, true) }
end

.inherited(child) ⇒ Object 



90
91
92
93
 
# File 'lib/sidekiq/web.rb', line 90

def self.inherited(child)
  child.app_url = app_url
  child.redis_pool = redis_pool
end

.middlewares ⇒ Object 



66
67
68
 
# File 'lib/sidekiq/web.rb', line 66

def middlewares
  @middlewares ||= []
end

.register(extension) ⇒ Object 



136
137
138
 
# File 'lib/sidekiq/web.rb', line 136

def self.register(extension)
  extension.registered(WebApplication)
end

.session_secret=(val) ⇒ Object 



82
83
84
 
# File 'lib/sidekiq/web.rb', line 82

def session_secret=(val)
  puts "WARNING: Sidekiq::Web.session_secret= is no longer relevant and will be removed in Sidekiq 7.0. #{caller(1..1).first}"
end

.sessions=(val) ⇒ Object 



78
79
80
 
# File 'lib/sidekiq/web.rb', line 78

def sessions=(val)
  puts "WARNING: Sidekiq::Web.sessions= is no longer relevant and will be removed in Sidekiq 7.0. #{caller(1..1).first}"
end

.set(attribute, value) ⇒ Object 



74
75
76
 
# File 'lib/sidekiq/web.rb', line 74

def set(attribute, value)
  send(:"#{attribute}=", value)
end

.settings ⇒ Object 



37
38
39
 
# File 'lib/sidekiq/web.rb', line 37

def settings
  self
end

.use(*args, &block) ⇒ Object 



70
71
72
 
# File 'lib/sidekiq/web.rb', line 70

def use(*args, &block)
  middlewares << [args, block]
end

Instance Method Details

#app ⇒ Object 



116
117
118
 
# File 'lib/sidekiq/web.rb', line 116

def app
  @app ||= build
end

#call(env) ⇒ Object 



107
108
109
 
# File 'lib/sidekiq/web.rb', line 107

def call(env)
  app.call(env)
end

#disable(*opts) ⇒ Object 



124
125
126
 
# File 'lib/sidekiq/web.rb', line 124

def disable(*opts)
  opts.each { |key| set(key, false) }
end

#enable(*opts) ⇒ Object 



120
121
122
 
# File 'lib/sidekiq/web.rb', line 120

def enable(*opts)
  opts.each { |key| set(key, true) }
end

#middlewares ⇒ Object 



99
100
101
 
# File 'lib/sidekiq/web.rb', line 99

def middlewares
  @middlewares ||= self.class.middlewares
end

#sessions=(val) ⇒ Object 



132
133
134
 
# File 'lib/sidekiq/web.rb', line 132

def sessions=(val)
  puts "Sidekiq::Web#sessions= is no longer relevant and will be removed in Sidekiq 7.0. #{caller[2..2].first}"
end

#set(attribute, value) ⇒ Object 



128
129
130
 
# File 'lib/sidekiq/web.rb', line 128

def set(attribute, value)
  send(:"#{attribute}=", value)
end

#settings ⇒ Object 



95
96
97
 
# File 'lib/sidekiq/web.rb', line 95

def settings
  self.class.settings
end

#use(*args, &block) ⇒ Object 



103
104
105
 
# File 'lib/sidekiq/web.rb', line 103

def use(*args, &block)
  middlewares << [args, block]
end