Coverage for amazonorders/entity/order.py: 94.53%
128 statements
« prev ^ index » next coverage.py v7.4.0, created at 2024-01-17 01:52 +0000
« prev ^ index » next coverage.py v7.4.0, created at 2024-01-17 01:52 +0000
1import logging
2from datetime import datetime, date
3from typing import List, Optional, TypeVar
4from urllib.parse import parse_qs
5from urllib.parse import urlparse
7from bs4 import BeautifulSoup, Tag
9from amazonorders.entity.item import Item
10from amazonorders.entity.parsable import Parsable
11from amazonorders.entity.recipient import Recipient
12from amazonorders.entity.shipment import Shipment
13from amazonorders.session import BASE_URL
15__author__ = "Alex Laird"
16__copyright__ = "Copyright 2024, Alex Laird"
17__version__ = "1.0.0"
19logger = logging.getLogger(__name__)
21Entity = TypeVar('Entity', bound='Order')
24class Order(Parsable):
25 """
27 """
29 def __init__(self,
30 parsed: Tag,
31 full_details: bool = False,
32 clone: Optional[Entity] = None) -> None:
33 super().__init__(parsed)
35 #: If the Orders full details were populated from its details page.
36 self.full_details: bool = full_details
38 #:
39 self.shipments: List[Shipment] = clone.shipments if clone else self._parse_shipments()
40 #:
41 self.items: List[Item] = clone.items if clone else self._parse_items()
42 #:
43 self.order_details_link: Optional[str] = clone.order_details_link if clone else self.safe_parse(
44 self._parse_order_details_link)
45 #:
46 self.order_number: str = clone.order_number if clone else self.safe_parse(self._parse_order_number)
47 #:
48 self.grand_total: float = clone.grand_total if clone else self.safe_parse(self._parse_grand_total)
49 #:
50 self.order_placed_date: date = clone.order_placed_date if clone else self.safe_parse(
51 self._parse_order_placed_date)
52 #:
53 self.recipient: Recipient = clone.recipient if clone else self.safe_parse(self._parse_recipient)
55 if self.full_details:
56 self.items: List[Item] = self._parse_items()
57 #:
58 self.payment_method: Optional[str] = self._parse_payment_method()
59 #:
60 self.payment_method_last_4: Optional[str] = self._parse_payment_method_last_4()
61 #:
62 self.subtotal: Optional[float] = self._parse_subtotal()
63 #:
64 self.shipping_total: Optional[float] = self._parse_shipping_total()
65 #:
66 self.subscription_discount: Optional[float] = self._parse_subscription_discount()
67 #:
68 self.total_before_tax: Optional[float] = self._parse_total_before_tax()
69 #:
70 self.estimated_tax: Optional[float] = self._parse_estimated_tax()
71 #:
72 self.refund_total: Optional[float] = self._parse_refund_total()
73 #:
74 self.order_shipped_date: Optional[date] = self._parse_order_shipping_date()
75 #:
76 self.refund_completed_date: Optional[date] = self._parse_refund_completed_date()
78 def __repr__(self) -> str:
79 return "<Order #{}: \"{}\">".format(self.order_number, self.items)
81 def __str__(self) -> str: # pragma: no cover
82 return "Order #{}: \"{}\"".format(self.order_number, self.items)
84 def _parse_shipments(self) -> List[Shipment]:
85 return [Shipment(x) for x in self.parsed.find_all("div", {"class": "shipment"})]
87 def _parse_items(self) -> List[Item]:
88 return [Item(x) for x in self.parsed.find_all("div", {"class": "yohtmlc-item"})]
90 def _parse_order_details_link(self) -> Optional[str]:
91 tag = self.parsed.find("a", {"class": "yohtmlc-order-details-link"})
92 if tag:
93 return "{}{}".format(BASE_URL, tag.attrs["href"])
94 else:
95 return None
97 def _parse_order_number(self) -> str:
98 if self.order_details_link:
99 parsed_url = urlparse(self.order_details_link)
100 return parse_qs(parsed_url.query)["orderID"][0]
101 else:
102 tag = self.parsed.find("bdi", dir="ltr")
103 return tag.text.strip()
105 def _parse_grand_total(self) -> float:
106 tag = self.parsed.find("div", {"class": "yohtmlc-order-total"})
107 if tag:
108 tag = tag.find("span", {"class": "value"})
109 else:
110 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}):
111 if "grand total" in tag.text.lower():
112 tag = tag.find("div", {"class": "a-span-last"})
113 break
114 return float(tag.text.strip().replace("$", ""))
116 def _parse_order_placed_date(self) -> date:
117 tag = self.parsed.find("span", {"class": "order-date-invoice-item"})
118 if tag:
119 date_str = tag.text.split("Ordered on")[1].strip()
120 else:
121 tag = self.parsed.find("div", {"class": "a-span3"}).find_all("span")
122 date_str = tag[1].text.strip()
123 return datetime.strptime(date_str, "%B %d, %Y").date()
125 def _parse_recipient(self) -> Recipient:
126 tag = self.parsed.find("div", {"class": "displayAddressDiv"})
127 if not tag:
128 script_id = self.parsed.find("div",
129 id=lambda value: value and value.startswith("shipToInsertionNode")).attrs[
130 "id"]
131 tag = self.parsed.find("script",
132 id="shipToData-shippingAddress-{}".format(script_id.split("-")[2]))
133 tag = BeautifulSoup(str(tag.contents[0]).strip(), "html.parser")
134 return Recipient(tag)
136 def _parse_payment_method(self) -> Optional[str]:
137 tag = self.parsed.find("img", {"class": "pmts-payment-credit-card-instrument-logo"})
138 if tag:
139 return tag.attrs["alt"]
140 else:
141 return None
143 def _parse_payment_method_last_4(self) -> Optional[str]:
144 tag = self.parsed.find("img", {"class": "pmts-payment-credit-card-instrument-logo"})
145 if tag:
146 ending_sibling = tag.find_next_siblings()[-1]
147 return ending_sibling.text.split("ending in")[1].strip()
148 else:
149 return None
151 def _parse_subtotal(self) -> Optional[float]:
152 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}):
153 if "subtotal" in tag.text.lower():
154 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", ""))
156 return None
158 def _parse_shipping_total(self) -> Optional[float]:
159 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}):
160 if "shipping" in tag.text.lower():
161 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", ""))
163 return None
165 def _parse_subscription_discount(self) -> Optional[float]:
166 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}):
167 if "subscribe" in tag.text.lower():
168 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", ""))
170 return None
172 def _parse_total_before_tax(self) -> Optional[float]:
173 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}):
174 if "before tax" in tag.text.lower():
175 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", ""))
177 return None
179 def _parse_estimated_tax(self) -> Optional[float]:
180 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}):
181 if "estimated tax" in tag.text.lower():
182 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", ""))
184 return None
186 def _parse_refund_total(self) -> Optional[float]:
187 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}):
188 if "refund total" in tag.text.lower() and "tax refund" not in tag.text.lower():
189 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", ""))
191 return None
193 def _parse_order_shipping_date(self) -> Optional[date]:
194 # TODO: find a better way to do this
195 if "Items shipped:" in self.parsed.text:
196 date_str = self.parsed.text.split("Items shipped:")[1].strip().split("-")[0].strip()
197 return datetime.strptime(date_str, "%B %d, %Y").date()
198 else:
199 return None
201 def _parse_refund_completed_date(self) -> Optional[date]:
202 # TODO: find a better way to do this
203 if "Refund: Completed" in self.parsed.text:
204 date_str = self.parsed.text.split("Refund: Completed")[1].strip().split("-")[0].strip()
205 return datetime.strptime(date_str, "%B %d, %Y").date()
206 else:
207 return None