Merge branch 'add_proxy_support'

JNRowe · JNRowe · commit 0ffc5b18553f · 2011-05-19T15:44:44.000+01:00
* add_proxy_support:
  Adding SocksiPy-branch to install.rst.
  Making socks support optional.
  Adding HTTP proxy settings support to the client.
diff --git a/AUTHORS b/AUTHORS
@@ -23,3 +23,4 @@ Barthelemy Dagenais <bart@cs.mcgill.ca>
 Surajram Kumarave <root@surajram.com>
 broderboy <timothy.broder@gmail.com>
 Patryk Zawadzki <patrys@pld-linux.org>
+hub-cap <mbasnight@gmail.com>
diff --git a/doc/install.rst b/doc/install.rst
@@ -24,3 +24,4 @@ following::
 Gregorio for handling HTTP sessions.  :pypi:`simplejson` is also required when
 using :mod:`github2` with Python 2.4 or 2.5.  If you install via ``pip`` or
 ``easy_install`` the dependencies should be installed automatically for you.
+:pypi:`SocksiPy-branch` is an optional dependency if proxy support is needed.
diff --git a/github2/client.py b/github2/client.py
@@ -10,7 +10,8 @@
 class Github(object):
 
     def __init__(self, username=None, api_token=None, debug=False,
-        requests_per_second=None, access_token=None, cache=None):
+        requests_per_second=None, access_token=None, cache=None,
+        proxy_host=None, proxy_port=8080):
         """
         An interface to GitHub's API:
             http://develop.github.com/
@@ -31,13 +32,17 @@ def __init__(self, username=None, api_token=None, debug=False,
             or None to disable delays.  The default is to disable delays (for
             backwards compatibility).
         :param str cache: a directory for caching GitHub responses.
+        :param str proxy_host: the hostname for the HTTP proxy, if needed.
+        :param str proxy_port: the hostname for the HTTP proxy, if needed (will
+            default to 8080 if a proxy_host is set and no port is set.
         """
 
         self.debug = debug
         self.request = GithubRequest(username=username, api_token=api_token,
                                      debug=self.debug,
                                      requests_per_second=requests_per_second,
-                                     access_token=access_token, cache=cache)
+                                     access_token=access_token, cache=cache,
+                                     proxy_host=proxy_host, proxy_port=proxy_port)
         self.issues = Issues(self.request)
         self.users = Users(self.request)
         self.repos = Repositories(self.request)
diff --git a/github2/request.py b/github2/request.py
@@ -6,6 +6,10 @@
     import json as simplejson  # For Python 2.6
 except ImportError:
     import simplejson
+try:
+    import socks # SOCKS support may not be installed
+except ImportError:
+    socks = None
 from urlparse import (urlsplit, urlunsplit)
 try:
     from urlparse import parse_qs
@@ -31,7 +35,7 @@ class GithubRequest(object):
 
     def __init__(self, username=None, api_token=None, url_prefix=None,
             debug=False, requests_per_second=None, access_token=None,
-            cache=None):
+            cache=None, proxy_host=None, proxy_port=None):
         """Make an API request.
 
         :see: :py:class:`github2.client.Github`
@@ -52,7 +56,14 @@ def __init__(self, username=None, api_token=None, url_prefix=None,
                 "api_version": self.api_version,
                 "api_format": self.api_format,
             }
-        self._http = httplib2.Http(cache=cache)
+        if proxy_host is None:
+            self._http = httplib2.Http(cache=cache)
+        elif proxy_host and socks is None:
+            raise GithubError('Proxy support missing. Install a python SOCKS library.')
+        else:
+            self._http = httplib2.Http(proxy_info=httplib2.ProxyInfo(socks.PROXY_TYPE_HTTP, 
+                                                                     proxy_host, proxy_port), 
+                                       cache=cache)
 
     def encode_authentication_data(self, extra_post_data):
         if self.access_token:
diff --git a/setup.py b/setup.py
@@ -33,6 +33,9 @@
     zip_safe=True,
     test_suite="nose.collector",
     tests_require=['nose'],
+    extras_require={
+        'SOCKS': ['SocksiPy-branch==1.01'],
+    },
     classifiers=[
         "Development Status :: 3 - Alpha",
         "Intended Audience :: Developers",
