Initial commit

1 files changed, 40 insertions, 0 deletions

diff --git a/warmachine/connections/base.py b/warmachine/connections/base.py
new file mode 100644
index 0000000..e68e9b9
--- /dev/null
+++ b/warmachine/connections/base.py
@@ -0,0 +1,40 @@
+INITALIZED = 'Initalized'
+CONNECTED = 'Connected'
+
+
+class Connection(object):
+    def connect(self, *args, **kwargs):
+        """
+        This is called by the main start method. It should prepare your
+        Connection and connect.
+        """
+        raise NotImplementedError('{} must implement `connect` method'.format(
+            self.__class__.__name__))
+
+    def read(self):
+        """
+        Dictionary of data in the following format:
+        {
+          'sender': 'username/id',
+          'channel': 'channel name' or None,
+          'message': 'actual message',
+        }
+
+        Returns:
+            dict: Data from the connection that the bot should consider.
+        """
+        raise NotImplementedError('{} must implement `read` method'.format(
+            self.__class__.__name__))
+
+    def id(self):
+        """
+        Unique ID for this connection. Since there can be more than one
+        connection it should be unique per actual connection to the server. For
+        example `bot nickname` + `server host:port`. This is used to store
+        settings and other information.
+
+        Returns:
+           str: Unique ID for this connection object
+        """
+        raise NotImplementedError('{} must implement `id` method'.format(
+            self.__class__.__name__))