Merge pull request #26 from Payum/reuse-facade

reuse payum facade, cleanup\simplify things.
Payum · Sep 28, 2015 · fa013c4 · fa013c4
2 parents 0045862 + 69813ea
commit fa013c4
Show file tree

Hide file tree

Showing 20 changed files with 415 additions and 723 deletions.
diff --git a/docs/eloquent_storage.md b/docs/eloquent_storage.md
@@ -17,23 +17,26 @@ class Payment extends Illuminate\Database\Eloquent\Model
 Register a storage for it 
 
 ```php
-// app/config/packages/payum/payum-laravel-package/config.php
+// bootstrap/start.php
 
 use Payum\LaravelPackage\Storage\EloquentStorage;
 
-return array(
-    'storages' => array(
-        'Payment' => new EloquentStorage('Payment'),
-    )
-);
+App::resolving('payum.builder', function(\Payum\Core\PayumBuilder $payumBuilder) {
+    $payumBuilder
+        ->addStorage(Payment::class, new EloquentStorage(Payment::class))
+    ;
+});
 ```
 
 ## Models 
 
 The package provides two models `Payum\LaravelPackage\Model\Token` and `Payum\LaravelPackage\Model\Payment` which may be reused directly or extend with some custom logic.
 Here's the models schemas:
 
-Order:
+Payment:
+
+The database schema could be generated like this
+
 ```php
 <?php
 
@@ -51,9 +54,26 @@ Order:
 });
 ```
 
+The storage could be registered like this
+
+```php
+// bootstrap/start.php
+
+use Payum\LaravelPackage\Storage\EloquentStorage;
+use Payum\LaravelPackage\Model\Payment;
+
+App::resolving('payum.builder', function(\Payum\Core\PayumBuilder $payumBuilder) {
+    $payumBuilder
+        ->addStorage(Payment::class, new EloquentStorage(Payment::class))
+    ;
+});
+```
+
 
 Token:
 
+The database schema could be generated like this
+
 ```php
 <?php
 
@@ -68,4 +88,19 @@ Token:
 });
 ```
 
+The token storage could be registered like this
+
+```php
+// bootstrap/start.php
+
+use Payum\LaravelPackage\Storage\EloquentStorage;
+use Payum\LaravelPackage\Model\Token;
+
+App::resolving('payum.builder', function(\Payum\Core\PayumBuilder $payumBuilder) {
+    $payumBuilder
+        ->setTokenStorage(new EloquentStorage(Token::class))
+    ;
+});
+```
+
 Back to [index](index.md).
diff --git a/docs/examples.md b/docs/examples.md
@@ -4,60 +4,102 @@
 
 Described in [Get it started](get-it-started.md)
 
+## Payment model
+
+* Configuration
+
+```bash
+$ php composer.phar require payum/payum-laravel-package payum/offline
+```
+
+```php
+// bootstrap/start.php
+
+App::resolving('payum.builder', function(\Payum\Core\PayumBuilder $payumBuilder) {
+    $payumBuilder
+        ->addGateway('offline', ['factory' => 'offline'])
+    ;
+});
+```
+
+* Prepare payment
+
+```php
+<?php
+// app/controllers/PaymentController.php
+
+use Payum\LaravelPackage\Controller\PayumController;
+
+cclass PaymentController extends PayumController
+{
+ 	public function preparePayment()
+ 	{
+         $storage = $this->getPayum()->getStorage('Payum\Core\Model\Payment');
+
+         $payment = $storage->create();
+         $payment->setNumber(uniqid());
+         $payment->setCurrencyCode('EUR');
+         $payment->setTotalAmount(123); // 1.23 EUR
+         $payment->setDescription('A description');
+         $payment->setClientId('anId');
+         $payment->setClientEmail('foo@example.com');
+         $payment->setDetails(array(
+           // put here any fields in a gateway format.
+           // for example if you use Paypal ExpressCheckout you can define a description of the first item:
+           // 'L_PAYMENTREQUEST_0_DESC0' => 'A desc',
+         ));
+         $storage->update($payment);
+
+         $captureToken = $payum->getTokenFactory()->createCaptureToken('offline', $payment, 'payment_done');
+
+         return \Redirect::to($captureToken->getTargetUrl());
+ 	}
+}
+```
+
 ## Stripe.Js
 
 * Configuration
 
 ```bash
 $ php composer.phar require payum/payum-laravel-package stripe/stripe-php payum/stripe
-$ php artisan config:publish payum/payum-laravel-package
 ```
 
 ```php
-// app/config/packages/payum/payum-laravel-package/config.php
-
-use Payum\LaravelPackage\Action\GetHttpRequestAction;
-use Payum\Core\Storage\FilesystemStorage;
-
-$detailsClass = 'Payum\Core\Model\ArrayObject';
-$tokenClass = 'Payum\Core\Model\Token';
-
-$stripeJsGatewayFactory = new \Payum\Stripe\StripeJsGatewayFactory();
-
-return array(
-    'token_storage' => new FilesystemStorage(__DIR__.'/../../../../storage/payments', $tokenClass, 'hash'),
-    'gateways' => array(
-        'stripe_js' => $stripeJsGatewayFactory->create(array(
-            'publishable_key' => $_SERVER['payum.stripe.publishable_key'],
-            'secret_key' => $_SERVER['payum.stripe.secret_key'],
-            'payum.action.get_http_request' => new GetHttpRequestAction(),
-        )),
-    ),
-    'storages' => array(
-        $detailsClass => new FilesystemStorage(__DIR__.'/../../../../storage/payments', $detailsClass),
-    )
-);
+// bootstrap/start.php
+
+App::resolving('payum.builder', function(\Payum\Core\PayumBuilder $payumBuilder) {
+    $payumBuilder
+        ->addGateway('stripe_js', [
+            'factory' => 'stripe_js',
+            'publishable_key' => 'EDIT ME',
+            'secret_key' => 'EDIT ME',
+         ])
+    ;
+});
 ```
 
 * Prepare payment
 
 ```php
 <?php
-// app/controllers/PaypalController.php
+// app/controllers/StripeController.php
 
-cclass StripeController extends BaseController
+use Payum\LaravelPackage\Controller\PayumController;
+
+cclass StripeController extends PayumController
 {
  	public function prepareJs()
  	{
-         $storage = \App::make('payum')->getStorage('Payum\Core\Model\ArrayObject');
+         $storage = $this->getPayum()->getStorage('Payum\Core\Model\ArrayObject');
 
          $details = $storage->create();
          $details['amount'] = '100';
          $details['currency'] = 'USD';
          $details['description'] = 'a desc';
          $storage->update($details);
 
-         $captureToken = \App::make('payum.security.token_factory')->createCaptureToken('stripe_js', $details, 'payment_done');
+         $captureToken = $this->getPayum()->getTokenFactory()->createCaptureToken('stripe_js', $details, 'payment_done');
 
          return \Redirect::to($captureToken->getTargetUrl());
  	}
@@ -70,54 +112,43 @@ cclass StripeController extends BaseController
 
 ```bash
 $ php composer.phar require payum/stripe payum/payum-laravel-package stripe/stripe-php
-$ php artisan config:publish payum/payum-laravel-package
 ```
 
 ```php
-// app/config/packages/payum/payum-laravel-package/config.php
-
-use Payum\LaravelPackage\Action\GetHttpRequestAction;
-use Payum\Core\Storage\FilesystemStorage;
-
-$detailsClass = 'Payum\Core\Model\ArrayObject';
-$tokenClass = 'Payum\Core\Model\Token';
+// bootstrap/start.php
 
-$stripeCheckoutGatewayFactory = new \Payum\Stripe\StripeCheckoutGatewayFactory();
-
-return array(
-    'token_storage' => new FilesystemStorage(__DIR__.'/../../../../storage/payments', $tokenClass, 'hash'),
-    'gateways' => array(
-        'stripe_checkout' => $stripeCheckoutGatewayFactory->create(array(
+App::resolving('payum.builder', function(\Payum\Core\PayumBuilder $payumBuilder) {
+    $payumBuilder
+        ->addGateway('stripe_checkout', [
+            'factory' => 'stripe_checkout',
             'publishable_key' => 'EDIT ME',
             'secret_key' => 'EDIT ME',
-            'payum.action.get_http_request' => new GetHttpRequestAction(),
-        )),
-    ),
-    'storages' => array(
-        $detailsClass => new FilesystemStorage(__DIR__.'/../../../../storage/payments', $detailsClass),
-    )
-);
+         ])
+    ;
+});
 ```
 
 * Prepare payment
 
 ```php
 <?php
-// app/controllers/PaypalController.php
+// app/controllers/StripeController.php
+
+use Payum\LaravelPackage\Controller\PayumController;
 
-cclass StripeController extends BaseController
+cclass StripeController extends PayumController
 {
  	public function prepareCheckout()
  	{
-         $storage = \App::make('payum')->getStorage('Payum\Core\Model\ArrayObject');
+         $storage = $this->getPayum()->getStorage('Payum\Core\Model\ArrayObject');
 
          $details = $storage->create();
          $details['amount'] = '100';
          $details['currency'] = 'USD';
          $details['description'] = 'a desc';
          $storage->update($details);
 
-         $captureToken = \App::make('payum.security.token_factory')->createCaptureToken('stripe_checkout', $details, 'payment_done');
+         $captureToken = $this->getPayum()->getTokenFactory()->createCaptureToken('stripe_checkout', $details, 'payment_done');
 
          return \Redirect::to($captureToken->getTargetUrl());
  	}
@@ -130,56 +161,45 @@ cclass StripeController extends BaseController
 
 ```bash
 $ php composer.phar require payum/omnipay-bridge payum/payum-laravel-package omnipay/stripe
-$ php artisan config:publish payum/payum-laravel-package
 ```
 
 ```php
-// app/config/packages/payum/payum-laravel-package/config.php
+// bootstrap/start.php
 
-use Payum\LaravelPackage\Action\GetHttpRequestAction;
-use Payum\Core\Storage\FilesystemStorage;
-
-$detailsClass = 'Payum\Core\Model\ArrayObject';
-$tokenClass = 'Payum\Core\Model\Token';
-
-$omnipayDirectGatewayFactory = new \Payum\OmnipayBridge\OmnipayDirectGatewayFactory();
-
-return array(
-    'token_storage' => new FilesystemStorage(__DIR__.'/../../../../storage/payments', $tokenClass, 'hash'),
-    'gateways' => array(
-        'stripe_direct' => $omnipayDirectGatewayFactory->create(array(
+App::resolving('payum.builder', function(\Payum\Core\PayumBuilder $payumBuilder) {
+    $payumBuilder
+        ->addGateway('stripe_direct', [
+            'factory' => 'omnipay_direct',
             'type' => 'Stripe',
             'options' => array(
                 'apiKey' => 'EDIT ME',
                 'testMode' => true,
             ),
-            'payum.action.obtain_credit_card' => new ObtainCreditCardAction,
-        )),
-    ),
-    'storages' => array(
-        $detailsClass => new FilesystemStorage(__DIR__.'/../../../../storage/payments', $detailsClass),
-    )
-);
+         ])
+    ;
+});
 ```
 
 * Prepare payment
 
 ```php
 <?php
-// app/controllers/PaypalController.php
+// app/controllers/OmnipayController.php
+
+use Payum\LaravelPackage\Controller\PayumController;
 
-cclass StripeController extends BaseController
+cclass OmnipayController extends PayumController
 {
  	public function prepareDirect()
  	{
-         $storage = \App::make('payum')->getStorage('Payum\Core\Model\ArrayObject');
+         $storage = $this->getPayum()->getStorage('Payum\Core\Model\ArrayObject');
 
          $details = $storage->create();
          $details['amount'] = '10.00';
          $details['currency'] = 'USD';
          $storage->update($details);
 
-         $captureToken = \App::make('payum.security.token_factory')->createCaptureToken('stripe_direct', $details, 'payment_done');
+         $captureToken = $this->getPayum()->getTokenFactory()->createCaptureToken('stripe_direct', $details, 'payment_done');
 
          return \Redirect::to($captureToken->getTargetUrl());
  	}