Merge pull request #40 from CakeDC/3.4

3.4

Author: ajibarra

.gitignore

@@ -7,4 +7,5 @@ vendor/
 composer.lock
 tmp
 pmip
-webroot/coverage
+webroot/coverage
+.php_cs.cache

.travis.yml

@@ -3,7 +3,7 @@ language: php
 php:
   - 5.6
   - 7.0
-
+  - 7.1
 sudo: false
 
 env:
@@ -18,11 +18,11 @@ matrix:
   fast_finish: true
 
   include:
-    - php: 5.6
+    - php: 7.1
       env: PHPCS=1 DEFAULT=0
 
-    - php: 5.6
-      env: COVERALLS=1 DEFAULT=0 DB=mysql db_dsn='mysql://travis@0.0.0.0/cakephp_test'
+    - php: 7.1
+      env: CODECOVERAGE=1 DEFAULT=0 DB=mysql db_dsn='mysql://travis@0.0.0.0/cakephp_test'
 
 before_script:
   - composer self-update
@@ -33,14 +33,12 @@ before_script:
 
   - sh -c "if [ '$PHPCS' = '1' ]; then composer require cakephp/cakephp-codesniffer:dev-master; fi"
 
-  - sh -c "if [ '$COVERALLS' = '1' ]; then composer require --dev satooshi/php-coveralls:dev-master; fi"
-  - sh -c "if [ '$COVERALLS' = '1' ]; then mkdir -p build/logs; fi"
-
 script:
-  - sh -c "if [ '$DEFAULT' = '1' ]; then vendor/bin/phpunit --stderr; fi"
+  - sh -c "if [ '$DEFAULT' = '1' ]; then ./vendor/bin/phpunit --stderr; fi"
   - sh -c "if [ '$PHPCS' = '1' ]; then ./vendor/bin/phpcs -p -n --extensions=php --standard=vendor/cakephp/cakephp-codesniffer/CakePHP ./src ./tests; fi"
-  - sh -c "if [ '$COVERALLS' = '1' ]; then vendor/bin/phpunit --stderr --coverage-clover build/logs/clover.xml; fi"
-  - sh -c "if [ '$COVERALLS' = '1' ]; then php vendor/bin/coveralls -c .coveralls.yml -v; fi"
+  - sh -c "if [ '$CODECOVERAGE' = '1' ]; then phpunit --coverage-clover=clover.xml || true; fi"
+  - sh -c "if [ '$CODECOVERAGE' = '1' ]; then wget -O codecov.sh https://codecov.io/bash; fi"
+  - sh -c "if [ '$CODECOVERAGE' = '1' ]; then bash codecov.sh; fi"
 
 notifications:
   email: false

composer.json

@@ -6,7 +6,7 @@
         "cakephp",
         "api",
         "rest",
-        "hateaos",
+        "hateoas",
         "crud"
     ],
     "homepage": "https://github.com/CakeDC/cakephp-api",
@@ -28,16 +28,12 @@
     },
     "require": {
         "php": ">=5.4.16",
-        "cakephp/cakephp": "3.*",
-        "cakedc/users": "^5.0"
+        "cakephp/cakephp": "^3.4",
+        "cakedc/users": "^5.0|^6.0"
     },
     "require-dev": {
-        "cakedc/users": "*" ,
         "phpunit/phpunit": "<6.0"
     },
-    "suggest": {
-        "cakedc/users": "Users Plugin for CakePHP"
-    },
     "autoload": {
         "psr-4": {
             "CakeDC\\Api\\": "src",

config/api.php

@@ -1,11 +1,11 @@
 <?php
 /**
- * Copyright 2016, Cake Development Corporation (http://cakedc.com)
+ * Copyright 2016 - 2017, Cake Development Corporation (http://cakedc.com)
  *
  * Licensed under The MIT License
  * Redistributions of files must retain the above copyright notice.
  *
- * @copyright Copyright 2016, Cake Development Corporation (http://cakedc.com)
+ * @copyright Copyright 2016 - 2017, Cake Development Corporation (http://cakedc.com)
  * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
 
@@ -68,5 +68,11 @@
                 ],
             ],
         ],
+        'Log' => [
+            'className' => 'File',
+            'scopes' => ['api'],
+            'levels' => ['error', 'info'],
+            'file' => 'api.log',
+        ]
     ]
 ];

config/bootstrap.php

@@ -1 +1,28 @@
-<?php/** * Copyright 2016, Cake Development Corporation (http://cakedc.com) * * Licensed under The MIT License * Redistributions of files must retain the above copyright notice. * * @copyright Copyright 2016, Cake Development Corporation (http://cakedc.com) * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */use Cake\Core\Configure;Configure::load('CakeDC/Api.api');collection((array)Configure::read('Api.config'))->each(function ($file) {    Configure::load($file);});
+<?php
+/**
+ * Copyright 2016 - 2017, Cake Development Corporation (http://cakedc.com)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright Copyright 2016 - 2017, Cake Development Corporation (http://cakedc.com)
+ * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
+ */
+
+use Cake\Core\Configure;
+use Cake\Log\Log;
+
+Configure::load('CakeDC/Api.api');
+collection((array)Configure::read('Api.config'))->each(function ($file) {
+    Configure::load($file);
+});
+
+if (!Log::engine('api')) {
+    Log::setConfig('api', [
+        'className' => Configure::read('Api.Log.className'),
+        'path' => LOGS,
+        'scopes' => Configure::read('Api.Log.scopes'),
+        'levels' => Configure::read('Api.Log.levels'),
+        'file' => Configure::read('Api.Log.file'),
+    ]);
+}

config/routes.php

@@ -1,11 +1,11 @@
 <?php
 /**
- * Copyright 2016, Cake Development Corporation (http://cakedc.com)
+ * Copyright 2016 - 2017, Cake Development Corporation (http://cakedc.com)
  *
  * Licensed under The MIT License
  * Redistributions of files must retain the above copyright notice.
  *
- * @copyright Copyright 2016, Cake Development Corporation (http://cakedc.com)
+ * @copyright Copyright 2016 - 2017, Cake Development Corporation (http://cakedc.com)
  * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
 

docs/Documentation/collections.md

@@ -0,0 +1,56 @@
+Collections
+==========
+
+Collection actions allow to process many entities on the same endpoint call. 
+This feature was created to allow easy integration with bulk actions, allowing to 
+delete/edit/add many entities.
+
+Adding collections to your own service is easy, use the `initialize()` method of your Service class.
+
+* Use mapAction, map 3 routes to cover add/edit/delete
+
+```php
+$this->mapAction('bulkAdd', AddEditAction::class, [
+    'method' => ['POST'],
+    'mapCors' => true,
+    'path' => 'bulk'
+]);
+$this->mapAction('bulkEdit', AddEditAction::class, [
+    'method' => ['PUT'],
+    'mapCors' => true,
+    'path' => 'bulk'
+]);
+$this->mapAction('bulkDelete', DeleteAction::class, [
+    'method' => ['DELETE'],
+    'mapCors' => true,
+    'path' => 'bulk'
+]);
+```
+
+If you need additional features, you can extend the specific actions 
+and override the mapping configuration to use your own implementation.
+
+* Using collection endpoints
+
+Here are a couple examples, curl based
+
+  * Edit post with id 15, and add a new post
+
+```
+    curl --request POST \
+      --url http://collections.3dev/api/posts/bulk \
+      --header 'content-type: multipart/form-data; boundary=---011000010111000001101001' \
+      --form '0[title]=edit existing post title for id 15' \
+      --form '1[title]=this is a new post' \
+      --form '0[id]=15'
+```
+  
+  * Delete 2 entities with id's 14 and 15
+  
+  ```
+    curl --request DELETE \
+      --url http://collections.3dev/api/posts/bulk \
+      --header 'content-type: multipart/form-data; boundary=---011000010111000001101001' \
+      --form '1[id]=14' \
+      --form '0[id]=15' 
+  ```

docs/Documentation/crud.md

@@ -63,7 +63,7 @@ curl -i https://myapi.com/api/blogs?limit=1
             "name": "mark",
             "description": "",
             "created": null
-        },
+        }
     ],
     "pagination": {
         "page": 1,
@@ -155,7 +155,7 @@ curl --data "description=Jorge best blog" https://myapi.com/api/blogs/25
 {
     "status": "error",
     "message": "A route matching \"\/blogs\/26\" could not be found.",
-    "code": 404,
+    "code": 404
 }
 ```
 

docs/home.md

@@ -21,6 +21,7 @@ Documentation
 * [Renderers](Documentation/renderers.md)
 * [Statuses](Documentation/status.md)
 * [Versioning](Documentation/versioning.md)
+* [Collections](Documentation/collections.md)
 
 
 

src/Controller/ApiController.php

@@ -1,11 +1,11 @@
 <?php
 /**
- * Copyright 2016, Cake Development Corporation (http://cakedc.com)
+ * Copyright 2016 - 2017, Cake Development Corporation (http://cakedc.com)
  *
  * Licensed under The MIT License
  * Redistributions of files must retain the above copyright notice.
  *
- * @copyright Copyright 2016, Cake Development Corporation (http://cakedc.com)
+ * @copyright Copyright 2016 - 2017, Cake Development Corporation (http://cakedc.com)
  * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
 
@@ -42,7 +42,7 @@ public function initialize()
     /**
      * Process api request
      *
-     * @return \Cake\Http\Client\Response|\Cake\Network\Response|null
+     * @return \Cake\Http\Client\Response|\Cake\Http\Response|null
      */
     public function process()
     {
@@ -81,7 +81,7 @@ public function describe()
      * Process api request
      *
      * @param array $options Options
-     * @return \Cake\Http\Client\Response|\Cake\Network\Response|null
+     * @return \Cake\Http\Client\Response|\Cake\Http\Response|null
      */
     protected function _process($options = [])
     {
@@ -95,8 +95,8 @@ protected function _process($options = [])
                 }
 
                 $url = '/' . $service;
-                if (!empty($this->request->params['pass'])) {
-                    $url .= '/' . join('/', $this->request->params['pass']);
+                if (!empty($this->request->getParam('pass'))) {
+                    $url .= '/' . join('/', $this->request->getParam('pass'));
                 }
                 $options += [
                     'version' => $version,
@@ -111,11 +111,9 @@ protected function _process($options = [])
 
                 return $Service->respond($result);
             }
-            $this->response->statusCode(404);
-            $this->response->body(__('Service not found'));
+            $this->response = $this->response->withStringBody(__('Service not found'))->withStatus(404);
         } catch (Exception $e) {
-            $this->response->statusCode(400);
-            $this->response->body($e->getMessage());
+            $this->response = $this->response->withStringBody($e->getMessage())->withStatus(400);
         }
 
         return $this->response;