[Pay] Contract and Component

docs/SUMMARY.md

@@ -52,6 +52,7 @@
   * [Queries](components/money/queries.md)
 * [Pager](components/pager/README.md)
   * [Adapters](components/pager/adapters.md)
+* [Pay](components/pay.md)
 * [Registry](components/registry.md)
 * [State Machine](components/state-machine.md)
 * [Version](components/version.md)
@@ -65,6 +66,7 @@
 * [Filesystem](contracts/filesystem.md)
 * [Mailer](contracts/mailer.md)
 * [Pager](contracts/pager.md)
+* [Pay](contracts/pay.md)
 * [Registry](contracts/registry.md)
 * [State Machine](contracts/state-machine.md)
 

docs/components/pay.md

@@ -0,0 +1,11 @@
+---
+title: Pay
+---
+
+Pay is a multi-gateway payment processing library.
+
+## Installation
+
+```shell
+composer require sonsofphp/pay
+```

docs/contracts/pay.md

@@ -0,0 +1,9 @@
+---
+title: Pay Contract
+---
+
+## Installation
+
+```shell
+composer require sonsofphp/pay-contract
+```

src/SonsOfPHP/Contract/Pay/.gitattributes

@@ -0,0 +1,2 @@
+/.gitattributes export-ignore
+/.gitignore export-ignore

src/SonsOfPHP/Contract/Pay/.gitignore

@@ -0,0 +1,2 @@
+composer.lock
+vendor/

src/SonsOfPHP/Contract/Pay/Command/CommandInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Contract\Pay\Command;
+
+/**
+ * Commands tell a gateway to do something.
+ *
+ * @author Joshua Estes <[email protected]>
+ */
+interface CommandInterface {}

src/SonsOfPHP/Contract/Pay/Exception/PayExceptionInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Contract\Pay\Exception;
+
+/**
+ * @author Joshua Estes <[email protected]>
+ */
+interface PayExceptionInterface {}

src/SonsOfPHP/Contract/Pay/Factory/FactoryInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Contract\Pay\Factory;
+
+/**
+ * @author Joshua Estes <[email protected]>
+ */
+interface FactoryInterface {}

src/SonsOfPHP/Contract/Pay/Gateway/GatewayInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Contract\Pay\Gateway;
+
+/**
+ * @author Joshua Estes <[email protected]>
+ */
+interface GatewayInterface
+{
+    public function command(CommandInterface $command): void;
+
+    public function query(QueryInterface $command): mixed;
+}

src/SonsOfPHP/Contract/Pay/LICENSE

@@ -0,0 +1,19 @@
+Copyright 2022 to Present Joshua Estes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

src/SonsOfPHP/Contract/Pay/Marshaller/MarshallerInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Contract\Pay\Marshaller;
+
+/**
+ * @author Joshua Estes <[email protected]>
+ */
+interface MarshallerInterface
+{
+    public function marshall(mixed $value): string;
+
+    public function unmarshall(string $value): mixed;
+}

src/SonsOfPHP/Contract/Pay/Model/AddressInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Contract\Pay\Model;
+
+/**
+ * This is generally the billing address but could be any type of address.
+ *
+ * @author Joshua Estes <[email protected]>
+ */
+interface AddressInterface {}

src/SonsOfPHP/Contract/Pay/Model/BankAccountInterface.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Contract\Pay\Model;
+
+/**
+ * Represents a bank account
+ *
+ * @author Joshua Estes <[email protected]>
+ */
+interface BankAccountInterface
+{
+    public function getAccountNumber(): string;
+
+    public function setAccountNumber(string $accountNumber): void;
+
+    public function getRoutingNumber(): string;
+
+    public function setRoutingNumber(string $routingNumber): void;
+}

src/SonsOfPHP/Contract/Pay/Model/CreditCardInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Contract\Pay\Model;
+
+/**
+ * Represents a credit card
+ *
+ * @author Joshua Estes <[email protected]>
+ */
+interface CreditCardInterface {}

src/SonsOfPHP/Contract/Pay/Model/GatewayConfigurationInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Contract\Pay\Model;
+
+/**
+ * @author Joshua Estes <[email protected]>
+ */
+interface GatwwayConfigurationInterface
+{
+    public function getConfig(): array;
+
+    public function setConfig(array $config): void;
+}

src/SonsOfPHP/Contract/Pay/Model/IdentifierInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Contract\Pay\Model;
+
+/**
+ * Used as a unique identifier
+ *
+ * @author Joshua Estes <[email protected]>
+ */
+interface IdentifierInterface {}

src/SonsOfPHP/Contract/Pay/Model/TokenInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Contract\Pay\Model;
+
+/**
+ * A token is used for various things. It could be used as a payment token or
+ * authorization token
+ *
+ * @author Joshua Estes <[email protected]>
+ */
+interface TokenInterface {}

src/SonsOfPHP/Contract/Pay/PayInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Contract\Pay;
+
+/**
+ * @author Joshua Estes <[email protected]>
+ */
+interface PayInterface
+{
+    public function authorize($command): void;
+
+    public function capture($command): void;
+
+    public function void($command): void;
+
+    public function refund($command): void;
+}

src/SonsOfPHP/Contract/Pay/Query/QueryInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Contract\Pay\Query;
+
+/**
+ * Queries return information from a gateway
+ *
+ * @author Joshua Estes <[email protected]>
+ */
+interface QueryInterface {}

src/SonsOfPHP/Contract/Pay/README.md

@@ -0,0 +1,18 @@
+Sons of PHP - Pay Contract
+==========================
+
+Multi-Gateway Payment Processor
+
+## Learn More
+
+* [Documentation][docs]
+* [Contributing][contributing]
+* [Report Issues][issues] and [Submit Pull Requests][pull-requests] in the [Mother Repository][mother-repo]
+* Get Help & Support using [Discussions][discussions]
+
+[discussions]: https://github.com/orgs/SonsOfPHP/discussions
+[mother-repo]: https://github.com/SonsOfPHP/sonsofphp
+[contributing]: https://docs.sonsofphp.com/contributing/
+[docs]: https://docs.sonsofphp.com/contracts/pay/
+[issues]: https://github.com/SonsOfPHP/sonsofphp/issues?q=is%3Aopen+is%3Aissue+label%3APay
+[pull-requests]: https://github.com/SonsOfPHP/sonsofphp/pulls?q=is%3Aopen+is%3Apr+label%3APay

src/SonsOfPHP/Contract/Pay/Registry/RegistryInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Contract\Pay\Registry;
+
+/**
+ * @author Joshua Estes <[email protected]>
+ */
+interface RegistryInterface {}

src/SonsOfPHP/Contract/Pay/Storage/StorageInterface.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Contract\Pay\Storage;
+
+/**
+ * Storage is where all the models are stored. This could be the filesystem or
+ * database.
+ *
+ * @template T of object
+ *
+ * @author Joshua Estes <[email protected]>
+ */
+interface StorageInterface
+{
+    /**
+     * @param T $model
+     */
+    public function save(object $model): void;
+
+    /**
+     * @param T $model
+     */
+    public function remove(object $model): void;
+
+    /**
+     * @param IndentifierInterface|string|int $id
+     *
+     * @return T
+     */
+    public function find($id): ?object;
+}

src/SonsOfPHP/Contract/Pay/composer.json

@@ -0,0 +1,53 @@
+{
+    "name": "sonsofphp/pay-contract",
+    "type": "library",
+    "description": "",
+    "keywords": [
+        "abstractions",
+        "contracts",
+        "decoupling",
+        "interfaces",
+        "interoperability",
+        "standards",
+        "payment-gateway"
+    ],
+    "homepage": "https://github.com/SonsOfPHP/pay-contract",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Joshua Estes",
+            "email": "[email protected]"
+        }
+    ],
+    "support": {
+        "issues": "https://github.com/SonsOfPHP/sonsofphp/issues",
+        "forum": "https://github.com/orgs/SonsOfPHP/discussions",
+        "docs": "https://docs.sonsofphp.com"
+    },
+    "autoload": {
+        "psr-4": {
+            "SonsOfPHP\\Contract\\Pay\\": ""
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "require": {
+        "php": ">=8.2"
+    },
+    "extra": {
+        "sort-packages": true,
+        "branch-alias": {
+            "dev-main": "0.3.x-dev"
+        }
+    },
+    "funding": [
+        {
+            "type": "github",
+            "url": "https://github.com/sponsors/JoshuaEstes"
+        },
+        {
+            "type": "tidelift",
+            "url": "https://tidelift.com/subscription/pkg/packagist-sonsofphp-sonsofphp"
+        }
+    ]
+}