amazon-orders 2.0.1__tar.gz → 2.0.2__tar.gz

{amazon_orders-2.0.1 → amazon_orders-2.0.2}/CHANGELOG.md

@@ -4,7 +4,21 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/alexdlaird/amazon-orders/compare/2.0.1...HEAD)
+## [Unreleased](https://github.com/alexdlaird/amazon-orders/compare/2.0.2...HEAD)
+
+## [2.0.2](https://github.com/alexdlaird/amazon-orders/compare/2.0.1...2.0.2) - 2024-10-30
+
+### Added
+
+- `item_class` to the config file, which allows for overriding the `Item` class.
+- Support for Amazon's new `data-component` tag on order subtotals.
+- Build and stability improvements.
+
+### Fixed
+
+- The return value of `Order._parse_recipient()` is now optional, so parsing doesn't break digital goods without a shipping address.
+- Redundant order ID logic to parse from the URI, simplified to consistently fetch from page.
+- Support for order details selector on Amazon's legacy digital orders page.
 
 ## [2.0.1](https://github.com/alexdlaird/amazon-orders/compare/2.0.0...2.0.1) - 2024-10-27
 

{amazon_orders-2.0.1/amazon_orders.egg-info → amazon_orders-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: amazon-orders
-Version: 2.0.1
+Version: 2.0.2
 Summary: A CLI and library for interacting with Amazon order history.
 Maintainer-email: Alex Laird <contact@alexlaird.com>
 License: MIT License

{amazon_orders-2.0.1 → amazon_orders-2.0.2/amazon_orders.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: amazon-orders
-Version: 2.0.1
+Version: 2.0.2
 Summary: A CLI and library for interacting with Amazon order history.
 Maintainer-email: Alex Laird <contact@alexlaird.com>
 License: MIT License

{amazon_orders-2.0.1 → amazon_orders-2.0.2}/amazonorders/__init__.py

@@ -1,3 +1,3 @@
 __copyright__ = "Copyright (c) 2024 Alex Laird"
 __license__ = "MIT"
-__version__ = "2.0.1"
+__version__ = "2.0.2"

{amazon_orders-2.0.1 → amazon_orders-2.0.2}/amazonorders/cli.py

@@ -278,7 +278,11 @@ Order #{}
     order_str += f"\n  Order Details Link: {order.order_details_link}"
     order_str += f"\n  Grand Total: ${order.grand_total:,.2f}"
     order_str += f"\n  Order Placed Date: {order.order_placed_date}"
-    order_str += f"\n  {order.recipient}"
+    if order.recipient:
+        order_str += f"\n  {order.recipient}"
+    else:
+        order_str += "\n  Recipient: None"
+
     if order.payment_method:
         order_str += f"\n  Payment Method: {order.payment_method}"
     if order.payment_method_last_4:

{amazon_orders-2.0.1 → amazon_orders-2.0.2}/amazonorders/conf.py

@@ -35,6 +35,7 @@ class AmazonOrdersConfig:
             "selectors_class": "amazonorders.selectors.Selectors",
             "order_class": "amazonorders.entity.order.Order",
             "shipment_class": "amazonorders.entity.shipment.Shipment",
+            "item_class": "amazonorders.entity.item.Item",
         }
 
         if os.path.exists(self.config_path):
@@ -62,11 +63,13 @@ class AmazonOrdersConfig:
         selectors_class_split = self.selectors_class.split(".")
         order_class_split = self.order_class.split(".")
         shipment_class_split = self.shipment_class.split(".")
+        item_class_split = self.item_class.split(".")
 
         self.constants = util.load_class(constants_class_split[:-1], constants_class_split[-1])()
         self.selectors = util.load_class(selectors_class_split[:-1], selectors_class_split[-1])()
         self.order_cls = util.load_class(order_class_split[:-1], order_class_split[-1])
         self.shipment_cls = util.load_class(shipment_class_split[:-1], shipment_class_split[-1])
+        self.item_cls = util.load_class(item_class_split[:-1], item_class_split[-1])
 
     def __getattr__(self,
                     key: str) -> Any:

{amazon_orders-2.0.1 → amazon_orders-2.0.2}/amazonorders/entity/order.py

@@ -4,8 +4,7 @@ __license__ = "MIT"
 import json
 import logging
 from datetime import date, datetime
-from typing import List, Optional, TypeVar, Union, Any
-from urllib.parse import parse_qs, urlparse
+from typing import Any, List, Optional, TypeVar, Union
 
 from bs4 import BeautifulSoup, Tag
 
@@ -15,7 +14,6 @@ from amazonorders.entity.item import Item
 from amazonorders.entity.parsable import Parsable
 from amazonorders.entity.recipient import Recipient
 from amazonorders.entity.shipment import Shipment
-from amazonorders.exception import AmazonOrdersError
 
 logger = logging.getLogger(__name__)
 
@@ -42,7 +40,9 @@ class Order(Parsable):
         #: The Order Items.
         self.items: List[Item] = clone.items if clone and not full_details else self._parse_items()
         #: The Order number.
-        self.order_number: str = clone.order_number if clone else self.safe_parse(self._parse_order_number)
+        self.order_number: str = clone.order_number if clone else self.safe_simple_parse(
+            selector=self.config.selectors.FIELD_ORDER_NUMBER_SELECTOR,
+            required=True)
         #: The Order details link.
         self.order_details_link: Optional[str] = clone.order_details_link if clone else self.safe_parse(
             self._parse_order_details_link)
@@ -84,6 +84,9 @@ class Order(Parsable):
         return f"Order #{self.order_number}: {self.items}"
 
     def _parse_shipments(self) -> List[Shipment]:
+        if not self.parsed:
+            return []
+
         shipments: List[Shipment] = [self.config.shipment_cls(x, self.config)
                                      for x in util.select(self.parsed,
                                                           self.config.selectors.SHIPMENT_ENTITY_SELECTOR)]
@@ -91,8 +94,12 @@ class Order(Parsable):
         return shipments
 
     def _parse_items(self) -> List[Item]:
-        items = [Item(x, self.config)
-                 for x in util.select(self.parsed, self.config.selectors.ITEM_ENTITY_SELECTOR)]
+        if not self.parsed:
+            return []
+
+        items: List[Item] = [self.config.item_cls(x, self.config)
+                             for x in util.select(self.parsed,
+                                                  self.config.selectors.ITEM_ENTITY_SELECTOR)]
         items.sort()
         return items
 
@@ -104,21 +111,6 @@ class Order(Parsable):
 
         return value
 
-    def _parse_order_number(self) -> str:
-        try:
-            order_details_link = self._parse_order_details_link()
-        except Exception:
-            # We're not using safe_parse here because it's fine if this fails, no need for noise
-            order_details_link = None
-
-        if order_details_link:
-            parsed_url = urlparse(order_details_link)
-            value = parse_qs(parsed_url.query)["orderID"][0]
-        else:
-            value = self.simple_parse(self.config.selectors.FIELD_ORDER_NUMBER_SELECTOR, required=True)
-
-        return value
-
     def _parse_grand_total(self) -> float:
         value = self.simple_parse(self.config.selectors.FIELD_ORDER_GRAND_TOTAL_SELECTOR)
 
@@ -150,14 +142,14 @@ class Order(Parsable):
 
         return value
 
-    def _parse_recipient(self) -> Recipient:
+    def _parse_recipient(self) -> Optional[Recipient]:
         value = util.select_one(self.parsed, self.config.selectors.FIELD_ORDER_ADDRESS_SELECTOR)
 
         if not value:
             value = util.select_one(self.parsed, self.config.selectors.FIELD_ORDER_ADDRESS_FALLBACK_1_SELECTOR)
 
             if value:
-                data_popover = value.get("data-a-popover", {})  # type: ignore[var-annotated]
+                data_popover = value.get("data-a-popover", {})  # type: ignore[arg-type]
                 inline_content = data_popover.get("inlineContent")  # type: ignore[union-attr]
                 if inline_content:
                     value = BeautifulSoup(json.loads(inline_content), "html.parser")
@@ -172,13 +164,12 @@ class Order(Parsable):
                 parsed_parent,
                 self.config.selectors.FIELD_ORDER_ADDRESS_FALLBACK_2_SELECTOR
             )
-            if not parent_tag:
-                raise AmazonOrdersError(
-                    "FIELD_ORDER_ADDRESS_FALLBACK_2_SELECTOR resulted in None, but it's required. "
-                    "Check if Amazon changed the expected HTML."
-                )  # pragma: no cover
 
-            value = BeautifulSoup(str(parent_tag.contents[0]).strip(), "html.parser")
+            if parent_tag:
+                value = BeautifulSoup(str(parent_tag.contents[0]).strip(), "html.parser")
+
+        if not value:
+            return None
 
         return Recipient(value, self.config)
 

{amazon_orders-2.0.1 → amazon_orders-2.0.2}/amazonorders/entity/shipment.py

@@ -50,6 +50,11 @@ class Shipment(Parsable):
             return str(self.items) < str(other.items)
 
     def _parse_items(self) -> List[Item]:
-        items = [Item(x, self.config) for x in util.select(self.parsed, self.config.selectors.ITEM_ENTITY_SELECTOR)]
+        if not self.parsed:
+            return []
+
+        items: List[Item] = [self.config.item_cls(x, self.config)
+                             for x in util.select(self.parsed,
+                                                  self.config.selectors.ITEM_ENTITY_SELECTOR)]
         items.sort()
         return items

{amazon_orders-2.0.1 → amazon_orders-2.0.2}/amazonorders/selectors.py

@@ -36,7 +36,7 @@ class Selectors:
     ##########################################################################
 
     ORDER_HISTORY_ENTITY_SELECTOR = ["div.order", "div.order-card"]
-    ORDER_DETAILS_ENTITY_SELECTOR = ["div#orderDetails", "[data-component='orderCard']"]
+    ORDER_DETAILS_ENTITY_SELECTOR = ["div#orderDetails", "div#ordersContainer", "[data-component='orderCard']"]
     ITEM_ENTITY_SELECTOR = ["div:has(> div.yohtmlc-item)", ".item-box", "[data-component='purchasedItems']"]
     SHIPMENT_ENTITY_SELECTOR = ["div.shipment", "div.delivery-box", "[data-component='shipments']"]
 
@@ -61,7 +61,7 @@ class Selectors:
                                         "div.a-span3"]
     FIELD_ORDER_PAYMENT_METHOD_SELECTOR = "img.pmts-payment-credit-card-instrument-logo"
     FIELD_ORDER_PAYMENT_METHOD_LAST_4_SELECTOR = "img.pmts-payment-credit-card-instrument-logo"
-    FIELD_ORDER_SUBTOTALS_TAG_ITERATOR_SELECTOR = "div#od-subtotals div.a-row"
+    FIELD_ORDER_SUBTOTALS_TAG_ITERATOR_SELECTOR = ["div#od-subtotals div.a-row", "[data-component='orderSubtotals']"]
     FIELD_ORDER_SUBTOTALS_INNER_TAG_SELECTOR = "div.a-span-last"
     FIELD_ORDER_ADDRESS_SELECTOR = "div.displayAddressDiv"
     FIELD_ORDER_ADDRESS_FALLBACK_1_SELECTOR = "div.recipient span.a-declarative"

{amazon_orders-2.0.1 → amazon_orders-2.0.2}/tests/test_conf.py

@@ -50,6 +50,7 @@ class TestConf(TestCase):
         with open(config.config_path, "r") as f:
             self.assertEqual("""constants_class: amazonorders.constants.Constants
 cookie_jar_path: {}
+item_class: amazonorders.entity.item.Item
 max_auth_attempts: 10
 order_class: amazonorders.entity.order.Order
 output_dir: {}

{amazon_orders-2.0.1 → amazon_orders-2.0.2}/tests/test_orders.py

@@ -204,7 +204,8 @@ class TestOrders(UnitTestCase):
     @responses.activate
     def test_temp_order_history_file(self):
         """
-        This test
+        This test can be used to drop in an order history page at tests/output/temp-order-history.html to easily
+        run a test against it for debugging purposes.
         """
         # GIVEN
         self.amazon_session.is_authenticated = True
@@ -239,6 +240,10 @@ class TestOrders(UnitTestCase):
                             "place it at tests/output/temp-order-details.html")
     @responses.activate
     def test_temp_order_details_file(self):
+        """
+        This test can be used to drop in an order details page at tests/output/temp-order-details.html to easily
+        run a test against it for debugging purposes.
+        """
         # GIVEN
         self.amazon_session.is_authenticated = True
         order_id = "temp-1234"

{amazon_orders-2.0.1 → amazon_orders-2.0.2}/tests/testcase.py

@@ -358,10 +358,11 @@ class TestCase(unittest.TestCase):
         self.assertIsNotNone(order.grand_total)
         self.assertIsNotNone(order.order_details_link)
         self.assertIsNotNone(order.order_placed_date)
-        self.assertIsNotNone(order.recipient.name)
-        self.assertIsNotNone(order.recipient.address)
-        self.assertGreaterEqual(len(order.shipments), 1)
-        self.assertEqual(str(order.items), str(order.shipments[0].items))
+        if order.recipient:
+            self.assertIsNotNone(order.recipient.name)
+            self.assertIsNotNone(order.recipient.address)
+            self.assertGreaterEqual(len(order.shipments), 1)
+            self.assertEqual(str(order.items), str(order.shipments[0].items))
         self.assertGreaterEqual(len(order.items), 1)
         self.assertIsNotNone(order.items[0].title)
         self.assertIsNotNone(order.items[0].link)
@@ -372,10 +373,12 @@ class TestCase(unittest.TestCase):
             self.assertIsNotNone(order.payment_method)
             self.assertEqual(4, len(order.payment_method_last_4))
             self.assertIsNotNone(order.subtotal)
-            self.assertIsNotNone(order.shipping_total)
+            if order.recipient:
+                self.assertIsNotNone(order.shipping_total)
             self.assertIsNotNone(order.total_before_tax)
             self.assertIsNotNone(order.estimated_tax)
             # As of April 2024, this is no longer shown in Order History
             # self.assertIsNotNone(order.items[0].condition)
-            self.assertIsNotNone(order.items[0].price)
-            self.assertIsNotNone(order.items[0].seller.name)
+            if order.recipient:
+                self.assertIsNotNone(order.items[0].price)
+                self.assertIsNotNone(order.items[0].seller.name)