From 1bf5ebb1110b38f35ef70053d945817fd8730dd9 Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Thu, 21 Nov 2024 00:30:36 +0100 Subject: [PATCH] Add New Attributes to `SuccessfulPayment` --- telegram/_payment/successfulpayment.py | 40 ++++++++++++++++++++++ tests/_payment/test_successfulpayment.py | 42 ++++++++++++++++++++++++ 2 files changed, 82 insertions(+) diff --git a/telegram/_payment/successfulpayment.py b/telegram/_payment/successfulpayment.py index 34bce2914..5d8edbd1b 100644 --- a/telegram/_payment/successfulpayment.py +++ b/telegram/_payment/successfulpayment.py @@ -18,10 +18,12 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram SuccessfulPayment.""" +import datetime as dtm from typing import TYPE_CHECKING, Optional from telegram._payment.orderinfo import OrderInfo from telegram._telegramobject import TelegramObject +from telegram._utils.datetime import extract_tzinfo_from_defaults, from_timestamp from telegram._utils.types import JSONDict if TYPE_CHECKING: @@ -45,6 +47,17 @@ class SuccessfulPayment(TelegramObject): it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). invoice_payload (:obj:`str`): Bot-specified invoice payload. + subscription_expiration_date (:class:`datetime.datetime`, optional): Expiration date of the + subscription; for recurring payments only. + + .. versionadded:: NEXT.VERSION + is_recurring (:obj:`bool`, optional): True, if the payment is for a subscription. + + .. versionadded:: NEXT.VERSION + is_first_recurring (:obj:`bool`, optional): True, if the payment is the first payment of a + subscription. + + .. versionadded:: NEXT.VERSION shipping_option_id (:obj:`str`, optional): Identifier of the shipping option chosen by the user. order_info (:class:`telegram.OrderInfo`, optional): Order info provided by the user. @@ -61,6 +74,17 @@ class SuccessfulPayment(TelegramObject): it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). invoice_payload (:obj:`str`): Bot-specified invoice payload. + subscription_expiration_date (:class:`datetime.datetime`): Optional. Expiration + date of the subscription; for recurring payments only. + + .. versionadded:: NEXT.VERSION + is_recurring (:obj:`bool`): Optional. True, if the payment is for a subscription. + + .. versionadded:: NEXT.VERSION + is_first_recurring (:obj:`bool`): Optional. True, if the payment is the first payment of a + subscription. + + .. versionadded:: NEXT.VERSION shipping_option_id (:obj:`str`): Optional. Identifier of the shipping option chosen by the user. order_info (:class:`telegram.OrderInfo`): Optional. Order info provided by the user. @@ -72,9 +96,12 @@ class SuccessfulPayment(TelegramObject): __slots__ = ( "currency", "invoice_payload", + "is_first_recurring", + "is_recurring", "order_info", "provider_payment_charge_id", "shipping_option_id", + "subscription_expiration_date", "telegram_payment_charge_id", "total_amount", ) @@ -88,6 +115,9 @@ class SuccessfulPayment(TelegramObject): provider_payment_charge_id: str, shipping_option_id: Optional[str] = None, order_info: Optional[OrderInfo] = None, + subscription_expiration_date: Optional[dtm.datetime] = None, + is_recurring: Optional[bool] = None, + is_firs_recurring: Optional[bool] = None, *, api_kwargs: Optional[JSONDict] = None, ): @@ -99,6 +129,9 @@ class SuccessfulPayment(TelegramObject): self.order_info: Optional[OrderInfo] = order_info self.telegram_payment_charge_id: str = telegram_payment_charge_id self.provider_payment_charge_id: str = provider_payment_charge_id + self.subscription_expiration_date: Optional[dtm.datetime] = subscription_expiration_date + self.is_recurring: Optional[bool] = is_recurring + self.is_first_recurring: Optional[bool] = is_firs_recurring self._id_attrs = (self.telegram_payment_charge_id, self.provider_payment_charge_id) @@ -116,4 +149,11 @@ class SuccessfulPayment(TelegramObject): data["order_info"] = OrderInfo.de_json(data.get("order_info"), bot) + # Get the local timezone from the bot if it has defaults + loc_tzinfo = extract_tzinfo_from_defaults(bot) + + data["subscription_expiration_date"] = from_timestamp( + data.get("subscription_expiration_date"), tzinfo=loc_tzinfo + ) + return super().de_json(data=data, bot=bot) diff --git a/tests/_payment/test_successfulpayment.py b/tests/_payment/test_successfulpayment.py index 2b4cf0918..a2114079f 100644 --- a/tests/_payment/test_successfulpayment.py +++ b/tests/_payment/test_successfulpayment.py @@ -16,9 +16,12 @@ # # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. +import datetime as dtm + import pytest from telegram import OrderInfo, SuccessfulPayment +from telegram._utils.datetime import UTC, to_timestamp from tests.auxil.slots import mro_slots @@ -43,6 +46,9 @@ class SuccessfulPaymentTestBase: order_info = OrderInfo() telegram_payment_charge_id = "telegram_payment_charge_id" provider_payment_charge_id = "provider_payment_charge_id" + subscription_expiration_date = dtm.datetime.now(tz=UTC).replace(microsecond=0) + is_recurring = True + is_first_recurring = True class TestSuccessfulPaymentWithoutRequest(SuccessfulPaymentTestBase): @@ -61,6 +67,9 @@ class TestSuccessfulPaymentWithoutRequest(SuccessfulPaymentTestBase): "order_info": self.order_info.to_dict(), "telegram_payment_charge_id": self.telegram_payment_charge_id, "provider_payment_charge_id": self.provider_payment_charge_id, + "subscription_expiration_date": to_timestamp(self.subscription_expiration_date), + "is_recurring": self.is_recurring, + "is_first_recurring": self.is_first_recurring, } successful_payment = SuccessfulPayment.de_json(json_dict, offline_bot) assert successful_payment.api_kwargs == {} @@ -72,6 +81,32 @@ class TestSuccessfulPaymentWithoutRequest(SuccessfulPaymentTestBase): assert successful_payment.order_info == self.order_info assert successful_payment.telegram_payment_charge_id == self.telegram_payment_charge_id assert successful_payment.provider_payment_charge_id == self.provider_payment_charge_id + assert successful_payment.subscription_expiration_date == self.subscription_expiration_date + assert successful_payment.is_recurring == self.is_recurring + assert successful_payment.is_first_recurring == self.is_first_recurring + + def test_de_json_localization(self, offline_bot, raw_bot, tz_bot): + json_dict = { + "invoice_payload": self.invoice_payload, + "currency": self.currency, + "total_amount": self.total_amount, + "telegram_payment_charge_id": self.telegram_payment_charge_id, + "provider_payment_charge_id": self.provider_payment_charge_id, + "subscription_expiration_date": to_timestamp(self.subscription_expiration_date), + } + successful_payment = SuccessfulPayment.de_json(json_dict, offline_bot) + successful_payment_raw = SuccessfulPayment.de_json(json_dict, raw_bot) + successful_payment_tz = SuccessfulPayment.de_json(json_dict, tz_bot) + + # comparing utcoffsets because comparing timezones is unpredicatable + date_offset = successful_payment_tz.subscription_expiration_date.utcoffset() + tz_bot_offset = tz_bot.defaults.tzinfo.utcoffset( + successful_payment_tz.subscription_expiration_date.replace(tzinfo=None) + ) + + assert successful_payment_raw.subscription_expiration_date.tzinfo == UTC + assert successful_payment.subscription_expiration_date.tzinfo == UTC + assert date_offset == tz_bot_offset def test_to_dict(self, successful_payment): successful_payment_dict = successful_payment.to_dict() @@ -92,6 +127,13 @@ class TestSuccessfulPaymentWithoutRequest(SuccessfulPaymentTestBase): successful_payment_dict["provider_payment_charge_id"] == successful_payment.provider_payment_charge_id ) + assert successful_payment_dict["subscription_expiration_date"] == to_timestamp( + successful_payment.subscription_expiration_date + ) + assert successful_payment_dict["is_recurring"] == successful_payment.is_recurring + assert ( + successful_payment_dict["is_first_recurring"] == successful_payment.is_first_recurring + ) def test_equality(self): a = SuccessfulPayment(