Merge branch 'master' into update_license_year

Author: thinkingserious

.travis.yml

@@ -10,6 +10,7 @@ fail_fast: true
 before_install:
     - pip install pycodestyle
 install:
+- pip install codecov
 - if [[ "$TRAVIS_PYTHON_VERSION" == 2.6* ]]; then travis_retry pip install unittest2; fi
 - if [[ "$TRAVIS_PYTHON_VERSION" == 2.6* ]]; then travis_retry pip uninstall -y pbr; fi
 - if [[ "$TRAVIS_PYTHON_VERSION" == "3.2" ]]; then travis_retry pip install coverage==3.7.1; fi
@@ -23,6 +24,7 @@ after_script:
 # Run pycodestyle
 - pycodestyle
 - if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]]; then unit2 discover; else python -m unittest discover; fi
+- coverage run tests/test_unit.py
 notifications:
   hipchat:
     rooms:
@@ -33,7 +35,8 @@ notifications:
       <a href="https://github.com/sendgrid/%{repository}/commits/%{commit}">View on
       GitHub</a>'
     format: html
-    notify: false
+after_success:
+  - codecov
 env:
   global:
   - secure: 7j0Ox9ZQss0PewrhGih86Ro0pQJpv23Bb0uABJV7kKN/W37ofrG0m6joamf8EhDDleaPoIqfbARhUpAlqFZF0Uo/5rREqpKkmP4e1zuYMu20VbFv6PXwZ+7ByAuKXN2/Xs54MImlL1+RaduMPNRpbcfT1mdqJgSC+3tVcWodzuRG9RPzxtWYLe93QfwNHV/VMsDPDIY12FZTErbXd/hBCEQXep5rNfK+TtLIGn0ZnS7TktTcD0ld+0ruhunbDjnkpXPVSJDuLaGRpotq0oyaGifnjVM5gVubP+KCL3h24tIXjJ7uI36Eu3EuF4qsg0fmNjuM/WjgwZ9Ta4I2MHlXtFs//qMMArOw5AvPg25adrEwGO4Veh3I3tJGL7hJeM7AZX4rAycXiGIHvpP2G/nX6e/EqRrnFBDOStmBhxEaknLJ/p2Cv6AOvxTMKDo8y+tJY1jp3H1iwCBYyW6KuFKVPDYtu8VLxJunaqNX4LxiJN7VHgvTSgqImjzEy5tVxVt079ciyeznSKKGHLHDAl1ioQpmv/Oyas007A4PKJJAf73go8Yt+GM6qe3K6U3tIBKWL8e0cK1kejk9TLC0D9KXbmhmK81QzpBdQfkrveYi/kucVv0zdrGl+Uy8zcq+vYxceyCdDYcTxCS66bWNFTD2t1dML5gRpdNVVSc27ZM9wtA=

CONTRIBUTING.md

@@ -10,6 +10,7 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou
 - [Testing Multiple Versions of Python](#testing-multiple-versions-of-python)
 - [Style Guidelines & Naming Conventions](#style-guidelines-and-naming-conventions)
 - [Creating a Pull Request](#creating-a-pull-request)
+- [Code Reviews](#code-reviews)
 
 <a name="roadmap"></a>
 We use [Milestones](https://github.com/sendgrid/python-http-client/milestones) to help define current roadmaps, please feel free to grab an issue from the current milestone. Please indicate that you have begun work on it to avoid collisions. Once a PR is made, community review, comments, suggestions and additional PRs are welcomed and encouraged.
@@ -225,3 +226,7 @@ Please run your code through:
     with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
 
 If you have any additional questions, please feel free to [email](mailto:[email protected]) us or create an issue in this repo.
+
+<a name="code-reviews"></a>
+## Code Reviews
+If you can, please look at open PRs and review them. Give feedback and help us merge these PRs much faster! If you don't know how, Github has some great [information on how to review a Pull Request](https://help.github.com/articles/about-pull-request-reviews/).

README.md

@@ -110,6 +110,7 @@ Quick links:
 - [Bug Reports](https://github.com/sendgrid/python-http-client/blob/master/CONTRIBUTING.md#submit-a-bug-report)
 - [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/python-http-client/blob/master/CONTRIBUTING.md#cla)
 - [Improvements to the Codebase](https://github.com/sendgrid/python-http-client/blob/master/CONTRIBUTING.md#improvements-to-the-codebase)
+- [Review Pull Requests](https://github.com/sendgrid/python-http-client/blob/master/CONTRIBUTING.md#code-reviews)
 
 <a name="local_setup"></a>
 

python_http_client/__init__.py

@@ -1,5 +1,5 @@
-from .client import Client
-from .exceptions import (
+from .client import Client  # noqa
+from .exceptions import (  # noqa
     HTTPError,
     BadRequestsError,
     UnauthorizedError,

python_http_client/client.py

@@ -64,7 +64,8 @@ def __init__(self,
                  request_headers=None,
                  version=None,
                  url_path=None,
-                 append_slash=False):
+                 append_slash=False,
+                 timeout=None):
         """
         :param host: Base URL for the api. (e.g. https://api.sendgrid.com)
         :type host:  string
@@ -88,6 +89,7 @@ def __init__(self,
         self.methods = ['delete', 'get', 'patch', 'post', 'put']
         # APPEND SLASH set
         self.append_slash = append_slash
+        self.timeout = timeout
 
     def _build_versioned_url(self, url):
         """Subclass this function for your own needs.
@@ -124,7 +126,6 @@ def _build_url(self, query_params):
             url = self._build_versioned_url(url)
         else:
             url = self.host + url
-
         return url
 
     def _update_headers(self, request_headers):
@@ -148,20 +149,24 @@ def _build_client(self, name=None):
                       version=self._version,
                       request_headers=self.request_headers,
                       url_path=url_path,
-                      append_slash=self.append_slash)
+                      append_slash=self.append_slash,
+                      timeout=self.timeout)
 
-    def _make_request(self, opener, request):
+    def _make_request(self, opener, request, timeout=None):
         """Make the API call and return the response. This is separated into
            it's own function, so we can mock it easily for testing.
 
         :param opener:
         :type opener:
         :param request: url payload to request
         :type request: urllib.Request object
+        :param timeout: timeout value or None
+        :type timeout: float
         :return: urllib response
         """
+        timeout = timeout or self.timeout
         try:
-            return opener.open(request)
+            return opener.open(request, timeout=timeout)
         except HTTPError as err:
             exc = handle_error(err)
             exc.__cause__ = None
@@ -214,7 +219,6 @@ def http_request(*_, **kwargs):
                 if 'request_body' not in kwargs:
                     data = None
                 else:
-
                     # Don't serialize to a JSON formatted str
                     # if we don't have a JSON Content-Type
                     if 'Content-Type' in self.request_headers:
@@ -241,7 +245,8 @@ def http_request(*_, **kwargs):
                 if data and ('Content-Type' not in self.request_headers):
                     request.add_header('Content-Type', 'application/json')
                 request.get_method = lambda: method
-                return Response(self._make_request(opener, request))
+                timeout = kwargs.pop('timeout', None)
+                return Response(self._make_request(opener, request, timeout=timeout))
             return http_request
         else:
             # Add a segment to the URL

register.py

@@ -1,23 +1,24 @@
 import pypandoc
-import os
 
 
 output = pypandoc.convert('README.md', 'rst')
 
 with open('README.txt', 'w+') as f:
     f.write(output)
 
-with open('./README.txt') as f:
-    readme_rst = f.read()
+readme_rst = open('./README.txt').read()
 
-replace = ('[SendGrid Logo]\n'
-           '(https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)')
+replace = """\
+[SendGrid Logo]
+(https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)"""
 
-replacement = ('|SendGrid Logo|\n\n.. |SendGrid Logo| image:: '
-               'https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png'
-               '\n   :target: https://www.sendgrid.com')
+replacement = """\
+|SendGrid Logo|
 
-final_text = readme_rst.replace(replace, replacement)
+.. |SendGrid Logo| image:: \
+https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png
+   :target: https://www.sendgrid.com"""
 
+final_text = readme_rst.replace(replace, replacement)
 with open('./README.txt', 'w') as f:
     f.write(final_text)

setup.py

@@ -8,7 +8,7 @@
     long_description = open('README.txt').read()
 
 
-def getRequires():
+def get_requires():
     deps = []
     if (2, 6) <= sys.version_info < (2, 7):
         deps.append('unittest2')
@@ -28,7 +28,7 @@ def getRequires():
     license='MIT',
     description='HTTP REST client, simplified for Python',
     long_description=long_description,
-    install_requires=getRequires(),
+    install_requires=get_requires(),
     keywords=[
         'REST',
         'HTTP',

tests/test_daterange.py

@@ -14,7 +14,10 @@ def setUp(self):
                                 '../LICENSE.txt')
         self.pattern = 'Copyright (c) 2012 - %s SendGrid, Inc.' % (
                         time.strftime("%Y"))
-        self.licensefile = open(self.openlicensefile).read()
+        fh = open(self.openlicensefile)
+        self.licensefile = fh.read()
+        fh.close()
 
     def test__daterange(self):
         self.assertTrue(self.pattern in self.licensefile)
+

tests/test_unit.py

@@ -1,11 +1,10 @@
-import os
 import pickle
-from os import path
+
 try:
     import unittest2 as unittest
 except ImportError:
     import unittest
-from python_http_client.client import Client, Response
+from python_http_client.client import Client
 from python_http_client.exceptions import (
     handle_error,
     HTTPError,
@@ -15,15 +14,13 @@
     ServiceUnavailableError
 )
 
-
 try:
     # Python 3
     import urllib.request as urllib
 except ImportError:
     # Python 2
     import urllib2 as urllib
 
-
 try:
     basestring
 except NameError:
@@ -58,13 +55,12 @@ def read(self):
 
 class MockClient(Client):
 
-    def __init__(self, host, response_code):
+    def __init__(self, host, response_code, timeout=None):
         self.response_code = 200
         Client.__init__(self, host)
 
-    def _make_request(self, opener, request):
-
-        if 200 <= self.response_code < 299:   # if successful code
+    def _make_request(self, opener, request, timeout=None):
+        if 200 <= self.response_code < 299:  # if successful code
             return MockResponse(self.response_code)
         else:
             raise handle_error(MockException(self.response_code))
@@ -74,12 +70,11 @@ class TestClient(unittest.TestCase):
 
     def setUp(self):
         self.host = 'http://api.test.com'
-        self.client = Client(host=self.host)
-        self.api_key = 'SENDGRID_API_KEY'
+        self.api_key = "SENDGRID_API_KEY"
         self.request_headers = {
-                                'Content-Type': 'application/json',
-                                'Authorization': 'Bearer ' + self.api_key
-                                }
+            'Content-Type': 'application/json',
+            'Authorization': 'Bearer ' + self.api_key
+        }
         self.client = Client(host=self.host,
                              request_headers=self.request_headers,
                              version=3)
@@ -88,6 +83,7 @@ def test__init__(self):
         default_client = Client(host=self.host)
         self.assertEqual(default_client.host, self.host)
         self.assertEqual(default_client.request_headers, {})
+        self.assertIs(default_client.timeout, None)
         methods = ['delete', 'get', 'patch', 'post', 'put']
         self.assertEqual(default_client.methods, methods)
         self.assertEqual(default_client._version, None)
@@ -97,13 +93,15 @@ def test__init__(self):
         version = 3
         client = Client(host=self.host,
                         request_headers=request_headers,
-                        version=version)
+                        version=version,
+                        timeout=10)
         self.assertEqual(client.host, self.host)
         self.assertEqual(client.request_headers, request_headers)
         methods = ['delete', 'get', 'patch', 'post', 'put']
         self.assertEqual(client.methods, methods)
         self.assertEqual(client._version, 3)
         self.assertEqual(client._url_path, [])
+        self.assertEqual(client.timeout, 10)
 
     def test__build_versioned_url(self):
         url = '/api_keys?hello=1&world=2'
@@ -116,13 +114,12 @@ def test__build_url(self):
         self.client._url_path = self.client._url_path + ['there']
         self.client._url_path = self.client._url_path + [1]
         self.client._version = 3
-
-        url = '{0}/v{1}{2}'.format(self.host,
-                                   str(self.client._version),
-                                   '/here/there/1?hello=0&' +
-                                   'world=1&ztest=0&ztest=1')
+        url = '{0}/v{1}{2}'.format(
+            self.host,
+            str(self.client._version),
+            '/here/there/1?hello=0&world=1&ztest=0&ztest=1'
+        )
         query_params = {'hello': 0, 'world': 1, 'ztest': [0, 1]}
-
         built_url = self.client._build_url(query_params)
         self.assertEqual(built_url, url)
 
@@ -154,7 +151,7 @@ def test__getattr__(self):
         self.assertEqual(client._version, 3)
 
         # Test GET
-        mock_client._url_path+['test']
+        mock_client._url_path + ['test']
         r = mock_client.get()
         self.assertEqual(r.status_code, 200)
 
@@ -191,11 +188,14 @@ def test__getattr__(self):
         mock_client.response_code = 523
         self.assertRaises(HTTPError, mock_client.delete)
 
-
     def test_client_pickle_unpickle(self):
         pickled_client = pickle.dumps(self.client)
         unpickled_client = pickle.loads(pickled_client)
-        self.assertDictEqual(self.client.__dict__, unpickled_client.__dict__, "original client and unpickled client must have the same state")
+        self.assertDictEqual(
+            self.client.__dict__,
+            unpickled_client.__dict__,
+            "original client and unpickled client must have the same state"
+        )
 
 
 if __name__ == '__main__':