added custom-port option via configuration-file

Author: nickurt

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-plesk-xml` will be documented in this file
 
+## 0.5.1 - 2019-09-09
+
+- Added support for custom port via configuration-file
+
 ## 0.5.0 - 2019-09-04
 
 - Added support for Laravel 6

composer.json

@@ -10,7 +10,7 @@
         "spatie/array-to-xml": "^2.7"
     },
     "require-dev": {
-        "phpunit/phpunit": "^7.5|^8.0"
+        "orchestra/testbench": "^3.8|^4.0"
     },
     "autoload": {
         "psr-4": {
@@ -20,6 +20,11 @@
             "src/helpers.php"
         ]
     },
+    "autoload-dev": {
+        "psr-4": {
+            "nickurt\\PleskXml\\tests\\": "tests"
+        }
+    },
     "scripts": {
         "test": "vendor/bin/phpunit",
         "test-coverage": "vendor/bin/phpunit --coverage-html coverage"

src/Api/AbstractApi.php

@@ -31,7 +31,7 @@ protected function post($parameters)
         $parameters = ArrayToXml::convert($parameters, [
             'rootElementName' => 'packet',
             '_attributes' => [
-                'version' => $this->client->getHttpClient()->getOptions()['api_version'],
+                'version' => $this->client->getHttpClient()->getOptions()['version'],
             ],
         ]);
 
@@ -41,4 +41,4 @@ protected function post($parameters)
 
         return $response;
     }
-}
+}

src/Client.php

@@ -15,8 +15,8 @@ class Client implements ClientInterface
      * @var array
      */
     private $options = [
-        'api_port' => '8443',
-        'api_version' => '1.6.9.1',
+        'port' => '8443',
+        'version' => '1.6.9.1',
     ];
 
     /**
@@ -106,12 +106,22 @@ public function getHttpClient()
     }
 
     /**
-     * @param $host
+     * @param string $host
      */
     public function setHost($host)
     {
         $this->getHttpClient()->setOptions([
-            'base_url' => sprintf('https://%s:8443/enterprise/control/agent.php', $host)
+            'host' => $host
         ]);
     }
-}
+
+    /**
+     * @param int $port
+     */
+    public function setPort($port)
+    {
+        $this->getHttpClient()->setOptions([
+            'port' => $port
+        ]);
+    }
+}

src/HttpClient/HttpClient.php

@@ -47,7 +47,7 @@ public function request($body, $method)
     {
         $response = $this->client->request(
             $method,
-            $this->getOptions()['base_url'],
+            sprintf('https://%s:%s%s', $this->getOptions()['host'], $this->getOptions()['port'], '/enterprise/control/agent.php'),
             [
                 'headers' => $this->getHeaders(),
                 'body' => $body
@@ -88,4 +88,4 @@ public function setHeaders(array $headers)
     {
         $this->headers = array_merge($this->headers, $headers);
     }
-}
+}

src/Plesk.php

@@ -76,6 +76,7 @@ protected function resolve($name)
 
         $this->client = new \nickurt\PleskXml\Client();
         $this->client->setHost($config['host']);
+        $this->client->setPort($config['port'] ?? 8443);
         $this->client->setCredentials(
             $config['username'],
             $config['password']

tests/ExampleTest.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace nickurt\PleskXml\tests;
+
+use nickurt\PleskXml\Facade as Plesk;
+
+class PleskXmlTest extends TestCase
+{
+    /** @test */
+    public function it_can_use_a_custom_plesk_server()
+    {
+        config(['plesk-xml.default' => 'custom']);
+
+        $plesk = Plesk::getHttpClient();
+
+        $this->assertSame('https://xml-plesk-xml.tld:8444/enterprise/control/agent.php', sprintf(
+            'https://%s:%s%s', $plesk->getOptions()['host'], $plesk->getOptions()['port'], '/enterprise/control/agent.php'
+        ));
+
+        $this->assertSame('xml-plesk-xml.tld', $plesk->getOptions()['host']);
+        $this->assertSame(8444, $plesk->getOptions()['port']);
+
+        $this->assertSame('xml-plesk-xml', $plesk->getHeaders()['HTTP_AUTH_LOGIN']);
+        $this->assertSame('plesk-xml-plesk', $plesk->getHeaders()['HTTP_AUTH_PASSWD']);
+    }
+
+    /** @test */
+    public function it_can_use_the_default_plesk_server()
+    {
+        $plesk = Plesk::getHttpClient();
+
+        $this->assertSame('https://plesk-xml.tld:8443/enterprise/control/agent.php', sprintf(
+            'https://%s:%s%s', $plesk->getOptions()['host'], $plesk->getOptions()['port'], '/enterprise/control/agent.php'
+        ));
+
+        $this->assertSame('plesk-xml.tld', $plesk->getOptions()['host']);
+        $this->assertSame(8443, $plesk->getOptions()['port']);
+
+        $this->assertSame('plesk-xml', $plesk->getHeaders()['HTTP_AUTH_LOGIN']);
+        $this->assertSame('xml-plesk', $plesk->getHeaders()['HTTP_AUTH_PASSWD']);
+    }
+}

tests/PleskXmlTest.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace nickurt\PleskXml\Tests;
+
+use Orchestra\Testbench\TestCase as Orchestra;
+
+class TestCase extends Orchestra
+{
+    /**
+     * Define environment setup.
+     *
+     * @param \Illuminate\Foundation\Application $app
+     *
+     * @return void
+     */
+    protected function getEnvironmentSetUp($app)
+    {
+        config()->set('plesk-xml', [
+            'default' => 'default',
+            'servers' => [
+                'default' => [
+                    'host' => 'plesk-xml.tld',
+                    'username' => 'plesk-xml',
+                    'password' => 'xml-plesk',
+                ],
+                'custom' => [
+                    'host' => 'xml-plesk-xml.tld',
+                    'port' => 8444,
+                    'username' => 'xml-plesk-xml',
+                    'password' => 'plesk-xml-plesk',
+                ]
+            ],
+        ]);
+    }
+
+    /**
+     * @param \Illuminate\Foundation\Application $app
+     * @return array
+     */
+    protected function getPackageAliases($app)
+    {
+        return [
+            'PleskXml' => \nickurt\PleskXml\Facade::class
+        ];
+    }
+
+    /**
+     * @param \Illuminate\Foundation\Application $app
+     * @return array
+     */
+    protected function getPackageProviders($app)
+    {
+        return [
+            \nickurt\PleskXml\ServiceProvider::class
+        ];
+    }
+}