Merge pull request #22 from copartit/master

1.3.1

Author: nmaludy

CHANGES.md

@@ -1,5 +1,10 @@
 # Change Log
 
+
+## 1.3.1
+
+- Code refactoring/clean-up.
+
 ## 1.3.0
 
 - Added `st2.rules.enable`, `st2.rules.disable` actions and chatops commands.

actions/lib/action.py

@@ -12,6 +12,9 @@
 
 
 class St2BaseAction(Action):
+    def run(self, **kwargs):
+        pass
+
     def __init__(self, config):
         super(St2BaseAction, self).__init__(config)
         self._client = Client
@@ -111,6 +114,22 @@ def _run_client_method(self, method, method_kwargs, format_func, format_kwargs=N
         return result
 
     def _manipulate_rule(self, name, pack, enabled):
+        """
+        Enable or disable rule.
+
+        :param name: Name of the rule
+        :type name: ``str``
+
+        :param pack: Pack where the rule is
+        :type pack: ``str``
+
+        :param enabled:
+        :type enabled: ``bool``
+
+        :return: Updated rule or string in case of an error
+        :rtype: ``dict`` or ``str``
+        """
+
         rule_name = '{}.{}'.format(pack, name)
         failure_reason = None
         rule = None
@@ -124,14 +143,21 @@ def _manipulate_rule(self, name, pack, enabled):
         if failure_reason:
             return 'Could not get rule {}: {}'.format(rule_name, failure_reason)
 
-        rule_enabled = rule.enabled
-
-        if isinstance(rule_enabled, bool) and rule_enabled == enabled:
-            # already enabled, so just return true and formatted results
+        try:
+            rule_enabled = rule.enabled
+        except AttributeError:
+            # this should not happen, but better be safe than sorry
+            self.logger.debug("Hmm, rule {}.{} doesn't have attribute 'enabled', "
+                              "assuming it's off then.".format(name, pack))
+            rule_enabled = False
+
+        if rule_enabled == enabled:
+            # already enabled/disabled, so just return true and formatted results
             return rule
 
-        rule.enabled = enabled
         try:
+            rule.enabled = enabled
+
             self.client.rules.update(rule)
         except Exception as exc:
             return 'Could not update rule {}: {}'.format(rule_name, exc)

actions/lib/formatters.py

@@ -22,3 +22,12 @@ def format_result(item):
 
 def format_rule_update_result(result, exclude_attributes):
     return format_client_list_result(result=[result], exclude_attributes=exclude_attributes)[0]
+
+
+def format_rule_result(rule, exclude):
+    if rule is None or isinstance(rule, str):
+        # error happened
+        return False, rule
+    else:
+        # all good here
+        return True, format_rule_update_result(rule, exclude)

actions/rules_disable.py

@@ -1,5 +1,5 @@
 from lib.action import St2BaseAction
-from lib.formatters import format_rule_update_result
+from lib.formatters import format_rule_result
 
 __all__ = [
     'St2RulesDisableAction'
@@ -10,9 +10,4 @@ class St2RulesDisableAction(St2BaseAction):
     def run(self, pack=None, name=None, exclude=None):
 
         rule = self._manipulate_rule(pack=pack, name=name, enabled=False)
-        if rule is None or isinstance(rule, str):
-            # error happened
-            return False, rule
-        else:
-            # all good here
-            return True, format_rule_update_result(rule, exclude)
+        return format_rule_result(rule, exclude)

actions/rules_enable.py

@@ -1,5 +1,5 @@
 from lib.action import St2BaseAction
-from lib.formatters import format_rule_update_result
+from lib.formatters import format_rule_result
 
 __all__ = [
     'St2RulesEnableAction'
@@ -10,9 +10,4 @@ class St2RulesEnableAction(St2BaseAction):
     def run(self, pack=None, name=None, exclude=None):
 
         rule = self._manipulate_rule(pack=pack, name=name, enabled=True)
-        if rule is None or isinstance(rule, str):
-            # error happened
-            return False, rule
-        else:
-            # all good here
-            return True, format_rule_update_result(rule, exclude)
+        return format_rule_result(rule, exclude)

pack.yaml

@@ -2,12 +2,11 @@
 ref: st2
 name: st2
 description: StackStorm utility actions and aliases
-version: 1.3.0
+version: 1.3.1
 python_versions:
   - "2"
   - "3"
 author: StackStorm, Inc.
 email: info@stackstorm.com
 contributors:
   - Igor Cherkaev <igor.cherkaev@copart.com>
-