自原專案抽離

Author: Shishamou

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2

.gitignore

@@ -0,0 +1,4 @@
+/vendor
+.env
+.php_cs.cache
+.phpunit.result.cache

README.md

@@ -0,0 +1 @@
+# A Laravel package example

composer.json

@@ -0,0 +1,35 @@
+{
+    "name": "a2workspace/laravel-jwt",
+    "description": "提供 Laravel JWT 認證功能",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Shishamou",
+            "email": "shishatw225@gmail.com"
+        }
+    ],
+    "require": {
+        "php": "^7.4|^8.0",
+        "tymon/jwt-auth": "^1.0"
+    },
+    "require-dev": {
+        "orchestra/testbench": "4.x"
+    },
+    "autoload": {
+        "psr-4": {
+            "A2Workspace\\LaravelJwt\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "A2Workspace\\LaravelJwt\\ServiceProvider"
+            ]
+        }
+    }
+}

phpunit.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    bootstrap="vendor/autoload.php"
+    backupGlobals="false"
+    backupStaticAttributes="false"
+    colors="true"
+    verbose="true"
+    convertErrorsToExceptions="true"
+    convertNoticesToExceptions="true"
+    convertWarningsToExceptions="true"
+    processIsolation="false"
+    stopOnFailure="false"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+>
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests/Unit</directory>
+        </testsuite>
+        <testsuite name="Feature">
+            <directory suffix="Test.php">./tests/Feature</directory>
+        </testsuite>
+    </testsuites>
+    <php>
+        <env name="DB_CONNECTION" value="testing"/>
+        <env name="APP_KEY" value="base64:2fl+Ktvkfl+Fuz4Qp/A75G2RTiWVA/ZoKZvp6fiiM10="/>
+        <env name="DB_CONNECTION" value="sqlite"/>
+        <env name="DB_DATABASE" value=":memory:"/>
+    </php>
+</phpunit>

src/AuthenticatesUsers.php

@@ -0,0 +1,117 @@
+<?php
+
+namespace A2Workspace\LaravelJwt;
+
+use Tymon\JWTAuth\JWTGuard;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Auth;
+use Tymon\JWTAuth\Exceptions\JWTException;
+
+trait AuthenticatesUsers
+{
+    /**
+     * 處理登入請求
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\Response
+     */
+    public function login(Request $request)
+    {
+        $credentials = $this->credentials($request);
+
+        if ($token = $this->guard()->attempt($credentials)) {
+            return $this->respondWithToken($token);
+        }
+
+        return response()->json(['error' => 'Unauthorized'], 401);
+    }
+
+    /**
+     * 自 Request 取得驗證所需的欄位
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return array
+     */
+    protected function credentials(Request $request)
+    {
+        return $request->only($this->username(), 'password');
+    }
+
+    /**
+     * 回傳驗證守衛。
+     *
+     * @return \Tymon\JWTAuth\JWTGuard
+     */
+    protected function guard(): JWTGuard
+    {
+        return Auth::guard('api');
+    }
+
+    /**
+     * 取得驗證使用者名稱的欄位
+     *
+     * @return string
+     */
+    protected function username()
+    {
+        return 'username';
+    }
+
+    /**
+     * Get the token array structure.
+     *
+     * @param  string $token
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
+    protected function respondWithToken($token)
+    {
+        return response()->json([
+            'access_token' => $token,
+            'token_type' => 'bearer',
+            'expires_in' => $this->guard()->factory()->getTTL() * 60
+        ]);
+    }
+
+    /**
+     * 處理登出請求
+     *
+     * @param \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\Response
+     */
+    public function logout(Request $request)
+    {
+        $this->guard()->logout();
+
+        return response()->json(['message' => 'Successfully logged out']);
+    }
+
+    /**
+     * 刷新 token
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function refresh()
+    {
+        try {
+            return $this->respondWithToken($this->guard()->refresh());
+        } catch (JWTException $e) {
+            return response()->json(['error' => 'Invalid Access Token'], 401);
+        }
+    }
+
+    /**
+     * 回傳當前使用者資訊
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\Response 回傳使用者資訊
+     */
+    public function me(Request $request)
+    {
+        if ($this->guard()->check()) {
+            return response()->json($this->guard()->user());
+        } else {
+            return response()->json(['error' => 'Invalid Access Token'], 401);
+        }
+    }
+}

src/Commands/InstallCommand.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace A2Workspace\LaravelJwt\Commands;
+
+use Illuminate\Console\Command;
+
+class InstallCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'laravel-jwt:install';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = '安裝設置 laravel-jwt';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle()
+    {
+        $this->line('安裝 jwt-auth ...');
+
+        $this->call('vendor:publish', [
+            '--provider' => 'Tymon\JWTAuth\Providers\LaravelServiceProvider',
+        ]);
+
+        $this->call('jwt:secret');
+    }
+}

src/Controllers/AuthController.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace A2Workspace\LaravelJwt\Controllers;
+
+use Illuminate\Routing\Controller;
+use A2Workspace\LaravelJwt\AuthenticatesUsers;
+
+class AuthController extends Controller
+{
+    use AuthenticatesUsers;
+}

src/HasApiTokens.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace A2Workspace\LaravelJwt;
+
+use Tymon\JWTAuth\Facades\JWTAuth;
+
+trait HasApiTokens
+{
+    /**
+     * Get the identifier that will be stored in the subject claim of the JWT.
+     *
+     * @return mixed
+     */
+    public function getJWTIdentifier()
+    {
+        return $this->getKey();
+    }
+
+    /**
+     * Return a key value array, containing any custom claims to be added to the JWT.
+     *
+     * @return array
+     */
+    public function getJWTCustomClaims()
+    {
+        return [];
+    }
+
+    /**
+     * Create a new token for current user.
+     *
+     * @return string
+     */
+    public function createToken(): string
+    {
+        return JWTAuth::fromUser($this);
+    }
+}

src/LaravelJwt.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace A2Workspace\LaravelJwt;
+
+use Illuminate\Support\Facades\Route;
+use Illuminate\Contracts\Routing\Registrar as Router;
+
+class LaravelJwt
+{
+    /**
+     * Binds the routes.
+     *
+     * @param  array  $options
+     * @return void
+     */
+    public static function routes(array $options = [])
+    {
+        $defaultOptions = [
+            'prefix' => '/api/auth',
+            'namespace' => '\A2Workspace\LaravelJwt\Controllers',
+            'as' => 'jwt.',
+        ];
+
+        $options = array_merge($defaultOptions, $options);
+
+        Route::group($options, function ($router) {
+            $router->post('/login', 'AuthController@login')->name('login');
+            $router->post('/logout', 'AuthController@logout')->name('logout');
+            $router->post('/refresh', 'AuthController@refresh')->name('refresh');
+            $router->get('/user', 'AuthController@me')->name('user');
+        });
+    }
+}