46 Commits
0.0.1 ... 0.0.8

Author SHA1 Message Date
Meritoo
db6a6f22e2 ParticipantService - getParticipantDetails() method - returns full data of participant with given e-mail of given survey 2017-10-01 20:51:13 +02:00
Meritoo
f5334f816f Participants collection - store instances of ParticipantShort instead of Participant
Related to fetch full data of participant of given survey
2017-10-01 20:50:17 +02:00
Meritoo
e43712f218 Minor refactoring 2017-10-01 20:43:39 +02:00
Meritoo
e464ae30af SurveyService - getStartSurveyUrl() method - returns url used to start survey for given survey and participant 2017-10-01 18:34:56 +02:00
Meritoo
98cad233d9 Minor refactoring 2017-10-01 18:20:58 +02:00
Meritoo
5154f05ee4 ParticipantService - hasParticipantFilledSurvey() method - fix "Response: HTTP/1.1 500 Internal Server Error" bug while trying to get information if participant has filled survey 2017-10-01 15:01:54 +02:00
Meritoo
0c44140c89 MissingParticipantOfSurveyException - fix message 2017-10-01 13:42:42 +02:00
Meritoo
41156ed058 Participants collection - store instances of ParticipantShort instead of Participant
Required to fix bug "Call to undefined method Meritoo\LimeSurvey\ApiClient\Result\Item\ParticipantShort::isCompleted() in /src/Service/ParticipantService.php on line 206"
2017-10-01 13:42:35 +02:00
Meritoo
54bd0ca114 SurveyService - allow to verify if survey with given ID exists and if is active 2017-09-29 23:55:56 +02:00
Meritoo
5243294bd5 Implement Surveys class, collection of surveys, to work with surveys 2017-09-29 22:51:42 +02:00
Meritoo
6159731768 Base class for one item - add class constructor & allow to set values directly in the constructor 2017-09-29 22:10:13 +02:00
Meritoo
bbd466610c Tests - add missing tests of Participants::addParticipant() method for not existing survey 2017-09-29 19:47:42 +02:00
Meritoo
d54765b378 SurveyService - getAllSurveys() method - catch and serve an exception while fetching all surveys 2017-09-29 16:55:04 +02:00
Meritoo
ab328b96ee ParticipantService - getSurveyParticipants() method - catch and serve an exception while fetching participants of given survey 2017-09-29 15:18:31 +02:00
Meritoo
cd6dbf72bc Tests - add missing tests of Participants::addParticipant() method 2017-09-29 15:16:17 +02:00
Meritoo
beaf61d2ea Participants collection - disable method has(), because hasParticipantsOfSurvey() should be used to verify if there are participants of given survey 2017-09-29 15:07:26 +02:00
Meritoo
cacb2b3b92 ParticipantService - getParticipant() method - get all participants of survey first (to avoid problem when participants exist but are not loaded) 2017-09-29 14:20:31 +02:00
Meritoo
dfa64fee43 ParticipantService - getParticipant() & hasParticipantFilledSurvey() methods - returns participant of survey & information if participant has filled survey 2017-09-29 13:35:26 +02:00
Meritoo
6c44a62f36 Item of result - setting values - make stronger comparison for boolean values 2017-09-29 13:17:40 +02:00
Meritoo
4f26bca282 Minor refactoring 2017-09-29 10:31:04 +02:00
Meritoo
dbd0a65286 composer.json - move tests-related classes to "autoload-dev" section (used for development purposes only and avoid polluting the autoloader in production) 2017-09-29 09:24:57 +02:00
Meritoo
0562cb4d21 ParticipantService & SurveyService - allow to get a client from these services (add getters) 2017-09-28 21:34:31 +02:00
Meritoo
f8a675d0fb Tests - Client - verify null returned as raw data by JsonRpcClient 2017-09-28 20:34:33 +02:00
Meritoo
a5b534b00d Client - allow to get configuration of connection (add getter) 2017-09-28 20:29:50 +02:00
Meritoo
a6866d994c Configuration of connecting - do not allow to change (remove setters) 2017-09-28 20:13:54 +02:00
Meritoo
5061f5a295 Minor refactoring 2017-09-28 19:43:02 +02:00
Meritoo
f5de59f50b Minor refactoring 2017-09-27 22:56:38 +02:00
Meritoo
6e54d39972 ConnectionConfiguration - $verifySslCertificate property - fix setting value by constructor 2017-09-27 22:32:20 +02:00
Meritoo
b3b0e66fb3 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.
2017-09-27 21:32:28 +02:00
Meritoo
0fbfc9780d Remove composer.lock 2017-09-27 21:29:51 +02:00
Meritoo
92315bd853 Minor refactoring 2017-09-27 12:28:51 +02:00
Meritoo
c3e6935dd8 ResultProcessor - fix bug when iterable data with multiple items was returned 2017-09-26 22:18:14 +02:00
Meritoo
07bc4ab4af Result - store status provided by the LimeSurvey's API (instead of raw data) & do not process the data (because it's unknown) 2017-09-26 21:41:04 +02:00
Meritoo
fd1ec32e1a Minor refactoring 2017-09-26 21:18:54 +02:00
Meritoo
72480ecc27 Tests - test cases of exceptions 2017-09-26 14:39:00 +02:00
Meritoo
20d7d2f50d Catch an exception while running method (e.g. "Malformed payload") & throw custom exception 2017-09-26 12:49:59 +02:00
Meritoo
f5bafdc969 Minor refactoring 2017-09-26 12:19:03 +02:00
Meritoo
0eb6cc85a2 Fix bug while releasing session key:
Uncaught exception 'Meritoo\LimeSurvey\ApiClient\Exception\UnknownMethodException' with message 'The 'get_session_key' type of name of method used while talking to the LimeSurvey's API is unknown
2017-09-26 09:14:10 +02:00
Meritoo
e803d82844 Composer - update packages 2017-09-25 21:41:23 +02:00
Meritoo
01439aaa1f SurveyService - a service that serves surveys 2017-09-25 21:17:31 +02:00
Meritoo
844f04c877 ParticipantService - a service that serves participants 2017-09-25 21:17:06 +02:00
Meritoo
959e9481fd ResultProcessor - add support of the "add_participants" method 2017-09-25 21:10:54 +02:00
Meritoo
af2df98d14 Client - run() method - use an empty array when raw data is unknown/null 2017-09-25 21:08:24 +02:00
Meritoo
d0badf1ec6 Tests - implement BaseTestCase::assert*() methods to verify constructors 2017-09-22 19:26:03 +02:00
Meritoo
2dc215a3e4 Tests - implement BaseTestCase::assert*() methods 2017-09-21 17:13:07 +02:00
Meritoo
10c0bf8e41 composer.json - update versions of the "dev" packages 2017-09-20 10:22:37 +02:00
57 changed files with 3042 additions and 3981 deletions

1
.gitignore vendored
View File

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

View File

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

3581
composer.lock generated

File diff suppressed because it is too large Load Diff

View File

@@ -16,13 +16,32 @@ namespace Meritoo\LimeSurvey\ApiClient\Base\Result;
*/ */
abstract class BaseItem abstract class BaseItem
{ {
/**
* Class constructor
*
* @param array $data (optional) Data to set in properties of the item
*/
public function __construct(array $data = [])
{
$this->setValues($data);
}
/**
* Sets given value in given property
*
* @param string $property Name of property to set the value
* @param mixed $value Value to set in property
* @return mixed
*/
abstract public function setValue($property, $value);
/** /**
* Sets values in each property of the item * Sets values in each property of the item
* *
* @param array $data Data to set in properties of the item * @param array $data Data to set in properties of the item
* @return $this * @return $this
*/ */
public function setValues($data) private function setValues(array $data)
{ {
/* /*
* Oops, no data * Oops, no data
@@ -40,13 +59,4 @@ abstract class BaseItem
return $this; return $this;
} }
/**
* Sets given value in given property
*
* @param string $property Name of property to set the value
* @param mixed $value Value to set in property
* @return mixed
*/
abstract public function setValue($property, $value);
} }

View File

@@ -77,7 +77,8 @@ class Client
public function run($method, $arguments = []) public function run($method, $arguments = [])
{ {
/* /*
* Let's validate method * Let's validate method.
* It's called in the JsonRpcClientManager::runMethod() too, but I want to verify it before getting session key.
*/ */
$method = MethodType::getValidatedMethod($method); $method = MethodType::getValidatedMethod($method);
@@ -92,7 +93,7 @@ class Client
->getSessionKey($username, $password); ->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); array_unshift($arguments, $sessionKey);
@@ -103,9 +104,31 @@ class Client
->getRpcClientManager() ->getRpcClientManager()
->runMethod($method, $arguments); ->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); return new Result($method, $rawData);
} }
/**
* Returns configuration used while connecting to LimeSurvey's API
*
* @return ConnectionConfiguration
*/
public function getConfiguration()
{
return $this->configuration;
}
/** /**
* Returns manager of the JsonRPC client used while connecting to LimeSurvey's API * Returns manager of the JsonRPC client used while connecting to LimeSurvey's API
* *

View File

@@ -59,21 +59,33 @@ class ConnectionConfiguration
*/ */
private $debugMode = false; 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 * Class constructor
* *
* @param string $baseUrl Base url. Protocol & domain. * @param string $baseUrl Base url. Protocol & domain.
* @param string $username Name of user used to authenticate to LimeSurvey * @param string $username Name of user used to authenticate to LimeSurvey
* @param string $password Password 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 $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 $this->setBaseUrl($baseUrl);
->setBaseUrl($baseUrl)
->setUsername($username) $this->username = $username;
->setPassword($password) $this->password = $password;
->setDebugMode($debugMode); $this->debugMode = $debugMode;
$this->verifySslCertificate = $verifySslCertificate;
} }
/** /**
@@ -86,29 +98,6 @@ class ConnectionConfiguration
return $this->baseUrl; return $this->baseUrl;
} }
/**
* Sets the base url, protocol & domain
*
* @param string $baseUrl The base url, protocol & domain
* @return $this
*
* @throws InvalidUrlException
*/
public function setBaseUrl($baseUrl)
{
if (!Regex::isValidUrl($baseUrl)) {
throw new InvalidUrlException($baseUrl);
}
if (Regex::endsWith($baseUrl, '/')) {
$baseUrl = substr($baseUrl, 0, strlen($baseUrl) - 1);
}
$this->baseUrl = $baseUrl;
return $this;
}
/** /**
* Returns the url of the LimeSurvey's remote control * Returns the url of the LimeSurvey's remote control
* *
@@ -142,19 +131,6 @@ class ConnectionConfiguration
return $this->username; return $this->username;
} }
/**
* Sets the name of user used to authenticate to LimeSurvey
*
* @param string $username The name of user used to authenticate to LimeSurvey
* @return $this
*/
public function setUsername($username)
{
$this->username = $username;
return $this;
}
/** /**
* Returns the password used to authenticate to LimeSurvey * Returns the password used to authenticate to LimeSurvey
* *
@@ -165,19 +141,6 @@ class ConnectionConfiguration
return $this->password; return $this->password;
} }
/**
* Sets the password used to authenticate to LimeSurvey
*
* @param string $password The password used to authenticate to LimeSurvey
* @return $this
*/
public function setPassword($password)
{
$this->password = $password;
return $this;
}
/** /**
* Returns information if the "debug" mode is turned on * Returns information if the "debug" mode is turned on
* *
@@ -189,24 +152,15 @@ class ConnectionConfiguration
} }
/** /**
* Sets information if the "debug" mode is turned on * Returns information if the SSL certificate verification is turned on
* *
* @param bool $debugMode (optional) If is set to true, the "debug" mode is turned on. Otherwise - turned off. * @return bool
* @return $this
*/ */
public function setDebugMode($debugMode = false) public function isVerifySslCertificateOn()
{ {
$this->debugMode = $debugMode; return $this->verifySslCertificate;
return $this;
} }
/*
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
* Additional / extra methods (neither getters, nor setters)
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
*/
/** /**
* Returns full url of the LimeSurvey's API. * Returns full url of the LimeSurvey's API.
* It's a base url with part related to remote control. * It's a base url with part related to remote control.
@@ -217,4 +171,27 @@ class ConnectionConfiguration
{ {
return sprintf('%s/%s', $this->baseUrl, $this->remoteControlUrl); return sprintf('%s/%s', $this->baseUrl, $this->remoteControlUrl);
} }
/**
* Sets the base url, protocol & domain
*
* @param string $baseUrl The base url, protocol & domain
* @return $this
*
* @throws InvalidUrlException
*/
private function setBaseUrl($baseUrl)
{
if (!Regex::isValidUrl($baseUrl)) {
throw new InvalidUrlException($baseUrl);
}
if (Regex::endsWith($baseUrl, '/')) {
$baseUrl = substr($baseUrl, 0, strlen($baseUrl) - 1);
}
$this->baseUrl = $baseUrl;
return $this;
}
} }

View File

@@ -0,0 +1,50 @@
<?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
{
/**
* Reason why data cannot be processed, e.g. "Invalid user name or password"
*
* @var string
*/
private $reason;
/**
* Class constructor
*
* @param string $reason Reason why data cannot be processed, e.g. "Invalid user name or password"
*/
public function __construct($reason)
{
$this->reason = $reason;
$template = 'Raw data returned by the LimeSurvey\'s API cannot be processed. Reason: \'%s\'.';
$message = sprintf($template, $this->reason);
parent::__construct($message);
}
/**
* Returns reason why data cannot be processed, e.g. "Invalid user name or password"
*
* @return string
*/
public function getReason()
{
return $this->reason;
}
}

View File

@@ -0,0 +1,35 @@
<?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;
use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem;
/**
* An exception used while class used to create instance of one item of the result, with data fetched from the
* LimeSurvey's API, is incorrect
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class IncorrectClassOfResultItemException extends \Exception
{
/**
* Class constructor
*
* @param string $className Incorrect class name used to create instance of one item
*/
public function __construct($className)
{
$template = 'Class %s used to create instance of one item of the result should extend %s, but it does not. Did'
. ' you forget to use proper base class?';
$message = sprintf($template, $className, BaseItem::class);
parent::__construct($message);
}
}

View File

@@ -0,0 +1,45 @@
<?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;
use Exception;
use Meritoo\Common\Utilities\Arrays;
/**
* An exception used when an error occurred while running method
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class InvalidResultOfMethodRunException extends Exception
{
/**
* Class constructor
*
* @param Exception $previousException The previous exception, source of an error
* @param string $methodName Name of called method
* @param array $methodArguments (optional) Arguments of the called method
*/
public function __construct(Exception $previousException, $methodName, array $methodArguments = [])
{
$template = "Oops, an error occurred while running method. Is there everything ok? Details:\n"
. "- error: %s,\n"
. "- method: %s,\n"
. '- arguments: %s.';
if (empty($methodArguments)) {
$methodArguments = '(no arguments)';
} else {
$methodArguments = Arrays::valuesKeys2string($methodArguments, ', ', '=', '"');
}
$message = sprintf($template, $previousException->getMessage(), $methodName, $methodArguments);
parent::__construct($message, $previousException->getCode());
}
}

View File

@@ -0,0 +1,32 @@
<?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 when participant of survey is missing
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class MissingParticipantOfSurveyException extends \Exception
{
/**
* Class constructor
*
* @param int $surveyId ID of survey
* @param string $email E-mail address of the participant
*/
public function __construct($surveyId, $email)
{
$template = 'Participant with e-mail %s of survey with ID %s is missing. Maybe was not added to the survey?';
$message = sprintf($template, $email, $surveyId);
parent::__construct($message);
}
}

View File

@@ -1,12 +1,19 @@
<?php <?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; namespace Meritoo\LimeSurvey\ApiClient\Exception;
use Exception; use Exception;
use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor; use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
/** /**
* An exception used while instance of one item used by result, with data fetched from the LimeSurvey's API, is unknown * An exception used while class name used to create instance of one item of the result, with data fetched from the
* LimeSurvey's API, is unknown
* *
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl> * @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl * @copyright Meritoo.pl
@@ -21,10 +28,10 @@ class UnknownInstanceOfResultItem extends Exception
*/ */
public function __construct($method) public function __construct($method)
{ {
$template = 'Instance of one item used by result the of \'%s\' LimeSurvey API\'s method is unknown. Proper' $template = 'Class name used to create instance of one item used by result the of \'%s\' LimeSurvey API\'s'
. ' class is not mapped in %s::%s() method. Did you forget about this?'; . ' method is unknown. Proper class is not mapped in %s::%s() method. Did you forget about this?';
$message = sprintf($template, $method, ResultProcessor::class, 'getItemInstance'); $message = sprintf($template, $method, ResultProcessor::class, 'getItemClassName');
parent::__construct($message); parent::__construct($message);
} }
} }

View File

@@ -3,7 +3,9 @@
namespace Meritoo\LimeSurvey\ApiClient\Manager; namespace Meritoo\LimeSurvey\ApiClient\Manager;
use JsonRPC\Client as RpcClient; use JsonRPC\Client as RpcClient;
use JsonRPC\Exception\InvalidJsonFormatException;
use Meritoo\LimeSurvey\ApiClient\Configuration\ConnectionConfiguration; use Meritoo\LimeSurvey\ApiClient\Configuration\ConnectionConfiguration;
use Meritoo\LimeSurvey\ApiClient\Exception\InvalidResultOfMethodRunException;
use Meritoo\LimeSurvey\ApiClient\Exception\UnknownMethodException; use Meritoo\LimeSurvey\ApiClient\Exception\UnknownMethodException;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType; use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
@@ -47,14 +49,22 @@ class JsonRpcClientManager
* @return mixed * @return mixed
* *
* @throws UnknownMethodException * @throws UnknownMethodException
* @throws InvalidResultOfMethodRunException
*/ */
public function runMethod($method, $arguments = []) public function runMethod($method, $arguments = [])
{ {
$result = null;
$method = MethodType::getValidatedMethod($method); $method = MethodType::getValidatedMethod($method);
return $this try {
$result = $this
->getRpcClient() ->getRpcClient()
->execute($method, $arguments); ->execute($method, $arguments);
} catch (InvalidJsonFormatException $exception) {
throw new InvalidResultOfMethodRunException($exception, $method);
}
return $result;
} }
/** /**
@@ -75,7 +85,20 @@ class JsonRpcClientManager
* The "debug" mode is turned on? * The "debug" mode is turned on?
*/ */
if ($this->connectionConfiguration->isDebugModeOn()) { 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();
} }
} }

View File

@@ -0,0 +1,151 @@
<?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\ParticipantShort;
/**
* Collection of participants (of surveys).
* 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');
}
/**
* {@inheritdoc}
*/
public function has($element)
{
throw new DisabledMethodException(__METHOD__, 'hasParticipantsOfSurvey');
}
/**
* Adds participants of given survey
*
* @param Collection $participants Participants to add. Collection of ParticipantShort 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 ParticipantShort $participant Participant to add
* @param int $surveyId ID of survey
* @return $this
*/
public function addParticipant(ParticipantShort $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 ParticipantShort|null
*/
public function getParticipantOfSurvey($surveyId, $participantEmail)
{
/* @var Collection $participants */
$participants = $this->getBySurvey($surveyId);
if ($participants->isEmpty()) {
return null;
}
/* @var ParticipantShort $participant */
foreach ($participants as $participant) {
if ($participant->getEmail() == $participantEmail) {
return $participant;
}
}
return null;
}
}

View File

@@ -0,0 +1,58 @@
<?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\LimeSurvey\ApiClient\Result\Item\Survey;
/**
* Collection of surveys (the Survey class instances)
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class Surveys extends Collection
{
/**
* {@inheritdoc}
*/
public function add($element, $index = null)
{
if (null === $index) {
/* @var Survey $element */
$index = $element->getId();
}
return parent::add($element, $index);
}
/**
* Returns all or active only surveys
*
* @param bool $onlyActive (optional) If is set to true, active surveys are returned only. Otherwise - all.
* @return $this
*/
public function getAll($onlyActive = false)
{
if ($this->isEmpty() || !$onlyActive) {
return $this;
}
$all = new static();
/* @var Survey $survey */
foreach ($this as $survey) {
if ($survey->isActive()) {
$all->add($survey);
}
}
return $all;
}
}

View File

@@ -13,7 +13,7 @@ use Meritoo\Common\Utilities\Date;
use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem; use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem;
/** /**
* One item of the result/data: full data of participant * One item of the result/data: full data of one participant
* *
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl> * @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl * @copyright Meritoo.pl
@@ -183,15 +183,15 @@ class Participant extends BaseItem
break; break;
case 'blacklisted': case 'blacklisted':
$this->blacklisted = 'Y' === trim($value); $this->blacklisted = 'Y' === trim(strtoupper($value));
break; break;
case 'sent': case 'sent':
$this->sent = 'Y' === trim($value); $this->sent = 'Y' === trim(strtoupper($value));
break; break;
case 'remindersent': case 'remindersent':
$this->reminderSent = 'Y' === trim($value); $this->reminderSent = 'Y' === trim(strtoupper($value));
break; break;
case 'remindercount': case 'remindercount':
@@ -199,7 +199,7 @@ class Participant extends BaseItem
break; break;
case 'completed': case 'completed':
$this->completed = 'Y' === trim($value); $this->completed = 'Y' === trim(strtoupper($value));
break; break;
case 'usesleft': case 'usesleft':

View File

@@ -103,4 +103,26 @@ class ParticipantShort extends BaseItem
{ {
return $this->email; return $this->email;
} }
/**
* Returns short data of participant created from full data of participant
*
* @param Participant $participant Full data of participant
* @return $this
*/
public static function fromParticipant(Participant $participant)
{
$info = [
'firstname' => $participant->getFirstName(),
'lastname' => $participant->getLastName(),
'email' => $participant->getEmail(),
];
$data = [
'tid' => $participant->getId(),
'participant_info' => $info,
];
return new self($data);
}
} }

View File

@@ -193,11 +193,11 @@ class QuestionShort extends BaseItem
break; break;
case 'other': case 'other':
$this->other = 'Y' === trim($value); $this->other = 'Y' === trim(strtoupper($value));
break; break;
case 'mandatory': case 'mandatory':
$this->mandatory = 'Y' === trim($value); $this->mandatory = 'Y' === trim(strtoupper($value));
break; break;
case 'question_order': case 'question_order':

View File

@@ -86,7 +86,7 @@ class Survey extends BaseItem
break; break;
case 'active': case 'active':
$this->active = 'Y' === trim($value); $this->active = 'Y' === trim(strtoupper($value));
break; break;
} }
} }

View File

@@ -8,7 +8,9 @@
namespace Meritoo\LimeSurvey\ApiClient\Result\Processor; namespace Meritoo\LimeSurvey\ApiClient\Result\Processor;
use Meritoo\Common\Utilities\Reflection;
use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem; use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem;
use Meritoo\LimeSurvey\ApiClient\Exception\IncorrectClassOfResultItemException;
use Meritoo\LimeSurvey\ApiClient\Exception\UnknownInstanceOfResultItem; use Meritoo\LimeSurvey\ApiClient\Exception\UnknownInstanceOfResultItem;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Participant; use Meritoo\LimeSurvey\ApiClient\Result\Item\Participant;
use Meritoo\LimeSurvey\ApiClient\Result\Item\ParticipantShort; use Meritoo\LimeSurvey\ApiClient\Result\Item\ParticipantShort;
@@ -31,7 +33,9 @@ class ResultProcessor
* @param string $method Name of called method while talking to the LimeSurvey's API. One of the MethodType * @param string $method Name of called method while talking to the LimeSurvey's API. One of the MethodType
* class constants. * class constants.
* @param array $rawData Data returned by the LimeSurvey's API * @param array $rawData Data returned by the LimeSurvey's API
* @return null|BaseItem|array * @return array|BaseItem|null
*
* @throws IncorrectClassOfResultItemException
*/ */
public function process($method, array $rawData) public function process($method, array $rawData)
{ {
@@ -46,59 +50,61 @@ class ResultProcessor
} }
/* /*
* Prepare instance of one item * Prepare class name for instance of one item
*/ */
$item = $this->getItemInstance($method); $itemClassName = $this->getItemClassName($method);
/* /*
* The raw data is or, actually, should be iterable? * The raw data is or, actually, should be iterable?
*/ */
if (MethodType::isResultIterable($method)) { if (MethodType::isResultIterable($method)) {
$items = []; $items = [];
$emptyItem = clone $item;
foreach ($rawData as $itemData) { foreach ($rawData as $itemData) {
$items[] = $emptyItem->setValues($itemData); $items[] = new $itemClassName($itemData);
} }
return $items; return $items;
} }
return $item->setValues($rawData); return new $itemClassName($rawData);
} }
/** /**
* Returns instance of one item of the result * Returns class name used to create instance of one item of the result
* *
* @param string $method Name of called method while talking to the LimeSurvey's API. One of the MethodType * @param string $method Name of called method while talking to the LimeSurvey's API. One of the MethodType
* class constants. * class constants.
* @return BaseItem * @return string
*
* @throws IncorrectClassOfResultItemException
* @throws UnknownInstanceOfResultItem * @throws UnknownInstanceOfResultItem
*/ */
private function getItemInstance($method) private function getItemClassName($method)
{ {
$item = null; $className = null;
$method = MethodType::getValidatedMethod($method); $method = MethodType::getValidatedMethod($method);
switch ($method) { switch ($method) {
case MethodType::ADD_PARTICIPANTS:
case MethodType::GET_PARTICIPANT_PROPERTIES: case MethodType::GET_PARTICIPANT_PROPERTIES:
$item = new Participant(); $className = Participant::class;
break; break;
case MethodType::GET_QUESTION_PROPERTIES: case MethodType::GET_QUESTION_PROPERTIES:
$item = new Question(); $className = Question::class;
break; break;
case MethodType::LIST_PARTICIPANTS: case MethodType::LIST_PARTICIPANTS:
$item = new ParticipantShort(); $className = ParticipantShort::class;
break; break;
case MethodType::LIST_QUESTIONS: case MethodType::LIST_QUESTIONS:
$item = new QuestionShort(); $className = QuestionShort::class;
break; break;
case MethodType::LIST_SURVEYS: case MethodType::LIST_SURVEYS:
$item = new Survey(); $className = Survey::class;
break; break;
/* /*
@@ -107,12 +113,19 @@ class ResultProcessor
} }
/* /*
* Instance of the item is unknown? * Oops, class name for instance of the item is unknown
*/ */
if (null === $item) { if (null === $className) {
throw new UnknownInstanceOfResultItem($method); throw new UnknownInstanceOfResultItem($method);
} }
return $item; if (Reflection::isChildOfClass($className, BaseItem::class)) {
return $className;
}
/*
* Oops, class is incorrect (should extend BaseItem)
*/
throw new IncorrectClassOfResultItemException($className);
} }
} }

View File

@@ -10,6 +10,7 @@ namespace Meritoo\LimeSurvey\ApiClient\Result;
use Meritoo\Common\Collection\Collection; use Meritoo\Common\Collection\Collection;
use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem; use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem;
use Meritoo\LimeSurvey\ApiClient\Exception\CannotProcessDataException;
use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor; use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType; use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
@@ -35,6 +36,13 @@ class Result
*/ */
private $rawData; 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 * 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) public function __construct($method, array $rawData)
{ {
$this->method = MethodType::getValidatedMethod($method); $this->method = MethodType::getValidatedMethod($method);
$this->rawData = $rawData; $this->setRawDataAndStatus($rawData);
} }
/** /**
@@ -71,16 +79,43 @@ class Result
* @param bool $raw (optional) If is set to true, raw data provided by the LimeSurvey's API will be returned. * @param bool $raw (optional) If is set to true, raw data provided by the LimeSurvey's API will be returned.
* Otherwise - prepared/processed. * Otherwise - prepared/processed.
* @return array|Collection|BaseItem * @return array|Collection|BaseItem
* @throws CannotProcessDataException
*/ */
public function getData($raw = false) public function getData($raw = false)
{ {
/*
* Raw data should be returned only?
* Let's do it
*/
if ($raw) { if ($raw) {
return $this->rawData; return $this->rawData;
} }
/*
* Status is unknown?
* Let's process the raw data
*/
if (empty($this->status)) {
return $this->getProcessedData($this->rawData); 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;
}
/** /**
* Returns processed data based on the raw data returned by the LimeSurvey's API * Returns processed data based on the raw data returned by the LimeSurvey's API
* *
@@ -93,7 +128,11 @@ class Result
->getResultProcessor() ->getResultProcessor()
->process($this->method, $rawData); ->process($this->method, $rawData);
if (null === $processed || is_array($processed)) { /*
* Result is unknown and it should be iterable the result is an array?
* Let's prepare and return collection
*/
if ((null === $processed && MethodType::isResultIterable($this->method)) || is_array($processed)) {
$collection = new Collection(); $collection = new Collection();
if (is_array($processed)) { if (is_array($processed)) {
@@ -119,4 +158,23 @@ class Result
return $this->resultProcessor; 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;
}
} }

View File

@@ -0,0 +1,255 @@
<?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\Exception\CannotProcessDataException;
use Meritoo\LimeSurvey\ApiClient\Exception\MissingParticipantOfSurveyException;
use Meritoo\LimeSurvey\ApiClient\Result\Collection\Participants;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Participant;
use Meritoo\LimeSurvey\ApiClient\Result\Item\ParticipantShort;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
use Meritoo\LimeSurvey\ApiClient\Type\ReasonType;
/**
* Service that serves participants
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class ParticipantService
{
/**
* Client of the LimeSurvey's API
*
* @var Client
*/
private $client;
/**
* Collection of participants (of surveys).
* All participants grouped per survey.
*
* @var Participants
*/
private $allParticipants;
/**
* Class constructor
*
* @param Client $client Client of the LimeSurvey's API
* @param Participants $allParticipants (optional) Collection of participants (of surveys). 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 client of the LimeSurvey's API
*
* @return Client
*/
public function getClient()
{
return $this->client;
}
/**
* Returns participants of given survey
*
* @param int $surveyId ID of survey
* @return Collection
*
* @throws CannotProcessDataException
*/
public function getSurveyParticipants($surveyId)
{
$hasSurvey = $this
->allParticipants
->hasParticipantsOfSurvey($surveyId);
if (!$hasSurvey) {
$arguments = [
$surveyId,
];
try {
$participants = $this
->client
->run(MethodType::LIST_PARTICIPANTS, $arguments)
->getData();
} catch (CannotProcessDataException $exception) {
$reason = $exception->getReason();
/*
* Reason of the exception is different than "Oops, there is no participants. Everything else is fine."?
* Let's throw the exception
*/
if (ReasonType::NO_PARTICIPANTS_FOUND !== $reason) {
throw $exception;
}
$participants = new Collection();
}
$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();
/* @var Participant $addedParticipant */
$addedParticipant = $participantCollection->getFirst();
$participants = new Collection([
ParticipantShort::fromParticipant($addedParticipant),
]);
$this
->allParticipants
->addParticipants($participants, $surveyId);
return $participantCollection->getFirst();
}
/**
* Returns short data of one participant with given e-mail of given survey
*
* @param int $surveyId ID of survey
* @param string $email E-mail address of the participant
* @return ParticipantShort|null
*/
public function getParticipant($surveyId, $email)
{
/*
* I have to get all participants of survey to avoid problem when participants exist but are not loaded
*/
$this->getSurveyParticipants($surveyId);
return $this
->allParticipants
->getParticipantOfSurvey($surveyId, $email);
}
/**
* Returns full data of participant with given e-mail of given survey
*
* @param int $surveyId ID of survey
* @param string $email E-mail address of the participant
* @return Participant|null
*/
public function getParticipantDetails($surveyId, $email)
{
$arguments = [
$surveyId,
[
'email' => $email,
],
];
$participant = $this
->client
->run(MethodType::GET_PARTICIPANT_PROPERTIES, $arguments)
->getData();
/* @var Participant $participant */
return $participant;
}
/**
* Returns information if participant with given e-mail has filled given survey
*
* @param int $surveyId ID of survey
* @param string $email E-mail address of the participant
* @return bool
*
* @throws MissingParticipantOfSurveyException
*/
public function hasParticipantFilledSurvey($surveyId, $email)
{
if ($this->hasParticipant($surveyId, $email)) {
$arguments = [
$surveyId,
[
'email' => $email,
],
];
/* @var Participant $participant */
$participant = $this
->client
->run(MethodType::GET_PARTICIPANT_PROPERTIES, $arguments)
->getData();
return true === $participant->isCompleted();
}
throw new MissingParticipantOfSurveyException($surveyId, $email);
}
}

View File

@@ -0,0 +1,168 @@
<?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\Exception\CannotProcessDataException;
use Meritoo\LimeSurvey\ApiClient\Result\Collection\Surveys;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Participant;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Survey;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
use Meritoo\LimeSurvey\ApiClient\Type\ReasonType;
/**
* Service that 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.
* Collection of surveys (the Survey class instances).
*
* @var Surveys
*/
private $allSurveys;
/**
* Template of the url used to start survey
*
* Example:
* - url: https://your.limesurvey.instance/12345?token=q1w2e3r4t5y6
* - LimeSurvey frontend: https://your.limesurvey.instance
* - survey ID: 12345
* - token: q1w2e3r4t5y6
*
* @var string
*/
private $startSurveyUrlTemplate = '%s/%d?token=%s';
/**
* Class constructor
*
* @param Client $client Client of the LimeSurvey's API
* @param Surveys $allSurveys (optional) All surveys. Collection of surveys (the Survey class instances).
*/
public function __construct(Client $client, Surveys $allSurveys = null)
{
if (null === $allSurveys) {
$allSurveys = new Surveys();
}
$this->client = $client;
$this->allSurveys = $allSurveys;
}
/**
* Returns client of the LimeSurvey's API
*
* @return Client
*/
public function getClient()
{
return $this->client;
}
/**
* Returns all surveys
*
* @param bool $onlyActive (optional) If is set to true, active surveys are returned only. Otherwise - all.
* @return Surveys
*
* @throws CannotProcessDataException
*/
public function getAllSurveys($onlyActive = false)
{
if ($this->allSurveys->isEmpty()) {
$surveys = new Surveys();
try {
$surveys = $this
->client
->run(MethodType::LIST_SURVEYS)
->getData();
} catch (CannotProcessDataException $exception) {
$reason = $exception->getReason();
/*
* Reason of the exception is different than "Oops, there is no surveys. Everything else is fine."?
* Let's throw the exception
*/
if (ReasonType::NO_SURVEYS_FOUND !== $reason) {
throw $exception;
}
}
if (null !== $surveys && $surveys instanceof Collection) {
$this->allSurveys = new Surveys($surveys->toArray());
}
}
return $this->allSurveys->getAll($onlyActive);
}
/**
* Returns information if survey with given ID exists
*
* @param int $surveyId ID of survey to verify
* @param bool $shouldBeActive (optional) If is set to true, survey should be active. If it's not, it shouldn't
* be returned, even if exists. Otherwise - it doesn't matter.
* @return bool
*/
public function isExistingSurvey($surveyId, $shouldBeActive = false)
{
$allSurveys = $this->getAllSurveys($shouldBeActive);
/*
* 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;
}
/**
* Returns url used to start survey for given survey and participant
*
* @param int $surveyId ID of survey to start
* @param Participant $participant Participant who would like to start survey
* @return string
*/
public function getStartSurveyUrl($surveyId, Participant $participant)
{
$baseUrl = $this
->client
->getConfiguration()
->getBaseUrl();
return sprintf($this->startSurveyUrlTemplate, $baseUrl, $surveyId, $participant->getToken());
}
}

View File

@@ -19,6 +19,16 @@ use Meritoo\LimeSurvey\ApiClient\Exception\UnknownMethodException;
*/ */
class MethodType extends BaseType 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. * Add a response to the survey responses collection.
* Returns the id of the inserted survey response. * Returns the id of the inserted survey response.
@@ -86,7 +96,7 @@ class MethodType extends BaseType
*/ */
public static function getValidatedMethod($method) public static function getValidatedMethod($method)
{ {
if ((new static())->isCorrectType($method)) { if ((new static())->isCorrectType($method) || (new SystemMethodType())->isCorrectType($method)) {
return $method; return $method;
} }
@@ -104,6 +114,7 @@ class MethodType extends BaseType
$method = static::getValidatedMethod($method); $method = static::getValidatedMethod($method);
return in_array($method, [ return in_array($method, [
static::ADD_PARTICIPANTS,
static::LIST_PARTICIPANTS, static::LIST_PARTICIPANTS,
static::LIST_QUESTIONS, static::LIST_QUESTIONS,
static::LIST_SURVEYS, static::LIST_SURVEYS,

42
src/Type/ReasonType.php Normal file
View File

@@ -0,0 +1,42 @@
<?php
namespace Meritoo\LimeSurvey\ApiClient\Type;
use Meritoo\Common\Type\Base\BaseType;
/**
* Type of reason used by LimeSurvey's exception
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class ReasonType extends BaseType
{
/**
* Reason of exception when there is no survey with given ID
*
* @var string
*/
const NOT_EXISTING_SURVEY_ID = 'Error: Invalid survey ID';
/**
* Reason of exception when there is no participants of survey
*
* @var string
*/
const NO_PARTICIPANTS_FOUND = 'No survey participants found.';
/**
* Reason of exception when there is no surveys
*
* @var string
*/
const NO_SURVEYS_FOUND = 'No surveys found';
/**
* Reason of exception when there is no table with tokens/participants of survey
*
* @var string
*/
const NO_TOKEN_TABLE = 'Error: No token table';
}

View File

@@ -0,0 +1,32 @@
<?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\Base\Result;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem;
/**
* Test case of the base class for one item of result/data fetched while talking to the LimeSurvey's API
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class BaseItemTest extends BaseTestCase
{
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(BaseItem::class, OopVisibilityType::IS_PUBLIC, 1, 0);
}
public function testSetValuesVisibilityAndArguments()
{
static::assertMethodVisibilityAndArguments(BaseItem::class, 'setValues', OopVisibilityType::IS_PRIVATE, 1, 1);
}
}

View File

@@ -34,6 +34,11 @@ class ClientTest extends BaseTestCase
*/ */
private $configuration; private $configuration;
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(Client::class, OopVisibilityType::IS_PUBLIC, 3, 1);
}
/** /**
* @param string $incorrectMethod Incorrect name of method to call * @param string $incorrectMethod Incorrect name of method to call
* @dataProvider provideIncorrectMethod * @dataProvider provideIncorrectMethod
@@ -50,10 +55,11 @@ class ClientTest extends BaseTestCase
* @param string $method Name of method to call * @param string $method Name of method to call
* @param array $arguments Arguments of the method to call * @param array $arguments Arguments of the method to call
* @param bool $debugMode If is set to true, the "debug" mode is turned on. Otherwise - turned off. * @param bool $debugMode If is set to true, the "debug" mode is turned on. Otherwise - turned off.
* @param mixed $expectedRawData Expected raw data returned by JsonRpcClient
* *
* @dataProvider provideMethod * @dataProvider provideMethod
*/ */
public function testRun($method, $arguments, $debugMode) public function testRun($method, $arguments, $debugMode, $expectedRawData)
{ {
$sessionManager = $this->createMock(SessionManager::class); $sessionManager = $this->createMock(SessionManager::class);
$rpcClientManager = $this->createMock(JsonRpcClientManager::class); $rpcClientManager = $this->createMock(JsonRpcClientManager::class);
@@ -61,22 +67,34 @@ class ClientTest extends BaseTestCase
$rpcClientManager $rpcClientManager
->expects(static::any()) ->expects(static::any())
->method('runMethod') ->method('runMethod')
->willReturn([]); ->willReturn($expectedRawData);
$this->configuration->setDebugMode($debugMode); $configuration = new ConnectionConfiguration(
$client = new Client($this->configuration, $rpcClientManager, $sessionManager); $this->configuration->getBaseUrl(),
$this->configuration->getUsername(),
$this->configuration->getPassword(),
$debugMode,
$this->configuration->isVerifySslCertificateOn()
);
$client = new Client($configuration, $rpcClientManager, $sessionManager);
static::assertInstanceOf(Result::class, $client->run($method, $arguments)); static::assertInstanceOf(Result::class, $client->run($method, $arguments));
} }
public function testGetConfiguration()
{
$client = new Client($this->configuration);
static::assertEquals($this->configuration, $client->getConfiguration());
}
public function testGetRpcClientManagerVisibilityAndArguments() public function testGetRpcClientManagerVisibilityAndArguments()
{ {
$this->verifyMethodVisibilityAndArguments(Client::class, 'getRpcClientManager', OopVisibilityType::IS_PRIVATE); static::assertMethodVisibilityAndArguments(Client::class, 'getRpcClientManager', OopVisibilityType::IS_PRIVATE);
} }
public function testGetSessionManagerVisibilityAndArguments() public function testGetSessionManagerVisibilityAndArguments()
{ {
$this->verifyMethodVisibilityAndArguments(Client::class, 'getRpcClientManager', OopVisibilityType::IS_PRIVATE); static::assertMethodVisibilityAndArguments(Client::class, 'getRpcClientManager', OopVisibilityType::IS_PRIVATE);
} }
/** /**
@@ -110,18 +128,21 @@ class ClientTest extends BaseTestCase
MethodType::GET_PARTICIPANT_PROPERTIES, MethodType::GET_PARTICIPANT_PROPERTIES,
[], [],
true, true,
[],
]; ];
yield[ yield[
MethodType::LIST_SURVEYS, MethodType::LIST_SURVEYS,
[], [],
false, false,
[],
]; ];
yield[ yield[
MethodType::LIST_PARTICIPANTS, MethodType::LIST_PARTICIPANTS,
[], [],
false, false,
null,
]; ];
/* /*

View File

@@ -0,0 +1,140 @@
<?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\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;
/**
* Test case of the configuration used while connecting to LimeSurvey's API
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class ConnectionConfigurationTest extends BaseTestCase
{
/**
* Configuration with default values of optional constructor's arguments
*
* @var ConnectionConfiguration
*/
private $configurationWithDefaults;
/**
* Configuration without default values of optional constructor's arguments
*
* @var ConnectionConfiguration
*/
private $configurationAnother;
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(ConnectionConfiguration::class, OopVisibilityType::IS_PUBLIC, 5, 3);
}
/**
* @param mixed $emptyBaseUrl Empty base url
* @dataProvider provideEmptyBaseUrl
*/
public function testConstructorWithEmptyBaseUrl($emptyBaseUrl)
{
$this->expectException(InvalidUrlException::class);
new ConnectionConfiguration($emptyBaseUrl, '', '');
}
/**
* @param string $invalidBaseUrl Invalid base url
* @dataProvider provideInvalidBaseUrl
*/
public function testConstructorWithInvalidBaseUrl($invalidBaseUrl)
{
$this->expectException(InvalidUrlException::class);
new ConnectionConfiguration($invalidBaseUrl, '', '');
}
public function testConstructor()
{
static::assertEquals('http://test.com', $this->configurationWithDefaults->getBaseUrl());
static::assertEquals('test1', $this->configurationWithDefaults->getUsername());
static::assertEquals('test2', $this->configurationWithDefaults->getPassword());
static::assertFalse($this->configurationWithDefaults->isDebugModeOn());
static::assertTrue($this->configurationWithDefaults->isVerifySslCertificateOn());
static::assertEquals('http://lets-test.com', $this->configurationAnother->getBaseUrl());
static::assertEquals('test11', $this->configurationAnother->getUsername());
static::assertEquals('test22', $this->configurationAnother->getPassword());
static::assertTrue($this->configurationAnother->isDebugModeOn());
static::assertFalse($this->configurationAnother->isVerifySslCertificateOn());
}
public function testGetRemoteControlUrl()
{
$this->configurationWithDefaults->setRemoteControlUrl('lorem/ipsum');
static::assertEquals('lorem/ipsum', $this->configurationWithDefaults->getRemoteControlUrl());
$this->configurationAnother->setRemoteControlUrl('dolor/sit');
static::assertEquals('dolor/sit', $this->configurationAnother->getRemoteControlUrl());
}
public function testGetFullUrl()
{
$this->configurationWithDefaults->setRemoteControlUrl('lorem/ipsum');
static::assertEquals('http://test.com/lorem/ipsum', $this->configurationWithDefaults->getFullUrl());
}
/**
* Provides empty base url
*
* @return Generator
*/
public function provideEmptyBaseUrl()
{
yield[
'',
];
yield[
null,
];
}
/**
* Provides invalid base url
*
* @return Generator
*/
public function provideInvalidBaseUrl()
{
yield[
'lorem',
];
yield[
'ipsum',
];
yield[
'htp:/dolor.com',
];
}
/**
* {@inheritdoc}
*/
protected function setUp()
{
parent::setUp();
$this->configurationWithDefaults = new ConnectionConfiguration('http://test.com', 'test1', 'test2');
$this->configurationAnother = new ConnectionConfiguration('http://lets-test.com/', 'test11', 'test22', true, false);
}
}

View File

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

View File

@@ -0,0 +1,61 @@
<?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\CreateSessionKeyFailedException;
/**
* Test case of an exception used while create of the session key has failed
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class CreateSessionKeyFailedExceptionTest extends BaseTestCase
{
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(CreateSessionKeyFailedException::class, OopVisibilityType::IS_PUBLIC, 1, 0);
}
/**
* @param string $reason Reason of failure, e.g. "Invalid user name or password"
* @param string $expectedMessage Expected exception's message
*
* @dataProvider provideReason
*/
public function testConstructorMessage($reason, $expectedMessage)
{
$exception = new CreateSessionKeyFailedException($reason);
static::assertEquals($expectedMessage, $exception->getMessage());
}
/**
* Provides reason of failure
*
* @return Generator
*/
public function provideReason()
{
$shortMessage = 'Create of the session key has failed';
$longMessageTemplate = sprintf('%s. Reason: \'%s\'.', $shortMessage, '%s');
yield[
'',
$shortMessage,
];
yield[
'Invalid user name or password',
sprintf($longMessageTemplate, 'Invalid user name or password'),
];
}
}

View File

@@ -0,0 +1,58 @@
<?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\Base\Result\BaseItem;
use Meritoo\LimeSurvey\ApiClient\Exception\IncorrectClassOfResultItemException;
use stdClass;
/**
* Test case of an exception used while class used to create instance of one item of the result is incorrect
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class IncorrectClassOfResultItemExceptionTest extends BaseTestCase
{
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(IncorrectClassOfResultItemException::class, OopVisibilityType::IS_PUBLIC, 1, 1);
}
/**
* @param string $className Incorrect class name used to create instance of one item
* @param string $expectedMessage Expected exception's message
*
* @dataProvider provideIncorrectClassName
*/
public function testConstructorMessage($className, $expectedMessage)
{
$exception = new IncorrectClassOfResultItemException($className);
static::assertEquals($expectedMessage, $exception->getMessage());
}
/**
* Provides incorrect class name used to create instance of one item
*
* @return Generator
*/
public function provideIncorrectClassName()
{
$template = 'Class %s used to create instance of one item of the result should extend %s, but it does not. Did'
. ' you forget to use proper base class?';
yield[
stdClass::class,
sprintf($template, stdClass::class, BaseItem::class),
];
}
}

View File

@@ -0,0 +1,75 @@
<?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 Exception;
use Generator;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\LimeSurvey\ApiClient\Exception\InvalidResultOfMethodRunException;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
/**
* Test case of an exception used when an error occurred while running method
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class InvalidResultOfMethodRunExceptionTest extends BaseTestCase
{
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(InvalidResultOfMethodRunException::class, OopVisibilityType::IS_PUBLIC, 3, 2);
}
/**
* @param Exception $previousException The previous exception, source of an error
* @param string $methodName Name of called method
* @param array $methodArguments Arguments of the called method
* @param string $expectedMessage Expected exception's message
*
* @dataProvider providePreviousExceptionAndMethod
*/
public function testConstructorMessage(Exception $previousException, $methodName, array $methodArguments, $expectedMessage)
{
$exception = new InvalidResultOfMethodRunException($previousException, $methodName, $methodArguments);
static::assertEquals($expectedMessage, $exception->getMessage());
}
/**
* Provides previous exception, name and arguments of called method
*
* @return Generator
*/
public function providePreviousExceptionAndMethod()
{
$template = "Oops, an error occurred while running method. Is there everything ok? Details:\n"
. "- error: %s,\n"
. "- method: %s,\n"
. '- arguments: %s.';
yield[
new Exception('Lorem ipsum'),
MethodType::ADD_RESPONSE,
[],
sprintf($template, 'Lorem ipsum', MethodType::ADD_RESPONSE, '(no arguments)'),
];
yield[
new Exception('Dolor sit amet'),
MethodType::LIST_SURVEYS,
[
'fist_name' => 'John',
'last_name' => 'Scott',
'email' => 'john@scott.com',
],
sprintf($template, 'Dolor sit amet', MethodType::LIST_SURVEYS, 'fist_name="John", last_name="Scott", email="john@scott.com"'),
];
}
}

View File

@@ -0,0 +1,57 @@
<?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 Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\LimeSurvey\ApiClient\Exception\MissingParticipantOfSurveyException;
/**
* Test case of an exception used when participant of survey is missing
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class MissingParticipantOfSurveyExceptionTest extends BaseTestCase
{
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(MissingParticipantOfSurveyException::class, OopVisibilityType::IS_PUBLIC, 2, 2);
}
/**
* @param int $surveyId ID of survey
* @param string $email E-mail address of the participant
* @param string $expectedMessage Expected exception's message
*
* @dataProvider provideSurveyIdAndEmail
*/
public function testConstructorMessage($surveyId, $email, $expectedMessage)
{
$exception = new MissingParticipantOfSurveyException($surveyId, $email);
static::assertEquals($expectedMessage, $exception->getMessage());
}
public function provideSurveyIdAndEmail()
{
$template = 'Participant with e-mail %s of survey with ID %s is missing. Maybe was not added to the survey?';
yield[
1,
'lorem@ipsum.com',
sprintf($template, 'lorem@ipsum.com', 1),
];
yield[
1234,
'another@email.comm',
sprintf($template, 'another@email.comm', 1234),
];
}
}

View File

@@ -0,0 +1,65 @@
<?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\UnknownInstanceOfResultItem;
use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
/**
* Test case of an exception used while instance of one item used by result, with data fetched from the LimeSurvey's
* API, is unknown
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class UnknownInstanceOfResultItemTest extends BaseTestCase
{
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(UnknownInstanceOfResultItem::class, OopVisibilityType::IS_PUBLIC, 1, 1);
}
/**
* @param string $method Name of called method while talking to the LimeSurvey's API. One of the
* MethodType class constants.
* @param string $expectedMessage Expected exception's message
*
* @dataProvider provideMethodName
*/
public function testConstructorMessage($method, $expectedMessage)
{
$exception = new UnknownInstanceOfResultItem($method);
static::assertEquals($expectedMessage, $exception->getMessage());
}
/**
* Provides name of called method
*
* @return Generator
*/
public function provideMethodName()
{
$template = 'Class name used to create instance of one item used by result the of \'%s\' LimeSurvey API\'s'
. ' method is unknown. Proper class is not mapped in %s::%s() method. Did you forget about this?';
yield[
MethodType::LIST_SURVEYS,
sprintf($template, MethodType::LIST_SURVEYS, ResultProcessor::class, 'getItemClassName'),
];
yield[
MethodType::ADD_PARTICIPANTS,
sprintf($template, MethodType::ADD_PARTICIPANTS, ResultProcessor::class, 'getItemClassName'),
];
}
}

View File

@@ -0,0 +1,64 @@
<?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\UnknownMethodException;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
/**
* Test case of an exception used while name of method used while talking to the LimeSurvey's API is unknown
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class UnknownMethodExceptionTest extends BaseTestCase
{
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(UnknownMethodException::class, OopVisibilityType::IS_PUBLIC, 1, 1);
}
/**
* @param string $unknownType The unknown type of something (value of constant)
* @param string $expectedMessage Expected exception's message
*
* @dataProvider provideUnknownType
*/
public function testConstructorMessage($unknownType, $expectedMessage)
{
$exception = new UnknownMethodException($unknownType);
static::assertEquals($expectedMessage, $exception->getMessage());
}
/**
* Provides name of called method
*
* @return Generator
*/
public function provideUnknownType()
{
$allMethods = implode(', ', (new MethodType())->getAll());
$template = 'The \'%s\' type of name of method used while talking to the LimeSurvey\'s API is unknown. Probably'
. ' doesn\'t exist or there is a typo. You should use one of these types: %s.';
yield[
MethodType::ADD_PARTICIPANTS,
sprintf($template, MethodType::ADD_PARTICIPANTS, $allMethods),
];
yield[
MethodType::ADD_PARTICIPANTS,
sprintf($template, MethodType::ADD_PARTICIPANTS, $allMethods),
];
}
}

View File

@@ -9,9 +9,11 @@
namespace Meritoo\LimeSurvey\Test\ApiClient\Manager; namespace Meritoo\LimeSurvey\Test\ApiClient\Manager;
use JsonRPC\Client as RpcClient; use JsonRPC\Client as RpcClient;
use JsonRPC\Exception\InvalidJsonFormatException;
use Meritoo\Common\Test\Base\BaseTestCase; use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType; use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\LimeSurvey\ApiClient\Configuration\ConnectionConfiguration; use Meritoo\LimeSurvey\ApiClient\Configuration\ConnectionConfiguration;
use Meritoo\LimeSurvey\ApiClient\Exception\InvalidResultOfMethodRunException;
use Meritoo\LimeSurvey\ApiClient\Manager\JsonRpcClientManager; use Meritoo\LimeSurvey\ApiClient\Manager\JsonRpcClientManager;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType; use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
use Meritoo\LimeSurvey\Test\ApiClient\Result\Item\SurveyTest; use Meritoo\LimeSurvey\Test\ApiClient\Result\Item\SurveyTest;
@@ -33,10 +35,10 @@ class JsonRpcClientManagerTest extends BaseTestCase
public function testConstructorVisibilityAndArguments() public function testConstructorVisibilityAndArguments()
{ {
$this->verifyConstructorVisibilityAndArguments(JsonRpcClientManager::class, OopVisibilityType::IS_PUBLIC, 1, 1); static::assertConstructorVisibilityAndArguments(JsonRpcClientManager::class, OopVisibilityType::IS_PUBLIC, 1, 1);
} }
public function testRunMethod() public function testRunMethodWithEmptyArrayReturned()
{ {
$rpcClient = $this->createMock(RpcClient::class); $rpcClient = $this->createMock(RpcClient::class);
@@ -51,12 +53,12 @@ class JsonRpcClientManagerTest extends BaseTestCase
->getMock(); ->getMock();
$rpcClient $rpcClient
->expects(static::any()) ->expects(static::once())
->method('execute') ->method('execute')
->willReturn([]); ->willReturn([]);
$manager $manager
->expects(static::any()) ->expects(static::once())
->method('getRpcClient') ->method('getRpcClient')
->willReturn($rpcClient); ->willReturn($rpcClient);
@@ -64,18 +66,18 @@ class JsonRpcClientManagerTest extends BaseTestCase
static::assertEquals([], $manager->runMethod(MethodType::LIST_SURVEYS)); static::assertEquals([], $manager->runMethod(MethodType::LIST_SURVEYS));
} }
public function testRunMethodWithMockedRpcClient() public function testRunMethodWithRawDataReturned()
{ {
$rpcClient = $this->createMock(RpcClient::class); $rpcClient = $this->createMock(RpcClient::class);
$manager = $this->createPartialMock(JsonRpcClientManager::class, ['getRpcClient']); $manager = $this->createPartialMock(JsonRpcClientManager::class, ['getRpcClient']);
$rpcClient $rpcClient
->expects(static::any()) ->expects(static::once())
->method('execute') ->method('execute')
->willReturn(SurveyTest::getSurveysRawData()); ->willReturn(SurveyTest::getSurveysRawData());
$manager $manager
->expects(static::any()) ->expects(static::once())
->method('getRpcClient') ->method('getRpcClient')
->willReturn($rpcClient); ->willReturn($rpcClient);
@@ -83,9 +85,30 @@ class JsonRpcClientManagerTest extends BaseTestCase
static::assertEquals(SurveyTest::getSurveysRawData(), $manager->runMethod(MethodType::LIST_SURVEYS)); static::assertEquals(SurveyTest::getSurveysRawData(), $manager->runMethod(MethodType::LIST_SURVEYS));
} }
public function testRunMethodWithException()
{
$this->expectException(InvalidResultOfMethodRunException::class);
$manager = $this->createPartialMock(JsonRpcClientManager::class, ['getRpcClient']);
$rpcClient = $this->createMock(RpcClient::class);
$rpcClient
->expects(self::once())
->method('execute')
->willThrowException(new InvalidJsonFormatException('bla bla'));
$manager
->expects(static::once())
->method('getRpcClient')
->willReturn($rpcClient);
/* @var JsonRpcClientManager $manager */
$manager->runMethod(MethodType::LIST_SURVEYS);
}
public function testGetRpcClientVisibilityAndArguments() 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() public function testConstructorVisibilityAndArguments()
{ {
$this->verifyConstructorVisibilityAndArguments(SessionManager::class, OopVisibilityType::IS_PUBLIC, 1, 1); static::assertConstructorVisibilityAndArguments(SessionManager::class, OopVisibilityType::IS_PUBLIC, 1, 1);
} }
public function testGetSessionKeyWhenFailedWithoutReason() public function testGetSessionKeyWhenFailedWithoutReason()

View File

@@ -1,55 +0,0 @@
<?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\Base\Result;
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
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class BaseItemTest extends PHPUnit_Framework_TestCase
{
public function testConstructorVisibilityAndArguments()
{
$reflection = new ReflectionClass(BaseItem::class);
$constructor = $reflection->getConstructor();
static::assertNull($constructor);
}
public function testSetValues()
{
$mock = $this->getBaseItemMock();
static::assertInstanceOf(BaseItem::class, $mock->setValues([]));
static::assertInstanceOf(BaseItem::class, $mock->setValues(['lorem']));
}
/**
* Returns mock of the tested class
*
* @return BaseItem
*/
private function getBaseItemMock()
{
$mock = $this->getMockForAbstractClass(BaseItem::class);
$mock
->expects(static::any())
->method('setValue')
->willReturn(null);
return $mock;
}
}

View File

@@ -1,146 +0,0 @@
<?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\Configuration;
use Generator;
use Meritoo\Common\Exception\Regex\InvalidUrlException;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\LimeSurvey\ApiClient\Configuration\ConnectionConfiguration;
/**
* Test case of the configuration used while connecting to LimeSurvey's API
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class ConnectionConfigurationTest extends BaseTestCase
{
/**
* @param mixed $emptyBaseUrl Empty base url
* @dataProvider provideEmptyBaseUrl
*/
public function testConstructorWithEmptyBaseUrl($emptyBaseUrl)
{
$this->expectException(InvalidUrlException::class);
new ConnectionConfiguration($emptyBaseUrl, '', '');
}
/**
* @param string $invalidBaseUrl Invalid base url
* @dataProvider provideInvalidBaseUrl
*/
public function testConstructorWithInvalidBaseUrl($invalidBaseUrl)
{
$this->expectException(InvalidUrlException::class);
new ConnectionConfiguration($invalidBaseUrl, '', '');
}
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());
}
public function testSetBaseUrl()
{
$configuration = new ConnectionConfiguration('http://test.com', 'test1', 'test2');
$configuration->setBaseUrl('http://lorem.ipsum');
static::assertEquals('http://lorem.ipsum', $configuration->getBaseUrl());
$configuration->setBaseUrl('http://lorem.ipsum/');
static::assertEquals('http://lorem.ipsum', $configuration->getBaseUrl());
}
public function testSetRemoteControlUrl()
{
$configuration = new ConnectionConfiguration('http://test.com', 'test1', 'test2');
$configuration->setRemoteControlUrl('/lorem/ipsum');
static::assertEquals('/lorem/ipsum', $configuration->getRemoteControlUrl());
}
public function testSetUsername()
{
$configuration = new ConnectionConfiguration('http://test.com', 'test1', 'test2');
$configuration->setUsername('lorem');
static::assertEquals('lorem', $configuration->getUsername());
}
public function testSetPassword()
{
$configuration = new ConnectionConfiguration('http://test.com', 'test1', 'test2');
$configuration->setPassword('ipsum');
static::assertEquals('ipsum', $configuration->getPassword());
}
public function testSetDebugMode()
{
$configuration = new ConnectionConfiguration('http://test.com', 'test1', 'test2');
$configuration->setDebugMode();
static::assertFalse($configuration->isDebugModeOn());
$configuration->setDebugMode(false);
static::assertFalse($configuration->isDebugModeOn());
$configuration->setDebugMode(true);
static::assertTrue($configuration->isDebugModeOn());
}
public function testGetFullUrl()
{
$configuration = new ConnectionConfiguration('http://test.com', 'test1', 'test2');
$configuration->setRemoteControlUrl('lorem/ipsum');
static::assertEquals('http://test.com/lorem/ipsum', $configuration->getFullUrl());
}
/**
* Provides empty base url
*
* @return Generator
*/
public function provideEmptyBaseUrl()
{
yield[
'',
];
yield[
null,
];
}
/**
* Provides invalid base url
*
* @return Generator
*/
public function provideInvalidBaseUrl()
{
yield[
'lorem',
];
yield[
'ipsum',
];
yield[
'htp:/dolor.com',
];
}
}

View File

@@ -0,0 +1,199 @@
<?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;
use Meritoo\LimeSurvey\ApiClient\Result\Item\ParticipantShort;
/**
* Test case of the collection of participants (of surveys)
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class ParticipantsTest extends BaseTestCase
{
/**
* An empty collection of participants (of surveys)
*
* @var Participants
*/
private $participantsEmpty;
/**
* Collection of participants of 1 survey
*
* @var Participants
*/
private $participantsOfOneSurvey;
/**
* Collection of 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 testHas()
{
$this->expectException(DisabledMethodException::class);
(new Participants())->has(new Participant());
}
public function testAddParticipantsUsingEmptyCollection()
{
$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));
}
public function testAddParticipantFirstParticipant()
{
$surveyId = 1;
$email = 'john@scott.com';
$participant = new ParticipantShort([
'tid' => 1,
'participant_info' => [
'firstname' => 'John',
'lastname' => 'Scott',
'email' => $email,
],
]);
$participants = new Participants();
$result = $participants->addParticipant($participant, $surveyId);
static::assertEquals($participants, $result);
static::assertEquals($participant, $participants->getParticipantOfSurvey($surveyId, $email));
static::assertTrue($participants->hasParticipantsOfSurvey($surveyId));
static::assertFalse($participants->hasParticipantsOfSurvey(2));
}
public function testAddParticipantNotFirstParticipant()
{
$surveyId = 1;
$email = 'john@scott.com';
$participant = new ParticipantShort([
'tid' => 1,
'participant_info' => [
'firstname' => 'John',
'lastname' => 'Scott',
'email' => $email,
],
]);
$result = $this
->participantsOfOneSurvey
->addParticipant($participant, $surveyId);
static::assertEquals($this->participantsOfOneSurvey, $result);
static::assertEquals($participant, $this->participantsOfOneSurvey->getParticipantOfSurvey($surveyId, $email));
static::assertTrue($this->participantsOfOneSurvey->hasParticipantsOfSurvey($surveyId));
static::assertFalse($this->participantsOfOneSurvey->hasParticipantsOfSurvey(2));
}
/**
* {@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

@@ -0,0 +1,108 @@
<?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\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\LimeSurvey\ApiClient\Result\Collection\Surveys;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Survey;
/**
* Test case of the collection of surveys (the Survey class instances)
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class SurveysTest extends BaseTestCase
{
/**
* An empty collection of surveys
*
* @var Surveys
*/
private $surveysEmpty;
/**
* Not empty collection of surveys
*
* @var Surveys
*/
private $surveysNotEmpty;
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(Surveys::class, OopVisibilityType::IS_PUBLIC, 1, 0);
}
public function testAddWithoutIndex()
{
$survey1 = new Survey([
'sid' => 3,
'surveyls_title' => 'Test Test Test',
]);
$survey2 = new Survey([
'sid' => 4,
'surveyls_title' => 'Another Test Test Test',
]);
$this
->surveysEmpty
->add($survey1)
->add($survey2);
$this
->surveysNotEmpty
->add($survey1)
->add($survey2);
static::assertEquals($survey1, $this->surveysEmpty[3]);
static::assertEquals($survey2, $this->surveysEmpty[4]);
static::assertEquals($survey1, $this->surveysNotEmpty[3]);
static::assertEquals($survey2, $this->surveysNotEmpty[4]);
}
public function testGetAll()
{
static::assertCount(0, $this->surveysEmpty->getAll());
static::assertCount(0, $this->surveysEmpty->getAll(true));
static::assertCount(3, $this->surveysNotEmpty->getAll());
static::assertCount(2, $this->surveysNotEmpty->getAll(true));
}
/**
* {@inheritdoc}
*/
protected function setUp()
{
parent::setUp();
$surveys = [
new Survey([
'sid' => 1,
'surveyls_title' => 'Test',
'active' => 'Y',
]),
new Survey([
'sid' => 2,
'surveyls_title' => 'Another Test',
'active' => 'Y',
]),
new Survey([
'sid' => 3,
'surveyls_title' => 'I am inactive',
]),
];
$this->surveysEmpty = new Surveys();
$this->surveysNotEmpty = new Surveys($surveys);
}
}

View File

@@ -8,10 +8,12 @@
namespace Meritoo\LimeSurvey\Test\ApiClient\Result\Item; namespace Meritoo\LimeSurvey\Test\ApiClient\Result\Item;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Participant;
use Meritoo\LimeSurvey\ApiClient\Result\Item\ParticipantShort; use Meritoo\LimeSurvey\ApiClient\Result\Item\ParticipantShort;
use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor; use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType; use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
use PHPUnit_Framework_TestCase;
/** /**
* Test case of the one item of the result/data: short data of participant * Test case of the one item of the result/data: short data of participant
@@ -19,7 +21,7 @@ use PHPUnit_Framework_TestCase;
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl> * @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl * @copyright Meritoo.pl
*/ */
class ParticipantShortTest extends PHPUnit_Framework_TestCase class ParticipantShortTest extends BaseTestCase
{ {
/** /**
* Raw data of participants * Raw data of participants
@@ -42,6 +44,11 @@ class ParticipantShortTest extends PHPUnit_Framework_TestCase
*/ */
private $participant2ndInstance; private $participant2ndInstance;
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(ParticipantShort::class, OopVisibilityType::IS_PUBLIC, 1, 0);
}
public function testCreateOfTheParticipant() public function testCreateOfTheParticipant()
{ {
$processor = new ResultProcessor(); $processor = new ResultProcessor();
@@ -74,6 +81,52 @@ class ParticipantShortTest extends PHPUnit_Framework_TestCase
static::assertEquals('dolor@sit.com', $this->participant2ndInstance->getEmail()); static::assertEquals('dolor@sit.com', $this->participant2ndInstance->getEmail());
} }
public function testFromParticipantUsingEmptyParticipant()
{
$participant = new Participant();
$participantShort = ParticipantShort::fromParticipant($participant);
static::assertEquals(0, $participantShort->getId());
static::assertEquals('', $participantShort->getFirstName());
static::assertEquals('', $participantShort->getLastName());
static::assertEquals('', $participantShort->getEmail());
static::assertEquals($participant->getId(), $participantShort->getId());
static::assertEquals($participant->getFirstName(), $participantShort->getFirstName());
static::assertEquals($participant->getLastName(), $participantShort->getLastName());
static::assertEquals($participant->getEmail(), $participantShort->getEmail());
}
public function testFromParticipant()
{
$participant1 = new Participant([
'tid' => $this->rawData[0]['tid'],
'firstname' => $this->rawData[0]['participant_info']['firstname'],
'lastname' => $this->rawData[0]['participant_info']['lastname'],
'email' => $this->rawData[0]['participant_info']['email'],
]);
$participant2 = new Participant([
'tid' => $this->rawData[1]['tid'],
'firstname' => $this->rawData[1]['participant_info']['firstname'],
'lastname' => $this->rawData[1]['participant_info']['lastname'],
'email' => $this->rawData[1]['participant_info']['email'],
]);
$participantShort1 = ParticipantShort::fromParticipant($participant1);
$participantShort2 = ParticipantShort::fromParticipant($participant2);
static::assertEquals($participant1->getId(), $participantShort1->getId());
static::assertEquals($participant1->getFirstName(), $participantShort1->getFirstName());
static::assertEquals($participant1->getLastName(), $participantShort1->getLastName());
static::assertEquals($participant1->getEmail(), $participantShort1->getEmail());
static::assertEquals($participant2->getId(), $participantShort2->getId());
static::assertEquals($participant2->getFirstName(), $participantShort2->getFirstName());
static::assertEquals($participant2->getLastName(), $participantShort2->getLastName());
static::assertEquals($participant2->getEmail(), $participantShort2->getEmail());
}
/** /**
* Returns raw data of participants * Returns raw data of participants
* *
@@ -84,7 +137,6 @@ class ParticipantShortTest extends PHPUnit_Framework_TestCase
return [ return [
[ [
'tid' => '123', 'tid' => '123',
'token' => uniqid(),
'participant_info' => [ 'participant_info' => [
'firstname' => 'Lorem', 'firstname' => 'Lorem',
'lastname' => 'Ipsum', 'lastname' => 'Ipsum',
@@ -93,7 +145,6 @@ class ParticipantShortTest extends PHPUnit_Framework_TestCase
], ],
[ [
'tid' => '456', 'tid' => '456',
'token' => uniqid(),
'participant_info' => [ 'participant_info' => [
'firstname' => 'Dolor', 'firstname' => 'Dolor',
'lastname' => 'Sit', 'lastname' => 'Sit',
@@ -111,7 +162,7 @@ class ParticipantShortTest extends PHPUnit_Framework_TestCase
parent::setUp(); parent::setUp();
$this->rawData = static::getParticipantsRawData(); $this->rawData = static::getParticipantsRawData();
$this->participant1stInstance = (new ParticipantShort())->setValues($this->rawData[0]); $this->participant1stInstance = new ParticipantShort($this->rawData[0]);
$this->participant2ndInstance = (new ParticipantShort())->setValues($this->rawData[1]); $this->participant2ndInstance = new ParticipantShort($this->rawData[1]);
} }
} }

View File

@@ -9,10 +9,11 @@
namespace Meritoo\LimeSurvey\Test\ApiClient\Result\Item; namespace Meritoo\LimeSurvey\Test\ApiClient\Result\Item;
use DateTime; use DateTime;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Participant; use Meritoo\LimeSurvey\ApiClient\Result\Item\Participant;
use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor; use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType; use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
use PHPUnit_Framework_TestCase;
/** /**
* Test case of the one item of the result/data: full data of participant * Test case of the one item of the result/data: full data of participant
@@ -20,7 +21,7 @@ use PHPUnit_Framework_TestCase;
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl> * @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl * @copyright Meritoo.pl
*/ */
class ParticipantTest extends PHPUnit_Framework_TestCase class ParticipantTest extends BaseTestCase
{ {
/** /**
* Raw data of participants * Raw data of participants
@@ -43,6 +44,11 @@ class ParticipantTest extends PHPUnit_Framework_TestCase
*/ */
private $participant2ndInstance; private $participant2ndInstance;
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(Participant::class, OopVisibilityType::IS_PUBLIC, 1, 0);
}
public function testCreateOfTheParticipant() public function testCreateOfTheParticipant()
{ {
$processor = new ResultProcessor(); $processor = new ResultProcessor();
@@ -210,7 +216,7 @@ class ParticipantTest extends PHPUnit_Framework_TestCase
parent::setUp(); parent::setUp();
$this->rawData = static::getParticipantsRawData(); $this->rawData = static::getParticipantsRawData();
$this->participant1stInstance = (new Participant())->setValues($this->rawData[0]); $this->participant1stInstance = new Participant($this->rawData[0]);
$this->participant2ndInstance = (new Participant())->setValues($this->rawData[1]); $this->participant2ndInstance = new Participant($this->rawData[1]);
} }
} }

View File

@@ -9,6 +9,7 @@
namespace Meritoo\LimeSurvey\Test\ApiClient\Result\Item; namespace Meritoo\LimeSurvey\Test\ApiClient\Result\Item;
use Meritoo\Common\Test\Base\BaseTestCase; use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\LimeSurvey\ApiClient\Result\Item\QuestionShort; use Meritoo\LimeSurvey\ApiClient\Result\Item\QuestionShort;
use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor; use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType; use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
@@ -42,6 +43,11 @@ class QuestionShortTest extends BaseTestCase
*/ */
private $question2ndInstance; private $question2ndInstance;
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(QuestionShort::class, OopVisibilityType::IS_PUBLIC, 1, 0);
}
public function testCreateOfTheQuestionShort() public function testCreateOfTheQuestionShort()
{ {
$processor = new ResultProcessor(); $processor = new ResultProcessor();
@@ -217,7 +223,7 @@ class QuestionShortTest extends BaseTestCase
parent::setUp(); parent::setUp();
$this->rawData = static::getQuestionsRawData(); $this->rawData = static::getQuestionsRawData();
$this->question1stInstance = (new QuestionShort())->setValues($this->rawData[0]); $this->question1stInstance = new QuestionShort($this->rawData[0]);
$this->question2ndInstance = (new QuestionShort())->setValues($this->rawData[1]); $this->question2ndInstance = new QuestionShort($this->rawData[1]);
} }
} }

View File

@@ -8,10 +8,11 @@
namespace Meritoo\LimeSurvey\Test\ApiClient\Result\Item; namespace Meritoo\LimeSurvey\Test\ApiClient\Result\Item;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Question; use Meritoo\LimeSurvey\ApiClient\Result\Item\Question;
use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor; use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType; 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 * Test case of the one item of the result/data: full data of one question of survey
@@ -19,7 +20,7 @@ use PHPUnit_Framework_TestCase;
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl> * @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl * @copyright Meritoo.pl
*/ */
class QuestionTest extends PHPUnit_Framework_TestCase class QuestionTest extends BaseTestCase
{ {
/** /**
* Raw data of questions * Raw data of questions
@@ -42,6 +43,11 @@ class QuestionTest extends PHPUnit_Framework_TestCase
*/ */
private $question2ndInstance; private $question2ndInstance;
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(Question::class, OopVisibilityType::IS_PUBLIC, 1, 0);
}
public function testCreateOfTheQuestionShort() public function testCreateOfTheQuestionShort()
{ {
$processor = new ResultProcessor(); $processor = new ResultProcessor();
@@ -279,7 +285,7 @@ class QuestionTest extends PHPUnit_Framework_TestCase
parent::setUp(); parent::setUp();
$this->rawData = static::getQuestionsRawData(); $this->rawData = static::getQuestionsRawData();
$this->question1stInstance = (new Question())->setValues($this->rawData[0]); $this->question1stInstance = new Question($this->rawData[0]);
$this->question2ndInstance = (new Question())->setValues($this->rawData[1]); $this->question2ndInstance = new Question($this->rawData[1]);
} }
} }

View File

@@ -9,10 +9,11 @@
namespace Meritoo\LimeSurvey\Test\ApiClient\Result\Item; namespace Meritoo\LimeSurvey\Test\ApiClient\Result\Item;
use DateTime; use DateTime;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Survey; use Meritoo\LimeSurvey\ApiClient\Result\Item\Survey;
use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor; use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType; use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
use PHPUnit_Framework_TestCase;
/** /**
* Test case of the one item of the result/data: survey * Test case of the one item of the result/data: survey
@@ -20,7 +21,7 @@ use PHPUnit_Framework_TestCase;
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl> * @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl * @copyright Meritoo.pl
*/ */
class SurveyTest extends PHPUnit_Framework_TestCase class SurveyTest extends BaseTestCase
{ {
/** /**
* Raw data of surveys * Raw data of surveys
@@ -43,6 +44,11 @@ class SurveyTest extends PHPUnit_Framework_TestCase
*/ */
private $survey2ndInstance; private $survey2ndInstance;
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(Survey::class, OopVisibilityType::IS_PUBLIC, 1, 0);
}
public function testCreateOfTheSurvey() public function testCreateOfTheSurvey()
{ {
$processor = new ResultProcessor(); $processor = new ResultProcessor();
@@ -114,7 +120,7 @@ class SurveyTest extends PHPUnit_Framework_TestCase
parent::setUp(); parent::setUp();
$this->rawData = static::getSurveysRawData(); $this->rawData = static::getSurveysRawData();
$this->survey1stInstance = (new Survey())->setValues($this->rawData[0]); $this->survey1stInstance = new Survey($this->rawData[0]);
$this->survey2ndInstance = (new Survey())->setValues($this->rawData[1]); $this->survey2ndInstance = new Survey($this->rawData[1]);
} }
} }

View File

@@ -12,10 +12,10 @@ use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType; use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem; use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem;
use Meritoo\LimeSurvey\ApiClient\Exception\UnknownInstanceOfResultItem; use Meritoo\LimeSurvey\ApiClient\Exception\UnknownInstanceOfResultItem;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Survey;
use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor; use Meritoo\LimeSurvey\ApiClient\Result\Processor\ResultProcessor;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType; use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
use Meritoo\LimeSurvey\Test\ApiClient\Result\Item\SurveyTest; 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 * Test case of the processor of the raw data fetched while talking to the LimeSurvey's API
@@ -27,10 +27,7 @@ class ResultProcessorTest extends BaseTestCase
{ {
public function testConstructorVisibilityAndArguments() public function testConstructorVisibilityAndArguments()
{ {
$reflection = new ReflectionClass(ResultProcessor::class); static::assertHasNoConstructor(ResultProcessor::class);
$constructor = $reflection->getConstructor();
static::assertNull($constructor);
} }
public function testProcessWithEmptyRawData() public function testProcessWithEmptyRawData()
@@ -43,12 +40,24 @@ class ResultProcessorTest extends BaseTestCase
public function testProcessWithIterableData() public function testProcessWithIterableData()
{ {
$surveysRawData = SurveyTest::getSurveysRawData();
$processor = new ResultProcessor(); $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::assertTrue(is_array($processed));
static::assertCount(2, $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() public function testProcessWithNotIterableData()
@@ -66,9 +75,9 @@ class ResultProcessorTest extends BaseTestCase
static::assertInstanceOf(BaseItem::class, $processed); static::assertInstanceOf(BaseItem::class, $processed);
} }
public function testGetItemInstanceVisibilityAndArguments() public function testGetItemClassNameVisibilityAndArguments()
{ {
$this->verifyMethodVisibilityAndArguments(ResultProcessor::class, 'getItemInstance', OopVisibilityType::IS_PRIVATE, 1, 1); static::assertMethodVisibilityAndArguments(ResultProcessor::class, 'getItemClassName', OopVisibilityType::IS_PRIVATE, 1, 1);
} }
public function testRunWithUnknownResultClass() public function testRunWithUnknownResultClass()

View File

@@ -12,6 +12,7 @@ use DateTime;
use Meritoo\Common\Test\Base\BaseTestCase; use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType; use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem; use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem;
use Meritoo\LimeSurvey\ApiClient\Exception\CannotProcessDataException;
use Meritoo\LimeSurvey\ApiClient\Result\Result; use Meritoo\LimeSurvey\ApiClient\Result\Result;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType; use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
use PHPUnit_Framework_MockObject_MockObject; use PHPUnit_Framework_MockObject_MockObject;
@@ -46,45 +47,60 @@ class ResultTest extends BaseTestCase
private $notIterableData; private $notIterableData;
/** /**
* Mock of the tested class. * Status provided instead of real data.
* With empty data returned by the LimeSurvey's API. * 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. * Mock of the tested class.
* With iterable, not empty data.
* *
* @var PHPUnit_Framework_MockObject_MockObject * @var PHPUnit_Framework_MockObject_MockObject
*/ */
private $iterableDataMock; private $emptyDataResult;
/** /**
* Result with iterable, not empty data.
* Mock of the tested class. * Mock of the tested class.
* With not iterable, not empty data.
* *
* @var PHPUnit_Framework_MockObject_MockObject * @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() public function testConstructorVisibilityAndArguments()
{ {
$this->verifyConstructorVisibilityAndArguments(Result::class, OopVisibilityType::IS_PUBLIC, 2, 2); static::assertConstructorVisibilityAndArguments(Result::class, OopVisibilityType::IS_PUBLIC, 2, 2);
} }
public function testIsEmpty() public function testIsEmpty()
{ {
static::assertTrue($this->emptyDataMock->isEmpty()); static::assertTrue($this->emptyDataResult->isEmpty());
static::assertFalse($this->iterableDataMock->isEmpty()); static::assertFalse($this->iterableDataResult->isEmpty());
} }
public function testGetDataUsingProcessedData() public function testGetDataUsingProcessedData()
{ {
$emptyData = $this->emptyDataMock->getData(); $emptyData = $this->emptyDataResult->getData();
$iterableData = $this->iterableDataMock->getData(); $iterableData = $this->iterableDataResult->getData();
$notIterableData = $this->notIterableDataMock->getData(); $notIterableData = $this->notIterableDataResult->getData();
static::assertEmpty($emptyData); static::assertEmpty($emptyData);
static::assertNotEmpty($iterableData); static::assertNotEmpty($iterableData);
@@ -97,8 +113,8 @@ class ResultTest extends BaseTestCase
public function testGetDataUsingRawData() public function testGetDataUsingRawData()
{ {
$emptyData = $this->emptyDataMock->getData(true); $emptyData = $this->emptyDataResult->getData(true);
$iterableData = $this->iterableDataMock->getData(true); $iterableData = $this->iterableDataResult->getData(true);
static::assertEmpty($emptyData); static::assertEmpty($emptyData);
static::assertNotEmpty($iterableData); static::assertNotEmpty($iterableData);
@@ -110,14 +126,34 @@ class ResultTest extends BaseTestCase
static::assertEquals($this->iterableData, $iterableData); static::assertEquals($this->iterableData, $iterableData);
} }
public function testGetDataUsingProcessedDataWhoCannotBeProcessed()
{
$this->expectException(CannotProcessDataException::class);
$this->statusInsteadDataResult->getData();
}
public function testGetProcessedDataVisibilityAndArguments() 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() public function testGetResultProcessorVisibilityAndArguments()
{ {
$this->verifyMethodVisibilityAndArguments(Result::class, 'getResultProcessor', OopVisibilityType::IS_PRIVATE); 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));
} }
/** /**
@@ -149,24 +185,29 @@ class ResultTest extends BaseTestCase
], ],
]; ];
$emptyDataArguments = [ $this->statusInsteadData = [
'status' => 'Invalid data',
];
$emptyData = [
MethodType::LIST_SURVEYS, MethodType::LIST_SURVEYS,
$this->emptyData, $this->emptyData,
]; ];
$iterableDataArguments = [ $iterableData = [
MethodType::LIST_SURVEYS, MethodType::LIST_SURVEYS,
$this->iterableData, $this->iterableData,
]; ];
$notIterableDataArguments = [ $notIterableData = [
MethodType::GET_PARTICIPANT_PROPERTIES, MethodType::GET_PARTICIPANT_PROPERTIES,
$this->notIterableData, $this->notIterableData,
]; ];
$this->emptyDataMock = $this->getResultMock($emptyDataArguments); $this->emptyDataResult = $this->getResultMock($emptyData);
$this->iterableDataMock = $this->getResultMock($iterableDataArguments); $this->iterableDataResult = $this->getResultMock($iterableData);
$this->notIterableDataMock = $this->getResultMock($notIterableDataArguments); $this->notIterableDataResult = $this->getResultMock($notIterableData);
$this->statusInsteadDataResult = new Result(MethodType::LIST_PARTICIPANTS, $this->statusInsteadData);
} }
/** /**

View File

@@ -0,0 +1,377 @@
<?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 Exception;
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\Exception\CannotProcessDataException;
use Meritoo\LimeSurvey\ApiClient\Exception\MissingParticipantOfSurveyException;
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\Result\Item\ParticipantShort;
use Meritoo\LimeSurvey\ApiClient\Service\ParticipantService;
use Meritoo\LimeSurvey\ApiClient\Type\ReasonType;
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
{
/**
* Service that serves participants.
* Without participants.
*
* @var ParticipantService
*/
private $serviceWithoutParticipants;
/**
* Service that serves participants.
* With participants.
*
* @var ParticipantService
*/
private $serviceWithParticipants;
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(ParticipantService::class, OopVisibilityType::IS_PUBLIC, 2, 1);
}
public function testGetClient()
{
$rpcClientManager = $this->getJsonRpcClientManager(0);
$sessionManager = $this->getSessionManager();
$this->createServiceWithoutParticipants($rpcClientManager, $sessionManager);
$this->createServiceWithParticipants($rpcClientManager, $sessionManager);
static::assertInstanceOf(Client::class, $this->serviceWithoutParticipants->getClient());
static::assertInstanceOf(Client::class, $this->serviceWithParticipants->getClient());
$connectionConfiguration = $this->getConnectionConfiguration();
$client = new Client($connectionConfiguration);
$participantService = new ParticipantService($client);
static::assertEquals($client, $participantService->getClient());
}
public function testGetSurveyParticipants()
{
$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 testGetSurveyParticipantsWithImportantException()
{
$this->expectException(CannotProcessDataException::class);
$exception = new CannotProcessDataException(ReasonType::NO_TOKEN_TABLE);
$rpcClientManager = $this->getJsonRpcClientManagerWithException(1, $exception);
$sessionManager = $this->getSessionManager();
$this->createServiceWithParticipants($rpcClientManager, $sessionManager);
$this->serviceWithParticipants->getSurveyParticipants(3);
}
public function testGetSurveyParticipantsWithNoParticipantsException()
{
$exception = new CannotProcessDataException(ReasonType::NO_PARTICIPANTS_FOUND);
$rpcClientManager = $this->getJsonRpcClientManagerWithException(1, $exception);
$sessionManager = $this->getSessionManager();
$this->createServiceWithParticipants($rpcClientManager, $sessionManager);
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 testAddParticipantForNotExistingSurvey()
{
$this->expectException(CannotProcessDataException::class);
$exception = new CannotProcessDataException(ReasonType::NOT_EXISTING_SURVEY_ID);
$rpcClientManager = $this->getJsonRpcClientManagerWithException(1, $exception);
$sessionManager = $this->getSessionManager();
$this->createServiceWithoutParticipants($rpcClientManager, $sessionManager);
$this->createServiceWithParticipants($rpcClientManager, $sessionManager);
$surveyId = 1;
$firstName = 'John';
$lastName = 'Scott';
$email = 'john@scott.com';
$this->serviceWithoutParticipants->addParticipant($surveyId, $firstName, $lastName, $email);
$this->serviceWithParticipants->addParticipant($surveyId, $firstName, $lastName, $email);
}
public function testAddParticipant()
{
$surveyId = 1;
$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($surveyId, $firstName, $lastName, $email);
static::assertInstanceOf(Participant::class, $result);
static::assertEquals($firstName, $result->getFirstName());
static::assertEquals($lastName, $result->getLastName());
static::assertEquals($email, $result->getEmail());
}
public function testGetParticipant()
{
$rpcClientManager = $this->getJsonRpcClientManager(1);
$sessionManager = $this->getSessionManager();
$this->createServiceWithoutParticipants($rpcClientManager, $sessionManager);
$this->createServiceWithParticipants($rpcClientManager, $sessionManager);
static::assertNull($this->serviceWithoutParticipants->getParticipant(1, 'john@scott.com'));
$participant = $this->serviceWithParticipants->getParticipant(1, 'john@scott.com');
static::assertInstanceOf(ParticipantShort::class, $participant);
static::assertEquals('John', $participant->getFirstName());
static::assertEquals('Scott', $participant->getLastName());
static::assertEquals('john@scott.com', $participant->getEmail());
}
public function testGetParticipantDetails()
{
$sessionManager = $this->getSessionManager();
$rpcClientManager = $this->getJsonRpcClientManager(1);
$this->createServiceWithoutParticipants($rpcClientManager, $sessionManager);
$runMethodCallResults = [
'tid' => 1,
'firstname' => 'John',
'lastname' => 'Scott',
'email' => 'john@scott.com',
'token' => uniqid(),
'sent' => 'N',
'completed' => 'N',
];
$rpcClientManager = $this->getJsonRpcClientManager(1, $runMethodCallResults);
$this->createServiceWithParticipants($rpcClientManager, $sessionManager);
static::assertNull($this->serviceWithoutParticipants->getParticipantDetails(1, 'john@scott.com'));
$participant = $this->serviceWithParticipants->getParticipantDetails(1, 'john@scott.com');
static::assertInstanceOf(Participant::class, $participant);
static::assertEquals($runMethodCallResults['tid'], $participant->getId());
static::assertEquals($runMethodCallResults['firstname'], $participant->getFirstName());
static::assertEquals($runMethodCallResults['lastname'], $participant->getLastName());
static::assertEquals($runMethodCallResults['email'], $participant->getEmail());
static::assertEquals($runMethodCallResults['token'], $participant->getToken());
static::assertFalse($participant->isSent());
static::assertFalse($participant->isCompleted());
static::assertNull($participant->isBlacklisted());
static::assertNull($participant->getValidFrom());
}
public function testHasParticipantFilledSurveyWithException()
{
$this->expectException(MissingParticipantOfSurveyException::class);
$rpcClientManager = $this->getJsonRpcClientManager(1);
$sessionManager = $this->getSessionManager();
$this->createServiceWithoutParticipants($rpcClientManager, $sessionManager);
$this->serviceWithoutParticipants->hasParticipantFilledSurvey(1, 'john@scott.com');
}
public function testHasParticipantFilledSurveyUsingExistingParticipant()
{
$runMethodCallResults = [
'firstname' => 'John',
'lastname' => 'Scott',
'email' => 'john@scott.com',
'completed' => 'Y',
];
$rpcClientManager = $this->getJsonRpcClientManager(1, $runMethodCallResults);
$sessionManager = $this->getSessionManager();
$this->createServiceWithParticipants($rpcClientManager, $sessionManager);
static::assertTrue($this->serviceWithParticipants->hasParticipantFilledSurvey(1, 'john@scott.com'));
}
public function testHasParticipantFilledSurveyUsingNotExistingParticipant()
{
$this->expectException(MissingParticipantOfSurveyException::class);
$rpcClientManager = $this->getJsonRpcClientManager(1);
$sessionManager = $this->getSessionManager();
$this->createServiceWithParticipants($rpcClientManager, $sessionManager);
$this->serviceWithParticipants->hasParticipantFilledSurvey(3, 'mary@jane.com');
}
/**
* 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 with mocked method runMethod()
*
* @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;
}
/**
* Returns manager of the JsonRPC client used while connecting to LimeSurvey's API with mocked method runMethod()
* that throws an exception
*
* @param int $runMethodCallCount Count of calls of the runMethod() method (who is mocked)
* @param Exception $exception The exception that should be thrown
* @return PHPUnit_Framework_MockObject_MockObject
*/
private function getJsonRpcClientManagerWithException($runMethodCallCount, Exception $exception)
{
$rpcClientManager = $this->createMock(JsonRpcClientManager::class);
$rpcClientManager
->expects(static::exactly($runMethodCallCount))
->method('runMethod')
->willThrowException($exception);
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 ParticipantShort([
'tid' => 1,
'participant_info' => [
'firstname' => 'John',
'lastname' => 'Scott',
'email' => 'john@scott.com',
],
]),
new ParticipantShort([
'tid' => 2,
'participant_info' => [
'firstname' => 'Mary',
'lastname' => 'Jane',
'email' => 'mary@jane.com',
],
]),
]),
2 => new Collection([
new ParticipantShort(),
]),
]);
$this->serviceWithParticipants = new ParticipantService($client, $allParticipants);
}
}

View File

@@ -0,0 +1,290 @@
<?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 Exception;
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\Exception\CannotProcessDataException;
use Meritoo\LimeSurvey\ApiClient\Manager\JsonRpcClientManager;
use Meritoo\LimeSurvey\ApiClient\Manager\SessionManager;
use Meritoo\LimeSurvey\ApiClient\Result\Collection\Surveys;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Participant;
use Meritoo\LimeSurvey\ApiClient\Result\Item\Survey;
use Meritoo\LimeSurvey\ApiClient\Service\SurveyService;
use Meritoo\LimeSurvey\ApiClient\Type\ReasonType;
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
{
/**
* Service that serves surveys.
* Without surveys.
*
* @var SurveyService
*/
private $serviceWithoutSurveys;
/**
* Service that serves surveys.
* With surveys.
*
* @var SurveyService
*/
private $serviceWithSurveys;
/**
* Base url of LimeSurvey's instance.
* Used to prepare configuration of connection.
*
* @var string
*/
private $connectionBaseUrl = 'http://test.com';
public function testConstructorVisibilityAndArguments()
{
static::assertConstructorVisibilityAndArguments(SurveyService::class, OopVisibilityType::IS_PUBLIC, 2, 1);
}
public function testGetClient()
{
$rpcClientManager = $this->getJsonRpcClientManager(0);
$sessionManager = $this->getSessionManager();
$this->createServiceWithoutSurveys($rpcClientManager, $sessionManager);
$this->createServiceWithSurveys($rpcClientManager, $sessionManager);
static::assertInstanceOf(Client::class, $this->serviceWithoutSurveys->getClient());
static::assertInstanceOf(Client::class, $this->serviceWithSurveys->getClient());
$connectionConfiguration = $this->getConnectionConfiguration();
$client = new Client($connectionConfiguration);
$surveyService = new SurveyService($client);
static::assertEquals($client, $surveyService->getClient());
}
public function testGetAllSurveysWithImportantException()
{
$this->expectException(CannotProcessDataException::class);
$exception = new CannotProcessDataException(ReasonType::NO_TOKEN_TABLE);
$rpcClientManager = $this->getJsonRpcClientManagerWithException(1, $exception);
$sessionManager = $this->getSessionManager();
$this->createServiceWithoutSurveys($rpcClientManager, $sessionManager);
$this->serviceWithoutSurveys->getAllSurveys();
}
public function testGetAllSurveysWithNoSurveysException()
{
$exception = new CannotProcessDataException(ReasonType::NO_SURVEYS_FOUND);
$rpcClientManager = $this->getJsonRpcClientManagerWithException(1, $exception);
$sessionManager = $this->getSessionManager();
$this->createServiceWithoutSurveys($rpcClientManager, $sessionManager);
static::assertCount(0, $this->serviceWithoutSurveys->getAllSurveys());
}
public function testGetAllSurveys()
{
$rpcClientManager = $this->getJsonRpcClientManager(2);
$sessionManager = $this->getSessionManager();
$this->createServiceWithoutSurveys($rpcClientManager, $sessionManager);
$this->createServiceWithSurveys($rpcClientManager, $sessionManager);
/*
* If there are no surveys, count of all or active only surveys is the same
*/
static::assertCount(0, $this->serviceWithoutSurveys->getAllSurveys());
static::assertCount(0, $this->serviceWithoutSurveys->getAllSurveys(true));
/*
* If there are surveys, here we've got difference between count of all or active only surveys
*/
static::assertCount(3, $this->serviceWithSurveys->getAllSurveys());
static::assertCount(2, $this->serviceWithSurveys->getAllSurveys(true));
}
public function testIsExistingSurvey()
{
$rpcClientManager = $this->getJsonRpcClientManager(4);
$sessionManager = $this->getSessionManager();
$this->createServiceWithoutSurveys($rpcClientManager, $sessionManager);
$this->createServiceWithSurveys($rpcClientManager, $sessionManager);
/*
* If there are no surveys, verification of existence any survey always return false
*/
static::assertFalse($this->serviceWithoutSurveys->isExistingSurvey(1));
static::assertFalse($this->serviceWithoutSurveys->isExistingSurvey(1, true));
static::assertFalse($this->serviceWithoutSurveys->isExistingSurvey(2));
static::assertFalse($this->serviceWithoutSurveys->isExistingSurvey(2, true));
/*
* If there are surveys, verification of existence active survey always return true
*/
static::assertTrue($this->serviceWithSurveys->isExistingSurvey(1));
static::assertTrue($this->serviceWithSurveys->isExistingSurvey(1, true));
static::assertTrue($this->serviceWithSurveys->isExistingSurvey(2));
static::assertTrue($this->serviceWithSurveys->isExistingSurvey(2, true));
/*
* If there are surveys, verification of existence of non-active survey shows difference
*/
static::assertTrue($this->serviceWithSurveys->isExistingSurvey(3));
static::assertFalse($this->serviceWithSurveys->isExistingSurvey(3, true));
/*
* If there are surveys, verification of existence non-existing survey always return false
*/
static::assertFalse($this->serviceWithSurveys->isExistingSurvey(4));
static::assertFalse($this->serviceWithSurveys->isExistingSurvey(4, true));
}
public function testGetStartSurveyUrl()
{
$rpcClientManager = $this->getJsonRpcClientManager(0);
$sessionManager = $this->getSessionManager();
$this->createServiceWithoutSurveys($rpcClientManager, $sessionManager);
$this->createServiceWithSurveys($rpcClientManager, $sessionManager);
$surveyId = 123;
$token = uniqid();
$expectedUrl = sprintf('%s/%d?token=%s', $this->connectionBaseUrl, $surveyId, $token);
$participant = new Participant([
'tid' => 1,
'firstname' => 'John',
'lastname' => 'Scott',
'email' => 'john@scott.com',
'token' => $token,
]);
static::assertEquals($expectedUrl, $this->serviceWithoutSurveys->getStartSurveyUrl($surveyId, $participant));
static::assertEquals($expectedUrl, $this->serviceWithSurveys->getStartSurveyUrl($surveyId, $participant));
}
/**
* Returns configuration used while connecting to LimeSurvey's API
*
* @return ConnectionConfiguration
*/
private function getConnectionConfiguration()
{
return new ConnectionConfiguration($this->connectionBaseUrl, '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 with mocked method runMethod()
*
* @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;
}
/**
* Returns manager of the JsonRPC client used while connecting to LimeSurvey's API with mocked method runMethod()
* that throws an exception
*
* @param int $runMethodCallCount Count of calls of the runMethod() method (who is mocked)
* @param Exception $exception The exception that should be thrown
* @return PHPUnit_Framework_MockObject_MockObject
*/
private function getJsonRpcClientManagerWithException($runMethodCallCount, Exception $exception)
{
$rpcClientManager = $this->createMock(JsonRpcClientManager::class);
$rpcClientManager
->expects(static::exactly($runMethodCallCount))
->method('runMethod')
->willThrowException($exception);
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 Surveys([
new Survey([
'sid' => 1,
'surveyls_title' => 'Test',
'active' => 'Y',
]),
new Survey([
'sid' => 2,
'surveyls_title' => 'Another Test',
'active' => 'Y',
]),
new Survey([
'sid' => 3,
'surveyls_title' => 'I am inactive',
]),
]);
$this->serviceWithSurveys = new SurveyService($client, $allSurveys);
}
}

View File

@@ -12,6 +12,7 @@ use Generator;
use Meritoo\Common\Test\Base\BaseTypeTestCase; use Meritoo\Common\Test\Base\BaseTypeTestCase;
use Meritoo\LimeSurvey\ApiClient\Exception\UnknownMethodException; use Meritoo\LimeSurvey\ApiClient\Exception\UnknownMethodException;
use Meritoo\LimeSurvey\ApiClient\Type\MethodType; use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
use Meritoo\LimeSurvey\ApiClient\Type\SystemMethodType;
/** /**
* Test case of the type of method used while talking with LimeSurvey's API * Test case of the type of method used while talking with LimeSurvey's API
@@ -21,6 +22,11 @@ use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
*/ */
class MethodTypeTest extends BaseTypeTestCase class MethodTypeTest extends BaseTypeTestCase
{ {
public function testConstructorVisibilityAndArguments()
{
static::assertHasNoConstructor(MethodType::class);
}
/** /**
* @param string $incorrectMethod Type of method to verify * @param string $incorrectMethod Type of method to verify
* @dataProvider provideIncorrectMethod * @dataProvider provideIncorrectMethod
@@ -83,6 +89,14 @@ class MethodTypeTest extends BaseTypeTestCase
yield[ yield[
MethodType::LIST_SURVEYS, MethodType::LIST_SURVEYS,
]; ];
yield[
SystemMethodType::GET_SESSION_KEY,
];
yield[
SystemMethodType::RELEASE_SESSION_KEY,
];
} }
/** /**
@@ -157,6 +171,7 @@ class MethodTypeTest extends BaseTypeTestCase
protected function getAllExpectedTypes() protected function getAllExpectedTypes()
{ {
return [ return [
'ADD_PARTICIPANTS' => MethodType::ADD_PARTICIPANTS,
'ADD_RESPONSE' => MethodType::ADD_RESPONSE, 'ADD_RESPONSE' => MethodType::ADD_RESPONSE,
'EXPORT_STATISTICS' => MethodType::EXPORT_STATISTICS, 'EXPORT_STATISTICS' => MethodType::EXPORT_STATISTICS,
'GET_PARTICIPANT_PROPERTIES' => MethodType::GET_PARTICIPANT_PROPERTIES, 'GET_PARTICIPANT_PROPERTIES' => MethodType::GET_PARTICIPANT_PROPERTIES,

View File

@@ -0,0 +1,83 @@
<?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\Type;
use Meritoo\Common\Test\Base\BaseTypeTestCase;
use Meritoo\LimeSurvey\ApiClient\Type\ReasonType;
/**
* Test case of the type of reason used by LimeSurvey's exception
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class ReasonTypeTest extends BaseTypeTestCase
{
public function testConstructorVisibilityAndArguments()
{
static::assertHasNoConstructor(ReasonType::class);
}
/**
* {@inheritdoc}
*/
protected function getAllExpectedTypes()
{
return [
'NOT_EXISTING_SURVEY_ID' => ReasonType::NOT_EXISTING_SURVEY_ID,
'NO_PARTICIPANTS_FOUND' => ReasonType::NO_PARTICIPANTS_FOUND,
'NO_SURVEYS_FOUND' => ReasonType::NO_SURVEYS_FOUND,
'NO_TOKEN_TABLE' => ReasonType::NO_TOKEN_TABLE,
];
}
/**
* {@inheritdoc}
*/
protected function getTestedTypeInstance()
{
return new ReasonType();
}
/**
* {@inheritdoc}
*/
public function provideTypeToVerify()
{
yield[
'',
false,
];
yield[
'lorem',
false,
];
yield[
ReasonType::NOT_EXISTING_SURVEY_ID,
true,
];
yield[
ReasonType::NO_PARTICIPANTS_FOUND,
true,
];
yield[
ReasonType::NO_SURVEYS_FOUND,
true,
];
yield[
ReasonType::NO_TOKEN_TABLE,
true,
];
}
}

View File

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