various changes

SonsOfPHP · Dec 8, 2023 · 277261e · 277261e
1 parent 19f8198
commit 277261e
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 9 deletions.
diff --git a/docs/contracts/gateway/index.md b/docs/contracts/gateway/index.md
@@ -29,11 +29,14 @@ Out of Scope
 ```php
 <?php
 
-$processor = new StripeProcessor(key: '...', secret: '...');
+$processor = new PaymentProcessor(key: '...', secret: '...');
 $gateway = new Gateway($processor);
 
-$transaction = $gateway->authorize(...);
-$transaction = $gateway->capture(...);
+$card = new CreditCard();
+$card->setNumber(...)->setCvv(...);
+
+$transaction = $gateway->authorize(['card' => $card]);
+$transaction = $gateway->capture(['card' => $card]);
 
 // Token Based processors
 $transaction = $gateway->purchase($token);

diff --git a/src/SonsOfPHP/Contract/Gateway/AuthorizableInterface.php b/src/SonsOfPHP/Contract/Gateway/AuthorizableInterface.php
@@ -9,7 +9,7 @@
  */
 interface AuthorizableInterface
 {
-    public function authorize($options): void;
+    public function authorize(array $options): void;
 
-    public function authorizeComplete($options): void;
+    public function authorizeComplete(array $options): void;
 }
diff --git a/...P/Contract/Gateway/ProcessorInterface.php → ...act/Gateway/PaymentProcessorInterface.php b/...P/Contract/Gateway/ProcessorInterface.php → ...act/Gateway/PaymentProcessorInterface.php
@@ -11,9 +11,18 @@
  * Processor Examples
  *   - Stripe
  *   - Authorize.net
+ *   - Dummy or Mock
+ *   - Round Robin
+ *   - Capped
  *
  * @author Joshua Estes <joshua@sonsofphp.com>
  */
-interface ProcessorInterface
+interface PaymentProcessorInterface
 {
+    /**
+     * MUST return the friendly name such as "Stripe"
+     *
+     * This MAY BE used as a display on the frontend
+     */
+    public function getName(): string;
 }
diff --git a/src/SonsOfPHP/Contract/Gateway/README.md b/src/SonsOfPHP/Contract/Gateway/README.md
@@ -1,7 +1,8 @@
 Sons of PHP - Gateway Contract
 ==============================
 
-
+The Gateway Contract is an abstract way to interact with payment gateways or
+processors. An example of this would be Stripe.
 
 ## Learn More
 

diff --git a/src/SonsOfPHP/Contract/Gateway/composer.json b/src/SonsOfPHP/Contract/Gateway/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "sonsofphp/gateway-contract",
     "type": "library",
-    "description": "",
+    "description": "Abstract Gateway Contract to allow payment processing",
     "keywords": [
         "abstractions",
         "contracts",
@@ -32,7 +32,9 @@
     "prefer-stable": true,
     "require": {
         "php": ">=8.1",
-        "psr/http-client": "^1.0"
+        "psr/http-client": "^1.0",
+        "psr/event-dispatcher": "^1.0",
+        "sonsofphp/money-contract": "^0.3.0@dev"
     },
     "extra": {
         "sort-packages": true,