Renamed the method validateSubmission() to verifySubmission()

The validation happens before the form is submitted. Because of that, `validateSubmission` is the wrong name. We renamed the method but kept the old method as an alias method in the client.

Author: zepich

src/Client.php

@@ -59,7 +59,7 @@ public function __construct(string $host, string $publicKey, string $privateKey,
     /**
      * Validates the given form data with the configured mosparo
      * instance. Returns a VerificationResult object which contains
-     * all needed informations.
+     * all needed information.
      *
      * @param array $formData
      * @param string $submitToken
@@ -69,7 +69,7 @@ public function __construct(string $host, string $publicKey, string $privateKey,
      * @throws \Mosparo\ApiClient\Exception Submit or validation token not available.
      * @throws \Mosparo\ApiClient\Exception An error occurred while sending the request to mosparo.
      */
-    public function validateSubmission(array $formData, string $submitToken = null, string $validationToken = null): VerificationResult
+    public function verifySubmission(array $formData, string $submitToken = null, string $validationToken = null): VerificationResult
     {
         $requestHelper = new RequestHelper($this->publicKey, $this->privateKey);
 
@@ -129,6 +129,28 @@ public function validateSubmission(array $formData, string $submitToken = null,
         );
     }
 
+    /**
+     * DEPRECATED: Use Client::verifySubmission() instead.
+     *
+     * Validates the given form data with the configured mosparo
+     * instance. Returns a VerificationResult object which contains
+     * all needed information.
+     *
+     * @deprecated 1.0.2 This method has the wrong method name. Please use Client::verifySubmission() instead.
+     *
+     * @param array $formData
+     * @param string $submitToken
+     * @param string $validationToken
+     * @return \Mosparo\ApiClient\VerificationResult
+     *
+     * @throws \Mosparo\ApiClient\Exception Submit or validation token not available.
+     * @throws \Mosparo\ApiClient\Exception An error occurred while sending the request to mosparo.
+     */
+    public function validateSubmission(array $formData, string $submitToken = null, string $validationToken = null): VerificationResult
+    {
+        return $this->verifySubmission($formData, $submitToken, $validationToken);
+    }
+
     /**
      * Retrieves the statistics data from mosparo for the given time range,
      * counted by date.

tests/ClientTest.php

@@ -28,58 +28,58 @@ public function setUp(): void
         $this->handlerStack->push($historyMiddleware);
     }
 
-    public function testValidateSubmissionWithoutTokens()
+    public function testVerifySubmissionWithoutTokens()
     {
         $this->expectException(Exception::class);
         $this->expectExceptionMessage('Submit or validation token not available.');
 
         $apiClient = new Client('http://test.local', 'testPublicKey', 'testPrivateKey', ['handler' => $this->handlerStack]);
-        $result = $apiClient->validateSubmission(['name' => 'John Example']);
+        $result = $apiClient->verifySubmission(['name' => 'John Example']);
     }
 
-    public function testValidateSubmissionWithoutValidationTokens()
+    public function testVerifySubmissionWithoutValidationTokens()
     {
         $this->expectException(Exception::class);
         $this->expectExceptionMessage('Submit or validation token not available.');
 
         $apiClient = new Client('http://test.local', 'testPublicKey', 'testPrivateKey', ['handler' => $this->handlerStack]);
-        $result = $apiClient->validateSubmission(['name' => 'John Example', '_mosparo_submitToken' => 'submitToken']);
+        $result = $apiClient->verifySubmission(['name' => 'John Example', '_mosparo_submitToken' => 'submitToken']);
     }
 
-    public function testValidateSubmissionFormTokensEmptyResponse()
+    public function testVerifySubmissionFormTokensEmptyResponse()
     {
         $this->handler->append(new Response(200, ['Content-Type' => 'application/json'], json_encode([])));
 
         $this->expectException(Exception::class);
         $this->expectExceptionMessage('Response from API invalid.');
 
         $apiClient = new Client('http://test.local', 'testPublicKey', 'testPrivateKey', ['handler' => $this->handlerStack]);
-        $result = $apiClient->validateSubmission(['name' => 'John Example', '_mosparo_submitToken' => 'submitToken', '_mosparo_validationToken' => 'validationToken']);
+        $result = $apiClient->verifySubmission(['name' => 'John Example', '_mosparo_submitToken' => 'submitToken', '_mosparo_validationToken' => 'validationToken']);
     }
 
-    public function testValidateSubmissionTokensAsArgumentEmptyResponse()
+    public function testVerifySubmissionTokensAsArgumentEmptyResponse()
     {
         $this->handler->append(new Response(200, ['Content-Type' => 'application/json'], json_encode([])));
 
         $this->expectException(Exception::class);
         $this->expectExceptionMessage('Response from API invalid.');
 
         $apiClient = new Client('http://test.local', 'testPublicKey', 'testPrivateKey', ['handler' => $this->handlerStack]);
-        $result = $apiClient->validateSubmission(['name' => 'John Example'], 'submitToken', 'validationToken');
+        $result = $apiClient->verifySubmission(['name' => 'John Example'], 'submitToken', 'validationToken');
     }
 
-    public function testValidateSubmissionConnectionError()
+    public function testVerifySubmissionConnectionError()
     {
         $this->handler->append(new RequestException('Error Communicating with Server', new Request('GET', 'test')));
 
         $this->expectException(Exception::class);
         $this->expectExceptionMessage('An error occurred while sending the request to mosparo.');
 
         $apiClient = new Client('http://test.local', 'testPublicKey', 'testPrivateKey', ['handler' => $this->handlerStack]);
-        $result = $apiClient->validateSubmission(['name' => 'John Example'], 'submitToken', 'validationToken');
+        $result = $apiClient->verifySubmission(['name' => 'John Example'], 'submitToken', 'validationToken');
     }
 
-    public function testValidateSubmissionIsValid()
+    public function testVerifySubmissionIsValid()
     {
         $publicKey = 'testPublicKey';
         $privateKey = 'testPrivateKey';
@@ -107,7 +107,7 @@ public function testValidateSubmissionIsValid()
         // Start the test
         $apiClient = new Client('http://test.local', $publicKey, $privateKey, ['handler' => $this->handlerStack]);
 
-        $result = $apiClient->validateSubmission($formData, $submitToken, $validationToken);
+        $result = $apiClient->verifySubmission($formData, $submitToken, $validationToken);
 
         // Check the result
         $this->assertInstanceOf(VerificationResult::class, $result);
@@ -125,7 +125,7 @@ public function testValidateSubmissionIsValid()
         $this->assertEquals($requestData['formSignature'], $formSignature);
     }
 
-    public function testValidateSubmissionIsNotValid()
+    public function testVerifySubmissionIsNotValid()
     {
         $publicKey = 'testPublicKey';
         $privateKey = 'testPrivateKey';
@@ -147,7 +147,7 @@ public function testValidateSubmissionIsNotValid()
         // Start the test
         $apiClient = new Client('http://test.local', 'testPublicKey', $privateKey, ['handler' => $this->handlerStack]);
 
-        $result = $apiClient->validateSubmission($formData, $submitToken, $validationToken);
+        $result = $apiClient->verifySubmission($formData, $submitToken, $validationToken);
 
         // Check the result
         $this->assertInstanceOf(VerificationResult::class, $result);