Enhance doc

Author: Prometee

README.md

@@ -6,6 +6,11 @@
 ## Payum Stripe gateways
 
 This library is designed to add a new gateways to Payum to support Stripe (with SCA support)
+Actually there is one Gateway fully supported `Stripe checkout session` but soon `Stripe JS` will be supported too.
+
+> If you are using Symfony use the bundle : [prometee/payum-stripe-checkout-bundle](https://github.com/Prometee/PayumStripeCheckoutSessionBundle)
+
+> If you are using Sylius use the plugin : [prometee/sylius-payum-stripe-checkout-session-plugin](https://github.com/Prometee/SyliusPayumStripeCheckoutSessionPlugin)
 
 ## Installation
 
@@ -22,12 +27,27 @@ the most used is [php-http/guzzle6-adapter](https://packagist.org/packages/php-h
 composer require  php-http/guzzle6-adapter
 ```
 
-## Configuration
+## Gateways configuration
+
+ - [Stripe Checkout Session](docs/stripe-checkout-session/README.md)
+   
+   Support :
+    - ["One-time payments"](https://stripe.com/docs/payments/checkout/one-time)
+    - ["Subscription"](https://stripe.com/docs/payments/checkout/subscriptions/starting)
+    - ["Update payment details"](https://stripe.com/docs/payments/checkout/subscriptions/updating)
+    
+ - [WIP] [Stripe JS](docs/stripe-js/README.md)
+
+## More
 
- - [Stripe Checkout Session gateway](docs/stripe-checkout-session/README.md)
- - [Stripe JS gateway](docs/stripe-js/README.md)
+### What to use with Stripe Checkout Session gateway ?
 
+ - A Symfony bundle : [prometee/payum-stripe-checkout-bundle](https://github.com/Prometee/PayumStripeCheckoutSessionBundle)
+ - A Sylius plugin : [prometee/sylius-payum-stripe-checkout-session-plugin](https://github.com/Prometee/SyliusPayumStripeCheckoutSessionPlugin)
+  
+### What to use with Stripe JS gateway ?
 
+ - [WORK IN PROGRESS]
 
 
 [ico-version]: https://img.shields.io/packagist/v/Prometee/payum-stripe.svg?style=flat-square

docs/stripe-checkout-session/README.md

@@ -80,6 +80,7 @@ If the token is null then we will try to handle a webhook, and if a token is det
 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 :
@@ -91,12 +92,25 @@ So if you want to consume another webhook event type, you just need to create an
 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
+## Subscription handling
+
+Payum don't have php `Interfaces` to handle subscription, that's why subscriptions should be
+managed by yourself. There is maybe a composer packages which meet your need,
+but you will have to build the interface between your subscription `Model` class and `Payum`.
+
+Usually you will have to build a `ConvertPaymentAction` like this one : [ConvertPaymentAction.php](https://github.com/Prometee/SyliusPayumStripeCheckoutSessionPlugin/blob/master/src/Action/ConvertPaymentAction.php)
+customizing the `supports` method to meet your need and finally providing the right `$details` array.
 
-Check the dedicated bundle :
+Example : https://stripe.com/docs/payments/checkout/subscriptions/starting#create-checkout-session (`$details` is the array given to create a `Session`)
 
-https://github.com/Prometee/PayumStripeCheckoutSessionBundle
+## Subscription update payment details
 
-And the Sylius plugin :
+Same as the [previous chapter](#subscription-handling)
+
+Example : https://stripe.com/docs/payments/checkout/subscriptions/updating#create-checkout-session (`$details` is the array given to create a `Session`)
+
+## More
 
-https://github.com/Prometee/SyliusPayumStripeCheckoutSessionPlugin
+ - A Symfony bundle : [prometee/payum-stripe-checkout-bundle](https://github.com/Prometee/PayumStripeCheckoutSessionBundle)
+ - A Sylius plugin : [prometee/sylius-payum-stripe-checkout-session-plugin](https://github.com/Prometee/SyliusPayumStripeCheckoutSessionPlugin)
+  

docs/stripe-credentials.md

@@ -16,7 +16,33 @@ Then get a `webhook_secret_key` configured with at least two events :
 The URL to fill is the url to your `notify.php`, here is an example :
 
 ```
-http://localhost/notify.php?gateway=stripe_checkout_session
+https://localhost/notify.php?gateway=stripe_checkout_session
 ```
 
 https://dashboard.stripe.com/test/webhooks
+
+## Test or dev environment
+
+Webhooks are triggered by Stripe on their server to your server.
+If the server is into a private network, Stripe won't be allowed to reach your server.
+
+Stripe provide an alternate way to catch those webhook events, you can use
+`Stripe cli` : https://stripe.com/docs/stripe-cli
+Follow the link and install `Stripe cli`, then use those command line to get
+your webhook key :
+
+First login to your Stripe account (needed every 90 days) :
+
+```bash
+stripe login
+```
+
+Then start to listen for the 2 required events, forwarding request to you local server :
+
+```bash
+stripe listen \
+    --events checkout.session.completed,payment_intent.canceled \
+    --forward-to https://localhost/notify.php?gateway=stripe_checkout_session
+```
+
+> Replace the --forward-to argument value with the right one you need.