feat(MPDZBS-877): zmscitizenapi into next

.github/workflows/build-images.yaml

@@ -45,6 +45,8 @@ jobs:
             php_version: "8.0"
           - module: zmscalldisplay
             php_version: "8.0"
+          - module: zmscitizenapi
+            php_version: "8.0"
           - module: zmsmessaging
             php_version: "8.0"
           - module: zmsstatistic

.github/workflows/unit-tests.yaml

@@ -27,6 +27,8 @@ jobs:
             php_version: "8.0"
           - module: zmscalldisplay
             php_version: "8.0"
+          - module: zmscitizenapi
+            php_version: "8.0"
           - module: zmsdldb
             php_version: "8.0"
           - module: zmsentities

.htaccess

@@ -39,6 +39,14 @@ RewriteRule ^terminvereinbarung/calldisplay(.*) /var/www/html/zmscalldisplay/pub
 RewriteRule ^terminvereinbarung/calldisplay/+_(.*) /var/www/html/zmscalldisplay/public/_$1 [QSA]
 
 
+# zmscitizenapi
+SetEnvIf Request_URI ^/zmscitizenapi ZMS_MODULE_BASEPATH=/terminvereinbarung/api/citizen
+RewriteCond %{REQUEST_URI} !^/terminvereinbarung/api/citizen/+(_|doc)
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^terminvereinbarung/api/citizen(.*) /var/www/html/zmscitizenapi/public/index.php?$1 [QSA]
+RewriteRule ^terminvereinbarung/api/citizen/+(doc|_)(.*) /var/www/html/zmscitizenapi/public/$1$2 [QSA]
+
+
 # zmsstatistic
 SetEnvIf Request_URI ^/zmsstatistic ZMS_MODULE_BASEPATH=/terminvereinbarung/statistic
 RewriteCond %{REQUEST_URI} !^/terminvereinbarung/[^/]+/+_

cli

@@ -22,6 +22,7 @@ modules = [
   "zmsadmin",
   "zmsapi",
   "zmscalldisplay",
+  "zmscitizenapi",
   "zmsclient",
   "zmsdb",
   "zmsdldb",

mellon/phpunit.xml.dist

@@ -10,7 +10,7 @@
             convertWarningsToExceptions="true"
             processIsolation="false"
             forceCoversAnnotation="false" 
-            stopOnFailure="true"
+            stopOnFailure="false"
             bootstrap="tests/bootstrap.php"
 >
     <testsuites>

zmsadmin/tests/Zmsadmin/fixtures/GET_processList_empty.json

@@ -4,7 +4,7 @@
         "$schema": "https://schema.berlin.de/queuemanagement/metaresult.json",
         "error": false,
         "generated": "2019-02-11T16:07:58+01:00",
-        "server": "Zmsapi-ENV (v2.19.02-38-g0ba2cba)"
+        "server": "Zmsapi"
     },
     "data": []
 }

zmsadmin/tests/Zmsadmin/fixtures/GET_processList_fake_entry.json

@@ -4,7 +4,7 @@
         "$schema": "https://schema.berlin.de/queuemanagement/metaresult.json",
         "error": false,
         "generated": "2019-02-11T16:07:58+01:00",
-        "server": "Zmsapi-ENV (v2.19.02-38-g0ba2cba)"
+        "server": "Zmsapi"
     },
     "data": [
         {

zmsadmin/tests/Zmsadmin/fixtures/GET_source_unittest.json

@@ -4,7 +4,7 @@
         "$schema": "https://schema.berlin.de/queuemanagement/metaresult.json",
         "error": false,
         "generated": "2019-02-08T14:45:15+01:00",
-        "server": "Zmsapi-ENV (v2.19.02-38-g0ba2cba)"
+        "server": "Zmsapi"
     },
     "data": {
         "$schema": "https://schema.berlin.de/queuemanagement/source.json",

zmsapi/public/doc/README.md

@@ -1,6 +1,22 @@
 ## How does the Open Api definition work
 ## Version 2.0
 
+```
+bin/configure
+npm i
+npm run build
+npm run doc
+swagger-cli bundle -o public/doc/swagger.json public/doc/swagger.yaml
+python3 -m http.server 8001
+```
+
+Reachable at:
+```
+http://[::]:8001/public/doc/
+https://zms.ddev.site/terminvereinbarung/api/2/doc/index.html
+https://it-at-m.github.io/eappointment/zmsapi/public/doc/index.html
+```
+
 * Under /public/doc are the schema from zmsentities. A symbolic link points to the corresponding folder under vendor/eappointment/zmsentities/schema.
 
 * Under /bin there is a build_swagger.js file. This is executed via ``npm run doc`` and validates the existing swagger.yaml file. If valid, the open api annotations are read from routing.php and the remaining information such as info, definitions, version and tags are compiled from the yaml files under ./partials into a complete swagger.yaml. 

zmscalldisplay/phpunit.xml

@@ -10,7 +10,7 @@
   convertNoticesToExceptions="true" 
   convertWarningsToExceptions="true" 
   forceCoversAnnotation="false" 
-  stopOnFailure="true" 
+  stopOnFailure="false" 
   verbose="true"
   processIsolation="false"
 >

zmscitizenapi/.gitignore

@@ -0,0 +1,17 @@
+node_modules
+vendor
+vendor.zmsbase
+config.php
+tags
+.DS_*
+public/_tests
+public/doc/assets/redoc.min.js
+public/doc/swagger.*
+public/_test/assets/swagger-ui-bundle.js
+public/_test/assets/swagger-ui.css
+public/_test/assets/swagger-ui-standalone-preset.js
+cache
+vendor.old
+vendor.update
+VERSION
+.phpunit.result.cache

zmscitizenapi/Makefile

@@ -0,0 +1,32 @@
+.PHONY: help now dev live watch fix openapi coverage paratest
+
+help: # This help
+	@echo "Possible Targets:"
+	@grep -P "^\w+:" Makefile|sort|perl -pe 's/^(\w+):([^\#]+)(\#\s*(.*))?/ \1\n\t\4\n/'
+
+now: # Dummy target
+
+dev: # init development system
+	COMPOSER=composer.json composer update
+	npm install
+
+live: # init live system, delete unnecessary libs
+	composer install --no-dev --prefer-dist
+	bin/configure
+	npm install
+	npm run build
+	npm run doc
+	npx swagger-cli bundle -o public/doc/swagger.json public/doc/swagger.yaml
+
+fix: # run code fixing
+	php vendor/bin/phpcbf --standard=psr2 src/
+	php vendor/bin/phpcbf --standard=psr2 tests/
+
+openapi: # Swagger docs on changes
+	./bin/doc
+
+coverage:
+	php vendor/bin/phpunit --coverage-html public/_tests/coverage/
+
+paratest: # init parallel unit testing with 5 processes
+	vendor/bin/paratest -p20 --coverage-html public/_tests/coverage/

zmscitizenapi/bin/build_swagger.js

@@ -0,0 +1,89 @@
+var fs = require('fs');
+const swaggerParser = require('swagger-parser');
+const swaggerJsdoc = require('swagger-jsdoc');
+const yaml = require('js-yaml');
+
+const options = {
+    definition: {
+      openapi: '2.0.0',
+      info: {
+        version: readApiVersion(),
+        title: "ZMS API"
+      },
+    },
+    apis: ['./routing.php']
+  };
+
+const openapiSpecification = swaggerJsdoc(options);
+
+buildSwagger();
+validateSwagger();
+
+function validateSwagger() {
+
+    fs.stat('public/doc/swagger.yaml', function(error, stats) {
+        var routessize = stats.size;
+        if (error) {
+            console.log(error);
+        } else {
+            console.log("Found public/doc/swagger.yaml with " + routessize + " bytes");
+        }
+
+        swaggerParser.validate('public/doc/swagger.yaml', (err, api) => {
+            if (err) {
+                console.error(err);
+              }
+              else {
+                console.log("Validated API %s, Version: %s", api.info.title, api.info.version);
+              }
+        })
+    });
+}
+
+function buildSwagger() {
+  let version = readFileContent('public/doc/partials/version.yaml') + "\n";
+  let info = readFileContent('public/doc/partials/info.yaml');
+  //append current api version to info
+  info = info + "\n  version: '" + readFileContent("./VERSION").trim() + "'\n";
+
+  let basics = readFileContent('public/doc/partials/basic.yaml') + "\n";
+  let paths = {
+    paths: 
+      openapiSpecification.paths,
+  }
+  let tags = readFileContent('public/doc/partials/tags.yaml');
+  let definitions = readFileContent('public/doc/partials/definitions.yaml');
+  writeSwaggerFile(version + info + basics + tags + yaml.dump(paths) + definitions)
+
+}
+
+function writeSwaggerFile(data)
+{
+  try {
+    fs.writeFileSync('public/doc/swagger.yaml', data, 'utf8');
+    console.log("Build new swagger file successfully!");
+  } catch (e) {
+    console.log(e);
+  }
+}
+
+function readFileContent(file) {
+  try {
+    const data = fs.readFileSync(file, 'utf8');
+    return data;
+  } catch (e) {
+    console.log(e);
+  }
+}
+
+function readApiVersion() {
+    fs.readFile('./VERSION', 'utf8' , (err, data) => {
+        if (err) {
+          console.error(err)
+          return
+        }
+        return data;
+      })
+}
+
+

zmscitizenapi/bin/configure

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+REALPATH=$(which realpath || which readlink)
+REALPATH=$([[ "$REALPATH" =~ 'readlink' ]] && echo "$REALPATH -e" || echo "$REALPATH")
+DIR=$(dirname $($REALPATH ${BASH_SOURCE[0]}))
+ROOT=$($REALPATH $DIR/..)
+
+#echo "Get DLDB Exports"
+#$ROOT/bin/getDldbExport
+
+echo -n "Configuring application"
+mkdir -p $ROOT/.git/hooks
+ln -sf $ROOT/bin/test $ROOT/.git/hooks/pre-commit
+ln -sf $ROOT/bin/configure $ROOT/.git/hooks/post-checkout
+ln -sf $ROOT/bin/configure $ROOT/.git/hooks/post-commit
+ln -sf $ROOT/bin/configure $ROOT/.git/hooks/post-merge
+
+if [ ! -e $ROOT/config.php ]
+then	
+    cp $ROOT/config.example.php $ROOT/config.php
+fi
+test -d $ROOT/cache && chmod -fR a+rwX $ROOT/cache || echo "Could not chmod cache files"
+
+
+#VERSION=`git symbolic-ref -q --short HEAD || git describe --tags --exact-match`
+VERSION=`git describe --tags --always`
+echo $VERSION > $ROOT/VERSION
+echo " $VERSION"

zmscitizenapi/bootstrap.php

@@ -0,0 +1,39 @@
+<?php
+/*if (php_sapi_name() !== 'cli' && (!defined('BOOTSTRAP_ALLOW_WEB') || !BOOTSTRAP_ALLOW_WEB)) {
+    header('HTTP/1.0 403 Forbidden');
+    exit('Access Denied');
+}*/ // If activated blocks direct api access via http
+
+// @codingStandardsIgnoreFile
+chdir(__DIR__);
+
+// define the application path as single global constant
+if (!defined('APP_PATH')) {
+    define('APP_PATH', realpath(__DIR__));
+}
+
+// use autoloading offered by composer, see composer.json for path settings
+if (file_exists(APP_PATH . '/vendor/autoload.php')) {
+    define('VENDOR_PATH', APP_PATH . '/vendor');
+} else {
+    define('VENDOR_PATH', APP_PATH . '/../..');
+}
+require_once(VENDOR_PATH . '/autoload.php');
+
+
+// initialize the static \App singleton
+require(APP_PATH . '/config.php');
+
+// Set option for environment, routing, logging and templating
+\BO\Slim\Bootstrap::init();
+
+\App::$slim->addBodyParsingMiddleware();
+
+\App::$http = new \BO\Zmsclient\Http(\App::ZMS_API_URL);
+//\BO\Zmsclient\Psr7\Client::$curlopt = \App::$http_curl_config;
+
+//$errorMiddleware = \App::$slim->getContainer()->get('errorMiddleware');
+//$errorMiddleware->setDefaultErrorHandler(new \BO\Zmscitizenapi\Helper\ErrorHandler());
+
+// load routing
+\BO\Slim\Bootstrap::loadRouting(\App::APP_PATH . '/routing.php');

zmscitizenapi/composer.json

@@ -0,0 +1,57 @@
+{
+    "name": "eappointment/zmscitizenapi",
+    "description": "This application offers a REST-like interface for citizens on the internet.",
+    "license": "EUPL-1.2",
+    "authors": [],
+    "repositories": [
+        {
+            "type": "path",
+            "url": "../*",
+            "options": {
+                "symlink": true
+            }
+        }
+    ],
+    "config": {
+        "platform": {
+            "php": "8.0"
+        },
+        "allow-plugins": {
+            "php-http/discovery": true
+        }
+    },
+    "require-dev": {
+        "phpmd/phpmd": "@stable",
+        "squizlabs/php_codesniffer": "*",
+        "phpunit/phpunit": "^9.5.4",
+        "helmich/phpunit-psr7-assert": "^4.3.0",
+        "phpspec/prophecy-phpunit": "^2.0.0"
+    },
+    "require": {
+        "eappointment/mellon": "@dev",
+        "eappointment/zmsslim": "@dev",
+        "eappointment/zmsclient": "@dev",
+        "eappointment/zmsentities": "@dev"
+    },
+    "scripts": {
+        "clean": "rm -f public/doc/assets/*.* && rm -f public/_test/assets/*.*",
+        "command": "bin/configure",
+        "wget-files": [
+            "wget https://eappointment.gitlab.io/zmsapi/doc/swagger.json -O public/doc/swagger.json",
+            "wget https://eappointment.gitlab.io/zmsapi/doc/assets/redoc.min.js -O public/doc/assets/redoc.min.js"
+        ],
+        "post-install-cmd": [
+            "@wget-files"
+        ],
+        "post-update-cmd": [
+            "@wget-files"
+        ]
+    },
+    "bin": [],
+    "autoload": {
+        "psr-4": {
+            "BO\\Zmscitizenapi\\": "src/Zmscitizenapi/",
+            "BO\\Zmscitizenapi\\Tests\\": "tests/Zmscitizenapi/"
+        }
+    }
+}