Add a send_notification method for notification-only tokens (issue #46) to the HypChat class.

hypchat/__init__.py

@@ -7,7 +7,7 @@
 import datetime
 import six
 from .requests import Requests, BearerAuth, HttpTooManyRequests
-from .restobject import Linker
+from .restobject import Linker, prepare_notification_data
 
 
 class RateLimitWarning(Warning):
@@ -155,3 +155,12 @@ def get_user(self, id_or_email, **kwargs):
 
     def get_emoticon(self, id_or_shortcut, **kwargs):
         return self.fromurl('{0}/v2/emoticon/{1}'.format(self.endpoint, id_or_shortcut), **kwargs)
+
+    def send_notification(self, id_or_name, message, notify=False, format=None, **kwargs):
+        """
+        Send a message to a room.
+        This version is for notification-only add-ons and tokens generated for that purpose.
+        """
+        data = prepare_notification_data(message, notify, format, **kwargs)
+        url = '{0}/v2/room/{1}'.format(self.endpoint, id_or_name)
+        self._requests.post(url + '/notification', data=data)

hypchat/restobject.py

@@ -125,6 +125,23 @@ def delete(self):
 _at_mention = re.compile('@[\w]+(?: |$)')
 
 
+def prepare_notification_data(message, notify=False, format=None, **kwargs):
+    """Process arguments to build the request body
+    Cards not supported. see https://www.hipchat.com/docs/apiv2/method/send_room_notification for additional properties
+    Note that from needs to be passed as _from to avoid python keyword conflict
+    """
+    properties = {'_from': 'from', 'attach_to': 'attach_to', 'color': 'color'}
+    if not format:
+        if len(_at_mention.findall(message)) > 0:
+            format = 'text'
+        else:
+            format = 'html'
+    data = {'message': message, 'notify': notify, 'message_format': format}
+    for prop, value in kwargs.items():
+        data[properties[prop]] = value if prop in properties.keys() else None
+    return data
+
+
 class Room(RestObject):
     def __init__(self, *p, **kw):
         super(Room, self).__init__(*p, **kw)
@@ -147,18 +164,11 @@ def message(self, message):
         data = {'message': message}
         self._requests.post(self.url + '/message', data=data)
 
-    def notification(self, message, color=None, notify=False, format=None):
+    def notification(self, message, notify=False, format=None, **kwargs):
         """
         Send a message to a room.
         """
-        if not format:
-            if len(_at_mention.findall(message)) > 0:
-                format = 'text'
-            else:
-                format = 'html'
-        data = {'message': message, 'notify': notify, 'message_format': format}
-        if color:
-            data['color'] = color
+        data = prepare_notification_data(message, notify, format, **kwargs)
         self._requests.post(self.url + '/notification', data=data)
 
     def topic(self, text):

setup.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 
-from distutils.core import setup, Command
+from setuptools import setup, Command
+
 
 
 class PyTest(Command):