Merge branch 'feature/refactoring' into origin/develop

Author: José Fernando Cordova

.docker/.gitignore

@@ -0,0 +1,2 @@
+/local-mysql-datadir/
+/xdebug.ini

.docker/Dockerfile

@@ -9,7 +9,7 @@ RUN apt-get -y install libmcrypt-dev libzzip-dev zziplib-bin zlib1g-dev
 
 # MySQL client for Initial Tasks
 RUN apt-get update &&\
-	apt-get install -y mysql-client
+        apt-get install -y mysql-client
 
 # docker-php ext-install:
 RUN docker-php-ext-install mcrypt
@@ -37,6 +37,20 @@ COPY .docker/vhost.conf /etc/apache2/sites-available/000-default.conf
 COPY ./composer.json ./composer.json
 COPY ./composer.lock ./composer.lock
 
+RUN composer install --no-dev --no-interaction --no-scripts
+
+# entrypoint
+COPY .docker/docker-php-entrypoint /usr/local/bin/
+
 # www-data:
 RUN chown -R www-data:www-data ./ && a2enmod rewrite
+RUN chown -R www-data:www-data storage
+
+RUN chmod 755 /usr/local/bin/docker-php-entrypoint
+
+# mode-root:
 USER root
+
+HEALTHCHECK --interval=50s \
+            --timeout=600s \
+            CMD curl -f http://localhost/api/hello || exit 1

.docker/docker-php-entrypoint

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+# ENVIRONMENT VARIABLES ----------------------------------
+	cp /docker-laravel-api-dev/.env.example /docker-laravel-api-dev/.env
+
+# Xdebug ----------------------------------------------------
+	if [ "${XDEBUG_MODE}" == 1 ] ; then
+		mkdir -p /docker-laravel-api-dev/.docker/local-mysql-datadir
+		echo 'Installs require-dev dependencies'
+		composer install --no-scripts
+		echo 'Permissions'
+		chmod 777 -R /docker-laravel-api-dev/storage
+		echo 'Installing XDebug...'
+		pecl install xdebug && docker-php-ext-enable xdebug
+		echo 'XDebug installed!'
+	fi
+
+# WAIT FOR MYSQL READY -----------------------------------
+	echo 'Checking MySql...'
+	while !(mysqladmin ping --host=$DB_HOST)
+	do
+		sleep 1
+		echo 'Waiting for MySql...'
+	done
+	echo 'MySql ready!'
+
+# MIGRATIONS -----------------------------------
+	echo 'Running Migrations...'
+	cd /docker-laravel-api-dev
+	php artisan key:generate
+	php artisan jwt:secret -f
+	php artisan migrate
+	echo 'Migrations done!'
+
+# APACHE -----------------------------------
+# first arg is `-f` or `--some-option`
+if [ "${1#-}" != "$1" ]; then
+	set -- apache2-foreground "$@"
+fi
+exec "$@"

.docker/xdebug.ini.template

@@ -0,0 +1,5 @@
+zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20160303/xdebug.so
+
+xdebug.remote_enable=1
+xdebug.remote_host=XXX.XXX.XXX.XXX
+xdebug.remote_log="/tmp/xdebug.log"

.gitignore

@@ -11,11 +11,11 @@ services:
 
 before_script:
   - chmod +x ./scripts/runtests.sh
-  - docker-compose -f docker-compose.yml up --build -d
+  - docker-compose -f docker-compose-dev.yml up --build -d
   - docker ps -a
   - sleep 30  # wait for Mysql to start
 
 script: ./scripts/runtests.sh
 
 after_script:
-  - docker-compose -f docker-compose.yml down
+  - docker-compose -f docker-compose-dev.yml down

.travis.yml

@@ -6,63 +6,50 @@
 * API Laravel Boilerplate 5.5
 * Apache 2
 * MySQL
+* Xdebug
 * Docker
- 
-## Docker Environments
 
-### Swarm Mode
-Clone this respository and run the following commands:
-```bash
-cd docker-laravel-api-dev/
-# Creating mount folder
-mkdir .docker/local-mysql-datadir
-docker stack deploy -c docker-compose.yml docker-laravel-api-dev
-# wait for it and follow the docker instructions!...
-```
-### Docker Compose
-Clone this respository and run the following commands:
-```bash
-cd docker-laravel-api-dev/
-docker-compose -f docker-compose.yml up --build -d
-# wait for it to build and follow the docker instructions!...
-```
-### PWD 
-With Play with Docker and following the docker instructions, it is easy to deploy and test this environment!
+## Environments
+
+To deploy this api boilerplate, there are three options (yaml) and Docker environments with instructions that you should consider:
 
-[![Try in PWD](https://cdn.rawgit.com/play-with-docker/stacks/cff22438/assets/images/button.png)](http://play-with-docker.com?stack=https://raw.githubusercontent.com/jfernancordova/docker-laravel-api-dev/master/docker-compose-pwd.yml)
+### Dev or Local Mode
+* docker-compose-dev.yml: generate automatically folders and require-dev dependencies on your local workspace including Xdebug, however the yaml file has a key called:
+"XDEBUG_MODE", this yaml by default has the value true (1) to install it.
 
-## Docker Instructions
+You can appreciate the dependencies generated automatically on your workspace!
+
+### Play with Docker Mode
+* docker-compose-pwd.yml: you can [![Play With Docker](https://cdn.rawgit.com/play-with-docker/stacks/cff22438/assets/images/button.png)](http://play-with-docker.com?stack=https://raw.githubusercontent.com/jfernancordova/docker-laravel-api-dev/feature/refactoring/docker-compose-pwd.yml), to visualize this environment and test it, however you should see the container lists to verify the HEALTHCHECK. 
 
-### Execute Laravel Pre-requisites
-In the root directory:
 ```bash
 # container lists
 docker ps
-# next, execute an interactive bash shell on the php container.
-docker container exec -t -i [dockerlaravelapidev_php_1 or container Id] bash
+# make sure that the docker dockerlaravelapidev_php_1 or php container is (healthy),
+normally the process begins in starting mode (health: starting),
 ```
-#### Run the following commands:
+### Production Mode
+* docker-compose-prod.yml: if you are going to use this yaml, make sure to generate the migrations before!, however you can modify the entrypoint to generate them.
+
+## Docker Environments
 
-##### Compose and Swarm Mode
+### Swarm Mode
+Clone this respository and run the following commands:
 ```bash
-composer install && cp .env.example .env && php artisan key:generate && php artisan migrate
-chmod 755 -R storage
-# forward to the port 80, go to localhost and enjoy!...
+cd docker-laravel-api-dev/
+docker stack deploy -c docker-compose-dev.yml docker-laravel-api-dev
+# wait for the HEALTHCHECK in healthy mode
 ```
-##### Play With Docker (PWD)
+
+### Docker Compose
+Clone this respository and run the following commands:
 ```bash
-composer install && php artisan migrate
-# forward to the port 80, go to localhost and enjoy!...
+cd docker-laravel-api-dev/
+docker-compose -f docker-compose-dev.yml up --build -d 
+or to see the logs 
+docker-compose -f docker-compose-dev.yml up 
+# wait for the HEALTHCHECK in healthy mode
 ```
 
-### How to fix Error: laravel.log could not be opened?
-In the root directory or inside the container php:
-<pre><code>chmod -R 775 storage </code></pre>
-* 7 - Owner can write
-* 7 - Group can write
-* 5 - Others cannot write!
-Reference:
-https://stackoverflow.com/questions/23411520/how-to-fix-error-laravel-log-could-not-be-opened
-
-### API Boilerplate Reference
+## API Boilerplate Reference
 https://github.com/francescomalatesta/laravel-api-boilerplate-jwt/blob/master/readme.md

LICENSE.md

@@ -0,0 +1,98 @@
+{
+	"info": {
+		"name": "apiLaravelDocker",
+		"_postman_id": "7d5f25d3-239f-4595-aa94-94380953b7b8",
+		"description": "",
+		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+	},
+	"item": [
+		{
+			"name": "http://127.0.0.1/api/auth/signup",
+			"request": {
+				"method": "POST",
+				"header": [],
+				"body": {
+					"mode": "formdata",
+					"formdata": [
+						{
+							"key": "name",
+							"value": "José Fernando Cordova ",
+							"description": "",
+							"type": "text"
+						},
+						{
+							"key": "email",
+							"value": "jfernancordova@gmail.com",
+							"description": "",
+							"type": "text"
+						},
+						{
+							"key": "password",
+							"value": "apiLaravelDocker",
+							"description": "",
+							"type": "text"
+						}
+					]
+				},
+				"url": {
+					"raw": "http://127.0.0.1/api/auth/signup",
+					"protocol": "http",
+					"host": [
+						"127",
+						"0",
+						"0",
+						"1"
+					],
+					"path": [
+						"api",
+						"auth",
+						"signup"
+					]
+				},
+				"description": ""
+			},
+			"response": []
+		},
+		{
+			"name": "http://127.0.0.1/api/auth/login",
+			"request": {
+				"method": "POST",
+				"header": [],
+				"body": {
+					"mode": "formdata",
+					"formdata": [
+						{
+							"key": "email",
+							"value": "jfernancordova3@gmail.com",
+							"description": "",
+							"type": "text"
+						},
+						{
+							"key": "password",
+							"value": "apiLaravelDocker",
+							"description": "",
+							"type": "text"
+						}
+					]
+				},
+				"url": {
+					"raw": "http://127.0.0.1/api/auth/login",
+					"protocol": "http",
+					"host": [
+						"127",
+						"0",
+						"0",
+						"1"
+					],
+					"path": [
+						"api",
+						"auth",
+						"login"
+					]
+				},
+				"description": ""
+			},
+			"response": []
+		}
+	]
+}

README.md

@@ -4,34 +4,31 @@
 
 use App\User;
 use App\Http\Controllers\Controller;
-use Illuminate\Http\JsonResponse;
 use Illuminate\Support\Facades\Password;
 use App\Api\V1\Requests\ForgotPasswordRequest;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
-use App\Helpers\ApiResponse;
 
 class ForgotPasswordController extends Controller
 {
-    /**
-     * @param ForgotPasswordRequest $request
-     * @return \Illuminate\Http\JsonResponse
-     */
-    public function sendResetEmail(ForgotPasswordRequest $request): JsonResponse
+    public function sendResetEmail(ForgotPasswordRequest $request)
     {
         $user = User::where('email', '=', $request->get('email'))->first();
-        if (!$user) {
+
+        if(!$user) {
             throw new NotFoundHttpException();
         }
 
         $broker = $this->getPasswordBroker();
         $sendingResponse = $broker->sendResetLink($request->only('email'));
 
-        if ($sendingResponse !== Password::RESET_LINK_SENT) {
+        if($sendingResponse !== Password::RESET_LINK_SENT) {
             throw new HttpException(500);
         }
 
-        ApiResponse::response(200, 'Ok');
+        return response()->json([
+            'status' => 'ok'
+        ], 200);
     }
 
     /**
@@ -43,4 +40,4 @@ private function getPasswordBroker()
     {
         return Password::broker();
     }
-}
+}