Add method to get Pricelist

Release 0.3

Author: Vitexus

.gitignore

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

Examples/GetPriceList.php

@@ -0,0 +1,20 @@
+<?php
+/**
+ * Subreg - RegisterDomain Example
+ *
+ * @author     Vítězslav Dvořák <[email protected]>
+ * @copyright  (C) 2019 Spoje.Net
+ */
+
+namespace Subreg;
+
+require_once '../vendor/autoload.php';
+
+\Ease\Shared::instanced()->loadConfig('../config.json');
+
+$client = new Client(\Ease\Shared::instanced()->configuration);
+
+
+
+print_r($client->pricelist());
+

debian/changelog

@@ -1,5 +1,5 @@
-php-subreg (0.2-1) UNRELEASED; urgency=medium
+php-subreg (0.3) unstable; urgency=medium
 
-  * debianized
+  * new support for Pricelist command 
 
- -- Vítězslav Dvořák <[email protected]>  Mon, 04 Mar 2019 00:01:29 +0100
+ -- Vítězslav Dvořák <[email protected]>  Wed, 29 May 2019 16:21:24 +0200

debian/files

@@ -1,2 +1,2 @@
-php-subreg_0.2-1_all.buildinfo web optional
-php-subreg_0.2-1_all.deb web optional
+php-subreg_0.3_all.buildinfo web optional
+php-subreg_0.3_all.deb web optional

debian/fixversion.sh

@@ -3,7 +3,7 @@ VERSTR=`dpkg-parsechangelog --show-field Version`
 COMPOSER_VERSTR=`echo ${VERSTR}|sed 's/-/./g'`
 echo update debian/php-subreg/usr/share/php/Subreg/composer.json version to ${COMPOSER_VERSTR}
 sed -i -e '/\"version\"/c\    \"version\": \"'${COMPOSER_VERSTR}'",' debian/php-subreg/usr/share/php/Ease/composer.json
-echo Update debian/php-subreg/usr/share/php/Ease/Atom.php version to ${VERSTR}
-sed -i -e "/static public \$libVersion/c\    static public \$frameworkVersion = '${VERSTR}';" debian/php-subreg/usr/share/php/Subreg/Client.php
+echo Update debian/php-subreg/usr/share/php/Subreg/Client.php version to ${VERSTR}
+sed -i -e "/static public \$libVersion/c\    static public \$libVersion = '${VERSTR}';" debian/php-subreg/usr/share/php/Subreg/Client.php
 echo Update src/Ease/Atom.php version to ${VERSTR}
-sed -i -e "/static public \$libVersion/c\    static public \$frameworkVersion = '${VERSTR}';" src/Subreg/Client.php
+sed -i -e "/static public \$libVersion/c\    static public \$libVersion = '${VERSTR}';" src/Subreg/Client.php

nbproject/project.properties

@@ -1,12 +1,12 @@
-auxiliary.org-netbeans-modules-php-phpunit.bootstrap_2e_create_2e_tests=false
+auxiliary.org-netbeans-modules-php-phpunit.bootstrap_2e_create_2e_tests=true
 auxiliary.org-netbeans-modules-php-phpunit.bootstrap_2e_enabled=true
 auxiliary.org-netbeans-modules-php-phpunit.bootstrap_2e_path=tests/bootstrap.php
 auxiliary.org-netbeans-modules-php-phpunit.configuration_2e_enabled=true
-auxiliary.org-netbeans-modules-php-phpunit.configuration_2e_path=tests/configuration.xml
+auxiliary.org-netbeans-modules-php-phpunit.configuration_2e_path=phpunit.xml
 auxiliary.org-netbeans-modules-php-phpunit.customSuite_2e_enabled=false
 auxiliary.org-netbeans-modules-php-phpunit.customSuite_2e_path=
-auxiliary.org-netbeans-modules-php-phpunit.phpUnit_2e_enabled=false
-auxiliary.org-netbeans-modules-php-phpunit.phpUnit_2e_path=
+auxiliary.org-netbeans-modules-php-phpunit.phpUnit_2e_enabled=true
+auxiliary.org-netbeans-modules-php-phpunit.phpUnit_2e_path=vendor/bin/phpunit
 auxiliary.org-netbeans-modules-php-phpunit.test_2e_groups_2e_ask=false
 auxiliary.org-netbeans-modules-php-phpunit.test_2e_run_2e_all=false
 auxiliary.org-netbeans-modules-php-phpunit.test_2e_run_2e_phpunit_2e_only=false

phpunit.xml

@@ -2,7 +2,7 @@
 <phpunit colors="true" bootstrap="./testing/bootstrap.php">
     <testsuites>
         <testsuite name="all">
-            <directory>./testing</directory>
+            <directory>./tests</directory>
         </testsuite>
     </testsuites>
 

src/Subreg/Client.php

@@ -19,7 +19,7 @@ class Client extends \Ease\Molecule
      * ClientLibrary version
      * @var string 
      */
-    static public $frameworkVersion = '0.1';
+    static public $libVersion = '0.3';
 
     /**
      * Object Configuration
@@ -74,6 +74,20 @@ public function __construct($config)
         $this->login();
     }
 
+    /**
+     * Add Info about used user, server and libraries
+     *
+     * @param string $additions Additional note text
+     * 
+     * @return boolean was logged ?
+     */
+    public function logBanner($additions = null)
+    {
+        return $this->addStatusMessage('API '.str_replace('://',
+                '://'.$this->config['login'].'@', $this->config['uri']).' php-subreg v'.self::$libVersion.' EasePHP Framework v'.\Ease\Atom::$frameworkVersion.' '.$additions,
+            'debug');
+    }
+
     /**
      * API Call
      * 
@@ -92,19 +106,24 @@ public function call($command, $params = [])
         }
         $responseRaw = $this->soaper->__call($command, ['data' => $params]);
 
+
         if (isset($responseRaw['status'])) {
             $this->lastStatus = $responseRaw['status'];
-            if ($this->lastStatus == 'error') {
-                $this->logError($responseRaw['error']);
+            switch ($responseRaw['status']) {
+                case 'ok':
+                    if (array_key_exists('data', $responseRaw)) {
+                        $this->lastResult = $responseRaw['data'];
+                    } else {
+                        $this->lastResult = $this->lastStatus;
+                    }
+                    break;
+                case 'error':
+                    $this->logError($responseRaw['error']);
+                    $this->lastResult = ['error' => $responseRaw['error']];
+                    break;
             }
         }
 
-        if (array_key_exists('data', $responseRaw)) {
-            $this->lastResult = $responseRaw['data'];
-        } else {
-            $this->lastResult = $this->lastStatus;
-        }
-
         return $this->lastResult;
     }
 
@@ -222,4 +241,16 @@ public function domainsList()
     {
         return $this->call('Domains_List');
     }
+
+    /**
+     *  Get pricelist from your account
+     * 
+     * @link https://subreg.cz/manual/?cmd=Pricelist Command: Pricelist
+     * 
+     * @return array
+     */
+    public function pricelist()
+    {
+        return $this->call('Pricelist');
+    }
 }

tests/bootstrap.php

@@ -24,5 +24,5 @@
     define('EASE_LOGGER', 'syslog');
 }
 
-\Ease\Shared::instanced()->loadConfig('../config.json',true);
+\Ease\Shared::instanced()->loadConfig('config.json',true);
 

tests/configuration.xml

@@ -30,44 +30,107 @@ protected function tearDown(): void
 
     }
 
+    /**
+     * Test Constructor
+     *
+     * @depends testLogBanner
+     * @covers Subreg\Client::__construct
+     */
+    public function testConstructor()
+    {
+        $classname = get_class($this->object);
+        // Get mock, without the constructor being called
+        $mock      = $this->getMockBuilder($classname)
+            ->disableOriginalConstructor()
+            ->getMockForAbstractClass();
+        $mock->__construct(\Ease\Shared::instanced()->configuration);
+        $this->assertNotEmpty($mock->token);
+    }
+
+    /**
+     * @covers Subreg\Client::logBanner
+     */
+    public function testLogBanner()
+    {
+        $this->assertTrue($this->object->logBanner(addslashes(get_class($this))));
+    }
+
     /**
      * @covers Subreg\Client::call
      */
     public function testCall()
     {
-        $this->object->call('Get_Credit');
+        $fail    = $this->object->call('NonExist');
+        $this->assertEquals(['error' => [
+                'errormsg' => 'Invalid method called',
+                'errorcode' => [
+                    'major' => '500', 'minor' => '107']
+            ]
+            ], $fail);
+        $success = $this->object->call('Get_Credit');
+        $this->arrayHasKey(array_key_exists('credit', $success));
     }
 
     /**
      * @covers Subreg\Client::logError
      */
     public function testLogError()
     {
-        $this->object->logError(['errorcode' => ['major' => 999, 'minor' => 000],
-            'errormsg' => 'some error message']);
+        $error = ['errorcode' => ['major' => 999, 'minor' => 000],
+            'errormsg' => 'some error message'];
+        $this->object->logError($error);
+        $this->assertEquals($error, $this->object->lastError);
     }
 
     /**
      * @covers Subreg\Client::login
      */
     public function testLogin()
     {
-        $this->object->login();
+        $this->assertTrue($this->object->login());
     }
 
     /**
      * @covers Subreg\Client::checkDomain
      */
     public function testCheckDomain()
     {
-        return $this->object->checkDomain('spoje.net');
+        $checkResult = $this->object->checkDomain('spoje.net');
+        $this->assertTrue(array_key_exists('name', $checkResult) && array_key_exists('price',
+                $checkResult));
     }
 
     /**
-     * @covers Subreg\Client::domainList
+     * @covers Subreg\Client::domainsList
      */
     public function testDomainsList()
     {
-        return $this->object->domainsList();
+        $domainlist = $this->object->domainsList();
+        $this->assertTrue(array_key_exists('domains', $domainlist) && array_key_exists('count',
+                $domainlist));
+    }
+
+    /**
+     * @covers Subreg\Client::pricelist
+     */
+    public function testPricelist()
+    {
+        $pricelist = $this->object->pricelist();
+        $this->assertTrue(array_key_exists('cz', $pricelist));
+    }
+
+    /**
+     * @covers Subreg\Client::registerDomain
+     */
+    public function testRegisterDomain()
+    {
+        $unexistentDomain = strtolower(\Ease\Sand::randomString()).'.cz';
+
+        $nsHosts = array("ns.spoje.net", "ns2.spoje.net");
+
+        $result = $this->object->registerDomain($unexistentDomain, 'G-000001',
+            'G-000001', 'G-000001', 'ukulele', $nsHosts);
+
+        $this->assertTrue( array_key_exists('orderid', $result));
     }
 }