feat: #4 params validation

Author: shaunthegeek

composer.json

@@ -5,7 +5,8 @@
     "require": {
         "php": ">=7.4",
         "ext-json": "*",
-        "guzzlehttp/guzzle": "^7.4"
+        "guzzlehttp/guzzle": "^7.4",
+        "illuminate/validation": "^8.67"
     },
     "require-dev": {
         "fakerphp/faker": "^1.16",

src/Core.php

@@ -2,6 +2,7 @@
 
 namespace Coding;
 
+use Coding\Exceptions\ApiError;
 use GuzzleHttp\Client;
 
 class Core

src/ApiError.php src/Exceptions/ApiError.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Coding;
+namespace Coding\Exceptions;
 
 use Exception;
 

src/Exceptions/ValidationException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Coding\Exceptions;
+
+use Exception;
+
+class ValidationException extends Exception
+{
+}

src/Handlers/Validator.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Coding\Handlers;
+
+use Illuminate\Filesystem\Filesystem;
+use Illuminate\Translation\FileLoader;
+use Illuminate\Translation\Translator;
+use Illuminate\Validation\Factory;
+
+class Validator extends Factory
+{
+    public static function getInstance(): Factory
+    {
+        static $validator = null;
+        if ($validator === null) {
+            $fileLoader = new FileLoader(new Filesystem(), __DIR__ . '/../../lang');
+            $translator = new Translator($fileLoader, 'en');
+            $validator = new Factory($translator);
+        }
+        return $validator;
+    }
+}

src/Iteration.php

@@ -2,6 +2,9 @@
 
 namespace Coding;
 
+use Coding\Exceptions\ValidationException;
+use Coding\Handlers\Validator;
+
 class Iteration
 {
     private Core $core;
@@ -13,6 +16,18 @@ public function __construct(string $token, Core $core = null)
 
     public function create(array $data)
     {
+        $validator = Validator::getInstance()->make($data, [
+            'ProjectName' => 'string|required',
+            'Name' => 'string|required',
+            'Goal' => 'string',
+            'Assignee' => 'integer',
+            'StartAt' => 'date_format:Y-m-d',
+            'EndAt' => 'date_format:Y-m-d|after:StartAt',
+        ]);
+        if ($validator->fails()) {
+            // TODO Laravel ValidationException no message
+            throw new ValidationException($validator->errors()->all()[0]);
+        }
         $response = $this->core->request('CreateIteration', $data);
         return $response['Iteration'];
     }

tests/CoreTest.php

@@ -2,7 +2,7 @@
 
 namespace Coding\Tests;
 
-use Coding\ApiError;
+use Coding\Exceptions\ApiError;
 use Coding\Core;
 use GuzzleHttp\Psr7\Response;
 

tests/IterationTest.php

@@ -3,11 +3,12 @@
 namespace Coding\Tests;
 
 use Coding\Core;
+use Coding\Exceptions\ValidationException;
 use Coding\Iteration;
 
 class IterationTest extends TestCase
 {
-    public function testCreateSuccess()
+    public function testCreateSuccessWithOnlyRequiredParams()
     {
         $coreMock = \Mockery::mock(Core::class, [])->makePartial();
 
@@ -28,4 +29,58 @@ public function testCreateSuccess()
         $result = $iteration->create($data);
         $this->assertEquals($response['Iteration'], $result);
     }
+
+    public function testCreateSuccessWithAllParams()
+    {
+        $coreMock = \Mockery::mock(Core::class, [])->makePartial();
+
+        $response = json_decode(
+            file_get_contents($this->dataPath('CreateIterationResponse.json')),
+            true
+        )['Response'];
+        $startAt = $this->faker->date();
+        $data = [
+            'ProjectName' => $this->projectName,
+            'Name' => $this->faker->title,
+            'Goal' => $this->faker->sentence,
+            'Assignee' => $this->faker->randomNumber(),
+            'StartAt' => $startAt,
+            'EndAt' => date('Y-m-d', strtotime($startAt) + $this->faker->randomDigitNotZero() * 86400),
+        ];
+        $coreMock->shouldReceive('request')->times(1)->withArgs([
+            'CreateIteration',
+            $data
+        ])->andReturn($response);
+
+        $iteration = new Iteration($this->token, $coreMock);
+        $result = $iteration->create($data);
+        $this->assertEquals($response['Iteration'], $result);
+    }
+
+    public function testCreateFailedRequired()
+    {
+        $data = [
+            'ProjectName' => $this->projectName,
+        ];
+
+        $iteration = new Iteration($this->token);
+        $this->expectException(ValidationException::class);
+        $this->expectExceptionMessage('The name field is required.');
+        $iteration->create($data);
+    }
+
+    public function testCreateFailedBefore()
+    {
+        $data = [
+            'ProjectName' => $this->projectName,
+            'Name' => $this->faker->title,
+            'StartAt' => '2021-10-23',
+            'EndAt' => '2021-10-22',
+        ];
+
+        $iteration = new Iteration($this->token);
+        $this->expectException(ValidationException::class);
+        $this->expectExceptionMessage('The end at must be a date after start at.');
+        $iteration->create($data);
+    }
 }