Structure

Author: José Fernando Cordova

.docker/Dockerfile

@@ -0,0 +1,42 @@
+FROM php:7.1.8-apache
+
+MAINTAINER jfernancordova@gmail.com
+
+# apt-get
+RUN apt-get update
+RUN apt-get -y install bzip2 git nano wget zip unzip
+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
+
+# docker-php ext-install:
+RUN docker-php-ext-install mcrypt
+RUN docker-php-ext-install zip
+
+# pdo_mysql
+RUN docker-php-ext-install pdo_mysql
+
+# rsyslog: (for Loggly etc)
+RUN apt-get update && apt-get -y install rsyslog && apt-get clean
+RUN sed -i '1s/^/$MaxMessageSize 64k\n/' /etc/rsyslog.conf
+
+# composer:
+COPY .docker/composer-install.sh /tmp
+RUN /tmp/composer-install.sh && mv /usr/local/bin/composer.phar /usr/local/bin/composer
+
+# DIR
+WORKDIR /docker-laravel-api-dev
+COPY . ./
+
+# apache:
+COPY .docker/vhost.conf /etc/apache2/sites-available/000-default.conf
+
+# composer configuration:
+COPY ./composer.json ./composer.json
+COPY ./composer.lock ./composer.lock
+
+# www-data:
+RUN chown -R www-data:www-data ./ && a2enmod rewrite
+USER root

.docker/composer-install.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+EXPECTED_SIGNATURE=$(wget -q -O - https://composer.github.io/installer.sig)
+php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
+ACTUAL_SIGNATURE=$(php -r "echo hash_file('SHA384', 'composer-setup.php');")
+
+if [ "$EXPECTED_SIGNATURE" != "$ACTUAL_SIGNATURE" ]
+then
+    >&2 echo 'ERROR: Invalid installer signature'
+    rm composer-setup.php
+    exit 1
+fi
+
+php composer-setup.php --install-dir=/usr/local/bin --quiet
+RESULT=$?
+rm composer-setup.php
+exit $RESULT

.docker/vhost.conf

@@ -0,0 +1,11 @@
+<VirtualHost *:80>
+    DocumentRoot /docker-laravel-api-dev/public
+
+    <Directory "/docker-laravel-api-dev/public">
+        AllowOverride all
+        Require all granted
+    </Directory>
+
+    ErrorLog ${APACHE_LOG_DIR}/error.log
+    CustomLog ${APACHE_LOG_DIR}/access.log combined
+</VirtualHost>

.dockerignore

@@ -0,0 +1,2 @@
+-/.docker/local-mysql-datadir
+/vendor

.env.example

@@ -0,0 +1,41 @@
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=true
+APP_LOG_LEVEL=debug
+APP_URL=http://localhost
+
+DB_CONNECTION=mysql
+DB_HOST=db
+DB_PORT=3306
+DB_DATABASE=apiLaravelDocker
+DB_USERNAME=apiLaravelDocker
+DB_PASSWORD=apiLaravelDocker
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=file
+SESSION_DRIVER=file
+QUEUE_DRIVER=sync
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_DRIVER=smtp
+MAIL_HOST=mailtrap.io
+MAIL_PORT=2525
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+
+PUSHER_APP_ID=
+PUSHER_KEY=
+PUSHER_SECRET=
+
+API_PREFIX=api
+API_SUBTYPE=app
+API_VERSION=v1
+
+SIGN_UP_RELEASE_TOKEN=false
+PASSWORD_RESET_RELEASE_TOKEN=false
+
+JWT_SECRET=my-dummy-token

.gitattributes

@@ -0,0 +1,3 @@
+* text=auto
+*.css linguist-vendored
+*.scss linguist-vendored

.gitignore

@@ -2,3 +2,9 @@
 .env.*.php
 .env.php
 .env
+
+\.docker/local-mysql-datadir/
+
+\.idea/
+
+vendor/

.travis.yml

@@ -0,0 +1,21 @@
+sudo: required
+
+language: php
+
+php:
+  # Test against PHP 7.1.8 version ...
+  - 7.1.8
+
+services:
+  - docker
+
+before_script:
+  - chmod +x ./scripts/runtests.sh
+  - docker-compose -f docker-compose.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

app/Api/V1/Controllers/ForgotPasswordController.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace App\Api\V1\Controllers;
+
+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
+    {
+        $user = User::where('email', '=', $request->get('email'))->first();
+        if (!$user) {
+            throw new NotFoundHttpException();
+        }
+
+        $broker = $this->getPasswordBroker();
+        $sendingResponse = $broker->sendResetLink($request->only('email'));
+
+        if ($sendingResponse !== Password::RESET_LINK_SENT) {
+            throw new HttpException(500);
+        }
+
+        ApiResponse::response(200, 'Ok');
+    }
+
+    /**
+     * Get the broker to be used during password reset.
+     *
+     * @return \Illuminate\Contracts\Auth\PasswordBroker
+     */
+    private function getPasswordBroker()
+    {
+        return Password::broker();
+    }
+}

app/Api/V1/Controllers/LoginController.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace App\Api\V1\Controllers;
+
+use App\Helpers\ApiResponse;
+use Illuminate\Http\JsonResponse;
+use Symfony\Component\HttpKernel\Exception\HttpException;
+use Tymon\JWTAuth\JWTAuth;
+use App\Http\Controllers\Controller;
+use App\Api\V1\Requests\LoginRequest;
+use Tymon\JWTAuth\Exceptions\JWTException;
+use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
+use Auth;
+
+class LoginController extends Controller
+{
+    /**
+     * Log the user in
+     *
+     * @param LoginRequest $request
+     * @param JWTAuth $JWTAuth
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function login(LoginRequest $request, JWTAuth $JWTAuth): JsonResponse
+    {
+        $credentials = $request->only(['email', 'password']);
+
+        try {
+            $token = Auth::guard()->attempt($credentials);
+
+            if(!$token) {
+                throw new AccessDeniedHttpException();
+            }
+
+        } catch (JWTException $e) {
+            throw new HttpException(500);
+        }
+
+        ApiResponse::response(200, 'Ok',
+            ['token' => $token, 'expires_in' => Auth::guard()->factory()->getTTL() * 60]);
+    }
+}

app/Api/V1/Controllers/LogoutController.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Api\V1\Controllers;
+
+use App\Helpers\ApiResponse;
+use App\Http\Controllers\Controller;
+use Auth;
+use Illuminate\Http\JsonResponse;
+
+class LogoutController extends Controller
+{
+    /**
+     * Create a new AuthController instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        $this->middleware('auth:api', []);
+    }
+
+    /**
+     * Log the user out (Invalidate the token)
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function logout(): JsonResponse
+    {
+        Auth::guard()->logout();
+        ApiResponse::response(200, 'Ok', ['message' => 'Successfully logged out']);
+    }
+}

app/Api/V1/Controllers/RefreshController.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Api\V1\Controllers;
+use App\Helpers\ApiResponse;
+use App\Http\Controllers\Controller;
+use Auth;
+
+class RefreshController extends Controller
+{
+    /**
+     * Refresh a token.
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function refresh()
+    {
+        $token = Auth::guard()->refresh();
+
+        return ApiResponse::response(200, 'Ok',
+            ['token' => $token, 'expires_in' => Auth::guard()->factory()->getTTL() * 60]);
+
+    }
+}

app/Api/V1/Controllers/ResetPasswordController.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace App\Api\V1\Controllers;
+
+use App\Helpers\ApiResponse;
+use Config;
+use App\User;
+use Illuminate\Http\JsonResponse;
+use Tymon\JWTAuth\JWTAuth;
+use App\Http\Controllers\Controller;
+use Illuminate\Support\Facades\Password;
+use App\Api\V1\Requests\ResetPasswordRequest;
+use Symfony\Component\HttpKernel\Exception\HttpException;
+
+class ResetPasswordController extends Controller
+{
+    /**
+     * @param ResetPasswordRequest $request
+     * @param JWTAuth $JWTAuth
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function resetPassword(ResetPasswordRequest $request, JWTAuth $JWTAuth): JsonResponse
+    {
+        $response = $this->broker()->reset(
+            $this->credentials($request), function ($user, $password) {
+                $this->reset($user, $password);
+            }
+        );
+
+        if($response !== Password::PASSWORD_RESET) {
+            throw new HttpException(500);
+        }
+
+        if(!Config::get('boilerplate.reset_password.release_token')) {
+            return response()->json([
+                'status' => 'ok',
+            ]);
+        }
+
+        $user = User::where('email', '=', $request->get('email'))->first();
+
+        return ApiResponse::response(200, 'Ok', ['token' => $JWTAuth->fromUser($user)]);
+    }
+
+    /**
+     * Get the broker to be used during password reset.
+     *
+     * @return \Illuminate\Contracts\Auth\PasswordBroker
+     */
+    public function broker()
+    {
+        return Password::broker();
+    }
+
+    /**
+     * Get the password reset credentials from the request.
+     *
+     * @param  ResetPasswordRequest  $request
+     * @return array
+     */
+    protected function credentials(ResetPasswordRequest $request)
+    {
+        return $request->only(
+            'email', 'password', 'password_confirmation', 'token'
+        );
+    }
+
+    /**
+     * Reset the given user's password.
+     *
+     * @param  \Illuminate\Contracts\Auth\CanResetPassword  $user
+     * @param  string  $password
+     * @return void
+     */
+    protected function reset($user, $password)
+    {
+        $user->password = $password;
+        $user->save();
+    }
+}