8 Commits
0.0.1 ... 0.0.2

25 changed files with 985 additions and 49 deletions

View File

@@ -3,7 +3,7 @@
"description": "Client of LimeSurvey API",
"type": "library",
"license": "MIT",
"version": "0.0.1",
"version": "0.0.2",
"authors": [
{
"name": "Meritoo",
@@ -15,13 +15,13 @@
"meritoo/common-library": "~0.0.1"
},
"require-dev": {
"phpunit/phpunit": "^4.8.35 || ^5.4.3",
"squizlabs/php_codesniffer": "^2.8",
"phpunit/phpunit": "^5.7",
"squizlabs/php_codesniffer": "^2.9",
"phpmd/phpmd": "^2.6",
"sebastian/phpcpd": "^3.0",
"pdepend/pdepend": "^2.5",
"phploc/phploc": "^4.0",
"friendsofphp/php-cs-fixer": "^2.5"
"friendsofphp/php-cs-fixer": "^2.6"
},
"autoload": {
"psr-4": {

30
composer.lock generated
View File

@@ -4,7 +4,7 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
"This file is @generated automatically"
],
"content-hash": "8dd6b3c26ff164b50e36ec644a269e12",
"content-hash": "e4198a77e875ad9d86efc5ebd166341b",
"packages": [
{
"name": "behat/transliterator",
@@ -769,16 +769,16 @@
},
{
"name": "meritoo/common-library",
"version": "0.0.7",
"version": "0.0.12",
"source": {
"type": "git",
"url": "https://github.com/meritoo/common-library.git",
"reference": "94a464cb4ded35c53638a404657a15a114437815"
"reference": "ffa3fbffe77c1caa4afb9aa26bd851c9ecd38cfc"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/meritoo/common-library/zipball/94a464cb4ded35c53638a404657a15a114437815",
"reference": "94a464cb4ded35c53638a404657a15a114437815",
"url": "https://api.github.com/repos/meritoo/common-library/zipball/ffa3fbffe77c1caa4afb9aa26bd851c9ecd38cfc",
"reference": "ffa3fbffe77c1caa4afb9aa26bd851c9ecd38cfc",
"shasum": ""
},
"require": {
@@ -788,13 +788,13 @@
"symfony/http-foundation": "^3.3"
},
"require-dev": {
"friendsofphp/php-cs-fixer": "^2.1",
"friendsofphp/php-cs-fixer": "^2.6",
"pdepend/pdepend": "^2.5",
"phploc/phploc": "^3.0",
"phploc/phploc": "^4.0",
"phpmd/phpmd": "^2.6",
"phpunit/phpunit": "^4.8 || ^5.0",
"phpunit/phpunit": "^5.7",
"sebastian/phpcpd": "^3.0",
"squizlabs/php_codesniffer": "^2.8"
"squizlabs/php_codesniffer": "^2.9"
},
"type": "library",
"autoload": {
@@ -815,7 +815,7 @@
}
],
"description": "Useful classes, methods, extensions etc.",
"time": "2017-09-19T16:09:13+00:00"
"time": "2017-09-22T21:27:21+00:00"
},
{
"name": "psr/log",
@@ -1998,16 +1998,16 @@
},
{
"name": "phpunit/phpunit",
"version": "5.7.21",
"version": "5.7.22",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/phpunit.git",
"reference": "3b91adfb64264ddec5a2dee9851f354aa66327db"
"reference": "10df877596c9906d4110b5b905313829043f2ada"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/3b91adfb64264ddec5a2dee9851f354aa66327db",
"reference": "3b91adfb64264ddec5a2dee9851f354aa66327db",
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/10df877596c9906d4110b5b905313829043f2ada",
"reference": "10df877596c9906d4110b5b905313829043f2ada",
"shasum": ""
},
"require": {
@@ -2076,7 +2076,7 @@
"testing",
"xunit"
],
"time": "2017-06-21T08:11:54+00:00"
"time": "2017-09-24T07:23:38+00:00"
},
{
"name": "phpunit/phpunit-mock-objects",

View File

@@ -92,7 +92,7 @@ class Client
->getSessionKey($username, $password);
/*
* Use the session's key as of the method's arguments
* Use the session's key as one of the method's arguments
*/
array_unshift($arguments, $sessionKey);
@@ -103,6 +103,18 @@ class Client
->getRpcClientManager()
->runMethod($method, $arguments);
/*
* Raw data is unknown?
* Let's use an empty array instead
*
* Required to avoid bug:
* Argument 2 passed to Meritoo\LimeSurvey\ApiClient\Result\Result::__construct() must be of the type array,
* null given
*/
if (null === $rawData) {
$rawData = [];
}
return new Result($method, $rawData);
}

View File

@@ -0,0 +1,143 @@
<?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\Result\Collection;
use Meritoo\Common\Collection\Collection;
use Meritoo\Common\Exception\Method\DisabledMethodException;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Participant;
/**
* Participants of survey.
* All participants grouped per survey.
*
* It's a collection of participants' collections.
* The survey ID is used as an index per each collection of participants, so they are grouped by survey.
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class Participants extends Collection
{
/**
* {@inheritdoc}
*/
public function add($element, $index = null)
{
throw new DisabledMethodException(__METHOD__, 'addParticipants');
}
/**
* {@inheritdoc}
*/
public function addMultiple($elements, $useIndexes = false)
{
throw new DisabledMethodException(__METHOD__, 'addParticipants');
}
/**
* Adds participants of given survey
*
* @param Collection $participants Participants to add. Collection of Participant classes.
* @param int $surveyId ID of survey
* @return $this
*/
public function addParticipants(Collection $participants, $surveyId)
{
/*
* No participants?
* Nothing to do
*/
if ($participants->isEmpty()) {
return $this;
}
$this
->getBySurvey($surveyId)
->addMultiple($participants);
return $this;
}
/**
* Adds participant of given survey
*
* @param Participant $participant Participant to add
* @param int $surveyId ID of survey
* @return $this
*/
public function addParticipant(Participant $participant, $surveyId)
{
$this
->getBySurvey($surveyId)
->add($participant);
return $this;
}
/**
* Returns information if there are participants of given survey
*
* @param int $surveyId ID of survey
* @return bool
*/
public function hasParticipantsOfSurvey($surveyId)
{
return false === $this
->getBySurvey($surveyId)
->isEmpty();
}
/**
* Returns participants of given survey
*
* If there are no participants of given survey, adds an empty collection who will store participants.
* So, this method will return collection always.
*
* @param int $surveyId ID of survey
* @return Collection
*/
public function getBySurvey($surveyId)
{
/*
* There are no participants of given survey?
* Let's add an empty collection who will store participants
*/
if (!isset($this[$surveyId])) {
$this[$surveyId] = new Collection();
}
return $this[$surveyId];
}
/**
* Returns participant of given survey
*
* @param int $surveyId ID of survey
* @param string $participantEmail E-mail of searched participant
* @return Participant|null
*/
public function getParticipantOfSurvey($surveyId, $participantEmail)
{
/* @var Collection $participants */
$participants = $this->getBySurvey($surveyId);
if ($participants->isEmpty()) {
return null;
}
/* @var Participant $participant */
foreach ($participants as $participant) {
if ($participant->getEmail() == $participantEmail) {
return $participant;
}
}
return null;
}
}

View File

@@ -81,6 +81,7 @@ class ResultProcessor
$method = MethodType::getValidatedMethod($method);
switch ($method) {
case MethodType::ADD_PARTICIPANTS:
case MethodType::GET_PARTICIPANT_PROPERTIES:
$item = new Participant();
break;

View File

@@ -0,0 +1,142 @@
<?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\Collection\Participants;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Participant;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
/**
* Serves participants
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class ParticipantService
{
/**
* Client of the LimeSurvey's API
*
* @var Client
*/
private $client;
/**
* Participants of survey.
* All participants grouped per survey.
*
* @var Participants
*/
private $allParticipants;
/**
* Class constructor
*
* @param Client $client Client of the LimeSurvey's API
* @param Participants $allParticipants (optional) Participants of survey. All participants grouped per survey.
*/
public function __construct(Client $client, Participants $allParticipants = null)
{
if (null === $allParticipants) {
$allParticipants = new Participants();
}
$this->client = $client;
$this->allParticipants = $allParticipants;
}
/**
* Returns participants of given survey
*
* @param int $surveyId ID of survey
* @return Collection
*/
public function getSurveyParticipants($surveyId)
{
$hasSurvey = $this
->allParticipants
->hasParticipantsOfSurvey($surveyId);
if (!$hasSurvey) {
$arguments = [
$surveyId,
];
$participants = $this
->client
->run(MethodType::LIST_PARTICIPANTS, $arguments)
->getData();
$this
->allParticipants
->addParticipants($participants, $surveyId);
}
return $this
->allParticipants
->getBySurvey($surveyId);
}
/**
* Returns information if given survey has participant with given e-mail
*
* @param int $surveyId ID of survey
* @param string $email E-mail address of the participant
* @return bool
*/
public function hasParticipant($surveyId, $email)
{
/*
* I have to get all participants of survey to avoid problem when participants exist but are not loaded
*/
$this->getSurveyParticipants($surveyId);
return null !== $this
->allParticipants
->getParticipantOfSurvey($surveyId, $email);
}
/**
* Adds participant with given data to survey with given ID
*
* @param int $surveyId ID of survey
* @param string $firstName First name of the participant to add
* @param string $lastName Last ame of the participant to add
* @param string $email E-mail address of the participant to add
* @return Participant
*/
public function addParticipant($surveyId, $firstName, $lastName, $email)
{
$participantsData = [
[
'firstname' => $firstName,
'lastname' => $lastName,
'email' => $email,
],
];
$arguments = [
$surveyId,
$participantsData,
];
$participantCollection = $this
->client
->run(MethodType::ADD_PARTICIPANTS, $arguments)
->getData();
$this
->allParticipants
->addParticipants($participantCollection, $surveyId);
return $participantCollection->getFirst();
}
}

View File

@@ -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;
}
}

View File

@@ -19,6 +19,16 @@ use Meritoo\LimeSurvey\ApiClient\Exception\UnknownMethodException;
*/
class MethodType extends BaseType
{
/**
* Add participants to the tokens collection of the survey
*
* Returns the inserted data including additional new information like the Token entry ID and the token string.
* In case of errors in some data, return it in errors.
*
* @var string
*/
const ADD_PARTICIPANTS = 'add_participants';
/**
* Add a response to the survey responses collection.
* Returns the id of the inserted survey response.
@@ -104,6 +114,7 @@ class MethodType extends BaseType
$method = static::getValidatedMethod($method);
return in_array($method, [
static::ADD_PARTICIPANTS,
static::LIST_PARTICIPANTS,
static::LIST_QUESTIONS,
static::LIST_SURVEYS,

View File

@@ -8,9 +8,8 @@
namespace Meritoo\LimeSurvey\Test\ApiClient\Base\Result;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem;
use PHPUnit_Framework_TestCase;
use ReflectionClass;
/**
* Test case of the base class for one item of result/data fetched while talking to the LimeSurvey's API
@@ -18,14 +17,11 @@ use ReflectionClass;
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class BaseItemTest extends PHPUnit_Framework_TestCase
class BaseItemTest extends BaseTestCase
{
public function testConstructorVisibilityAndArguments()
{
$reflection = new ReflectionClass(BaseItem::class);
$constructor = $reflection->getConstructor();
static::assertNull($constructor);
static::assertHasNoConstructor(BaseItem::class);
}
public function testSetValues()

View File

@@ -34,6 +34,11 @@ class ClientTest extends BaseTestCase
*/
private $configuration;
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(Client::class, OopVisibilityType::IS_PUBLIC, 3, 1);
}
/**
* @param string $incorrectMethod Incorrect name of method to call
* @dataProvider provideIncorrectMethod
@@ -71,12 +76,12 @@ class ClientTest extends BaseTestCase
public function testGetRpcClientManagerVisibilityAndArguments()
{
$this->verifyMethodVisibilityAndArguments(Client::class, 'getRpcClientManager', OopVisibilityType::IS_PRIVATE);
static::assertMethodVisibilityAndArguments(Client::class, 'getRpcClientManager', OopVisibilityType::IS_PRIVATE);
}
public function testGetSessionManagerVisibilityAndArguments()
{
$this->verifyMethodVisibilityAndArguments(Client::class, 'getRpcClientManager', OopVisibilityType::IS_PRIVATE);
static::assertMethodVisibilityAndArguments(Client::class, 'getRpcClientManager', OopVisibilityType::IS_PRIVATE);
}
/**

View File

@@ -11,6 +11,7 @@ namespace Meritoo\LimeSurvey\Test\ApiClient\Configuration;
use Generator;
use Meritoo\Common\Exception\Regex\InvalidUrlException;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\LimeSurvey\ApiClient\Configuration\ConnectionConfiguration;
/**
@@ -21,6 +22,11 @@ use Meritoo\LimeSurvey\ApiClient\Configuration\ConnectionConfiguration;
*/
class ConnectionConfigurationTest extends BaseTestCase
{
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(ConnectionConfiguration::class, OopVisibilityType::IS_PUBLIC, 4, 3);
}
/**
* @param mixed $emptyBaseUrl Empty base url
* @dataProvider provideEmptyBaseUrl

View File

@@ -33,7 +33,7 @@ class JsonRpcClientManagerTest extends BaseTestCase
public function testConstructorVisibilityAndArguments()
{
$this->verifyConstructorVisibilityAndArguments(JsonRpcClientManager::class, OopVisibilityType::IS_PUBLIC, 1, 1);
static::assertConstructorVisibilityAndArguments(JsonRpcClientManager::class, OopVisibilityType::IS_PUBLIC, 1, 1);
}
public function testRunMethod()
@@ -85,7 +85,7 @@ class JsonRpcClientManagerTest extends BaseTestCase
public function testGetRpcClientVisibilityAndArguments()
{
$this->verifyMethodVisibilityAndArguments(JsonRpcClientManager::class, 'getRpcClient', OopVisibilityType::IS_PROTECTED);
static::assertMethodVisibilityAndArguments(JsonRpcClientManager::class, 'getRpcClient', OopVisibilityType::IS_PROTECTED);
}
/**

View File

@@ -24,7 +24,7 @@ class SessionManagerTest extends BaseTestCase
{
public function testConstructorVisibilityAndArguments()
{
$this->verifyConstructorVisibilityAndArguments(SessionManager::class, OopVisibilityType::IS_PUBLIC, 1, 1);
static::assertConstructorVisibilityAndArguments(SessionManager::class, OopVisibilityType::IS_PUBLIC, 1, 1);
}
public function testGetSessionKeyWhenFailedWithoutReason()

View File

@@ -0,0 +1,143 @@
<?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\Result\Collection;
use Meritoo\Common\Collection\Collection;
use Meritoo\Common\Exception\Method\DisabledMethodException;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\LimeSurvey\ApiClient\Result\Collection\Participants;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Participant;
/**
* Test case of the participants of survey
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class ParticipantsTest extends BaseTestCase
{
/**
* An empty collection of participants
*
* @var Participants
*/
private $participantsEmpty;
/**
* Participants of 1 survey
*
* @var Participants
*/
private $participantsOfOneSurvey;
/**
* Participants of more than 1 survey
*
* @var Participants
*/
private $participantsOfManySurvey;
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(Participants::class, OopVisibilityType::IS_PUBLIC, 1, 0);
}
public function testAdd()
{
$this->expectException(DisabledMethodException::class);
(new Participants())->add('');
}
public function testAddMultiple()
{
$this->expectException(DisabledMethodException::class);
(new Participants())->addMultiple([]);
}
public function testAddParticipantsWithoutParticipants()
{
$surveyId = 1;
$participants = new Participants();
$result = $participants->addParticipants(new Collection(), $surveyId);
static::assertFalse($participants->hasParticipantsOfSurvey($surveyId));
static::assertFalse($participants->hasParticipantsOfSurvey(2));
static::assertEquals($participants, $result);
static::assertCount(0, $participants->getBySurvey($surveyId));
}
public function testAddParticipantsFirstParticipants()
{
$surveyId = 1;
$participantsData = new Collection([
new Participant(),
new Participant(),
]);
$result = $this
->participantsEmpty
->addParticipants($participantsData, $surveyId);
static::assertTrue($this->participantsEmpty->hasParticipantsOfSurvey($surveyId));
static::assertFalse($this->participantsEmpty->hasParticipantsOfSurvey(2));
static::assertEquals($this->participantsEmpty, $result);
static::assertCount(2, $this->participantsEmpty->getBySurvey($surveyId));
}
public function testAddParticipantsMoreParticipants()
{
$surveyId = 2;
$participantsData = new Collection([
new Participant(),
new Participant(),
]);
$result = $this
->participantsOfOneSurvey
->addParticipants($participantsData, $surveyId);
static::assertTrue($this->participantsOfOneSurvey->hasParticipantsOfSurvey($surveyId));
static::assertFalse($this->participantsOfOneSurvey->hasParticipantsOfSurvey(3));
static::assertEquals($this->participantsOfOneSurvey, $result);
static::assertCount(2, $this->participantsOfOneSurvey->getBySurvey($surveyId));
}
/**
* {@inheritdoc}
*/
protected function setUp()
{
parent::setUp();
$this->participantsEmpty = new Participants();
$this->participantsOfOneSurvey = new Participants();
$this->participantsOfManySurvey = new Participants();
$participants1Survey = new Collection();
$participants2Survey = new Collection();
$participants3Survey = new Collection();
$this
->participantsOfOneSurvey
->addParticipants($participants1Survey, 1);
$this
->participantsOfManySurvey
->addParticipants($participants1Survey, 2)
->addParticipants($participants2Survey, 3)
->addParticipants($participants3Survey, 4);
}
}

View File

@@ -8,10 +8,10 @@
namespace Meritoo\LimeSurvey\Test\ApiClient\Result\Item;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\LimeSurvey\ApiClient\Result\Item\ParticipantShort;
use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
use PHPUnit_Framework_TestCase;
/**
* Test case of the one item of the result/data: short data of participant
@@ -19,7 +19,7 @@ use PHPUnit_Framework_TestCase;
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class ParticipantShortTest extends PHPUnit_Framework_TestCase
class ParticipantShortTest extends BaseTestCase
{
/**
* Raw data of participants
@@ -42,6 +42,11 @@ class ParticipantShortTest extends PHPUnit_Framework_TestCase
*/
private $participant2ndInstance;
public function testConstructorVisibilityAndArguments()
{
static::assertHasNoConstructor(ParticipantShort::class);
}
public function testCreateOfTheParticipant()
{
$processor = new ResultProcessor();

View File

@@ -9,10 +9,10 @@
namespace Meritoo\LimeSurvey\Test\ApiClient\Result\Item;
use DateTime;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Participant;
use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
use PHPUnit_Framework_TestCase;
/**
* Test case of the one item of the result/data: full data of participant
@@ -20,7 +20,7 @@ use PHPUnit_Framework_TestCase;
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class ParticipantTest extends PHPUnit_Framework_TestCase
class ParticipantTest extends BaseTestCase
{
/**
* Raw data of participants
@@ -43,6 +43,11 @@ class ParticipantTest extends PHPUnit_Framework_TestCase
*/
private $participant2ndInstance;
public function testConstructorVisibilityAndArguments()
{
static::assertHasNoConstructor(Participant::class);
}
public function testCreateOfTheParticipant()
{
$processor = new ResultProcessor();

View File

@@ -42,6 +42,11 @@ class QuestionShortTest extends BaseTestCase
*/
private $question2ndInstance;
public function testConstructorVisibilityAndArguments()
{
static::assertHasNoConstructor(QuestionShort::class);
}
public function testCreateOfTheQuestionShort()
{
$processor = new ResultProcessor();

View File

@@ -8,10 +8,10 @@
namespace Meritoo\LimeSurvey\Test\ApiClient\Result\Item;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Question;
use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
use PHPUnit_Framework_TestCase;
/**
* Test case of the one item of the result/data: full data of one question of survey
@@ -19,7 +19,7 @@ use PHPUnit_Framework_TestCase;
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class QuestionTest extends PHPUnit_Framework_TestCase
class QuestionTest extends BaseTestCase
{
/**
* Raw data of questions
@@ -42,6 +42,11 @@ class QuestionTest extends PHPUnit_Framework_TestCase
*/
private $question2ndInstance;
public function testConstructorVisibilityAndArguments()
{
static::assertHasNoConstructor(Question::class);
}
public function testCreateOfTheQuestionShort()
{
$processor = new ResultProcessor();

View File

@@ -9,10 +9,10 @@
namespace Meritoo\LimeSurvey\Test\ApiClient\Result\Item;
use DateTime;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Survey;
use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
use PHPUnit_Framework_TestCase;
/**
* Test case of the one item of the result/data: survey
@@ -20,7 +20,7 @@ use PHPUnit_Framework_TestCase;
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class SurveyTest extends PHPUnit_Framework_TestCase
class SurveyTest extends BaseTestCase
{
/**
* Raw data of surveys
@@ -43,6 +43,11 @@ class SurveyTest extends PHPUnit_Framework_TestCase
*/
private $survey2ndInstance;
public function testConstructorVisibilityAndArguments()
{
static::assertHasNoConstructor(Survey::class);
}
public function testCreateOfTheSurvey()
{
$processor = new ResultProcessor();

View File

@@ -15,7 +15,6 @@ use Meritoo\LimeSurvey\ApiClient\Exception\UnknownInstanceOfResultItem;
use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
use Meritoo\LimeSurvey\Test\ApiClient\Result\Item\SurveyTest;
use ReflectionClass;
/**
* Test case of the processor of the raw data fetched while talking to the LimeSurvey's API
@@ -27,10 +26,7 @@ class ResultProcessorTest extends BaseTestCase
{
public function testConstructorVisibilityAndArguments()
{
$reflection = new ReflectionClass(ResultProcessor::class);
$constructor = $reflection->getConstructor();
static::assertNull($constructor);
static::assertHasNoConstructor(ResultProcessor::class);
}
public function testProcessWithEmptyRawData()
@@ -68,7 +64,7 @@ class ResultProcessorTest extends BaseTestCase
public function testGetItemInstanceVisibilityAndArguments()
{
$this->verifyMethodVisibilityAndArguments(ResultProcessor::class, 'getItemInstance', OopVisibilityType::IS_PRIVATE, 1, 1);
static::assertMethodVisibilityAndArguments(ResultProcessor::class, 'getItemInstance', OopVisibilityType::IS_PRIVATE, 1, 1);
}
public function testRunWithUnknownResultClass()

View File

@@ -71,7 +71,7 @@ class ResultTest extends BaseTestCase
public function testConstructorVisibilityAndArguments()
{
$this->verifyConstructorVisibilityAndArguments(Result::class, OopVisibilityType::IS_PUBLIC, 2, 2);
static::assertConstructorVisibilityAndArguments(Result::class, OopVisibilityType::IS_PUBLIC, 2, 2);
}
public function testIsEmpty()
@@ -112,12 +112,12 @@ class ResultTest extends BaseTestCase
public function testGetProcessedDataVisibilityAndArguments()
{
$this->verifyMethodVisibilityAndArguments(Result::class, 'getProcessedData', OopVisibilityType::IS_PRIVATE, 1, 1);
static::assertMethodVisibilityAndArguments(Result::class, 'getProcessedData', OopVisibilityType::IS_PRIVATE, 1, 1);
}
public function testGetResultProcessorVisibilityAndArguments()
{
$this->verifyMethodVisibilityAndArguments(Result::class, 'getResultProcessor', OopVisibilityType::IS_PRIVATE);
static::assertMethodVisibilityAndArguments(Result::class, 'getResultProcessor', OopVisibilityType::IS_PRIVATE);
}
/**

View File

@@ -0,0 +1,186 @@
<?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\Collection\Participants;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Participant;
use Meritoo\LimeSurvey\ApiClient\Service\ParticipantService;
use PHPUnit_Framework_MockObject_MockObject;
/**
* Test case of the service that serves participants
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class ParticipantServiceTest extends BaseTestCase
{
/**
* Serves participants.
* Service without participants.
*
* @var ParticipantService
*/
private $serviceWithoutParticipants;
/**
* Serves participants.
* Service with participants.
*
* @var ParticipantService
*/
private $serviceWithParticipants;
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(ParticipantService::class, OopVisibilityType::IS_PUBLIC, 2, 1);
}
public function testGetSurveyParticipantsFromEmptyParticipants()
{
$rpcClientManager = $this->getJsonRpcClientManager(3);
$sessionManager = $this->getSessionManager();
$this->createServiceWithoutParticipants($rpcClientManager, $sessionManager);
$this->createServiceWithParticipants($rpcClientManager, $sessionManager);
static::assertCount(0, $this->serviceWithoutParticipants->getSurveyParticipants(1));
static::assertCount(0, $this->serviceWithoutParticipants->getSurveyParticipants(2));
static::assertCount(2, $this->serviceWithParticipants->getSurveyParticipants(1));
static::assertCount(1, $this->serviceWithParticipants->getSurveyParticipants(2));
static::assertCount(0, $this->serviceWithParticipants->getSurveyParticipants(3));
}
public function testHasParticipant()
{
$rpcClientManager = $this->getJsonRpcClientManager(3);
$sessionManager = $this->getSessionManager();
$this->createServiceWithoutParticipants($rpcClientManager, $sessionManager);
$this->createServiceWithParticipants($rpcClientManager, $sessionManager);
static::assertFalse($this->serviceWithoutParticipants->hasParticipant(1, 'john@scott.com'));
static::assertFalse($this->serviceWithoutParticipants->hasParticipant(2, 'john@scott.com'));
static::assertTrue($this->serviceWithParticipants->hasParticipant(1, 'john@scott.com'));
static::assertFalse($this->serviceWithParticipants->hasParticipant(2, 'john@scott.com'));
static::assertFalse($this->serviceWithParticipants->hasParticipant(3, 'john@scott.com'));
}
public function testAddParticipant()
{
$firstName = 'John';
$lastName = 'Scott';
$email = 'john@scott.com';
$runMethodCallCount = 1;
$runMethodCallResults = [
[
'firstname' => $firstName,
'lastname' => $lastName,
'email' => $email,
],
];
$rpcClientManager = $this->getJsonRpcClientManager($runMethodCallCount, $runMethodCallResults);
$sessionManager = $this->getSessionManager();
$this->createServiceWithoutParticipants($rpcClientManager, $sessionManager);
$result = $this->serviceWithoutParticipants->addParticipant(1, $firstName, $lastName, $email);
static::assertInstanceOf(Participant::class, $result);
}
/**
* 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 participants
*
* @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 createServiceWithoutParticipants(PHPUnit_Framework_MockObject_MockObject $rpcClientManager, PHPUnit_Framework_MockObject_MockObject $sessionManager)
{
$configuration = $this->getConnectionConfiguration();
$client = new Client($configuration, $rpcClientManager, $sessionManager);
$this->serviceWithoutParticipants = new ParticipantService($client);
}
/**
* Creates instance of the tested service with participants
*
* @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 createServiceWithParticipants(PHPUnit_Framework_MockObject_MockObject $rpcClientManager, PHPUnit_Framework_MockObject_MockObject $sessionManager)
{
$configuration = $this->getConnectionConfiguration();
$client = new Client($configuration, $rpcClientManager, $sessionManager);
$allParticipants = new Participants([
1 => new Collection([
(new Participant())->setValues([
'firstname' => 'John',
'lastname' => 'Scott',
'email' => 'john@scott.com',
]),
new Participant(),
]),
2 => new Collection([
new Participant(),
]),
]);
$this->serviceWithParticipants = new ParticipantService($client, $allParticipants);
}
}

View File

@@ -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);
}
}

View File

@@ -21,6 +21,11 @@ use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
*/
class MethodTypeTest extends BaseTypeTestCase
{
public function testConstructorVisibilityAndArguments()
{
static::assertHasNoConstructor(MethodType::class);
}
/**
* @param string $incorrectMethod Type of method to verify
* @dataProvider provideIncorrectMethod
@@ -157,6 +162,7 @@ class MethodTypeTest extends BaseTypeTestCase
protected function getAllExpectedTypes()
{
return [
'ADD_PARTICIPANTS' => MethodType::ADD_PARTICIPANTS,
'ADD_RESPONSE' => MethodType::ADD_RESPONSE,
'EXPORT_STATISTICS' => MethodType::EXPORT_STATISTICS,
'GET_PARTICIPANT_PROPERTIES' => MethodType::GET_PARTICIPANT_PROPERTIES,

View File

@@ -19,6 +19,11 @@ use Meritoo\LimeSurvey\ApiClient\Type\SystemMethodType;
*/
class SystemMethodTypeTest extends BaseTypeTestCase
{
public function testConstructorVisibilityAndArguments()
{
static::assertHasNoConstructor(SystemMethodType::class);
}
/**
* {@inheritdoc}
*/