Merge lp:~mvo/piston-mini-client/add-proxy-support into lp:piston-mini-client

[Michael Vogt]

This adds support for reading the http/https proxy from the environment. Unfortunately it also needs python-socksipy as a additional dependency. Fortunately its tiny.

[lp:~mvo/piston-mini-client/add-proxy-support]

44. By Michael Vogt on 2011-09-27

support multi scheme apis

[Anthony Lenton (elachuni)]

Hi mvo!

Thanks for the patch!
Improvements for a later branch, notes to myself more than anything else:
 - Update the docs to mention these improvements
 - The tests fail if you don't have socksipy available already. SocksiPy isn't installable from PyPI it seems, we'll need to figure out a way to make that work or disable the proxy tests if it isn't available

review: Approve

=== modified file 'piston_mini_client/__init__.py'
--- piston_mini_client/__init__.py	2011-08-10 16:56:49 +0000
+++ piston_mini_client/__init__.py	2011-09-27 16:30:36 +0000
@@ -210,7 +210,8 @@
         if not service_root:
             raise ValueError("No service_root provided, and no default found")
         parsed_service_root = urlparse(service_root)
-        if parsed_service_root.scheme not in ['http', 'https']:
+        scheme = parsed_service_root.scheme
+        if scheme not in ['http', 'https']:
             raise ValueError("service_root's scheme must be http or https")
         self._service_root = service_root
         self._parsed_service_root = list(parsed_service_root)
@@ -220,19 +221,53 @@
             self._httplib2_cache = None
         self._auth = auth
         self._offline_mode = offline_mode
-        self._http = None
-        if (disable_ssl_validation or
+        self._disable_ssl_validation = disable_ssl_validation
+        # create one httplib2.Http object per scheme so that we can
+        # have per-scheme proxy settings (see also Issue 26
+        #   http://code.google.com/p/httplib2/issues/detail?id=26)
+        self._http = {}
+        for scheme in ("http", "https"):
+            self._http[scheme] = self._get_http_obj_for_scheme(scheme)
+        if self.serializers is None:
+            self.serializers = {}
+
+    def _get_http_obj_for_scheme(self, scheme):
+        proxy_info = self._get_proxy_info(scheme)
+        http = None
+        if (self._disable_ssl_validation or
             os.environ.get(DISABLE_SSL_VALIDATION_ENVVAR)):
             try:
-                self._http = httplib2.Http(cache=self._httplib2_cache,
-                    disable_ssl_certificate_validation=True)
+                http = httplib2.Http(
+                    cache=self._httplib2_cache,
+                    disable_ssl_certificate_validation=True,
+                    proxy_info=proxy_info)
             except TypeError:
                 # httplib2 < 0.7.0 doesn't support cert validation anyway
                 pass
-        if self._http is None:
-            self._http = httplib2.Http(cache=self._httplib2_cache)
-        if self.serializers is None:
-            self.serializers = {}
+        if http is None:
+            http = httplib2.Http(cache=self._httplib2_cache,
+                                 proxy_info=proxy_info)
+        return http
+
+    def _get_proxy_info(self, scheme):
+        envvar = "%s_proxy" % scheme
+        if envvar in os.environ:
+            import socks
+            url = urlparse(os.environ[envvar])
+            user_pass, sep, host_and_port = url.netloc.rpartition("@")
+            user, sep, passw = user_pass.partition(":")
+            host, sep, port = host_and_port.partition(":")
+            if port:
+                port = int(port)
+            proxy_info = httplib2.ProxyInfo(
+                proxy_type=socks.PROXY_TYPE_HTTP,
+                proxy_host=host,
+                proxy_port=port or 8080,
+                proxy_user=user or None,
+                proxy_pass=passw or None)
+            return proxy_info
+        return None
+        
 
     def _get(self, path, args=None, scheme=None, extra_headers=None):
         """Perform an HTTP GET request.
@@ -404,10 +439,13 @@
                 raise OfflineModeException(err)
             return self._get_from_cache(url)
 
+        if scheme is None:
+            scheme = urlparse(url).scheme
+
         if self._auth:
             self._auth.sign_request(url, method, body, headers)
         try:
-            response, body = self._http.request(url, method=method, body=body,
+            response, body = self._http[scheme].request(url, method=method, body=body,
                 headers=headers)
         except AttributeError, e:
             # Special case out httplib2's way of telling us unable to connect
@@ -423,8 +461,9 @@
         """ get a given url from the cachedir even if its expired
             or return None if no data is available
         """
-        if self._http.cache:
-            cached_value = self._http.cache.get(httplib2.urlnorm(url)[-1])
+        scheme = urlparse(url).scheme
+        if self._http[scheme].cache:
+            cached_value = self._http[scheme].cache.get(httplib2.urlnorm(url)[-1])
             if cached_value:
                 info, content = cached_value.split('\r\n\r\n', 1)
                 return content

=== added file 'piston_mini_client/tests/test_proxy.py'
--- piston_mini_client/tests/test_proxy.py	1970-01-01 00:00:00 +0000
+++ piston_mini_client/tests/test_proxy.py	2011-09-27 16:30:36 +0000
@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+# Copyright 2010-2011 Canonical Ltd.  This software is licensed under the
+# GNU Lesser General Public License version 3 (see the file LICENSE).
+
+import os
+
+from mock import patch
+from unittest import TestCase
+
+from piston_mini_client import PistonAPI
+
+class DentistAPI(PistonAPI):
+    default_service_root = 'http://localhost:12345'
+    def appointments(self):
+        self._get('/appointments')
+
+class ProxySupportTestCase(TestCase):
+
+    def setUp(self):
+        for envvar in ("http_proxy", "https_proxy"):
+            if envvar in os.environ:
+                del os.environ[envvar]
+
+    def test_basic_proxy(self):
+        os.environ["http_proxy"] = "http://localhost:3128"
+        api = DentistAPI()
+        proxy_info = api._http["http"].proxy_info
+        self.assertNotEqual(proxy_info, None)
+        self.assertEqual(proxy_info.proxy_host, "localhost")
+        self.assertEqual(proxy_info.proxy_port, 3128)
+
+    def test_basic_https_proxy(self):
+        # not the https this time
+        os.environ["https_proxy"] = "https://localhost:3128"
+        api = DentistAPI(service_root="https://localhost:12345")
+        proxy_info = api._http["https"].proxy_info
+        self.assertNotEqual(proxy_info, None)
+        self.assertEqual(proxy_info.proxy_host, "localhost")
+        self.assertEqual(proxy_info.proxy_port, 3128)
+
+    def test_auth_proxy(self):
+        os.environ["http_proxy"] = "http://user:pass@localhost:3128"
+        api = DentistAPI()
+        proxy_info = api._http["http"].proxy_info
+        self.assertNotEqual(proxy_info, None)
+        self.assertEqual(proxy_info.proxy_host, "localhost")
+        self.assertEqual(proxy_info.proxy_port, 3128)
+        self.assertEqual(proxy_info.proxy_user, "user")
+        self.assertEqual(proxy_info.proxy_pass, "pass")
+
+    def test_no_proxy(self):
+        api = DentistAPI()
+        proxy_info = api._http["http"].proxy_info
+        self.assertEqual(proxy_info, None)
+
+
+if __name__ == "__main__":
+    import unittest
+    unittest.main()

=== modified file 'piston_mini_client/tests/test_resource.py'
--- piston_mini_client/tests/test_resource.py	2011-08-09 15:13:32 +0000
+++ piston_mini_client/tests/test_resource.py	2011-09-27 16:30:36 +0000
@@ -429,3 +429,6 @@
         obj = self.MySerializable(foo='bar', baz=42)
         self.assertEqual({'foo': 'bar'}, obj._as_serializable())
 
+if __name__ == "__main__":
+    import unittest
+    unittest.main()