Merge lp:~soren/surveilr/messaging into lp:surveilr

[Soren Hansen]

Add basic messaging subsystem.

[lp:~soren/surveilr/messaging]

11. By Soren Hansen on 2011-11-29

Merge trunk

12. By Soren Hansen on 2011-11-29

Add support for sender id in SMS messaging driver. Add tests for Clickatell client instantiation.

13. By Soren Hansen on 2011-11-30

Only define User model once.

14. By Soren Hansen on 2011-11-30

Include messaging settings in GET /users/{id} response

15. By Soren Hansen on 2011-11-30

PEP-8 fixes

=== modified file 'surveilr/api/server.py'
--- surveilr/api/server.py	2011-11-29 20:07:19 +0000
+++ surveilr/api/server.py	2011-11-30 09:36:24 +0000
@@ -35,10 +35,25 @@
 from webob.dec import wsgify
 from webob.exc import HTTPNotFound
 
+from surveilr import messaging
 from surveilr import models
 from surveilr import utils
 
 
+class NotificationController(object):
+    """Routes style controller for notifications"""
+
+    def create(self, req, user_id):
+        """Called for POST requests to /user/{id}/notifications
+
+        Sends a notification to the given user"""
+
+        user = models.User.get(key=user_id)
+        messaging.send(user, json.loads(req.body))
+        response = {}
+        return Response(json.dumps(response))
+
+
 class UserController(object):
     """Routes style controller for actions related to users"""
 
@@ -59,7 +74,10 @@
         Returns information for the given service"""
         try:
             user = models.User.get(id)
-            return Response({'id': user.key})
+            resp_dict = {'id': user.key,
+                         'messaging_driver': user.messaging_driver,
+                         'messaging_address': user.messaging_address}
+            return Response(json.dumps(resp_dict))
         except riakalchemy.NoSuchObjectError:
             return HTTPNotFound()
 
@@ -138,6 +156,9 @@
                  path_prefix='/services/{service_name}')
     map.resource("service", "services", controller='ServiceController')
     map.resource("user", "users", controller='UserController')
+    map.resource("notification", "notifications",
+                 controller='NotificationController',
+                 path_prefix='/users/{user_id}')
 
     @wsgify
     def __call__(self, req):
 
=== modified file 'surveilr/defaults.cfg'
--- surveilr/defaults.cfg	2011-11-28 22:05:12 +0000
+++ surveilr/defaults.cfg	2011-11-30 09:36:24 +0000
@@ -4,3 +4,4 @@
 username = 
 password = 
 api_id = 
+sender = 
 
=== added directory 'surveilr/messaging'
=== added file 'surveilr/messaging/__init__.py'
--- surveilr/messaging/__init__.py	1970-01-01 00:00:00 +0000
+++ surveilr/messaging/__init__.py	2011-11-30 09:36:24 +0000
@@ -0,0 +1,34 @@
+"""
+    Surveilr - Log aggregation, analysis and visualisation
+
+    Copyright (C) 2011  Linux2Go
+
+    This program is free software: you can redistribute it and/or
+    modify it under the terms of the GNU Affero General Public License
+    as published by the Free Software Foundation, either version 3 of
+    the License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see
+    <http://www.gnu.org/licenses/>.
+"""
+
+import surveilr.messaging.fake
+import surveilr.messaging.sms
+
+from surveilr import drivers
+
+
+def _get_driver(recipient):
+    return drivers.get_driver('messaging',
+                              getattr(recipient, 'messaging_driver', 'fake'))
+
+
+def send(recipient, info):
+    driver = _get_driver(recipient)
+    driver.send(recipient, info)
 
=== added file 'surveilr/messaging/fake.py'
--- surveilr/messaging/fake.py	1970-01-01 00:00:00 +0000
+++ surveilr/messaging/fake.py	2011-11-30 09:36:24 +0000
@@ -0,0 +1,32 @@
+"""
+    Surveilr - Log aggregation, analysis and visualisation
+
+    Copyright (C) 2011  Linux2Go
+
+    This program is free software: you can redistribute it and/or
+    modify it under the terms of the GNU Affero General Public License
+    as published by the Free Software Foundation, either version 3 of
+    the License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see
+    <http://www.gnu.org/licenses/>.
+
+    Fake messaging driver
+"""
+
+import surveilr.drivers
+
+
+class FakeMessaging(object):
+    messages = []
+
+    def send(self, recipient, info):
+        self.messages.append((recipient, info))
+
+surveilr.drivers.register_driver('messaging', 'fake', FakeMessaging())
 
=== added file 'surveilr/messaging/sms.py'
--- surveilr/messaging/sms.py	1970-01-01 00:00:00 +0000
+++ surveilr/messaging/sms.py	2011-11-30 09:36:24 +0000
@@ -0,0 +1,52 @@
+"""
+    Surveilr - Log aggregation, analysis and visualisation
+
+    Copyright (C) 2011  Linux2Go
+
+    This program is free software: you can redistribute it and/or
+    modify it under the terms of the GNU Affero General Public License
+    as published by the Free Software Foundation, either version 3 of
+    the License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see
+    <http://www.gnu.org/licenses/>.
+
+    SMS messaging driver
+"""
+
+from surveilr import config
+from surveilr import drivers
+
+from clickatell.api import Clickatell
+from clickatell import constants as cc
+
+
+class SMSMessaging(object):
+    def __init__(self):
+        username = config.get_str('sms', 'username')
+        password = config.get_str('sms', 'password')
+        api_id = config.get_str('sms', 'api_id')
+        self.client = Clickatell(username, password, api_id,
+                                 sendmsg_defaults={
+                                    'callback': cc.YES,
+                                    'msg_type': cc.SMS_DEFAULT,
+                                    'deliv_ack': cc.YES,
+                                    'req_feat': (cc.FEAT_ALPHA +
+                                                 cc.FEAT_NUMER +
+                                                 cc.FEAT_DELIVACK)
+                              })
+
+    def send(self, recipient, info):
+        sender = config.get_str('sms', 'sender')
+        self.client.sendmsg(recipients=[recipient.messaging_address],
+                            sender=sender,
+                            text=str(info))
+
+
+drivers.register_driver('messaging', 'sms', SMSMessaging())
 
=== modified file 'surveilr/models.py'
--- surveilr/models.py	2011-11-29 10:27:40 +0000
+++ surveilr/models.py	2011-11-30 09:36:24 +0000
@@ -35,12 +35,16 @@
 
     name = String()
     most_recent_log_entry = RelatedObjects()
+    user = RelatedObjects(backref=True)
 
 
 class User(RiakObject):
     """A user of the service"""
     bucket_name = 'users'
 
+    messaging_driver = String()
+    messaging_address = String()
+
 
 class LogEntry(RiakObject):
     """A log entry holding one or more metrics
 
=== modified file 'surveilr/tests/__init__.py'
--- surveilr/tests/__init__.py	2011-11-29 23:14:20 +0000
+++ surveilr/tests/__init__.py	2011-11-30 09:36:24 +0000
@@ -24,6 +24,7 @@
 
 from surveilr import config
 
+
 class TestCase(unittest.TestCase):
     def config_files(self):
         module = self.__module__
@@ -49,5 +50,3 @@
 
     def tearDown(self):
         config.load_default_config()
-
-
 
=== modified file 'surveilr/tests/test_api_server.py'
--- surveilr/tests/test_api_server.py	2011-11-29 10:27:40 +0000
+++ surveilr/tests/test_api_server.py	2011-11-30 09:36:24 +0000
@@ -38,23 +38,46 @@
         """Create, retrieve, delete, attempt to retrieve again"""
         req = Request.blank('/users',
                             method='POST',
+                            POST=json.dumps({'messaging_driver': 'fake',
+                                             'messaging_address': 'foo'}))
+        resp = application(req)
+        self.assertEquals(resp.status_int, 200)
+
+        service_id = json.loads(resp.body)['id']
+
+        req = Request.blank('/users/%s' % service_id)
+        resp = application(req)
+        self.assertEquals(resp.status_int, 200)
+
+        print resp.body, type(resp.body)
+        user = json.loads(resp.body)
+        self.assertEquals(user['messaging_driver'], 'fake')
+        self.assertEquals(user['messaging_address'], 'foo')
+
+        req = Request.blank('/users/%s' % service_id, method='DELETE')
+        resp = application(req)
+        self.assertEquals(resp.status_int, 200)
+
+        req = Request.blank('/users/%s' % service_id)
+        resp = application(req)
+        self.assertEquals(resp.status_int, 404)
+
+    def test_send_notification(self):
+        req = Request.blank('/users',
+                            method='POST',
                             POST=json.dumps({}))
         resp = application(req)
         self.assertEquals(resp.status_int, 200)
 
-        service_id = json.loads(resp.body)['id']
-
-        req = Request.blank('/users/%s' % service_id)
-        resp = application(req)
-        self.assertEquals(resp.status_int, 200)
-
-        req = Request.blank('/users/%s' % service_id, method='DELETE')
-        resp = application(req)
-        self.assertEquals(resp.status_int, 200)
-
-        req = Request.blank('/users/%s' % service_id)
-        resp = application(req)
-        self.assertEquals(resp.status_int, 404)
+        user_id = json.loads(resp.body)['id']
+        req = Request.blank('/users/%s/notifications' % user_id,
+                            method='POST',
+                            POST=json.dumps({
+                                         'timestamp': 13217362355575,
+                                         'metrics': {'duration': 85000,
+                                                     'response_size': 12435}}))
+        resp = application(req)
+        self.assertEquals(resp.status_int, 200)
 
     def test_create_retrieve_service(self):
         """Create, retrieve, delete, attempt to retrieve again"""
 
=== added file 'surveilr/tests/test_messaging.cfg'
--- surveilr/tests/test_messaging.cfg	1970-01-01 00:00:00 +0000
+++ surveilr/tests/test_messaging.cfg	2011-11-30 09:36:24 +0000
@@ -0,0 +1,5 @@
+[sms]
+username = testuser
+password = testpassword
+api_id = testapiid
+sender = testsender
 
=== added file 'surveilr/tests/test_messaging.py'
--- surveilr/tests/test_messaging.py	1970-01-01 00:00:00 +0000
+++ surveilr/tests/test_messaging.py	2011-11-30 09:36:24 +0000
@@ -0,0 +1,114 @@
+"""
+    Surveilr - Log aggregation, analysis and visualisation
+
+    Copyright (C) 2011  Linux2Go
+
+    This program is free software: you can redistribute it and/or
+    modify it under the terms of the GNU Affero General Public License
+    as published by the Free Software Foundation, either version 3 of
+    the License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see
+    <http://www.gnu.org/licenses/>.
+
+    Tests for messaging layer
+"""
+
+import mock
+import unittest
+
+from surveilr import drivers
+from surveilr import messaging
+from surveilr import tests
+from surveilr.messaging import sms
+from surveilr.tests import utils
+
+
+class FakeMessagingDriverTests(unittest.TestCase):
+    def setUp(self):
+        import surveilr.messaging.fake
+        # This does nothing, but pyflakes gets upset if we import it
+        # and never "use" it.
+        surveilr.messaging.fake
+        self.driver = drivers.get_driver('messaging', 'fake')
+
+    def test_send(self):
+        user = utils.get_test_user()
+        info = {'service': 'service_id',
+                'state': 'normal',
+                'previous_state': 'unexpected high'}
+        self.driver.send(user, info)
+
+
+class SMSMessagingDriverTests(tests.TestCase):
+    @mock.patch('surveilr.messaging.sms.Clickatell')
+    def test_instantiate_client(self, clickatell):
+        self.driver = sms.SMSMessaging()
+
+        sendmsg_defaults = {'callback': 1,
+                            'req_feat': 8240,
+                            'deliv_ack': 1,
+                            'msg_type': 'SMS_TEXT'}
+        clickatell.assert_called_with('testuser', 'testpassword', 'testapiid',
+                                      sendmsg_defaults=sendmsg_defaults)
+
+    def test_send(self):
+        driver = sms.SMSMessaging()
+        driver.client = mock.Mock()
+
+        msisdn = '12345678'
+        user = utils.get_test_user(messaging_driver='sms',
+                                   messaging_address=msisdn)
+        info = utils.get_test_notification_info()
+
+        driver.send(user, info)
+
+        driver.client.sendmsg.assert_called_with(recipients=[msisdn],
+                                                 sender='testsender',
+                                                 text=str(info))
+
+
+class MessagingAPITests(unittest.TestCase):
+    def test_send(self):
+        user = utils.get_test_user()
+        info = {'service': 'service_id',
+                'state': 'normal',
+                'previous_state': 'unexpected high'}
+
+        with mock.patch('surveilr.messaging._get_driver') as _get_driver:
+            messaging.send(user, info)
+
+            # Check that _get_driver gets called with the user as its argument
+            _get_driver.assert_called_with(user)
+
+            # Check that _get_driver's return value (i.e. the driver)
+            # gets its .send() method called with user and info as its
+            # arguments
+            _get_driver.return_value.send.assert_called_with(user, info)
+
+    def test_get_driver_default(self):
+        user = utils.get_test_user()
+        expected_driver = drivers.get_driver('messaging', 'fake')
+
+        actual_driver = messaging._get_driver(user)
+        self.assertEquals(actual_driver, expected_driver)
+
+    def test_get_driver_sms(self):
+        user = utils.get_test_user(messaging_driver='sms')
+        expected_driver = drivers.get_driver('messaging', 'sms')
+
+        actual_driver = messaging._get_driver(user)
+        self.assertEquals(actual_driver, expected_driver)
+
+    def test_get_driver_fake(self):
+        user = utils.get_test_user(messaging_driver='fake')
+        expected_driver = drivers.get_driver('messaging', 'fake')
+
+        actual_driver = messaging._get_driver(user)
+        self.assertEquals(actual_driver, expected_driver)
 
=== added file 'surveilr/tests/utils.py'
--- surveilr/tests/utils.py	1970-01-01 00:00:00 +0000
+++ surveilr/tests/utils.py	2011-11-30 09:36:24 +0000
@@ -0,0 +1,35 @@
+"""
+    Surveilr - Log aggregation, analysis and visualisation
+
+    Copyright (C) 2011  Linux2Go
+
+    This program is free software: you can redistribute it and/or
+    modify it under the terms of the GNU Affero General Public License
+    as published by the Free Software Foundation, either version 3 of
+    the License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see
+    <http://www.gnu.org/licenses/>.
+
+    Utilities for unit tests
+"""
+
+from surveilr import models
+
+
+def get_test_user(messaging_driver='fake', messaging_address='somewhere'):
+    return models.User(**{'id': 'user_id',
+                          'messaging_driver': messaging_driver,
+                          'messaging_address': messaging_address})
+
+
+def get_test_notification_info():
+    return {'service': 'service_id',
+            'state': 'normal',
+            'previous_state': 'unexpected high'}