Implement support for HTTP proxies.

Author: rolftimmermans

test/helper.py

@@ -5,6 +5,7 @@
 import sys
 import os
 import httpretty
+from nose.exc import SkipTest
 
 if sys.version_info < (2, 7):
     import unittest2 as unittest
@@ -34,8 +35,9 @@ def tearDown(self):
         httpretty.disable()
         httpretty.reset()
 
-        tinify.app_identifier = None
         tinify.key = None
+        tinify.app_identifier = None
+        tinify.proxy = None
         tinify.compression_count
 
     def assertJsonEqual(self, expected, actual):

test/integration.py

@@ -7,6 +7,7 @@
 
 class ClientIntegrationTest(unittest.TestCase):
     tinify.key = os.environ.get("TINIFY_KEY")
+    tinify.proxy = os.environ.get("TINIFY_PROXY")
 
     unoptimized_path = os.path.join(os.path.dirname(__file__), 'examples', 'voormedia.png')
     optimized = tinify.from_file(unoptimized_path)

test/tinify_client_test.py

@@ -66,6 +66,19 @@ def test_should_issue_request_with_user_agent(self):
 
         self.assertEqual(self.request.headers['user-agent'], Client.USER_AGENT + ' TestApp/0.2')
 
+class TinifyClientRequestWhenValidWithProxy(TestHelper):
+    def setUp(self):
+        super(type(self), self).setUp()
+        httpretty.register_uri(httpretty.CONNECT, 'http://localhost:8080', **{
+          'compression-count': 12
+        })
+
+    def test_should_issue_request_with_proxy_authorization(self):
+        raise SkipTest('https://github.com/gabrielfalcao/HTTPretty/issues/122')
+        Client('key', None, 'http://user:pass@localhost:8080').request('GET', '/')
+
+        self.assertEqual(self.request.headers['proxy-authorization'], 'Basic dXNlcjpwYXNz')
+
 class TinifyClientRequestWithTimeout(TestHelper):
     @patch('requests.sessions.Session.request', RaiseException(requests.exceptions.Timeout))
     def test_should_raise_connection_error(self):

test/tinify_test.py

@@ -26,6 +26,17 @@ def test_should_reset_client_with_new_app_identifier(self):
         tinify.get_client().request('GET', '/')
         self.assertEqual(self.request.headers['user-agent'], tinify.Client.USER_AGENT + " MyApp/2.0")
 
+class TinifyProxy(TestHelper):
+    def test_should_reset_client_with_new_proxy(self):
+        httpretty.register_uri(httpretty.CONNECT, 'http://localhost:8080')
+        tinify.key = 'abcde'
+        tinify.proxy = 'http://localhost:8080'
+        tinify.get_client()
+        tinify.proxy = 'http://localhost:8080'
+        raise SkipTest('https://github.com/gabrielfalcao/HTTPretty/issues/122')
+        tinify.get_client().request('GET', '/')
+        self.assertEqual(self.request.headers['user-agent'], tinify.Client.USER_AGENT + " MyApp/2.0")
+
 class TinifyClient(TestHelper):
     def test_with_key_should_return_client(self):
         tinify.key = 'abcde'
@@ -35,6 +46,12 @@ def test_without_key_should_raise_error(self):
         with self.assertRaises(tinify.AccountError):
             tinify.get_client()
 
+    def test_with_invalid_proxy_should_raise_error(self):
+        with self.assertRaises(tinify.ConnectionError):
+            tinify.key = 'abcde'
+            tinify.proxy = 'http-bad-url'
+            tinify.get_client().request('GET', '/')
+
 class TinifyValidate(TestHelper):
     def test_with_valid_key_should_return_true(self):
         httpretty.register_uri(httpretty.POST, 'https://api.tinify.com/shrink', status=400,

tinify/__init__.py

@@ -12,6 +12,7 @@ def __init__(self, module):
         self._client = None
         self._key = None
         self._app_identifier = None
+        self._proxy = None
         self._compression_count = None
 
     @property
@@ -32,6 +33,15 @@ def app_identifier(self, value):
         self._app_identifier = value
         self._client = None
 
+    @property
+    def proxy(self):
+        return self._key
+
+    @key.setter
+    def proxy(self, value):
+        self._proxy = value
+        self._client = None
+
     @property
     def compression_count(self):
         return self._compression_count
@@ -47,7 +57,7 @@ def get_client(self):
         if not self._client:
             with self._lock:
                 if not self._client:
-                    self._client = Client(self._key, self._app_identifier)
+                    self._client = Client(self._key, self._app_identifier, self._proxy)
 
         return self._client
 

tinify/client.py

@@ -16,8 +16,10 @@ class Client(object):
     API_ENDPOINT = 'https://api.tinify.com'
     USER_AGENT = 'Tinify/{0} Python/{1} ({2})'.format(tinify.__version__, platform.python_version(), platform.python_implementation())
 
-    def __init__(self, key, app_identifier=None):
+    def __init__(self, key, app_identifier=None, proxy=None):
         self.session = requests.sessions.Session()
+        if proxy:
+            self.session.proxies = {'https': proxy}
         self.session.auth = ('api', key)
         self.session.headers = {
             'user-agent': self.USER_AGENT + ' ' + app_identifier if app_identifier else self.USER_AGENT,