Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Multiple events per calendar + more #7

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Multiple events per calendar + more #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
c9f8d70
more sanity checks on organizer data, added quotes to CN property to …
sourcehunter Jul 22, 2014
89e9ac9
replaced custom date parsing by Moment.js
sourcehunter Jul 22, 2014
1138fbe
added multiple event support
sourcehunter Jul 22, 2014
d3b1f0a
added support for all day events
sourcehunter Jul 22, 2014
69df09c
added name and description for calendars
sourcehunter Jul 29, 2014
162b0e2
escape ',', ';' and '\'
sourcehunter Jul 29, 2014
5613079
updated example and readme
sourcehunter Jul 29, 2014
dda9110
more escaping
sourcehunter Aug 22, 2014
3544490
Update documentation to note that property is no longer required
wearhere Feb 8, 2016
ab19e50
Fix package.json
wearhere Feb 8, 2016
6059446
Merge pull request #2 from mixmaxhq/jeff/fix_package_json
sourcehunter Feb 9, 2016
cdbb761
Merge pull request #1 from mixmaxhq/jeff/remove_unused_property
sourcehunter Feb 9, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
223 changes: 185 additions & 38 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,19 @@ With [npm](http://npmjs.org):
## Examples

``` js
var iCalEvent = require('icalevent');
var iCalendar = require('./icalevent');

var event = new iCalEvent({
uid: 9873647,
offset: new Date().getTimezoneOffset(),
var calendar = new iCalendar({
method: 'request',
name: 'Personal calendar',
description: 'Personal calendar of Johnny Boy'
}, [{
uid: 9873647,
status: 'confirmed',
attendees: [
{
name: 'Johnny Boy',
email: 'johnny@numberfive.com'
email: 'johnny@numberfivevent.com'
},
{
name: 'Homer Simpson',
Expand All @@ -36,28 +38,49 @@ var event = new iCalEvent({
description: 'Home flu visit.',
location: 'Casa',
organizer: {
name: 'Nacho Libre',
name: 'Libre, Nacho',
email: 'luchador@monastery.org'
},
url: 'http://google.com/search?q=nacho+libre'
});
url: 'http://googlevent.com/search?q=nacho+libre'
}, {
status: 'confirmed',
attendees: [
{
name: 'Johnny Boy',
email: 'johnny@numberfivevent.com'
}
],
start: '2014-07-02T10:00:00-05:00',
end: '2014-07-02T11:30:00-05:00',
timezone: 'US/Central',
summary: 'Meet with Jane, bring cake',
location: 'Somwhere',
organizer: {
name: 'Doe, Jane',
email: 'jane@doevent.com'
}
}]);
```

Or:

``` js
var iCalEvent = require('icalevent');
var iCalendar = require('./icalevent');

var event = new iCalEvent();
var calendar = new iCalendar();

calendar.set('method', 'request');
calendar.set('name', 'Personal calendar');
calendar.set('description', 'Personal calendar of Johnny Boy');

var event = calendar.addEvent();

event.set('uid', 9873647);
event.set('offset', new Date().getTimezoneOffset());
event.set('method', 'request');
event.set('status', 'confirmed');
event.set('attendees', [
{
name: 'Johnny Boy',
email: 'johnny@numberfive.com'
email: 'johnny@numberfivevent.com'
},
{
name: 'Homer Simpson',
Expand All @@ -70,14 +93,30 @@ event.set('timezone', 'US/Central');
event.set('summary', 'Priestly Duties.');
event.set('description', 'Home flu visit.');
event.set('location', 'Casa');
event.set('organizer', { name: 'Nacho Libre', email: 'luchador@monastery.org' });
event.set('url', 'http://google.com/search?q=nacho+libre');
event.set('organizer', { name: 'Libre, Nacho', email: 'luchador@monastery.org' });
event.set('url', 'http://googlevent.com/search?q=nacho+libre');

var event2 = calendar.addEvent();

event2.set('status', 'confirmed');
event2.set('attendees', [
{
name: 'Johnny Boy',
email: 'johnny@numberfivevent.com'
}
]);
event2.set('start', '2014-07-02T10:00:00-05:00');
event2.set('end', '2014-07-02T11:30:00-05:00');
event2.set('timezone', 'US/Central');
event2.set('summary', 'Meet with Jane, bring cake');
event2.set('location', 'Somwhere');
event2.set('organizer', {name: 'Doe, Jane', email: 'jane@doevent.com'});
```

To ics string:

``` js
event.toFile();
calendar.toFile();
```

Returns:
Expand All @@ -86,40 +125,153 @@ Returns:
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//iCalEvent.js v0.3//EN
METHOD:REQUEST
NAME:Personal calendar
X-WR-CALNAME:Personal calendar
DESCRIPTION:Personal calendar of Johnny Boy
X-WR-CALDESC:Personal calendar of Johnny Boy
BEGIN:VEVENT
UID:9873647
DTSTAMP:20140316T003036
DTSTAMP:20140729T115736
STATUS:CONFIRMED
DTSTART;TZID=US/Central:20140701T090000
DTEND;TZID=US/Central:20140701T093000
SUMMARY:Priestly Duties
DESCRIPTION:Home flu visit.
ORGANIZER;CN=Libre\, Nacho:mailto:luchador@monastery.org
LOCATION:Casa
URL;VALUE=URI:http://google.com/search?q=nacho+libre
ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;CN=Johnny Boy:MAILTO:johnny@numberfive.com
ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;CN=Homer Simpson:MAILTO:homer@powerplant.com
END:VEVENT
BEGIN:VEVENT
UID:104a0a1f-2b0b-4fcb-9a36-83d868e67a08
DTSTAMP:20140729T115736
STATUS:CONFIRMED
DTSTART;TZID=US/Central:20140702T170000
DTEND;TZID=US/Central:20140702T183000
SUMMARY:Meet with Jane\, bring cake
ORGANIZER;CN=Doe\, Jane:mailto:jane@doe.com
LOCATION:Somewhere
ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;CN=Johnny Boy:MAILTO:johnny@numberfive.com
END:VEVENT
END:VCALENDAR
```

## Calendar-API

### Properties

* **method** (String) _The calendar method. For example, publish, request, reply, add, cancel, refresh, counter, and decline-counter_
* **id** (String) _The identifier of the product, that created this calendar. Defaults to "-//iCalEvent.js v0.3//EN"._
* **name** (String) _A name, that describes the events in this calendar in short._
* **description** (String) _A full description of the kind of events in this calendar._

### Methods

#### iCalendar(calendar, events)

The constructor for a new iCalendar. Initializes the calendar properties with the values provided by the `calendar` hash and adds all events from the `events` array to the calendar.

#### .addEvent(event)

Creates a new event in this calendar and initializes it with the values provided by the `event` hash. Returns the newly created iCalEvent object. (see [Event-API](#event-api))

``` js
event = calendar.addEvent({
status: 'confirmed',
attendees: [
{
name: 'Johnny Boy',
email: 'johnny@numberfivevent.com'
}
],
start: '2014-07-02T10:00:00-05:00',
end: '2014-07-02T11:30:00-05:00',
timezone: 'US/Central',
summary: 'Meet with Jane, bring cake',
location: 'Somwhere',
organizer: {
name: 'Doe, Jane',
email: 'jane@doevent.com'
}
});
```

#### .set(property, value)
``` js
calendar.set('method', 'publish');
```

#### .get(property)
``` js
calendar.get('method');
```

Returns:

```
publish
```

#### .toFile()
``` js
calendar.toFile();
```

Returns:

```
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//iCalEvent.js v0.3//EN
METHOD:REQUEST
NAME:Personal calendar
X-WR-CALNAME:Personal calendar
DESCRIPTION:Personal calendar of Johnny Boy
X-WR-CALDESC:Personal calendar of Johnny Boy
BEGIN:VEVENT
UID:9873647
DTSTAMP:20140729T115736
STATUS:CONFIRMED
DTSTART;TZID=US/Central:20140701T020000
DTEND;TZID=US/Central:20140701T023000
SUMMARY:Priestly Duties.
DTSTART;TZID=US/Central:20140701T090000
DTEND;TZID=US/Central:20140701T093000
SUMMARY:Priestly Duties
DESCRIPTION:Home flu visit.
ORGANIZER;CN=Nacho Libre:mailto:luchador@monastery.org
ORGANIZER;CN=Libre\, Nacho:mailto:luchador@monastery.org
LOCATION:Casa
URL;VALUE=URI:http://google.com/search?q=nacho+libre
ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;CN=Johnny Boy:MAILTO:johnny@numberfive.com
ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;CN=Homer Simpson:MAILTO:homer@powerplant.com
END:VEVENT
BEGIN:VEVENT
UID:104a0a1f-2b0b-4fcb-9a36-83d868e67a08
DTSTAMP:20140729T115736
STATUS:CONFIRMED
DTSTART;TZID=US/Central:20140702T170000
DTEND;TZID=US/Central:20140702T183000
SUMMARY:Meet with Jane\, bring cake
ORGANIZER;CN=Doe\, Jane:mailto:jane@doe.com
LOCATION:Somewhere
ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;CN=Johnny Boy:MAILTO:johnny@numberfive.com
END:VEVENT
END:VCALENDAR
```

## API
## Event-API

### Properties

#### Required

* **offset** (Integer) _The Date.getTimezoneOffset() of the timezone the event is set in. Important: the offset has to be set before start and end times_
* **start** (Date Object) _The start date object of the event_
* **end** (Date Object) _The end date object of the event_

#### Optional

* **uid** (String or Integer) _The event uid. If you don't set the uid it will be set for you._
* **method** (String) _The event method. For example, publish, request, reply, add, cancel, refresh, counter, and decline-counter_
* **status** (String) _The event status. For example, cancelled, confirmed, tentative_
* **timezone** (String) _The event's timezone in [ICS timezone format](https://github.com/shanebo/tzone/blob/master/lib/tzone.js). If you don't set the timezone it will be set for you._
* **timezone** (String) _The event's timezone in [ICS timezone format](https://github.com/shanebo/tzone/blob/master/lib/tzonevent.js). If you don't set the timezone it will be set for you._
* **location** (String) _The event location of the event. For example, monastery_
* **url** (String) _A url corresponding to the event_
* **summary** (String) _A summary of the event_
Expand All @@ -138,7 +290,7 @@ END:VCALENDAR
[
{
name: 'Johnny Boy',
email: 'johnny@numberfive.com'
email: 'johnny@numberfivevent.com'
},
{
name: 'Homer Simpson',
Expand All @@ -151,7 +303,7 @@ END:VCALENDAR

#### .set(property, value)
``` js
event.set('url', 'http://google.com/search?q=nacho+libre');
event.set('url', 'http://googlevent.com/search?q=nacho+libre');
```

#### .get(property)
Expand All @@ -162,7 +314,7 @@ event.get('url');
Returns:

```
http://google.com/search?q=nacho+libre
http://googlevent.com/search?q=nacho+libre
```

#### .toFile()
Expand All @@ -173,25 +325,20 @@ event.toFile();
Returns:

```
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//iCalEvent.js v0.3//EN
BEGIN:VEVENT
UID:9873647
DTSTAMP:20140316T003036
METHOD:REQUEST
DTSTAMP:20140729T115736
STATUS:CONFIRMED
DTSTART;TZID=US/Central:20140701T020000
DTEND;TZID=US/Central:20140701T023000
SUMMARY:Priestly Duties.
DTSTART;TZID=US/Central:20140701T090000
DTEND;TZID=US/Central:20140701T093000
SUMMARY:Priestly Duties
DESCRIPTION:Home flu visit.
ORGANIZER;CN=Nacho Libre:mailto:luchador@monastery.org
ORGANIZER;CN=Libre\, Nacho:mailto:luchador@monastery.org
LOCATION:Casa
URL;VALUE=URI:http://google.com/search?q=nacho+libre
ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;CN=Johnny Boy:MAILTO:johnny@numberfive.com
ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;CN=Homer Simpson:MAILTO:homer@powerplant.com
END:VEVENT
END:VCALENDAR
```


Expand Down