Merge pull request #46 from jammons/master

Add tests and bugfix for b'' messages appearing in python3.

Author: jammons

README.md

@@ -67,6 +67,8 @@ This will print the incoming message json (dict) to the screen where the bot is
 
 Plugins having a method defined as ```catch_all(data)``` will receive ALL events from the websocket. This is useful for learning the names of events and debugging.
 
+Note: If you're using Python 2.x, the incoming data should be a unicode string, be careful you don't coerce it into a normal str object as it will cause errors on output. You can add `from __future__ import unicode_literals` to your plugin file to avoid this.
+
 ####Outgoing data
 Plugins can send messages back to any channel, including direct messages. This is done by appending a two item array to the outputs global array. The first item in the array is the channel ID and the second is the message text. Example that writes "hello world" when the plugin is started:
 

doc/example-plugins/canary.py

@@ -1,3 +1,6 @@
+from __future__ import unicode_literals
+# don't convert to ascii in py2.7 when creating string to return
+
 import time
 outputs = []
 

doc/example-plugins/counter.py

@@ -1,3 +1,6 @@
+from __future__ import unicode_literals
+# don't convert to ascii in py2.7 when creating string to return
+
 import time
 crontable = []
 outputs = []

doc/example-plugins/repeat.py

@@ -1,3 +1,6 @@
+from __future__ import unicode_literals
+# don't convert to ascii in py2.7 when creating string to return
+
 crontable = []
 outputs = []
 

doc/example-plugins/todo.py

@@ -1,4 +1,7 @@
 from __future__ import print_function
+from __future__ import unicode_literals
+# don't convert to ascii in py2.7 when creating string to return
+
 import os
 import pickle
 

requirements-dev.txt

@@ -1,6 +1,7 @@
 coveralls==1.1
 ipdb==0.9.3
 ipython==4.1.2
+mock==2.0.0
 pdbpp==0.8.3
 pytest>=2.8.2
 pytest-cov==2.2.1

rtmbot/core.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python
+from __future__ import unicode_literals
 import sys
 import glob
 import os
@@ -101,8 +102,7 @@ def output(self):
                     if limiter:
                         time.sleep(.1)
                         limiter = False
-                    message = output[1].encode('ascii', 'ignore')
-                    channel.send_message("{}".format(message))
+                    channel.send_message(output[1])
                     limiter = True
 
     def crons(self):

setup.py

@@ -4,7 +4,7 @@
 
 setup(
     name='rtmbot',
-    version='0.10',
+    version='0.2.0',
     description='A Slack bot written in python that connects via the RTM API.',
     author='Ryan Huber',
     author_email='[email protected]',

tests/test_example.py

@@ -1,15 +1,26 @@
+# -*- coding: utf-8 -*-
+try:
+    from unittest.mock import Mock, create_autospec
+except ImportError:
+    from mock import Mock, create_autospec
+
 from testfixtures import LogCapture
-from rtmbot.core import RtmBot
+from slackclient import SlackClient, _channel, _server, _util
+from rtmbot.core import RtmBot, Plugin
 
+def init_rtmbot():
+    ''' Initializes an instance of RTMBot with some default values '''
+    rtmbot = RtmBot({
+        'SLACK_TOKEN': 'test-12345',
+        'BASE_PATH': '/tmp/',
+        'LOGFILE': '/tmp/rtmbot.log',
+        'DEBUG': True
+    })
+    return rtmbot
 
 def test_init():
     with LogCapture() as l:
-        rtmbot = RtmBot({
-            'SLACK_TOKEN': 'test-12345',
-            'BASE_PATH': '/tmp/',
-            'LOGFILE': '/tmp/rtmbot.log',
-            'DEBUG': True
-        })
+        rtmbot = init_rtmbot()
 
     assert rtmbot.token == 'test-12345'
     assert rtmbot.directory == '/tmp/'
@@ -18,3 +29,47 @@ def test_init():
     l.check(
         ('root', 'INFO', 'Initialized in: /tmp/')
     )
+
+def test_output():
+    ''' Test that sending a message behaves as expected '''
+    rtmbot = init_rtmbot()
+
+    # Mock the slack_client object with Server, Channel objects and needed methods
+    slackclient_mock = create_autospec(SlackClient)
+    server_mock = create_autospec(_server.Server)
+
+    # Mock Server with channels method and correct return value
+    slackclient_mock.server = server_mock
+    searchlist_mock = create_autospec(_util.SearchList)
+    server_mock.channels = searchlist_mock
+    channel_mock = create_autospec(_channel.Channel)
+    slackclient_mock.server.channels.find.return_value = channel_mock
+
+    rtmbot.slack_client = slackclient_mock
+
+    # mock the plugin object to return a sample response
+    plugin_mock = create_autospec(Plugin)
+    plugin_mock.do_output.return_value = [['C12345678', 'test message']]
+    rtmbot.bot_plugins.append(plugin_mock)
+
+    rtmbot.output()
+
+
+    # test that the output matches the expected value
+    channel_mock.send_message.assert_called_with('test message')
+
+    # test that emoji messages work as expected
+    channel_mock.reset_mock()
+    plugin_mock.reset_mock()
+    plugin_mock.do_output.return_value = [['C12345678', '🚀 testing']]
+    rtmbot.output()
+
+    channel_mock.send_message.assert_called_with('🚀 testing')
+
+    # test that unicode messages work as expected
+    channel_mock.reset_mock()
+    plugin_mock.reset_mock()
+    plugin_mock.do_output.return_value = [['C12345678', 'ù hœø3ö']]
+    rtmbot.output()
+
+    channel_mock.send_message.assert_called_with('ù hœø3ö')