Use API key environment variable by default

Author: jm-mailosaur

README.md

@@ -10,17 +10,30 @@ Mailosaur lets you automate email and SMS tests as part of software development
 
 This guide provides several key sections:
 
+- [Mailosaur - Python library · ](#mailosaur---python-library--)
   - [Get Started](#get-started)
+  - [Installation](#installation)
+    - [Set your API key](#set-your-api-key)
+    - [Create your code](#create-your-code)
+    - [API Reference](#api-reference)
   - [Creating an account](#creating-an-account)
   - [Test email addresses with Mailosaur](#test-email-addresses-with-mailosaur)
   - [Find an email](#find-an-email)
+    - [What is this code doing?](#what-is-this-code-doing)
   - [Find an SMS message](#find-an-sms-message)
   - [Testing plain text content](#testing-plain-text-content)
+    - [Extracting verification codes from plain text](#extracting-verification-codes-from-plain-text)
   - [Testing HTML content](#testing-html-content)
+    - [Working with HTML using Beautiful Soup](#working-with-html-using-beautiful-soup)
   - [Working with hyperlinks](#working-with-hyperlinks)
+    - [Links in plain text (including SMS messages)](#links-in-plain-text-including-sms-messages)
   - [Working with attachments](#working-with-attachments)
   - [Working with images and web beacons](#working-with-images-and-web-beacons)
+    - [Remotely-hosted images](#remotely-hosted-images)
+    - [Triggering web beacons](#triggering-web-beacons)
   - [Spam checking](#spam-checking)
+  - [Development](#development)
+  - [Contacting us](#contacting-us)
 
 You can find the full [Mailosaur documentation](https://mailosaur.com/docs/) on the website.
 
@@ -32,11 +45,21 @@ If you get stuck, just contact us at support@mailosaur.com.
 pip install --upgrade mailosaur
 ```
 
-Then import the library into your code. The value for `YOUR_API_KEY` is covered in the next step ([creating an account](#creating-an-account)):
+### Set your API key
+
+Get your API key from the Mailosaur Dashboard and set it as an environment variable:
+
+```sh
+export MAILOSAUR_API_KEY='your-api-key-here'
+```
+
+### Create your code
+
+Then import the library and create a client:
 
 ```py
 from mailosaur import MailosaurClient
-mailosaur = MailosaurClient("YOUR_API_KEY")
+mailosaur = MailosaurClient()
 ```
 
 ### API Reference
@@ -80,7 +103,7 @@ In automated tests you will want to wait for a new email to arrive. This library
 from mailosaur import MailosaurClient
 from mailosaur.models import SearchCriteria
 
-mailosaur = MailosaurClient("API_KEY")
+mailosaur = MailosaurClient()
 
 # See https://mailosaur.com/app/project/api
 server_id = "abc123"
@@ -96,7 +119,7 @@ print(email.subject) # "Hello world!"
 
 ### What is this code doing?
 
-1. Sets up an instance of `MailosaurClient` with your API key.
+1. Sets up an instance of `MailosaurClient` using the `MAILOSAUR_API_KEY` environment variable.
 2. Waits for an email to arrive at the server with ID `abc123`.
 3. Outputs the subject line of the email.
 
@@ -110,7 +133,7 @@ If your account has [SMS testing](https://mailosaur.com/sms-testing/) enabled, y
 from mailosaur import MailosaurClient
 from mailosaur.models import SearchCriteria
 
-mailosaur = MailosaurClient("API_KEY")
+mailosaur = MailosaurClient()
 
 # See https://mailosaur.com/app/project/api
 server_id = "abc123"

mailosaur/mailosaur_client.py

@@ -8,6 +8,7 @@
     More options at https://mailosaur.com/docs/email/
 """
 
+import os
 import uuid
 import requests
 
@@ -24,8 +25,15 @@
 class MailosaurClient(object):
     """ Main class to access Mailosaur.com api. """
 
-    def __init__(self, api_key, base_url="https://mailosaur.com/"):
+    def __init__(self, api_key=None, base_url="https://mailosaur.com/"):
         """ Pass in your mailbox id and api key to authenticate """
+        api_key = api_key or os.environ.get('MAILOSAUR_API_KEY')
+
+        if not api_key:
+            raise ValueError(
+                "'api_key' must be set via the MAILOSAUR_API_KEY environment "
+                "variable, or passed to the MailosaurClient constructor.")
+
         session = requests.Session()
         session.auth = (api_key, '')
         session.headers.update({'User-Agent': 'mailosaur-python/8.0.0'})

tests/devices_test.py

@@ -8,14 +8,9 @@
 class DevicesTest(TestCase):
     @classmethod
     def setUpClass(self):
-        api_key = os.getenv('MAILOSAUR_API_KEY')
         base_url = os.getenv('MAILOSAUR_BASE_URL')
 
-        if api_key is None:
-            raise Exception(
-                "Missing necessary environment variables - refer to README.md")
-
-        self.client = MailosaurClient(api_key, base_url)
+        self.client = MailosaurClient(base_url=base_url)
 
     def test_crud(self):
         device_name = "My test"

tests/emails_test.py

@@ -11,16 +11,15 @@
 class EmailsTest(TestCase):
     @classmethod
     def setUpClass(cls):
-        api_key = os.getenv('MAILOSAUR_API_KEY')
         base_url = os.getenv('MAILOSAUR_BASE_URL')
         cls.server = os.getenv('MAILOSAUR_SERVER')
         cls.verified_domain = os.getenv('MAILOSAUR_VERIFIED_DOMAIN')
 
-        if (api_key or cls.server) is None:
+        if cls.server is None:
             raise Exception(
                 "Missing necessary environment variables - refer to README.md")
 
-        cls.client = MailosaurClient(api_key, base_url)
+        cls.client = MailosaurClient(base_url=base_url)
 
         cls.client.messages.delete_all(cls.server)
 

tests/errors_test.py

@@ -7,13 +7,8 @@
 class ErrorsTest(TestCase):
     @classmethod
     def setUpClass(self):
-        self.api_key = os.getenv('MAILOSAUR_API_KEY')
         self.base_url = os.getenv('MAILOSAUR_BASE_URL')
 
-        if self.api_key is None:
-            raise Exception(
-                "Missing necessary environment variables - refer to README.md")
-
     def test_unauthorized(self):
         client = MailosaurClient('invalid_key', self.base_url)
 
@@ -24,7 +19,7 @@ def test_unauthorized(self):
             'Authentication failed, check your API key.', context.exception.message)
 
     def test_not_found(self):
-        client = MailosaurClient(self.api_key, self.base_url)
+        client = MailosaurClient(base_url=self.base_url)
 
         with self.assertRaises(MailosaurException) as context:
             client.servers.get('not_found')
@@ -33,7 +28,7 @@ def test_not_found(self):
             'Not found, check input parameters.', context.exception.message)
 
     def test_bad_request(self):
-        client = MailosaurClient(self.api_key, self.base_url)
+        client = MailosaurClient(base_url=self.base_url)
 
         with self.assertRaises(MailosaurException) as context:
             options = ServerCreateOptions()

tests/files_test.py

@@ -7,14 +7,13 @@
 class EmailsTest(TestCase):
     @classmethod
     def setUpClass(cls):
-        api_key = os.getenv('MAILOSAUR_API_KEY')
         base_url = os.getenv('MAILOSAUR_BASE_URL')
         cls.server = os.getenv('MAILOSAUR_SERVER')
 
-        if (api_key or cls.server) is None:
+        if cls.server is None:
             raise Exception("Missing necessary environment variables - refer to README.md")
 
-        cls.client = MailosaurClient(api_key, base_url)
+        cls.client = MailosaurClient(base_url=base_url)
 
         cls.client.messages.delete_all(cls.server)
 

tests/previews_test.py

@@ -11,15 +11,14 @@
 class PreviewsTest(TestCase):
     @classmethod
     def setUpClass(cls):
-        api_key = os.getenv('MAILOSAUR_API_KEY')
         base_url = os.getenv('MAILOSAUR_BASE_URL')
         cls.server = os.getenv('MAILOSAUR_SERVER')
 
-        if api_key is None or cls.server is None:
+        if cls.server is None:
             raise Exception(
                 "Missing necessary environment variables - refer to README.md")
 
-        cls.client = MailosaurClient(api_key, base_url)
+        cls.client = MailosaurClient(base_url=base_url)
 
     def test_list_clients(self):
         result = self.client.previews.list_email_clients()

tests/servers_test.py

@@ -8,14 +8,9 @@
 class ServersTest(TestCase):
     @classmethod
     def setUpClass(self):
-        api_key = os.getenv('MAILOSAUR_API_KEY')
         base_url = os.getenv('MAILOSAUR_BASE_URL')
 
-        if api_key is None:
-            raise Exception(
-                "Missing necessary environment variables - refer to README.md")
-
-        self.client = MailosaurClient(api_key, base_url)
+        self.client = MailosaurClient(base_url=base_url)
 
     def test_list(self):
         result = self.client.servers.list()

tests/usage_test.py

@@ -5,13 +5,9 @@
 class UsageTest(TestCase):
     @classmethod
     def setUpClass(self):
-        api_key = os.getenv('MAILOSAUR_API_KEY')
         base_url = os.getenv('MAILOSAUR_BASE_URL')
 
-        if api_key is None:
-            raise Exception("Missing necessary environment variables - refer to README.md")
-
-        self.client = MailosaurClient(api_key, base_url)
+        self.client = MailosaurClient(base_url=base_url)
 
     def test_account_limits(self):
         result = self.client.usage.limits()