Merge branch 'master' into master

Author: Matt Bernier

.env_sample

@@ -0,0 +1 @@
+export SENDGRID_API_KEY=''

.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:[email protected]), or file a Github Issue in this repository.

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

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
 

python_http_client/client.py

@@ -117,10 +117,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)
+
         if self._version:
             url = self._build_versioned_url(url)
         else:
             url = self.host + url
+
         return url
 
     def _update_headers(self, request_headers):
@@ -210,6 +212,7 @@ 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:
@@ -226,16 +229,23 @@ def http_request(*_, **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

register.py

@@ -1,17 +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'
+
+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)

setup.py

@@ -2,6 +2,7 @@
 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()

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)

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))

tests/test_unit.py

@@ -1,4 +1,5 @@
 import os
+import pickle
 from os import path
 try:
     import unittest2 as unittest
@@ -30,6 +31,7 @@
 
 
 class MockException(HTTPError):
+
     def __init__(self, code):
         self.code = code
         self.reason = 'REASON'
@@ -61,17 +63,19 @@ 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
             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
@@ -112,11 +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]}
+
         built_url = self.client._build_url(query_params)
         self.assertEqual(built_url, url)
 
@@ -186,5 +192,11 @@ def test__getattr__(self):
         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()