[TOOLSLIBS-2387] Add file_data to EmailAttachment (#218)

* adds file_data to email attachment

* update for version bump

* fix some typing issues

* additional type checks

* true up local and CI mypy runs

* mypy issues

* fix or ignore mypy issues

* more ci mypy fixes

* more typing return fixes

* mypy thrashin

Author: aschuman0

.github/workflows/test_runner.yaml

@@ -21,7 +21,7 @@ jobs:
           python -m pip install -r requirements-dev.txt
       - name: Type check with mypy
         run: |
-          mypy urbanairship/
+          mypy --config-file=pyproject.toml --ignore-missing-imports --disable-error-code=no-any-return urbanairship/
       - name: Test with pytest
         run: |
           python -m pytest

.pre-commit-config.yaml

@@ -45,9 +45,11 @@ repos:
     rev: v1.9.0
     hooks:
     -   id: mypy
+        args: [--config-file=pyproject.toml, --ignore-missing-imports, --disable-error-code=no-any-return]
+        files: ^urbanairship/
+        exclude: ^docs/
         additional_dependencies:
             - types-requests>=2.31.0.20240311
             - types-six>=1.16.21.20240311
             - types-mock>=5.1.0.20240311
             - types-urllib3
-        exclude: ^(docs/|tests/)

CHANGELOG

@@ -1,5 +1,9 @@
 # urbanairship changelog
 
+## 7.1.0
+
+- Adds file_data argument to the EmailAttachment class fir passing stringified file data.
+
 ## 7.0.0
 
 - Adds package type annotations

pyproject.toml

@@ -42,7 +42,6 @@ include = '\.pyi?$'
 [tool.isort]
 profile = "black"
 multi_line_output = 3
-line-length = 99
 include_trailing_comma = true
 force_grid_wrap = 0
 use_parentheses = true
@@ -84,3 +83,28 @@ omit = [
     "tests/*",
     "setup.py",
 ]
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = false
+disallow_incomplete_defs = false
+check_untyped_defs = false
+disallow_untyped_decorators = false
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+warn_unreachable = true
+strict_equality = true
+show_error_codes = true
+ignore_missing_imports = true
+disable_error_code = "unreachable"
+
+[[tool.mypy.overrides]]
+module = [
+    "tests.*",
+    "docs.*",
+]
+ignore_errors = true

tests/devices/test_email.py

@@ -81,9 +81,9 @@ def test_email_update_payload(self):
     def test_email_reg(self):
         with mock.patch.object(ua.Airship, "_request") as mock_request:
             response = requests.Response()
-            response._content = json.dumps(
-                {"ok": True, "channel_id": self.channel_id}
-            ).encode("utf-8")
+            response._content = json.dumps({"ok": True, "channel_id": self.channel_id}).encode(
+                "utf-8"
+            )
             response.status_code = 201
             mock_request.return_value = response
 
@@ -98,9 +98,9 @@ def test_email_w_opt_dates(self):
         test_date = "2018-11-06T12:00:00Z"
         with mock.patch.object(ua.Airship, "_request") as mock_request:
             response = requests.Response()
-            response._content = json.dumps(
-                {"ok": True, "channel_id": self.channel_id}
-            ).encode("utf-8")
+            response._content = json.dumps({"ok": True, "channel_id": self.channel_id}).encode(
+                "utf-8"
+            )
             response.status_code = 201
             mock_request.return_value = response
 
@@ -121,9 +121,9 @@ def test_email_w_opt_dates(self):
     def test_email_update(self):
         with mock.patch.object(ua.Airship, "_request") as mock_request:
             response = requests.Response()
-            response._content = json.dumps(
-                {"ok": True, "channel_id": self.channel_id}
-            ).encode("utf-8")
+            response._content = json.dumps({"ok": True, "channel_id": self.channel_id}).encode(
+                "utf-8"
+            )
             response.status_code = 200
             mock_request.return_value = response
 
@@ -137,9 +137,9 @@ def test_email_update(self):
     def test_email_reg_w_opts(self):
         with mock.patch.object(ua.Airship, "_request") as mock_request:
             response = requests.Response()
-            response._content = json.dumps(
-                {"ok": True, "channel_id": self.channel_id}
-            ).encode("utf-8")
+            response._content = json.dumps({"ok": True, "channel_id": self.channel_id}).encode(
+                "utf-8"
+            )
             response.status_code = 201
             mock_request.return_value = response
 
@@ -161,9 +161,9 @@ def test_email_reg_w_opts(self):
     def test_email_uninstall(self):
         with mock.patch.object(ua.Airship, "_request") as mock_request:
             response = requests.Response()
-            response._content = json.dumps(
-                {"ok": True, "channel_id": self.channel_id}
-            ).encode("utf-8")
+            response._content = json.dumps({"ok": True, "channel_id": self.channel_id}).encode(
+                "utf-8"
+            )
             response.status_code = 200
             mock_request.return_value = response
 
@@ -188,9 +188,7 @@ def test_email_lookup(self):
             lookup = ua.Email.lookup(airship=self.airship, address=self.address)
 
             self.assertEqual(200, lookup.status_code)
-            self.assertEqual(
-                "email", json.loads(lookup.content)["channel"]["device_type"]
-            )
+            self.assertEqual("email", json.loads(lookup.content)["channel"]["device_type"])
 
 
 class TestEmailTags(unittest.TestCase):
@@ -256,19 +254,30 @@ def testSetWithAddAndRemove(self):
 
 class TestEmailAttachment(unittest.TestCase):
     def setUp(self):
+        with open("tests/data/logo.png", "rb") as f:
+            self.file_bytes = f.read()
+        self.encoded = str(base64.urlsafe_b64encode(self.file_bytes))
+
         self.attachment = ua.EmailAttachment(
             airship=ua.Airship(TEST_KEY, TEST_SECRET),
             filename="test_file.png",
             content_type='image/png; charset="UTF-8"',
             filepath="tests/data/logo.png",
         )
-        file = open("tests/data/logo.png", "rb").read()
-        self.encoded = str(base64.urlsafe_b64encode(file))
 
-    def test_encoding(self):
+    def test_encoding_with_filepath(self):
         self.assertEqual(self.encoded, self.attachment.req_payload.get("data"))
 
-    def test_payload(self):
+    def test_encoding_with_file_data(self):
+        attachment_with_data = ua.EmailAttachment(
+            airship=ua.Airship(TEST_KEY, TEST_SECRET),
+            filename="test_file.png",
+            content_type='image/png; charset="UTF-8"',
+            file_data=self.file_bytes,
+        )
+        self.assertEqual(self.encoded, attachment_with_data.req_payload.get("data"))
+
+    def test_payload_with_filepath(self):
         self.assertDictEqual(
             self.attachment.req_payload,
             {
@@ -277,3 +286,53 @@ def test_payload(self):
                 "data": self.encoded,
             },
         )
+
+    def test_payload_with_file_data(self):
+        attachment_with_data = ua.EmailAttachment(
+            airship=ua.Airship(TEST_KEY, TEST_SECRET),
+            filename="test_file.png",
+            content_type='image/png; charset="UTF-8"',
+            file_data=self.file_bytes,
+        )
+        self.assertDictEqual(
+            attachment_with_data.req_payload,
+            {
+                "filename": "test_file.png",
+                "content_type": 'image/png; charset="UTF-8"',
+                "data": self.encoded,
+            },
+        )
+
+    def test_validation_no_parameters(self):
+        with self.assertRaises(ValueError) as context:
+            ua.EmailAttachment(
+                airship=ua.Airship(TEST_KEY, TEST_SECRET),
+                filename="test_file.png",
+                content_type='image/png; charset="UTF-8"',
+            )
+        self.assertIn("filepath or file_data must be provided", str(context.exception))
+
+    def test_validation_both_parameters(self):
+        with self.assertRaises(ValueError) as context:
+            ua.EmailAttachment(
+                airship=ua.Airship(TEST_KEY, TEST_SECRET),
+                filename="test_file.png",
+                content_type='image/png; charset="UTF-8"',
+                filepath="tests/data/logo.png",
+                file_data=self.file_bytes,
+            )
+        self.assertIn("filepath and file_data cannot both be provided", str(context.exception))
+
+    def test_post_method(self):
+        with mock.patch.object(ua.Airship, "_request") as mock_request:
+            response = requests.Response()
+            response._content = json.dumps({"ok": True, "attachment_ids": ["test-id"]}).encode(
+                "utf-8"
+            )
+            response.status_code = 200
+            mock_request.return_value = response
+
+            result = self.attachment.post()
+
+            self.assertEqual({"ok": True, "attachment_ids": ["test-id"]}, result)
+            mock_request.assert_called_once()

urbanairship/__about__.py

@@ -1 +1 @@
-__version__ = "7.0.0"
+__version__ = "7.1.0"