ConnectionConfiguration - add $verifySslCertificate property - if is set to true, the SSL certificate verification is turned on, otherwise - turned off

It's useful while running application with custom, non-official SSL certificate, e.g. while development process.

.gitignore

@@ -11,6 +11,7 @@
 # ----------------------------------------------------------------------------------------------------------------------
 ### Composer
 # ----------------------------------------------------------------------------------------------------------------------
+/composer.lock
 /composer.phar
 
 # ----------------------------------------------------------------------------------------------------------------------

composer.json

@@ -3,7 +3,7 @@
     "description": "Client of LimeSurvey API",
     "type": "library",
     "license": "MIT",
-    "version": "0.0.3",
+    "version": "0.0.6",
     "authors": [
         {
             "name": "Meritoo",

src/Meritoo/LimeSurvey/ApiClient/Configuration/ConnectionConfiguration.php

@@ -59,15 +59,26 @@ class ConnectionConfiguration
      */
     private $debugMode = false;
 
+    /**
+     * If is set to true, the SSL certificate verification is turned on. Otherwise - turned off.
+     * It's useful while running application with custom, non-official SSL certificate, e.g. while development process.
+     *
+     * @var bool
+     */
+    private $verifySslCertificate = true;
+
     /**
      * Class constructor
      *
-     * @param string $baseUrl   Base url. Protocol & domain.
-     * @param string $username  Name of user used to authenticate to LimeSurvey
-     * @param string $password  Password used to authenticate to LimeSurvey
-     * @param bool   $debugMode (optional) If is set to true, the "debug" mode is turned on. Otherwise - turned off.
+     * @param string $baseUrl              Base url. Protocol & domain.
+     * @param string $username             Name of user used to authenticate to LimeSurvey
+     * @param string $password             Password used to authenticate to LimeSurvey
+     * @param bool   $debugMode            (optional) If is set to true, the "debug" mode is turned on. Otherwise -
+     *                                     turned off.
+     * @param bool   $verifySslCertificate (optional) If is set to true,  the SSL certificate verification is turned
+     *                                     on. Otherwise - turned off.
      */
-    public function __construct($baseUrl, $username, $password, $debugMode = false)
+    public function __construct($baseUrl, $username, $password, $debugMode = false, $verifySslCertificate = true)
     {
         $this
             ->setBaseUrl($baseUrl)
@@ -201,6 +212,30 @@ class ConnectionConfiguration
         return $this;
     }
 
+    /**
+     * Returns information if the SSL certificate verification is turned on
+     *
+     * @return bool
+     */
+    public function isVerifySslCertificateOn()
+    {
+        return $this->verifySslCertificate;
+    }
+
+    /**
+     * Sets information if the SSL certificate verification is turned on
+     *
+     * @param bool $verifySslCertificate (optional) If is set to true, the SSL certificate verification is turned on.
+     *                                   Otherwise - turned off.
+     * @return $this
+     */
+    public function setVerifySslCertificate($verifySslCertificate = true)
+    {
+        $this->verifySslCertificate = $verifySslCertificate;
+
+        return $this;
+    }
+
     /*
      * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      * Additional / extra methods (neither getters, nor setters)

src/Meritoo/LimeSurvey/ApiClient/Exception/CannotProcessDataException.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\LimeSurvey\ApiClient\Exception;
+
+/**
+ * An exception used while raw data returned by the LimeSurvey's API cannot be processed
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class CannotProcessDataException extends \Exception
+{
+    /**
+     * Class constructor
+     *
+     * @param string $reason Reason why data cannot be processed, e.g. "Invalid user name or password"
+     */
+    public function __construct($reason)
+    {
+        $template = 'Raw data returned by the LimeSurvey\'s API cannot be processed. Reason: \'%s\'.';
+        $message = sprintf($template, $reason);
+
+        parent::__construct($message);
+    }
+}

src/Meritoo/LimeSurvey/ApiClient/Manager/JsonRpcClientManager.php

@@ -85,7 +85,20 @@ class JsonRpcClientManager
              * The "debug" mode is turned on?
              */
             if ($this->connectionConfiguration->isDebugModeOn()) {
-                $this->rpcClient->getHttpClient()->withDebug();
+                $this
+                    ->rpcClient
+                    ->getHttpClient()
+                    ->withDebug();
+            }
+
+            /*
+             * The SSL certificate verification is turned off?
+             */
+            if (!$this->connectionConfiguration->isVerifySslCertificateOn()) {
+                $this
+                    ->rpcClient
+                    ->getHttpClient()
+                    ->withoutSslVerification();
             }
         }
 

src/Meritoo/LimeSurvey/ApiClient/Result/Processor/ResultProcessor.php

@@ -55,9 +55,9 @@ class ResultProcessor
          */
         if (MethodType::isResultIterable($method)) {
             $items = [];
-            $emptyItem = clone $item;
 
             foreach ($rawData as $itemData) {
+                $emptyItem = clone $item;
                 $items[] = $emptyItem->setValues($itemData);
             }
 

src/Meritoo/LimeSurvey/ApiClient/Result/Result.php

@@ -10,6 +10,7 @@ namespace Meritoo\LimeSurvey\ApiClient\Result;
 
 use Meritoo\Common\Collection\Collection;
 use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem;
+use Meritoo\LimeSurvey\ApiClient\Exception\CannotProcessDataException;
 use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
 use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
 
@@ -35,6 +36,13 @@ class Result
      */
     private $rawData;
 
+    /**
+     * Status, information returned instead of usual/normal result
+     *
+     * @var string
+     */
+    private $status;
+
     /**
      * Processor of the raw data fetched while talking to the LimeSurvey's API
      *
@@ -52,7 +60,7 @@ class Result
     public function __construct($method, array $rawData)
     {
         $this->method = MethodType::getValidatedMethod($method);
-        $this->rawData = $rawData;
+        $this->setRawDataAndStatus($rawData);
     }
 
     /**
@@ -71,14 +79,41 @@ class Result
      * @param bool $raw (optional) If is set to true, raw data provided by the LimeSurvey's API will be returned.
      *                  Otherwise - prepared/processed.
      * @return array|Collection|BaseItem
+     * @throws CannotProcessDataException
      */
     public function getData($raw = false)
     {
+        /*
+         * Raw data should be returned only?
+         * Let's do it
+         */
         if ($raw) {
             return $this->rawData;
         }
 
-        return $this->getProcessedData($this->rawData);
+        /*
+         * Status is unknown?
+         * Let's process the raw data
+         */
+        if (empty($this->status)) {
+            return $this->getProcessedData($this->rawData);
+        }
+
+        /*
+         * Oops, the raw data returned by the LimeSurvey's API cannot be processed, because status was provided.
+         * Well, probably something is broken and... there is no data.
+         */
+        throw new CannotProcessDataException($this->status);
+    }
+
+    /**
+     * Returns status, information returned instead of usual/normal result
+     *
+     * @return string
+     */
+    public function getStatus()
+    {
+        return $this->status;
     }
 
     /**
@@ -119,4 +154,23 @@ class Result
 
         return $this->resultProcessor;
     }
+
+    /**
+     * Sets status, information returned instead of usual/normal result and raw data returned by the LimeSurvey's API
+     *
+     * @param array $rawData Raw data returned by the LimeSurvey's API
+     */
+    private function setRawDataAndStatus(array $rawData)
+    {
+        /*
+         * Status was provided?
+         * Well, probably something is broken and... there is no data
+         */
+        if (isset($rawData['status'])) {
+            $this->status = trim($rawData['status']);
+            $rawData = [];
+        }
+
+        $this->rawData = $rawData;
+    }
 }

tests/Meritoo/LimeSurvey/Test/ApiClient/Configuration/ConnectionConfigurationTest.php

@@ -22,9 +22,16 @@ use Meritoo\LimeSurvey\ApiClient\Configuration\ConnectionConfiguration;
  */
 class ConnectionConfigurationTest extends BaseTestCase
 {
+    /**
+     * Simple instance of the configuration
+     *
+     * @var ConnectionConfiguration
+     */
+    private $simpleConfiguration;
+
     public function testConstructorVisibilityAndArguments()
     {
-        static::assertConstructorVisibilityAndArguments(ConnectionConfiguration::class, OopVisibilityType::IS_PUBLIC, 4, 3);
+        static::assertConstructorVisibilityAndArguments(ConnectionConfiguration::class, OopVisibilityType::IS_PUBLIC, 5, 3);
     }
 
     /**
@@ -49,69 +56,67 @@ class ConnectionConfigurationTest extends BaseTestCase
 
     public function testConstructor()
     {
-        $configuration = new ConnectionConfiguration('http://test.com', 'test1', 'test2');
-
-        static::assertEquals('http://test.com', $configuration->getBaseUrl());
-        static::assertEquals('test1', $configuration->getUsername());
-        static::assertEquals('test2', $configuration->getPassword());
-        static::assertFalse($configuration->isDebugModeOn());
+        static::assertEquals('http://test.com', $this->simpleConfiguration->getBaseUrl());
+        static::assertEquals('test1', $this->simpleConfiguration->getUsername());
+        static::assertEquals('test2', $this->simpleConfiguration->getPassword());
+        static::assertFalse($this->simpleConfiguration->isDebugModeOn());
     }
 
     public function testSetBaseUrl()
     {
-        $configuration = new ConnectionConfiguration('http://test.com', 'test1', 'test2');
+        $this->simpleConfiguration->setBaseUrl('http://lorem.ipsum');
+        static::assertEquals('http://lorem.ipsum', $this->simpleConfiguration->getBaseUrl());
 
-        $configuration->setBaseUrl('http://lorem.ipsum');
-        static::assertEquals('http://lorem.ipsum', $configuration->getBaseUrl());
-
-        $configuration->setBaseUrl('http://lorem.ipsum/');
-        static::assertEquals('http://lorem.ipsum', $configuration->getBaseUrl());
+        $this->simpleConfiguration->setBaseUrl('http://lorem.ipsum/');
+        static::assertEquals('http://lorem.ipsum', $this->simpleConfiguration->getBaseUrl());
     }
 
     public function testSetRemoteControlUrl()
     {
-        $configuration = new ConnectionConfiguration('http://test.com', 'test1', 'test2');
-        $configuration->setRemoteControlUrl('/lorem/ipsum');
-
-        static::assertEquals('/lorem/ipsum', $configuration->getRemoteControlUrl());
+        $this->simpleConfiguration->setRemoteControlUrl('/lorem/ipsum');
+        static::assertEquals('/lorem/ipsum', $this->simpleConfiguration->getRemoteControlUrl());
     }
 
     public function testSetUsername()
     {
-        $configuration = new ConnectionConfiguration('http://test.com', 'test1', 'test2');
-        $configuration->setUsername('lorem');
-
-        static::assertEquals('lorem', $configuration->getUsername());
+        $this->simpleConfiguration->setUsername('lorem');
+        static::assertEquals('lorem', $this->simpleConfiguration->getUsername());
     }
 
     public function testSetPassword()
     {
-        $configuration = new ConnectionConfiguration('http://test.com', 'test1', 'test2');
-        $configuration->setPassword('ipsum');
-
-        static::assertEquals('ipsum', $configuration->getPassword());
+        $this->simpleConfiguration->setPassword('ipsum');
+        static::assertEquals('ipsum', $this->simpleConfiguration->getPassword());
     }
 
     public function testSetDebugMode()
     {
-        $configuration = new ConnectionConfiguration('http://test.com', 'test1', 'test2');
+        $this->simpleConfiguration->setDebugMode();
+        static::assertFalse($this->simpleConfiguration->isDebugModeOn());
 
-        $configuration->setDebugMode();
-        static::assertFalse($configuration->isDebugModeOn());
+        $this->simpleConfiguration->setDebugMode(false);
+        static::assertFalse($this->simpleConfiguration->isDebugModeOn());
 
-        $configuration->setDebugMode(false);
-        static::assertFalse($configuration->isDebugModeOn());
+        $this->simpleConfiguration->setDebugMode(true);
+        static::assertTrue($this->simpleConfiguration->isDebugModeOn());
+    }
 
-        $configuration->setDebugMode(true);
-        static::assertTrue($configuration->isDebugModeOn());
+    public function testSetVerifySslCertificate()
+    {
+        $this->simpleConfiguration->setVerifySslCertificate();
+        static::assertTrue($this->simpleConfiguration->isVerifySslCertificateOn());
+
+        $this->simpleConfiguration->setVerifySslCertificate(false);
+        static::assertFalse($this->simpleConfiguration->isVerifySslCertificateOn());
+
+        $this->simpleConfiguration->setVerifySslCertificate(true);
+        static::assertTrue($this->simpleConfiguration->isVerifySslCertificateOn());
     }
 
     public function testGetFullUrl()
     {
-        $configuration = new ConnectionConfiguration('http://test.com', 'test1', 'test2');
-        $configuration->setRemoteControlUrl('lorem/ipsum');
-
-        static::assertEquals('http://test.com/lorem/ipsum', $configuration->getFullUrl());
+        $this->simpleConfiguration->setRemoteControlUrl('lorem/ipsum');
+        static::assertEquals('http://test.com/lorem/ipsum', $this->simpleConfiguration->getFullUrl());
     }
 
     /**
@@ -149,4 +154,13 @@ class ConnectionConfigurationTest extends BaseTestCase
             'htp:/dolor.com',
         ];
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function setUp()
+    {
+        parent::setUp();
+        $this->simpleConfiguration = new ConnectionConfiguration('http://test.com', 'test1', 'test2');
+    }
 }

tests/Meritoo/LimeSurvey/Test/ApiClient/Exception/CannotProcessDataExceptionTest.php

@@ -0,0 +1,60 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\LimeSurvey\Test\ApiClient\Exception;
+
+use Generator;
+use Meritoo\Common\Test\Base\BaseTestCase;
+use Meritoo\Common\Type\OopVisibilityType;
+use Meritoo\LimeSurvey\ApiClient\Exception\CannotProcessDataException;
+
+/**
+ * Test case of an exception used while raw data returned by the LimeSurvey's API cannot be processed
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class CannotProcessDataExceptionTest extends BaseTestCase
+{
+    public function testConstructorVisibilityAndArguments()
+    {
+        static::assertConstructorVisibilityAndArguments(CannotProcessDataException::class, OopVisibilityType::IS_PUBLIC, 1, 1);
+    }
+
+    /**
+     * @param string $reason          Reason why data cannot be processed, e.g. "Invalid user name or password"
+     * @param string $expectedMessage Expected exception's message
+     *
+     * @dataProvider provideReason
+     */
+    public function testConstructorMessage($reason, $expectedMessage)
+    {
+        $exception = new CannotProcessDataException($reason);
+        static::assertEquals($expectedMessage, $exception->getMessage());
+    }
+
+    /**
+     * Provides reason why data cannot be processed
+     *
+     * @return Generator
+     */
+    public function provideReason()
+    {
+        $template = 'Raw data returned by the LimeSurvey\'s API cannot be processed. Reason: \'%s\'.';
+
+        yield[
+            'unknown',
+            sprintf($template, 'unknown'),
+        ];
+
+        yield[
+            'Invalid user name or password',
+            sprintf($template, 'Invalid user name or password'),
+        ];
+    }
+}

tests/Meritoo/LimeSurvey/Test/ApiClient/Result/Processor/ResultProcessorTest.php

@@ -12,6 +12,7 @@ use Meritoo\Common\Test\Base\BaseTestCase;
 use Meritoo\Common\Type\OopVisibilityType;
 use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem;
 use Meritoo\LimeSurvey\ApiClient\Exception\UnknownInstanceOfResultItem;
+use Meritoo\LimeSurvey\ApiClient\Result\Item\Survey;
 use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
 use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
 use Meritoo\LimeSurvey\Test\ApiClient\Result\Item\SurveyTest;
@@ -39,12 +40,24 @@ class ResultProcessorTest extends BaseTestCase
 
     public function testProcessWithIterableData()
     {
+        $surveysRawData = SurveyTest::getSurveysRawData();
         $processor = new ResultProcessor();
-        $processed = $processor->process(MethodType::LIST_SURVEYS, SurveyTest::getSurveysRawData());
+        $processed = $processor->process(MethodType::LIST_SURVEYS, $surveysRawData);
 
-        static::assertNotEmpty($processed);
         static::assertTrue(is_array($processed));
         static::assertCount(2, $processed);
+
+        /* @var Survey $firstSurvey */
+        $firstSurvey = $processed[0];
+
+        /* @var Survey $secondSurvey */
+        $secondSurvey = $processed[1];
+
+        static::assertEquals($surveysRawData[0]['sid'], $firstSurvey->getId());
+        static::assertEquals($surveysRawData[1]['sid'], $secondSurvey->getId());
+
+        static::assertEquals($surveysRawData[0]['surveyls_title'], $firstSurvey->getTitle());
+        static::assertEquals($surveysRawData[1]['surveyls_title'], $secondSurvey->getTitle());
     }
 
     public function testProcessWithNotIterableData()

tests/Meritoo/LimeSurvey/Test/ApiClient/Result/ResultTest.php

@@ -12,6 +12,7 @@ use DateTime;
 use Meritoo\Common\Test\Base\BaseTestCase;
 use Meritoo\Common\Type\OopVisibilityType;
 use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem;
+use Meritoo\LimeSurvey\ApiClient\Exception\CannotProcessDataException;
 use Meritoo\LimeSurvey\ApiClient\Result\Result;
 use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
 use PHPUnit_Framework_MockObject_MockObject;
@@ -46,28 +47,43 @@ class ResultTest extends BaseTestCase
     private $notIterableData;
 
     /**
-     * Mock of the tested class.
-     * With empty data returned by the LimeSurvey's API.
+     * Status provided instead of real data.
+     * An array with one key: "status".
      *
-     * @var PHPUnit_Framework_MockObject_MockObject
+     * @var array
      */
-    private $emptyDataMock;
+    private $statusInsteadData;
 
     /**
+     * Result with empty data returned by the LimeSurvey's API.
      * Mock of the tested class.
-     * With iterable, not empty data.
      *
      * @var PHPUnit_Framework_MockObject_MockObject
      */
-    private $iterableDataMock;
+    private $emptyDataResult;
 
     /**
+     * Result with iterable, not empty data.
      * Mock of the tested class.
-     * With not iterable, not empty data.
      *
      * @var PHPUnit_Framework_MockObject_MockObject
      */
-    private $notIterableDataMock;
+    private $iterableDataResult;
+
+    /**
+     * Result with not iterable, not empty data.
+     * Mock of the tested class.
+     *
+     * @var PHPUnit_Framework_MockObject_MockObject
+     */
+    private $notIterableDataResult;
+
+    /**
+     * Result with status provided instead of real data
+     *
+     * @var Result
+     */
+    private $statusInsteadDataResult;
 
     public function testConstructorVisibilityAndArguments()
     {
@@ -76,15 +92,15 @@ class ResultTest extends BaseTestCase
 
     public function testIsEmpty()
     {
-        static::assertTrue($this->emptyDataMock->isEmpty());
-        static::assertFalse($this->iterableDataMock->isEmpty());
+        static::assertTrue($this->emptyDataResult->isEmpty());
+        static::assertFalse($this->iterableDataResult->isEmpty());
     }
 
     public function testGetDataUsingProcessedData()
     {
-        $emptyData = $this->emptyDataMock->getData();
-        $iterableData = $this->iterableDataMock->getData();
-        $notIterableData = $this->notIterableDataMock->getData();
+        $emptyData = $this->emptyDataResult->getData();
+        $iterableData = $this->iterableDataResult->getData();
+        $notIterableData = $this->notIterableDataResult->getData();
 
         static::assertEmpty($emptyData);
         static::assertNotEmpty($iterableData);
@@ -97,8 +113,8 @@ class ResultTest extends BaseTestCase
 
     public function testGetDataUsingRawData()
     {
-        $emptyData = $this->emptyDataMock->getData(true);
-        $iterableData = $this->iterableDataMock->getData(true);
+        $emptyData = $this->emptyDataResult->getData(true);
+        $iterableData = $this->iterableDataResult->getData(true);
 
         static::assertEmpty($emptyData);
         static::assertNotEmpty($iterableData);
@@ -110,6 +126,12 @@ class ResultTest extends BaseTestCase
         static::assertEquals($this->iterableData, $iterableData);
     }
 
+    public function testGetDataUsingProcessedDataWhoCannotBeProcessed()
+    {
+        $this->expectException(CannotProcessDataException::class);
+        $this->statusInsteadDataResult->getData();
+    }
+
     public function testGetProcessedDataVisibilityAndArguments()
     {
         static::assertMethodVisibilityAndArguments(Result::class, 'getProcessedData', OopVisibilityType::IS_PRIVATE, 1, 1);
@@ -120,6 +142,20 @@ class ResultTest extends BaseTestCase
         static::assertMethodVisibilityAndArguments(Result::class, 'getResultProcessor', OopVisibilityType::IS_PRIVATE);
     }
 
+    public function testGetStatusWhenIsNotProvided()
+    {
+        $result = new Result(MethodType::ADD_PARTICIPANTS, []);
+
+        static::assertEquals(null, $result->getStatus());
+        static::assertEquals([], $result->getData(true));
+    }
+
+    public function testGetStatusWhenIsProvided()
+    {
+        static::assertEquals($this->statusInsteadData['status'], $this->statusInsteadDataResult->getStatus());
+        static::assertEquals([], $this->statusInsteadDataResult->getData(true));
+    }
+
     /**
      * {@inheritdoc{
      */
@@ -149,24 +185,29 @@ class ResultTest extends BaseTestCase
             ],
         ];
 
-        $emptyDataArguments = [
+        $this->statusInsteadData = [
+            'status' => 'Invalid data',
+        ];
+
+        $emptyData = [
             MethodType::LIST_SURVEYS,
             $this->emptyData,
         ];
 
-        $iterableDataArguments = [
+        $iterableData = [
             MethodType::LIST_SURVEYS,
             $this->iterableData,
         ];
 
-        $notIterableDataArguments = [
+        $notIterableData = [
             MethodType::GET_PARTICIPANT_PROPERTIES,
             $this->notIterableData,
         ];
 
-        $this->emptyDataMock = $this->getResultMock($emptyDataArguments);
-        $this->iterableDataMock = $this->getResultMock($iterableDataArguments);
-        $this->notIterableDataMock = $this->getResultMock($notIterableDataArguments);
+        $this->emptyDataResult = $this->getResultMock($emptyData);
+        $this->iterableDataResult = $this->getResultMock($iterableData);
+        $this->notIterableDataResult = $this->getResultMock($notIterableData);
+        $this->statusInsteadDataResult = new Result(MethodType::LIST_PARTICIPANTS, $this->statusInsteadData);
     }
 
     /**