Merge branch 'master' of github.com:mixerapi/mixerapi-dev

cnizzardini · cnizzardini · commit 8c0941e7ba2e · 2021-07-19T22:45:29.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,8 @@
 /mixerapi_dev_test
 /src/Controller/*
 /coverage-reports/
+/plugins/cakephp-swagger-bake
+/plugins/cakephp-swagger-bake/*
 
 # MKDOCS                 #
 ##########################
diff --git a/composer.json b/composer.json
@@ -91,11 +91,24 @@
         "phpstan": "phpstan analyse plugins/*/src",
         "phpmd": "phpmd plugins --exclude tests,assets,config ansi phpmd.xml",
         "coverage": "phpunit --coverage-html coverage-reports/",
-        "mkdocs-run": "docker run --rm -it --network=host -v ${PWD}:/docs --user $(id -u):$(id -g) systematical/mixerapidocs:latest",
+        "mkdocs-run": [
+            "@cakephp-swagger-bake",
+            "docker run --rm -it --network=host -v ${PWD}:/docs --user $(id -u):$(id -g) systematical/mixerapidocs:latest"
+        ],
         "mkdocs-build": [
             "docker pull systematical/mixerapidocs:latest",
             "git pull",
+            "@cakephp-swagger-bake",
             "docker run --rm --network=host -v ${PWD}:/docs --user $(id -u):$(id -g) systematical/mixerapidocs:latest mkdocs build"
+        ],
+        "cakephp-swagger-bake": [
+            "rm -rf plugins/cakephp-swagger-bake",
+            "git clone https://github.com/cnizzardini/cakephp-swagger-bake plugins/cakephp-swagger-bake",
+            "rm -rf plugins/cakephp-swagger-bake/.github plugins/cakephp-swagger-bake/assets",
+            "rm -rf plugins/cakephp-swagger-bake/src plugins/cakephp-swagger-bake/templates",
+            "rm -rf plugins/cakephp-swagger-bake/tests plugins/cakephp-swagger-bake/webroot",
+            "rm -rf plugins/cakephp-swagger-bake/*.xml plugins/cakephp-swagger-bake/*.json",
+            "rm -rf plugins/cakephp-swagger-bake/*.gitignore plugins/cakephp-swagger-bake/*.neon"
         ]
     },
     "prefer-stable": true,
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -50,7 +50,11 @@ nav:
 - Crud Services: /plugins/crud
 - Event Listeners: /event-listeners
 - Exception Rendering: /plugins/exception-render
-- OpenAPI (Swagger): /cakephp-swagger-bake
+- OpenAPI (Swagger):
+  - Documentation: /plugins/cakephp-swagger-bake
+  - Annotations: /plugins/cakephp-swagger-bake/docs/annotations
+  - Events: /plugins/cakephp-swagger-bake/docs/events
+  - Extensions: /plugins/cakephp-swagger-bake/docs/extensions
 - Response Formats:
   - JSON / XML: /plugins/collection-view
   - HAL+JSON: /plugins/hal-view
diff --git a/plugins/crud/src/CrudServiceProvider.php b/plugins/crud/src/CrudServiceProvider.php
@@ -16,6 +16,9 @@
 use MixerApi\Crud\Services\Search;
 use MixerApi\Crud\Services\Update;
 
+/**
+ * @experimental
+ */
 class CrudServiceProvider extends ServiceProvider
 {
     /**
diff --git a/plugins/crud/src/Deserializer.php b/plugins/crud/src/Deserializer.php
@@ -8,6 +8,9 @@
 use Cake\Http\ServerRequest;
 use Cake\Utility\Xml;
 
+/**
+ * @experimental
+ */
 class Deserializer
 {
     /**
diff --git a/plugins/crud/src/Exception/ResourceWriteException.php b/plugins/crud/src/Exception/ResourceWriteException.php
@@ -7,6 +7,9 @@
 use Cake\Http\Exception\HttpException;
 use Throwable;
 
+/**
+ * @experimental
+ */
 class ResourceWriteException extends HttpException
 {
     /**
diff --git a/plugins/crud/src/Interfaces/CreateInterface.php b/plugins/crud/src/Interfaces/CreateInterface.php
@@ -6,6 +6,9 @@
 use Cake\Controller\Controller;
 use Cake\Datasource\EntityInterface;
 
+/**
+ * @experimental
+ */
 interface CreateInterface
 {
     /**
diff --git a/plugins/crud/src/Interfaces/DeleteInterface.php b/plugins/crud/src/Interfaces/DeleteInterface.php
@@ -5,6 +5,9 @@
 
 use Cake\Controller\Controller;
 
+/**
+ * @experimental
+ */
 interface DeleteInterface
 {
     /**
diff --git a/plugins/crud/src/Interfaces/ReadInterface.php b/plugins/crud/src/Interfaces/ReadInterface.php
@@ -6,6 +6,9 @@
 use Cake\Controller\Controller;
 use Cake\Datasource\EntityInterface;
 
+/**
+ * @experimental
+ */
 interface ReadInterface
 {
     /**
diff --git a/plugins/crud/src/Interfaces/SearchInterface.php b/plugins/crud/src/Interfaces/SearchInterface.php
@@ -7,6 +7,9 @@
 use Cake\Datasource\ResultSetInterface;
 use Cake\ORM\Query;
 
+/**
+ * @experimental
+ */
 interface SearchInterface
 {
     /**
diff --git a/plugins/crud/src/Interfaces/UpdateInterface.php b/plugins/crud/src/Interfaces/UpdateInterface.php
@@ -6,6 +6,9 @@
 use Cake\Controller\Controller;
 use Cake\Datasource\EntityInterface;
 
+/**
+ * @experimental
+ */
 interface UpdateInterface
 {
     /**
diff --git a/plugins/crud/src/Plugin.php b/plugins/crud/src/Plugin.php
@@ -8,9 +8,12 @@
 use Cake\Core\PluginApplicationInterface;
 use Cake\Event\Event;
 use Cake\Event\EventManager;
+use Cake\Http\Exception\MethodNotAllowedException;
 
 /**
  * Plugin for Crud
+ *
+ * @experimental
  */
 class Plugin extends BasePlugin
 {
@@ -108,7 +111,13 @@ private function allowedMethodsEvent(): void
             $action = $controller->getRequest()->getParam('action');
 
             if (is_array($this->allowedMethods) && isset($this->allowedMethods[$action])) {
-                $controller->getRequest()->allowMethod($this->allowedMethods[$action]);
+                try {
+                    $controller->getRequest()->allowMethod($this->allowedMethods[$action]);
+                } catch (MethodNotAllowedException $e) {
+                    throw new MethodNotAllowedException(
+                        'Method Not Allowed. Must be one of: ' . implode($this->allowedMethods[$action])
+                    );
+                }
             }
         });
     }
diff --git a/plugins/crud/src/Services/Create.php b/plugins/crud/src/Services/Create.php
@@ -11,6 +11,9 @@
 use MixerApi\Crud\Exception\ResourceWriteException;
 use MixerApi\Crud\Interfaces\CreateInterface;
 
+/**
+ * @experimental
+ */
 class Create implements CreateInterface
 {
     use CrudTrait;
diff --git a/plugins/crud/src/Services/CrudTrait.php b/plugins/crud/src/Services/CrudTrait.php
@@ -6,6 +6,9 @@
 use Cake\Controller\Controller;
 use InvalidArgumentException;
 
+/**
+ * @experimental
+ */
 trait CrudTrait
 {
     /**
diff --git a/plugins/crud/src/Services/Delete.php b/plugins/crud/src/Services/Delete.php
@@ -10,6 +10,9 @@
 use MixerApi\Crud\Exception\ResourceWriteException;
 use MixerApi\Crud\Interfaces\DeleteInterface;
 
+/**
+ * @experimental
+ */
 class Delete implements DeleteInterface
 {
     use CrudTrait;
diff --git a/plugins/crud/src/Services/Read.php b/plugins/crud/src/Services/Read.php
@@ -9,6 +9,9 @@
 use Cake\ORM\TableRegistry;
 use MixerApi\Crud\Interfaces\ReadInterface;
 
+/**
+ * @experimental
+ */
 class Read implements ReadInterface
 {
     use CrudTrait;
diff --git a/plugins/crud/src/Services/Search.php b/plugins/crud/src/Services/Search.php
@@ -11,6 +11,9 @@
 use Cake\ORM\TableRegistry;
 use MixerApi\Crud\Interfaces\SearchInterface;
 
+/**
+ * @experimental
+ */
 class Search implements SearchInterface
 {
     use CrudTrait;
diff --git a/plugins/crud/src/Services/Update.php b/plugins/crud/src/Services/Update.php
@@ -11,6 +11,9 @@
 use MixerApi\Crud\Exception\ResourceWriteException;
 use MixerApi\Crud\Interfaces\UpdateInterface;
 
+/**
+ * @experimental
+ */
 class Update implements UpdateInterface
 {
     use CrudTrait;
diff --git a/plugins/mixerapi/README.md b/plugins/mixerapi/README.md
@@ -87,6 +87,7 @@ MixerAPI automatically installs the following plugins for your RESTful API proje
 | ------------- | ------------- |
 | [MixerApi/Bake](https://github.com/mixerapi/bake) | A custom bake template focused on creating RESTful CakePHP controllers in seconds |
 | [MixerApi/CollectionView](https://github.com/mixerapi/collection-view) | A Collection View for displaying configurable pagination meta-data in JSON or XML collection responses |
+| [MixerApi/Crud](https://github.com/mixerapi/crud) | A service provider for CRUD (Create/Read/Update/Delete) operations. Since this plugin uses the experimental CakePHP dependency injection it must be enabled separately. |
 | [MixerApi/ExceptionRender](https://github.com/mixerapi/exception-render) | Handles rendering entity validation errors and other exceptions for your API |
 | [MixerApi/HalView](https://github.com/mixerapi/hal-view) | A Hypertext Application Language ([HAL+JSON](http://stateless.co/hal_specification.html)) View for CakePHP |
 | [MixerApi/JsonLdView](https://github.com/mixerapi/json-ld-view) | A [JSON-LD](https://json-ld.org/) View for CakePHP |

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,9 @@`
`16`	`16`	`use MixerApi\Crud\Services\Search;`
`17`	`17`	`use MixerApi\Crud\Services\Update;`
`18`	`18`
	`19`	`+/**`
	`20`	`+ * @experimental`
	`21`	`+ */`
`19`	`22`	`class CrudServiceProvider extends ServiceProvider`
`20`	`23`	`{`
`21`	`24`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,9 @@`
`8`	`8`	`use Cake\Http\ServerRequest;`
`9`	`9`	`use Cake\Utility\Xml;`
`10`	`10`
	`11`	`+/**`
	`12`	`+ * @experimental`
	`13`	`+ */`
`11`	`14`	`class Deserializer`
`12`	`15`	`{`
`13`	`16`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,9 @@`
`7`	`7`	`use Cake\Http\Exception\HttpException;`
`8`	`8`	`use Throwable;`
`9`	`9`
	`10`	`+/**`
	`11`	`+ * @experimental`
	`12`	`+ */`
`10`	`13`	`class ResourceWriteException extends HttpException`
`11`	`14`	`{`
`12`	`15`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,9 @@`
`6`	`6`	`use Cake\Controller\Controller;`
`7`	`7`	`use Cake\Datasource\EntityInterface;`
`8`	`8`
	`9`	`+/**`
	`10`	`+ * @experimental`
	`11`	`+ */`
`9`	`12`	`interface CreateInterface`
`10`	`13`	`{`
`11`	`14`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`
`6`	`6`	`use Cake\Controller\Controller;`
`7`	`7`
	`8`	`+/**`
	`9`	`+ * @experimental`
	`10`	`+ */`
`8`	`11`	`interface DeleteInterface`
`9`	`12`	`{`
`10`	`13`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,9 @@`
`7`	`7`	`use Cake\Datasource\ResultSetInterface;`
`8`	`8`	`use Cake\ORM\Query;`
`9`	`9`
	`10`	`+/**`
	`11`	`+ * @experimental`
	`12`	`+ */`
`10`	`13`	`interface SearchInterface`
`11`	`14`	`{`
`12`	`15`	`/**`