sendgrid · nishantmadu · Jun 16, 2017 · Jul 31, 2017 · Jul 31, 2017 · Jul 31, 2017
diff --git a/.codeclimate.yml b/.codeclimate.yml
@@ -0,0 +1,3 @@
+plugins:
+  pep8:
+    enabled: true
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,4 @@
+[run]
+branch = True
+source = sendgrid
+omit = site-packages
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
@@ -0,0 +1,24 @@
+<!--
+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.
+
+
+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.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 bin/
+env/
 include/
 lib/
 .Python
@@ -15,4 +16,9 @@ venv/
 .tox/
 profile*
 README.txt
-temp*.py
+.coverage
+coverage.xml
+htmlcov
+temp*.py
+sendgrid.env
+
diff --git a/.travis.yml b/.travis.yml
@@ -8,18 +8,37 @@ python:
 - '3.5'
 - '3.6'
 install:
+- if [[ $TRAVIS_PYTHON_VERSION == 2.6* ]]; then pip install unittest2; fi
 - python setup.py install
 - pip install pyyaml
 - pip install flask
 - pip install six
+- pip install pypandoc
+- pip install coverage
+- pip install codecov
+# - sudo apt-get install -y pandoc
+addons:
+  apt_packages:
+    - pandoc
 before_script:
-- mkdir prism
-- mkdir prism/bin
-- export PATH=$PATH:$PWD/prism/bin/
-- ./test/prism.sh
+- . ./test/prism.sh
+- prism version
 script:
-- if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]]; then unit2 discover; else python -m unittest
-  discover; fi
+- if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]]; then coverage run -m unittest2 discover; else coverage run -m unittest discover; fi
+after_script:
+- codecov
+before_deploy:
+- python ./register.py
+deploy:
+  provider: pypi
+  user: thinkingserious
+  password:
+    secure: DoM21KiMKkt/7AS6zOqTs7j3fgInrpswRTPG3cqBNRSzyfkXeXmKecCPruooxvYKLM7fPNDOuIH2phgCjdx/XBtJwghNh34n+TzhNFEiI/6pV0iS4a9gW0+QU+GMYvQmfNlA9DKQ5N20FMy4XeK8QQFarJXQwW1/a5wWftbUYvQ=
+  skip_cleanup: true
+  distributions: sdist bdist_wheel
+  on:
+    tags: true
+    python: '3.6'
 notifications:
   hipchat:
     rooms:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,42 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [5.3.0] - 2017-10-23 ##
+### Added
+- Pull #348: Allows users to submit rfc822 formatted email addresses
+- Big thanks to [Matt Bernier](https://github.com/mbernier) for the pull request!
+
+## [5.2.1] - 2017-10-21 ##
+### Fixed
+- Pull #364: Install prism with non superuser account 
+- Big thanks to [meahow](https://github.com/meahow) for the pull request!
+
+## [5.2.0] - 2017-08-31 ##
+### Added
+- Pull #335: Permit unicode string values with Substitution helper
+- Big thanks to [Mehron Kugler](https://github.com/mehronkugler) for the pull request!
+
+## [5.1.0] - 2017-08-30 ##
+### Added
+- Pull #338: Allow the `__str__` method for the `Mail` object return an `String` instead of a `NoneType`
+- Solves #292: The `__str__` method of the `Mail` class, doesn't actually return anything
+- Big thanks to [belfazt](https://github.com/belfazt) for the pull request!
+
+## [5.0.1] - 2017-08-29
+### Fix
+- Pull #337, fixes issue #366
+- On install, some experienced: `ValueError: ("Expected ',' or end-of-list in", 'python-http-client ==3.0.*', 'at', '*')`
+
+## [5.0.0] - 2017-08-11
+### BREAKING CHANGE
+- The breaking change actually happened in [version 4.2.1](https://github.com/sendgrid/sendgrid-python/releases/tag/v4.2.1), where I mistakenly applied a patch version bump. See issues #328 and #321 for details.
+- This version (5.0.0) replaces error handling via HTTPError from urllib in favor of custom error handling via the [HTTPError class](https://github.com/sendgrid/python-http-client/blob/master/python_http_client/exceptions.py) as was the case in version 4.2.0.
+
+## [4.2.1] - 2017-08-03 ##
+### Fixed
+- Issue #321: Installing 4.2.0 installs the wrong version of python-http-client
+- Big thanks to [w-](https://github.com/w-) for the heads up!
+
 ## [4.2.0] - 2017-06-01 ##
 ### Added
 - Pull #318 Add ability to reset request headers on client attribute
@@ -15,7 +51,7 @@ All notable changes to this project will be documented in this file.
 ### BREAKING CHANGE
 - Pull #244 [refactor helpers using property getter/setter](https://github.com/sendgrid/sendgrid-python/pull/244/files)
 - Big thanks to [Denis Vlasov](https://github.com/denis90) for the pull request!
-- The changes break the impelmentation of the [Mail Helper](https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/mail) `Mail()` class
+- The changes break the implementation of the [Mail Helper](https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/mail) `Mail()` class
 - `set_from()` is now the property `from_email`
 - `set_subject()` is now the property `subject`
 - `set_template_id()` is now the property `template_id`
@@ -273,7 +309,7 @@ All notable changes to this project will be documented in this file.
 ## [1.5.9] - 2015-10-26 ##
 
 ### Added ###
-- Supression Unsubscribes [GET]
+- Suppression Unsubscribes [GET]
 
 ## [1.5.8] - 2015-10-21 ##
 
@@ -306,7 +342,7 @@ All notable changes to this project will be documented in this file.
 ### Added ###
 - Refactored tests and added Tox support
 - Framework for Web API v3 endpoints
-- Web API v3 endpionts: apikeys, ASM groups and ASM suppressions
+- Web API v3 endpoints: apikeys, ASM groups and ASM suppressions
 
 ### Fixed  ###
 - Python 3 Fix [#126](https://github.com/sendgrid/sendgrid-python/issues/126)

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,41 @@
+# SendGrid Community Code of Conduct
+
+ The SendGrid open source community is made up of members from around the globe with a diverse set of skills, personalities, and experiences. It is through these differences that our community experiences successes and continued growth. When you're working with members of the community, we encourage you to follow these guidelines, which help steer our interactions and strive to maintain a positive, successful and growing community. 
+
+ ### Be Open
+ Members of the community are open to collaboration, whether it's on pull requests, code reviews, approvals, issues or otherwise. We're receptive to constructive comments and criticism, as the experiences and skill sets of all members contribute to the whole of our efforts. We're accepting of all who wish to take part in our activities, fostering an environment where anyone can participate, and everyone can make a difference.
+
+ ### Be Considerate
+ Members of the community are considerate of their peers, which include other contributors and users of SendGrid. We're thoughtful when addressing the efforts of others, keeping in mind that often the labor was completed with the intent of the good of the community. We're attentive in our communications, whether in person or online, and we're tactful when approaching differing views.
+
+ ### Be Respectful
+ Members of the community are respectful. We're respectful of others, their positions, their skills, their commitments and their efforts. We're respectful of the volunteer efforts that permeate the SendGrid community. We're respectful of the processes outlined in the community, and we work within them. When we disagree, we are courteous in raising our issues.  Overall, we're good to each other. We contribute to this community not because we have to, but because we want to. If we remember that, these guidelines will come naturally.
+
+ ## Additional Guidance 
+
+ ### Disclose Potential Conflicts of Interest
+ Community discussions often involve interested parties. We expect participants to be aware when they are conflicted due to employment or other projects they are involved in and disclose those interests to other project members. When in doubt, over-disclose. Perceived conflicts of interest are important to address so that the community’s decisions are credible even when unpopular, difficult or favorable to the interests of one group over another.
+
+ ### Interpretation
+ This Code is not exhaustive or complete. It is not a rulebook; it serves to distill our common understanding of a collaborative, shared environment and goals. We expect it to be followed in spirit as much as in the letter.  When in doubt, try to abide by [SendGrid’s cultural values](https://sendgrid.com/blog/employee-engagement-the-4h-way) defined by our “4H’s”: Happy, Hungry, Humble and Honest.  
+
+ ### Enforcement
+ Most members of the SendGrid community always comply with this Code, not because of the existence of this Code, but because they have long experience participating in open source communities where the conduct described above is normal and expected. However, failure to observe this Code may be grounds for suspension, reporting the user for abuse or changing permissions for outside contributors.
+
+ ## If you have concerns about someone’s conduct
+ **Initiate Direct Contact** - It is always appropriate to email a community member (if contact information is available), mention that you think their behavior was out of line, and (if necessary) point them to this Code.
+
+ **Discuss Publicly** - Discussing publicly is always acceptable. Note, though, that approaching the person directly may be better, as it tends to make them less defensive, and it respects the time of other community members, so you probably want to try direct contact first.
+
+ **Contact the Moderators** - You can reach the SendGrid moderators by emailing [email protected].
+
+ ## Submission to SendGrid Repositories
+ Finally, just a reminder, changes to the SendGrid repositories will only be accepted upon completion of the [SendGrid Contributor Agreement](https://cla.sendgrid.com). 
+
+ ## Attribution
+
+ SendGrid thanks the following, on which it draws for content and inspiration:
+
+  [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/)  
+  [Open Source Initiative General Code of Conduct](https://opensource.org/codeofconduct) 
+  [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html) 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,13 +2,13 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou
 
 - [CLAs and CCLAs](#cla)
 - [Roadmap & Milestones](#roadmap)
-- [Feature Request](#feature_request)
-- [Submit a Bug Report](#submit_a_bug_report)
-- [Improvements to the Codebase](#improvements_to_the_codebase)
-- [Understanding the Code Base](#understanding_the_codebase)
+- [Feature Request](#feature-request)
+- [Submit a Bug Report](#submit-a-bug-report)
+- [Improvements to the Codebase](#improvements-to-the-codebase)
+- [Understanding the Code Base](#understanding-the-codebase)
 - [Testing](#testing)
-- [Style Guidelines & Naming Conventions](#style_guidelines_and_naming_conventions)
-- [Creating a Pull Request](#creating_a_pull_request)
+- [Style Guidelines & Naming Conventions](#style-guidelines-and-naming-conventions)
+- [Creating a Pull Request](#creating-a-pull-request)
 
 <a name="roadmap"></a>
 We use [Milestones](https://github.com/sendgrid/sendgrid-python/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.
@@ -26,7 +26,7 @@ When you create a Pull Request, after a few seconds, a comment will appear with
 
 There are a few ways to contribute, which we'll enumerate below:
 
-<a name="feature_request"></a>
+<a name="feature-request"></a>
 ## Feature Request
 
 If you'd like to make a feature request, please read this section.
@@ -36,7 +36,7 @@ The GitHub issue tracker is the preferred channel for library feature requests,
 - Please **search for existing issues** in order to ensure we don't have duplicate bugs/feature requests.
 - Please be respectful and considerate of others when commenting on issues
 
-<a name="submit_a_bug_report"></a>
+<a name="submit-a-bug-report"></a>
 ## Submit a Bug Report
 
 Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.
@@ -53,13 +53,16 @@ Before you decide to create a new issue, please try the following:
 
 In order to make the process easier, we've included a [sample bug report template]((https://github.com/sendgrid/sendgrid-python/.github/ISSUE_TEMPLATE)) (borrowed from [Ghost](https://github.com/TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown/) for formatting.
 
-<a name="improvements_to_the_codebase"></a>
+<a name="improvements-to-the-codebase"></a>
 ## Improvements to the Codebase
 
 We welcome direct contributions to the sendgrid-python code base. Thank you!
 
 ### Development Environment ###
 
+#### Using Docker ####
+You can use our Docker image to avoid setting up the development environment yourself.  See [USAGE.md](https://github.com/sendgrid/sendgrid-python/blob/master/docker/USAGE.md).
+
 #### Install and Run Locally ####
 
 ##### Prerequisites #####
@@ -92,7 +95,7 @@ See the [examples folder](https://github.com/sendgrid/sendgrid-python/tree/maste
 
 If testing from the root directory of this repo, create a new file (e.g. test.py) and replace `import sendgrid` with `from sendgrid import *`
 
-<a name="understanding_the_codebase"></a>
+<a name="understanding-the-codebase"></a>
 ## Understanding the Code Base
 
 **/examples**
@@ -128,12 +131,15 @@ For Python 2.7.* and up:
 
 All PRs require passing tests before the PR will be reviewed.
 
-#### Prequisites: ####
+#### Prerequisites: ####
 
 The above local "Initial setup" is complete
 
 * [pyenv](https://github.com/yyuu/pyenv)
 * [tox](https://pypi.python.org/pypi/tox)
+* [prism](https://github.com/stoplightio/prism) v0.6 - It should be available in your PATH, but unittest script
+will try to install it locally if not found. Apart from PATH env variable it will check in `~/bin` and `/usr/local/bin`.
+You can install by yourself it in user dir by calling `source test/prism.sh`.
 
 #### Initial setup: ####
 
@@ -156,7 +162,7 @@ source venv/bin/activate
 tox
 ```
 
-<a name="style_guidelines_and_naming_conventions"></a>
+<a name="style-guidelines-and-naming-conventions"></a>
 ## Style Guidelines & Naming Conventions
 
 Generally, we follow the style guidelines as suggested by the official language. However, we ask that you conform to the styles that already exist in the library. If you wish to deviate, please explain your reasoning.
@@ -169,7 +175,7 @@ Please run your code through:
 - [pylint](https://www.pylint.org/)
 - [pep8](https://pypi.python.org/pypi/pep8)
 
-## Creating a Pull Request<a name="creating_a_pull_request"></a>
+## Creating a Pull Request<a name="creating-a-pull-request"></a>
 
 1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork,
    and configure the remotes:
@@ -199,7 +205,7 @@ Please run your code through:
 
 4. Commit your changes in logical chunks. Please adhere to these [git commit
    message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
-   or your code is unlikely be merged into the main project. Use Git's
+   or your code is unlikely to be merged into the main project. Use Git's
    [interactive rebase](https://help.github.com/articles/interactive-rebase)
    feature to tidy up your commits before making them public.
 

diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,4 +1,4 @@
-Copyright (c) 2012-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 in the Software without restriction, including without limitation