Add initial codebase

Created the project's initial codebase covering requested features. It includes PHP classes to handle HTTP requests and responses, and several supporting classes like enumeration classes for HTTP methods, status, and schemes. Accompanied by exception classes to manage unexpected cases. Also, includes tests for testing these features along with setup files for Github actions and PHPStan.

Author: tlmcclatchey

.github/workflows/php.yml

@@ -0,0 +1,38 @@
+name: PHP CI/CD Pipeline
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.3'
+          extensions: mbstring, xml, ctype, iconv, intl, pdo_sqlite
+          coverage: xdebug
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Run tests
+        run: ./vendor/bin/phpunit tests
+
+    # If you have a deployment step, you can include it here.
+    # This could be pushing to a Docker registry, deploying to a cloud platform, etc.
+    # - name: Deploy...

.gitignore

@@ -0,0 +1,5 @@
+.dev/
+.idea/
+composer.lock
+vendor/
+.phpunit.result.cache

.run/phpmd.run.xml

@@ -0,0 +1,5 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="phpmd" type="PhpLocalRunConfigurationType" factoryName="PHP Console" path="$PROJECT_DIR$/vendor/bin/phpmd" scriptParameters="../../src ansi cleancode,codesize,controversial,design,naming,unusedcode">
+    <method v="2" />
+  </configuration>
+</component>

.run/phpstan.run.xml

@@ -0,0 +1,5 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="phpstan" type="PhpLocalRunConfigurationType" factoryName="PHP Console" path="$PROJECT_DIR$/vendor/bin/phpstan" scriptParameters="analyse -c ..\..\phpstan.neon">
+    <method v="2" />
+  </configuration>
+</component>

LICENSE.md

@@ -0,0 +1,25 @@
+# License
+
+This project is licensed under the terms of the MIT license.
+
+The MIT License (MIT)
+
+Copyright (c) 2023 [CommonPHP.org](https://www.commonphp.org/)
+
+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

@@ -0,0 +1,71 @@
+# CommonPHP Web Library
+
+The CommonPHP Web Library provides a suite of components designed to streamline the development of web applications by offering a standardized, easy-to-use set of utilities for handling HTTP requests and responses, along with robust exception handling. Inspired by the flexibility of PHP and the need for more straightforward, decoupled components in modern web development, this library aims to offer PHP developers a reliable toolkit for enhancing their web projects.
+
+## Features
+
+- **HTTP Request Handling**: Simplifies the process of managing HTTP requests, including methods, schemes, headers, and cookies.
+- **HTTP Response Management**: Offers a structured way to create and manage HTTP responses, including status codes, headers, and body content.
+- **Exception Handling**: Provides specialized exceptions to handle common web development issues, improving the debuggability and reliability of your application.
+- **Support Classes**: Includes enums for request methods, schemes, and response statuses, making your code more readable and maintainable.
+
+## Installation
+
+You can install the CommonPHP Web Library using Composer:
+
+```bash
+composer require comphp/web
+```
+
+Replace `your/package-name` with the actual package name of the CommonPHP Web Library on Packagist.
+
+## Usage
+
+### Handling Requests
+
+To handle an HTTP request, you can easily instantiate a `Request` object:
+
+```php
+use CommonPHP\Web\Request;
+
+$request = Request::fromRequest();
+```
+
+This will automatically populate the `Request` object with details from the current HTTP request, including method, scheme, headers, and any parameters.
+
+### Creating Responses
+
+To create an HTTP response, you can use the `Response` class:
+
+```php
+use CommonPHP\Web\Response;
+use CommonPHP\Web\Support\ResponseStatus;
+
+$response = new Response(
+    body: 'Hello, world!',
+    status: ResponseStatus::SUCCESS_OK,
+    headers: ['Content-Type' => 'text/plain']
+);
+
+$response->send();
+```
+
+This will send a response with the specified body, status code, and headers.
+
+### Exception Handling
+
+The library includes several exceptions designed to handle common errors in web development:
+
+- `UndefinedRequestMethodException`
+- `UndefinedRequestSchemeException`
+- `UndefinedResponseStatusCodeException`
+
+These can be used to catch and respond to errors more effectively in your application.
+
+## Contributing
+
+We welcome contributions from the community, whether it's through submitting bug reports, proposing enhancements, or creating pull requests. Please refer to our CONTRIBUTING.md file for more details on how to contribute to the CommonPHP Web Library.
+
+## License
+
+This library is licensed under the [MIT License](LICENSE.md).

composer.json

@@ -0,0 +1,30 @@
+{
+  "name": "comphp/web",
+  "type": "library",
+  "description": "Provides base functionality for web-based applications",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "timothy.mcclatchey",
+      "email": "timothy@commonphp.org"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "CommonPHP\\Web\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "CommonPHP\\Tests\\Web\\": "tests/"
+    }
+  },
+  "require": {
+    "php": "^8.3"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^10.5.9",
+    "phpstan/phpstan": "^1.10.58",
+    "phpmd/phpmd": "^2.13"
+  }
+}

phpstan.neon

@@ -0,0 +1,4 @@
+parameters:
+  level: 9
+  paths:
+    - src

src/Exceptions/UndefinedRequestMethodException.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+
+namespace CommonPHP\Web\Exceptions;
+
+use Throwable;
+
+/**
+ * Class UndefinedRequestMethodException
+ *
+ * This exception is thrown when an undefined HTTP request method is encountered.
+ */
+class UndefinedRequestMethodException extends WebException
+{
+    public function __construct(string $requestMethod, ?Throwable $previous = null)
+    {
+        parent::__construct('The request method '.$requestMethod.' is not a known HTTP request method: https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods', $previous);
+        $this->code = 2303;
+    }
+}

src/Exceptions/UndefinedRequestSchemeException.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CommonPHP\Web\Exceptions;
+
+use Throwable;
+
+/**
+ * Class UndefinedRequestSchemeException
+ *
+ * Exception that is thrown when the provided request scheme is not a known HTTP request scheme.
+ * This class extends the WebException class.
+ */
+class UndefinedRequestSchemeException extends WebException
+{
+    public function __construct(string $requestScheme, ?Throwable $previous = null)
+    {
+        parent::__construct('The request scheme '.$requestScheme.' is not a known HTTP request scheme: http,https', $previous);
+        $this->code = 2302;
+    }
+}

src/Exceptions/UndefinedResponseStatusCodeException.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CommonPHP\Web\Exceptions;
+
+use Throwable;
+
+/**
+ * Exception thrown when an undefined HTTP response status code is encountered.
+ *
+ * This exception is thrown when an HTTP response status code is not recognized or not within the
+ * standard HTTP status codes.
+ */
+class UndefinedResponseStatusCodeException extends WebException
+{
+    public function __construct(int $status, ?Throwable $previous = null)
+    {
+        parent::__construct('The status '.$status.' is not a known HTTP status: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status', $previous);
+        $this->code = 2301;
+    }
+}

src/Exceptions/WebException.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CommonPHP\Web\Exceptions;
+
+use Exception;
+use Throwable;
+
+/**
+ * Class WebException
+ *
+ * This class represents an exception related to web operations.
+ * It extends the base Exception class.
+ */
+class WebException extends Exception
+{
+    public function __construct(string $message = "", ?Throwable $previous = null)
+    {
+        parent::__construct($message, 2300, $previous);
+    }
+}