Merge branch 'master' into master

Matt Bernier · web-flow · commit f2f18349d493 · 2017-12-11T23:17:46.000Z
diff --git a/.env_sample b/.env_sample
@@ -0,0 +1 @@
+export SENDGRID_API_KEY=''
diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE
@@ -1,5 +1,24 @@
-**Description of the change**:
+<!--
+We appreciate the effort for this pull request but before that please make sure you read the contribution guidelines given above, then fill out the blanks below.
 
-**Reason for the change**:
 
+Please enter each Issue number you are resolving in your PR after one of the following words [Fixes, Closes, Resolves]. This will auto-link these issues and close them when this PR is merged!
+e.g. 
+Fixes #1
+Closes #2
+-->
+# Fixes # 
 
+### Checklist
+- [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
+- [ ] I have read the [Contribution Guide] and my PR follows them.
+- [ ] I updated my branch with the master branch.
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I have added necessary documentation about the functionality in the appropriate .md file
+- [ ] I have added in line documentation to the code I modified
+
+### Short description of what this PR does:
+- 
+- 
+
+If you have questions, please send an email to [Sendgrid](mailto:dx@sendgrid.com), or file a Github Issue in this repository.
diff --git a/.travis.yml b/.travis.yml
@@ -6,13 +6,18 @@ python:
 - '2.7'
 - '3.4'
 - '3.5'
+fail_fast: true
+before_install:
+    - pip install pycodestyle
 install:
 - 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
 - if [[ "$TRAVIS_PYTHON_VERSION" != "3.2" ]]; then travis_retry pip install coverage; fi
 - python setup.py install
 script:
+# Run pycodestyle
+- pycodestyle
 - if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]]; then unit2 discover; else python -m unittest discover; fi
 notifications:
   hipchat:
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 SendGrid, Inc.
+Copyright (c) 2012 - 2017 SendGrid, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -45,6 +45,16 @@ or
 easy_install python_http_client
 ```
 
+## API Key
+
+Store your SendGrid API key in a .env file
+
+```bash
+cp .env_sample .env
+```
+
+Edit the `.env` file and add your API key.
+
 <a name="quick-start"></a>
 # Quick Start
 
diff --git a/examples/live_sendgrid_example.py b/examples/live_sendgrid_example.py
@@ -66,4 +66,3 @@
 response = client.api_keys._(api_key_id).delete()
 print(response.status_code)
 print(response.headers)
-
diff --git a/python_http_client/client.py b/python_http_client/client.py
@@ -119,8 +119,12 @@ def _build_url(self, query_params):
         if query_params:
             url_values = urlencode(sorted(query_params.items()), True)
             url = '{0}?{1}'.format(url, url_values)
-        url = self._build_versioned_url(
-            url) if self._version else self.host + url
+
+        if self._version:
+            url = self._build_versioned_url(url)
+        else:
+            url = self.host + url
+
         return url
 
     def _update_headers(self, request_headers):
@@ -210,27 +214,41 @@ 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
+
+                    # Don't serialize to a JSON formatted str
+                    # if we don't have a JSON Content-Type
                     if 'Content-Type' in self.request_headers:
-                        if self.request_headers['Content-Type'] != 'application/json':
+                        if self.request_headers['Content-Type'] != 'application\
+                        /json':
                             data = kwargs['request_body'].encode('utf-8')
                         else:
                             data = json.dumps(
                                 kwargs['request_body']).encode('utf-8')
                     else:
                         data = json.dumps(
                             kwargs['request_body']).encode('utf-8')
-                params = kwargs['query_params'] if 'query_params' in kwargs else None
+
+                if 'query_params' in kwargs:
+                    params = kwargs['query_params']
+                else:
+                    params = None
+
                 opener = urllib.build_opener()
                 request = urllib.Request(self._build_url(params), data=data)
                 if self.request_headers:
                     for key, value in self.request_headers.items():
                         request.add_header(key, value)
-                if data and not ('Content-Type' in self.request_headers):
+                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))
             return http_request
         else:
             # Add a segment to the URL
             return self._(name)
+
+    def __getstate__(self):
+        return self.__dict__
+
+    def __setstate__(self, state):
+        self.__dict__ = state
diff --git a/register.py b/register.py
@@ -1,14 +1,23 @@
 import pypandoc
 import os
 
+
 output = pypandoc.convert('README.md', 'rst')
-f = open('README.txt','w+')
-f.write(output)
-f.close()
-
-readme_rst = open('./README.txt').read()
-replace = '[SendGrid Logo]\n(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'
-final_text = readme_rst.replace(replace,replacement)
+
+with open('README.txt', 'w+') as f:
+    f.write(output)
+
+with open('./README.txt') as f:
+    readme_rst = f.read()
+
+replace = ('[SendGrid Logo]\n'
+           '(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')
+
+final_text = readme_rst.replace(replace, replacement)
+
 with open('./README.txt', 'w') as f:
-  f.write(final_text)
+    f.write(final_text)
diff --git a/setup.py b/setup.py
@@ -2,16 +2,19 @@
 import os
 from setuptools import setup
 
+
 long_description = 'Please see our GitHub README'
 if os.path.exists('README.txt'):
     long_description = open('README.txt').read()
 
+
 def getRequires():
     deps = []
     if (2, 6) <= sys.version_info < (2, 7):
         deps.append('unittest2')
     return deps
 
+
 base_url = 'https://github.com/sendgrid/'
 version = '3.0.0'
 setup(
diff --git a/tests/profile.py b/tests/profile.py
@@ -160,5 +160,6 @@ def static_version():
                           version=3)
     run_tested_code(client, 10)
 
+
 dynamic_result = dynamic_version()
 static_result = static_version()
diff --git a/tests/test_daterange.py b/tests/test_daterange.py
@@ -0,0 +1,20 @@
+import os
+import time
+
+try:
+    import unittest2 as unittest
+except ImportError:
+    import unittest
+
+
+class DateRangeTest(unittest.TestCase):
+    def setUp(self):
+        self.openlicensefile = os.path.join(
+                                os.path.dirname(__file__),
+                                '../LICENSE.txt')
+        self.pattern = 'Copyright (c) 2012 - %s SendGrid, Inc.' % (
+                        time.strftime("%Y"))
+        self.licensefile = open(self.openlicensefile).read()
+
+    def test__daterange(self):
+        self.assertTrue(self.pattern in self.licensefile)
diff --git a/tests/test_repofiles.py b/tests/test_repofiles.py
@@ -0,0 +1,38 @@
+from os import path
+try:
+    import unittest2 as unittest
+except ImportError:
+    import unittest
+
+
+class RepoFiles(unittest.TestCase):
+    FILES = [
+        ['./Dockerfile', './docker/Dockerfile'],
+        ['./docker-compose.yml', './docker/docker-compose.yml'],
+        ['./.env_sample'],
+        ['./.gitignore'],
+        ['./.travis.yml'],
+        ['./.codeclimate.yml'],
+        ['./CHANGELOG.md'],
+        ['./CODE_OF_CONDUCT.md'],
+        ['./CONTRIBUTING.md'],
+        ['./.github/ISSUE_TEMPLATE'],
+        ['./LICENSE.md', './LICENSE.txt'],
+        ['./.github/PULL_REQUEST_TEMPLATE'],
+        ['./README.md'],
+        ['./TROUBLESHOOTING.md'],
+        ['./USAGE.md'],
+        ['./USE_CASES.md']
+    ]
+
+    def _all_file(self, files):
+        '''
+        Checks the list of files and sees if they exist. If all of them don't
+        exist, returns False. Otherwise, return True.
+        '''
+        return all(map(lambda f: not path.isfile(f), files))
+
+    def test_file_existance(self):
+        missing = list(filter(self._all_file, self.FILES))
+        self.assertTrue(len(missing) == 0,
+                        "Files %s aren't found" % str(missing))
diff --git a/tests/test_unit.py b/tests/test_unit.py
@@ -1,4 +1,5 @@
 import os
+import pickle
 from os import path
 try:
     import unittest2 as unittest
@@ -30,10 +31,12 @@
 
 
 class MockException(HTTPError):
-    def __init__(self,code):
+
+    def __init__(self, code):
         self.code = code
         self.reason = 'REASON'
         self.hdrs = 'HEADERS'
+
     def read(self):
         return 'BODY'
 
@@ -60,21 +63,22 @@ def __init__(self, host, response_code):
         Client.__init__(self, host)
 
     def _make_request(self, opener, request):
-        if 200 <= self.response_code <299:   # if successsful code
+
+        if 200 <= self.response_code < 299:   # if successsful code
             return MockResponse(self.response_code)
         else:
             raise handle_error(MockException(self.response_code))
 
 
-
 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,
@@ -112,10 +116,13 @@ 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')
-        query_params = {'hello': 0, 'world': 1, 'ztest': [0,1]}
+                                   '/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)
 
@@ -170,19 +177,26 @@ def test__getattr__(self):
         self.assertEqual(r.status_code, 204)
 
         mock_client.response_code = 400
-        self.assertRaises(BadRequestsError,mock_client.get)
+        self.assertRaises(BadRequestsError, mock_client.get)
 
         mock_client.response_code = 404
-        self.assertRaises(NotFoundError,mock_client.post)
+        self.assertRaises(NotFoundError, mock_client.post)
 
         mock_client.response_code = 415
-        self.assertRaises(UnsupportedMediaTypeError,mock_client.patch)
+        self.assertRaises(UnsupportedMediaTypeError, mock_client.patch)
 
         mock_client.response_code = 503
-        self.assertRaises(ServiceUnavailableError,mock_client.delete)
+        self.assertRaises(ServiceUnavailableError, mock_client.delete)
 
         mock_client.response_code = 523
-        self.assertRaises(HTTPError,mock_client.delete)
+        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")
+
 
 if __name__ == '__main__':
     unittest.main()
