paulsm-icalendar 1.1.0.4

data/lib/icalendar/component/alarm.rb

@@ -0,0 +1,44 @@
+=begin
+  Copyright (C) 2005 Jeff Rose
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+module Icalendar 
+  # An Alarm calendar component is a grouping of component
+  # properties that is a reminder or alarm for an event or a
+  # to-do. For example, it may be used to define a reminder for a
+  # pending Event or an overdue Todo.  
+  class Alarm < Component
+  
+    # Single properties
+    ical_property :action
+    ical_property :description
+    ical_property :trigger
+    ical_property :summary
+    
+    # Single but must appear together
+    ical_property :duration
+    ical_property :repeat
+    
+    # Single and only occurring once
+    
+    ical_property :created
+    ical_property :last_modified
+    ical_property :timestamp
+    ical_property :sequence
+
+    # Multi properties
+    ical_multiline_property :attendee, :attendee, :attendees
+    ical_multiline_property :attach, :attachment, :attachments
+
+    def initialize()
+      super("VALARM")
+      
+      # Almost everyone just wants to display so I make it the 
+      # default so it works for most people right away...
+      action "DISPLAY"
+    end
+  end
+end

data/lib/icalendar/component/event.rb

@@ -0,0 +1,129 @@
+=begin
+  Copyright (C) 2005 Jeff Rose
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+
+module Icalendar
+  # A Event calendar component is a grouping of component
+  # properties, and possibly including Alarm calendar components, that
+  # represents a scheduled amount of time on a calendar. For example, it
+  # can be an activity; such as a one-hour long, department meeting from
+  # 8:00 AM to 9:00 AM, tomorrow. Generally, an event will take up time
+  # on an individual calendar.
+  class Event < Component
+    ical_component :alarms
+
+    ## Single instance properties
+
+    # Access classification (PUBLIC, PRIVATE, CONFIDENTIAL...)
+    ical_property :ip_class, :klass 
+
+    # Date & time of creation
+    ical_property :created
+
+    # Complete description of the calendar component
+    ical_property :description
+
+    # Specifies the timezone for the event
+    attr_accessor :tzid
+    
+    # Specifies date-time when calendar component begins
+    ical_property :dtstart, :start
+
+    # Latitude & longitude for specified activity
+    ical_property :geo, :geo_location
+ 
+    # Date & time this item was last modified
+    ical_property :last_modified
+
+    # Specifies the intended venue for this activity
+    ical_property :location
+
+    # Defines organizer of this item
+    ical_property :organizer
+
+    # Defines relative priority for this item (1-9... 1 = best)
+    ical_property :priority
+
+    # Indicate date & time when this item was created
+    ical_property :dtstamp, :timestamp
+
+    # Revision sequence number for this item
+    ical_property :sequence, :seq
+
+    # Defines overall status or confirmation of this item
+    ical_property :status
+    ical_property :summary
+    ical_property :transp, :transparency
+
+    # Defines a persistent, globally unique id for this item
+    ical_property :uid, :unique_id
+
+    # Defines a URL associated with this item
+    ical_property :url
+    ical_property :recurid, :recurrence_id
+
+    ## Single but mutually exclusive properties (Not testing though)
+    
+    # Specifies a date and time that this item ends
+    ical_property :dtend, :end
+
+    # Specifies a positive duration time
+    ical_property :duration
+
+    ## Multi-instance properties
+
+    # Associates a URI or binary blob with this item
+    ical_multi_property :attach, :attachment, :attachments
+
+    # Defines an attendee for this calendar item
+    ical_multiline_property :attendee, :attendee, :attendees
+    
+    # Defines the categories for a calendar component (school, work...)
+    ical_multi_property :categories, :category, :categories
+
+    # Simple comment for the calendar user.
+    ical_multi_property :comment, :comment, :comments
+
+    # Contact information associated with this item.
+    ical_multi_property :contact, :contact, :contacts
+    ical_multi_property :exdate, :exception_date, :exception_dates
+    ical_multi_property :exrule, :exception_rule, :exception_rules
+    ical_multi_property :rstatus, :request_status, :request_statuses
+
+    # Used to represent a relationship between two calendar items
+    ical_multi_property :related_to, :related_to, :related_tos
+    ical_multi_property :resources, :resource, :resources
+
+    # Used with the UID & SEQUENCE to identify a specific instance of a
+    # recurring calendar item.
+    ical_multi_property :rdate, :recurrence_date, :recurrence_dates
+    ical_multi_property :rrule, :recurrence_rule, :recurrence_rules
+    
+    def initialize()
+      super("VEVENT")
+
+      # Now doing some basic initialization
+      sequence 0
+      timestamp DateTime.now
+      uid new_uid
+    end
+
+    def alarm(&block)
+      a = Alarm.new
+      self.add a
+
+      a.instance_eval &block if block
+
+      a
+    end
+    
+    def occurrences_starting(time)
+      recurrence_rules.first.occurrences_of_event_starting(self, time)
+    end
+
+  end
+end

data/lib/icalendar/component/freebusy.rb

@@ -0,0 +1,38 @@
+=begin
+  Copyright (C) 2005 Jeff Rose
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+module Icalendar
+  # A Freebusy calendar component is a grouping of
+  # component properties that represents either a request for, a reply to
+  # a request for free or busy time information or a published set of
+  # busy time information.
+  class Freebusy < Component
+    # Single properties
+    ical_property :contact
+    ical_property :dtstart, :start
+    ical_property :dtend, :end
+    ical_property :dtstamp, :timestamp
+    ical_property :duration
+    ical_property :organizer
+    ical_property :uid, :user_id
+    ical_property :url
+    ical_property :summary
+
+    # Multi-properties
+    ical_multiline_property :attendee, :attendee, :attendees
+    ical_multi_property :comment, :comment, :comments
+    ical_multiline_property :freebusy, :freebusy, :freebusys
+    ical_multi_property :rstatus, :request_status, :request_statuses
+
+    def initialize()
+      super("VFREEBUSY")
+
+      timestamp DateTime.now
+      uid new_uid
+    end
+  end
+end

data/lib/icalendar/component/journal.rb

@@ -0,0 +1,61 @@
+=begin
+  Copyright (C) 2005 Jeff Rose
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+module Icalendar
+  # A Journal calendar component is a grouping of
+  # component properties that represent one or more descriptive text
+  # notes associated with a particular calendar date. The "DTSTART"
+  # property is used to specify the calendar date that the journal entry
+  # is associated with. Generally, it will have a DATE value data type,
+  # but it can also be used to specify a DATE-TIME value data type.
+  # Examples of a journal entry include a daily record of a legislative
+  # body or a journal entry of individual telephone contacts for the day
+  # or an ordered list of accomplishments for the day. The Journal
+  # calendar component can also be used to associate a document with a
+  # calendar date.
+  class Journal < Component
+
+    # Single properties
+    ical_property :ip_class
+    ical_property :created
+    ical_property :description
+    ical_property :dtstart, :start
+    ical_property :last_modified
+    ical_property :organizer
+    ical_property :dtstamp, :timestamp
+    ical_property :sequence, :seq
+    ical_property :status
+    ical_property :summary
+    ical_property :uid, :user_id
+    ical_property :url
+    ical_property :recurid, :recurrence_id
+
+    # Multi-properties
+    ical_multi_property :attach, :attachment, :attachments
+    ical_multiline_property :attendee, :attendee, :attendees
+    ical_multi_property :categories, :category, :categories
+    ical_multi_property :comment, :comment, :comments
+    ical_multi_property :contact, :contact, :contacts
+    ical_multi_property :exdate, :exception_date, :exception_dates
+    ical_multi_property :exrule, :exception_rule, :exception_rules
+    ical_multi_property :rstatus, :request_status, :request_statuses
+    ical_multi_property :related_to, :related_to, :related_tos
+    ical_multi_property :resources, :resource, :resources
+    ical_multi_property :rdate, :recurrence_date, :recurrence_dates
+    ical_multi_property :rrule, :recurrence_rule, :recurrence_rules
+
+    def initialize()
+      super("VJOURNAL")
+
+      sequence 0
+      timestamp DateTime.now
+      uid new_uid
+    end
+
+  end
+end
+

data/lib/icalendar/component/timezone.rb

@@ -0,0 +1,105 @@
+=begin
+  Copyright (C) 2005 Jeff Rose
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+module Icalendar
+  # A Timezone is unambiguously defined by the set of time
+  # measurement rules determined by the governing body for a given
+  # geographic area. These rules describe at a minimum the base offset
+  # from UTC for the time zone, often referred to as the Standard Time
+  # offset. Many locations adjust their Standard Time forward or backward
+  # by one hour, in order to accommodate seasonal changes in number of
+  # daylight hours, often referred to as Daylight  Saving Time. Some
+  # locations adjust their time by a fraction of an hour. Standard Time
+  # is also known as Winter Time. Daylight Saving Time is also known as
+  # Advanced Time, Summer Time, or Legal Time in certain countries. The
+  # following table shows the changes in time zone rules in effect for
+  # New York City starting from 1967. Each line represents a description
+  # or rule for a particular observance.
+  class Timezone < Component
+    ical_component :standard, :daylight
+
+    # Single properties
+    ical_property :dtstart, :start
+    ical_property :tzoffsetto, :timezone_offset_to
+    ical_property :tzoffsetfrom, :timezone_offset_from
+    ical_property :tzid, :timezone_id
+    ical_property :tzname, :timezone_name
+    
+    ical_property :created
+    ical_property :last_modified
+    ical_property :timestamp
+    ical_property :sequence
+
+    # Multi-properties
+    ical_multi_property :comment, :comment, :comments
+    ical_multi_property :rdate, :recurrence_date, :recurrence_dates
+    ical_multi_property :rrule, :recurrence_rule, :recurrence_rules
+
+    # Define a custom add component method because standard and daylight
+    # are the only components that can occur just once with their parent.
+    def add_component(component)
+      key = component.class.to_s.downcase.gsub('icalendar::','').to_sym
+      @components[key] = component
+    end
+
+    # Also need a custom to_ical because typically it iterates over an array
+    # of components.
+    def to_ical
+      print_component do
+      s = ""
+        @components.each_value do |comp|
+          s << comp.to_ical
+        end
+      s
+      end
+    end
+    
+
+    def initialize(name = "VTIMEZONE")
+      super(name)
+    end
+    
+    # Allow block syntax for declaration of standard and daylight components of timezone
+    def standard(&block)
+      e = Standard.new
+      self.add_component e
+
+      e.instance_eval &block if block
+
+      e
+    end
+
+    def daylight(&block)
+      e = Daylight.new
+      self.add_component e
+
+      e.instance_eval &block if block
+
+      e
+    end
+  end
+
+  # A Standard component is a sub-component of the Timezone component which
+  # is used to describe the standard time offset. 
+  class Standard < Timezone
+
+    def initialize()
+      super("STANDARD")
+    end
+  end
+
+  # A Daylight component is a sub-component of the Timezone component which
+  # is used to describe the time offset for what is commonly known as
+  # daylight savings time.
+  class Daylight < Timezone
+
+    def initialize()
+      super("DAYLIGHT")
+    end
+  end
+
+end

data/lib/icalendar/component/todo.rb

@@ -0,0 +1,64 @@
+=begin
+  Copyright (C) 2005 Jeff Rose
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+module Icalendar
+  # A Todo calendar component is a grouping of component
+  # properties and possibly Alarm calendar components that represent
+  # an action-item or assignment. For example, it can be used to
+  # represent an item of work assigned to an individual; such as "turn in
+  # travel expense today".
+  class Todo < Component
+    ical_component :alarms
+
+    # Single properties
+    ical_property :ip_class
+    ical_property :completed
+    ical_property :created
+    ical_property :description
+    ical_property :dtstamp, :timestamp
+    ical_property :dtstart, :start
+    ical_property :geo
+    ical_property :last_modified
+    ical_property :location
+    ical_property :organizer
+    ical_property :percent
+    ical_property :priority
+    ical_property :recurid, :recurrence_id
+    ical_property :seq, :sequence
+    ical_property :status
+    ical_property :summary
+    ical_property :uid, :user_id
+    ical_property :url
+    
+    # Single but mutually exclusive TODO: not testing anything yet
+    ical_property :due
+    ical_property :duration
+
+    # Multi-properties
+    ical_multi_property :attach, :attachment, :attachments
+    ical_multiline_property :attendee, :attendee, :attendees
+    ical_multi_property :categories, :category, :categories
+    ical_multi_property :comment, :comment, :comments
+    ical_multi_property :contact, :contact, :contacts
+    ical_multi_property :exdate, :exception_date, :exception_dates
+    ical_multi_property :exrule, :exception_rule, :exception_rules
+    ical_multi_property :rstatus, :request_status, :request_statuses
+    ical_multi_property :related_to, :related_to, :related_tos
+    ical_multi_property :resources, :resource, :resources
+    ical_multi_property :rdate, :recurrence_date, :recurrence_dates
+    ical_multi_property :rrule, :recurrence_rule, :recurrence_rules
+    
+    def initialize()
+      super("VTODO")
+
+      sequence 0
+      timestamp DateTime.now
+      uid new_uid
+    end
+
+  end
+end

data/lib/icalendar/conversions.rb

@@ -0,0 +1,150 @@
+=begin
+  Copyright (C) 2005 Jeff Rose
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+
+require 'date'
+
+### Add some to_ical methods to classes
+
+# class Object
+#   def to_ical
+#     raise(NotImplementedError, "This object does not implement the to_ical method!")
+#   end
+# end
+
+module Icalendar
+  module TzidSupport
+    attr_accessor :icalendar_tzid
+  end
+end
+
+require 'uri/generic'
+
+class String
+  def to_ical
+    self
+  end
+end
+
+class Fixnum
+  def to_ical
+    "#{self}"
+  end
+end
+
+class Bignum
+  def to_ical
+    "#{self}"
+  end
+end
+
+class Float
+  def to_ical
+    "#{self}"
+  end
+end
+
+# From the spec: "Values in a list of values MUST be separated by a COMMA
+# character (US-ASCII decimal 44)."
+class Array
+  def to_ical
+    map{|elem| elem.to_ical}.join ','
+  end
+end
+
+module URI
+  class Generic
+    def to_ical
+      "#{self}"
+    end
+  end
+end
+
+class DateTime < Date
+  attr_accessor :ical_params
+  include Icalendar::TzidSupport
+
+  def to_ical
+    s = ""
+    
+    # 4 digit year
+    s << self.year.to_s
+    
+    # Double digit month
+    s << "0" unless self.month > 9 
+    s << self.month.to_s
+    
+    # Double digit day
+    s << "0" unless self.day > 9 
+    s << self.day.to_s
+
+    s << "T"
+        
+    # Double digit hour
+    s << "0" unless self.hour > 9 
+    s << self.hour.to_s
+    
+    # Double digit minute
+    s << "0" unless self.min > 9 
+    s << self.min.to_s
+    
+    # Double digit second
+    s << "0" unless self.sec > 9 
+    s << self.sec.to_s
+
+    # UTC time gets a Z suffix
+    if icalendar_tzid == "UTC"
+      s << "Z"
+    end
+
+    s
+  end
+end
+
+class Date
+  attr_accessor :ical_params
+  def to_ical(utc = false)
+    s = ""
+        
+    # 4 digit year
+    s << self.year.to_s
+    
+    # Double digit month
+    s << "0" unless self.month > 9 
+    s << self.month.to_s
+    
+    # Double digit day
+    s << "0" unless self.day > 9 
+    s << self.day.to_s
+  end
+end
+
+class Time
+  attr_accessor :ical_params
+  def to_ical(utc = false)
+    s = ""
+
+    # Double digit hour
+    s << "0" unless self.hour > 9 
+    s << self.hour.to_s
+    
+    # Double digit minute
+    s << "0" unless self.min > 9 
+    s << self.min.to_s
+    
+    # Double digit second
+    s << "0" unless self.sec > 9 
+    s << self.sec.to_s
+
+    # UTC time gets a Z suffix
+    if utc
+      s << "Z"
+    end
+
+    s
+  end
+end