Merge pull request #4 from rkdarst/ics-0.8.0

Port yaml2ics to ics 0.8.0

Author: stefanv

example/another_calendar.yaml

@@ -1,6 +1,6 @@
 events:
-  - name: Another Event
-    begin: 2021-09-21 10:00-07:00
-    end: 2021-09-21 12:00-07:00
+  - summary: Another Event
+    begin: 2021-09-21 10:00:00 -07:00
+    end: 2021-09-21 12:00:00 -07:00
     description: |
       A two hour long event.

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,3 +1,3 @@
-ics
+https://github.com/ics-py/ics-py/archive/refs/heads/main.zip
 python-dateutil
 pyyaml

tests/test_calendar.py

@@ -1,7 +1,30 @@
-from yaml2ics import events_to_calendar_ics
+import io
+import textwrap
+
+from util import parse_yaml
+
+from yaml2ics import events_to_calendar, files_to_calendar
 
 
 def test_calendar_structure():
-    cal = events_to_calendar_ics(['event0', 'event1'])
-    assert cal.startswith('BEGIN:VCALENDAR')
-    assert cal.endswith('END:VCALENDAR')
+    cal = events_to_calendar([])
+    cal_str = cal.serialize()
+    assert cal_str.startswith('BEGIN:VCALENDAR')
+    assert cal_str.endswith('END:VCALENDAR')
+
+def test_calendar_event():
+    cal = files_to_calendar(
+        [io.StringIO(textwrap.dedent(
+            '''
+            events:
+              - summary: Earth Day
+                begin: 2021-04-22
+                url: https://earthday.org
+                location: Earth
+            '''
+        ))]
+    )
+    cal_str = cal.serialize()
+    assert cal_str.startswith('BEGIN:VCALENDAR')
+    assert 'SUMMARY:Earth Day' in cal_str
+    assert cal_str.endswith('END:VCALENDAR')

tests/test_events.py

@@ -1,49 +1,55 @@
 from util import parse_yaml
 
-from yaml2ics import event_ics_from_yaml
+from yaml2ics import event_from_yaml
 
 
 def test_basic_structure():
-    event = event_ics_from_yaml(
+    event = event_from_yaml(
         parse_yaml(
             '''
-            name: Earth Day
+            summary: Earth Day
             begin: 2021-04-22
             url: https://earthday.org
+            location: Earth
             '''
         )
     )
 
     # 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')
-
+    assert 'SUMMARY:Earth Day' in event_str
+    assert 'URL:https://earthday.org' in event_str
+    assert 'LOCATION:Earth' in event_str
     # All events must have a DTSTAMP
-    assert 'DTSTAMP' in event
+    assert 'DTSTAMP' in event_str
 
 
 def test_all_day_event():
-    event = event_ics_from_yaml(
+    event = event_from_yaml(
         parse_yaml(
             '''
-            name: Earth Day
+            summary: Earth Day
             begin: 2021-04-22
             url: https://earthday.org
             '''
         )
     )
-    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():
-    event = event_ics_from_yaml(
+    event = event_from_yaml(
         parse_yaml(
             '''
-            name: Earth Day
+            summary: Earth Day
             begin: 2021-04-22
             url: https://earthday.org
             repeat:
@@ -53,40 +59,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(
+    event = event_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
+            summary: Event of the Century
+            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(
+    event = event_from_yaml(
         parse_yaml(
             '''
-            name: Event of the Century
-            begin: 2021-09-21 15:00-07:00
+            summary: Event of the Century
+            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,7 +19,7 @@
 }
 
 
-def event_ics_from_yaml(event_yaml: dict) -> str:
+def event_from_yaml(event_yaml: dict) -> ics.Event:
     d = event_yaml
     repeat = d.pop('repeat', None)
 
@@ -68,32 +68,30 @@ 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)
+    event.dtstamp = datetime.utcnow().replace(tzinfo=dateutil.tz.UTC)
+    return event
 
-            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)
-
-
-def events_to_calendar_ics(events: dict) -> str:
+def events_to_calendar(events: list) -> str:
     cal = ics.Calendar()
     for event in events:
-        cal.events.add(event)
-    return str(cal)
+        cal.events.append(event)
+    return cal
+
+def files_to_calendar(files: list) -> ics.Calendar:
+    """'main' function: list of files to our result"""
+    all_events = [ ]
+    for f in files:
+        if hasattr(f, 'read'):
+            calendar_yaml = yaml.load(f.read(), Loader=yaml.FullLoader)
+        else:
+            calendar_yaml = yaml.load(open(f, 'r'), Loader=yaml.FullLoader)
+        for event in calendar_yaml['events']:
+            all_events.append(event_from_yaml(event))
+    calendar = events_to_calendar(all_events)
+    return calendar
 
 
 if __name__ == '__main__':
@@ -107,10 +105,6 @@ def events_to_calendar_ics(events: dict) -> str:
             print(f'Error: {f} is not a file')
             sys.exit(-1)
 
-    all_events = []
-    for f in files:
-        calendar_yaml = yaml.load(open(f, 'r'), Loader=yaml.FullLoader)
-        for event in calendar_yaml['events']:
-            all_events.append(event_ics_from_yaml(event))
+    calendar = files_to_calendar(files)
 
-    print(events_to_calendar_ics(all_events))
+    print(calendar.serialize())