From f5254a990db3b998edd84b42035cb2b025277df7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matej=20Ba=C4=8Do?= Date: Fri, 5 Jan 2024 08:45:36 +0000 Subject: [PATCH 1/9] Improve readme --- .github/ISSUE_TEMPLATE/bug.yaml | 2 +- CONTRIBUTING.md | 24 ++++++++++++------------ README.md | 25 +++++++++++++------------ composer.json | 5 +++-- docs/Getting-Starting-Guide.md | 10 +++++----- example/composer.json | 2 +- tests/Validator/DomainTest.php | 11 ----------- tests/Validator/HostTest.php | 11 ----------- tests/Validator/IPTest.php | 11 ----------- tests/Validator/URLTest.php | 11 ----------- 10 files changed, 35 insertions(+), 77 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index c034a667..0e676b25 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -34,7 +34,7 @@ body: - type: dropdown id: utopia-version attributes: - label: "🎲 Utopia Framework version" + label: "🎲 Utopia Http version" description: "What version of Utopia are you running?" options: - Version 0.18.x diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4701ba07..8da3199b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,16 @@ # Contributing -We would ❤️ for you to contribute to Framework and help make it better! We want contributing to Framework to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs as well as updates and tweaks, blog posts, workshops, and more. +We would ❤️ for you to contribute to Utopia-PHP Http and help make it better! We want contributing to Http to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs as well as updates and tweaks, blog posts, workshops, and more. ## How to Start? If you are worried or don’t know where to start, check out our next section explaining what kind of help we could use and where can you get involved. You can reach out with questions to [Eldad Fux (@eldadfux)](https://twitter.com/eldadfux) or [@appwrite_io](https://twitter.com/appwrite_io) on Twitter, and anyone from the [Appwrite team on Discord](https://discord.gg/GSeTUeA). You can also submit an issue, and a maintainer can guide you! -You can get an in-depth understanding of the Utopia-PHP framework in our [Getting Started](docs/Getting-Starting-Guide.md) guide. +You can get an in-depth understanding of the Utopia-PHP Http in our [Getting Started](docs/Getting-Starting-Guide.md) guide. ## Code of Conduct -Help us keep framework open and inclusive. Please read and follow our [Code of Conduct](/CODE_OF_CONDUCT.md). +Help us keep Utopia-PHP Http open and inclusive. Please read and follow our [Code of Conduct](/CODE_OF_CONDUCT.md). ## Submit a Pull Request 🚀 @@ -72,33 +72,33 @@ $ git push origin [name_of_your_new_branch] ## Introducing New Features -We would 💖 you to contribute to Framework, but we would also like to make sure Framework is as great as possible and loyal to its vision and mission statement 🙏. +We would 💖 you to contribute to Utopia-PHP HTTP, but we would also like to make sure Http is as great as possible and loyal to its vision and mission statement 🙏. For us to find the right balance, please open an issue explaining your ideas before introducing a new pull request. -This will allow the Framework community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision. +This will allow the Utopia-PHP Http community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision. -This is also important for the Framework lead developers to be able to give technical input and different emphasis regarding the feature design and architecture. Some bigger features might need to go through our [RFC process](https://github.com/appwrite/rfc). +This is also important for the Http lead developers to be able to give technical input and different emphasis regarding the feature design and architecture. Some bigger features might need to go through our [RFC process](https://github.com/appwrite/rfc). ## Other Ways to Help -Pull requests are great, but there are many other areas where you can help Framework +Pull requests are great, but there are many other areas where you can help Utopia-PHP Http ### Blogging & Speaking -Blogging, speaking about, or creating tutorials about one of Framework's many features is great way to contribute and help our project grow. +Blogging, speaking about, or creating tutorials about one of Http's many features is great way to contribute and help our project grow. ### Presenting at Meetups -Presenting at meetups and conferences about your Framework projects. Your unique challenges and successes in building things with Framework can provide great speaking material. We’d love to review your talk abstract/CFP, so get in touch with us if you’d like some help! +Presenting at meetups and conferences about your Http projects. Your unique challenges and successes in building things with Utopia-PHP Http can provide great speaking material. We’d love to review your talk abstract/CFP, so get in touch with us if you’d like some help! ### Sending Feedbacks & Reporting Bugs -Sending feedback is a great way for us to understand your different use cases of Framework better. If you had any issues, bugs, or want to share about your experience, feel free to do so on our GitHub issues page or at our [Discord channel](https://discord.gg/GSeTUeA). +Sending feedback is a great way for us to understand your different use cases of Utopia-PHP Http better. If you had any issues, bugs, or want to share about your experience, feel free to do so on our GitHub issues page or at our [Discord channel](https://discord.gg/GSeTUeA). ### Submitting New Ideas -If you think Framework could use a new feature, please open an issue on our GitHub repository, stating as much information as you can think about your new idea and it's implications. We would also use this issue to gather more information, get more feedback from the community, and have a proper discussion about the new feature. +If you think Utopia-PHP Http could use a new feature, please open an issue on our GitHub repository, stating as much information as you can think about your new idea and it's implications. We would also use this issue to gather more information, get more feedback from the community, and have a proper discussion about the new feature. ### Improving Documentation @@ -106,4 +106,4 @@ Submitting documentation updates, enhancements, designs, or bug fixes. Spelling ### Helping Someone -Searching for Framework on Discord, GitHub, or StackOverflow and helping someone else who needs help. You can also help by teaching others how to contribute to Framework's repo! +Searching for Utopia-PHP Http on Discord, GitHub, or StackOverflow and helping someone else who needs help. You can also help by teaching others how to contribute to Http's repo! diff --git a/README.md b/README.md index fe37a60e..16429706 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,20 @@ Logo

-[![Build Status](https://travis-ci.org/utopia-php/framework.svg?branch=master)](https://travis-ci.org/utopia-php/framework) -![Total Downloads](https://img.shields.io/packagist/dt/utopia-php/framework.svg) +[![Build Status](https://travis-ci.org/utopia-php/http.svg?branch=master)](https://travis-ci.org/utopia-php/http) +![Total Downloads](https://img.shields.io/packagist/dt/utopia-php/http.svg) [![Discord](https://img.shields.io/discord/564160730845151244?label=discord)](https://discord.gg/GSeTUeA) -Utopia Framework is a PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. This library is maintained by the [Appwrite team](https://appwrite.io). +Utopia Http is a PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. This library is maintained by the [Appwrite team](https://appwrite.io). -Utopia Framework is dependency-free. Any extra features, such as authentication or caching, will be available as standalone models in order to keep the framework core clean, light, and easy to learn. +Utopia Http is dependency-free. Any extra features, such as authentication or caching are available as standalone models in order to keep the framework core clean, light, and easy to learn. ## Getting Started -Install using composer: +Install using Composer: + ```bash -composer require utopia-php/framework +composer require utopia-php/http ``` Init your first application in `src/server.php`: @@ -49,7 +50,7 @@ $http->start(); Run HTTP server: ```bash -php -S localhost:8000 src/server2.php +php -S localhost:8000 src/server.php ``` Send HTTP request: @@ -60,7 +61,7 @@ curl http://localhost:8000/hello-world ### Server Adapters -The library supports server adapters to be able to run on any PHP setup. For instance, you could use the FPM server or the Swoole server. +The library supports server adapters to be able to run on any PHP setup. Youx1s could use the FPM server or the Swoole server. #### Use PHP FPM server @@ -243,15 +244,15 @@ In advanced scenarios, resources can also be injected into other resources or en Resources are designed to prepare dependencies or context for the request. Resources are not meant to do functional logic or return callbacks. For such a use case, you should use hooks. -To learn more about Framework architecture and features, check out more in-depth [Getting started guide](/docs/Getting-Starting-Guide.md). +To learn more about Http architecture and features, check out more in-depth [Getting started guide](/docs/Getting-Starting-Guide.md). ## System Requirements -Utopia Framework requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible. +Utopia Http requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible. ## More from Utopia -Our ecosystem supports other thin PHP projects aiming to extend the core PHP Utopia framework. +Our ecosystem supports other thin PHP projects aiming to extend the core PHP Utopia Http. Each project is focused on solving a single, very simple problem and you can use composer to include any of them in your next project. @@ -263,7 +264,7 @@ All code contributions - including those of people having commit access - must g Fork the project, create a feature branch, and send us a pull request. -You can refer to the [Contributing Guide](https://github.com/utopia-php/framework/blob/master/CONTRIBUTING.md) for more info. +You can refer to the [Contributing Guide](https://github.com/utopia-php/http/blob/master/CONTRIBUTING.md) for more info. For security issues, please email security@appwrite.io instead of posting a public issue in GitHub. diff --git a/composer.json b/composer.json index 043758fa..8694ef5b 100644 --- a/composer.json +++ b/composer.json @@ -1,10 +1,11 @@ { - "name": "utopia-php/framework", - "description": "A simple, light and advanced PHP framework", + "name": "utopia-php/http", + "description": "A simple, light and advanced PHP HTTP framework", "type": "library", "keywords": [ "php", "framework", + "http", "upf" ], "license": "MIT", diff --git a/docs/Getting-Starting-Guide.md b/docs/Getting-Starting-Guide.md index 272a6b4a..de0f1118 100644 --- a/docs/Getting-Starting-Guide.md +++ b/docs/Getting-Starting-Guide.md @@ -1,7 +1,7 @@ # Getting Started with Utopia-PHP # Intro -Utopia Framework is an easy-to-use PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. It follows an architecture like Express and is based on the declarative programming approach. Documenting and writing code are usually seen as two separate tasks and very often, documentation loses priority in the software development lifecycle. Utopia unifies the two with a flexible API that allows your code to be self-documenting. What’s interesting about Utopia is its ability to accept metadata along with it’s route definitions. This metadata can then be used for various purposes like generating documentation, swagger specifications and more. +Utopia Http is an easy-to-use PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. It follows an architecture like Express and is based on the declarative programming approach. Documenting and writing code are usually seen as two separate tasks and very often, documentation loses priority in the software development lifecycle. Utopia unifies the two with a flexible API that allows your code to be self-documenting. What’s interesting about Utopia is its ability to accept metadata along with it’s route definitions. This metadata can then be used for various purposes like generating documentation, swagger specifications and more. # Defining Routes If you’re new to Utopia, let’s get started by looking at an example of a basic GET route for an application that you can create using Utopia. We'll be using a [Swoole server](https://github.com/swoole/swoole-src) in this example, but you should be able to extend it to any HTTP server. @@ -130,7 +130,7 @@ $response ->send('') ``` -You can find the details of other status codes by visiting our [GitHub repository](https://github.com/utopia-php/framework/blob/master/src/Response.php). +You can find the details of other status codes by visiting our [GitHub repository](https://github.com/utopia-php/http/blob/master/src/Response.php). # Advanced Utopia @@ -279,9 +279,9 @@ Http::shutdown(function($request) { # Running Locally -If you have PHP and Composer installed on your device, you can run Utopia apps locally by downloading the Utopia-PHP/framework dependency using `composer require utopia-php/framework` command. +If you have PHP and Composer installed on your device, you can run Utopia apps locally by downloading the Utopia-PHP/http dependency using `composer require utopia-php/http` command. -> Utopia Framework requires PHP 7.3 or later. We recommend using the latest PHP version whenever possible. +> Utopia Http requires PHP 7.3 or later. We recommend using the latest PHP version whenever possible. -Wonderful! 😄 You’re all set to create a basic demo app using the Utopia framework. If you have any issues or questions feel free to reach out to us on our [Discord Server](https://appwrite.io/discord). +Wonderful! 😄 You’re all set to create a basic demo app using the Utopia Http. If you have any issues or questions feel free to reach out to us on our [Discord Server](https://appwrite.io/discord). diff --git a/example/composer.json b/example/composer.json index 999df3c0..8e35bc2e 100644 --- a/example/composer.json +++ b/example/composer.json @@ -1,6 +1,6 @@ { "name": "utopia-php/http-app", "require": { - "utopia-php/framework": "0.33.*" + "utopia-php/http": "0.33.*" } } \ No newline at end of file diff --git a/tests/Validator/DomainTest.php b/tests/Validator/DomainTest.php index d8fa4de4..85a346e1 100644 --- a/tests/Validator/DomainTest.php +++ b/tests/Validator/DomainTest.php @@ -1,15 +1,4 @@ - * @version 1.0 RC4 - * @license The MIT License (MIT) - */ namespace Utopia\Http\Validator; diff --git a/tests/Validator/HostTest.php b/tests/Validator/HostTest.php index 7d845f33..9476ea6b 100644 --- a/tests/Validator/HostTest.php +++ b/tests/Validator/HostTest.php @@ -1,15 +1,4 @@ - * @version 1.0 RC4 - * @license The MIT License (MIT) - */ namespace Utopia\Http\Validator; diff --git a/tests/Validator/IPTest.php b/tests/Validator/IPTest.php index 88c71994..074a8f68 100644 --- a/tests/Validator/IPTest.php +++ b/tests/Validator/IPTest.php @@ -1,15 +1,4 @@ - * @version 1.0 RC4 - * @license The MIT License (MIT) - */ namespace Utopia\Http\Validator; diff --git a/tests/Validator/URLTest.php b/tests/Validator/URLTest.php index f092890f..de530cd1 100644 --- a/tests/Validator/URLTest.php +++ b/tests/Validator/URLTest.php @@ -1,15 +1,4 @@ - * @version 1.0 RC4 - * @license The MIT License (MIT) - */ namespace Utopia\Http\Validator; From 6b6ae760497ea692bdbf27e574a82e90aa5fcc1d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matej=20Ba=C4=8Do?= Date: Fri, 5 Jan 2024 08:47:00 +0000 Subject: [PATCH 2/9] Fix docs version --- docs/Getting-Starting-Guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Getting-Starting-Guide.md b/docs/Getting-Starting-Guide.md index de0f1118..ab1ccb8c 100644 --- a/docs/Getting-Starting-Guide.md +++ b/docs/Getting-Starting-Guide.md @@ -281,7 +281,7 @@ Http::shutdown(function($request) { # Running Locally If you have PHP and Composer installed on your device, you can run Utopia apps locally by downloading the Utopia-PHP/http dependency using `composer require utopia-php/http` command. -> Utopia Http requires PHP 7.3 or later. We recommend using the latest PHP version whenever possible. +> Utopia Http requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible. Wonderful! 😄 You’re all set to create a basic demo app using the Utopia Http. If you have any issues or questions feel free to reach out to us on our [Discord Server](https://appwrite.io/discord). From 19e0eb1742467c6dcd5d52e97fb7b2c3801af8ac Mon Sep 17 00:00:00 2001 From: Torsten Dittmann Date: Fri, 5 Jan 2024 11:44:20 +0100 Subject: [PATCH 3/9] chore: rename library to utopia-php/http --- .github/workflows/test.yml | 5 +++- README.md | 14 ++++----- composer.json | 2 +- composer.lock | 14 ++++----- docs/Getting-Starting-Guide.md | 54 +++++++++++++++++----------------- example/composer.json | 2 +- tests/Validator/DomainTest.php | 2 +- tests/Validator/HostTest.php | 2 +- tests/Validator/IPTest.php | 2 +- tests/Validator/URLTest.php | 2 +- 10 files changed, 51 insertions(+), 48 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index ce9d61c5..e17e5507 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -15,6 +15,9 @@ jobs: with: php-version: '8.1' + - name: Validate composer.json and composer.lock + run: composer validate --strict + - name: Setup Docker run: docker-compose up -d --build @@ -23,6 +26,6 @@ jobs: - name: Run FPM Tests run: docker compose exec fpm vendor/bin/phpunit --configuration phpunit.xml - + - name: Run Swoole Tests run: docker compose exec swoole vendor/bin/phpunit --configuration phpunit.xml \ No newline at end of file diff --git a/README.md b/README.md index fe37a60e..3fb0a525 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ Logo

-[![Build Status](https://travis-ci.org/utopia-php/framework.svg?branch=master)](https://travis-ci.org/utopia-php/framework) -![Total Downloads](https://img.shields.io/packagist/dt/utopia-php/framework.svg) +[![Build Status](https://travis-ci.org/utopia-php/http.svg?branch=master)](https://travis-ci.org/utopia-php/http) +![Total Downloads](https://img.shields.io/packagist/dt/utopia-php/http.svg) [![Discord](https://img.shields.io/discord/564160730845151244?label=discord)](https://discord.gg/GSeTUeA) Utopia Framework is a PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. This library is maintained by the [Appwrite team](https://appwrite.io). @@ -14,7 +14,7 @@ Utopia Framework is dependency-free. Any extra features, such as authentication Install using composer: ```bash -composer require utopia-php/framework +composer require utopia-php/http ``` Init your first application in `src/server.php`: @@ -49,7 +49,7 @@ $http->start(); Run HTTP server: ```bash -php -S localhost:8000 src/server2.php +php -S localhost:8000 src/server2.php ``` Send HTTP request: @@ -203,7 +203,7 @@ Http::init() }); ``` -Groups are designed to be actions that run during the lifecycle of requests to endpoints that have some logic in common. Groups allow you to prevent code duplication and are designed to be defined anywhere in your source code to allow flexibility. +Groups are designed to be actions that run during the lifecycle of requests to endpoints that have some logic in common. Groups allow you to prevent code duplication and are designed to be defined anywhere in your source code to allow flexibility. ### Resources @@ -253,7 +253,7 @@ Utopia Framework requires PHP 8.0 or later. We recommend using the latest PHP ve Our ecosystem supports other thin PHP projects aiming to extend the core PHP Utopia framework. -Each project is focused on solving a single, very simple problem and you can use composer to include any of them in your next project. +Each project is focused on solving a single, very simple problem and you can use composer to include any of them in your next project. You can find all libraries in [GitHub Utopia organization](https://github.com/utopia-php). @@ -263,7 +263,7 @@ All code contributions - including those of people having commit access - must g Fork the project, create a feature branch, and send us a pull request. -You can refer to the [Contributing Guide](https://github.com/utopia-php/framework/blob/master/CONTRIBUTING.md) for more info. +You can refer to the [Contributing Guide](https://github.com/utopia-php/http/blob/master/CONTRIBUTING.md) for more info. For security issues, please email security@appwrite.io instead of posting a public issue in GitHub. diff --git a/composer.json b/composer.json index 043758fa..a2cf3cb2 100644 --- a/composer.json +++ b/composer.json @@ -1,5 +1,5 @@ { - "name": "utopia-php/framework", + "name": "utopia-php/http", "description": "A simple, light and advanced PHP framework", "type": "library", "keywords": [ diff --git a/composer.lock b/composer.lock index a388d0e9..a5519ed2 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "f27d5bb02390ce6b9a8268d4fffb1e87", + "content-hash": "33b8cf270cfbd8f86cbd1338d81f5140", "packages": [], "packages-dev": [ { @@ -724,16 +724,16 @@ }, { "name": "phpstan/phpstan", - "version": "1.10.50", + "version": "1.10.52", "source": { "type": "git", "url": "https://github.com/phpstan/phpstan.git", - "reference": "06a98513ac72c03e8366b5a0cb00750b487032e4" + "reference": "0cd0c330081d4f1e1d630701fe4f342c3b659685" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpstan/phpstan/zipball/06a98513ac72c03e8366b5a0cb00750b487032e4", - "reference": "06a98513ac72c03e8366b5a0cb00750b487032e4", + "url": "https://api.github.com/repos/phpstan/phpstan/zipball/0cd0c330081d4f1e1d630701fe4f342c3b659685", + "reference": "0cd0c330081d4f1e1d630701fe4f342c3b659685", "shasum": "" }, "require": { @@ -782,7 +782,7 @@ "type": "tidelift" } ], - "time": "2023-12-13T10:59:42+00:00" + "time": "2024-01-05T09:51:32+00:00" }, { "name": "phpunit/php-code-coverage", @@ -3451,5 +3451,5 @@ "ext-swoole": "*" }, "platform-dev": [], - "plugin-api-version": "2.6.0" + "plugin-api-version": "2.3.0" } diff --git a/docs/Getting-Starting-Guide.md b/docs/Getting-Starting-Guide.md index 272a6b4a..0d44f140 100644 --- a/docs/Getting-Starting-Guide.md +++ b/docs/Getting-Starting-Guide.md @@ -4,7 +4,7 @@ Utopia Framework is an easy-to-use PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. It follows an architecture like Express and is based on the declarative programming approach. Documenting and writing code are usually seen as two separate tasks and very often, documentation loses priority in the software development lifecycle. Utopia unifies the two with a flexible API that allows your code to be self-documenting. What’s interesting about Utopia is its ability to accept metadata along with it’s route definitions. This metadata can then be used for various purposes like generating documentation, swagger specifications and more. # Defining Routes -If you’re new to Utopia, let’s get started by looking at an example of a basic GET route for an application that you can create using Utopia. We'll be using a [Swoole server](https://github.com/swoole/swoole-src) in this example, but you should be able to extend it to any HTTP server. +If you’re new to Utopia, let’s get started by looking at an example of a basic GET route for an application that you can create using Utopia. We'll be using a [Swoole server](https://github.com/swoole/swoole-src) in this example, but you should be able to extend it to any HTTP server. ## Basic GET Route @@ -17,7 +17,7 @@ use Swoole\Http\Request as SwooleRequest; use Swoole\Http\Response as SwooleResponse; $http = new Server("0.0.0.0", 8080); - + Http::get('/') ->inject('request') ->inject('response') @@ -27,7 +27,7 @@ Http::get('/') $response->send("
Hello World!
"); } /* - Configure your HTTP server to respond with the Utopia http. + Configure your HTTP server to respond with the Utopia http. */ $http->on('request', function (SwooleRequest $swooleRequest, SwooleResponse $swooleResponse) { @@ -39,12 +39,12 @@ $http->on('request', function (SwooleRequest $swooleRequest, SwooleResponse $swo $http->start(); ``` - + Any route in Utopia would require you to `inject` the dependencies ( `$request` and `$response` in this case ) and define the controller by passing a callback to the `action` function. As you might have already guessed, `$request` and `$response` refer to the objects of the HTTP server library you’re using, for example, Swoole in this case. `action` defines the callback function that would be called when the GET request is executed. In this case, raw HTML is returned as a `$response`. ## More Endpoints -You can perform basic CRUD operations like GET, POST, PUT and DELETE using Utopia. Let’s assume there's a file `todos.json` that stores a list of todo objects with the following structure. In a real-world scenario, you would be fetching this information from a database. +You can perform basic CRUD operations like GET, POST, PUT and DELETE using Utopia. Let’s assume there's a file `todos.json` that stores a list of todo objects with the following structure. In a real-world scenario, you would be fetching this information from a database. ```json [ @@ -88,9 +88,9 @@ You might have noticed an additional property in the above example, i.e. `param` All the parameters need to be defined using the `param` property which accepts the following - `$key`, `$default`, `$validator`, `$description`, `$optional` and `$injections`. There are typically 3 types of parameters: -1. Path params ( eg: `/api/users/` ) +1. Path params ( eg: `/api/users/` ) 2. Query Params ( eg: `/api/users?userId=`) -3. Body Params ( These are passed in the request body in POST and PUT requests. ) +3. Body Params ( These are passed in the request body in POST and PUT requests. ) Let's take a look at how these three types of params are taken care of by Utopia: @@ -100,7 +100,7 @@ Let's take a look at how these three types of params are taken care of by Utopia 3. Body Parameters are specified using the `->param()` function as well. -Each of these params then become available to the `->action()` callback function in the same order that they were declared in. +Each of these params then become available to the `->action()` callback function in the same order that they were declared in. ### Returning a Response Based on the type of the response you wish to return, multiple options can be used: @@ -120,7 +120,7 @@ $response->json(['Goodbye' => 'World']); JSON objects can be returned by passing the JSON object inside `$response->json()`. -### Setting Response Status +### Setting Response Status You can set a status code for your response using the `setStatusCode()` function of utopia's response object. @@ -130,7 +130,7 @@ $response ->send('') ``` -You can find the details of other status codes by visiting our [GitHub repository](https://github.com/utopia-php/framework/blob/master/src/Response.php). +You can find the details of other status codes by visiting our [GitHub repository](https://github.com/utopia-php/http/blob/master/src/Response.php). # Advanced Utopia @@ -149,28 +149,28 @@ use Utopia\Http\Validator\Wildcard; $http = new Server("0.0.0.0", 8080); Http::init(function($response) { - /* - Example of global init method. Do stuff that is common to all your endpoints in all groups. + /* + Example of global init method. Do stuff that is common to all your endpoints in all groups. This can include things like authentication and authorisation checks, implementing rate limits and so on.. */ }, ['response']); Http::init(function($response) { - /* + /* Example of init method for group1. Do stuff that is common to all your endpoints in group1. This can include things like authentication and authorisation checks, implementing rate limits and so on.. */ }, ['response'], 'group1'); Http::init(function($response) { - /* - Example of init method for group2. Do stuff that is common to all your endpoints in group2. + /* + Example of init method for group2. Do stuff that is common to all your endpoints in group2. This can include things like authentication and authorisation checks, implementing rate limits and so on.. */ }, ['response'], 'group2'); Http::shutdown(function($request) { - /* + /* Example of global shutdown method. Do stuff that needs to be performed at the end of each request for all groups. '*' (Wildcard validator) is optional. This can include cleanups, logging information, recording usage stats, closing database connections and so on.. @@ -179,7 +179,7 @@ Http::shutdown(function($request) { }, ['request'], '*'); Http::shutdown(function($request) { - /* + /* Example of shutdown method of group1. Do stuff that needs to be performed at the end of each request for all groups. This can include cleanups, logging information, recording usage stats, closing database connections and so on.. */ @@ -211,7 +211,7 @@ Http::put('/todos/:id') $response->json($data); } ); - + $http->start(); ``` @@ -224,7 +224,7 @@ For each endpoint, you can add the following properties described below. Let’s `groups` are used to define common functions that need to be executed. When you add a callback function to a group, the init hooks of the respective group are executed before the individual actions are executed. * #### Labels -`label` can be used to store metadata that is related to your endpoint. It’s a key-value store. Some use-cases can be using label to generate the documentation or the swagger specifications. +`label` can be used to store metadata that is related to your endpoint. It’s a key-value store. Some use-cases can be using label to generate the documentation or the swagger specifications. * #### Injections Since each action in Utopia depends on certain resources, `inject` is used to add the dependencies. `$response` and `$request` can be injected into the service. Utopia provides the http static functions to make global resources available to all utopia endpoints. @@ -238,7 +238,7 @@ Since each action in Utopia depends on certain resources, `inject` is used to ad Now that you’re familiar with routing in Utopia, let’s dive into the lifecycle of a utopia request in detail and learn about some of the lifecycle methods. ## Init and Shutdown Methods - + The Utopia http goes through the following lifecycle whenever it receives any request: ![untitled@2x](https://user-images.githubusercontent.com/43381712/146966398-0f4af03b-213e-47d7-9002-01983053c5aa.png) @@ -248,7 +248,7 @@ In case an error occurs anywhere during the execution, the workflow executes the The init and shutdown methods take three params: 1. Callback function - 2. Array of resources required by the callback + 2. Array of resources required by the callback 3. The endpoint group for which the callback is intended to run * ### Init @@ -256,9 +256,9 @@ The init and shutdown methods take three params: init method is executed in the beginning when the program execution begins. Here’s an example of the init method, where the init method is executed for all groups indicated by the wildcard symbol `'*'`. ```php Http::init(function($response) { - /* - Do stuff that is common to all your endpoints. - This can include things like authentication and authorisation checks, implementing rate limits and so on.. + /* + Do stuff that is common to all your endpoints. + This can include things like authentication and authorisation checks, implementing rate limits and so on.. */ }, ['response'], '*'); ``` @@ -269,8 +269,8 @@ Utopia's shutdown callback is used to perform cleanup tasks after a request. Thi ```php Http::shutdown(function($request) { - /* - Do stuff that needs to be performed at the end of each request. + /* + Do stuff that needs to be performed at the end of each request. This can include cleanups, logging information, recording usage stats, closing database connections and so on.. */ @@ -279,7 +279,7 @@ Http::shutdown(function($request) { # Running Locally -If you have PHP and Composer installed on your device, you can run Utopia apps locally by downloading the Utopia-PHP/framework dependency using `composer require utopia-php/framework` command. +If you have PHP and Composer installed on your device, you can run Utopia apps locally by downloading the utopia-php/http dependency using `composer require utopia-php/http` command. > Utopia Framework requires PHP 7.3 or later. We recommend using the latest PHP version whenever possible. diff --git a/example/composer.json b/example/composer.json index 999df3c0..8e35bc2e 100644 --- a/example/composer.json +++ b/example/composer.json @@ -1,6 +1,6 @@ { "name": "utopia-php/http-app", "require": { - "utopia-php/framework": "0.33.*" + "utopia-php/http": "0.33.*" } } \ No newline at end of file diff --git a/tests/Validator/DomainTest.php b/tests/Validator/DomainTest.php index d8fa4de4..5e9e544f 100644 --- a/tests/Validator/DomainTest.php +++ b/tests/Validator/DomainTest.php @@ -5,7 +5,7 @@ * @package Framework * @subpackage Tests * - * @link https://github.com/utopia-php/framework + * @link https://github.com/utopia-php/http * @author Appwrite Team * @version 1.0 RC4 * @license The MIT License (MIT) diff --git a/tests/Validator/HostTest.php b/tests/Validator/HostTest.php index 7d845f33..fc75907d 100644 --- a/tests/Validator/HostTest.php +++ b/tests/Validator/HostTest.php @@ -5,7 +5,7 @@ * @package Framework * @subpackage Tests * - * @link https://github.com/utopia-php/framework + * @link https://github.com/utopia-php/http * @author Appwrite Team * @version 1.0 RC4 * @license The MIT License (MIT) diff --git a/tests/Validator/IPTest.php b/tests/Validator/IPTest.php index 88c71994..ea699feb 100644 --- a/tests/Validator/IPTest.php +++ b/tests/Validator/IPTest.php @@ -5,7 +5,7 @@ * @package Framework * @subpackage Tests * - * @link https://github.com/utopia-php/framework + * @link https://github.com/utopia-php/http * @author Appwrite Team * @version 1.0 RC4 * @license The MIT License (MIT) diff --git a/tests/Validator/URLTest.php b/tests/Validator/URLTest.php index f092890f..5e8c94f6 100644 --- a/tests/Validator/URLTest.php +++ b/tests/Validator/URLTest.php @@ -5,7 +5,7 @@ * @package Framework * @subpackage Tests * - * @link https://github.com/utopia-php/framework + * @link https://github.com/utopia-php/http * @author Appwrite Team * @version 1.0 RC4 * @license The MIT License (MIT) From 43f884715e03b8aa4e87d8e77478ff032391c969 Mon Sep 17 00:00:00 2001 From: Torsten Dittmann Date: Fri, 5 Jan 2024 11:49:09 +0100 Subject: [PATCH 4/9] fix: example version to latest --- example/composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/example/composer.json b/example/composer.json index 8e35bc2e..383d90aa 100644 --- a/example/composer.json +++ b/example/composer.json @@ -1,6 +1,6 @@ { "name": "utopia-php/http-app", "require": { - "utopia-php/http": "0.33.*" + "utopia-php/http": "latest" } } \ No newline at end of file From 0ef2070db396cc1efc847d7490279c024414ff8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matej=20Ba=C4=8Do?= Date: Fri, 5 Jan 2024 12:12:24 +0100 Subject: [PATCH 5/9] Update .github/ISSUE_TEMPLATE/bug.yaml Co-authored-by: Torsten Dittmann --- .github/ISSUE_TEMPLATE/bug.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index 0e676b25..0b6ca990 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -34,7 +34,7 @@ body: - type: dropdown id: utopia-version attributes: - label: "🎲 Utopia Http version" + label: "🎲 Utopia HTTP version" description: "What version of Utopia are you running?" options: - Version 0.18.x From f22cfa3e6693f1ff2b243a47960991be00dcb200 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matej=20Ba=C4=8Do?= Date: Fri, 5 Jan 2024 12:12:35 +0100 Subject: [PATCH 6/9] Update CONTRIBUTING.md Co-authored-by: Torsten Dittmann --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8da3199b..0e1eb142 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -We would ❤️ for you to contribute to Utopia-PHP Http and help make it better! We want contributing to Http to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs as well as updates and tweaks, blog posts, workshops, and more. +We would ❤️ for you to contribute to `utopia-php/http` and help make it better! We want contributing to this library to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs as well as updates and tweaks, blog posts, workshops, and more. ## How to Start? From 5a996f6b070af27b3e862336c569fe7e0173e658 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matej=20Ba=C4=8Do?= Date: Fri, 5 Jan 2024 12:15:21 +0100 Subject: [PATCH 7/9] Apply suggestions from code review Co-authored-by: Torsten Dittmann --- CONTRIBUTING.md | 22 +++++++++++----------- README.md | 12 ++++++------ docs/Getting-Starting-Guide.md | 4 ++-- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0e1eb142..c01dbd27 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,11 +6,11 @@ We would ❤️ for you to contribute to `utopia-php/http` and help make it bett If you are worried or don’t know where to start, check out our next section explaining what kind of help we could use and where can you get involved. You can reach out with questions to [Eldad Fux (@eldadfux)](https://twitter.com/eldadfux) or [@appwrite_io](https://twitter.com/appwrite_io) on Twitter, and anyone from the [Appwrite team on Discord](https://discord.gg/GSeTUeA). You can also submit an issue, and a maintainer can guide you! -You can get an in-depth understanding of the Utopia-PHP Http in our [Getting Started](docs/Getting-Starting-Guide.md) guide. +You can get an in-depth understanding of Utopia HTTP in our [Getting Started](docs/Getting-Starting-Guide.md) guide. ## Code of Conduct -Help us keep Utopia-PHP Http open and inclusive. Please read and follow our [Code of Conduct](/CODE_OF_CONDUCT.md). +Help us keep Utopia HTTP open and inclusive. Please read and follow our [Code of Conduct](/CODE_OF_CONDUCT.md). ## Submit a Pull Request 🚀 @@ -72,33 +72,33 @@ $ git push origin [name_of_your_new_branch] ## Introducing New Features -We would 💖 you to contribute to Utopia-PHP HTTP, but we would also like to make sure Http is as great as possible and loyal to its vision and mission statement 🙏. +We would 💖 you to contribute to Utopia HTTP, but we would also like to make sure this library is as great as possible and loyal to its vision and mission statement 🙏. For us to find the right balance, please open an issue explaining your ideas before introducing a new pull request. -This will allow the Utopia-PHP Http community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision. +This will allow the community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision. -This is also important for the Http lead developers to be able to give technical input and different emphasis regarding the feature design and architecture. Some bigger features might need to go through our [RFC process](https://github.com/appwrite/rfc). +This is also important for the repository owners to be able to give technical input and different emphasis regarding the feature design and architecture. Some bigger features might need to go through our [RFC process](https://github.com/appwrite/rfc). ## Other Ways to Help -Pull requests are great, but there are many other areas where you can help Utopia-PHP Http +Pull requests are great, but there are many other areas where you can help: ### Blogging & Speaking -Blogging, speaking about, or creating tutorials about one of Http's many features is great way to contribute and help our project grow. +Creating blog posts, giving talks, or developing tutorials about one of this library's many features are excellent ways to contribute and help our project grow. ### Presenting at Meetups -Presenting at meetups and conferences about your Http projects. Your unique challenges and successes in building things with Utopia-PHP Http can provide great speaking material. We’d love to review your talk abstract/CFP, so get in touch with us if you’d like some help! +Presenting at meetups and conferences about your Utopia projects. Your unique challenges and successes in building things with this library can provide great speaking material. We’d love to review your conference talk abstract, so get in touch with us if you’d like some help! ### Sending Feedbacks & Reporting Bugs -Sending feedback is a great way for us to understand your different use cases of Utopia-PHP Http better. If you had any issues, bugs, or want to share about your experience, feel free to do so on our GitHub issues page or at our [Discord channel](https://discord.gg/GSeTUeA). +Sending feedback is a great way for us to understand your different use cases of this library better. If you had any issues, bugs, or want to share about your experience, feel free to do so on our GitHub issues page or at our [Discord channel](https://discord.gg/GSeTUeA). ### Submitting New Ideas -If you think Utopia-PHP Http could use a new feature, please open an issue on our GitHub repository, stating as much information as you can think about your new idea and it's implications. We would also use this issue to gather more information, get more feedback from the community, and have a proper discussion about the new feature. +If you think this library could use a new feature, please open an issue on our GitHub repository, stating as much information as you can think about your new idea and it's implications. We would also use this issue to gather more information, get more feedback from the community, and have a proper discussion about the new feature. ### Improving Documentation @@ -106,4 +106,4 @@ Submitting documentation updates, enhancements, designs, or bug fixes. Spelling ### Helping Someone -Searching for Utopia-PHP Http on Discord, GitHub, or StackOverflow and helping someone else who needs help. You can also help by teaching others how to contribute to Http's repo! +Searching for Utopia-PHP on Discord, GitHub, or StackOverflow and helping someone else who needs help. You can also help by teaching others how to contribute to this repo! diff --git a/README.md b/README.md index 71f1504e..137e384c 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ ![Total Downloads](https://img.shields.io/packagist/dt/utopia-php/http.svg) [![Discord](https://img.shields.io/discord/564160730845151244?label=discord)](https://discord.gg/GSeTUeA) -Utopia Http is a PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. This library is maintained by the [Appwrite team](https://appwrite.io). +Utopia HTTP is a PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. This library is maintained by the [Appwrite team](https://appwrite.io). -Utopia Http is dependency-free. Any extra features, such as authentication or caching are available as standalone models in order to keep the framework core clean, light, and easy to learn. +Utopia HTTP is dependency-free. Any extra features, such as authentication or caching are available as standalone models in order to keep the framework core clean, light, and easy to learn. ## Getting Started @@ -61,7 +61,7 @@ curl http://localhost:8000/hello-world ### Server Adapters -The library supports server adapters to be able to run on any PHP setup. Youx1s could use the FPM server or the Swoole server. +The library supports server adapters to be able to run on any PHP setup. You could use the FPM or Swoole server. #### Use PHP FPM server @@ -244,15 +244,15 @@ In advanced scenarios, resources can also be injected into other resources or en Resources are designed to prepare dependencies or context for the request. Resources are not meant to do functional logic or return callbacks. For such a use case, you should use hooks. -To learn more about Http architecture and features, check out more in-depth [Getting started guide](/docs/Getting-Starting-Guide.md). +To learn more about architecture and features for this library, check out more in-depth [Getting started guide](/docs/Getting-Starting-Guide.md). ## System Requirements -Utopia Http requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible. +Utopia HTTP requires PHP 8.1 or later. We recommend using the latest PHP version whenever possible. ## More from Utopia -Our ecosystem supports other thin PHP projects aiming to extend the core PHP Utopia Http. +Our ecosystem supports other thin PHP projects aiming to extend the core PHP Utopia HTTP. Each project is focused on solving a single, very simple problem and you can use composer to include any of them in your next project. diff --git a/docs/Getting-Starting-Guide.md b/docs/Getting-Starting-Guide.md index 2d5cf9c4..04a2aae9 100644 --- a/docs/Getting-Starting-Guide.md +++ b/docs/Getting-Starting-Guide.md @@ -1,7 +1,7 @@ # Getting Started with Utopia-PHP # Intro -Utopia Http is an easy-to-use PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. It follows an architecture like Express and is based on the declarative programming approach. Documenting and writing code are usually seen as two separate tasks and very often, documentation loses priority in the software development lifecycle. Utopia unifies the two with a flexible API that allows your code to be self-documenting. What’s interesting about Utopia is its ability to accept metadata along with it’s route definitions. This metadata can then be used for various purposes like generating documentation, swagger specifications and more. +Utopia HTTP is an easy-to-use PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. It follows an architecture like Express and is based on the declarative programming approach. Documenting and writing code are usually seen as two separate tasks and very often, documentation loses priority in the software development lifecycle. Utopia unifies the two with a flexible API that allows your code to be self-documenting. What’s interesting about Utopia is its ability to accept metadata along with it’s route definitions. This metadata can then be used for various purposes like generating documentation, swagger specifications and more. # Defining Routes If you’re new to Utopia, let’s get started by looking at an example of a basic GET route for an application that you can create using Utopia. We'll be using a [Swoole server](https://github.com/swoole/swoole-src) in this example, but you should be able to extend it to any HTTP server. @@ -281,7 +281,7 @@ Http::shutdown(function($request) { # Running Locally If you have PHP and Composer installed on your device, you can run Utopia apps locally by downloading the Utopia-PHP/http dependency using `composer require utopia-php/http` command. -> Utopia Http requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible. +> Utopia HTTP requires PHP 8.1 or later. We recommend using the latest PHP version whenever possible. Wonderful! 😄 You’re all set to create a basic demo app using the Utopia Http. If you have any issues or questions feel free to reach out to us on our [Discord Server](https://appwrite.io/discord). From 9c641f2a1f81fb27aa21e0dece9408ac6f351aa4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matej=20Ba=C4=8Do?= Date: Fri, 5 Jan 2024 12:15:44 +0100 Subject: [PATCH 8/9] Update docs/Getting-Starting-Guide.md Co-authored-by: Torsten Dittmann --- docs/Getting-Starting-Guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Getting-Starting-Guide.md b/docs/Getting-Starting-Guide.md index 04a2aae9..e1aa0de2 100644 --- a/docs/Getting-Starting-Guide.md +++ b/docs/Getting-Starting-Guide.md @@ -279,7 +279,7 @@ Http::shutdown(function($request) { # Running Locally -If you have PHP and Composer installed on your device, you can run Utopia apps locally by downloading the Utopia-PHP/http dependency using `composer require utopia-php/http` command. +If you have PHP and Composer installed on your device, you can run Utopia apps locally by downloading the `utopia-php/http` dependency using `composer require utopia-php/http` command. > Utopia HTTP requires PHP 8.1 or later. We recommend using the latest PHP version whenever possible. From ea29fe6c19edbaa73090141a81a51ae7ceb3dec4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matej=20Ba=C4=8Do?= Date: Fri, 5 Jan 2024 11:17:35 +0000 Subject: [PATCH 9/9] PR review changes --- CONTRIBUTING.md | 4 ++-- docs/Getting-Starting-Guide.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c01dbd27..3ab8893b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -We would ❤️ for you to contribute to `utopia-php/http` and help make it better! We want contributing to this library to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs as well as updates and tweaks, blog posts, workshops, and more. +We would ❤️ for you to contribute to Utopia HTTP and help make it better! We want contributing to this library to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs as well as updates and tweaks, blog posts, workshops, and more. ## How to Start? @@ -106,4 +106,4 @@ Submitting documentation updates, enhancements, designs, or bug fixes. Spelling ### Helping Someone -Searching for Utopia-PHP on Discord, GitHub, or StackOverflow and helping someone else who needs help. You can also help by teaching others how to contribute to this repo! +Searching for Utopia HTTP on Discord, GitHub, or StackOverflow and helping someone else who needs help. You can also help by teaching others how to contribute to this repo! diff --git a/docs/Getting-Starting-Guide.md b/docs/Getting-Starting-Guide.md index e1aa0de2..b0f46a4b 100644 --- a/docs/Getting-Starting-Guide.md +++ b/docs/Getting-Starting-Guide.md @@ -1,4 +1,4 @@ -# Getting Started with Utopia-PHP +# Getting Started with Utopia HTTP # Intro Utopia HTTP is an easy-to-use PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. It follows an architecture like Express and is based on the declarative programming approach. Documenting and writing code are usually seen as two separate tasks and very often, documentation loses priority in the software development lifecycle. Utopia unifies the two with a flexible API that allows your code to be self-documenting. What’s interesting about Utopia is its ability to accept metadata along with it’s route definitions. This metadata can then be used for various purposes like generating documentation, swagger specifications and more. @@ -283,5 +283,5 @@ If you have PHP and Composer installed on your device, you can run Utopia apps l > Utopia HTTP requires PHP 8.1 or later. We recommend using the latest PHP version whenever possible. -Wonderful! 😄 You’re all set to create a basic demo app using the Utopia Http. If you have any issues or questions feel free to reach out to us on our [Discord Server](https://appwrite.io/discord). +Wonderful! 😄 You’re all set to create a basic demo app using the Utopia HTTP. If you have any issues or questions feel free to reach out to us on our [Discord Server](https://appwrite.io/discord).