Merge pull request #11 from factorio-item-browser/feature/combination-validation

feature/combination-validation

Author: BluePsyduck

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 3.2.0 - 2020-11-01
+
+### Added
+
+- New `/combination/validate` request.
+
 ## 3.1.0 - 2020-05-02
 
 ### Added

config/dependencies.php

@@ -24,6 +24,7 @@
             Endpoint\Auth\AuthEndpoint::class => InvokableFactory::class,
             Endpoint\Combination\CombinationExportEndpoint::class => InvokableFactory::class,
             Endpoint\Combination\CombinationStatusEndpoint::class => InvokableFactory::class,
+            Endpoint\Combination\CombinationValidateEndpoint::class => InvokableFactory::class,
             Endpoint\Generic\GenericDetailsEndpoint::class => InvokableFactory::class,
             Endpoint\Generic\GenericIconEndpoint::class => InvokableFactory::class,
             Endpoint\Item\ItemIngredientEndpoint::class => InvokableFactory::class,

config/serializer/Entity.ValidatedMod.yaml

@@ -0,0 +1,12 @@
+FactorioItemBrowser\Api\Client\Entity\ValidatedMod:
+  access_type: public_method
+  exclusion_policy: all
+  properties:
+    name:
+      type: string
+    version:
+      type: string
+    issueType:
+      type: string
+    issueDependency:
+      type: string

config/serializer/Response.Combination.CombinationValidateResponse.yaml

@@ -0,0 +1,8 @@
+FactorioItemBrowser\Api\Client\Response\Combination\CombinationValidateResponse:
+  access_type: public_method
+  exclusion_policy: all
+  properties:
+    isValid:
+      type: bool
+    validatedMods:
+      type: array<FactorioItemBrowser\Api\Client\Entity\ValidatedMod>

src/Constant/ValidatedModIssueType.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FactorioItemBrowser\Api\Client\Constant;
+
+/**
+ * The issue types of the validated mods.
+ *
+ * @author BluePsyduck <[email protected]>
+ * @license http://opensource.org/licenses/GPL-3.0 GPL v3
+ */
+interface ValidatedModIssueType
+{
+    /**
+     * The mod is in conflict with another mod.
+     */
+    public const CONFLICT = 'conflict';
+
+    /**
+     * The mod is missing a mandatory dependency.
+     */
+    public const MISSING_DEPENDENCY = 'missing-dependency';
+
+    /**
+     * The mod is missing on the mod portal.
+     */
+    public const MISSING_MOD = 'missing-mod';
+
+    /**
+     * The mod is missing a valid release which can be used.
+     */
+    public const MISSING_RELEASE = 'missing-release';
+
+    /**
+     * The mod does not have any issues.
+     */
+    public const NONE = 'none';
+}

src/Endpoint/Combination/CombinationValidateEndpoint.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FactorioItemBrowser\Api\Client\Endpoint\Combination;
+
+use FactorioItemBrowser\Api\Client\Endpoint\EndpointInterface;
+use FactorioItemBrowser\Api\Client\Request\Combination\CombinationValidateRequest;
+use FactorioItemBrowser\Api\Client\Response\Combination\CombinationValidateResponse;
+
+/**
+ * The endpoint for the combination validate request.
+ *
+ * @author BluePsyduck <[email protected]>
+ * @license http://opensource.org/licenses/GPL-3.0 GPL v3
+ */
+class CombinationValidateEndpoint implements EndpointInterface
+{
+    /**
+     * Returns the request class supported by the endpoint.
+     * @return string
+     */
+    public function getSupportedRequestClass(): string
+    {
+        return CombinationValidateRequest::class;
+    }
+
+    /**
+     * Returns whether or not this endpoint requires an authorization token.
+     * @return bool
+     */
+    public function requiresAuthorizationToken(): bool
+    {
+        return true;
+    }
+
+    /**
+     * Returns the request path of the endpoint.
+     * @return string
+     */
+    public function getRequestPath(): string
+    {
+        return 'combination/validate';
+    }
+
+    /**
+     * Creates the response of the endpoint.
+     * @return string
+     */
+    public function getResponseClass(): string
+    {
+        return CombinationValidateResponse::class;
+    }
+}

src/Entity/ValidatedMod.php

@@ -0,0 +1,120 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FactorioItemBrowser\Api\Client\Entity;
+
+use FactorioItemBrowser\Api\Client\Constant\ValidatedModIssueType;
+
+/**
+ * The entity representing a validated mod.
+ *
+ * @author BluePsyduck <[email protected]>
+ * @license http://opensource.org/licenses/GPL-3.0 GPL v3
+ */
+class ValidatedMod
+{
+    /**
+     * The name of the mod.
+     * @var string
+     */
+    protected $name = '';
+
+    /**
+     * The version of the mod used for validation.
+     * @var string
+     */
+    protected $version = '';
+
+    /**
+     * The type of issue the mod has.
+     * @var string
+     */
+    protected $issueType = ValidatedModIssueType::NONE;
+
+    /**
+     * The dependency which triggered the "missing-dependency" or "conflict" issue.
+     * @var string
+     */
+    protected $issueDependency = '';
+
+    /**
+     * Sets the name of the mod.
+     * @param string $name
+     * @return $this
+     */
+    public function setName(string $name): self
+    {
+        $this->name = $name;
+        return $this;
+    }
+
+    /**
+     * Returns the name of the mod.
+     * @return string
+     */
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    /**
+     * Sets the version of the mod used for validation.
+     * @param string $version
+     * @return $this
+     */
+    public function setVersion(string $version): self
+    {
+        $this->version = $version;
+        return $this;
+    }
+
+    /**
+     * Returns the version of the mod used for validation.
+     * @return string
+     */
+    public function getVersion(): string
+    {
+        return $this->version;
+    }
+
+    /**
+     * Sets the type of issue the mod has.
+     * @param string $issueType
+     * @return $this
+     */
+    public function setIssueType(string $issueType): self
+    {
+        $this->issueType = $issueType;
+        return $this;
+    }
+
+    /**
+     * Returns the type of issue the mod has.
+     * @return string
+     */
+    public function getIssueType(): string
+    {
+        return $this->issueType;
+    }
+
+    /**
+     * Sets the dependency which triggered the "missing-dependency" or "conflict" issue.
+     * @param string $issueDependency
+     * @return $this
+     */
+    public function setIssueDependency(string $issueDependency): self
+    {
+        $this->issueDependency = $issueDependency;
+        return $this;
+    }
+
+    /**
+     * Returns the dependency which triggered the "missing-dependency" or "conflict" issue.
+     * @return string
+     */
+    public function getIssueDependency(): string
+    {
+        return $this->issueDependency;
+    }
+}

src/Request/Combination/CombinationValidateRequest.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FactorioItemBrowser\Api\Client\Request\Combination;
+
+use FactorioItemBrowser\Api\Client\Request\RequestInterface;
+
+/**
+ * The request of the combination validation.
+ *
+ * @author BluePsyduck <[email protected]>
+ * @license http://opensource.org/licenses/GPL-3.0 GPL v3
+ */
+class CombinationValidateRequest implements RequestInterface
+{
+}

src/Response/Combination/CombinationValidateResponse.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FactorioItemBrowser\Api\Client\Response\Combination;
+
+use FactorioItemBrowser\Api\Client\Entity\ValidatedMod;
+use FactorioItemBrowser\Api\Client\Response\ResponseInterface;
+
+/**
+ * The response of the combination validate request.
+ *
+ * @author BluePsyduck <[email protected]>
+ * @license http://opensource.org/licenses/GPL-3.0 GPL v3
+ */
+class CombinationValidateResponse implements ResponseInterface
+{
+    /**
+     * Whether the combination of mods is valid.
+     * @var bool
+     */
+    protected $isValid = false;
+
+    /**
+     * The list of validated mods.
+     * @var array<ValidatedMod>|ValidatedMod[]
+     */
+    protected $validatedMods = [];
+
+    /**
+     * Sets whether the combination of mods is valid.
+     * @param bool $isValid
+     * @return $this
+     */
+    public function setIsValid(bool $isValid): self
+    {
+        $this->isValid = $isValid;
+        return $this;
+    }
+
+    /**
+     * Returns whether the combination of mods is valid.
+     * @return bool
+     */
+    public function getIsValid(): bool
+    {
+        return $this->isValid;
+    }
+
+    /**
+     * Sets the list of validated mods.
+     * @param array|ValidatedMod[] $validatedMods
+     * @return $this
+     */
+    public function setValidatedMods(array $validatedMods): self
+    {
+        $this->validatedMods = $validatedMods;
+        return $this;
+    }
+
+    /**
+     * Adds a validated mod to the list.
+     * @param ValidatedMod $validatedMod
+     * @return $this
+     */
+    public function addValidatedMod(ValidatedMod $validatedMod): self
+    {
+        $this->validatedMods[] = $validatedMod;
+        return $this;
+    }
+
+    /**
+     * Returns the list of validated mods.
+     * @return array|ValidatedMod[]
+     */
+    public function getValidatedMods(): array
+    {
+        return $this->validatedMods;
+    }
+}