Merge pull request #3 from ar4min/main

V-3

Author: ar4min

examples/FeeCalculation.php

@@ -0,0 +1,38 @@
+<?php
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use ZarinPal\Sdk\Options;
+use ZarinPal\Sdk\ZarinPal;
+use ZarinPal\Sdk\HttpClient\Exception\ResponseException;
+use ZarinPal\Sdk\Endpoint\PaymentGateway\RequestTypes\FeeCalculationRequest;
+
+$options = new Options([
+    'merchant_id' => '67887a6d-e2f8-4de2-86b1-8db27bc171b5',
+]);
+
+$zarinpal = new ZarinPal($options);
+$paymentGateway = $zarinpal->paymentGateway();
+
+$feeCalculationRequest = new FeeCalculationRequest();
+$feeCalculationRequest->amount = 5000000;
+$feeCalculationRequest->currency = 'IRR'; // Optional - IRR or IRT
+
+try {
+    $response = $paymentGateway->feeCalculation($feeCalculationRequest);
+    echo "Fee Calculation Result: \n";
+    echo "Amount: " . $response->amount . "\n";
+    echo "Fee: " . $response->fee . "\n";
+    echo "Fee Type: " . $response->fee_type . "\n";
+    echo "Suggested Amount: " . $response->suggested_amount . "\n";
+    echo "Code: " . $response->code . "\n";
+    echo "Message: " . $response->message . "\n";
+
+} catch (ResponseException $e) {
+    echo 'Fee Calculation Error: ' . $e->getMessage() . "\n";
+    if ($e->getErrorDetails()) {
+        echo 'Error Details: ' . json_encode($e->getErrorDetails()) . "\n";
+    }
+} catch (\Exception $e) {
+    echo 'Fee Calculation Error: ' . $e->getMessage();
+} 

src/Endpoint/PaymentGateway/PaymentGateway.php

@@ -7,6 +7,7 @@
 use Exception;
 use JsonException;
 use Psr\Http\Message\ResponseInterface;
+use ZarinPal\Sdk\Endpoint\PaymentGateway\ResponseTypes\FeeCalculationResponse;
 use ZarinPal\Sdk\Endpoint\PaymentGateway\ResponseTypes\RequestResponse;
 use ZarinPal\Sdk\Endpoint\PaymentGateway\ResponseTypes\UnverifiedResponse;
 use ZarinPal\Sdk\Endpoint\PaymentGateway\ResponseTypes\VerifyResponse;
@@ -23,6 +24,7 @@ final class PaymentGateway
     private const UNVERIFIED_URI = self::BASE_URL . 'unVerified.json';
     private const REVERSE_URI = self::BASE_URL . 'reverse.json';
     private const INQUIRY_URI = self::BASE_URL . 'inquiry.json';
+    private const FEE_CALCULATION_URI = self::BASE_URL . 'feeCalculation.json';
 
     private ZarinPal $sdk;
 
@@ -77,6 +79,14 @@ public function inquiry(RequestTypes\InquiryRequest $request): RequestResponse
         return new RequestResponse($response['data']);
     }
 
+    public function feeCalculation(RequestTypes\FeeCalculationRequest $request): FeeCalculationResponse
+    {
+        $this->fillMerchantId($request);
+        $response = $this->httpHandler(self::FEE_CALCULATION_URI, $request->toString());
+
+        return new FeeCalculationResponse($response['data']);
+    }
+
     private function fillMerchantId($request): void
     {
         if ($request->merchantId === null) {

src/Endpoint/PaymentGateway/RequestTypes/FeeCalculationRequest.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace ZarinPal\Sdk\Endpoint\PaymentGateway\RequestTypes;
+
+use ZarinPal\Sdk\Endpoint\Fillable;
+use ZarinPal\Sdk\Validator;
+
+class FeeCalculationRequest
+{
+    use Fillable;
+
+    public ?string $merchantId = null;
+    public int $amount;
+    public ?string $currency = null;
+
+    public function validate(): void
+    {
+        Validator::validateMerchantId($this->merchantId);
+        Validator::validateAmount($this->amount);
+        Validator::validateCurrency($this->currency);
+    }
+
+    final public function toString(): string
+    {
+        $this->validate();
+
+        $data = [
+            "merchant_id" => $this->merchantId,
+            "amount" => $this->amount,
+        ];
+
+        if ($this->currency !== null) {
+            $data['currency'] = $this->currency;
+        }
+
+        return json_encode($data, JSON_THROW_ON_ERROR);
+    }
+} 

src/Endpoint/PaymentGateway/ResponseTypes/FeeCalculationResponse.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ZarinPal\Sdk\Endpoint\PaymentGateway\ResponseTypes;
+
+use ZarinPal\Sdk\Endpoint\Fillable;
+
+class FeeCalculationResponse
+{
+    use Fillable;
+
+    public int $amount;
+    public int $fee;
+    public string $fee_type;
+    public int $suggested_amount;
+    public int $code;
+    public string $message;
+} 

tests/PaymentGateway/PaymentGatewayTest.php

@@ -8,6 +8,7 @@
 use Tests\BaseTestCase;
 use ZarinPal\Sdk\ZarinPal;
 use ZarinPal\Sdk\Endpoint\PaymentGateway\PaymentGateway;
+use ZarinPal\Sdk\Endpoint\PaymentGateway\RequestTypes\FeeCalculationRequest;
 use ZarinPal\Sdk\Endpoint\PaymentGateway\RequestTypes\RequestRequest;
 use ZarinPal\Sdk\Endpoint\PaymentGateway\RequestTypes\VerifyRequest;
 use ZarinPal\Sdk\Endpoint\PaymentGateway\RequestTypes\UnverifiedRequest;
@@ -172,4 +173,35 @@ public function testInquiry()
         $response = $this->gateway->inquiry($inquiryRequest);
         $this->assertEquals(15000, $response->amount);
     }
+
+    public function testFeeCalculation()
+    {
+        $responseBody = [
+            'data' => [
+                'amount' => 5050543,
+                'fee' => 1220,
+                'fee_type' => 'Merchant',
+                'suggested_amount' => 5051763,
+                'code' => 100,
+                'message' => 'Success'
+            ],
+            'errors' => []
+        ];
+
+        $this->clientMock->expects($this->once())
+            ->method('post')
+            ->willReturn($this->createMockResponse($responseBody));
+
+        $feeCalculationRequest = new FeeCalculationRequest();
+        $feeCalculationRequest->amount = 5050543;
+        $feeCalculationRequest->currency = 'IRR';
+
+        $response = $this->gateway->feeCalculation($feeCalculationRequest);
+        $this->assertEquals(5050543, $response->amount);
+        $this->assertEquals(1220, $response->fee);
+        $this->assertEquals('Merchant', $response->fee_type);
+        $this->assertEquals(5051763, $response->suggested_amount);
+        $this->assertEquals(100, $response->code);
+        $this->assertEquals('Success', $response->message);
+    }
 }