initial release

Author: kamarton

Diff for: .dockerignore

@@ -0,0 +1,4 @@
+vendor
+.git
+.github
+.idea

Diff for: .github/workflows/phpunit.yml

@@ -0,0 +1,30 @@
+name: Run PHPUnit Tests (PHP-DI, nyholm/psr7)
+
+on:
+  push:
+    paths-ignore:
+      - 'README.md'
+
+jobs:
+  phpunit:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php-version: [ 8.2, 8.3, 8.4 ]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --no-progress --prefer-dist
+
+      - name: Run PHPUnit tests/*
+        run: vendor/bin/phpunit tests/*

Diff for: .gitignore

@@ -0,0 +1,3 @@
+.idea
+vendor
+composer*.phar

Diff for: README.md

@@ -0,0 +1,76 @@
+# HTTP cache header middlewares for PSR-7, PSR-11
+
+**This package is under development, and not ready for production use.**
+
+This package provides a set (eg. Cache-Control, ETag) of HTTP cache handling PSR-7, PSR-11 compatible middlewares.
+
+## Installation
+
+```bash
+composer require smartondev/httpcache-middleware
+```
+
+## Usage
+
+### Cache-Control
+
+For use `Cache-Control`, `ETag`, `Last-Modified` and more http "caching" headers, you need to add `HttpCacheMiddleware`
+to your route.
+
+```php
+use SmartonDev\HttpCacheMiddleware\Http\Middleware\HttpCacheMiddleware;
+use SmartonDev\HttpCacheMiddleware\Providers\Constants\ProviderConstants;
+
+// add HttpCacheContextService to container with ProviderConstants::HTTP_CACHE_CONTEXT_SERVICE_ID as singleton per request
+
+Route::get('/api/user/{id}', function ($id) {
+    $user = User::find($id);
+    app()->get(ProviderConstants::HTTP_CACHE_CONTEXT_SERVICE_ID)->getCacheHeaderBuilder()->maxAge(days: 30)->public();
+    return response()->json($user);
+})->middleware(HttpCacheMiddleware::class);
+```
+
+### ETag
+
+For use ETag, you need to add `ETagMatchMiddleware` to your route. You need to implement `ETagResolverInterface` and add
+it to the container with `ProviderConstants::ETAG_RESOLVER_SERVICE_ID`. For use ETag you need to
+add `HttpCacheContextService` and`HttpCacheMiddleware` to the container
+with `ProviderConstants::HTTP_CACHE_CONTEXT_SERVICE_ID`
+and `ProviderConstants::HTTP_CACHE_MIDDLEWARE_SERVICE_ID`.
+
+```php
+use SmartonDev\HttpCacheMiddleware\Http\Middleware\ETagMatchMiddleware;
+use SmartonDev\HttpCacheMiddleware\Http\Middleware\HttpCacheMiddleware;
+use SmartonDev\HttpCacheMiddleware\Providers\Constants\ProviderConstants;
+use SmartonDev\HttpCacheMiddleware\Contracts\ETagResolverInterface;
+
+class ETagResolver implements ETagResolverInterface
+{
+    public function resolve($request): string
+    {
+        // use it own logic to generate ETag
+        $id = $request->route('id');
+        $etagFromCache = Cache::get('etag_' . $id);
+        return $etagFromCache;
+    }
+}
+// add ETagResolver to container with ProviderConstants::ETAG_RESOLVER_SERVICE_ID
+// add HttpCacheContextService to container with ProviderConstants::HTTP_CACHE_CONTEXT_SERVICE_ID as singleton pre request
+
+Route::get('/api/user/{id}', function ($id) {
+    $user = User::find($id);
+    app()->get(ProviderConstants::HTTP_CACHE_CONTEXT_SERVICE_ID)->getCacheHeaderBuilder()->maxAge(days: 30)->public();
+    // etag added automatically, or you can set it manually
+    return response()->json($user);
+})->middleware(HttpCacheMiddleware::class)->middleware(ETagMatchMiddleware::class);
+```
+
+### Modified since
+
+```php
+
+```
+
+## Author
+
+- [Márton Somogyi](https://github.com/kamarton)

Diff for: composer.json

@@ -0,0 +1,46 @@
+{
+  "name": "smartondev/httpcache-middleware",
+  "description": "PSR-7, PSR-11 compatible middlewares for HTTP cache handling",
+  "keywords": [
+    "middleware",
+    "PSR-7",
+    "PSR-11",
+    "HTTP",
+    "HTTP-cache",
+    "Cache-control",
+    "ETag",
+    "Cache"
+  ],
+  "type": "library",
+  "license": "Apache-2.0",
+  "authors": [
+    {
+      "name": "Márton Somogyi",
+      "email": "[email protected]"
+    }
+  ],
+  "require": {
+    "php": "^8.2",
+    "psr/http-message": "^2.0",
+    "psr/container": "^2.0",
+    "smartondev/httpcache": "^0.2.0",
+    "psr/http-server-middleware": "^1.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^11.0",
+    "php-di/php-di": "^7.0",
+    "nyholm/psr7": "^1.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "SmartonDev\\HttpCacheMiddleware\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "SmartonDev\\HttpCacheMiddleware\\Tests\\": "tests/"
+    }
+  },
+  "minimum-stability": "dev",
+  "prefer-stable": true
+}