Skip to content

Commit

Permalink
Merge pull request #6 from PAYONE-GmbH/refactor/improved-example-app
Browse files Browse the repository at this point in the history 
Refactor/improved example app
  • Loading branch information
@lrosenfeldt
lrosenfeldt authored Jul 31, 2024
2 parents e1d3712 + 0b9d84a commit e692d14
Show file tree
Hide file tree
Showing 21 changed files with 1,443 additions and 141 deletions.
989 changes: 980 additions & 9 deletions README.md
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion composer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
}
},
"scripts": {
"demo": "php ./examples/demo-app/index.php",
"demo": "php ./examples/demo-app/src/DemoApp.php",
"format-check": "php-cs-fixer check",
"format": "php-cs-fixer fix",
"lint": "phpstan analyze -l 9 src tests",
Expand Down
9 changes: 8 additions & 1 deletion examples/demo-app/composer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,12 @@
"type": "path",
"url": "../../"
}
]
],
"autoload": {
"psr-4": {
"DemoApp\\": [
"src/"
]
}
}
}
34 changes: 0 additions & 34 deletions examples/demo-app/index.php
View file

This file was deleted.

275 changes: 275 additions & 0 deletions examples/demo-app/src/DemoApp.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,275 @@
<?php

namespace DemoApp;

require_once __DIR__ . '/../vendor/autoload.php';

use PayoneCommercePlatform\Sdk\ApiClient\CheckoutApiClient;
use PayoneCommercePlatform\Sdk\ApiClient\CommerceCaseApiClient;
use PayoneCommercePlatform\Sdk\ApiClient\OrderManagementCheckoutActionsApiClient;
use PayoneCommercePlatform\Sdk\ApiClient\PaymentExecutionApiClient;
use PayoneCommercePlatform\Sdk\CommunicatorConfiguration;
use PayoneCommercePlatform\Sdk\Errors\ApiErrorResponseException;
use PayoneCommercePlatform\Sdk\Errors\ApiException;
use PayoneCommercePlatform\Sdk\Models\Address;
use PayoneCommercePlatform\Sdk\Models\AddressPersonal;
use PayoneCommercePlatform\Sdk\Models\AmountOfMoney;
use PayoneCommercePlatform\Sdk\Models\BankAccountInformation;
use PayoneCommercePlatform\Sdk\Models\CartItemInput;
use PayoneCommercePlatform\Sdk\Models\CartItemInvoiceData;
use PayoneCommercePlatform\Sdk\Models\CheckoutReferences;
use PayoneCommercePlatform\Sdk\Models\CommerceCaseResponse;
use PayoneCommercePlatform\Sdk\Models\ContactDetails;
use PayoneCommercePlatform\Sdk\Models\CreateCheckoutRequest;
use PayoneCommercePlatform\Sdk\Models\CreateCommerceCaseRequest;
use PayoneCommercePlatform\Sdk\Models\Customer;
use PayoneCommercePlatform\Sdk\Models\DeliverRequest;
use PayoneCommercePlatform\Sdk\Models\DeliverType;
use PayoneCommercePlatform\Sdk\Models\MandateRecurrenceType;
use PayoneCommercePlatform\Sdk\Models\OrderLineDetailsInput;
use PayoneCommercePlatform\Sdk\Models\OrderRequest;
use PayoneCommercePlatform\Sdk\Models\OrderType;
use PayoneCommercePlatform\Sdk\Models\PatchCheckoutRequest;
use PayoneCommercePlatform\Sdk\Models\PaymentChannel;
use PayoneCommercePlatform\Sdk\Models\PaymentMethodSpecificInput;
use PayoneCommercePlatform\Sdk\Models\PersonalInformation;
use PayoneCommercePlatform\Sdk\Models\PersonalName;
use PayoneCommercePlatform\Sdk\Models\ProcessingMandateInformation;
use PayoneCommercePlatform\Sdk\Models\ProductType;
use PayoneCommercePlatform\Sdk\Models\References;
use PayoneCommercePlatform\Sdk\Models\SepaDirectDebitPaymentMethodSpecificInput;
use PayoneCommercePlatform\Sdk\Models\SepaDirectDebitPaymentProduct771SpecificInput;
use PayoneCommercePlatform\Sdk\Models\Shipping;
use PayoneCommercePlatform\Sdk\Models\ShoppingCartInput;
use PayoneCommercePlatform\Sdk\Queries\GetCommerceCasesQuery;

class DemoApp
{
protected string $merchantId = '';
protected CommunicatorConfiguration $config;
protected CheckoutApiClient $checkoutClient;
protected CommerceCaseApiClient $commerceCaseClient;
protected OrderManagementCheckoutActionsApiClient $orderManagementCheckoutClient;
protected PaymentExecutionApiClient $paymentExecutionClient;

public function __construct()
{
$apiKey = getenv('API_KEY');
if (empty($apiKey)) {
throw new \RuntimeException('required environment variable API_KEY is not set');
}
$apiSecret = getenv('API_SECRET');
if (empty($apiSecret)) {
throw new \RuntimeException('required environment variable API_SECRET is not set');
}
$this->merchantId = getenv('MERCHANT_ID');
if (empty($this->merchantId)) {
throw new \RuntimeException('required environment variable MERCHANT_ID is not set');
}
$this->config = new CommunicatorConfiguration(
apiKey: $apiKey,
apiSecret: $apiSecret,
host: CommunicatorConfiguration::getPredefinedHosts()['preprod']['url'],
);
$this->checkoutClient = new CheckoutApiClient($this->config);
$this->commerceCaseClient = new CommerceCaseApiClient($this->config);
$this->paymentExecutionClient = new PaymentExecutionApiClient($this->config);
$this->orderManagementCheckoutClient = new OrderManagementCheckoutActionsApiClient($this->config);
}

protected function runMultistepCheckout(string $commercaseMerchantReference): void
{
// create the commercase
$commerceCase = $this->commerceCaseClient->createCommerceCase(
$this->merchantId,
new CreateCommerceCaseRequest(
customer: new Customer(
businessRelation: "B2C",
locale: "de",
personalInformation: new PersonalInformation(
dateOfBirth: "19840604",
name: new PersonalName(firstName: "Rich", surname: "Harris")
),
contactDetails: new ContactDetails(emailAddress: 'mail@mail.com'),
billingAddress: new Address(
countryCode: 'DE',
zip: '40474',
city: 'Düsseldorf',
street: 'Cecilienallee',
houseNumber: '2',
),
),
checkout: new CreateCheckoutRequest(
shoppingCart: new ShoppingCartInput(
items: [new CartItemInput(
invoiceData: new CartItemInvoiceData('Frankenstein - Mary Shelley - Hardcover'),
orderLineDetails: new OrderLineDetailsInput(
productCode: 'shelley-42',
productPrice: 1999,
quantity: 1,
productType: ProductType::GOODS,
taxAmount: 19,
),
)],
),
),
)
);
// add shipping information
$this->checkoutClient->updateCheckout(
$this->merchantId,
$commerceCase->getCommerceCaseId(),
$commerceCase->getCheckout()->getCheckoutId(),
new PatchCheckoutRequest(
shipping: new Shipping(
address: new AddressPersonal(
countryCode: 'DE',
zip: '40474',
city: 'Düsseldorf',
street: 'Cecilienallee',
houseNumber: '2',
)
)
),
);
// confirm the order
$this->orderManagementCheckoutClient->createOrder(
$this->merchantId,
$commerceCase->getCommerceCaseId(),
$commerceCase->getCheckout()->getCheckoutId(),
new OrderRequest(
orderType: OrderType::FULL,
orderReferences: new References(merchantReference: 'o-' . $commercaseMerchantReference),
paymentMethodSpecificInput: new PaymentMethodSpecificInput(
paymentChannel: PaymentChannel::ECOMMERCE,
sepaDirectDebitPaymentMethodSpecificInput: new SepaDirectDebitPaymentMethodSpecificInput(
paymentProductId: 771,
paymentProduct771SpecificInput: new SepaDirectDebitPaymentProduct771SpecificInput(
mandate: new ProcessingMandateInformation(
bankAccountIban: new BankAccountInformation(
iban: 'DE75512108001245126199',
accountHolder: 'Rich Harris',
),
dateOfSignature: '20240730',
recurrenceType: MandateRecurrenceType::UNIQUE,
uniqueMandateReference: 'm-' . $commercaseMerchantReference,
creditorId: 'DE98ZZZ09999999999',
),
),
),
),
),
);

$checkout = $this->checkoutClient->getCheckout($this->merchantId, $commerceCase->getCommerceCaseId(), $commerceCase->getCheckout()->getCheckoutId());
var_dump($checkout);

// items are ready for shipment, the delivery can be performed to capture the money from the reservation
$delivery = $this->orderManagementCheckoutClient->deliverOrder(
$this->merchantId,
$commerceCase->getCommerceCaseId(),
$commerceCase->getCheckout()->getCheckoutId(),
new DeliverRequest(deliverType: DeliverType::FULL, isFinal: true),
);
var_dump($delivery);
}

protected function runSingleStepCheckout(string $commerceCaseMerchantReference): void
{
// create commerce case, checkout and execute payment in one go
try {
$createCommerceCaseRequest = new CreateCommerceCaseRequest(
merchantReference: $commerceCaseMerchantReference,
customer: new Customer(
personalInformation: new PersonalInformation(
dateOfBirth: "19840604",
name: new PersonalName(firstName: "Rich", surname: "Harris")
),
contactDetails: new ContactDetails(emailAddress: 'mail@mail.com'),
billingAddress: new Address(
countryCode: 'DE',
zip: '40474',
city: 'Düsseldorf',
street: 'Cecilienallee',
houseNumber: '2',
),
),
checkout: new CreateCheckoutRequest(
autoExecuteOrder: true,
references: new CheckoutReferences(merchantReference: 'c-' . $commerceCaseMerchantReference),
amountOfMoney: new AmountOfMoney(amount: 5199, currencyCode: 'EUR'),
shipping: new Shipping(
address: new AddressPersonal(
countryCode: 'DE',
zip: '40474',
city: 'Düsseldorf',
street: 'Cecilienallee',
houseNumber: '2',
)
),
shoppingCart: new ShoppingCartInput(
items: [new CartItemInput(
invoiceData: new CartItemInvoiceData('Hoodie - Scaleshape Logo - L'),
orderLineDetails: new OrderLineDetailsInput(
productPrice: 5199,
quantity: 1,
productType: ProductType::GOODS,
),
)]
),
orderRequest: new OrderRequest(
orderReferences: new References(merchantReference: 'o-' . $commerceCaseMerchantReference),
orderType: OrderType::FULL,
paymentMethodSpecificInput: new PaymentMethodSpecificInput(
sepaDirectDebitPaymentMethodSpecificInput: new SepaDirectDebitPaymentMethodSpecificInput(
paymentProductId: 771,
paymentProduct771SpecificInput: new SepaDirectDebitPaymentProduct771SpecificInput(
mandate: new ProcessingMandateInformation(
bankAccountIban: new BankAccountInformation(
iban: 'DE75512108001245126199',
accountHolder: 'Rich Harris',
),
dateOfSignature: '20240730',
recurrenceType: MandateRecurrenceType::UNIQUE,
uniqueMandateReference: 'm-' . $commerceCaseMerchantReference,
creditorId: 'DE98ZZZ09999999999',
),
),
),
),
),
),
);
$response = $this->commerceCaseClient->createCommerceCase($this->merchantId, $createCommerceCaseRequest);
var_dump($response);
$response2 = $this->orderManagementCheckoutClient->deliverOrder(
$this->merchantId,
$response->getCommerceCaseId(),
$response->getCheckout()->getCheckoutId(),
new DeliverRequest(deliverType: DeliverType::FULL, isFinal: true),
);
var_dump($response2);
} catch (ApiErrorResponseException $e) {
fwrite(\STDERR, $e->getTraceAsString() . "\n");
fwrite(\STDERR, print_r($e->getErrors(), true));
exit(1);
}
}

public function runApp(): void
{
// see: https://docs.payone.com/pcp/checkout-flows/one-step-checkout
// not that the given reference must be unique and has to renewed after each run
$this->runSingleStepCheckout('comb1b3');
// see: https://docs.payone.com/pcp/checkout-flows/step-by-step-checkout
// not that the given reference must be unique and has to renewed after each run
$this->runMultistepCheckout('com1a3b');
}

public static function run(): void
{
$app = new DemoApp();
$app->runApp();
}
}
DemoApp::run();
Loading

0 comments on commit e692d14

Please sign in to comment.