Merge remote-tracking branch 'origin/develop'

Author: pavloskafritsas

README.md

@@ -1,63 +1,127 @@
 
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/support-ukraine.svg?t=1" />](https://supportukrainenow.org)
-
-# Implementation of viva wallet's API for laravel projects
+# Viva Wallet's API for Laravel applications
 
+![PHP Version](https://img.shields.io/packagist/php-v/deyjandi/laravel-viva-wallet)
+![Laravel Version](https://img.shields.io/badge/laravel-%3E%3D8-red)
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/deyjandi/laravel-viva-wallet.svg?style=flat-square)](https://packagist.org/packages/deyjandi/laravel-viva-wallet)
 [![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/deyjandi/laravel-viva-wallet/run-tests?label=tests)](https://github.com/deyjandi/laravel-viva-wallet/actions?query=workflow%3Arun-tests+branch%3Amain)
 [![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/deyjandi/laravel-viva-wallet/Check%20&%20fix%20styling?label=code%20style)](https://github.com/deyjandi/laravel-viva-wallet/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/deyjandi/laravel-viva-wallet.svg?style=flat-square)](https://packagist.org/packages/deyjandi/laravel-viva-wallet)
 
 This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
 
-## Support us
-
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/laravel-viva-wallet.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-viva-wallet)
-
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
 
-## Installation
+## Installation steps
 
-You can install the package via composer:
+### 1. install the package via composer:
 
 ```bash
 composer require deyjandi/laravel-viva-wallet
 ```
 
-You can publish and run the migrations with:
+### 2. Publish the `config` file with:
 
 ```bash
-php artisan vendor:publish --tag="laravel-viva-wallet-migrations"
-php artisan migrate
+php artisan vendor:publish --tag="viva-wallet-config"
 ```
 
-You can publish the config file with:
-
+### 3. Add at minimum the following to the `.env` file
 ```bash
-php artisan vendor:publish --tag="laravel-viva-wallet-config"
+VIVA_WALLET_MERCHANT_ID=<your-merchant-id>
+VIVA_WALLET_API_KEY=<your-api-id>
+VIVA_WALLET_CLIENT_ID=<your-smart-checkout-client-id>
+VIVA_WALLET_CLIENT_SECRET=<your-smart-checkout-secret>
 ```
+You can refer to the `./config/viva-wallet-config.php` for additional configuration options
+
+## Usage
 
-This is the contents of the published config file:
+
+### Create a Payment Order using the default configuration:
 
 ```php
-return [
-];
+...
+
+use Deyjandi\VivaWallet\Facades\VivaWallet;
+use Deyjandi\VivaWallet\Payment;
+
+...
+
+$payment = new Payment($amount = 1000);
+
+$checkoutUrl = VivaWallet::createPaymentOrder($payment);
+
+...
 ```
 
-Optionally, you can publish the views using
+### Create a Payment Order specifying every configurable option:
 
-```bash
-php artisan vendor:publish --tag="laravel-viva-wallet-views"
+```php
+...
+
+use Deyjandi\VivaWallet\Enums\RequestLang;
+use Deyjandi\VivaWallet\Enums\PaymentMethod;
+use Deyjandi\VivaWallet\Facades\VivaWallet;
+use Deyjandi\VivaWallet\Customer;
+use Deyjandi\VivaWallet\Payment;
+
+...
+
+$customer = new Customer(
+    $email = '[email protected]',
+    $fullName = 'John Doe',
+    $phone = '+306987654321',
+    $countryCode = 'GR',
+    $requestLang = RequestLang::Greek,
+);
+
+$payment = new Payment();
+
+$payment
+    ->setAmount(2500)
+    ->setCustomerTrns('short description of the items/services being purchased')
+    ->setCustomer($customer)
+    ->setPaymentTimeout(3600)
+    ->setPreauth(false)
+    ->setAllowRecurring(true)
+    ->setMaxInstallments(3)
+    ->setPaymentNotification(true)
+    ->setTipAmount(250)
+    ->setDisableExactAmount(false)
+    ->setDisableCash(true)
+    ->setDisableWallet(false)
+    ->setSourceCode(1234)
+    ->setMerchantTrns('customer order reference number')
+    ->setTags(['tag-1', 'tag-2'])
+    ->setBrandColor('009688')
+    ->setPreselectedPaymentMethod(PaymentMethod::PayPal);
+
+$checkoutUrl = VivaWallet::createPaymentOrder($payment);
+
+...
 ```
 
-## Usage
+
+### Retrieve transaction:
 
 ```php
-$vivaWallet = new Deyjandi\VivaWallet();
-echo $vivaWallet->echoPhrase('Hello, Deyjandi!');
+...
+
+use Deyjandi\VivaWallet\Facades\VivaWallet;
+
+...
+
+$transaction = VivaWallet::retrieveTransaction($transactionId);
+
+```
+
+### Request a webhook verification key:
+
+```zsh
+php artisan viva-wallet:webhook-key
 ```
+#### the webhook verification key is stored to the `.env` file automatically
+
 
 ## Testing
 
@@ -80,7 +144,6 @@ Please review [our security policy](../../security/policy) on how to report secu
 ## Credits
 
 - [Pavlos Kafritsas](https://github.com/Deyjandi)
-- [All Contributors](../../contributors)
 
 ## License
 

composer.json

@@ -25,6 +25,7 @@
         "spatie/laravel-package-tools": "^1.9.2"
     },
     "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.8",
         "nunomaduro/collision": "^6.0",
         "nunomaduro/larastan": "^2.0.1",
         "orchestra/testbench": "^7.0",
@@ -48,7 +49,8 @@
         }
     },
     "scripts": {
-        "analyse": "vendor/bin/phpstan analyse",
+        "analyse": "vendor/bin/phpstan analyse --memory-limit 256M",
+        "fix": "vendor/bin/php-cs-fixer fix --config .php_cs.dist.php",
         "test": "vendor/bin/pest",
         "test-coverage": "vendor/bin/pest --coverage"
     },

config/viva-wallet.php

@@ -1,6 +1,6 @@
 <?php
 
-use Deyjandi\VivaWallet\Enums\VivaWalletPaymentMethod;
+use Deyjandi\VivaWallet\Enums\PaymentMethod;
 
 return [
 
@@ -119,7 +119,7 @@
 
         'brand_color' => env('VIVA_WALLET_PAYMENT_BRAND_COLOR', '06abc1'),
 
-        'preselected_method' => env('VIVA_WALLET_PAYMENT_PRESELECTED_METHOD', VivaWalletPaymentMethod::CreditCard)
+        'preselected_method' => env('VIVA_WALLET_PAYMENT_PRESELECTED_METHOD', PaymentMethod::CreditCard)
 
     ],
 ];

database/factories/.gitkeep

@@ -4,9 +4,11 @@
 
 interface AuthToken
 {
-    public static function getInstance(): static;
+    public static function getInstance(): self;
 
     public function getAccessToken(): string;
 
     public function getTokenType(): string;
+
+    public function refresh(): self;
 }

src/Contracts/AuthToken.php

@@ -2,14 +2,14 @@
 
 namespace Deyjandi\VivaWallet;
 
-use Deyjandi\VivaWallet\Enums\VivaWalletRequestLang;
+use Deyjandi\VivaWallet\Enums\RequestLang;
 use Deyjandi\VivaWallet\Traits\FiltersUnsetData;
 use InvalidArgumentException;
 
 /**
  * Information about the customer.
  */
-class VivaWalletCustomer
+class Customer
 {
     use FiltersUnsetData;
 
@@ -43,14 +43,14 @@ class VivaWalletCustomer
      * It determines the language that Smart Checkout will appear in, and so on.
      * If left unspecified it is filled based on the countryCode property.
      */
-    private ?VivaWalletRequestLang $requestLang;
+    private ?RequestLang $requestLang;
 
     public function __construct(
         ?string $email = null,
         ?string $fullName = null,
         ?string $phone = null,
         ?string $countryCode = null,
-        ?VivaWalletRequestLang $requestLang = null,
+        ?RequestLang $requestLang = null,
     ) {
         $this->setEmail($email)
             ->setFullName($fullName)
@@ -119,7 +119,7 @@ public function setCountryCode(?string $countryCode): static
         return $this;
     }
 
-    public function setRequestLang(?VivaWalletRequestLang $requestLang): static
+    public function setRequestLang(?RequestLang $requestLang): static
     {
         $this->requestLang = $requestLang;
 

src/VivaWalletCustomer.php src/Customer.phpsrc/VivaWalletCustomer.php renamed to src/Customer.php

@@ -7,7 +7,7 @@
  *
  * @see https://developer.vivawallet.com/integration-reference/response-codes/#electronic-commerce-indicator
  */
-enum VivaWalletEci: int
+enum Eci: int
 {
     case Unspecified = 0;
     case Authenticated = 1;

src/Enums/VivaWalletEci.php src/Enums/Eci.phpsrc/Enums/VivaWalletEci.php renamed to src/Enums/Eci.php

@@ -3,9 +3,9 @@
 namespace Deyjandi\VivaWallet\Enums;
 
 use Deyjandi\VivaWallet\Helpers\ClientAuth;
-use Deyjandi\VivaWallet\VivaWalletToken;
+use Deyjandi\VivaWallet\Token;
 
-enum VivaWalletEnv: string
+enum Environment: string
 {
     case Demo = 'demo';
     case Live = 'live';
@@ -50,7 +50,7 @@ public function createOrder(array $data): array
             },
             'options' => [
                 'headers' => [
-                    'Authorization' => ClientAuth::token(VivaWalletToken::getInstance()),
+                    'Authorization' => ClientAuth::token(Token::getInstance()),
                     'Content-Type' => 'application/json',
                 ],
                 'json' => $data,
@@ -76,7 +76,7 @@ public function retrieveTransaction(string $transaction_id): array
             },
             'options' => [
                 'headers' => [
-                    'Authorization' => ClientAuth::token(VivaWalletToken::getInstance()),
+                    'Authorization' => ClientAuth::token(Token::getInstance()),
                 ],
             ],
         ];

src/Enums/VivaWalletEnv.php src/Enums/Environment.phpsrc/Enums/VivaWalletEnv.php renamed to src/Enums/Environment.php

@@ -5,7 +5,7 @@
 /**
  * @see https://developer.vivawallet.com/integration-reference/response-codes/#event-id-codes
  */
-enum VivaWalletEventId: int
+enum EventId: int
 {
     case Undefined = 0;
     case Incomplete3dsFlow = 2061;

src/Enums/VivaWalletEventId.php src/Enums/EventId.phpsrc/Enums/VivaWalletEventId.php renamed to src/Enums/EventId.php

@@ -2,7 +2,7 @@
 
 namespace Deyjandi\VivaWallet\Enums;
 
-enum VivaWalletPaymentMethod: int
+enum PaymentMethod: int
 {
     case CreditCard = 0;
     case PayPal = 23;