paulsm-icalendar 1.1.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (48) hide show
  1. data/COPYING +56 -0
  2. data/GPL +340 -0
  3. data/README +266 -0
  4. data/Rakefile +109 -0
  5. data/docs/rfcs/itip_notes.txt +69 -0
  6. data/docs/rfcs/rfc2425.pdf +0 -0
  7. data/docs/rfcs/rfc2426.pdf +0 -0
  8. data/docs/rfcs/rfc2445.pdf +0 -0
  9. data/docs/rfcs/rfc2446.pdf +0 -0
  10. data/docs/rfcs/rfc2447.pdf +0 -0
  11. data/docs/rfcs/rfc3283.txt +738 -0
  12. data/examples/create_cal.rb +45 -0
  13. data/examples/parse_cal.rb +20 -0
  14. data/examples/single_event.ics +18 -0
  15. data/lib/hash_attrs.rb +34 -0
  16. data/lib/icalendar.rb +39 -0
  17. data/lib/icalendar/base.rb +43 -0
  18. data/lib/icalendar/calendar.rb +113 -0
  19. data/lib/icalendar/component.rb +442 -0
  20. data/lib/icalendar/component/alarm.rb +44 -0
  21. data/lib/icalendar/component/event.rb +129 -0
  22. data/lib/icalendar/component/freebusy.rb +38 -0
  23. data/lib/icalendar/component/journal.rb +61 -0
  24. data/lib/icalendar/component/timezone.rb +105 -0
  25. data/lib/icalendar/component/todo.rb +64 -0
  26. data/lib/icalendar/conversions.rb +150 -0
  27. data/lib/icalendar/helpers.rb +109 -0
  28. data/lib/icalendar/parameter.rb +33 -0
  29. data/lib/icalendar/parser.rb +396 -0
  30. data/lib/icalendar/rrule.rb +126 -0
  31. data/lib/icalendar/tzinfo.rb +121 -0
  32. data/lib/meta.rb +32 -0
  33. data/test/calendar_test.rb +71 -0
  34. data/test/component/event_test.rb +256 -0
  35. data/test/component/timezone_test.rb +67 -0
  36. data/test/component/todo_test.rb +13 -0
  37. data/test/component_test.rb +76 -0
  38. data/test/conversions_test.rb +97 -0
  39. data/test/coverage/STUB +0 -0
  40. data/test/fixtures/folding.ics +23 -0
  41. data/test/fixtures/life.ics +46 -0
  42. data/test/fixtures/simplecal.ics +119 -0
  43. data/test/fixtures/single_event.ics +23 -0
  44. data/test/interactive.rb +17 -0
  45. data/test/parameter_test.rb +29 -0
  46. data/test/parser_test.rb +84 -0
  47. data/test/read_write.rb +23 -0
  48. metadata +108 -0
data/COPYING ADDED
@@ -0,0 +1,56 @@
1
+ Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
2
+ You can redistribute it and/or modify it under either the terms of the GPL
3
+ (see the file GPL), or the conditions below:
4
+
5
+ 1. You may make and give away verbatim copies of the source form of the
6
+ software without restriction, provided that you duplicate all of the
7
+ original copyright notices and associated disclaimers.
8
+
9
+ 2. You may modify your copy of the software in any way, provided that
10
+ you do at least ONE of the following:
11
+
12
+ a) place your modifications in the Public Domain or otherwise
13
+ make them Freely Available, such as by posting said
14
+ modifications to Usenet or an equivalent medium, or by allowing
15
+ the author to include your modifications in the software.
16
+
17
+ b) use the modified software only within your corporation or
18
+ organization.
19
+
20
+ c) give non-standard binaries non-standard names, with
21
+ instructions on where to get the original software distribution.
22
+
23
+ d) make other distribution arrangements with the author.
24
+
25
+ 3. You may distribute the software in object code or binary form,
26
+ provided that you do at least ONE of the following:
27
+
28
+ a) distribute the binaries and library files of the software,
29
+ together with instructions (in the manual page or equivalent)
30
+ on where to get the original distribution.
31
+
32
+ b) accompany the distribution with the machine-readable source of
33
+ the software.
34
+
35
+ c) give non-standard binaries non-standard names, with
36
+ instructions on where to get the original software distribution.
37
+
38
+ d) make other distribution arrangements with the author.
39
+
40
+ 4. You may modify and include the part of the software into any other
41
+ software (possibly commercial). But some files in the distribution
42
+ are not written by the author, so that they are not under these terms.
43
+
44
+ For the list of those files and their copying conditions, see the
45
+ file LEGAL.
46
+
47
+ 5. The scripts and library files supplied as input to or produced as
48
+ output from the software do not automatically fall under the
49
+ copyright of the software, but belong to whomever generated them,
50
+ and may be sold commercially, and may be aggregated with this
51
+ software.
52
+
53
+ 6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
54
+ IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
55
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
56
+ PURPOSE.
data/GPL ADDED
@@ -0,0 +1,340 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Library General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) <year> <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License
307
+ along with this program; if not, write to the Free Software
308
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
309
+
310
+
311
+ Also add information on how to contact you by electronic and paper mail.
312
+
313
+ If the program is interactive, make it output a short notice like this
314
+ when it starts in an interactive mode:
315
+
316
+ Gnomovision version 69, Copyright (C) year name of author
317
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
318
+ This is free software, and you are welcome to redistribute it
319
+ under certain conditions; type `show c' for details.
320
+
321
+ The hypothetical commands `show w' and `show c' should show the appropriate
322
+ parts of the General Public License. Of course, the commands you use may
323
+ be called something other than `show w' and `show c'; they could even be
324
+ mouse-clicks or menu items--whatever suits your program.
325
+
326
+ You should also get your employer (if you work as a programmer) or your
327
+ school, if any, to sign a "copyright disclaimer" for the program, if
328
+ necessary. Here is a sample; alter the names:
329
+
330
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
331
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
332
+
333
+ <signature of Ty Coon>, 1 April 1989
334
+ Ty Coon, President of Vice
335
+
336
+ This General Public License does not permit incorporating your program into
337
+ proprietary programs. If your program is a subroutine library, you may
338
+ consider it more useful to permit linking proprietary applications with the
339
+ library. If this is what you want to do, use the GNU Library General
340
+ Public License instead of this License.
data/README ADDED
@@ -0,0 +1,266 @@
1
+ = iCalendar -- Internet calendaring, Ruby style
2
+
3
+ This is a Ruby library for dealing with iCalendar files. Rather than
4
+ explaining myself, here is the introduction from RFC-2445, which
5
+ defines the format:
6
+
7
+ The use of calendaring and scheduling has grown considerably in the
8
+ last decade. Enterprise and inter-enterprise business has become
9
+ dependent on rapid scheduling of events and actions using this
10
+ information technology. However, the longer term growth of calendaring
11
+ and scheduling, is currently limited by the lack of Internet standards
12
+ for the message content types that are central to these knowledgeware
13
+ applications. This memo is intended to progress the level of
14
+ interoperability possible between dissimilar calendaring and
15
+ scheduling applications. This memo defines a MIME content type for
16
+ exchanging electronic calendaring and scheduling information. The
17
+ Internet Calendaring and Scheduling Core Object Specification, or
18
+ iCalendar, allows for the capture and exchange of information normally
19
+ stored within a calendaring and scheduling application; such as a
20
+ Personal Information Manager (PIM) or a Group Scheduling product.
21
+
22
+ The iCalendar format is suitable as an exchange format between
23
+ applications or systems. The format is defined in terms of a MIME
24
+ content type. This will enable the object to be exchanged using
25
+ several transports, including but not limited to SMTP, HTTP, a file
26
+ system, desktop interactive protocols such as the use of a memory-
27
+ based clipboard or drag/drop interactions, point-to-point asynchronous
28
+ communication, wired-network transport, or some form of unwired
29
+ transport such as infrared might also be used.
30
+
31
+ Now for some examples:
32
+
33
+ ## Probably want to start with this
34
+
35
+ require 'rubygems' # Unless you install from the tarball or zip.
36
+ require 'icalendar'
37
+ require 'date'
38
+
39
+ include Icalendar # Probably do this in your class to limit namespace overlap
40
+
41
+ ## Creating calendars and events is easy.
42
+
43
+ # Create a calendar with an event (standard method)
44
+ cal = Calendar.new
45
+ cal.event do
46
+ dtstart Date.new(2005, 04, 29)
47
+ dtend Date.new(2005, 04, 28)
48
+ summary "Meeting with the man."
49
+ description "Have a long lunch meeting and decide nothing..."
50
+ klass "PRIVATE"
51
+ end
52
+
53
+ cal.publish
54
+
55
+ ## Or you can make events like this
56
+ event = Event.new
57
+ event.start = DateTime.civil(2006, 6, 23, 8, 30)
58
+ event.summary = "A great event!"
59
+ cal.add_event(event)
60
+
61
+ event2 = cal.event # This automatically adds the event to the calendar
62
+ event2.start = DateTime.civil(2006, 6, 24, 8, 30)
63
+ event2.summary = "Another great event!"
64
+
65
+ # Now with support for property parameters
66
+ params = {"ALTREP" =>['"http://my.language.net"'], "LANGUAGE" => ["SPANISH"]}
67
+
68
+ cal.event do
69
+ dtstart Date.new(2005, 04, 29)
70
+ dtend Date.new(2005, 04, 28)
71
+ summary "This is a summary with params.", params
72
+ end
73
+
74
+ # We can output the calendar as a string to write to a file,
75
+ # network port, database etc.
76
+ cal_string = cal.to_ical
77
+ puts cal_string
78
+
79
+ ## ALARMS
80
+
81
+ ## Within an event, you can create e-mail notification alarms like this...
82
+
83
+ cal.event.do
84
+ # ...other event properties
85
+ alarm do
86
+ action "EMAIL"
87
+ description "This is an event reminder" # email body (required)
88
+ summary "Alarm notification" # email subject (required)
89
+ attendees %w(mailto:me@my-domain.com mailto:me-too@my-domain.com) # one or more email recipients (required)
90
+ add_attendee "mailto:me-three@my-domain.com"
91
+ remove_attendee "mailto:me@my-domain.com"
92
+ trigger "-PT15M" # 15 minutes before
93
+ add_attach "ftp://host.com/novo-procs/felizano.exe", {"FMTTYPE" => "application/binary"} # email attachments (optional)
94
+ end
95
+
96
+ alarm do
97
+ action "DISPLAY" # This line isn't necessary, it's the default
98
+ summary "Alarm notification"
99
+ trigger "-P1DT0H0M0S" # 1 day before
100
+ end
101
+
102
+ alarm do
103
+ action "AUDIO"
104
+ trigger "-PT15M"
105
+ add_attach "Basso", {"VALUE" => ["URI"]} # only one attach allowed (optional)
106
+ end
107
+ end
108
+
109
+ # Output
110
+
111
+ # BEGIN:VALARM
112
+ # ACTION:EMAIL
113
+ # ATTACH;FMTTYPE=application/binary:ftp://host.com/novo-procs/felizano.exe
114
+ # TRIGGER:-PT15M
115
+ # SUMMARY:Alarm notification
116
+ # DESCRIPTION:This is an event reminder
117
+ # ATTENDEE:mailto:me-too@my-domain.com
118
+ # ATTENDEE:mailto:me-three@my-domain.com
119
+ # END:VALARM
120
+ #
121
+ # BEGIN:VALARM
122
+ # ACTION:DISPLAY
123
+ # TRIGGER:-P1DT0H0M0S
124
+ # SUMMARY:Alarm notification
125
+ # END:VALARM
126
+ #
127
+ # BEGIN:VALARM
128
+ # ACTION:AUDIO
129
+ # ATTACH;VALUE=URI:Basso
130
+ # TRIGGER:-PT15M
131
+ # END:VALARM
132
+
133
+ ## Timezones
134
+
135
+ # Create a timezone definition (previous convention)
136
+ cal = Calendar.new
137
+ timezone = Icalendar::Timezone.new
138
+ daylight = Icalendar::Daylight.new
139
+ standard = Icalendar::Standard.new
140
+
141
+ timezone.timezone_id = "America/Chicago"
142
+
143
+ daylight.timezone_offset_from = "-0600"
144
+ daylight.timezone_offset_to = "-0500"
145
+ daylight.timezone_name = "CDT"
146
+ daylight.dtstart = "19700308TO20000"
147
+ daylight.recurrence_rules = ["FREQ=YEARLY;BYMONTH=3;BYDAY=2SU"]
148
+
149
+ standard.timezone_offset_from = "-0500"
150
+ standard.timezone_offset_to = "-0600"
151
+ standard.timezone_name = "CST"
152
+ standard.dtstart = "19701101T020000"
153
+ standard.recurrence_rules = ["YEARLY;BYMONTH=11;BYDAY=1SU"]
154
+
155
+ timezone.add(daylight)
156
+ timezone.add(standard)
157
+ cal.add(timezone)
158
+
159
+ # Now, you can make timezones like this
160
+ cal = Calendar.new
161
+ cal.timezone do
162
+ timezone_id "America/Chicago"
163
+
164
+ daylight do
165
+ timezone_offset_from "-0600"
166
+ timezone_offset_to "-0500"
167
+ timezone_name "CDT"
168
+ dtstart "19700308TO20000"
169
+ add_recurrence_rule "FREQ=YEARLY;BYMONTH=3;BYDAY=2SU"
170
+ end
171
+
172
+ standard do
173
+ timezone_offset_from "-0500"
174
+ timezone_offset_to "-0600"
175
+ timezone_name "CST"
176
+ dtstart "19701101T020000"
177
+ add_recurrence_rule "YEARLY;BYMONTH=11;BYDAY=1SU"
178
+ end
179
+ end
180
+
181
+ # Both conventions output
182
+
183
+ # BEGIN:VTIMEZONE
184
+ # TZID:America/Chicago
185
+ # BEGIN:DAYLIGHT
186
+ # TZOFFSETFROM:-0600
187
+ # TZOFFSETTO:-0500
188
+ # TZNAME:CDT
189
+ # DTSTART:19700308T020000
190
+ # RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=2SU
191
+ # END:DAYLIGHT
192
+ # BEGIN:STANDARD
193
+ # TZOFFSETFROM:-0500
194
+ # TZOFFSETTO:-0600
195
+ # TZNAME:CST
196
+ # DTSTART:19701101T020000
197
+ # RRULE:FREQ=YEARLY;BYMONTH=11;BYDAY=1SU
198
+ # END:STANDARD
199
+ # END:VTIMEZONE
200
+
201
+ == Unicode
202
+ Add `$KCODE = 'u'` to make icalender work correctly with Utf8 texts
203
+
204
+ == Parsing iCalendars:
205
+
206
+ # Open a file or pass a string to the parser
207
+ cal_file = File.open("single_event.ics")
208
+
209
+ # Parser returns an array of calendars because a single file
210
+ # can have multiple calendars.
211
+ cals = Icalendar.parse(cal_file)
212
+ cal = cals.first
213
+
214
+ # Now you can access the cal object in just the same way I created it
215
+ event = cal.events.first
216
+
217
+ puts "start date-time: " + event.dtstart
218
+ puts "summary: " + event.summary
219
+
220
+ == Finders:
221
+
222
+ Often times in web apps and other interactive applications you'll need to
223
+ lookup items in a calendar to make changes or get details. Now you can find
224
+ everything by the unique id automatically associated with all components.
225
+
226
+ cal = Calendar.new
227
+ 10.times { cal.event } # Create 10 events with only default data.
228
+ some_event = cal.events[5] # Grab it from the array of events
229
+
230
+ # Use the uid as the key in your app
231
+ key = some_event.uid
232
+
233
+ # so later you can find it.
234
+ same_event = cal.find_event(key)
235
+
236
+ == Examples:
237
+
238
+ Check the unit tests for examples of most things you'll want to do, but please
239
+ send me example code or let me know what's missing.
240
+
241
+ == Download
242
+
243
+ The latest release version of this library can be found at
244
+
245
+ * http://rubyforge.org/projects/icalendar/
246
+
247
+ Documentation can be found at
248
+
249
+ * http://icalendar.rubyforge.org/
250
+
251
+ == Installation
252
+
253
+ It's all about rubygems:
254
+
255
+ $ sudo gem install icalendar
256
+
257
+ == License
258
+
259
+ This library is released under the same license as Ruby itself.
260
+
261
+ == Support & Contributions
262
+
263
+ The iCalendar library homepage is http://icalendar.rubyforge.org/
264
+
265
+ There is an icalendar-devel@rubyforge.org mailing list that can be
266
+ used for asking questions, making comments or submitting patches.