Port yaml2ics to ics 0.8.0

- Various changes throughout, see #3

Author: rkdarst

example/test_calendar.yaml

@@ -1,18 +1,18 @@
 events:
-  - name: Event of the Century
-    begin: 2021-09-21 15:00-07:00
-    end: 2021-09-21 15:30:00-07:00
+  - summary: Event of the Century
+    begin: 2021-09-21 15:00:00
+    end: 2021-09-21 15:30:00
     description: |
       Meet the team on the northern side of the field.
 
-  - name: Half-an-hour meeting
-    begin: 2021-09-23 15:00-07:00
+  - summary: Half-an-hour meeting
+    begin: 2021-09-23 15:00:00
     duration:
       minutes: 30
     location: |
       Office 224, Monolith Bldg, Office Block C
 
-  - name: Earth Day
+  - summary: Earth Day
     begin: 2021-04-22
     url: https://earthday.org
     repeat:

requirements.txt

@@ -1,2 +1,2 @@
-ics
+https://github.com/ics-py/ics-py/archive/refs/heads/main.zip
 python-dateutil

tests/test_calendar.py

@@ -2,6 +2,6 @@
 
 
 def test_calendar_structure():
-    cal = events_to_calendar_ics(['event0', 'event1'])
+    cal = events_to_calendar_ics([])
     assert cal.startswith('BEGIN:VCALENDAR')
     assert cal.endswith('END:VCALENDAR')

tests/test_events.py

@@ -15,12 +15,13 @@ def test_basic_structure():
     )
 
     # All lines must be separated by CRLF
-    lines = event.split('\n')
+    event_str = event.serialize()
+    lines = event_str.split('\n')
     for line in lines[:-1]:
         assert line.endswith('\r')
 
     # All events must have a DTSTAMP
-    assert 'DTSTAMP' in event
+    assert 'DTSTAMP' in event_str
 
 
 def test_all_day_event():
@@ -33,10 +34,12 @@ def test_all_day_event():
             '''
         )
     )
-    assert event.startswith('BEGIN:VEVENT')
-    assert event.endswith('END:VEVENT')
-    assert 'DTSTART;VALUE=DATE:20210422' in event
-    assert 'DTEND' not in event
+    event_str = event.serialize()
+    assert event_str.startswith('BEGIN:VEVENT')
+    assert event_str.endswith('END:VEVENT')
+    assert 'DTSTART;VALUE=DATE:20210422' in event_str
+    # ics 0.8.0 does have DTEND that is the next day.
+    #assert 'DTEND' not in event_str
 
 
 def test_rrule():
@@ -53,40 +56,43 @@ def test_rrule():
             '''
         )
     )
-    assert 'DTEND' not in event
-    assert 'RRULE:FREQ=YEARLY;UNTIL=20300422T000000Z' in event
+    event_str = event.serialize()
+    assert 'DTEND' not in event_str
+    assert 'RRULE:FREQ=YEARLY;UNTIL=20300422T000000' in event_str
 
 
 def test_event_with_time_range():
     event = event_ics_from_yaml(
         parse_yaml(
             '''
             name: Event of the Century
-            begin: 2021-09-21 15:00-07:00
-            end: 2021-09-21 15:30:00-07:00
+            begin: 2021-09-21 15:00:00 -07:00
+            end: 2021-09-21 15:30:00 -07:00
             description: |
               Meet the team on the northern side of the field.
             '''
         )
     )
-    assert 'DTSTART' in event
-    assert 'DTEND' in event
+    event_str = event.serialize()
+    assert 'DTSTART' in event_str
+    assert 'DTEND' in event_str
 
 
 def test_event_with_duration():
     event = event_ics_from_yaml(
         parse_yaml(
             '''
             name: Event of the Century
-            begin: 2021-09-21 15:00-07:00
+            begin: 2021-09-21 15:00:00 -07:00
             duration:
               minutes: 30
             description: |
               Meet the team on the northern side of the field.
             '''
         )
     )
+    event_str = event.serialize()
+    assert 'DURATION:PT30M' in event_str
+    assert 'DTEND' not in event_str
+    assert 'DTSTART' in event_str
 
-    assert 'DURATION:PT30M' in event
-    assert 'DTEND' not in event
-    assert 'DTSTART' in event

yaml2ics.py

@@ -19,9 +19,11 @@
 }
 
 
-def event_ics_from_yaml(event_yaml: dict) -> str:
+def event_ics_from_yaml(event_yaml: dict) -> ics.Event:
     d = event_yaml
     repeat = d.pop('repeat', None)
+    if 'name' in d:
+        d['summary'] = d.pop('name')
 
     # Strip all string values, since they often end on `\n`
     for key in d:
@@ -68,32 +70,17 @@ def event_ics_from_yaml(event_yaml: dict) -> str:
         rrule_dtstart = rrule_dtstart + 'Z'
         rrule_rrule = [line for line in rrule_lines if line.startswith('RRULE')][0]
 
-        event_lines = str(event).split('\r\n')
+        event.extra.append(ics.ContentLine(rrule_rrule))
 
-        # Splice in the rrule
-        out = []
-        for line in event_lines:
-            out.append(line)
-
-            if line.startswith('DTSTART'):
-                out.append(rrule_rrule + 'Z')
-    else:
-        out = str(event).split('\r\n')
-
-    now_utc = datetime.utcnow()
-    utc_stamp = now_utc.isoformat(
-        timespec='seconds'
-    ).replace('-', '').replace(':', '') + 'Z'
-    out.insert(-1, f'DTSTAMP:{utc_stamp}')
-
-    return '\r\n'.join(out)
+    event.dtstamp = datetime.utcnow().replace(tzinfo=dateutil.tz.UTC)
+    return event
 
 
 def events_to_calendar_ics(events: dict) -> str:
     cal = ics.Calendar()
     for event in events:
-        cal.events.add(event)
-    return str(cal)
+        cal.events.append(event)
+    return cal.serialize()
 
 
 if __name__ == '__main__':