Merge pull request #2 from YunoHost-Apps/testing

Testing
2021-11-20 22:10:05 +01:00 · 2021-11-20 22:10:05 +01:00 · 64b8438807
commit 64b8438807
parent cc5e33d6fe d95deb2069
14 changed files with 269 additions and 47 deletions
--- a/.github/workflows/updater.sh
+++ b/.github/workflows/updater.sh
@ -0,0 +1,130 @@
+#!/bin/bash
+
+#=================================================
+# PACKAGE UPDATING HELPER
+#=================================================
+
+# This script is meant to be run by GitHub Actions
+# The YunoHost-Apps organisation offers a template Action to run this script periodically
+# Since each app is different, maintainers can adapt its contents so as to perform
+# automatic actions when a new upstream release is detected.
+
+# Remove this exit command when you are ready to run this Action
+#exit 1
+
+#=================================================
+# FETCHING LATEST RELEASE AND ITS ASSETS
+#=================================================
+
+# Fetching information
+current_version=$(cat manifest.json | jq -j '.version|split("~")[0]')
+repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]')
+# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions)
+version=$(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1)
+assets=($(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '[ .[] | select(.tag_name=="'$version'").assets[].browser_download_url ] | join(" ") | @sh' | tr -d "'"))
+
+# Later down the script, we assume the version has only digits and dots
+# Sometimes the release name starts with a "v", so let's filter it out.
+# You may need more tweaks here if the upstream repository has different naming conventions. 
+if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then
+    version=${version:1}
+fi
+
+# Setting up the environment variables
+echo "Current version: $current_version"
+echo "Latest release from upstream: $version"
+echo "VERSION=$version" >> $GITHUB_ENV
+# For the time being, let's assume the script will fail
+echo "PROCEED=false" >> $GITHUB_ENV
+
+# Proceed only if the retrieved version is greater than the current one
+if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then
+    echo "::warning ::No new version available"
+    exit 0
+# Proceed only if a PR for this new version does not already exist
+elif git ls-remote -q --exit-code --heads https://github.com/$GITHUB_REPOSITORY.git ci-auto-update-v$version ; then
+    echo "::warning ::A branch already exists for this update"
+    exit 0
+fi
+
+# Each release can hold multiple assets (e.g. binaries for different architectures, source code, etc.)
+echo "${#assets[@]} available asset(s)"
+
+#=================================================
+# UPDATE SOURCE FILES
+#=================================================
+
+# Here we use the $assets variable to get the resources published in the upstream release.
+# Here is an example for Grav, it has to be adapted in accordance with how the upstream releases look like.
+
+# Let's loop over the array of assets URLs
+for asset_url in ${assets[@]}; do
+
+echo "Handling asset at $asset_url"
+
+# Assign the asset to a source file in conf/ directory
+# Here we base the source file name upon a unique keyword in the assets url (admin vs. update)
+# Leave $src empty to ignore the asset
+case $asset_url in
+  *"easyappointments-"*".zip"*)
+    src="app"
+    ;;
+esac
+
+# If $src is not empty, let's process the asset
+if [ ! -z "$src" ]; then
+
+# Create the temporary directory
+tempdir="$(mktemp -d)"
+
+# Download sources and calculate checksum
+filename=${asset_url##*/}
+curl --silent -4 -L $asset_url -o "$tempdir/$filename"
+checksum=$(sha256sum "$tempdir/$filename" | head -c 64)
+
+# Delete temporary directory
+rm -rf $tempdir
+
+# Get extension
+if [[ $filename == *.tar.gz ]]; then
+  extension=tar.gz
+else
+  extension=${filename##*.}
+fi
+
+# Rewrite source file
+cat <<EOT > conf/$src.src
+SOURCE_URL=$asset_url
+SOURCE_SUM=$checksum
+SOURCE_SUM_PRG=sha256sum
+SOURCE_FORMAT=zip
+SOURCE_IN_SUBDIR=false
+SOURCE_EXTRACT=true
+EOT
+echo "... conf/$src.src updated"
+
+else
+echo "... asset ignored"
+fi
+
+done
+
+#=================================================
+# SPECIFIC UPDATE STEPS
+#=================================================
+
+# Any action on the app's source code can be done.
+# The GitHub Action workflow takes care of committing all changes after this script ends.
+
+#=================================================
+# GENERIC FINALIZATION
+#=================================================
+
+# Replace new version in manifest
+echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json
+
+# No need to update the README, yunohost-bot takes care of it
+
+# The Action will proceed only if the PROCEED environment variable is set to true
+echo "PROCEED=true" >> $GITHUB_ENV
+exit 0
--- a/README.md
+++ b/README.md
@ -1,3 +1,8 @@
+<!--
+N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
+It shall NOT be edited by hand.
+-->
+
 # Easy!Appointments for YunoHost

 [![Integration level](https://dash.yunohost.org/integration/easyappointments.svg)](https://dash.yunohost.org/appci/app/easyappointments) ![](https://ci-apps.yunohost.org/ci/badges/easyappointments.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/easyappointments.maintain.svg)  
@ -5,45 +10,44 @@

 *[Lire ce readme en français.](./README_fr.md)*

-> *This package allow you to install Easy!Appointments quickly and simply on a YunoHost server.  
-If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
+> *This package allows you to install Easy!Appointments quickly and simply on a YunoHost server.
+If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*

 ## Overview

+Easy!Appointments is a highly customizable web application that allows customers to book appointments with you via a sophisticated web interface. Moreover, it provides the ability to sync your data with Google Calendar so you can use them with other services. It is an open source project that you can download and install even for commercial use. Easy!Appointments will run smoothly with your existing website as it can be installed in a single folder of the server and of course share an existing database.

-**Shipped version:** 1.4.2
+### Features
+The application is designed to be flexible enough so that it can handle any enterprise work flow.
+
+- Customers and appointments management.
+- Services and providers organization.
+- Working plan and booking rules.
+- Google Calendar synchronization.
+- Email notifications system.
+- Self hosted installation.
+- Translated user interface.
+
+
+**Shipped version:** 1.4.2~ynh2
+
+**Demo:** https://demo.easyappointments.org/

 ## Screenshots

-![]()
+![](./doc/screenshots/screenshots.png)

-## Demo
+## Documentation and resources

-* (https://demo.easyappointments.org/)
+* Official app website: https://easyappointments.org/
+* Official admin documentation: https://easyappointments.org/docs.html#1.4.1/readme.md
+* Upstream app code repository: https://github.com/alextselegidis/easyappointments
+* YunoHost documentation for this app: https://yunohost.org/app_easyappointments
+* Report a bug: https://github.com/YunoHost-Apps/easyappointments_ynh/issues

-## Configuration
+## Developer info

-## Documentation
-
- * Official documentation: https://easyappointments.org/docs.html#1.4.1/readme.md
- * YunoHost documentation: 
-
-## Limitations
-
-## Additionnal informations
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/easyappointments_ynh/issues
- * Easy!Appointments website: https://easyappointments.org/
- * Easy!Appointments repository: https://github.com/alextselegidis/easyappointments
- * YunoHost website: https://yunohost.org/
-
---
-
-## Developers infos
-
-Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/easyappointments_ynh/tree/testing).
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/easyappointments_ynh/tree/testing).

 To try the testing branch, please proceed like that.
 ```
@ -51,3 +55,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/easyappointments_ynh/
 or
 sudo yunohost app upgrade easyappointments -u https://github.com/YunoHost-Apps/easyappointments_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps
--- a/README_fr.md
+++ b/README_fr.md
@ -0,0 +1,55 @@
+# Easy!Appointments pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/easyappointments.svg)](https://dash.yunohost.org/appci/app/easyappointments) ![](https://ci-apps.yunohost.org/ci/badges/easyappointments.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/easyappointments.maintain.svg)  
+[![Installer Easy!Appointments avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=easyappointments)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer Easy!Appointments rapidement et simplement sur un serveur YunoHost.
+Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
+
+## Vue d'ensemble
+
+Easy!Appointments is a highly customizable web application that allows customers to book appointments with you via a sophisticated web interface. Moreover, it provides the ability to sync your data with Google Calendar so you can use them with other services. It is an open source project that you can download and install even for commercial use. Easy!Appointments will run smoothly with your existing website as it can be installed in a single folder of the server and of course share an existing database.
+
+### Features
+The application is designed to be flexible enough so that it can handle any enterprise work flow.
+
+- Customers and appointments management.
+- Services and providers organization.
+- Working plan and booking rules.
+- Google Calendar synchronization.
+- Email notifications system.
+- Self hosted installation.
+- Translated user interface.
+
+
+**Version incluse :** 1.4.2~ynh2
+
+**Démo :** https://demo.easyappointments.org/
+
+## Captures d'écran
+
+![](./doc/screenshots/screenshots.png)
+
+## Documentations et ressources
+
+* Site officiel de l'app : https://easyappointments.org/
+* Documentation officielle de l'admin : https://easyappointments.org/docs.html#1.4.1/readme.md
+* Dépôt de code officiel de l'app : https://github.com/alextselegidis/easyappointments
+* Documentation YunoHost pour cette app : https://yunohost.org/app_easyappointments
+* Signaler un bug : https://github.com/YunoHost-Apps/easyappointments_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/easyappointments_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/easyappointments_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade easyappointments -u https://github.com/YunoHost-Apps/easyappointments_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
--- a/conf/app.src
+++ b/conf/app.src
@ -3,5 +3,4 @@ SOURCE_SUM=94dba897669ba07f404daf98714fd9d9535d3f2c8d7dc4bbb00fcd3717616dd0
 SOURCE_SUM_PRG=sha256sum
 SOURCE_FORMAT=zip
 SOURCE_IN_SUBDIR=false
-SOURCE_FILENAME=
 SOURCE_EXTRACT=true
--- a/conf/nginx.conf
+++ b/conf/nginx.conf
@ -3,11 +3,6 @@ location / {
  # Path to source
  alias __FINALPATH__/;

-  # Force usage of https
-  if ($scheme = http) {
-    rewrite ^ https://$server_name$request_uri? permanent;
-  }
-
  index index.php index.html;

  #client_max_body_size 50M;
--- a/doc/.DS_Store
+++ b/doc/.DS_Store
--- a/doc/DESCRIPTION.md
+++ b/doc/DESCRIPTION.md
@ -0,0 +1,12 @@
+Easy!Appointments is a highly customizable web application that allows customers to book appointments with you via a sophisticated web interface. Moreover, it provides the ability to sync your data with Google Calendar so you can use them with other services. It is an open source project that you can download and install even for commercial use. Easy!Appointments will run smoothly with your existing website as it can be installed in a single folder of the server and of course share an existing database.
+
+### Features
+The application is designed to be flexible enough so that it can handle any enterprise work flow.
+
+- Customers and appointments management.
+- Services and providers organization.
+- Working plan and booking rules.
+- Google Calendar synchronization.
+- Email notifications system.
+- Self hosted installation.
+- Translated user interface.
--- a/doc/screenshots/screenshots.png
+++ b/doc/screenshots/screenshots.png
--- a/manifest.json
+++ b/manifest.json
@ -6,7 +6,7 @@
    "en": "Open Source Appointment Scheduler",
    "fr": "Planificateur de rendez-vous Open Source"
  },
-  "version": "1.4.2~ynh1",
+  "version": "1.4.2~ynh2",
  "url": "https://easyappointments.org/",
  "upstream": {
        "license": "GPL-3.0-only",
@ -17,11 +17,11 @@
  },
  "license": "GPL-3.0-only",
  "maintainer": {
-    "name": "",
+    "name": "eric_G",
    "email": ""
  },
  "requirements": {
-    "yunohost": ">= 4.2.4"
+    "yunohost": ">= 4.3.0"
  },
  "multi_instance": true,
  "services": [
@ -33,8 +33,7 @@
    "install" : [
    {
      "name": "domain",
-      "type": "domain",
-      "example": "domain.org"
+      "type": "domain"
    },
    {
      "name": "is_public",
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@ -6,4 +6,4 @@

 YNH_PHP_VERSION="7.3"

-extra_php_dependencies="php${YNH_PHP_VERSION}-curl"
+pkg_dependencies="php${YNH_PHP_VERSION}-curl"
--- a/scripts/install
+++ b/scripts/install
@ -24,6 +24,7 @@ domain=$YNH_APP_ARG_DOMAIN
 path_url="/"
 language=$YNH_APP_ARG_LANGUAGE
 is_public=$YNH_APP_ARG_IS_PUBLIC
+phpversion=$YNH_PHP_VERSION

 app=$YNH_APP_INSTANCE_NAME

@ -46,6 +47,14 @@ ynh_script_progression --message="Storing installation settings..." --weight=1
 ynh_app_setting_set --app=$app --key=domain --value=$domain
 ynh_app_setting_set --app=$app --key=path --value=$path_url
 ynh_app_setting_set --app=$app --key=language --value=$language
+ynh_app_setting_set --app=$app --key=phpversion --value=$phpversion
+
+#=================================================
+# INSTALL DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Installing dependencies..." --weight=1
+
+ynh_install_app_dependencies $pkg_dependencies

 #=================================================
 # STANDARD MODIFICATIONS
@ -95,8 +104,7 @@ ynh_add_nginx_config
 ynh_script_progression --message="Configuring PHP-FPM..." --weight=2

 # Create a dedicated PHP-FPM config
-ynh_add_fpm_config --package="$extra_php_dependencies"
-phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
+ynh_add_fpm_config

 #=================================================
 # SPECIFIC SETUP
--- a/scripts/remove
+++ b/scripts/remove
@ -37,6 +37,14 @@ ynh_script_progression --message="Removing the MySQL database..." --weight=4
 # Remove a database if it exists, along with the associated user
 ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name

+#=================================================
+# REMOVE DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Removing dependencies..." --weight=1
+
+# Remove metapackage and its dependencies
+ynh_remove_app_dependencies
+
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
--- a/scripts/restore
+++ b/scripts/restore
@ -36,8 +36,6 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 #=================================================
 ynh_script_progression --message="Validating restoration parameters..." --weight=2

-ynh_webpath_available --domain=$domain --path_url=$path_url \
-	|| ynh_die --message="Path not available: ${domain}${path_url}"
 test ! -d $final_path \
 	|| ynh_die --message="There is already a directory: $final_path "

@ -76,7 +74,13 @@ ynh_script_progression --message="Restoring the PHP-FPM configuration..." --weig

 ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"

-ynh_add_fpm_config --package="$extra_php_dependencies"
+#=================================================
+# REINSTALL DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Reinstalling dependencies..." --weight=1
+
+# Define and install dependencies
+ynh_install_app_dependencies $pkg_dependencies

 #=================================================
 # RESTORE THE MYSQL DATABASE
--- a/scripts/upgrade
+++ b/scripts/upgrade
@ -27,7 +27,6 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 #=================================================
 # CHECK VERSION
 #=================================================
-ynh_script_progression --message="Checking version..."

 upgrade_type=$(ynh_check_app_version_changed)

@ -96,13 +95,20 @@ ynh_script_progression --message="Upgrading NGINX web server configuration..." -
 # Create a dedicated NGINX config
 ynh_add_nginx_config

+#=================================================
+# UPGRADE DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Upgrading dependencies..." --weight=1
+
+ynh_install_app_dependencies $pkg_dependencies
+
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
 ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=2

 # Create a dedicated PHP-FPM config
-ynh_add_fpm_config --package="$extra_php_dependencies"
+ynh_add_fpm_config

 #=================================================
 # RELOAD NGINX