Rename namespace of the library to handle more than one gateway

Author: Prometee

README.md

@@ -3,18 +3,16 @@
 [![Build Status][ico-travis]][link-travis]
 [![Quality Score][ico-code-quality]][link-code-quality]
 
-## Payum Stripe checkout session gateway
+## Payum Stripe gateways
 
-This library is designed to add a new gateway to Payum to support Stripe checkout session
-
-See https://stripe.com/docs/payments/checkout for more information.
+This library is designed to add a new gateways to Payum to support Stripe (with SCA support)
 
 ## Installation
 
 Install using Composer :
 
 ```bash
-composer require prometee/payum-stripe-checkout-session
+composer require prometee/payum-stripe
 ```
 
 Choose one of [php-http/client-implementation](https://packagist.org/providers/php-http/client-implementation),
@@ -26,121 +24,18 @@ composer require  php-http/guzzle6-adapter
 
 ## Configuration
 
-### API keys
-
-Get your `publishable_key` and your `secret_key` on your Stripe account :
-
-https://dashboard.stripe.com/test/apikeys
-
-### Webhook key
-Then get a `webhook_secret_key` configured with at least two events : 
-`payment_intent.canceled` and `checkout.session.completed`
-and configured with the url to the URL to `notify.php` 
-
-https://dashboard.stripe.com/test/webhooks
-
-```php
-<?php
-
-declare(strict_types=1);
-
-$loader = require_once( __DIR__.'/vendor/autoload.php');
-
-use Payum\Core\GatewayFactoryInterface;
-use Prometee\PayumStripeCheckoutSession\StripeCheckoutSessionGatewayFactory;
-use Payum\Core\PayumBuilder;
-use Payum\Core\Payum;
-
-/** @var Payum $payum */
-$payum = (new PayumBuilder())
-    ->addDefaultStorages()
-    ->addGatewayFactory('stripe_checkout_session', function(array $config, GatewayFactoryInterface $coreGatewayFactory) {
-        return new StripeCheckoutSessionGatewayFactory($config, $coreGatewayFactory);
-    })
-    ->addGateway('stripe_checkout_session', [
-        'factory' => 'stripe_checkout_session',
-        'publishable_key' => 'pk_test_abcdefghijklmnopqrstuvwx',
-        'secret_key' => 'sk_test_abcdefghijklmnopqrstuvwx',
-        'webhook_secret_keys' => [
-            'whsec_abcdefghijklmnopqrstuvwxyz012345'
-        ],
-    ])
-    ->getPayum()
-;
-```
-
-## Usage quick Example
-
-More effort is needed to get a full working Payum solution, but here is a generic example.
-
-```php
-<?php
-
-declare(strict_types=1);
-
-use Payum\Core\Model\Payment;
-
-$gateway = $payum->getGateway('stripe_checkout_session');
-
-$payment = new Payment();
-$payment->setNumber('00001');
-$payment->setTotalAmount(123);
-$payment->setCurrencyCode('USD');
-$payment->setClientEmail('test@domain.tld');
-$payment->setDescription('My test order');
-$payment->setDetails([]);
-
-$token = $payum->getTokenFactory()
-    ->createCaptureToken('stripe_checkout_session', $payment, '/after-pay.php');
-
-$gateway->execute(new Capture($token));
-```
-
-## Webhooks
-
-For generic info on Stripe webhooks read this :
-https://stripe.com/docs/webhooks
-
-### How the webhooks are handle into this gateway ?
-
-The starting point is always an `Action` with Payum and generically you have to use `Notify*Action` to handle webhooks.
-
-Because we have to set a static url without any token variable params on Stripe backend,
-we can't use `NotifyAction` but we can use [`NotifyUnsafeAction`](src/Action/NotifyAction.php) instead.
-
-This `Action` will ask for 2 other actions to :
-
-1. Resolve the webhook event, meaning :
-    - retrieve the Stripe signature in the request headers.
-    - try to construct the webhook `Event` object checking it with the webhook secret key.
-2. Give this resolved `Event` to an `Action` able to consume this `Event`.
-
-So if you want to consume another webhook event type, you just need to create an `Action` extending `Prometee\PayumStripeCheckoutSession\Action\Api\WebhookEvent\AbstractWebhookEventAction`.
-Examples available into the `src/Action/Api/WebhookEvent` folder.
-
-## TODO
-
- - Add a `RefundAction` if it's possible just with Payum interface.
- - Add Subscription basic webhooks.
- - Add `Extension` or `ConvertPayment` to handle subscription and card storing.
-
-## More
-
-Check the corresponding bundle :
-
-https://github.com/Prometee/PayumStripeCheckoutSessionBundle
+ - [Stripe Checkout Session gateway](docs/stripe-checkout-session/README.md)
+ - [Stripe JS gateway](docs/stripe-js/README.md)
 
-And the Sylius plugin :
 
-https://github.com/Prometee/SyliusPayumStripeCheckoutSessionPlugin
 
 
-[ico-version]: https://img.shields.io/packagist/v/Prometee/payum-stripe-checkout-session.svg?style=flat-square
+[ico-version]: https://img.shields.io/packagist/v/Prometee/payum-stripe.svg?style=flat-square
 [ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
-[ico-travis]: https://img.shields.io/travis/Prometee/PayumStripeCheckoutSession/master.svg?style=flat-square
-[ico-code-quality]: https://img.shields.io/scrutinizer/g/Prometee/PayumStripeCheckoutSession.svg?style=flat-square
+[ico-travis]: https://img.shields.io/travis/Prometee/PayumStripe/master.svg?style=flat-square
+[ico-code-quality]: https://img.shields.io/scrutinizer/g/Prometee/PayumStripe.svg?style=flat-square
 
-[link-packagist]: https://packagist.org/packages/prometee/payum-stripe-checkout-session
-[link-travis]: https://travis-ci.org/Prometee/PayumStripeCheckoutSession
-[link-scrutinizer]: https://scrutinizer-ci.com/g/Prometee/PayumStripeCheckoutSession/code-structure
-[link-code-quality]: https://scrutinizer-ci.com/g/Prometee/PayumStripeCheckoutSession
+[link-packagist]: https://packagist.org/packages/prometee/payum-stripe
+[link-travis]: https://travis-ci.org/Prometee/PayumStripe
+[link-scrutinizer]: https://scrutinizer-ci.com/g/Prometee/PayumStripe/code-structure
+[link-code-quality]: https://scrutinizer-ci.com/g/Prometee/PayumStripe

composer.json

@@ -1,6 +1,6 @@
 {
-    "name": "prometee/payum-stripe-checkout-session",
-    "description": "Payum Stripe checkout session gateway",
+    "name": "prometee/payum-stripe",
+    "description": "Payum Stripe gateways",
     "type": "library",
     "require": {
         "php": "^7.3",
@@ -14,10 +14,10 @@
         "phpstan/phpstan": "^0.12.18"
     },
     "autoload": {
-        "psr-4": { "Prometee\\PayumStripeCheckoutSession\\": "src/" }
+        "psr-4": { "Prometee\\PayumStripe\\": "src/" }
     },
     "autoload-dev": {
-        "psr-4": { "Tests\\Prometee\\PayumStripeCheckoutSession\\": "tests/" }
+        "psr-4": { "Tests\\Prometee\\PayumStripe\\": "tests/" }
     },
     "license": "MIT",
     "extra": {

docs/stripe-checkout-session/README.md

@@ -0,0 +1,102 @@
+# Payum Stripe checkout session gateway
+
+See https://stripe.com/docs/payments/checkout for more information.
+
+## Configuration
+
+First get [your credentials](../stripe-credentials.md) from Stripe dashboard.
+
+```php
+<?php
+
+declare(strict_types=1);
+
+$loader = require_once( __DIR__.'/vendor/autoload.php');
+
+use Payum\Core\GatewayFactoryInterface;
+use Prometee\PayumStripe\StripeCheckoutSessionGatewayFactory;
+use Payum\Core\PayumBuilder;
+use Payum\Core\Payum;
+
+/** @var Payum $payum */
+$payum = (new PayumBuilder())
+    ->addDefaultStorages()
+    ->addGatewayFactory('stripe_checkout_session', function(array $config, GatewayFactoryInterface $coreGatewayFactory) {
+        return new StripeCheckoutSessionGatewayFactory($config, $coreGatewayFactory);
+    })
+    ->addGateway('stripe_checkout_session', [
+        'factory' => 'stripe_checkout_session',
+        'publishable_key' => 'pk_test_abcdefghijklmnopqrstuvwx',
+        'secret_key' => 'sk_test_abcdefghijklmnopqrstuvwx',
+        'webhook_secret_keys' => [
+            'whsec_abcdefghijklmnopqrstuvwxyz012345'
+        ],
+    ])
+    ->getPayum()
+;
+```
+
+## Usage quick Example
+
+More effort is needed to get a full working Payum solution, but here is a generic example.
+
+```php
+<?php
+
+declare(strict_types=1);
+
+use Payum\Core\Model\Payment;
+use Payum\Core\Request\Capture;
+
+$gateway = $payum->getGateway('stripe_checkout_session');
+
+$payment = new Payment();
+$payment->setNumber('00001');
+$payment->setTotalAmount(123);
+$payment->setCurrencyCode('USD');
+$payment->setClientEmail('test@domain.tld');
+$payment->setDescription('My test order');
+$payment->setDetails([]);
+
+$token = $payum->getTokenFactory()
+    ->createCaptureToken('stripe_checkout_session', $payment, '/after-pay.php');
+
+$gateway->execute(new Capture($token));
+```
+
+## Webhooks
+
+For generic info on Stripe webhooks read this :
+https://stripe.com/docs/webhooks
+
+### How the webhooks are handle into this gateway ?
+
+The starting point is always an `Action` with Payum and generically you have to use `Notify*Action` to handle webhooks.
+
+Because we have to set a static url on Stripe backend (eg: without any token variable params),
+we have to use what Payum is calling a `NotifyUnsafe`, it's a `Notify` with a `null` `Token`.
+You can find this action here : [`NotifyAction.php`](../../src/Action/NotifyAction.php).
+If the token is null then we will try to handle a webhook, and if a token is detected
+then it's a normal `Notify` so we must handle a `Sync` to refresh a payment details.
+
+#### Resolving a webhook : `NotifyUnsafe`
+The [`NotifyAction.php`](../../src/Action/NotifyAction.php) will ask for 2 other actions to :
+
+1. Resolve the webhook event, meaning :
+    - retrieve the Stripe signature in the request headers.
+    - try to construct the webhook `Event` object, checking it with the webhook secret key.
+2. Give this resolved `Event` to an `Action` able to consume this `Event`.
+
+So if you want to consume another webhook event type, you just need to create an `Action`
+extending [`Prometee\PayumStripe\Action\Api\WebhookEvent\AbstractWebhookEventAction`](../../src/Action/Api/WebhookEvent/AbstractWebhookEventAction.php).
+Examples available into the [`src/Action/Api/WebhookEvent/`](../../src/Action/Api/WebhookEvent) folder.
+
+## More
+
+Check the dedicated bundle :
+
+https://github.com/Prometee/PayumStripeCheckoutSessionBundle
+
+And the Sylius plugin :
+
+https://github.com/Prometee/SyliusPayumStripeCheckoutSessionPlugin

docs/stripe-credentials.md

@@ -0,0 +1,14 @@
+# Credentials
+
+## API keys
+
+Get your `publishable_key` and your `secret_key` on your Stripe account :
+
+https://dashboard.stripe.com/test/apikeys
+
+## Webhook key
+Then get a `webhook_secret_key` configured with at least two events : 
+`payment_intent.canceled` and `checkout.session.completed`
+and configured with the url to the URL to `notify.php` 
+
+https://dashboard.stripe.com/test/webhooks

docs/stripe-js/README.md

@@ -0,0 +1,5 @@
+# Payum Stripe js gateway
+
+See https://stripe.com/docs/payments for more information.
+
+WORK IN PROGRESS !

src/Action/Api/ConstructEventAction.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Prometee\PayumStripeCheckoutSession\Action\Api;
+namespace Prometee\PayumStripe\Action\Api;
 
 use Payum\Core\Action\ActionInterface;
 use Payum\Core\Exception\RequestNotSupportedException;
-use Prometee\PayumStripeCheckoutSession\Request\Api\ConstructEvent;
-use Prometee\PayumStripeCheckoutSession\Wrapper\EventWrapper;
+use Prometee\PayumStripe\Request\Api\ConstructEvent;
+use Prometee\PayumStripe\Wrapper\EventWrapper;
 use Stripe\Exception\SignatureVerificationException;
 use Stripe\Webhook;
 

src/Action/Api/RedirectToCheckoutAction.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Prometee\PayumStripeCheckoutSession\Action\Api;
+namespace Prometee\PayumStripe\Action\Api;
 
 use Payum\Core\Action\ActionInterface;
 use Payum\Core\ApiAwareInterface;
@@ -11,7 +11,7 @@
 use Payum\Core\GatewayAwareTrait;
 use Payum\Core\Reply\HttpResponse;
 use Payum\Core\Request\RenderTemplate;
-use Prometee\PayumStripeCheckoutSession\Request\Api\RedirectToCheckout;
+use Prometee\PayumStripe\Request\Api\RedirectToCheckout;
 
 final class RedirectToCheckoutAction implements ActionInterface, ApiAwareInterface, GatewayAwareInterface
 {

src/Action/Api/ResolveWebhookEventAction.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Prometee\PayumStripeCheckoutSession\Action\Api;
+namespace Prometee\PayumStripe\Action\Api;
 
 use LogicException;
 use Payum\Core\Action\ActionInterface;
@@ -11,9 +11,9 @@
 use Payum\Core\GatewayAwareInterface;
 use Payum\Core\GatewayAwareTrait;
 use Payum\Core\Request\GetHttpRequest;
-use Prometee\PayumStripeCheckoutSession\Request\Api\ConstructEvent;
-use Prometee\PayumStripeCheckoutSession\Request\Api\ResolveWebhookEvent;
-use Prometee\PayumStripeCheckoutSession\Wrapper\EventWrapperInterface;
+use Prometee\PayumStripe\Request\Api\ConstructEvent;
+use Prometee\PayumStripe\Request\Api\ResolveWebhookEvent;
+use Prometee\PayumStripe\Wrapper\EventWrapperInterface;
 
 class ResolveWebhookEventAction implements ActionInterface, GatewayAwareInterface, ApiAwareInterface
 {

src/Action/Api/Resource/AbstractAllAction.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Prometee\PayumStripeCheckoutSession\Action\Api\Resource;
+namespace Prometee\PayumStripe\Action\Api\Resource;
 
 use Payum\Core\Exception\LogicException;
 use Payum\Core\Exception\RequestNotSupportedException;
-use Prometee\PayumStripeCheckoutSession\Action\Api\StripeApiAwareTrait;
-use Prometee\PayumStripeCheckoutSession\Request\Api\Resource\AllInterface;
+use Prometee\PayumStripe\Action\Api\StripeApiAwareTrait;
+use Prometee\PayumStripe\Request\Api\Resource\AllInterface;
 use Stripe\ApiOperations\All;
 use Stripe\Collection;
 use Stripe\Exception\ApiErrorException;

src/Action/Api/Resource/AbstractCreateAction.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Prometee\PayumStripeCheckoutSession\Action\Api\Resource;
+namespace Prometee\PayumStripe\Action\Api\Resource;
 
 use Payum\Core\Exception\LogicException;
 use Payum\Core\Exception\RequestNotSupportedException;
-use Prometee\PayumStripeCheckoutSession\Action\Api\StripeApiAwareTrait;
-use Prometee\PayumStripeCheckoutSession\Request\Api\Resource\CreateInterface;
+use Prometee\PayumStripe\Action\Api\StripeApiAwareTrait;
+use Prometee\PayumStripe\Request\Api\Resource\CreateInterface;
 use Stripe\ApiOperations\Create;
 use Stripe\ApiResource;
 use Stripe\Exception\ApiErrorException;