SurveyService - a service that serves surveys

src/Meritoo/LimeSurvey/ApiClient/Service/SurveyService.php

@@ -0,0 +1,104 @@
+<?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\Service;
+
+use Meritoo\Common\Collection\Collection;
+use Meritoo\LimeSurvey\ApiClient\Client\Client;
+use Meritoo\LimeSurvey\ApiClient\Result\Item\Survey;
+use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
+
+/**
+ * Serves surveys
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class SurveyService
+{
+    /**
+     * Client of the LimeSurvey's API
+     *
+     * @var Client
+     */
+    private $client;
+
+    /**
+     * All surveys
+     *
+     * @var Collection
+     */
+    private $allSurveys;
+
+    /**
+     * Class constructor
+     *
+     * @param Client     $client     Client of the LimeSurvey's API
+     * @param Collection $allSurveys (optional) All surveys
+     */
+    public function __construct(Client $client, Collection $allSurveys = null)
+    {
+        if (null === $allSurveys) {
+            $allSurveys = new Collection();
+        }
+
+        $this->client = $client;
+        $this->allSurveys = $allSurveys;
+    }
+
+    /**
+     * Returns all surveys
+     *
+     * @return Collection
+     */
+    public function getAllSurveys()
+    {
+        if ($this->allSurveys->isEmpty()) {
+            $surveys = $this
+                ->client
+                ->run(MethodType::LIST_SURVEYS)
+                ->getData();
+
+            if (null !== $surveys) {
+                $this->allSurveys = $surveys;
+            }
+        }
+
+        return $this->allSurveys;
+    }
+
+    /**
+     * Returns information if survey with given ID exists
+     *
+     * @param int $surveyId ID of survey to verify
+     * @return bool
+     */
+    public function isExistingSurvey($surveyId)
+    {
+        $allSurveys = $this->getAllSurveys();
+
+        /*
+         * No surveys?
+         * Nothing to do
+         */
+        if ($allSurveys->isEmpty()) {
+            return false;
+        }
+
+        $surveyId = (int)$surveyId;
+
+        /* @var Survey $survey */
+        foreach ($allSurveys as $survey) {
+            if ($survey->getId() == $surveyId) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

tests/Meritoo/LimeSurvey/Test/ApiClient/Service/SurveyServiceTest.php

@@ -0,0 +1,155 @@
+<?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\Service;
+
+use Meritoo\Common\Collection\Collection;
+use Meritoo\Common\Test\Base\BaseTestCase;
+use Meritoo\Common\Type\OopVisibilityType;
+use Meritoo\LimeSurvey\ApiClient\Client\Client;
+use Meritoo\LimeSurvey\ApiClient\Configuration\ConnectionConfiguration;
+use Meritoo\LimeSurvey\ApiClient\Manager\JsonRpcClientManager;
+use Meritoo\LimeSurvey\ApiClient\Manager\SessionManager;
+use Meritoo\LimeSurvey\ApiClient\Result\Item\Survey;
+use Meritoo\LimeSurvey\ApiClient\Service\SurveyService;
+use PHPUnit_Framework_MockObject_MockObject;
+
+/**
+ * Test case of the service that serves surveys
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class SurveyServiceTest extends BaseTestCase
+{
+    /**
+     * Serves surveys.
+     * Service without surveys.
+     *
+     * @var SurveyService
+     */
+    private $serviceWithoutSurveys;
+
+    /**
+     * Serves surveys.
+     * Service with surveys.
+     *
+     * @var SurveyService
+     */
+    private $serviceWithSurveys;
+
+    public function testConstructorVisibilityAndArguments()
+    {
+        static::assertConstructorVisibilityAndArguments(SurveyService::class, OopVisibilityType::IS_PUBLIC, 2, 1);
+    }
+
+    public function testGetAllSurveys()
+    {
+        $rpcClientManager = $this->getJsonRpcClientManager(1);
+        $sessionManager = $this->getSessionManager();
+
+        $this->createServiceWithoutSurveys($rpcClientManager, $sessionManager);
+        $this->createServiceWithSurveys($rpcClientManager, $sessionManager);
+
+        static::assertCount(0, $this->serviceWithoutSurveys->getAllSurveys());
+        static::assertCount(2, $this->serviceWithSurveys->getAllSurveys());
+    }
+
+    public function testIsExistingSurvey()
+    {
+        $rpcClientManager = $this->getJsonRpcClientManager(2);
+        $sessionManager = $this->getSessionManager();
+
+        $this->createServiceWithoutSurveys($rpcClientManager, $sessionManager);
+        $this->createServiceWithSurveys($rpcClientManager, $sessionManager);
+
+        static::assertFalse($this->serviceWithoutSurveys->isExistingSurvey(1));
+        static::assertFalse($this->serviceWithoutSurveys->isExistingSurvey(2));
+
+        static::assertTrue($this->serviceWithSurveys->isExistingSurvey(1));
+        static::assertTrue($this->serviceWithSurveys->isExistingSurvey(2));
+        static::assertFalse($this->serviceWithSurveys->isExistingSurvey(3));
+    }
+
+    /**
+     * Returns configuration used while connecting to LimeSurvey's API
+     *
+     * @return ConnectionConfiguration
+     */
+    private function getConnectionConfiguration()
+    {
+        return new ConnectionConfiguration('http://test.com', 'test', 'test');
+    }
+
+    /**
+     * Returns manager of session started while connecting to LimeSurvey's API
+     *
+     * @return PHPUnit_Framework_MockObject_MockObject
+     */
+    private function getSessionManager()
+    {
+        return $this->createMock(SessionManager::class);
+    }
+
+    /**
+     * Returns manager of the JsonRPC client used while connecting to LimeSurvey's API
+     *
+     * @param int   $runMethodCallCount   Count of calls of the runMethod() method (who is mocked)
+     * @param array $runMethodCallResults (optional) Results of calls of the runMethod() method (who is mocked)
+     * @return PHPUnit_Framework_MockObject_MockObject
+     */
+    private function getJsonRpcClientManager($runMethodCallCount, array $runMethodCallResults = [])
+    {
+        $rpcClientManager = $this->createMock(JsonRpcClientManager::class);
+
+        $rpcClientManager
+            ->expects(static::exactly($runMethodCallCount))
+            ->method('runMethod')
+            ->will(static::returnValue($runMethodCallResults));
+
+        return $rpcClientManager;
+    }
+
+    /**
+     * Creates instance of the tested service without surveys
+     *
+     * @param PHPUnit_Framework_MockObject_MockObject $rpcClientManager Manager of the JsonRPC client used while connecting to LimeSurvey's API
+     * @param PHPUnit_Framework_MockObject_MockObject $sessionManager   Manager of session started while connecting to LimeSurvey's API
+     */
+    private function createServiceWithoutSurveys(PHPUnit_Framework_MockObject_MockObject $rpcClientManager, PHPUnit_Framework_MockObject_MockObject $sessionManager)
+    {
+        $configuration = $this->getConnectionConfiguration();
+        $client = new Client($configuration, $rpcClientManager, $sessionManager);
+        $this->serviceWithoutSurveys = new SurveyService($client);
+    }
+
+    /**
+     * Creates instance of the tested service with surveys
+     *
+     * @param PHPUnit_Framework_MockObject_MockObject $rpcClientManager Manager of the JsonRPC client used while connecting to LimeSurvey's API
+     * @param PHPUnit_Framework_MockObject_MockObject $sessionManager   Manager of session started while connecting to LimeSurvey's API
+     */
+    private function createServiceWithSurveys(PHPUnit_Framework_MockObject_MockObject $rpcClientManager, PHPUnit_Framework_MockObject_MockObject $sessionManager)
+    {
+        $configuration = $this->getConnectionConfiguration();
+        $client = new Client($configuration, $rpcClientManager, $sessionManager);
+
+        $allSurveys = new Collection([
+            (new Survey())->setValues([
+                'sid'            => 1,
+                'surveyls_title' => 'Test',
+            ]),
+            (new Survey())->setValues([
+                'sid'            => 2,
+                'surveyls_title' => 'Another Test',
+            ]),
+        ]);
+
+        $this->serviceWithSurveys = new SurveyService($client, $allSurveys);
+    }
+}