Merge pull request #295 from Liturgical-Calendar/development

Prepare v4.4 release

Author: JohnRDOrazio

Dockerfile

@@ -1,20 +1,20 @@
-# Use the official PHP 8.3 CLI image as the base image
+# Use the official PHP 8.4 CLI image as the base image
 FROM php:8.4-cli AS build
 
 # Install necessary PHP extensions and Composer in one step to minimize layers
 RUN apt-get update -y && \
-    apt-get upgrade -y && \
-    apt-get install -y --no-install-suggests --no-install-recommends libicu-dev libonig-dev libzip-dev gettext libyaml-dev && \
+    apt-get install -y --no-install-suggests --no-install-recommends \
+        libicu-dev libonig-dev libzip-dev gettext libyaml-dev && \
     docker-php-ext-install intl zip gettext calendar && \
     pecl install yaml && \
     docker-php-ext-enable intl zip gettext calendar yaml && \
     curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer && \
-    apt-get clean && \
     rm -rf /var/lib/apt/lists/*
 
 # Set the working directory
 WORKDIR /var/www/html
 
+# Copy composer files first for caching purposes
 COPY composer.json composer.lock ./
 
 # Run composer install to install dependencies
@@ -32,25 +32,23 @@ FROM php:8.4-cli AS main
 # Set the working directory
 WORKDIR /var/www/html
 
+# Install runtime dependencies (not the -dev packages)
+RUN apt-get update -y && \
+    apt-get install -y --no-install-suggests --no-install-recommends \
+    libyaml-0-2 libzip4 locales-all && \
+    rm -rf /var/lib/apt/lists/*
+
 # Copy the compiled PHP extensions from the build stage
-COPY --from=build /usr/lib/x86_64-linux-gnu/libyaml* /usr/lib/x86_64-linux-gnu
-COPY --from=build /usr/lib/x86_64-linux-gnu/libzip* /usr/lib/x86_64-linux-gnu
 COPY --from=build /usr/local/lib/php/extensions /usr/local/lib/php/extensions
 COPY --from=build /usr/local/etc/php/conf.d /usr/local/etc/php/conf.d
 COPY --from=build /usr/local/bin/composer /usr/local/bin/composer
 COPY --from=build /var/www/html /var/www/html
 
-RUN apt-get update -y && \
-    apt-get upgrade -y && \
-    apt-get install -y --no-install-suggests --no-install-recommends locales-all && \
-    apt-get clean && \
-    rm -rf /var/lib/apt/lists/*
+# Set the environment variable
+ENV PHP_CLI_SERVER_WORKERS=6
 
 # Expose port 8000 to the host
 EXPOSE 8000
 
-# Set the environment variable
-ENV PHP_CLI_SERVER_WORKERS=6
-
 # Command to run PHP's built-in server
 CMD ["php", "-S", "0.0.0.0:8000", "-t", "/var/www/html"]

README.md

@@ -41,10 +41,10 @@ Some characteristics of this API:
 # Example applications
 There are a few proof of concept example applications for usage of the API at https://litcal.johnromanodorazio.com/usage.php, which demonstrate generating an HTML representation of the Liturgical Calendar.
 
-* The [first example](https://litcal.johnromanodorazio.com/examples/php/) uses cURL in PHP to make a request to the endpoint and handle the results.
-* The [second example](https://litcal.johnromanodorazio.com/examples/javascript/) uses `fetch` in Javascript to make the request to the endpoint and handle the results.
-* The [third example](https://litcal.johnromanodorazio.com/examples/fullcalendar/examples/month-view.html) makes use of the [FullCalendar javascript framework](https://github.com/fullcalendar/fullcalendar) to display the results from the `fetch` request in a nicely formatted calendar view.
-* The [fourth example](https://litcal.johnromanodorazio.com/examples/fullcalendar/examples/messages.html) is the same as the third except that it outputs the Messages first and the [FullCalendar](https://github.com/fullcalendar/fullcalendar) calendar view after.
+* The [first example](https://litcal.johnromanodorazio.com/examples.php?example=PHP) uses cURL in PHP to make a request to the endpoint and handle the results.
+* The [second example](https://litcal.johnromanodorazio.com/examples.php?example=JavaScript) uses `fetch` in Javascript to make the request to the endpoint and handle the results.
+* The [third example](https://litcal.johnromanodorazio.com/examples.php?example=FullCalendar) makes use of the [FullCalendar javascript framework](https://github.com/fullcalendar/fullcalendar) to display the results from the `fetch` request in a nicely formatted calendar view.
+* The [fourth example](https://litcal.johnromanodorazio.com/examples.php?example=FullCalendarMessages) is the same as the third except that it outputs the Messages first and the [FullCalendar](https://github.com/fullcalendar/fullcalendar) calendar view after.
 
 All of these examples request `JSON` as the data exchange format generated by the endpoint. Any application could use the endpoint in a similar manner: an Android App, a plugin for a Desktop Publishing App...
 
@@ -60,23 +60,23 @@ _(See [usage.php#calSubscription](https://litcal.johnromanodorazio.com/usage.php
 # Testing locally
 
 System requirements:
-* PHP >= 8.1
+* PHP >= 8.4 (we make use of more modern PHP functions such as `array_find`)
 * PHP modules installed and enabled: `intl` * `zip` * `gettext` * `calendar` * `yaml`
 * System language packs for all the supported languages
 
 ## Using PHP's builtin server
 
-To test the API locally, you can use PHP's builtin server. However, you will need to spawn at least a couple of workers, since some routes will make a request internally to another route. For example, a request to the `/calendar` route will make a request internally to the `/calendars` route.
+To test the API locally, you can use PHP's builtin server. However, you will need to spawn at least a couple of workers, since some routes will make a request internally to another route. For example, a request to the `/calendar` route will make a request internally to the `/calendars` route. To be really safe, you could spawn up to 6 workers.
 
 Spawn at least two workers:
 ```bash
 PHP_CLI_SERVER_WORKERS=2 php -S localhost:8000
 ```
 
-## Using a docker container
-
 For convenience when using VSCode, a `tasks.json` has been defined so that you can simply type <kbd>CTRL</kbd>+<kbd>SHIFT</kbd>+<kbd>B</kbd> (<kbd>CMD</kbd>+<kbd>SHIFT</kbd>+<kbd>B</kbd> on MacOS) to start the PHP builtin server and open the browser.
 
+## Using a docker container
+
 To further simplify your setup, without having to worry about getting all the system requirements in place, you can also launch the API in a docker container using the repo `Dockerfile`:
 
 ```bash
@@ -87,6 +87,9 @@ docker build -t liturgy-api:{branch} .
 docker run -p 8000:8000 -d liturgy-api:{branch}
 ```
 
+This will result in a docker image of about 1.09GB. Unfortunately this cannot be reduced by means of an alpine image,
+if we want to install system locales in order for `gettext` to work properly with all supported languages.
+
 # Translations
 
 <a href="https://translate.johnromanodorazio.com/engage/liturgical-calendar/">
@@ -95,6 +98,9 @@ docker run -p 8000:8000 -d liturgy-api:{branch}
 
 # CHANGELOG
 
+## [v4.4](https://github.com/JohnRDOrazio/LiturgicalCalendar/releases/tag/v4.4) (March 22nd 2025)
+* restore national calendar `PUT`, `PATCH` and `DELETE` requests with full support for all i18n languages (issues #284, #265, and #220)
+
 ## [v4.3](https://github.com/JohnRDOrazio/LiturgicalCalendar/releases/tag/v4.3) (January 26th 2025)
 * realign XML output with latest developments (issue #290)
 

composer.json

@@ -5,7 +5,7 @@
     "keywords": ["api","rest","restful","liturgy","calendar","liturgical","universal","roman","catholic"],
     "homepage": "https://litcal.johnromanodorazio.com",
     "require": {
-        "php": ">=8.1",
+        "php": ">=8.4",
         "swaggest/json-schema": "~0.12",
         "cboden/ratchet": "~0.4",
         "sabre/vobject": "^4.5.1",