granam/gpwebpay-flat

Parser of GP WepPay report in FLAT format

1.2.0 2021-03-25 10:11 UTC

Requires

• php: >=7.3
• granam/imap-download: ^1.2
• granam/strict-object: ^3.0

Requires (Dev)

• granam/exceptions-hierarchy: ~5.0
• granam/test-with-mockery: ^2.0
• mockery/mockery: ~1.0
• phpunit/phpunit: ~9.0
• roave/security-advisories: dev-latest

Suggests

• ext-imap: Needed to fetch FLAT file directly from an email via IMAP protocol

MIT

• Jaroslav Týc

• parser
• pay
• report
• flat
• webpay
• gp
• gp webpay

README

Security first

NEVER download this library from an unknown source. Use ONLY packagist.org (therefore composer), or github.com/jaroslavtyc/granam-gpwebpay-flat.

You are going to work with financial data, which are ALWAYS sensitive. Think twice if a public library to process them is OK for your company inner politic.

This library is released under MIT licence, which means any harm caused to you by using it is your fight. But I will do my best to protect you from any data leakage or corruption.

Step-by-step

• send a request to [e-mail] to get daily reports of transactions in FLAT format to an email of your choice
• add this library to your project composer require granam/gpwebpay-flat
• let it to parse FLAT report from an email (or from a file, or from a string content... it's up to you)
  • note: PHP IMAP extension is needed to fetch email

<?php
namespace Coolest\Fan;

use Granam\GpWebPay\Flat\FlatReportParser;
use Granam\Mail\Download\ImapEmailAttachmentFetcher;
use Granam\GpWebPay\Flat\CzechECommerceTransactionHeaderMapper;
use Granam\Mail\Download\ImapReadOnlyConnection;

$flatReportParser = new FlatReportParser();
$imapConnection = new ImapReadOnlyConnection('[e-mail]', 'Раѕѕword123', 'imap.example.com' );
$flatContentFromCzechEmail = $flatReportParser->createFlatContentFromCzechEmailAttachment(
    new ImapEmailAttachmentFetcher($imapConnection),
    $yesterday = new \DateTime('yesterday'), // search for FLAT file with yesterday report, but sent today
    new CzechECommerceTransactionHeaderMapper()
);
if($flatContentFromCzechEmail === null) {
    die('No email with FLAT file has been found for yesterday');
}
$eCommerceTransactions = $flatContentFromCzechEmail->getECommerceTransactions($yesterday /* have to filter them because more days can be covered by a single report */);
echo 'We got confirmed '.$eCommerceTransactions->count().' of yesterday purchases via GpWebPay gateway!';

• verify that you have not missed a payment from a customer (what a shame!)

<?php
// ...
/** @var \Granam\GpWebPay\Flat\Sections\ECommerceTransactions $eCommerceTransactions */
$expectedIncome = require __DIR__ . '/expected_income_from_yesterday.php';
if ($expectedIncome !== $eCommerceTransactions->getPaidAmountWithoutFeesSummary()) {
    throw new \RuntimeException(
        "We have missing (or redundant) GpWebPay payments! Expected {$expectedIncome}, got ". $eCommerceTransactions->getPaidAmountWithoutFeesSummary()
    );
}

echo 'Our customers spent on yesterday '.$eCommerceTransactions->getPaidAmountWithoutFeesSummary().'.-, we paid '
.$eCommerceTransactions->getFeesInMerchantCurrencySummary().' to GpWebPay as fee'
.' and we got '.$eCommerceTransactions->getPaidAmountWithoutFeesSummary();

• be happy! (or at least less sad)