Merge pull request #11 from bb-Ricardo/development

add support for icalendar subscription of runs

Author: bb-Ricardo

README.md

@@ -18,6 +18,8 @@ You need to have a running Wordpress site with 'WP Event Manager' Plugin install
 * phpserialize
 * mysql-connector
 * psutil
+* icalendar
+* beautifulsoup4
 
 ### WP Event Manager Plugin
 * WP Event Manager >= 3.1.21
@@ -123,6 +125,17 @@ to your server block configuration. Make sure to adjust your IP and port accordi
                 #proxy_set_header   X-Forwarded-For   $proxy_add_x_forwarded_for;
                 #proxy_set_header   X-Forwarded-Proto $scheme;
         }
+        # expose icalender evets
+        location /events.ics {
+                proxy_pass http://127.0.0.1:8000/runs/calendar;
+                proxy_set_header   Host              $host;
+                proxy_set_header   X-Real-IP         $remote_addr;
+                # activate to see the actual remote IP and not just your reverse proxy
+                # attention: in Europe this has implications on your GDPR statements on your page
+                #            as you log IP addresses.
+                #proxy_set_header   X-Forwarded-For   $proxy_add_x_forwarded_for;
+                #proxy_set_header   X-Forwarded-Proto $scheme;
+        }
 ```
 
 ## Setup

api/factory/runs.py

@@ -73,6 +73,11 @@ def compare_attributes(value_a, value_b):
 
     matches = list()
     for key, value in params.dict().items():
+
+        # skip unsupported keys like: __pydantic_initialised__
+        if key.startswith("__"):
+            continue
+
         if value is None or key in ["id", "limit"]:
             continue
 

api/routers/runs.py

@@ -10,11 +10,20 @@
 from typing import List
 
 from fastapi import APIRouter, HTTPException, Depends
+from fastapi.responses import Response
+from datetime import datetime, timedelta
+from icalendar import Calendar, Event, vText, Alarm
+from pytz import utc
+from bs4 import BeautifulSoup
+import re
 
 from api.security import api_key_valid
 from api.models.run import Hash, HashParams
 from api.models.exceptions import APITokenValidationFailed
 from api.factory.runs import get_hash_runs
+from config.api import BasicAPISettings
+from common.misc import format_slug
+import config
 
 router_runs = APIRouter(
     prefix="/runs",
@@ -38,6 +47,122 @@ async def get_runs(params: HashParams = Depends(HashParams), key_valid: bool = D
     return result
 
 
+@router_runs.get("/calendar", summary="List of runs as iCal events", description="Returns Hash runs as iCal events",
+                 # Set what the media type will be in the autogenerated OpenAPI specification.
+                 # fastapi.tiangolo.com/advanced/additional-responses/#additional-media-types-for-the-main-response
+                 responses={
+                    200: {
+                        "content": {"text/calendar": {
+                            "example": "\n".join(
+                                    ["BEGIN:VCALENDAR",
+                                     "VERSION:2.0",
+                                      f"PRODID:-//wordpress-hash-event-api/{BasicAPISettings().version}//",
+                                      "CALSCALE:GREGORIAN",
+                                      "METHOD:PUBLISH",
+                                      f"X-WR-CALNAME:{config.calendar_settings.name}",
+                                      "X-WR-TIMEZONE:Europe/Berlin",
+                                      "BEGIN:VEVENT",
+                                      "SUMMARY:Nerd H3 Run #1234",
+                                      "DTSTART;TZID=Europe/Berlin:20231105T144500",
+                                      "DTEND;TZID=Europe/Berlin:20231105T164500",
+                                      "UID:wordpress-hash-event-api-event/676",
+                                      "DESCRIPTION:More details to follow soon!\\n\\nHash Cash: 4€\\nLocation URL:",
+                                      "  https://www.openstreetmap.org/?mlat=52.4811867&mlon=13.525649#map=17/52.4",
+                                      " 811867/13.525649",
+                                      "LAST-MODIFIED:20231026T085048Z",
+                                      "LOCATION:Karlshorst\, 10318 Berlin\, Germany",
+                                      "NAME:Nerd H3 Run #1234",
+                                      "END:VEVENT",
+                                      "ENV:VCALENDAR"
+                                     ])
+                            },
+                        },
+                        "description": "OK - Returns a list of calender events in icalendar format"
+                    }
+                 },
+                 # Prevent FastAPI from adding "application/json" as an additional
+                 # response media type in the autogenerated OpenAPI specification.
+                 # https://github.com/tiangolo/fastapi/issues/3258
+                 response_class=Response
+                 )
+async def get_runs_as_icalendar(params: HashParams = Depends(HashParams), key_valid: bool = Depends(api_key_valid)):
+
+    if key_valid is False:
+        raise APITokenValidationFailed
+
+    main_config = BasicAPISettings()
+
+    if params.start_date__gt is None:
+        params.start_date__gt = datetime.now(tz=utc) - timedelta(weeks=config.calendar_settings.num_past_weeks_exposed)
+
+    params.last_update__gt = datetime.now() - timedelta(weeks=config.calendar_settings.num_past_weeks_exposed)
+
+    # init the calendar
+    cal = Calendar()
+
+    # Some properties are required to be compliant
+    cal.add('prodid', f'-//wordpress-hash-event-api/{main_config.version}//')
+    cal.add('version', '2.0')
+    cal.add('X-WR-CALNAME', config.calendar_settings.name)
+    cal.add('X-WR-TIMEZONE', config.app_settings.timezone_string)
+    cal.add('CALSCALE', 'GREGORIAN')
+    cal.add('METHOD', 'PUBLISH')
+
+    for run in get_hash_runs(params) or list():
+
+        # hide runs which are deleted or meant to not show up
+        if run.deleted or run.event_hidden:
+            continue
+
+        if run.end_date is None:
+            run.end_date = run.start_date + timedelta(hours=2)
+
+        event_description = ""
+        # parse html data back to strings
+        if run.event_description is not None:
+            event_description = BeautifulSoup(run.event_description.replace("<br>", "\n"),
+                                              features="html.parser").get_text()
+
+        # reduce too many new lines
+        event_description = re.sub(r'\n(\n)+', '\n\n', event_description).strip()
+
+        # add has cash and location line
+        event_description += f'\n\nHash Cash: {run.hash_cash_members}{run.event_currency}\n'
+        event_description += f'Location URL: {run.geo_map_url}'
+
+        event = Event()
+        event.add('uid', f"wordpress-hash-event-api-event/{run.id}")
+        event.add('name', run.event_name)
+        event.add('summary', run.event_name)
+        event.add('description', event_description)
+        event.add('dtstart', run.start_date)
+        event.add('dtend', run.end_date)
+        event.add('last-modified', run.last_update)
+        event.add('location', vText(run.geo_location_name))
+        event.add('url', run.event_url, {"VALUE": "URI"})
+
+        if run.geo_lat and run.geo_long:
+            event.add('X-APPLE-STRUCTURED-LOCATION', f'geo:{run.geo_lat},{run.geo_long}',
+                      {"X-TITLE": vText(run.geo_location_name)})
+
+        if config.calendar_settings.enable_event_alarm:
+            alarm = Alarm()
+            alarm.add("trigger", timedelta(hours=-1))
+            alarm.add("uid", f"wordpress-hash-event-api-event-alarm/{run.id}")
+            alarm.add("description", run.event_name)
+            alarm.add("action", "AUDIO")
+            alarm.add("ATTACH", "Chord", {"VALUE": "URI"})
+
+            event.add_component(alarm)
+
+        cal.add_component(event)
+
+    return Response(content=cal.to_ical(),
+                    media_type="text/calendar",
+                    headers={"content-disposition":
+                             f"attachment; filename={format_slug(config.calendar_settings.name)}.ics"})
+
+
 # noinspection PyShadowingBuiltins
 @router_runs.get("/{id}", response_model=Hash, summary="Returns a single Hash run")
 async def get_run(id: int, key_valid: bool = Depends(api_key_valid)):

config-example.ini

@@ -129,7 +129,23 @@ hash_kennels = Nerd H3, Nerd Full Moon H3
 # the id or ids of the list to send this campaign to
 #list_ids =
 
-[database]
+
+###
+### [calendar]
+###
+### settings for exposing runs as icalendar events
+###
+
+[calendar]
+
+# define a default name for the calendar
+#name = Nerd H3 events
+
+# Adds an alarm of one hour before the event to each event
+#enable_event_alarm = true
+
+# Define the number weeks of past events to add to calendar data
+#num_past_weeks_exposed = 2
 
 
 ###

config/__init__.py

@@ -13,12 +13,14 @@
 from pydantic import ValidationError
 
 from config.models.app import AppSettings
+from config.models.calendar import CalendarConfigSettings
 from common.log import get_logger
 
 logger = get_logger()
 
 
 app_settings = AppSettings(hash_kennels="EMPTY")
+calendar_settings = CalendarConfigSettings()
 
 
 def validate_config_object(config_class, settings):

config/api.py

@@ -11,11 +11,11 @@
 
 
 class BasicAPISettings(BaseModel):
-    description = 'Hash Run API for WordPress Event Manager'
-    title = 'Kennel Runs API'
-    openapi_url = "/openapi.json"
-    root_path = "/api/v1"
-    version = '1.0.1'
-    debug = False
+    description: str = 'Hash Run API for WordPress Event Manager'
+    title: str = 'Kennel Runs API'
+    openapi_url: str = "/openapi.json"
+    root_path: str = "/api/v1"
+    version: str = '1.0.1'
+    debug: bool = False
 
 # EOF

config/models/api.py

@@ -8,10 +8,11 @@
 #  repository or visit: <https://opensource.org/licenses/MIT>.
 
 from config.models import EnvOverridesBaseSettings
+from typing import Union
 
 
 class APIConfigSettings(EnvOverridesBaseSettings):
-    token: str = None
+    token: Union[str, None] = None
     root_path: str = "/api/v1"
 
     class Config:

config/models/app.py

@@ -23,12 +23,12 @@
 # noinspection PyMethodParameters
 class AppSettings(EnvOverridesBaseSettings):
     hash_kennels: Union[str, List]
-    default_hash_cash: int = None
-    default_hash_cash_non_members: int = None
+    default_hash_cash: Union[int, None] = None
+    default_hash_cash_non_members: Union[int, None] = None
     default_run_type: str = "Regular Run"
-    default_currency: str = None
-    default_facebook_group_id: int = None
-    timezone_string: str = None
+    default_currency: Union[str, None] = None
+    default_facebook_group_id: Union[int, None] = None
+    timezone_string: Union[str, None] = None
     maps_url_template: AnyHttpUrl = maps_url_template
 
     # currently not implemented in WP Event manager
@@ -65,7 +65,7 @@ def split_hash_kennels(cls, value):
     def check_maps_url_formatting(cls, value):
 
         try:
-            value.format(lat=123, long=456)
+            str(value).format(lat=123, long=456)
         except KeyError as e:
             log.error(f"Unable to parse 'maps_url_template' formatting, KeyError: {e}. Using default value.")
             return maps_url_template

config/models/calendar.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+#  Copyright (c) 2022 Ricardo Bartels. All rights reserved.
+#
+#  wordpress-hash-event-api
+#
+#  This work is licensed under the terms of the MIT license.
+#  For a copy, see file LICENSE.txt included in this
+#  repository or visit: <https://opensource.org/licenses/MIT>.
+
+from config.models import EnvOverridesBaseSettings
+
+
+class CalendarConfigSettings(EnvOverridesBaseSettings):
+    name: str = "Hash events"
+    enable_event_alarm: bool = False
+    num_past_weeks_exposed: int = 2
+
+    class Config:
+        env_prefix = f"{__name__.split('.')[-1]}_"

listmonk/handler.py

@@ -8,7 +8,8 @@
 #  repository or visit: <https://opensource.org/licenses/MIT>.
 
 import json
-import requests
+from requests import session, Request
+from requests.exceptions import ConnectionError, ReadTimeout, JSONDecodeError as RequestsJSONDecodeError
 from typing import Union
 
 from config.api import BasicAPISettings
@@ -46,7 +47,7 @@ def init_session(self):
             "Content-Type": "application/json"
         }
 
-        self.session = requests.session()
+        self.session = session()
         self.session.auth = (self.config.username, self.config.password)
         self.session.headers.update(header)
 
@@ -124,21 +125,21 @@ def request(self, endpoint, req_type="GET", data=None, params=None):
 
         # prepare request
         this_request = self.session.prepare_request(
-                            requests.Request(req_type, request_url, params=params, json=data)
+                            Request(req_type, request_url, params=params, json=data)
                        )
 
         # issue request
         try:
             response = self.session.send(this_request, timeout=5)
-        except (ConnectionError, requests.exceptions.ConnectionError, requests.exceptions.ReadTimeout) as e:
+        except (ConnectionError, ReadTimeout) as e:
             log.error(f"Request failed, trying again: {e}")
             return
 
         log.debug("Received HTTP Status %s.", response.status_code)
 
         try:
             result = response.json()
-        except (json.decoder.JSONDecodeError, requests.exceptions.JSONDecodeError) as e:
+        except (json.decoder.JSONDecodeError, RequestsJSONDecodeError) as e:
             pass
 
         # token issues