Add user-agent headers (#160)

* Send user-agent header for Web API calls

Author: Roach

setup.py

@@ -1,7 +1,29 @@
 from setuptools import setup
+import codecs
+import os
+import re
+
+here = os.path.abspath(os.path.dirname(__file__))
+
+# Read the version number from a source file.
+# Why read it, and not import?
+# see https://groups.google.com/d/topic/pypa-dev/0PkjVpcxTzQ/discussion
+def find_version(*file_paths):
+    # Open in Latin-1 so that we avoid encoding errors.
+    # Use codecs.open for Python 2 compatibility
+    with codecs.open(os.path.join(here, *file_paths), 'r', 'latin1') as f:
+        version_file = f.read()
+
+    # The version line must have the form
+    # __version__ = 'ver'
+    version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
+                              version_file, re.M)
+    if version_match:
+        return version_match.group(1)
+    raise RuntimeError("Unable to find version string.")
 
 setup(name='slackclient',
-      version='1.0.4',
+      version=find_version('slackclient', 'version.py'),
       description='Python client for Slack.com',
       url='http://github.com/slackapi/python-slackclient',
       author='Ryan Huber',

slackclient/_client.py

@@ -27,6 +27,9 @@ def __init__(self, token):
         self.token = token
         self.server = Server(self.token, False)
 
+    def append_user_agent(self, name, version):
+        self.server.append_user_agent(name, version)
+
     def rtm_connect(self):
         '''
         Connects to the RTM Websocket

slackclient/_server.py

@@ -61,6 +61,9 @@ def __str__(self):
     def __repr__(self):
         return self.__str__()
 
+    def append_user_agent(self, name, version):
+        self.api_requester.append_user_agent(name, version)
+
     def rtm_connect(self, reconnect=False, timeout=None):
         reply = self.api_requester.do(self.token, "rtm.start", timeout=timeout)
         if reply.status_code != 200:

slackclient/_slackrequest.py

@@ -3,12 +3,50 @@
 import requests
 import six
 
+import sys
+import platform
+from .version import __version__
+
 
 class SlackRequest(object):
+    def __init__(self):
+
+        # __name__ returns 'slackclient._slackrequest', we only want 'slackclient'
+        client_name = __name__.split('.')[0]
+        client_version = __version__  # Version is returned from version.py
+
+        # Construct the user-agent header with the package info, Python version and OS version.
+        self.default_user_agent = {
+            "client": "{0}/{1}".format(client_name, client_version),
+            "python": "Python/{v.major}.{v.minor}.{v.micro}".format(v=sys.version_info),
+            "system": "{0}/{1}".format(platform.system(), platform.release())
+        }
+
+        self.custom_user_agent = None
+
+    def get_user_agent(self):
+        # Check for custom user-agent and append if found
+        if self.custom_user_agent:
+            custom_ua_list = ["/".join(client_info) for client_info in self.custom_user_agent]
+            custom_ua_string = " ".join(custom_ua_list)
+            self.default_user_agent['custom'] = custom_ua_string
 
-    @staticmethod
-    def do(token, request="?", post_data=None, domain="slack.com", timeout=None):
-        '''
+        # Concatenate and format the user-agent string to be passed into request headers
+        ua_string = []
+        for key, val in self.default_user_agent.items():
+            ua_string.append(val)
+
+        user_agent_string = " ".join(ua_string)
+        return user_agent_string
+
+    def append_user_agent(self, name, version):
+        if self.custom_user_agent:
+            self.custom_user_agent.append([name.replace("/", ":"), version.replace("/", ":")])
+        else:
+            self.custom_user_agent = [[name, version]]
+
+    def do(self, token, request="?", post_data=None, domain="slack.com", timeout=None):
+        """
         Perform a POST request to the Slack Web API
 
         Args:
@@ -19,12 +57,12 @@ def do(token, request="?", post_data=None, domain="slack.com", timeout=None):
                 {'channel': 'CABC12345'}
             domain (str): if for some reason you want to send your request to something other
                 than slack.com
-        '''
-        post_data = post_data or {}
+        """
 
         # Pull file out so it isn't JSON encoded like normal fields.
         # Only do this for requests that are UPLOADING files; downloading files
         # use the 'file' argument to point to a File ID.
+        post_data = post_data or {}
         upload_requests = ['files.upload']
         files = None
         if request in upload_requests:
@@ -36,5 +74,6 @@ def do(token, request="?", post_data=None, domain="slack.com", timeout=None):
 
         url = 'https://{0}/api/{1}'.format(domain, request)
         post_data['token'] = token
+        headers = {'user-agent': self.get_user_agent()}
 
-        return requests.post(url, data=post_data, files=files, timeout=timeout)
+        return requests.post(url, headers=headers, data=post_data, files=files, timeout=timeout)

slackclient/version.py

@@ -0,0 +1,2 @@
+# see: http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers
+__version__ = '1.0.4'

tests/test_slackrequest.py

@@ -1,43 +1,73 @@
 from slackclient._slackrequest import SlackRequest
+from slackclient.version import __version__
 import json
 import os
 
+def test_http_headers(mocker):
+    requests = mocker.patch('slackclient._slackrequest.requests')
+    request = SlackRequest()
+
+    request.do('xoxb-123', 'chat.postMessage', {'text': 'test', 'channel': '#general'})
+    args, kwargs = requests.post.call_args
+
+    assert None != kwargs['headers']['user-agent']
+
+def test_custom_user_agent(mocker):
+    requests = mocker.patch('slackclient._slackrequest.requests')
+    request = SlackRequest()
+
+    request.append_user_agent("fooagent1","0.1")
+    request.append_user_agent("baragent/2","0.2")
+
+    request.do('xoxb-123', 'chat.postMessage', {'text': 'test', 'channel': '#general'})
+    args, kwargs = requests.post.call_args
+
+    # Verify user-agent includes both default and custom agent info
+    assert "slackclient/{}".format(__version__) in kwargs['headers']['user-agent']
+    assert "fooagent1/0.1" in kwargs['headers']['user-agent']
+
+    # verify escaping of slashes in custom agent name
+    assert "baragent:2/0.2" in kwargs['headers']['user-agent']
+
 def test_post_file(mocker):
     requests = mocker.patch('slackclient._slackrequest.requests')
+    request = SlackRequest()
 
-    response = SlackRequest.do('xoxb-123',
+    request.do('xoxb-123',
         'files.upload',
         {'file': open(os.path.join('.', 'tests', 'data', 'slack_logo.png'), 'rb'),
             'filename': 'slack_logo.png'})
+    args, kwargs = requests.post.call_args
 
     assert requests.post.call_count == 1
-    args, kwargs = requests.post.call_args
     assert 'https://slack.com/api/files.upload' == args[0]
     assert {'filename': 'slack_logo.png',
             'token': 'xoxb-123'} == kwargs['data']
     assert None != kwargs['files']
 
 def test_get_file(mocker):
     requests = mocker.patch('slackclient._slackrequest.requests')
+    request = SlackRequest()
 
-    SlackRequest.do('xoxb-123', 'files.info', {'file': 'myFavoriteFileID'})
+    request.do('xoxb-123', 'files.info', {'file': 'myFavoriteFileID'})
+    args, kwargs = requests.post.call_args
 
     assert requests.post.call_count == 1
-    args, kwargs = requests.post.call_args
     assert 'https://slack.com/api/files.info' == args[0]
     assert {'file': "myFavoriteFileID",
             'token': 'xoxb-123'} == kwargs['data']
     assert None == kwargs['files']
 
 def test_post_attachements(mocker):
     requests = mocker.patch('slackclient._slackrequest.requests')
+    request = SlackRequest()
 
-    SlackRequest.do('xoxb-123',
+    request.do('xoxb-123',
                     'chat.postMessage',
                     {'attachments': [{'title': 'hello'}]})
+    args, kwargs = requests.post.call_args
 
     assert requests.post.call_count == 1
-    args, kwargs = requests.post.call_args
     assert 'https://slack.com/api/chat.postMessage' == args[0]
     assert {'attachments': json.dumps([{'title': 'hello'}]),
             'token': 'xoxb-123'} == kwargs['data']