initial API

Author: pierrevalade

.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+node_modules/

Makefile

@@ -0,0 +1,7 @@
+test:
+	NODE_ENV=test ./node_modules/.bin/mocha --check-leaks \
+		-w  \
+		--reporter landing \
+		test/*
+
+.PHONY: test

README.md

@@ -0,0 +1,78 @@
+VObject
+=====
+
+VObject allows you to easily manipulate iCalendar objects using JavaScript. Implements [rfc5545](http://tools.ietf.org/html/rfc5545).
+
+Installation
+---
+
+Example
+---
+
+### Create a Calendar
+
+> The top-level element in iCalendar is the Calendaring and Scheduling Core Object, a collection of calendar and scheduling information. Typically, this information will consist of a single iCalendar object.
+
+
+```js
+var calendar = VObject.calendar();
+```
+
+> The body of the iCalendar object (the icalbody) is made up of a list of calendar properties and one or more calendar components.
+
+### Create a Event
+
+```js
+var event = VObject.event();
+event.setSummary('Hello World!');
+```
+
+Then, add the event to that calendar (events need to be added to a calendar to be a proper iCal object):
+
+```js
+calendar.addComponent(event);
+```
+
+Then, to ICS:
+
+```js
+calendar.stringify();
+```
+
+API
+---
+
+### VObject.calendar
+
+#### getMethod
+#### setMethod
+#### stringify
+
+### VObject.event
+
+#### setUID (required)
+#### getUID
+#### setSummary
+#### getSummary
+#### setDescription
+#### setDescription
+#### setLocation
+#### setLocation
+#### setStatus
+#### getStatus
+#### setDTStamp
+#### getDTStamp
+#### setSequence
+#### getSequence (Default 0)
+#### setCreated
+#### getCreated
+
+### VObject.attendee
+
+
+
+### VObject.component
+#### addProperty
+#### setProperty
+#### getProperty
+#### getPropertyValue

index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/vobject');

lib/attendee.js

@@ -0,0 +1,60 @@
+var Property = require('./property');
+
+// http://tools.ietf.org/html/rfc5545#section-3.8.4.1
+// This property defines an "Attendee" within a calendar component.
+
+module.exports = function() {
+  var attendee = Property('ATTENDEE');
+
+  // CUType
+  // http://tools.ietf.org/html/rfc5545#section-3.2.3
+  attendee.setCUType = function(value) {
+    attendee.setParameter('CUTYPE', value);
+  };
+
+  attendee.getCUType = function() {
+    return attendee.getParameter('CUTYPE');
+  };
+
+  // Role
+  // http://tools.ietf.org/html/rfc5545#section-3.2.16
+  attendee.setRole = function(value) {
+    attendee.setParameter('ROLE', value);
+  };
+
+  attendee.getRole = function() {
+    return attendee.getParameter('ROLE');
+  };
+
+  // PartStat
+  // http://tools.ietf.org/html/rfc5545#section-3.2.12
+  attendee.setPartStat = function(value) {
+    attendee.setParameter('PARTSTAT', value);
+  };
+
+  attendee.getPartStat = function() {
+    return attendee.getParameter('PARTSTAT');
+  };
+
+  // RSVP Expectation
+  // http://tools.ietf.org/html/rfc5545#section-3.2.17
+  attendee.setRSVP = function(value) {
+    attendee.setParameter('RSVP', value);
+  };
+
+  attendee.getRSVP = function() {
+    return attendee.getParameter('RSVP');
+  };
+
+  // CN
+  // http://tools.ietf.org/html/rfc5545#section-3.2.2
+  attendee.setCN = function(value) {
+    attendee.setParameter('CN', value);
+  };
+
+  attendee.getCN = function() {
+    return attendee.getParameter('CN');
+  };
+
+  return attendee;
+};

lib/calendar.js

@@ -0,0 +1,32 @@
+var Component = require('./component');
+
+module.exports = function() {
+  var calendar = Component('VCALENDAR');
+
+  // Calendar Properties
+  // http://tools.ietf.org/html/rfc5545#section-3.7
+
+  // Version
+  // http://tools.ietf.org/html/rfc5545#section-3.7.4
+  calendar.addProperty('VERSION', '2');
+
+  // Calendar Scale
+  // http://tools.ietf.org/html/rfc5545#section-3.7.1
+  calendar.addProperty('CALSCALE', 'GREGORIAN');
+
+  // Product Identifier
+  // http://tools.ietf.org/html/rfc5545#section-3.7.3
+  calendar.addProperty('PRODID', '-//Sunrise Atelier, Inc//EN');
+
+  // Method
+  // http://tools.ietf.org/html/rfc5545#section-3.7.2
+  calendar.setMethod = function(method) {
+    calendar.addProperty('METHOD', method);
+  };
+
+  calendar.getMethod = function() {
+    return calendar.getPropertyValue('METHOD');
+  };
+
+  return calendar;
+};

lib/component.js

@@ -0,0 +1,78 @@
+var Property = require('./property');
+
+module.exports = function(name) {
+  var component = {};
+
+  component.name = (name || 'VCALENDAR').toUpperCase();
+
+  // http://tools.ietf.org/html/rfc5545#section-3.6
+  component.components = {};
+
+  // http://tools.ietf.org/html/rfc5545#section-3.7
+  component.properties = {};
+
+  // addProperty
+  // name, value
+  component.addProperty = function(name, value) {
+    var property = Property(name, value);
+    component.properties[name] = component.properties[name] || [];
+    component.properties[name].push(property);
+  };
+
+  // setProperty
+  // unique
+  component.setProperty = function(name, value) {
+    var property = Property(name, value);
+    component.properties[name] = [property];
+  };
+
+  // getProperty
+  // returns first Property when index is undefined
+  component.getProperty = function(name, index) {
+    return (this.properties[name] || [])[index || 0];
+  };
+
+  // getPropertyValue
+  component.getPropertyValue = function(name, index) {
+    var property = component.getProperty(name, index);
+    if (!property) {
+      return undefined;
+    }
+    return property.value;
+  };
+
+  // addComponent
+  component.addComponent = function(childComponent) {
+    component.components[childComponent.name] = component.properties[childComponent.name] || [];
+    component.components[childComponent.name].push(childComponent);
+  };
+
+  // stringifyToArray
+  component.stringifyToArray = function() {
+    var lines = [];
+
+    // BEGIN:VCALENDAR
+    lines.push(['BEGIN', component.name].join(':'));
+
+    // Stringify .properties
+    for(var name in component.properties) {
+      component.properties[name].forEach(function(property) {
+        lines.push(property.stringify());
+      });
+    }
+
+    // Stringify .components
+    for(var name in component.components) {
+      component.components[name].forEach(function(component) {
+        lines = lines.concat(component.stringifyToArray());
+      });
+    }
+
+    // END:VCALENDAR
+    lines.push(['END', component.name].join(':'));
+
+    return lines;
+  };
+
+  return component;
+};

lib/event.js

@@ -0,0 +1,84 @@
+var Component = require('./component');
+
+module.exports = function() {
+  // http://tools.ietf.org/html/rfc5545#section-3.6.1
+  // Provide a grouping of component properties that describe an event.
+  var event = Component('VEVENT');
+
+  // Sequence to 0 (Default)
+  event.setProperty('SEQUENCE', '0');
+
+  // http://tools.ietf.org/html/rfc5545#section-3.8.4.7
+  event.setUID = function(UID) {
+    event.setProperty('UID', UID);
+  };
+
+  event.getUID = function() {
+    return event.getPropertyValue('UID');
+  };
+
+  // http://tools.ietf.org/html/rfc5545#section-3.8.1.12
+  event.setSummary = function(summary) {
+    event.setProperty('SUMMARY', summary);
+  };
+
+  event.getSummary = function() {
+    return event.getPropertyValue('SUMMARY');
+  };
+
+  // http://tools.ietf.org/html/rfc5545#section-3.8.1.5
+  event.setDescription = function(description) {
+    event.setProperty('DESCRIPTION', description);
+  };
+
+  event.getDescription = function() {
+    return event.getPropertyValue('DESCRIPTION');
+  };
+
+  // http://tools.ietf.org/html/rfc5545#section-3.8.1.7
+  event.setLocation = function(location) {
+    event.setProperty('LOCATION', location);
+  };
+
+  event.getLocation = function() {
+    return event.getPropertyValue('LOCATION');
+  };
+
+  // http://tools.ietf.org/html/rfc5545#section-3.8.1.11
+  event.setStatus = function(status) {
+    event.setProperty('STATUS', status);
+  };
+
+  event.getStatus = function() {
+    return event.getPropertyValue('STATUS');
+  };
+
+  // http://tools.ietf.org/html/rfc5545#section-3.8.7.2
+  event.setDTStamp = function(dtstamp) {
+    event.setProperty('DTSTAMP', dtstamp);
+  };
+
+  event.getDTStamp = function() {
+    return event.getPropertyValue('DTSTAMP');
+  };
+
+  // http://tools.ietf.org/html/rfc5545#section-3.8.7.4
+  event.setSequence = function(sequence) {
+    event.setProperty('SEQUENCE', sequence);
+  };
+
+  event.getSequence = function() {
+    return event.getPropertyValue('SEQUENCE');
+  };
+
+  // http://tools.ietf.org/html/rfc5545#section-3.8.7.1
+  event.setCreated = function(sequence) {
+    event.setProperty('CREATED', sequence);
+  };
+
+  event.getCreated = function() {
+    return event.getPropertyValue('CREATED');
+  };
+
+  return event;
+};