creditCorrection and infoUser functions added

Author: Vitexus

.gitignore

@@ -6,4 +6,6 @@
 /debian/php-subreg.substvars
 /debian/debhelper-build-stamp
 /tests/.phpunit.result.cache
-/.phpunit.result.cache
+/.phpunit.result.cache
+/.phpunit.cache/
+/nbproject/

debian/changelog

@@ -1,3 +1,9 @@
+php-spojenet-subreg (1.1.0) UNRELEASED; urgency=medium
+
+  * creditCorrection and infoUser functions added
+
+ -- vitex <info@vitexsoftware.cz>  Thu, 25 Jan 2024 20:24:48 +0100
+
 php-spojenet-subreg (1.0) unstable; urgency=medium
 
   * new support for Pricelist command 

phpunit.xml

@@ -1,15 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit colors="true" bootstrap="./testing/bootstrap.php">
-    <testsuites>
-        <testsuite name="all">
-            <directory>./tests</directory>
-        </testsuite>
-    </testsuites>
-
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src/Subreg</directory>
-        </whitelist>
-    </filter>
-
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" bootstrap="./tests/bootstrap.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" cacheDirectory=".phpunit.cache">
+  <coverage/>
+  <testsuites>
+    <testsuite name="all">
+      <directory>./tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory suffix=".php">src/Subreg</directory>
+    </include>
+  </source>
 </phpunit>

src/Subreg/Client.php

@@ -4,7 +4,7 @@
  * Subreg - Usage Example
  *
  * @author     Vítězslav Dvořák <info@vitexsoftware.cz>
- * @copyright  (C) 2018,2023 Spoje.Net
+ * @copyright  (C) 2018,2023-2024 Spoje.Net
  */
 
 namespace Subreg;
@@ -44,7 +44,7 @@ class Client extends \Ease\Molecule
 
     /**
      * Last call status code
-     * @var string|null ok|error
+     * @var array|string|null ok|error
      */
     public $lastStatus = null;
 
@@ -83,7 +83,7 @@ public function __construct($config)
      *
      * @param string $additions Additional note text
      *
-     * @return boolean was logged ?
+     * @return bool was logged ?
      */
     public function logBanner($additions = null)
     {
@@ -152,7 +152,7 @@ public function logError($errorData)
     /**
      * Perform Login to Server
      *
-     * @return boolean success
+     * @return bool success
      */
     public function login()
     {
@@ -298,4 +298,36 @@ public function renewDomain(string $domain, int $years = 1)
     {
         return $this->call('Make_Order', ['order' => ['domain' => $domain, 'params' => ['period' => $years], 'type' => 'Renew_Domain']]);
     }
+
+    /**
+     * Credit_Correction
+     *
+     * Correct credit amount of your sub-users. The amount you specify in this
+     * command will be added to current amount. Use negative values for
+     * subtracting credit. Please note that currency will depend on current
+     * user setting.
+     *
+     * @see https://subreg.cz/manual/?cmd=Credit_Correction
+     *
+     * @param string $username  Credit Holder Username
+     * @param int    $amount    10 or -2
+     * @param string $reason    For example "Invoice settle"
+     */
+    public function creditCorrection($username, $amount, $reason)
+    {
+        return $this->call(
+            'Credit_Correction',
+            ['username' => $username, 'amount' => strval($amount), 'reason' => $reason]
+        );
+    }
+
+    /**
+     * Retrieve single sub-user
+     *
+     * @param int $id ID of the user
+     */
+    public function infoUser(int $id)
+    {
+        return $this->call('Info_User', ['id' => $id]);
+    }
 }

tests/src/Subreg/ClientTest.php

@@ -7,6 +7,7 @@
  */
 class ClientTest extends \Test\Ease\MoleculeTest
 {
+
     /**
      * @var Client
      */
@@ -19,6 +20,7 @@ class ClientTest extends \Test\Ease\MoleculeTest
     protected function setUp(): void
     {
         $this->object = new \Subreg\Client(\Ease\Shared::instanced()->configuration);
+        $this->object->login();
     }
 
     /**
@@ -40,11 +42,12 @@ public function testConstructor()
     {
         $classname = get_class($this->object);
         // Get mock, without the constructor being called
-        $mock      = $this->getMockBuilder($classname)
-            ->disableOriginalConstructor()
-            ->getMockForAbstractClass();
+        $mock = $this->getMockBuilder($classname)
+                ->disableOriginalConstructor()
+                ->getMockForAbstractClass();
         $mock->__construct(\Ease\Shared::instanced()->configuration);
-        $this->assertNotEmpty($mock->token);
+        $this->assertArrayHasKey('login', $this->object->config);
+        $this->assertInstanceOf('\SoapClient', $this->object->soaper);
     }
 
     /**
@@ -60,13 +63,15 @@ public function testLogBanner()
      */
     public function testCall()
     {
-        $fail    = $this->object->call('NonExist');
+        $fail = $this->object->call('NonExist');
         $this->assertEquals(['error' => [
                 'errormsg' => 'Invalid method called',
                 'errorcode' => [
-                    'major' => '500', 'minor' => '107']
+                    'major' => '500',
+                    'minor' => '107'
+                ]
             ]
-            ], $fail);
+                ], $fail);
         $success = $this->object->call('Get_Credit');
         $this->arrayHasKey(array_key_exists('credit', $success));
     }
@@ -88,16 +93,15 @@ public function testLogError()
     public function testLogin()
     {
         $this->assertTrue($this->object->login());
+        $this->assertNotEmpty($this->object->token);
     }
 
     /**
      * @covers Subreg\Client::checkDomain
      */
     public function testCheckDomain()
     {
-        $checkResult = $this->object->checkDomain('spoje.net');
-        $this->assertTrue(array_key_exists('name', $checkResult) && array_key_exists('price',
-                $checkResult));
+        $this->assertIsArray($this->object->checkDomain('php-subreg.cz'));
     }
 
     /**
@@ -107,7 +111,7 @@ public function testDomainsList()
     {
         $domainlist = $this->object->domainsList();
         $this->assertTrue(array_key_exists('domains', $domainlist) && array_key_exists('count',
-                $domainlist));
+                        $domainlist));
     }
 
     /**
@@ -124,21 +128,21 @@ public function testPricelist()
      */
     public function testGetPricelist()
     {
-        $pricelist = $this->object->getPricelist('???');
-        $this->assertTrue(array_key_exists('cz', $pricelist));
+        $pricelist = $this->object->getPricelist('MYPRICELIST');
+        $this->assertTrue(array_key_exists('error', $pricelist));
     }
 
     /**
      * @covers Subreg\Client::registerDomain
      */
     public function testRegisterDomain()
     {
-        $unexistentDomain = strtolower(\Ease\Sand::randomString()).'.cz';
+        $unexistentDomain = strtolower(\Ease\Functions::randomString()) . '.cz';
 
         $nsHosts = array("ns.spoje.net", "ns2.spoje.net");
 
         $result = $this->object->registerDomain($unexistentDomain, 'G-000001',
-            'G-000001', 'G-000001', 'ukulele', $nsHosts);
+                'G-000001', 'G-000001', 'ukulele', $nsHosts);
 
         $this->assertTrue(array_key_exists('orderid', $result));
     }
@@ -148,6 +152,23 @@ public function testRegisterDomain()
      */
     public function testRenewDomain()
     {
-        $this->assertArrayHasKey('orderid',$this->object->renewDomain('vitexsoftware.cz',1));
+        $this->assertIsArray($this->object->renewDomain('php-subreg.cz', 1));
+    }
+
+    /**
+     * @covers Subreg\Client::creditCorrection
+     */
+    public function testcreditCorrection()
+    {
+        $this->assertIsArray($this->object->creditCorrection('php-subreg', '+1', 'PHPUnit Test'));
+    }
+
+    /**
+     * @covers Subreg\Client::infoUser
+     */
+    public function testinfoUser()
+    {
+        $userInfo = $this->object->infoUser(1); // Not Exists
+        $this->assertTrue(array_key_exists('error', $userInfo));
     }
 }