click_and_drop_api 3.0.0__tar.gz → 3.0.2__tar.gz

{click_and_drop_api-3.0.0/click_and_drop_api.egg-info → click_and_drop_api-3.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: click_and_drop_api
-Version: 3.0.0
+Version: 3.0.2
 Summary: ChannelShipper & Royal Mail Public API
 Home-page: 
 Author: OpenAPI Generator community

{click_and_drop_api-3.0.0 → click_and_drop_api-3.0.2}/click_and_drop_api/examples/__init__.py

@@ -7,6 +7,7 @@ Each module can be executed directly::
     python -m click_and_drop_api.examples.shipping_countries
     python -m click_and_drop_api.examples.create_order
     python -m click_and_drop_api.examples.view_specific_orders
+    python -m click_and_drop_api.examples.view_order
     python -m click_and_drop_api.examples.package_size_and_cost
     python -m click_and_drop_api.examples.generate_label
 """

click_and_drop_api-3.0.2/click_and_drop_api/examples/__main__.py

@@ -0,0 +1,27 @@
+"""List all available examples with their descriptions."""
+
+import ast
+import textwrap
+from pathlib import Path
+
+_BASE = "click_and_drop_api.examples"
+_DIR = Path(__file__).parent
+
+
+def _docstring(name: str) -> str:
+    source = (_DIR / f"{name}.py").read_text()
+    tree = ast.parse(source)
+    return ast.get_docstring(tree) or ""
+
+
+_examples = sorted(p.stem for p in _DIR.glob("*.py") if not p.stem.startswith("_"))
+
+for name in _examples:
+    doc = _docstring(name).strip()
+    first_line, _, rest = doc.partition("\n")
+    detail = textwrap.indent(rest.strip(), "    ") if rest.strip() else ""
+    print(f"python -m {_BASE}.{name}")
+    print(f"  {first_line}")
+    if detail:
+        print(detail)
+    print()

click_and_drop_api-3.0.2/click_and_drop_api/examples/view_order.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python
+"""Print details of a single order by order number or reference.
+
+Usage::
+
+    python -m click_and_drop_api.examples.view_order <order_id_or_reference>
+"""
+
+import os
+import sys
+
+from click_and_drop_api.simple import ClickAndDrop
+
+API_KEY = os.environ["API_KEY"]
+
+if len(sys.argv) != 2:
+    print(
+        "Usage: python -m click_and_drop_api.examples.view_order <order_id_or_reference>"
+    )
+    sys.exit(1)
+
+identifier = sys.argv[1]
+# treat numeric strings as integer order IDs
+if identifier.isdigit():
+    identifier = int(identifier)
+
+api = ClickAndDrop(API_KEY)
+order = api.get_order(identifier)
+
+if order is None:
+    print(f"Order not found: {identifier!r}")
+    sys.exit(1)
+
+print(f"Order identifier : {order.order_identifier}")
+print(f"Order reference  : {order.order_reference}")
+print(f"Created on       : {order.created_on}")
+print(f"Order date       : {order.order_date}")
+print(f"Printed on       : {order.printed_on}")
+print(f"Manifested on    : {order.manifested_on}")
+print(f"Shipped on       : {order.shipped_on}")
+print(f"Tracking number  : {order.tracking_number}")
+
+if order.packages:
+    print(f"Packages ({len(order.packages)}):")
+    for pkg in order.packages:
+        print(f"  #{pkg.package_number}  tracking: {pkg.tracking_number}")

{click_and_drop_api-3.0.0 → click_and_drop_api-3.0.2}/click_and_drop_api/simple/base.py

@@ -12,6 +12,7 @@ from datetime import datetime, timezone
 
 from click_and_drop_api.exceptions import ApiException
 from click_and_drop_api.models.create_order_response import CreateOrderResponse
+from click_and_drop_api.models.order_field_response import OrderFieldResponse
 from click_and_drop_api.simple import (
     Address,
     CreateOrder,
@@ -173,7 +174,9 @@ class AbstractClickAndDrop(ABC):
                 failed_addresses.append(get_order_address(fo.order))
                 failed_messages.append(
                     ";".join(
-                        f"Error {e.error_code} in {e.fields}: {e.error_message}"
+                        f"Error {e.error_code} in "
+                        f"{self.format_fields_for_error_message(e.fields)}: "
+                        f"{e.error_message}"
                         for e in fo.errors
                     )
                 )
@@ -183,6 +186,10 @@ class AbstractClickAndDrop(ABC):
             successful_addresses, failed_addresses, failed_messages
         )
 
+    def format_fields_for_error_message(self, fields: list[OrderFieldResponse]) -> str:
+        """Return a comma-separated list of error message fields."""
+        return ", ".join(f"{f.field_name}={f.value}" for f in fields)
+
     def get_order_test_name(self, country_code: str) -> str:
         """Return a name for a test order for a specific country."""
         return f"test-{country_code}-{uuid.uuid4().hex[:16]}"

{click_and_drop_api-3.0.0 → click_and_drop_api-3.0.2}/click_and_drop_api/simple/shipping/db.py

@@ -127,6 +127,11 @@ class ShippingDB:
         """
         return self._options[0]
 
+    @property
+    def any_or_none(self) -> Optional[PackageShippingOption]:
+        """Any option in the DB, or ``None`` if the DB is empty."""
+        return self._options[0] if self._options else None
+
     def __getitem__(self, key: int):
         return self._options[key]
 

{click_and_drop_api-3.0.0 → click_and_drop_api-3.0.2}/click_and_drop_api/simple/shipping/package_shipping_option.py

@@ -20,6 +20,10 @@ class PackageShippingOption:
     Merges all physical package constraints (dimensions, weight) with the
     full Royal Mail service details (code, enhancements, pricing) into one
     object so callers never have to juggle two separate instances.
+
+    Note:
+        OBA shipping options do not have a price.
+        https://clickanddrop.uservoice.com/forums/399930-general/suggestions/45005089-show-the-service-price-cost
     """
 
     # ── Package format ──────────────────────────────────────────────────────

{click_and_drop_api-3.0.0 → click_and_drop_api-3.0.2/click_and_drop_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: click_and_drop_api
-Version: 3.0.0
+Version: 3.0.2
 Summary: ChannelShipper & Royal Mail Public API
 Home-page: 
 Author: OpenAPI Generator community

{click_and_drop_api-3.0.0 → click_and_drop_api-3.0.2}/click_and_drop_api.egg-info/SOURCES.txt

@@ -22,11 +22,13 @@ click_and_drop_api/api/manifests_api.py
 click_and_drop_api/api/orders_api.py
 click_and_drop_api/api/version_api.py
 click_and_drop_api/examples/__init__.py
+click_and_drop_api/examples/__main__.py
 click_and_drop_api/examples/check_oba.py
 click_and_drop_api/examples/create_order.py
 click_and_drop_api/examples/generate_label.py
 click_and_drop_api/examples/package_size_and_cost.py
 click_and_drop_api/examples/shipping_countries.py
+click_and_drop_api/examples/view_order.py
 click_and_drop_api/examples/view_specific_orders.py
 click_and_drop_api/examples/view_version.py
 click_and_drop_api/models/__init__.py

{click_and_drop_api-3.0.0 → click_and_drop_api-3.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "click_and_drop_api"
-version = "3.0.0"
+version = "3.0.2"
 description = "ChannelShipper & Royal Mail Public API"
 authors = [
   {name = "Nicco Kunzmann", email = "niccokunzmann@rambler.ru"},

{click_and_drop_api-3.0.0 → click_and_drop_api-3.0.2}/test/test_mock_api.py

@@ -4,6 +4,7 @@ from datetime import datetime, timezone
 
 import pytest
 
+from click_and_drop_api.models.order_field_response import OrderFieldResponse
 from click_and_drop_api.simple.shipping_test_result import ShippingTestResult
 from click_and_drop_api.simple.mock import MockClickAndDrop
 from click_and_drop_api.simple.types import (
@@ -277,3 +278,36 @@ def test_test_shipping_multiple_calls_stay_clean():
         result = api.test_shipping("smallParcel", service_code)
         assert result.is_success is True
     assert len(api._orders) == 0
+
+
+_api = MockClickAndDrop()
+
+
+def _field(name: str, value: str | None) -> OrderFieldResponse:
+    return OrderFieldResponse(fieldName=name, value=value)
+
+
+def test_format_fields_empty():
+    assert _api.format_fields_for_error_message([]) == ""
+
+
+def test_format_fields_single():
+    assert (
+        _api.format_fields_for_error_message([_field("postcode", "INVALID")])
+        == "postcode=INVALID"
+    )
+
+
+def test_format_fields_multiple():
+    fields = [_field("postcode", "INVALID"), _field("countryCode", "XX")]
+    assert (
+        _api.format_fields_for_error_message(fields)
+        == "postcode=INVALID, countryCode=XX"
+    )
+
+
+def test_format_fields_none_value():
+    assert (
+        _api.format_fields_for_error_message([_field("postcode", None)])
+        == "postcode=None"
+    )

{click_and_drop_api-3.0.0 → click_and_drop_api-3.0.2}/test/test_shipping_options.py

@@ -1,5 +1,10 @@
 import pytest
 from click_and_drop_api.simple import check_service_codes, db
+from click_and_drop_api.simple.shipping.db import ShippingDB
+from click_and_drop_api.simple.shipping.package_shipping_option import (
+    PackageShippingOption,
+)
+from decimal import Decimal as D
 
 
 def test_list_all_shipping_options():
@@ -107,11 +112,6 @@ def test_ship_with_low_weight():
     ],
 )
 def test_dimensions_order_themselves(dims, fits):
-    from click_and_drop_api.simple.shipping.package_shipping_option import (
-        PackageShippingOption,
-    )
-    from decimal import Decimal as D
-
     p = PackageShippingOption(
         package_size_code="letter",
         package_name="Letter",
@@ -130,11 +130,6 @@ def test_dimensions_order_themselves(dims, fits):
 
 
 def test_dimensions():
-    from click_and_drop_api.simple.shipping.package_shipping_option import (
-        PackageShippingOption,
-    )
-    from decimal import Decimal as D
-
     p = PackageShippingOption(
         package_size_code="letter",
         package_name="Letter",
@@ -153,11 +148,6 @@ def test_dimensions():
 
 
 def test_negative_values_not_ok():
-    from click_and_drop_api.simple.shipping.package_shipping_option import (
-        PackageShippingOption,
-    )
-    from decimal import Decimal as D
-
     p = PackageShippingOption(
         package_size_code="letter",
         package_name="Letter",
@@ -183,8 +173,6 @@ def test_db_len():
 
 def test_db_bool():
     assert db
-    from click_and_drop_api.simple.shipping.db import ShippingDB
-
     assert not ShippingDB([])
 
 
@@ -197,7 +185,23 @@ def test_db_iter():
 def test_db_getitem():
     first = db[0]
     assert hasattr(first, "service_code")
-    assert hasattr(first, "package_size_code")
+
+
+def test_db_any():
+    assert db.any is db[0]
+
+
+def test_db_any_raises_on_empty():
+    with pytest.raises(IndexError):
+        ShippingDB([]).any
+
+
+def test_db_any_or_none_non_empty():
+    assert db.any_or_none is db[0]
+
+
+def test_db_any_or_none_empty():
+    assert ShippingDB([]).any_or_none is None
 
 
 def test_db_str():