Class: Guh::Rule

Inherits:
Base
  • Object
show all
Defined in:
lib/guh/rule.rb

Overview

This class wraps everything related to Rules.

Class Method Summary collapse

Methods inherited from Base

configure, get, guh_ip_address, guh_ip_address=, guh_port, guh_port=, introspect, version

Class Method Details

.add(params) ⇒ Object

Creates a new Rule.

Example:

Guh::Rule.add(params)



42
43
44
45
46
47
48
 
# File 'lib/guh/rule.rb', line 42

def self.add(params)
  get({
    id: generate_request_id,
    method: "Rules.AddRule",
    params: params
  })
end

.all ⇒ Object

Returns a list of all Rules.

Example:

Guh::Rule.all



25
26
27
28
29
30
31
32
 
# File 'lib/guh/rule.rb', line 25

def self.all
  response = get({
    id: generate_request_id,
    method: "Rules.GetRules"
  })

  response['ruleIds']
end

.find(rule_id) ⇒ Object 



7
8
9
10
11
12
13
14
15
 
# File 'lib/guh/rule.rb', line 7

def self.find(rule_id)
  response = get({
    id: generate_request_id,
    method: "Rules.GetRuleDetails",
    params: { ruleId: rule_id }
  })

  response['rule']
end

.remove(rule_id) ⇒ Object

Removes a Rule.

Example:

Guh::Rule.remove(rule_id)



58
59
60
61
62
63
64
 
# File 'lib/guh/rule.rb', line 58

def self.remove(rule_id)
  get({
    id: generate_request_id,
    method: "Rules.RemoveRule",
    params: { ruleId: rule_id }
  })
end