Handle file upload

* this allow ticket attachements and other misc upload

Author: Marx314

tests/http_utils_test.py

@@ -66,3 +66,9 @@ def test_with_bools(self):
             'true': True,
             'false': False
         }, result)
+
+    def test_filtering_files(self):
+        result = _http_utils.form_encode_without_files(dict(true=True, files=dict(attach='some_binary_data')))
+        self.assertDictEqual({
+            'true': True,
+        }, result)

tests/ubersmith_request_get_test.py

@@ -13,11 +13,10 @@
 # limitations under the License.
 
 import unittest
-
 from hamcrest import assert_that, equal_to
 from mock import patch, MagicMock
-import ubersmith_client
 
+import ubersmith_client
 from tests.ubersmith_json.response_data_structure import a_response_data
 
 
@@ -66,6 +65,26 @@ def test_api_get_method_returns_with_arguments(self, request_mock):
 
         expected_call()
 
+    @patch('ubersmith_client.ubersmith_request_get.requests')
+    def test_api_get_support_ticket_submit_allow_file_upload(self, request_mock):
+        expected_files = {'attach[0]': ('filename.pdf', b'filecontent')}
+        expected_call = self.expect_a_ubersmith_call_with_files(requests_mock=request_mock,
+                                                                method='support.ticket_submit',
+                                                                subject='that I used to know',
+                                                                body='some body',
+                                                                returning=a_response_data(data='42'),
+                                                                files=expected_files)
+
+        ubersmith_api = ubersmith_client.api.init(self.url, self.username, self.password, use_http_get=True)
+
+        response = ubersmith_api.support.ticket_submit(subject='that I used to know',
+                                                       body='some body',
+                                                       files=expected_files)
+
+        assert_that(response, equal_to('42'))
+
+        expected_call()
+
     def expect_a_ubersmith_call(self, requests_mock, returning=None, **kwargs):
         response = MagicMock(status_code=200, headers={'content-type': 'application/json'})
         requests_mock.get = MagicMock(return_value=response)
@@ -77,3 +96,16 @@ def assert_called_with():
             response.json.assert_called_with()
 
         return assert_called_with
+
+    def expect_a_ubersmith_call_with_files(self, requests_mock, returning=None, files=None, **kwargs):
+        response = MagicMock(status_code=200, headers={'content-type': 'application/json'})
+        requests_mock.get = MagicMock(return_value=response)
+        response.json = MagicMock(return_value=returning)
+
+        def assert_called_with():
+            requests_mock.get.assert_called_with(auth=self.auth, params=kwargs, timeout=self.timeout, url=self.url,
+                                                 files=files,
+                                                 headers={'user-agent': 'python-ubersmithclient'})
+            response.json.assert_called_with()
+
+        return assert_called_with

tests/ubersmith_request_post_test.py

@@ -13,11 +13,10 @@
 # limitations under the License.
 
 import unittest
-
 from hamcrest import assert_that, equal_to, calling, raises
 from mock import patch, MagicMock
-import ubersmith_client
 
+import ubersmith_client
 from tests.ubersmith_json.response_data_structure import a_response_data
 
 
@@ -77,13 +76,46 @@ def test_api_raises_exception_with_if_data_status_is_false(self, requests_mock):
         self.expect_a_ubersmith_call_post(requests_mock, method='client.miss', returning=data)
         assert_that(calling(ubersmith_api.client.miss), raises(ubersmith_client.exceptions.UbersmithException))
 
-    def expect_a_ubersmith_call_post(self, requests_mock, returning=None, status_code=200, **kwargs):
-        response = MagicMock(status_code=status_code, headers={'content-type': 'application/json'})
+    @patch('ubersmith_client.ubersmith_request_post.requests')
+    def test_api_post_support_ticket_submit_allow_file_upload(self, request_mock):
+        expected_files = {'attach[0]': ('filename.pdf', b'filecontent')}
+        expected_call = self.expect_a_ubersmith_call_post_with_files(requests_mock=request_mock,
+                                                                     method='support.ticket_submit',
+                                                                     subject='that I used to know',
+                                                                     body='some body',
+                                                                     returning=a_response_data(data='42'),
+                                                                     files=expected_files)
+
+        ubersmith_api = ubersmith_client.api.init(self.url, self.username, self.password)
+
+        response = ubersmith_api.support.ticket_submit(subject='that I used to know',
+                                                       body='some body',
+                                                       files=expected_files)
+
+        assert_that(response, equal_to('42'))
+
+        expected_call()
+
+    def expect_a_ubersmith_call_post(self, requests_mock, returning=None, **kwargs):
+        response = MagicMock(status_code=200, headers={'content-type': 'application/json'})
+        requests_mock.post = MagicMock(return_value=response)
+        response.json = MagicMock(return_value=returning)
+
+        def assert_called_with():
+            requests_mock.post.assert_called_with(auth=self.auth, timeout=self.timeout, url=self.url, data=kwargs,
+                                                  headers={'user-agent': 'python-ubersmithclient'})
+            response.json.assert_called_with()
+
+        return assert_called_with
+
+    def expect_a_ubersmith_call_post_with_files(self, requests_mock, returning=None, files=None, **kwargs):
+        response = MagicMock(status_code=200, headers={'content-type': 'application/json'})
         requests_mock.post = MagicMock(return_value=response)
         response.json = MagicMock(return_value=returning)
 
         def assert_called_with():
             requests_mock.post.assert_called_with(auth=self.auth, timeout=self.timeout, url=self.url, data=kwargs,
+                                                  files=files,
                                                   headers={'user-agent': 'python-ubersmithclient'})
             response.json.assert_called_with()
 

ubersmith_client/_http_utils.py

@@ -22,6 +22,10 @@ def form_encode(data):
     return exploded_data
 
 
+def form_encode_without_files(data):
+    return form_encode({k: v for k, v in data.items() if k is not 'files'})
+
+
 def _explode_enumerable(k, v):
     exploded_items = []
     if isinstance(v, list) or isinstance(v, tuple):

ubersmith_client/ubersmith_request_get.py

@@ -21,13 +21,16 @@
 class UbersmithRequestGet(UbersmithRequest):
     def __call__(self, **kwargs):
         self._build_request_params(kwargs)
-        params = _http_utils.form_encode(kwargs)
+        params = _http_utils.form_encode_without_files(kwargs)
+        requests_get_args = dict(method=requests.get,
+                                 url=self.url,
+                                 auth=(self.user, self.password),
+                                 timeout=self.timeout,
+                                 headers={'user-agent': 'python-ubersmithclient'},
+                                 params=params)
+        if 'files' in kwargs:
+            requests_get_args['files'] = kwargs['files']
 
-        response = self._process_request(method=requests.get,
-                                         url=self.url,
-                                         auth=(self.user, self.password),
-                                         timeout=self.timeout,
-                                         headers={'user-agent': 'python-ubersmithclient'},
-                                         params=params)
+        response = self._process_request(**requests_get_args)
 
         return UbersmithRequest.process_ubersmith_response(response)

ubersmith_client/ubersmith_request_post.py

@@ -21,13 +21,17 @@
 class UbersmithRequestPost(UbersmithRequest):
     def __call__(self, **kwargs):
         self._build_request_params(kwargs)
-        params = _http_utils.form_encode(kwargs)
+        params = _http_utils.form_encode_without_files(kwargs)
 
-        response = self._process_request(method=requests.post,
-                                         url=self.url,
-                                         auth=(self.user, self.password),
-                                         timeout=self.timeout,
-                                         headers={'user-agent': 'python-ubersmithclient'},
-                                         data=params)
+        requests_post_args = dict(method=requests.post,
+                                  url=self.url,
+                                  auth=(self.user, self.password),
+                                  timeout=self.timeout,
+                                  headers={'user-agent': 'python-ubersmithclient'},
+                                  data=params)
+        if 'files' in kwargs:
+            requests_post_args['files'] = kwargs['files']
+
+        response = self._process_request(**requests_post_args)
 
         return UbersmithRequest.process_ubersmith_response(response)