Merge pull request #10 from factorio-item-browser/feature/list-endpoints

feature/list-endpoints

Author: BluePsyduck

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 3.1.0 - 2020-05-02
+
+### Added
+
+- New `/item/list` and `recipe/list` requests.
+
 ## 3.0.0 - 2020-04-15
 
 ### Added

config/api-client.php

@@ -23,10 +23,12 @@
                 Endpoint\Generic\GenericDetailsEndpoint::class,
                 Endpoint\Generic\GenericIconEndpoint::class,
                 Endpoint\Item\ItemIngredientEndpoint::class,
+                Endpoint\Item\ItemListEndpoint::class,
                 Endpoint\Item\ItemProductEndpoint::class,
                 Endpoint\Item\ItemRandomEndpoint::class,
                 Endpoint\Mod\ModListEndpoint::class,
                 Endpoint\Recipe\RecipeDetailsEndpoint::class,
+                Endpoint\Recipe\RecipeListEndpoint::class,
                 Endpoint\Recipe\RecipeMachinesEndpoint::class,
                 Endpoint\Search\SearchQueryEndpoint::class,
             ],

config/dependencies.php

@@ -27,10 +27,12 @@
             Endpoint\Generic\GenericDetailsEndpoint::class => InvokableFactory::class,
             Endpoint\Generic\GenericIconEndpoint::class => InvokableFactory::class,
             Endpoint\Item\ItemIngredientEndpoint::class => InvokableFactory::class,
+            Endpoint\Item\ItemListEndpoint::class => InvokableFactory::class,
             Endpoint\Item\ItemProductEndpoint::class => InvokableFactory::class,
             Endpoint\Item\ItemRandomEndpoint::class => InvokableFactory::class,
             Endpoint\Mod\ModListEndpoint::class => InvokableFactory::class,
             Endpoint\Recipe\RecipeDetailsEndpoint::class => InvokableFactory::class,
+            Endpoint\Recipe\RecipeListEndpoint::class => InvokableFactory::class,
             Endpoint\Recipe\RecipeMachinesEndpoint::class => InvokableFactory::class,
             Endpoint\Search\SearchQueryEndpoint::class => InvokableFactory::class,
 

config/serializer/Request.Item.ItemListRequest.yaml

@@ -0,0 +1,10 @@
+FactorioItemBrowser\Api\Client\Request\Item\ItemListRequest:
+  access_type: public_method
+  exclusion_policy: all
+  properties:
+    numberOfResults:
+      type: integer
+    indexOfFirstResult:
+      type: integer
+    numberOfRecipesPerResult:
+      type: integer

config/serializer/Request.Recipe.RecipeListRequest.yaml

@@ -0,0 +1,8 @@
+FactorioItemBrowser\Api\Client\Request\Recipe\RecipeListRequest:
+  access_type: public_method
+  exclusion_policy: all
+  properties:
+    numberOfResults:
+      type: integer
+    indexOfFirstResult:
+      type: integer

config/serializer/Response.Item.ItemListResponse.yaml

@@ -0,0 +1,8 @@
+FactorioItemBrowser\Api\Client\Response\Item\ItemListResponse:
+  access_type: public_method
+  exclusion_policy: all
+  properties:
+    items:
+      type: array<FactorioItemBrowser\Api\Client\Entity\GenericEntityWithRecipes>
+    totalNumberOfResults:
+      type: integer

config/serializer/Response.Recipe.RecipeListResponse.yaml

@@ -0,0 +1,8 @@
+FactorioItemBrowser\Api\Client\Response\Recipe\RecipeListResponse:
+  access_type: public_method
+  exclusion_policy: all
+  properties:
+    recipes:
+      type: array<FactorioItemBrowser\Api\Client\Entity\RecipeWithExpensiveVersion>
+    totalNumberOfResults:
+      type: integer

src/Endpoint/Item/ItemListEndpoint.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FactorioItemBrowser\Api\Client\Endpoint\Item;
+
+use FactorioItemBrowser\Api\Client\Endpoint\EndpointInterface;
+use FactorioItemBrowser\Api\Client\Request\Item\ItemListRequest;
+use FactorioItemBrowser\Api\Client\Response\Item\ItemListResponse;
+
+/**
+ * The endpoint of the item list request.
+ *
+ * @author BluePsyduck <bluepsyduck@gmx.com>
+ * @license http://opensource.org/licenses/GPL-3.0 GPL v3
+ */
+class ItemListEndpoint implements EndpointInterface
+{
+    /**
+     * Returns the request class supported by the endpoint.
+     * @return string
+     */
+    public function getSupportedRequestClass(): string
+    {
+        return ItemListRequest::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 'item/list';
+    }
+
+    /**
+     * Creates the response of the endpoint.
+     * @return string
+     */
+    public function getResponseClass(): string
+    {
+        return ItemListResponse::class;
+    }
+}

src/Endpoint/Recipe/RecipeListEndpoint.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FactorioItemBrowser\Api\Client\Endpoint\Recipe;
+
+use FactorioItemBrowser\Api\Client\Endpoint\EndpointInterface;
+use FactorioItemBrowser\Api\Client\Request\Recipe\RecipeListRequest;
+use FactorioItemBrowser\Api\Client\Response\Recipe\RecipeListResponse;
+
+/**
+ * The endpoint of the recipe list request.
+ *
+ * @author BluePsyduck <bluepsyduck@gmx.com>
+ * @license http://opensource.org/licenses/GPL-3.0 GPL v3
+ */
+class RecipeListEndpoint implements EndpointInterface
+{
+    /**
+     * Returns the request class supported by the endpoint.
+     * @return string
+     */
+    public function getSupportedRequestClass(): string
+    {
+        return RecipeListRequest::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 'recipe/list';
+    }
+
+    /**
+     * Creates the response of the endpoint.
+     * @return string
+     */
+    public function getResponseClass(): string
+    {
+        return RecipeListResponse::class;
+    }
+}

src/Request/Item/ItemListRequest.php

@@ -0,0 +1,94 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FactorioItemBrowser\Api\Client\Request\Item;
+
+use FactorioItemBrowser\Api\Client\Request\RequestInterface;
+
+/**
+ * The request of the item list.
+ *
+ * @author BluePsyduck <bluepsyduck@gmx.com>
+ * @license http://opensource.org/licenses/GPL-3.0 GPL v3
+ */
+class ItemListRequest implements RequestInterface
+{
+    /**
+     * The number of results to return.
+     * @var int
+     */
+    protected $numberOfResults = 10;
+
+    /**
+     * The 0-based index of the first result to return.
+     * @var int
+     */
+    protected $indexOfFirstResult = 0;
+
+    /**
+     * The number of recipes to return for each result.
+     * @var int
+     */
+    protected $numberOfRecipesPerResult = 3;
+
+    /**
+     * Sets the number of results to return.
+     * @param int $numberOfResults
+     * @return $this
+     */
+    public function setNumberOfResults(int $numberOfResults): self
+    {
+        $this->numberOfResults = $numberOfResults;
+        return $this;
+    }
+
+    /**
+     * Returns the number of results to return.
+     * @return int
+     */
+    public function getNumberOfResults(): int
+    {
+        return $this->numberOfResults;
+    }
+
+    /**
+     * Sets the 0-based index of the first result to return.
+     * @param int $indexOfFirstResult
+     * @return $this
+     */
+    public function setIndexOfFirstResult(int $indexOfFirstResult): self
+    {
+        $this->indexOfFirstResult = $indexOfFirstResult;
+        return $this;
+    }
+
+    /**
+     * Returns the 0-based index of the first result to return.
+     * @return int
+     */
+    public function getIndexOfFirstResult(): int
+    {
+        return $this->indexOfFirstResult;
+    }
+
+    /**
+     * Sets the number of recipes to return for each result.
+     * @param int $numberOfRecipesPerResult
+     * @return $this
+     */
+    public function setNumberOfRecipesPerResult(int $numberOfRecipesPerResult): self
+    {
+        $this->numberOfRecipesPerResult = $numberOfRecipesPerResult;
+        return $this;
+    }
+
+    /**
+     * Returns the the number of recipes to return for each result.
+     * @return int
+     */
+    public function getNumberOfRecipesPerResult(): int
+    {
+        return $this->numberOfRecipesPerResult;
+    }
+}