Fail connection for deprecated streams (#128)

* Fix unit tests

* Fail connection for specific selected streams

* Remove preserve_refresh_token

* Revert warning message

* Replace tap-tester_sandbox with vm reds

* Update config.yml

* Enable dev mode

* Update error message

* Update changelog

Author: prijendev

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 2.5.0
+  * Fail connection for deprecated streams [#128](https://github.com/singer-io/tap-xero/pull/128)
+
 ## 2.4.0
   * Bump singer-python version [#127](https://github.com/singer-io/tap-xero/pull/127)
 

setup.py

@@ -2,7 +2,7 @@
 from setuptools import setup, find_packages
 
 setup(name="tap-xero",
-      version="2.4.0",
+      version="2.5.0",
       description="Singer.io tap for extracting data from the Xero API",
       author="Stitch",
       url="http://singer.io",

tap_xero/__init__.py

@@ -19,6 +19,12 @@
 
 LOGGER = singer.get_logger()
 
+DEPRECATED_STREAM_IDS = [
+    "expense_claims",
+    "employees",
+    "receipts",
+]
+
 BAD_CREDS_MESSAGE = (
     "Failed to refresh OAuth token using the credentials from both the config and S3. "
     "The token might need to be reauthorized from the integration's properties "
@@ -110,7 +116,18 @@ def sync(ctx):
         stream.sync(ctx)
     ctx.state["currently_syncing"] = None
     ctx.write_state()
-
+    for stream_id in stream_ids_to_sync:
+        if stream_id in DEPRECATED_STREAM_IDS:
+            raise Exception(
+                "Employees, Expense Claims, and Receipts endpoints are deprecated and associated streams "
+                "`employees`, `expense_claims` and `receipts` will be removed on 28th April 2026. "
+                "Please deselect these streams to avoid sync errors. "
+                "Consider using the Invoices stream as a replacement for Expense Claims and Receipts. "
+                "For more details, see the Xero API documentation: "
+                "https://developer.xero.com/documentation/api/accounting/receipts, "
+                "https://developer.xero.com/documentation/api/accounting/employees, "
+                "https://developer.xero.com/documentation/api/accounting/expenseclaims"
+            )
 
 
 def main_impl():

tests/base.py

@@ -92,14 +92,10 @@ def expected_bookmarks(self):
             "overpayments": ["UpdatedDateUTC"],
             "prepayments": ["UpdatedDateUTC"],
             "purchase_orders": ["UpdatedDateUTC"],
-            "journals": ["JournalNumber"],
             "accounts": ["UpdatedDateUTC"],
             "bank_transfers": ["CreatedDateUTC"],
-            "employees": ["UpdatedDateUTC"],
-            "expense_claims": ["UpdatedDateUTC"],
             "items": ["UpdatedDateUTC"],
             "payments": ["UpdatedDateUTC"],
-            "receipts": ["UpdatedDateUTC"],
             "users": ["UpdatedDateUTC"],
             "linked_transactions": ["UpdatedDateUTC"],
             "quotes": ["UpdatedDateUTC"]
@@ -164,6 +160,8 @@ def select_found_catalogs(self, found_catalogs):
         # menagerie.post_annotated_catalogs(self.conn_id, selected)
         for catalog in found_catalogs:
             schema = menagerie.get_annotated_schema(self.conn_id, catalog['stream_id'])
+            if catalog['tap_stream_id'] in ["journals", "expense_claims", "receipts", "employees"]:
+                continue
             non_selected_properties = []
             additional_md = []
 

tests/test_xero_bookmarks.py

@@ -47,7 +47,7 @@ def check_bookmarks(self, bookmarks, max_bookmarks_from_records):
     def check_offsets(self, bookmarks):
         for stream, offset in self.expected_offsets.items():
             self.assertEqual(
-                bookmarks.get(stream, {}).get("offset"), offset,
+                bookmarks.get(stream, {}).get("offset", {}), offset,
                 msg=("unexpected offset found for stream {} {}. bookmarks: {}"
                      .format(stream, offset, bookmarks))
             )

tests/test_xero_future_dates_no_data.py

@@ -25,7 +25,6 @@ def state(self):
                 "overpayments": {"UpdatedDateUTC": future_date},
                 "prepayments": {"UpdatedDateUTC": future_date},
                 "purchase_orders": {"UpdatedDateUTC": future_date},
-                "journals": {"JournalNumber": 10e10},
                 "accounts": {"UpdatedDateUTC": future_date},
                 "bank_transfers": {"CreatedDateUTC": future_date},
                 "employees": {"UpdatedDateUTC": future_date},

tests/unittests/test_datetime_parsing.py

@@ -20,7 +20,7 @@ def test_normal_datetimes(self):
             strptime_to_utc('2020-01-01T12:30:00+0'),
         ]
 
-        self.assertEquals(parsed_dates, expected_dates)
+        self.assertEqual(parsed_dates, expected_dates)
 
     def test_epoch_datetimes(self):
         dates = [
@@ -39,7 +39,7 @@ def test_epoch_datetimes(self):
             datetime.datetime(1920, 5, 23, 00, 00, 00),
         ]
 
-        self.assertEquals(parsed_dates, expected_dates)
+        self.assertEqual(parsed_dates, expected_dates)
 
     def test_not_datetimes(self):
         dates = [
@@ -53,4 +53,4 @@ def test_not_datetimes(self):
 
         expected_dates = [None, None, None, None]
 
-        self.assertEquals(parsed_dates, expected_dates)
+        self.assertEqual(parsed_dates, expected_dates)

tests/unittests/test_exception_handling.py

@@ -191,7 +191,7 @@ def test_badrequest_400_error(self, mocked_session, mocked_badrequest_400_error)
             expected_error_message = "HTTP-error-code: 400, Error: A validation exception has occurred."
 
             # Verifying the message formed for the custom exception
-            self.assertEquals(str(e), expected_error_message)
+            self.assertEqual(str(e), expected_error_message)
             pass
 
 
@@ -210,7 +210,7 @@ def test_unauthorized_401_error(self, mocked_session, mocked_unauthorized_401_er
             expected_error_message = "HTTP-error-code: 401, Error: Invalid authorization credentials."
 
             # Verifying the message formed for the custom exception
-            self.assertEquals(str(e), expected_error_message)
+            self.assertEqual(str(e), expected_error_message)
             pass
 
 
@@ -229,7 +229,7 @@ def test_forbidden_403_exception(self, mocked_session, mocked_forbidden_403_exce
             expected_error_message = "HTTP-error-code: 403, Error: User doesn't have permission to access the resource."
 
             # Verifying the message formed for the custom exception
-            self.assertEquals(str(e), expected_error_message)
+            self.assertEqual(str(e), expected_error_message)
             pass
 
 
@@ -248,7 +248,7 @@ def test_notfound_404_error(self, mocked_session, mocked_notfound_404_error):
             expected_error_message = "HTTP-error-code: 404, Error: The resource you have specified cannot be found."
 
             # Verifying the message formed for the custom exception
-            self.assertEquals(str(e), expected_error_message)
+            self.assertEqual(str(e), expected_error_message)
             pass
 
     @mock.patch('requests.Request', side_effect=mocked_precondition_failed_412_error)
@@ -266,7 +266,7 @@ def test_precondition_failed_412_error(self, mocked_session, mocked_precondition
             expected_error_message = "HTTP-error-code: 412, Error: One or more conditions given in the request header fields were invalid."
 
             # Verifying the message formed for the custom exception
-            self.assertEquals(str(e), expected_error_message)
+            self.assertEqual(str(e), expected_error_message)
             pass
 
     @mock.patch('requests.Request', side_effect=mocked_internalservererror_500_error)
@@ -284,7 +284,7 @@ def test_internalservererror_500_error(self, mocked_session, mocked_internalserv
             expected_error_message = "HTTP-error-code: 500, Error: An unhandled error with the Xero API. Contact the Xero API team if problems persist."
 
             # Verifying the message formed for the custom exception
-            self.assertEquals(str(e), expected_error_message)
+            self.assertEqual(str(e), expected_error_message)
             pass
 
 
@@ -303,7 +303,7 @@ def test_notimplemented_501_error(self, mocked_session, mocked_notimplemented_50
             expected_error_message = "HTTP-error-code: 501, Error: The method you have called has not been implemented."
 
             # Verifying the message formed for the custom exception
-            self.assertEquals(str(e), expected_error_message)
+            self.assertEqual(str(e), expected_error_message)
             pass
 
     @mock.patch('requests.Request', side_effect=mocked_not_available_503_error)
@@ -321,7 +321,7 @@ def test_not_available_503_error(self, mocked_session, mocked_not_available_503_
             expected_error_message = "HTTP-error-code: 503, Error: API service is currently unavailable."
 
             # Verifying the message formed for the custom exception
-            self.assertEquals(str(e), expected_error_message)
+            self.assertEqual(str(e), expected_error_message)
             pass
 
 
@@ -341,7 +341,7 @@ def test_too_many_requests_429_in_day_error(self, mocked_session, mocked_failed_
             expected_error_message = "HTTP-error-code: 429, Error: The API rate limit for your organisation/application pairing has been exceeded. Please retry after 1000 seconds"
 
             # Verifying the message formed for the custom exception
-            self.assertEquals(str(e), expected_error_message)
+            self.assertEqual(str(e), expected_error_message)
             pass
 
 
@@ -361,7 +361,7 @@ def test_too_many_requests_429_in_minute_error(self, mocked_session, mocked_fail
             expected_error_message = "HTTP-error-code: 429, Error: The API rate limit for your organisation/application pairing has been exceeded. Please retry after 5 seconds"
 
             # Verifying the message formed for the custom exception
-            self.assertEquals(str(e), expected_error_message)
+            self.assertEqual(str(e), expected_error_message)
             pass