Merge branch 'v3.0' into v2.0

.gitattributes

@@ -0,0 +1 @@
+*.pdf filter=lfs diff=lfs merge=lfs -text

.github/workflows/static-analysis.yml

@@ -0,0 +1,35 @@
+name: Static Analysis
+on: [push, pull_request]
+jobs:
+  paypal:
+    name: PHP ${{ matrix.php-versions }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php-versions: ['7.0', '7.1', '7.2', '7.3', '7.4']
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Setup PHP with Composer and extensions
+      with:
+        php-version: ${{ matrix.php-versions }}
+      uses: shivammathur/setup-php@v2
+    - name: Get Composer cache directory
+      id: composercache
+      run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+    - name: Cache Composer dependencies
+      uses: actions/cache@v2
+      with:
+        php-version: ${{ matrix.php-versions }}
+        path: ${{ steps.composercache.outputs.dir }}
+        key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+        restore-keys: ${{ runner.os }}-composer-
+    - name: Install Composer dependencies
+      env:
+        PHP_VERSION: ${{ matrix.php-versions }}
+      run: composer install --no-progress --prefer-dist --optimize-autoloader $(if [ "$PHP_VERSION" == "8.0" || "$PHP_VERSION" == "8.1" ]; then echo "--ignore-platform-reqs"; fi;)    
+    - name: Run type checking analysis
+      env:
+        PHP_VERSION: ${{ matrix.php-versions }}
+      run: vendor/bin/phpstan

.github/workflows/tests.yml

@@ -1,4 +1,4 @@
-name: TestsV2
+name: Laravel PayPal V2
 on: [push, pull_request]
 jobs:
   paypal:
@@ -7,45 +7,49 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-versions: ['5.6', '7.0', '7.1']
+        php-versions: ['7.0', '7.1', '7.2', '7.3', '7.4']
     steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Setup PHP with Composer and extensions
-        with:
-          php-version: ${{ matrix.php-versions }}
-        uses: shivammathur/setup-php@v2
-      - name: Get Composer cache directory
-        id: composercache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-      - name: Cache Composer dependencies
-        uses: actions/cache@v2
-        with:
-          php-version: ${{ matrix.php-versions }}
-          path: ${{ steps.composercache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
-          restore-keys: ${{ runner.os }}-composer-
-      - name: Install Composer dependencies
-        env:
-          PHP_VERSION: ${{ matrix.php-versions }}
-        run: composer install --no-progress --prefer-dist --optimize-autoloader
-      - name: Run tests with code coverage
-        env:
-          PHP_VERSION: ${{ matrix.php-versions }}
-        run: vendor/bin/phpunit --coverage-clover build/logs/clover.xml
-      - name: Install PHP Coveralls library
-        env:
-          PHP_VERSION: ${{ matrix.php-versions }}
-        run:
-          composer global require --dev php-coveralls/php-coveralls
-      - name: Upload coverage results to Coveralls
-        env:
-          PHP_VERSION: ${{ matrix.php-versions }}
-          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          COVERALLS_PARALLEL: true
-          COVERALLS_FLAG_NAME: php-${{ matrix.php-versions }}
-        run:
-          php-coveralls -v
+    - name: Checkout
+      uses: actions/checkout@v2
+      with:
+        lfs: true
+    - name: Checkout LFS objects
+      run: git lfs checkout      
+    - name: Setup PHP with Composer and extensions
+      with:
+        php-version: ${{ matrix.php-versions }}
+      uses: shivammathur/setup-php@v2
+    - name: Get Composer cache directory
+      id: composercache
+      run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+    - name: Cache Composer dependencies
+      uses: actions/cache@v2
+      with:
+        php-version: ${{ matrix.php-versions }}
+        path: ${{ steps.composercache.outputs.dir }}
+        key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+        restore-keys: ${{ runner.os }}-composer-
+    - name: Install Composer dependencies
+      env:
+        PHP_VERSION: ${{ matrix.php-versions }}
+      run: composer install --no-progress --prefer-dist --optimize-autoloader $(if [ "$PHP_VERSION" == "8.0" || "$PHP_VERSION" == "8.1" ]; then echo "--ignore-platform-reqs"; fi;)    
+    - name: Run tests with code coverage
+      env:
+        PHP_VERSION: ${{ matrix.php-versions }}
+      run: vendor/bin/phpunit --coverage-clover build/logs/clover.xml
+    - name: Install PHP Coveralls library
+      env:
+        PHP_VERSION: ${{ matrix.php-versions }}
+      run:
+        composer global require --dev php-coveralls/php-coveralls
+    - name: Upload coverage results to Coveralls
+      env:
+        PHP_VERSION: ${{ matrix.php-versions }}
+        COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        COVERALLS_PARALLEL: true
+        COVERALLS_FLAG_NAME: php-${{ matrix.php-versions }}
+      run:
+        php-coveralls -v
   coveralls-finish:
     needs: [paypal]
     runs-on: ubuntu-latest

.gitignore

@@ -3,7 +3,8 @@
 .env
 composer.lock
 /build
-*docker*
 *-container*
 *.phpunit*
 test.php
+/.venv
+/docs/build

Dockerfile

@@ -0,0 +1,19 @@
+FROM srmklive/docker-php-cli:7.2
+
+LABEL maintainer="Raza Mehdi<[email protected]>"
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+# Set apps home directory.
+ENV APP_DIR /server/http
+
+# Define current working directory.
+WORKDIR ${APP_DIR}
+
+RUN apt-get -y autoclean \
+  && apt-get -y autoremove \
+  && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+COPY supervisor.conf /etc/supervisor/conf.d/supervisord.conf  
+
+CMD ["/usr/bin/supervisord"]

README.md

@@ -67,6 +67,20 @@ return [
 You can override PayPal API configuration by calling `setApiCredentials` method:
 
 ```php
+$config = [
+    'mode'    => 'live',
+    'live' => [
+        'client_id'         => 'PAYPAL_LIVE_CLIENT_ID',
+        'client_secret'     => 'PAYPAL_LIVE_CLIENT_SECRET',
+        'app_id'            => 'PAYPAL_LIVE_APP_ID',
+    ],
+
+    'payment_action' => 'Sale',
+    'currency'       => 'USD',
+    'notify_url'     => 'https://your-site.com/paypal/notify',
+    'locale'         => 'en_US',
+    'validate_ssl'   => true,
+];
 $provider->setApiCredentials($config);
 ```
 
@@ -128,9 +142,68 @@ $response = $provider->addProduct('Demo Product', 'Demo Product', 'SERVICE', 'SO
 
 ## Create Subscription by Existing Product & Billing Plan
 
+<a name="usage-helpers"></a>
+## Helper Methods
+
+> Please note that in the examples below, the call to `addPlanTrialPricing` is optional and it can be omitted when you are creating subscriptions without trial period.
+
+> `setReturnAndCancelUrl()` is optional. If you set urls you have to use real domains. e.g. localhost, project.test does not work.
+
+### Create Recurring Daily Subscription
+
+```php
+$response = $provider->addProduct('Demo Product', 'Demo Product', 'SERVICE', 'SOFTWARE')
+            ->addPlanTrialPricing('DAY', 7)
+            ->addDailyPlan('Demo Plan', 'Demo Plan', 1.50)
+            ->setReturnAndCancelUrl('https://example.com/paypal-success', 'https://example.com/paypal-cancel')
+            ->setupSubscription('John Doe', '[email protected]', '2021-12-10');
+```
+
+### Create Recurring Weekly Subscription
+
+```php
+$response = $provider->addProduct('Demo Product', 'Demo Product', 'SERVICE', 'SOFTWARE')
+            ->addPlanTrialPricing('DAY', 7)
+            ->addWeeklyPlan('Demo Plan', 'Demo Plan', 30)
+            ->setReturnAndCancelUrl('https://example.com/paypal-success', 'https://example.com/paypal-cancel')
+            ->setupSubscription('John Doe', '[email protected]', '2021-12-10');
+```
+
+### Create Recurring Monthly Subscription
+
+```php
+$response = $provider->addProduct('Demo Product', 'Demo Product', 'SERVICE', 'SOFTWARE')
+            ->addPlanTrialPricing('DAY', 7)
+            ->addMonthlyPlan('Demo Plan', 'Demo Plan', 100)
+            ->setReturnAndCancelUrl('https://example.com/paypal-success', 'https://example.com/paypal-cancel')
+            ->setupSubscription('John Doe', '[email protected]', '2021-12-10');
+```
+
+### Create Recurring Annual Subscription
+
+```php
+$response = $provider->addProduct('Demo Product', 'Demo Product', 'SERVICE', 'SOFTWARE')
+            ->addPlanTrialPricing('DAY', 7)
+            ->addAnnualPlan('Demo Plan', 'Demo Plan', 600)
+            ->setReturnAndCancelUrl('https://example.com/paypal-success', 'https://example.com/paypal-cancel')
+            ->setupSubscription('John Doe', '[email protected]', '2021-12-10');
+```
+
+### Create Recurring Subscription with Custom Intervals
+
+```php
+$response = $provider->addProduct('Demo Product', 'Demo Product', 'SERVICE', 'SOFTWARE')
+            ->addCustomPlan('Demo Plan', 'Demo Plan', 150, 'MONTH', 3)
+            ->setReturnAndCancelUrl('https://example.com/paypal-success', 'https://example.com/paypal-cancel')
+            ->setupSubscription('John Doe', '[email protected]', '2021-12-10');
+```
+
+### Create Subscription by Existing Product & Billing Plan
+
 ```php
 $response = $this->client->addProductById('PROD-XYAB12ABSB7868434')
     ->addBillingPlanById('P-5ML4271244454362WXNWU5NQ')
+    ->setReturnAndCancelUrl('https://example.com/paypal-success', 'https://example.com/paypal-cancel')
     ->setupSubscription('John Doe', '[email protected]', $start_date);
 ```
 

composer.json

@@ -26,7 +26,7 @@
     "nesbot/carbon": "~1.0|~2.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^5.7|^6.0|^7.0",
+    "phpunit/phpunit": "^5.7|^6.0|^7.0|^8.0",
     "symfony/var-dumper": "~3.0|~4.0|~5.0"
   },
   "config": {

docker-compose.yml

@@ -0,0 +1,10 @@
+version: '2'
+services:
+  app:
+    build:
+      context: ./
+      dockerfile: Dockerfile
+    image: srmklive/laravel-paypal
+    restart: always
+    volumes:
+    - ./:/server/http

phpstan.neon.dist

@@ -0,0 +1,9 @@
+parameters:
+  paths:
+    - src
+  level: 0
+  ignoreErrors:
+    - "#Parameter#"
+    - "#Call to static method error\\(\\)\\ on an unknown class Log.#"
+  excludePaths:
+    - "src/Providers/PayPalServiceProvider.php" 

phpunit.xml.dist

@@ -19,6 +19,8 @@
       <directory suffix=".php">src/</directory>
       <exclude>
         <file>src/PayPalFacadeAccessor.php</file>
+        <file>src/Traits/PayPalVerifyIPN.php</file>
+        <file>src/Services/Str.php</file>
         <directory suffix=".php">src/Facades/</directory>
         <directory suffix=".php">src/Providers/</directory>
       </exclude>

src/Services/PayPal.php

@@ -4,10 +4,12 @@
 
 use Exception;
 use Srmklive\PayPal\Traits\PayPalRequest as PayPalAPIRequest;
+use Srmklive\PayPal\Traits\PayPalVerifyIPN;
 
 class PayPal
 {
     use PayPalAPIRequest;
+    use PayPalVerifyIPN;
 
     /**
      * PayPal constructor.
@@ -24,10 +26,8 @@ public function __construct(array $config = [])
         $this->httpBodyParam = 'form_params';
 
         $this->options = [];
-        $this->options['headers'] = [
-            'Accept'            => 'application/json',
-            'Accept-Language'   => $this->locale,
-        ];
+
+        $this->setRequestHeader('Accept', 'application/json');
     }
 
     /**

src/Services/Str.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Srmklive\PayPal\Services;
+
+use GuzzleHttp\Utils;
+
+class Str extends \Illuminate\Support\Str
+{
+    /**
+     * Determine if a given value is valid JSON.
+     *
+     * @param mixed $value
+     *
+     * @return bool
+     */
+    public static function isJson($value): bool
+    {
+        if (!is_string($value)) {
+            return false;
+        }
+
+        if (function_exists('json_validate')) {
+            return json_validate($value, 512);
+        }
+
+        try {
+            Utils::jsonDecode($value, true, 512, 4194304);
+        } catch (\JsonException $jsonException) {
+            return false;
+        }
+
+        return true;
+    }
+}