From f65248f797de523d22e69f8f7400beca228d6594 Mon Sep 17 00:00:00 2001
From: Lucidiot <lucidiot@protonmail.com>
Date: Wed, 10 Oct 2018 19:25:03 +0200
Subject: [PATCH] Output type as an Enum (#35)

* Add enum34 requirement

* Use an Enum for output types
---
 pinhook/bot.py    |  6 ++++--
 pinhook/plugin.py | 12 ++++++++++--
 setup.py          |  1 +
 3 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/pinhook/bot.py b/pinhook/bot.py
index ac3542b..460c1ae 100644
--- a/pinhook/bot.py
+++ b/pinhook/bot.py
@@ -222,12 +222,14 @@ class Bot(irc.bot.SingleServerIRCBot):
         for msg in output.msg:
             if len(msg.encode('UTF-8')) > 512:
                 self.logger.error('output message too long: {}'.format(msg))
-            elif output.msg_type == 'message':
+            elif output.msg_type == pinhook.plugin.OutputType.Message:
                 self.logger.debug('output message: {}'.format(msg))
                 c.privmsg(chan, msg)
-            elif output.msg_type == 'action':
+            elif output.msg_type == pinhook.plugin.OutputType.Action:
                 self.logger.debug('output action: {}'.format(msg))
                 c.action(chan, msg)
+            else:
+                self.logger.warning("Unsupported output type '{}'".format(output.msg_type))
             time.sleep(.5)
 
 
diff --git a/pinhook/plugin.py b/pinhook/plugin.py
index 0607ba6..6a6afb1 100644
--- a/pinhook/plugin.py
+++ b/pinhook/plugin.py
@@ -1,7 +1,15 @@
+from enum import Enum
+
+
 cmds = {}
 lstnrs = {}
 
 
+class OutputType(Enum):
+    Message = 'message'
+    Action = 'action'
+
+
 class Output:
     def __init__(self, msg_type, msg):
         self.msg_type = msg_type
@@ -15,11 +23,11 @@ class Output:
 
 
 def action(msg):
-    return Output('action', msg)
+    return Output(OutputType.Action, msg)
 
 
 def message(msg):
-    return Output('message', msg)
+    return Output(OutputType.Message, msg)
 
 
 def _add_plugin(command, func):
diff --git a/setup.py b/setup.py
index 8332d35..d8b7f5a 100755
--- a/setup.py
+++ b/setup.py
@@ -21,6 +21,7 @@ AUTHOR = 'M. Hancock'
 # What packages are required for this module to be executed?
 REQUIRED = [
     'irc',
+    'enum34',
 ]
 
 # The rest you shouldn't have to touch too much :)