Fixing the tests

Author: thinkingserious

.env_sample

@@ -0,0 +1,3 @@
+SENDGRID_API_KEY=your_sendgrid_api_key
+SENDGRID_USERNAME=your_sendgrid_username
+SENDGRID_PASSWORD=your_sendgrid_password

.gitignore

@@ -8,5 +8,6 @@ sdist
 *.egg
 *.egg-info
 *.pyc
-.idea/
 venv/
+.idea
+.env

CHANGELOG.md

@@ -1,10 +1,6 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [1.4.2] - 2015-09-15
-### Added
-- Upgrade Mail to new-style class, on Python 2.x.
-
 ## [1.4.1] - 2015-09-09
 ### Added
 - Classifiers for compatible python versions

README.rst

@@ -380,11 +380,11 @@ Tests
 ~~~~~
 
 .. code:: python
-
+    
     virtualenv venv
-    source venv/bin/activate
+    source venv/bin/activate #or . ./activate.sh
     python setup.py install
-    python test/__init__.py
+    unit2 discover
 
 Deploying
 ~~~~~~~~~

activate.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+# Use this to activate the virtual environment, use the following to execute in current shell
+# . ./activate
+source venv/bin/activate

example_v2_test.py

@@ -0,0 +1,19 @@
+import sendgrid
+import os
+if os.path.exists('.env'):
+    for line in open('.env'):
+        var = line.strip().split('=')
+        if len(var) == 2:
+            os.environ[var[0]] = var[1]
+
+sg = sendgrid.SendGridClient(os.environ.get('SENDGRID_USERNAME'), os.environ.get('SENDGRID_PASSWORD'))
+
+message = sendgrid.Mail()
+message.add_to('Elmer Thomas <[email protected]>')
+message.set_subject('Testing from the Python library')
+message.set_html('<b>This was a successful test!</b>')
+message.set_text('This was a successful test!')
+message.set_from('Elmer Thomas <[email protected]>')
+status, msg = sg.send(message)
+print status
+print msg

example_v3_test.py

@@ -0,0 +1,56 @@
+import sendgrid
+import json
+
+import os
+if os.path.exists('.env'):
+    for line in open('.env'):
+        var = line.strip().split('=')
+        if len(var) == 2:
+            os.environ[var[0]] = var[1]
+
+client = sendgrid.SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
+
+name = "My Amazing API Key"
+status, msg = client.apikeys.post(name)
+msg = json.loads(msg)
+api_key_id = msg['api_key_id']
+print status
+print msg
+
+name = "My NEW API Key 3000"
+status, msg = client.apikeys.patch(api_key_id, name)
+print status
+print msg
+
+status, msg = client.apikeys.delete(api_key_id)
+print status
+
+status, msg = client.apikeys.get()
+print status
+print msg
+
+"""
+# Get a list of all valid API Keys from your account
+status, msg = client.apikeys.get()
+print status
+print msg
+
+# Create a new API Key
+name = "My API Key 10"
+status, msg = client.apikeys.post(name)
+print status
+print msg
+
+# Delete an API Key with a given api_key_id
+api_key_id = "zc0r5sW5TTuBQGsMPMUx0A"
+status, msg = client.apikeys.delete(api_key_id)
+print status
+print msg
+
+# Update the name of an API Key, given an api_key_id
+api_key_id = "API_KEY"
+name = "My API Key 3"
+status, msg = client.apikeys.patch(api_key_id, name)
+print status
+print msg
+"""

sendgrid/__init__.py

@@ -1,4 +1,7 @@
 from .version import __version__
 from .sendgrid import SendGridClient
 from .exceptions import SendGridError, SendGridClientError, SendGridServerError
+#v2 API
 from .message import Mail
+#v3 API
+from .client import SendGridAPIClient

sendgrid/client.py

@@ -0,0 +1,90 @@
+import json
+from .version import __version__
+from socket import timeout
+try:
+    import urllib.request as urllib_request
+    from urllib.parse import urlencode
+    from urllib.error import HTTPError
+except ImportError:  # Python 2
+    import urllib2 as urllib_request
+    from urllib2 import HTTPError
+    from urllib import urlencode
+
+from .exceptions import SendGridClientError, SendGridServerError
+from resources.apikeys import APIKeys
+
+class SendGridAPIClient(object):
+
+    """SendGrid API."""
+
+    def __init__(self, apikey, **opts):
+        """
+        Construct SendGrid API object.
+
+        Args:
+            apikey: SendGrid API key
+            opts: You can pass in host or proxies
+        """
+        self._apikey = apikey
+        self.useragent = 'sendgrid/' + __version__ + ';python_v3'
+        self.host = opts.get('host', 'https://api.sendgrid.com')
+        # urllib cannot connect to SSL servers using proxies
+        self.proxies = opts.get('proxies', None)
+
+        self.apikeys = APIKeys(self)
+
+    @property
+    def apikey(self):
+        return self._apikey
+
+    @apikey.setter
+    def apikey(self, value):
+        self._apikey = value
+
+    def _build_request(self, url, json_header=False, method='GET', data=None):
+        if self.proxies:
+            proxy_support = urllib_request.ProxyHandler(self.proxies)
+            opener = urllib_request.build_opener(proxy_support)
+            urllib_request.install_opener(opener)
+        req = urllib_request.Request(url)
+        req.get_method = lambda: method
+        req.add_header('User-Agent', self.useragent)
+        req.add_header('Authorization', 'Bearer ' + self.apikey)
+        if json_header:
+            req.add_header('Content-Type', 'application/json')
+        try:
+            if data:
+                response = urllib_request.urlopen(req, json.dumps(data))
+            else:
+                response = urllib_request.urlopen(req, timeout=10)
+        except HTTPError as e:
+            if 400 <= e.code < 500:
+                raise SendGridClientError(e.code, e.read())
+            elif 500 <= e.code < 600:
+                raise SendGridServerError(e.code, e.read())
+            else:
+                assert False
+        except timeout as e:
+            raise SendGridClientError(408, 'Request timeout')
+        body = response.read()
+        return response, body
+
+    def get(self, api):
+        url = self.host + api.base_endpoint
+        response, body = self._build_request(url, False, 'GET')
+        return response.getcode(), body
+
+    def post(self, api, data):
+        url = self.host + api.endpoint
+        response, body = self._build_request(url, True, 'POST', data)
+        return response.getcode(), body
+
+    def delete(self, api):
+        url = self.host + api.endpoint
+        response, body = self._build_request(url, False, 'DELETE')
+        return response.getcode(), body
+
+    def patch(self, api, data):
+        url = self.host + api.endpoint
+        response, body = self._build_request(url, True, 'PATCH', data)
+        return response.getcode(), body

sendgrid/message.py

@@ -8,7 +8,7 @@
 from smtpapi import SMTPAPIHeader
 
 
-class Mail(object):
+class Mail():
 
     """SendGrid Message."""
 

sendgrid/resources/__init__.py

@@ -0,0 +1 @@
+

sendgrid/resources/apikeys.py

@@ -0,0 +1,63 @@
+class APIKeys(object):
+    """The API Keys feature allows customers to be able to generate an API Key credential 
+    which can be used for authentication with the SendGrid v3 Web API or the Mail API Endpoint"""
+    
+    def __init__(self, client , **opts):
+        """
+        Constructs SendGrid APIKeys object.
+        
+        See https://sendgrid.com/docs/API_Reference/Web_API_v3/API_Keys/index.html
+        """
+        self._name = None
+        self._base_endpoint = "/v3/api_keys"
+        self._endpoint = "/v3/api_keys"
+        self._client = client
+
+    @property
+    def name(self):
+        return self._name
+    
+    @name.setter
+    def name(self, value):
+        self._name = value
+
+    @property
+    def base_endpoint(self):
+        return self._base_endpoint
+
+    @property
+    def endpoint(self):
+        endpoint = self._endpoint
+        return endpoint
+        
+    @endpoint.setter
+    def endpoint(self, value):
+        self._endpoint = value
+
+    @property
+    def client(self):
+        return self._client
+        
+    # Get a list of active API keys
+    def get(self):
+        return self.client.get(self)
+        
+    # Create a new API key with name (string)
+    def post(self, name):
+        data = {}
+        self.name = name
+        data['name'] = self.name
+        return self.client.post(self, data)
+        
+    # Delete a API key
+    def delete(self, api_key_id):
+        self.endpoint = self._base_endpoint + "/" + api_key_id
+        return self.client.delete(self)
+        
+    # Update a API key's name
+    def patch(self, api_key_id, name):
+        data = {}
+        self.name = name
+        data['name'] = self.name
+        self.endpoint = self._base_endpoint + "/" + api_key_id
+        return self.client.patch(self, data)

sendgrid/version.py

@@ -1,2 +1,2 @@
-version_info = (1, 4, 2)
+version_info = (1, 4, 1)
 __version__ = '.'.join(str(v) for v in version_info)

setup.py

@@ -17,8 +17,8 @@ def getRequires():
 setup(
     name='sendgrid',
     version=str(__version__),
-    author='SendGrid',
-    author_email='libraries@sendgrid.com',
+    author='Yamil Asusta',
+    author_email='yamil@sendgrid.com',
     url='https://github.com/sendgrid/sendgrid-python/',
     packages=find_packages(),
     license='MIT',

test/__init__.py

@@ -5,7 +5,6 @@
     import unittest
 import json
 import sys
-import collections
 try:
     from StringIO import StringIO
 except ImportError:  # Python 3
@@ -15,8 +14,71 @@
 from sendgrid.exceptions import SendGridClientError, SendGridServerError
 from sendgrid.sendgrid import HTTPError
 
-SG_USER = os.getenv('SG_USER') or 'SENDGRID_USERNAME'
-SG_PWD  = os.getenv('SG_PWD') or 'SENDGRID_PASSWORD'
+if os.path.exists('.env'):
+    for line in open('.env'):
+        var = line.strip().split('=')
+        if len(var) == 2:
+            os.environ[var[0]] = var[1]
+
+SG_USER = os.environ.get('SENDGRID_USERNAME') or 'SENDGRID_USERNAME'
+SG_PWD  = os.environ.get('SENDGRID_PASSWORD') or 'SENDGRID_PASSWORD'
+
+# v3 tests
+from sendgrid.client import SendGridAPIClient
+from sendgrid.version import __version__
+
+SG_APIKEY = os.environ.get('SENDGRID_API_KEY') or 'SENDGRID_API_KEY'
+
+class TestSendGridAPIClient(unittest.TestCase):
+    def setUp(self):
+        self.client = SendGridAPIClient(SG_APIKEY)
+
+    def test_apikey_init(self):
+        self.assertEqual(self.client.apikey, SG_APIKEY)
+
+    def test_useragent(self):
+        useragent = 'sendgrid/' + __version__ + ';python_v3'
+        self.assertEqual(self.client.useragent, useragent)
+
+    def test_host(self):
+        host = 'https://api.sendgrid.com'
+        self.assertEqual(self.client.host, host)
+
+class TestAPIKeys(unittest.TestCase):
+    def setUp(self):
+        self.client = SendGridAPIClient(SG_APIKEY)
+
+    def test_apikey_post_patch_delete_test(self):
+        name = "My Amazing API Key of Wonder [PATCH Test]"
+        status, msg = self.client.apikeys.post(name)
+        self.assertEqual(status, 201)
+        msg = json.loads(msg)
+        api_key_id = msg['api_key_id']
+        self.assertEqual(msg['name'], name)
+        print status
+        print msg
+
+        name = "My NEW Amazing API Key of Wonder [PATCH TEST]"
+        status, msg = self.client.apikeys.patch(api_key_id, name)
+        self.assertEqual(status, 200)
+        print status
+        print msg
+
+        status, msg = self.client.apikeys.get()
+        print status
+        print msg
+
+        status, msg = self.client.apikeys.delete(api_key_id)
+        self.assertEqual(status, 204)
+        print status
+
+        status, msg = self.client.apikeys.get()
+        print status
+        print msg
+
+    def test_apikey_get(self):
+        status, msg = self.client.apikeys.get()
+        self.assertEqual(status, 200)
 
 class TestSendGrid(unittest.TestCase):