payment response status enum

Author: Al-Muhandis

tests/test_yookassa_api.pas

@@ -218,7 +218,7 @@ procedure TTestYooKassa.TestGetPaymentRequest_CreateResponse;
       aResp := aReq.CreateResponse(aRaw) as TYookassaPaymentResponse;
       try
         AssertEquals('pay_123', aResp.ID);
-        AssertEquals('succeeded', aResp.Status);
+        AssertEquals(Ord(psSucceeded), Ord(aResp.Status));
         AssertEquals(100.00, (aResp).Amount);
       finally
         aResp.Free;
@@ -254,7 +254,7 @@ procedure TTestYooKassa.TestGetPayment_StaticMethod;
     aResp := TTestableGetPaymentRequest.GetPayment('test_shop', 'test_key', 'pay_test_999');
     try
       AssertEquals('pay_test_999', aResp.ID);
-      AssertEquals('waiting_for_capture', aResp.Status);
+      AssertEquals(Ord(psWaitingForCapture), Ord(aResp.Status));
       AssertEquals(500.00, aResp.Amount);
       AssertEquals('https://yookassa.ru/checkout/pay/test', aResp.ConfirmationURL);
     finally
@@ -291,7 +291,7 @@ procedure TTestYooKassa.TestPaymentResponseParsing;
     aResp := TYookassaPaymentResponse.Create(aRaw);
     try
       AssertEquals('pay_123', aResp.ID);
-      AssertEquals('pending', aResp.Status);
+      AssertEquals(Ord(psPending), Ord(aResp.Status));
       AssertEquals('https://yookassa.ru/checkout/pay/abc', aResp.ConfirmationURL);
       AssertEquals(100.00, aResp.Amount);
     finally
@@ -491,7 +491,7 @@ procedure TTestYooKassa.TestReceiptResponseParsing;
     aResp := TYookassaReceiptResponse.Create(aRaw);
     try
       AssertEquals('rcpt_456', aResp.ID);
-      AssertEquals('succeeded', aResp.GetStatus);
+      AssertEquals('succeeded', aResp.Status);
       AssertEquals('pay_789', aResp.PaymentId);
     finally
       aResp.Free;

tests/test_yookassa_api_integration.pas

@@ -215,7 +215,6 @@ procedure TTestYooKassaIntegration.TestCreatePaymentThenCreateReceiptAfterSucces
 var
   aConfirmationURL, aPaymentID: String;
   aPaymentResp: TYookassaPaymentResponse;
-  aSucceeded: Boolean;
 begin
   LoadCreatePaymentConf(FPaymentRequest);
   FPaymentResp:=FPaymentRequest.Execute as TYookassaPaymentResponse;
@@ -227,16 +226,11 @@ procedure TTestYooKassaIntegration.TestCreatePaymentThenCreateReceiptAfterSucces
 { Just pay using the link aConfirmationURL (you can view it in the file "~payment_response.json")
     within a minute (while the program is on Sleep(60*1000)) }
   JSONToFile('~payment_response.json', FPaymentResp.Raw);
-  aSucceeded:=False;
   repeat
     Sleep(10*1000); // 10 seconds
     aPaymentResp:=TYookassaGetPaymentRequest.GetPayment(FPaymentRequest.ShopId, FPaymentRequest.SecretKey, aPaymentID);
-    try
-      aSucceeded:=aPaymentResp.Status='succeeded';
-    finally
-      aPaymentResp.Free;
-    end;
-  until aSucceeded;
+    aPaymentResp.Free;
+  until aPaymentResp.Status=psSucceeded;
   LoadCreateReceiptConf(FReceiptRequest);
   FReceiptRequest.Settlements.Add(TYookassaSettlement.Create(stPrepayment, FPaymentRequest.Amount,
     FPaymentRequest.Currency));
@@ -422,7 +416,7 @@ procedure TTestYooKassaIntegration.TestReceiptAfterPayment_Agent_Sandbox;
 
       // check response
       AssertTrue('Receipt must be created', FReceiptResp.ID <> '');
-      AssertEquals('succeeded', FReceiptResp.GetStatus);
+      AssertEquals('succeeded', FReceiptResp.Status);
       AssertEquals(aPaymentId, FReceiptResp.PaymentId);
 
       // check that supplier was sent

yookassa_api.pas

@@ -16,37 +16,46 @@   TYookassaResponse = class
   private
     FRaw: TJSONObject;                  
     function GetId: string; virtual; abstract;
-    function GetStatus: string; virtual; abstract;
   public
     constructor Create(ARaw: TJSONObject);
     destructor Destroy; override;
     property Raw: TJSONObject read FRaw;
   end;
 
+  TPaymentStatus = (
+    psNone,              // Не указан  
+    psUnknown,           // Не распознан (нет в этом списке статусов)
+    psPending,           // Платеж создан и ожидает действий от пользователя
+    psWaitingForCapture, // Платеж оплачен, деньги авторизованы и ожидают списания
+    psSucceeded,         // Платеж успешно завершен
+    psCanceled           // Платеж отменен
+    );
+
   { TYookassaPaymentResponse }
   TYookassaPaymentResponse = class(TYookassaResponse) 
   private
     function GetConfirmationURL: string;
     function GetAmount: Currency;
     function GetCurrency: String;
-    function GetId: string; override; 
-    function GetStatus: string; override;
+    function GetId: string; override;
+    function GetStatus: TPaymentStatus;
   public
     property ConfirmationURL: string read GetConfirmationURL;
     property Amount: Currency read GetAmount;
     property Currency: String read GetCurrency;
     property ID: String read GetId;
-    property Status: String read GetStatus;
+    property Status: TPaymentStatus read GetStatus;
   end;
 
   { TYookassaReceiptResponse }
   TYookassaReceiptResponse = class(TYookassaResponse)
   private
     function GetPaymentId: String;   
     function GetId: string; override;
+    function GetStatus: string;
   public
-    function GetStatus: string; override;
     property PaymentId: string read GetPaymentId;
+    property Status: String read GetStatus;
     property ID: String read GetId;
   end;
 
@@ -373,6 +382,19 @@ function SettlementTypeToString(aSettlementType: TSettlementType): String;
   end;
 end;
 
+function StringToPaymentStatus(const aPaymentStatus: String): TPaymentStatus;
+begin
+  case aPaymentStatus of
+    '':                    Result:=psNone;
+    'pending':             Result:=psPending;
+    'waiting_for_capture': Result:=psWaitingForCapture;
+    'succeeded':           Result:=psSucceeded;
+    'canceled':            Result:=psCanceled;
+  else
+    Result:=psUnknown;
+  end;
+end;
+
 { TYookassaResponse }
 
 constructor TYookassaResponse.Create(ARaw: TJSONObject);
@@ -393,9 +415,9 @@ function TYookassaPaymentResponse.GetId: string;
   Result := Raw.Get('id', EmptyStr);
 end;
 
-function TYookassaPaymentResponse.GetStatus: string;
+function TYookassaPaymentResponse.GetStatus: TPaymentStatus;
 begin
-  Result := Raw.Get('status', EmptyStr);
+  Result := StringToPaymentStatus(Raw.Get('status', EmptyStr));
 end;
 
 function TYookassaPaymentResponse.GetConfirmationURL: string;
@@ -749,7 +771,6 @@ function TYookassaReceipt.ToJSON: TJSONObject;
 procedure TYookassaReceipt.AppendJSON(aJSON: TJSONObject);
 var
   aItems: TJSONArray;
-  aCustomer: TJSONObject;
   Item: TYookassaReceiptItem;
 begin
   if Assigned(FCustomer) then