Schedule status parameter, DQUOTE parsing [Issue #43] (#48)

* Add #43 schedule status parameter, dquote parsing Closes #43 * Fix #43 invalid parameter type * Fix #43 incorrect variable name
iammatis · Sep 6, 2020 · 7ad33fa · 7ad33fa
1 parent c411c18
commit 7ad33fa
Show file tree

Hide file tree

Showing 13 changed files with 66 additions and 22 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 - Added citation for regex from Ruby iCalendar library
 - Added rfc link to readme
 - Updated dtStamp as optional, current UTC time used when not set
+- Added schedule status event parameter, dquote parsing
 
 ## [0.4.0] - 2020-05-07
 

diff --git a/src/formatter.ts b/src/formatter.ts
@@ -77,11 +77,12 @@ class Formatter implements IFormatter {
 
 	public formatOrganizer(organizer?: Organizer): string {
 		if (organizer) {
-			const { address, cn, dir, sentBy } = organizer
+			const { address, cn, dir, sentBy, scheduleStatus } = organizer
 			const optionals = [
 				cn ? `CN=${cn}` : '',
 				dir ? `DIR="${dir}"` : '',
-				sentBy ? `SENT-BY="mailto:${sentBy}"` : ''
+				sentBy ? `SENT-BY="mailto:${sentBy}"` : '',
+				scheduleStatus ? `SCHEDULE-STATUS="${(Array.isArray(scheduleStatus) ? scheduleStatus : [ scheduleStatus ]).join(',')}"` : ''
 			].filter(Boolean).join(';')
 
 			const line = optionals
@@ -126,7 +127,7 @@ class Formatter implements IFormatter {
 
 	public formatAttendee(attendee?: Attendee): string {
 		if (attendee) {
-			const { address, cn, dir, sentBy, cu, member, role, partstat, rsvp, delegatedTo, delegatedFrom } = attendee
+			const { address, cn, dir, sentBy, cu, member, role, partstat, rsvp, delegatedTo, delegatedFrom, scheduleStatus } = attendee
 			const optionals = [
 				cn ? `CN=${cn}` : '',
 				dir ? `DIR=${dir}` : '',
@@ -137,7 +138,8 @@ class Formatter implements IFormatter {
 				partstat ? `PARTSTAT=${partstat}` : '',
 				rsvp ? `RSVP=${rsvp}` : '',
 				delegatedTo ? `DELEGATED-TO=${delegatedTo.map(del => `"mailto:${del}"`).join(',')}` : '',
-				delegatedFrom ? `DELEGATED-FROM=${delegatedFrom.map(del => `"mailto:${del}"`).join(',')}` : ''
+				delegatedFrom ? `DELEGATED-FROM=${delegatedFrom.map(del => `"mailto:${del}"`).join(',')}` : '',
+				scheduleStatus ? `SCHEDULE-STATUS="${(Array.isArray(scheduleStatus) ? scheduleStatus : [ scheduleStatus ]).join(',')}"` : ''
 			].filter(Boolean).join(';')
 
 			const line = optionals

diff --git a/src/parser/properties/attendee.parser.ts b/src/parser/properties/attendee.parser.ts
@@ -14,6 +14,7 @@ const validParameters: Parameters = {
 	'RSVP': 'rsvp',
 	'DELEGATED-TO': 'delegatedTo',
 	'DELEGATED-FROM': 'delegatedFrom',
+	'SCHEDULE-STATUS': { name: 'scheduleStatus', lambda: (text: string): string | string[] => text.includes(',') ? text.split(',') : text }
 }
 
 class AttendeeParser extends BaseParser<Attendee> {

diff --git a/src/parser/properties/base.parser.ts b/src/parser/properties/base.parser.ts
@@ -1,5 +1,7 @@
 import IPropertyParser, { Parameters } from '../../types/classes/parsers/property.parser'
 
+const DQUOTES = /^"(?<value>.*)"$/
+
 class BaseParser<Property> implements IPropertyParser<Property> {
 	public parse(value: string, params = ''): Property {
 		throw new Error('Method not implemented.')
@@ -17,9 +19,17 @@ class BaseParser<Property> implements IPropertyParser<Property> {
 			const [ key, value ] = param.split(/=(.+)?/)
 
 			if (key in validParams) {
-				paramsParsed[validParams[key]] = value
+				const { groups = {} } = value.match(DQUOTES) || {};
+
+				const parameter = validParams[key];
+				if (typeof parameter === 'object') {
+					paramsParsed[parameter.name]  = parameter.lambda(groups.value || value)
+				} else {
+					paramsParsed[parameter] = groups.value || value
+				}
+
 			} else {
-				// Don't throw an error, just dicard the parameter
+				// Don't throw an error, just discard the parameter
 				console.log(`Discarding not recognized parameter '${key}'.`)
 			}
 		}

diff --git a/src/parser/properties/duration.parser.ts b/src/parser/properties/duration.parser.ts
@@ -40,18 +40,19 @@ class DurationParser extends BaseParser<Duration> {
 				throw new ParsingError(`Invalid iCalendar duration '${duration}'`)
 			}
 
-			const [ , value, dur ] = matchArr
-			if (!(dur in parameters)) {
-				throw new ParsingError(`Invalid iCalendar duration\'s parameter '${dur}'`)
+			const [ , value, attribute ] = matchArr
+			if (!(attribute in parameters)) {
+				throw new ParsingError(`Invalid iCalendar duration\'s parameter '${attribute}'`)
 			}
 
-			const type = parameters[dur]
+			const parameter = parameters[attribute]
 			const amount = Number(value)
 			if (isNaN(amount)) {
 				throw new ParsingError(`Invalid iCalendar duration '${duration}'`)
 			}
 
-			result[type] = amount
+			const key = typeof parameter === 'object' ? parameter.name : parameter
+			result[key] = amount
 		}
 
 		return result

diff --git a/src/parser/properties/organizer.parser.ts b/src/parser/properties/organizer.parser.ts
@@ -6,7 +6,8 @@ import BaseParser from './base.parser'
 const validParameters: Parameters = {
 	'CN': 'cn',
 	'DIR': 'dir',
-	'SENT-BY': 'sentBy'
+	'SENT-BY': 'sentBy',
+	'SCHEDULE-STATUS': { name: 'scheduleStatus', lambda: (text: string): string | string[] => text.includes(',') ? text.split(',') : text }
 }
 
 class OrganizerParser extends BaseParser<Organizer> {

diff --git a/src/types/classes/parsers/property.parser.ts b/src/types/classes/parsers/property.parser.ts
@@ -1,5 +1,5 @@
 export type Parameters<T = string> = {
-    [key: string]: T
+    [key: string]: T | {name: T, lambda: Function}
 }
 
 interface IPropertyParser<Property> {

diff --git a/src/types/general.ts b/src/types/general.ts
@@ -74,6 +74,7 @@ export type Person = {
     cn?: string
     dir?: string
     sentBy?: string
+    scheduleStatus?: string | string[]
 }
 
 export type CUType = 'INDIVIDUAL' | 'GROUP' | 'RESOURCE' | 'ROOM' | 'UNKNOWN'

diff --git a/tests/builder.test.ts b/tests/builder.test.ts
@@ -48,14 +48,16 @@ describe('Test Builder Class', () => {
 							{
 								cn: 'Henry Cabot',
 								address: 'hcabot@example.com',
-								role: 'REQ-PARTICIPANT'
+								role: 'REQ-PARTICIPANT',
+								scheduleStatus: '2.0'
 							},
 							{
 								address: 'ildoit@example.com',
 								role: 'REQ-PARTICIPANT',
 								delegatedFrom: [ 'bob@example.com' ],
 								partstat: 'ACCEPTED',
-								cn: 'Jane Doe'
+								cn: 'Jane Doe',
+								scheduleStatus: [ '2.0', '2.4' ]
 							}
 						],
 						xProps: [

diff --git a/tests/fixtures/events/multiple_attendees.ics b/tests/fixtures/events/multiple_attendees.ics
@@ -4,9 +4,11 @@ PRODID:-//xyz Corp//NONSGML PDA Calendar Version 1.0//EN
 BEGIN:VEVENT
 DTSTAMP:20101231T083000Z
 UID:uid1@example.com
-ATTENDEE;CN=Henry Cabot;ROLE=REQ-PARTICIPANT:mailto:hcabot@example.com
+ATTENDEE;CN=Henry Cabot;ROLE=REQ-PARTICIPANT;SCHEDULE-STATUS="2.0":mailto:h
+ cabot@example.com
 ATTENDEE;CN=Jane Doe;ROLE=REQ-PARTICIPANT;PARTSTAT=ACCEPTED;DELEGATED-FROM=
- "mailto:bob@example.com":mailto:ildoit@example.com
+ "mailto:bob@example.com";SCHEDULE-STATUS="2.0,2.4":mailto:ildoit@example.co
+ m
 X-TESTNAME:random xprop value
 END:VEVENT
 END:VCALENDAR
diff --git a/tests/parser/attendee.parser.test.ts b/tests/parser/attendee.parser.test.ts
@@ -40,6 +40,27 @@ describe('Test Attendee Parser', () => {
 			address: 'hcabot@example.com'
 		})
 	})
+
+	it('Test simple attendee with schedule status', () => {
+		const attendee = parser.parse('mailto:hcabot@example.com', 'CN=Henry Cabot;ROLE=REQ-PARTICIPANT;SCHEDULE-STATUS="2.0"')
+
+		expect(attendee).toEqual({
+			cn: 'Henry Cabot',
+			role: 'REQ-PARTICIPANT',
+			address: 'hcabot@example.com',
+			scheduleStatus: '2.0'
+		})
+	})
+
+	it('Test simple attendee with array of schedule statuses', () => {
+		const attendee = parser.parse('mailto:hcabot@example.com', 'CN=Henry Cabot;ROLE=REQ-PARTICIPANT;SCHEDULE-STATUS="2.0,2.4"')
+		expect(attendee).toEqual({
+			cn: 'Henry Cabot',
+			role: 'REQ-PARTICIPANT',
+			address: 'hcabot@example.com',
+			scheduleStatus: [ '2.0', '2.4' ]
+		})
+	})
 
 	it('Test simple attendee with multiple mails', () => {
 		const attendee = parser.parse('mailto:ildoit@example.com', 'CN=Jane Doe;ROLE=REQ-PARTICIPANT;PARTSTAT=ACCEPTED;DELEGATED-FROM="mailto:bob@example.com"')
@@ -48,7 +69,7 @@ describe('Test Attendee Parser', () => {
 			cn: 'Jane Doe',
 			role: 'REQ-PARTICIPANT',
 			partstat: 'ACCEPTED',
-			delegatedFrom: '"mailto:bob@example.com"',
+			delegatedFrom: 'mailto:bob@example.com',
 			address: 'ildoit@example.com'
 		})
 	})

diff --git a/tests/parser/organizer.parser.test.ts b/tests/parser/organizer.parser.test.ts
@@ -36,7 +36,7 @@ describe('Test Organizer Parser', () => {
 
 		expect(organizer).toEqual({
 			cn: 'Jane Doe',
-			dir: '"ldap://example.com:6666/o=DC%20Associates,c=US???(cn=John%20Smith)"',
+			dir: 'ldap://example.com:6666/o=DC%20Associates,c=US???(cn=John%20Smith)',
 			address: 'ildoit@example.com'
 		})
 	})

diff --git a/tests/parser/parser.test.ts b/tests/parser/parser.test.ts
@@ -34,14 +34,16 @@ describe('Test Parser', () => {
 						{
 							cn: 'Henry Cabot',
 							role: 'REQ-PARTICIPANT',
-							address: 'hcabot@example.com'
+							address: 'hcabot@example.com',
+							scheduleStatus: '2.0'
 						},
 						{
 							cn: 'Jane Doe',
 							role: 'REQ-PARTICIPANT',
 							partstat: 'ACCEPTED',
-							delegatedFrom: '"mailto:bob@example.com"',
-							address: 'ildoit@example.com'
+							delegatedFrom: 'mailto:bob@example.com',
+							address: 'ildoit@example.com',
+							scheduleStatus: [ '2.0', '2.4' ]
 						}
 					],
 					xProps: [