Add commands, routes. Update CHANGELOG

Author: tuan-da

.gitignore

@@ -0,0 +1 @@
+vendor

CHANGELOG.md

@@ -4,13 +4,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased](https://gitlab.devsep.com/septech-php/septech-laravel/snowflake/-/compare/v1.0.2...master)
 
-## [Unreleased](https://gitlab.devsep.com/septech-php/septech-laravel/snowflake/-/compare/v1.0.0...master)
+## [v1.0.2 - 2020-09-01](https://github.com/SepteniTechnology/laravel-snowflake/compare/v1.0.1...v1.0.2)
+### Changed
+- Update URL to github
 
-## [v1.0.1 - 2020-08-24](https://gitlab.devsep.com/septech-php/septech-laravel/snowflake/-/compare/v1.0.0...v1.0.1)
+### Added
+- MIT license
+- Built-in middleware
+- Intergrated phpunit
+- Added routes
+- Added `SNOWFLAKE_HTTP_TOKEN` env variable
+- Added `worker:token` command
+
+
+## [v1.0.1 - 2020-08-24](https://github.com/SepteniTechnology/laravel-snowflake/compare/v1.0.0...v1.0.1)
 ### Added
 - Add facades
 
-## [v1.0.0 - 2020-08-21](https://gitlab.devsep.com/septech-php/septech-laravel/snowflake/-/tree/v1.0.0)
+
+## [v1.0.0 - 2020-08-21](https://github.com/SepteniTechnology/laravel-snowflake/tree/v1.0.0)
 ### Added
 - Release version 1.0 🚀🚀🚀

Console/Commands/Env.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Septech\Snowflake\Console\Commands;
+
+class Env
+{
+    protected $filepath;
+
+    protected $attributes = [];
+
+    public function __construct($filepath)
+    {
+        $this->filepath = $filepath;
+    }
+
+    public function get($key, $default = null)
+    {
+        return env($key, $default);
+    }
+
+    public function has($key)
+    {
+        return env($key, $this) !== $this;
+    }
+
+    public function replace($key, $value)
+    {
+        $replacement = sprintf("/^\s*($key)\s*=\s*(.*)?\s*$/m", $key);
+
+        file_put_contents($this->filepath, preg_replace(
+            $replacement,
+            $key.'='.$value,
+            file_get_contents($this->filepath)
+        ));
+    }
+
+    public function put($key, $value)
+    {
+        $this->has($key) ? $this->replace($key, $value) : $this->write($key, $value);
+    }
+
+    public function write($key, $value)
+    {
+        file_put_contents($this->filepath, sprintf("%s=%s\n", $key, $value), FILE_APPEND);
+    }
+}

Console/Commands/WorkerAllocateCommand.php

@@ -32,34 +32,25 @@ public function handle()
 
         $instanceId = AllocatedWorker::allocateFor($machineId);
 
-        if (! $this->hasEnvironment('SNOWFLAKE_WORKER_ID')) {
+        $env = new Env($this->laravel->environmentFilePath());
+        
+        if (! $env->has('SNOWFLAKE_WORKER_ID')) {
             $workerId = AllocatedWorker::workerId($instanceId);
 
             $this->info("Assigning worker:" . json_encode(["machine_id" => $machineId, 'worker_id' => $workerId]));
-            $this->putEnvironment('SNOWFLAKE_WORKER_ID', $workerId);
+            $env->write('SNOWFLAKE_WORKER_ID', $workerId);
         }
 
-        if (! $this->hasEnvironment('SNOWFLAKE_DATACENTER_ID')) {
+        if (! $env->has('SNOWFLAKE_DATACENTER_ID')) {
             $dataCenterId = AllocatedWorker::dataCenterId($instanceId);
 
             $this->info("Assigning data center:" . json_encode(["machine_id" => $machineId, 'data_center_id' => $dataCenterId]));
-            $this->putEnvironment('SNOWFLAKE_DATACENTER_ID', $dataCenterId);
+            $env->write('SNOWFLAKE_DATACENTER_ID', $dataCenterId);
         }
 
         $this->info('OK');
     }
 
-    protected function putEnvironment($key, $value)
-    {
-        $envPath = app()->environmentFilePath();
-        file_put_contents($envPath, sprintf("%s=\"%s\"\n", $key, $value), FILE_APPEND);
-    }
-
-    protected function hasEnvironment($key)
-    {
-        return env($key, $this) !== $this;
-    }
-
     protected function getInstanceId()
     {
         if (app()->environment('local')) {

Console/Commands/WorkerTokenCommand.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Septech\Snowflake\Console\Commands;
+
+use Illuminate\Support\Str;
+use Illuminate\Console\Command;
+
+class WorkerTokenCommand extends Command
+{
+    protected $signature = 'worker:token {--force : Overrides the generated token}';
+
+    protected $description = 'Generate server token using to release & assign worker via API';
+
+    public function handle()
+    {
+        $env = new Env($this->laravel->environmentFilePath());
+
+        $write = ! $env->has("SNOWFLAKE_HTTP_TOKEN") || $this->option('force');
+
+        if ($write || $this->confirm("The token was assigned. Do you want overrides it?")) {
+            $token = Str::random(64);
+
+            $env->put("SNOWFLAKE_HTTP_TOKEN", $token);
+
+            $this->line("Token: <comment>$token</comment>");
+            $this->info("Application key set successfully.");
+        }
+    }
+}

Facades/Snowflake.php

@@ -19,4 +19,9 @@ public static function next()
     {
         return static::getFacadeRoot()->id();
     }
+
+    public static function routes()
+    {
+        require_once __DIR__ . '/../routes.php';
+    }
 }

Http/Controllers/AllocatedWorkerController.php

@@ -2,7 +2,6 @@
 
 namespace Septech\Snowflake\Http\Controllers;
 
-use Septech\Http\Response;
 use Illuminate\Http\Request;
 use Illuminate\Foundation\Validation\ValidatesRequests;
 use Septech\Snowflake\AllocatedWorker;
@@ -19,9 +18,12 @@ public function allocate(Request $request)
 
         $instanceId = AllocatedWorker::allocateFor($data['machine_id']);
 
-        return Response::success([
-            'worker_id' => AllocatedWorker::workerId($instanceId),
-            'data_center_id' => AllocatedWorker::dataCenterId($instanceId),
+        return response()->json([
+            'ok' => true,
+            'data' => [
+                'worker_id' => AllocatedWorker::workerId($instanceId),
+                'data_center_id' => AllocatedWorker::dataCenterId($instanceId),
+            ],
         ]);
     }
 
@@ -33,6 +35,8 @@ public function release(Request $request)
 
         AllocatedWorker::release($data['machine_id']);
 
-        return Response::ok();
+        return response()->json([
+            'ok' => true
+        ]);
     }
 }

Http/Controllers/Middleware/ServerToken.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Septech\Snowflake\Http\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+
+class ServerToken
+{
+    /**
+     * Handle an incoming request.
+     *
+     * @param  Request  $request
+     * @param  Closure  $next
+     * @return mixed
+     */
+    public function handle(Request $request, Closure $next)
+    {
+        $secret = config('snowflake.sever_to_server_token');
+        $token = $request->header('Authorization');
+
+        if ($token) {
+            // Remove Bearer text
+            $token = substr($token, 7);
+        }
+
+        if (! $token) {
+            $token = $request->get('token');
+        }
+
+        if ($token !== $secret) {
+            abort(403);
+        }
+
+        return $next($request);
+    }
+}

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Septeni Technology
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -4,6 +4,18 @@
 
 ```php
 composer require septech-laravel/snowflake
+
+# Public config
+php artisan vendor:publish --provider="Septech\\Snowflake\\SnowflakeServiceProvider"
+```
+
+## Environment
+
+```
+
+# 
+SNOWFLAKE_EPOCH="2019-07-01 00:00:00"
+
 ```
 
 ## Usages
@@ -17,3 +29,77 @@ Snowflake::id();
 Snowflake::parseId('6696174721395998720');
 
 ```
+
+## Zookeeper
+
+To use the Zookeeper we need a DB connection to keep tracking assigned IDs & machine owned that ID.
+
+### Migration database
+
+```sh
+# Migrate database schema
+php artisan migrate
+
+# Assign the worker id to .env for current marchine.
+# It will take the hostname from AWS or get the hostname by gethostname()
+php artisan worker:allocate
+```
+
+### API
+
+
+#### Register routes
+
+```php
+// -- routes/api.php
+use Septech\Snowflake\Facades\Snowflake;
+
+Snowflake::routes();
+```
+
+#### Wrap routes within group
+
+```php
+use Septech\Snowflake\Facades\Snowflake;
+
+Route::group(['prefix' => '/snowflake'], function () {
+    Snowflake::routes();
+});
+
+```
+
+#### Apply the built-in middleware
+
+We provides a simple middleware to protect the API. The middleware will take token from the `Authorization` header. Or from $_GET['token'] or $_POST['token']. Then compare with a secret key set by config `snowflake.sever_to_server_token` or `env('SNOWFLAKE_HTTP_TOKEN')`. You can set the key manually or run command
+
+```
+php artisan worker:token
+```
+
+**Force it to override**
+```
+php artisan worker:token --force
+```
+
+```php
+Route::group(['middleware' => \Septech\Snowflake\Http\Middleware\ServerToken::class], function () {
+    Snowflake::routes();
+});
+
+```
+
+#### Using Kernel routeMiddleware
+
+```php
+// app/Http/Kernel.php
+protected $routeMiddleware = [
+    // ...
+    'server_token' => \Septech\Snowflake\Http\Middleware\ServerToken::class
+    // ...
+];
+
+// routes/api.php
+Route::group(['middleware' => 'server_token'], function () {
+    Snowflake::routes();
+});
+```

SnowflakeServiceProvider.php

@@ -7,6 +7,7 @@
 use Illuminate\Foundation\Application;
 use Illuminate\Support\ServiceProvider;
 use Septech\Snowflake\Console\Commands\WorkerAllocateCommand;
+use Septech\Snowflake\Console\Commands\WorkerTokenCommand;
 
 class SnowflakeServiceProvider extends ServiceProvider
 {
@@ -26,7 +27,7 @@ public function register()
         ], 'snowflake');
 
         // Register commands
-        $this->commands([WorkerAllocateCommand::class]);
+        $this->commands([WorkerAllocateCommand::class, WorkerTokenCommand::class]);
     }
 
     protected function registerSnowflakeInstance()