wip

Author: DaniloWA

.gitignore

@@ -0,0 +1,55 @@
+# Laravel
+/vendor
+/node_modules
+/public/storage
+/storage/*.key
+.env
+Homestead.yaml
+Homestead.json
+.idea
+.phpunit.result.cache
+/.vscode
+/.idea
+/.DS_Store
+
+# NPM
+npm-debug.log
+yarn-error.log
+
+# Composer
+composer.lock
+composer.phar
+
+# IDEs and Editors
+*.swp
+*.swo
+*.sublime-project
+*.sublime-workspace
+
+# Laravel-specific
+bootstrap/cache/*
+storage/app/*
+storage/framework/*
+storage/logs/*
+public/storage
+
+# Laravel 8 and later
+.env.local
+.env.*.local
+
+# Package-related
+/vendor/*
+/node_modules/*
+/composer.lock
+
+# Miscellaneous
+*.log
+*.tmp
+*.cache
+
+# OS-specific
+.DS_Store
+Thumbs.db
+
+# Local environment files
+*.local

README.md

@@ -0,0 +1,11 @@
+# Laravel Response Builder
+
+A Laravel package designed to simplify the creation of structured and formatted API responses (JSON, XML) with custom status codes, messages, and data.
+
+## Installation
+
+Install via Composer:
+
+```bash
+composer require d-oliveira/laravel-response-builder
+```

composer.json

@@ -0,0 +1,62 @@
+{
+  "name": "doliveira/laravel-api-response-builder",
+  "version": "1.0.0",
+  "description": "A Laravel package designed to simplify the creation of structured and formatted API responses (JSON, XML) with custom status codes, messages, and data.",
+  "type": "library",
+  "license": "MIT",
+  "minimum-stability": "stable",
+  "prefer-stable": true,
+  "homepage": "https://github.com/DaniloWA/laravel-api-response-builder",
+  "keywords": [
+    "doliveira",
+    "danilo",
+    "oliveira",
+    "laravel-api-response-builder",
+    "api-response-builder",
+    "api-response",
+    "response-builder",
+    "laravel",
+    "api",
+    "response",
+    "json",
+    "xml",
+    "package"
+  ],
+  "authors": [
+    {
+      "name": "Danilo Oliveira",
+      "email": "daniloworkdev@gmail.com",
+      "homepage": "http://www.daniloo.dev",
+      "role": "Developer"
+    }
+  ],
+  "require": {
+    "php": "^7.3|^8.0|^8.1|^8.2",
+    "laravel/framework": "^8.12|^9.0|^10.0|^11.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "Doliveira\\LaravelResponseBuilder\\": "src/",
+      "Doliveira\\LaravelResponseBuilder\\Providers\\": "src/providers/",
+      "Doliveira\\LaravelResponseBuilder\\Resources\\": "src/resources",
+      "Doliveira\\LaravelResponseBuilder\\Config\\": "src/config"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Doliveira\\LaravelResponseBuilder\\Tests\\": "tests"
+    }
+  },
+  "extra": {
+    "laravel": {
+      "providers": [
+        "Doliveira\\LaravelResponseBuilder\\Providers\\ResponseBuilderServiceProvider"
+      ]
+    }
+  },
+  "config": {
+    "sort-packages": true,
+    "optimize-autoloader": true,
+    "preferred-install": "dist"
+  }
+}

src/BaseResponse.php

@@ -0,0 +1,82 @@
+<?php
+
+namespace Doliveira\LaravelResponseBuilder;
+
+use Illuminate\Support\Facades\Config;
+
+abstract class BaseResponse
+{
+    protected $statusCode;
+    protected $message;
+    protected $data;
+
+    public function __construct($statusCode = null, $message = null, $data = null)
+    {
+        $this->statusCode = $statusCode ?? Config::get('responsebuilder.default_status_code');
+        $this->message = $message;
+        $this->data = $data;
+    }
+
+    protected function getResponseStructure(): array
+    {
+        return Config::get('responsebuilder.custom_response_structure', [
+            'status' => 'status',
+            'message' => 'message',
+            'data' => 'data'
+        ]);
+    }
+
+    protected function wrapData($data): array
+    {
+        if (Config::get('responsebuilder.wrap_data', true)) {
+            return ['data' => $data];
+        }
+
+        return $data;
+    }
+
+    protected function getJsonOptions(): int
+    {
+        return Config::get('responsebuilder.json_options', JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
+    }
+
+    protected function getCompressionSetting(): bool
+    {
+        return Config::get('responsebuilder.compress_responses', false);
+    }
+
+    protected function getLoggingSetting(): bool
+    {
+        return Config::get('responsebuilder.log_responses', false);
+    }
+
+    protected function getLoggingLevel(): string
+    {
+        return Config::get('responsebuilder.logging_level', 'info');
+    }
+
+    protected function getCorsSettings(): array
+    {
+        return Config::get('responsebuilder.cors_settings', []);
+    }
+
+    protected function getDetailedErrors(): bool
+    {
+        return Config::get('responsebuilder.detailed_errors', false);
+    }
+
+    protected function getDefaultResponseLanguage(): string
+    {
+        return Config::get('responsebuilder.default_response_language', 'en');
+    }
+
+    protected function getApiKeyHeader(): string
+    {
+        return Config::get('responsebuilder.api_key_header', 'X-API-KEY');
+    }
+
+    protected function getDebugMode(): bool
+    {
+        return Config::get('responsebuilder.debug_mode', false);
+    }
+}

src/JsonResponse.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Doliveira\LaravelResponseBuilder;
+
+use Illuminate\Http\JsonResponse as IlluminateJsonResponse;
+use Illuminate\Support\Facades\Lang;
+
+class JsonResponse extends BaseResponse
+{
+    public static function success($data = null, $message = null): IlluminateJsonResponse
+    {
+        $message = $message ?? Lang::get('response.success');
+        return (new self(200, $message, $data))->buildResponse();
+    }
+
+    public static function error($statusCode, $message = null, $data = null): IlluminateJsonResponse
+    {
+        $message = $message ?? Lang::get('response.server_error');
+        return (new self($statusCode, $message, $data))->buildResponse();
+    }
+
+    public static function auto($statusCode, $message = null, $data = null): IlluminateJsonResponse
+    {
+        return (new self($statusCode, $message, $data))->buildResponse();
+    }
+
+    public function buildResponse(): IlluminateJsonResponse
+    {
+        LogResponse::logRequest();
+        
+        $startTime = microtime(true);
+        
+        $structure = $this->getResponseStructure();
+        $response = [
+            $structure['status'] => $this->statusCode,
+            $structure['message'] => $this->message,
+            $structure['data'] => $this->wrapData($this->data),
+        ];
+
+        $jsonOptions = $this->getJsonOptions();
+        $jsonResponse = json_encode($response, $jsonOptions);
+
+        if ($this->getCompressionSetting()) {
+            $jsonResponse = gzcompress($jsonResponse);
+        }
+
+        if ($this->getLoggingSetting()) {
+            LogResponse::log(new IlluminateJsonResponse($jsonResponse, $this->statusCode));
+        }
+
+        $response = response()->json($response, $this->statusCode);
+
+        LogResponse::logResponseTime($startTime);
+
+        return $response;
+    }
+}

src/LogResponse.php

@@ -0,0 +1,115 @@
+<?php
+
+namespace Doliveira\LaravelResponseBuilder;
+
+use Illuminate\Http\JsonResponse as IlluminateJsonResponse;
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Facades\Request;
+
+class LogResponse
+{
+    /**
+     * Log the response details.
+     *
+     * @param IlluminateJsonResponse $response
+     * @return void
+     */
+    public static function log(IlluminateJsonResponse $response): void
+    {
+        $validLevels = ['emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug'];
+        $level = Config::get('responsebuilder.logging_level', 'info');
+
+        if (!in_array($level, $validLevels, true)) {
+            $level = 'info'; // Default level
+        }
+
+        // Collect log data
+        $logData = [
+            'status' => $response->status(),
+            'headers' => $response->headers->all(),
+            'content' => self::sanitizeContent($response->getContent()), // Sanitize content
+        ];
+
+        // Format the log data
+        $formattedLog = json_encode($logData, JSON_PRETTY_PRINT);
+
+        // Log the response if enabled
+        if (Config::get('responsebuilder.log_responses', false)) {
+            Log::$level($formattedLog);
+        }
+    }
+
+    /**
+     * Log the request details.
+     *
+     * @return void
+     */
+    public static function logRequest(): void
+    {
+        if (!Config::get('responsebuilder.log_requests', false)) {
+            return;
+        }
+
+        $request = Request::instance();
+
+        // Collect log data
+        $logData = [
+            'method' => $request->method(),
+            'url' => $request->fullUrl(),
+            'headers' => $request->headers->all(),
+            'body' => $request->all(),
+        ];
+
+        // Format the log data
+        $formattedLog = json_encode($logData, JSON_PRETTY_PRINT);
+
+        // Log the request
+        Log::info('Request Data: ' . $formattedLog);
+    }
+
+    /**
+     * Log the response time.
+     *
+     * @param float $startTime
+     * @return void
+     */
+    public static function logResponseTime(float $startTime): void
+    {
+        if (!Config::get('responsebuilder.log_response_time', false)) {
+            return;
+        }
+
+        $endTime = microtime(true);
+        $responseTime = $endTime - $startTime;
+
+        // Collect log data
+        $logData = [
+            'response_time' => number_format($responseTime * 1000, 2) . ' ms', // Convert to milliseconds
+        ];
+
+        // Format the log data
+        $formattedLog = json_encode($logData, JSON_PRETTY_PRINT);
+
+        // Log the response time
+        Log::info('Response Time: ' . $formattedLog);
+    }
+
+    /**
+     * Sanitize response content to remove sensitive information.
+     *
+     * @param string $content
+     * @return string
+     */
+    private static function sanitizeContent(string $content): string
+    {
+        $decodedContent = json_decode($content, true);
+        
+        // Example: Remove sensitive information
+        if (isset($decodedContent['data']['token'])) {
+            $decodedContent['data']['token'] = '***REDACTED***';
+        }
+
+        return json_encode($decodedContent, JSON_PRETTY_PRINT);
+    }
+}