chore(package): setup

Author: jfrosorio

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+### Description
+
+Explain what are you submitting.
+
+### Fixes
+
+Enter the issue you are fixing (e.g. This fixes #1.).
+
+
+
+

.gitignore

@@ -0,0 +1 @@
+/.idea

README.md

@@ -1,2 +1,69 @@
-# laravel-api-logs
-Simple package to log requests made to your API.
+# Laravel API Requests Logger
+
+A lightweight Laravel package for logging requests made to your API.
+
+[![Latest version](https://img.shields.io/github/release/CodeTechAgency/laravel-api-logs?style=flat-square)](https://github.com/CodeTechAgency/laravel-api-logs/releases)
+[![GitHub license](https://img.shields.io/github/license/CodeTechAgency/laravel-api-logs?style=flat-square)](https://github.com/CodeTechAgency/laravel-api-logs/blob/master/LICENSE)
+
+## Installation
+
+Add the package to your Laravel application using composer:
+
+```
+composer require codetech/laravel-api-logs
+```
+
+
+### Service Provider
+
+The service provider will be automatically registered during the installation process. However, you can manually register it by adding it to the list of providers located in your `config/app.php` file:
+
+```
+'providers' => [
+    ...
+    Codetech\ApiLogs\Providers\ApiLogServiceProvider::class,
+
+],
+```
+
+
+### Migrations
+
+Publish the migration file:
+
+```
+php artisan vendor:publish --provider=CodeTech\\ApiLogs\\Providers\\ApiLogServiceProvider --tag=migrations
+```
+
+Run the migration:
+```
+php artisan migrate
+```
+
+## Usage
+
+To start logging requests made to your API, you simply add the middleware to the API's route middleware group, located in your `app/Http/Kernel.php`:
+
+```
+protected $middlewareGroups = [
+    ...
+
+    'api' => [
+        ...
+        LogApiRequest::class,
+    ],
+];
+```
+
+
+---
+
+
+## License
+
+**codetech/laravel-api-logs** is open-sourced software licensed under the [MIT license](https://github.com/CodeTechAgency/laravel-api-logs/blob/master/LICENSE).
+
+
+## About CodeTech
+
+[CodeTech](https://www.codetech.pt) is a web development agency based in Matosinhos, Portugal. Oh, and we LOVE Laravel!

composer.json

@@ -0,0 +1,39 @@
+{
+  "name": "codetech/laravel-api-logs",
+  "description": "A lightweight Laravel package for logging requests made to your API.",
+  "keywords": [
+    "codetech",
+    "laravel-api-logs",
+    "api",
+    "logs",
+    "laravel",
+    "laravel-package"
+  ],
+  "authors": [
+    {
+      "name": "José Osório",
+      "email": "jfrosorio@gmail.com",
+      "role": "Developer"
+    }
+  ],
+  "license": "MIT",
+  "require": {
+    "php": "^7.2|^8.0",
+    "illuminate/database": "^7.0|^8.0|^9.0|^10.0",
+    "illuminate/support": "^7.0|^8.0|^9.0|^10.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "CodeTech\\ApiLogs\\": "src/"
+    }
+  },
+  "minimum-stability": "dev",
+  "prefer-stable": true,
+  "extra": {
+    "laravel": {
+      "providers": [
+        "CodeTech\\ApiLogs\\Providers\\ApiLogServiceProvider"
+      ]
+    }
+  }
+}

database/migrations/create_api_logs_table.php.stub

@@ -0,0 +1,38 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateApiLogsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('api_logs', function (Blueprint $table) {
+            $table->id();
+            $table->float('duration');
+            $table->string('url');
+            $table->string('method');
+            $table->ipAddress('ip');
+            $table->json('request_data');
+            $table->json('response_data')->nullable();
+            $table->foreignId('user_id')->nullable()->constrained()->cascadeOnDelete()->cascadeOnUpdate();
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('api_logs');
+    }
+}

src/Http/Middleware/LogApiRequest.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace CodeTech\ApiLogs\Http\Middleware;
+
+use Closure;
+use CodeTech\ApiLogs\Models\ApiLog;
+
+class LogApiRequest
+{
+    /**
+     * Handle an incoming request.
+     *
+     * @param $request
+     * @param  Closure  $next
+     * @return mixed
+     */
+    public function handle($request, Closure $next)
+    {
+        $request->start = microtime(true);
+
+        return $next($request);
+    }
+
+    /**
+     * Handle tasks after the response has been sent to the browser.
+     *
+     * @param $request
+     * @param $response
+     */
+    public function terminate($request, $response)
+    {
+        $request->end = microtime(true);
+
+        $data = [
+            'duration' => $request->end - $request->start,
+            'url' => $request->fullUrl(),
+            'method' => $request->getMethod(),
+            'ip' => $request->getClientIp(),
+            'request_data' => $request->all(),
+            'response_data' => json_decode($response->getContent()),
+            'user_id' => auth()->check() ? auth()->id() : null,
+        ];
+
+        ApiLog::create($data);
+    }
+}

src/Models/ApiLog.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace CodeTech\ApiLogs\Models;
+
+use App\Models\User;
+use Illuminate\Database\Eloquent\Model;
+
+class ApiLog extends Model
+{
+    /**
+     * @inheritdoc
+     */
+    protected $fillable = [
+        'duration',
+        'url',
+        'method',
+        'ip',
+        'request_data',
+        'response_data',
+        'user_id',
+    ];
+
+    /**
+     * @inheritdoc
+     */
+    protected $casts = [
+        'request_data' => 'json',
+        'response_data' => 'json',
+        'created_at' => 'datetime:d/m/Y H:i',
+        'updated_at' => 'datetime:d/m/Y H:i',
+    ];
+
+    /**
+     * Get the user that owns this session log.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function user()
+    {
+        return $this->belongsTo(User::class);
+    }
+}

src/Providers/ApiLogServiceProvider.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace CodeTech\ApiLogs\Providers;
+
+use Illuminate\Support\ServiceProvider;
+
+class ApiLogServiceProvider extends ServiceProvider
+{
+    /**
+     * Register services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        //
+    }
+
+    /**
+     * Bootstrap any application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        $this->setPublishableFiles();
+    }
+
+    /**
+     * Sets the publishable files.
+     */
+    private function setPublishableFiles()
+    {
+        $databasePath = sprintf('migrations/%s_create_api_logs_table.php', date('Y_m_d_His', time()));
+
+        $this->publishes([
+            __DIR__.'/../../database/migrations/create_api_logs_table.php.stub' => database_path($databasePath)
+        ], 'migrations');
+    }
+}