Module: Seekmodo::Sdk::Mode

Defined in:
lib/seekmodo/sdk/mode.rb

Constant Summary collapse

OFF = 
"off"
LEARNING = 
"learning"
SHADOW = 
"shadow"
ACTIVE = 
"active"
ENFORCE = 
"enforce"
ALL = 
[OFF, LEARNING, SHADOW, ACTIVE, ENFORCE].freeze

Class Method Summary collapse

Class Method Details

.assert_mode(mode) ⇒ Object 



24
25
26
27
28
29
30
 
# File 'lib/seekmodo/sdk/mode.rb', line 24

def assert_mode(mode)
  unless valid?(mode)
    raise ArgumentError, "Unknown Seekmodo mode '#{mode}'; expected one of: #{ALL.join(', ')}"
  end

  mode
end

.mirrors_writes?(mode) ⇒ Boolean

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/seekmodo/sdk/mode.rb', line 36

def mirrors_writes?(mode)
  mode != OFF
end

.serves_search?(mode) ⇒ Boolean

Returns:

  • (Boolean) 


32
33
34
 
# File 'lib/seekmodo/sdk/mode.rb', line 32

def serves_search?(mode)
  [SHADOW, ACTIVE, ENFORCE].include?(mode)
end

.valid?(mode) ⇒ Boolean

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/seekmodo/sdk/mode.rb', line 20

def valid?(mode)
  ALL.include?(mode)
end

.values ⇒ Object 



16
17
18
 
# File 'lib/seekmodo/sdk/mode.rb', line 16

def values
  ALL
end