Merge pull request #381 from SUMO-Kwiatkowski/SP-X

Updating dependencies and tests, adding generated config files t…

Author: bobbrodie

.gitignore

@@ -12,4 +12,8 @@ composer.phar
 .phpunit.result.cache
 test/unit/_html
 
-PrivateKey.key
+PrivateKey.key
+BitPay.config.json
+**/BitPay.config.json
+BitPay.config.yml
+**/BitPay.config.yml

composer.json

@@ -16,10 +16,10 @@
     "ext-json": "*",
     "ext-reflection": "*",
     "bitpay/key-utils": "^2.1",
-    "guzzlehttp/guzzle": "^7.0",
-    "symfony/yaml": "^5.0 || ^6.0 || ^7.0",
+    "guzzlehttp/guzzle": "^7.9",
+    "symfony/yaml": "^5.4 || ^6.4 || ^7.0",
     "netresearch/jsonmapper": "^5.0",
-    "symfony/console": "^4.4 || ^5.4 || ^6.0"
+    "symfony/console": "^4.4 || ^5.4 || ^6.4"
   },
   "authors": [
     {
@@ -28,7 +28,8 @@
     }
   ],
   "require-dev": {
-    "phpunit/phpunit": "^10.5 || ^11.5 || ^12.0"
+    "phpunit/phpunit": "^10.5 || ^11.5 || ^12.0",
+    "squizlabs/php_codesniffer": "^3.13"
   },
   "scripts": {
     "setup": [
@@ -47,4 +48,4 @@
       "BitPaySDK\\Functional\\": "test/functional/BitPaySDK"
     }
   }
-}
+}

composer.lock

@@ -2,4 +2,8 @@
 <ruleset name="BitPayStandard">
     <description>BitPay coding standard, based on PSR-12, temporarily excluding some rules.</description>
     <rule ref="PSR12"/>
+    <exclude-pattern>*/vendor/*</exclude-pattern>
+    <exclude-pattern>*/node_modules/*</exclude-pattern>
+    <exclude-pattern>*.css</exclude-pattern>
+    <exclude-pattern>*.js</exclude-pattern>
 </ruleset>

ruleset.xml

@@ -12,13 +12,36 @@ abstract class AbstractClientTestCase extends TestCase
 {
     protected Client $client;
 
+    // Default delay in seconds between API calls
+    private const API_CALL_DELAY = 0.5;
+    private static $lastApiCallTime = 0;
+
     /**
      * @throws BitPayGenericException
      */
     public function setUp(): void
     {
+        // Add delay to respect rate limits
+        $this->respectRateLimit();
+
         $this->client = Client::createWithFile(
             Config::FUNCTIONAL_TEST_PATH . DIRECTORY_SEPARATOR . Config::BITPAY_CONFIG_FILE
         );
     }
+
+    /**
+     * Delays execution if needed to respect rate limits
+     */
+    protected function respectRateLimit(): void
+    {
+        $currentTime = microtime(true);
+        $timeSinceLastCall = $currentTime - self::$lastApiCallTime;
+
+        if (self::$lastApiCallTime > 0 && $timeSinceLastCall < self::API_CALL_DELAY) {
+            $sleepTime = (self::API_CALL_DELAY - $timeSinceLastCall);
+            usleep((int)($sleepTime * 1000000)); // Convert to microseconds
+        }
+
+        self::$lastApiCallTime = microtime(true);
+    }
 }

test/functional/BitPaySDK/AbstractClientTestCase.php

@@ -34,6 +34,17 @@ public function testGetSettlement(): void
 
         $settlements = $this->client->getSettlements($currency, $dateStart, $dateEnd, $status);
 
+        // Skip test if no settlements exist
+        if (empty($settlements)) {
+            error_log(PHP_EOL . 'No settlements found in test account. ' .
+                'Skipping test. To test this functionality, ensure your test account has processed transactions.');
+            $this->markTestSkipped(
+                'No settlements found in test account. ' .
+                    'To test this functionality, ensure your test account has processed transactions.'
+            );
+            return;
+        }
+
         $settlement = $this->client->getSettlement($settlements[0]->getId());
 
         self::assertNotNull($settlement);
@@ -50,12 +61,25 @@ public function testGetReconciliationReport(): void
         $currency = 'USD';
 
         $settlements = $this->client->getSettlements($currency, $dateStart, $dateEnd, $status);
+
+        if (empty($settlements)) {
+            error_log( PHP_EOL . 'No settlements found in test account. ' .
+                'Skipping test. To test this functionality, ensure your test account has processed transactions.
+            ');
+            $this->markTestSkipped(
+                'No settlements found in test account. ' .
+                    'To test this functionality, ensure your test account has processed transactions.'
+            );
+            return;
+        }
+
         $settlement = $this->client->getSettlement($settlements[0]->getId());
-        $settlement = $this->client->getSettlementReconciliationReport($settlement);
+        $settlementId = $settlement->getId();
+        $token = $settlement->getToken();
+        $reconciliationReport = $this->client->getSettlementReconciliationReport($settlementId, $token);
 
-        self::assertEquals('processing', $settlement->getStatus());
-        self::assertNotNull($settlement);
-        self::assertEquals('USD', $settlement->getCurrency());
-        self::assertEquals($status, $settlement->getStatus());
+        self::assertNotNull($reconciliationReport);
+        self::assertEquals($currency, $reconciliationReport->getCurrency());
+        self::assertEquals($status, $reconciliationReport->getStatus());
     }
 }