vpim 0.17 → 0.323

data/lib/vpim/property/common.rb

@@ -0,0 +1,159 @@
+module Vpim
+  class Icalendar
+    module Property
+
+      # Properties common to Vevent, Vtodo, and Vjournal.
+      module Common
+
+        # This property defines the access classification for a calendar
+        # component.
+        #
+        # An access classification is only one component of the general
+        # security system within a calendar application. It provides a method
+        # of capturing the scope of the access the calendar owner intends for
+        # information within an individual calendar entry. The access
+        # classification of an individual iCalendar component is useful when
+        # measured along with the other security components of a calendar
+        # system (e.g., calendar user authentication, authorization, access
+        # rights, access role, etc.). Hence, the semantics of the individual
+        # access classifications cannot be completely defined by this memo
+        # alone. Additionally, due to the "blind" nature of most exchange
+        # processes using this memo, these access classifications cannot serve
+        # as an enforcement statement for a system receiving an iCalendar
+        # object.  Rather, they provide a method for capturing the intention of
+        # the calendar owner for the access to the calendar component.
+        #
+        # Property Name: CLASS
+        #
+        # Property Value: one of "PUBLIC", "PRIVATE", "CONFIDENTIAL", default
+        # is "PUBLIC" if no CLASS property is found.
+        def access_class
+          proptoken 'CLASS', ["PUBLIC", "PRIVATE", "CONFIDENTIAL"], "PUBLIC"
+        end
+
+        def created
+          proptime 'CREATED'
+        end
+
+        # Description of the calendar component, or nil if there is no description.
+        def description
+          proptext 'DESCRIPTION'
+        end
+
+        # The time stamp for this calendar component.
+        def dtstamp
+          proptime 'DTSTAMP'
+        end
+
+        # The start time for this calendar component.
+        def dtstart
+          proptime 'DTSTART'
+        end
+
+        def lastmod
+          proptime 'LAST-MODIFIED'
+        end
+
+        # Return the event organizer, an object of Icalendar::Address (or nil if
+        # there is no ORGANIZER field).
+        def organizer
+          organizer = @properties.field('ORGANIZER')
+
+          if organizer
+            organizer = Icalendar::Address.new(organizer)
+          end
+
+          organizer.freeze
+        end
+
+=begin
+recurid
+seq
+=end
+
+        # Status values are not rejected during decoding. However, if the
+        # status is requested, and it's value is not one of the defined
+        # allowable values, an exception is raised.
+        def status
+          case self
+          when Vpim::Icalendar::Vevent
+            proptoken 'STATUS', ['TENTATIVE', 'CONFIRMED', 'CANCELLED']
+
+          when Vpim::Icalendar::Vtodo
+            proptoken 'STATUS', ['NEEDS-ACTION', 'COMPLETED', 'IN-PROCESS', 'CANCELLED']
+
+          when Vpim::Icalendar::Vevent
+            proptoken 'STATUS', ['DRAFT', 'FINAL', 'CANCELLED']
+          end
+        end
+
+        # TODO - def status? ...
+
+        # TODO - def status= ...
+
+        # Summary description of the calendar component, or nil if there is no
+        # SUMMARY property.
+        def summary
+          proptext 'SUMMARY'
+        end
+
+        # The unique identifier of this calendar component, a string.
+        def uid
+          proptext 'UID'
+        end
+
+        def url
+          propvalue 'URL'
+        end
+
+        # Return an array of attendees, an empty array if there are none. The
+        # attendees are objects of Icalendar::Address. If +uri+ is specified
+        # only the return the attendees with this +uri+.
+        def attendees(uri = nil)
+          attendees = @properties.enum_by_name('ATTENDEE').map { |a| Icalendar::Address.new(a).freeze }
+          attendees.freeze
+          if uri
+            attendees.select { |a| a == uri }
+          else
+            attendees
+          end
+        end
+
+        # Return true if the +uri+, usually a mailto: URI, is an attendee.
+        def attendee?(uri)
+          attendees.include? uri
+        end
+
+        # categories = "CATEGORIES" catparam ":" text *("," text)
+        # comment    = "COMMENT" commparam ":" text
+        # contact    = "CONTACT" contparam ":" text
+
+        # This property defines the categories for a calendar component.
+        #
+        # Property Name: CATEGORIES
+        #
+        # Value Type: TEXT
+        #
+        # Ruby Type: Array of String
+        #
+        # This property is used to specify categories or subtypes of the
+        # calendar component. The categories are useful in searching for a
+        # calendar component of a particular type and category.
+        def categories
+          proptextlistarray 'CATEGORIES'
+        end
+
+        def comments
+          proptextarray 'COMMENT'
+        end
+
+        def contacts
+          proptextarray 'CONTACT'
+        end
+
+      end
+    end
+  end
+end
+
+

data/lib/vpim/property/location.rb

@@ -0,0 +1,29 @@
+module Vpim
+  class Icalendar
+    module Property
+      module Location
+        # Physical location information relevant to the component, or nil if
+        # there is no LOCATION property.
+        def location
+          proptext 'LOCATION'
+        end
+
+        # Array of Float, +[ latitude, longitude]+.
+        #
+        # North or equator is postive latitude, East of meridian is positive logitude.
+        #
+        # See RFC2445 for more info... there are lots of special cases.
+        def geo
+          prop = @properties.detect { |f| f.name? 'GEO' }
+          if prop
+            prop = Vpim.decode_list(prop.value_raw, ';') do |item| item.to_f end
+          end
+          prop
+        end
+
+      end
+    end
+  end
+end
+
+

data/lib/vpim/property/priority.rb

@@ -0,0 +1,35 @@
+module Vpim
+  class Icalendar
+    module Property
+      module Priority
+
+        # +priority+ is a number from 1 to 9, with 1 being the highest
+        # priority, 9 being the lowest. 0 means "no priority", equivalent to
+        # not specifying the PRIORITY field.
+        #
+        # The other integer values are reserved by RFC2445.
+        #
+        # TODO
+        # - methods to compare priorities?
+        # - return as class Priority, with #to_i, and #to_s, and appropriate
+        #   comparison operators?
+        def priority
+          p = @properties.detect { |f| f.name? 'PRIORITY' }
+          
+          if !p
+            p = 0
+          else
+            p = p.value.to_i
+
+            if( p < 0 || p > 9 )
+              raise Vpim::InvalidEncodingError, 'Invalid priority #{@priority} - it must be 0-9!'
+            end
+          end
+          p
+        end
+      end
+    end
+  end
+end
+
+

data/lib/vpim/property/resources.rb

@@ -0,0 +1,16 @@
+module Vpim
+  class Icalendar
+    module Property
+
+      module Resources
+
+        def resources
+          proptextlistarray 'RESOURCES'
+        end
+
+      end
+    end
+  end
+end
+
+

data/lib/vpim/rfc2425.rb

@@ -190,9 +190,25 @@ module Vpim
   # \n -> NL
   # \N -> NL
   # \, -> ,
+  # \; -> ;
   def Vpim.decode_text(v) # :nodoc:
-    # FIXME - this will fail for "\\,"!
-    v.gsub(/\\[nN]/, "\n").gsub(/\\,/, ",").gsub(/\\\\/) { |m| "\\" }
+    v.gsub(/\\(.)/) do
+      case $1
+      when '\\', ',', ';'
+        $1
+      when 'n', 'N' 
+        "\n"
+      else
+        raise Vpim::InvalidEncodingError, "TEXT #{v.inspect} uses invalid escape sequence '\\#{$1}'"
+      end
+    end
+  end
+
+  # Convert a +sep+-seperated list of TEXT values into an array of values.
+  def Vpim.decode_text_list(value, sep = ',') # :nodoc:
+    value.scan(/((?:(?:\\.)|[^#{sep}])+)#{sep}?/).map do |v|
+      Vpim.decode_text(v.first)
+    end
   end
 
 
@@ -216,13 +232,13 @@ module Vpim
     current = [ dst ]
 
     for f in src
-      if f.name? 'begin'
+      if f.name? 'BEGIN'
         e = [ f ]
 
         current.last.push(e)
         current.push(e)
 
-      elsif f.name? 'end'
+      elsif f.name? 'END'
         current.last.push(f)
 
         unless current.last.first.value? current.last.last.value
@@ -243,6 +259,7 @@ module Vpim
   # an array of all the inner arrays of fields. Return the array [outer,
   # inner].
   def Vpim.outer_inner(fields) #:nodoc:
+    # FIXME - use Enumerable#partition
     # seperate into the outer-level fields, and the arrays of component
     # fields
     outer = []

data/lib/vpim/rrule.rb

@@ -144,7 +144,7 @@ module Vpim
       # Time.to_a => [ sec, min, hour, day, month, year, wday, yday, isdst, zone ]
 
       # Every event occurs at least once, at its start time, but only if the start
-      # time is earlier than 'dountil'...
+      # time is earlier than DOUNTIL...
       if !@rrule
         if !dountil || t < dountil
           yield t

data/lib/vpim/vcard.rb

@@ -55,9 +55,9 @@ module Vpim
   # Here's an example of encoding a simple vCard using the low-level API:
   #
   #   card = Vpim::Vcard.create
-  #   card << Vpim::DirectoryInfo::Field.create('email', 'user.name@example.com', 'type' => 'internet' )
-  #   card << Vpim::DirectoryInfo::Field.create('url', 'http://www.example.com/user' )
-  #   card << Vpim::DirectoryInfo::Field.create('fn', 'User Name' )
+  #   card << Vpim::DirectoryInfo::Field.create('EMAIL', 'user.name@example.com', 'TYPE' => 'INTERNET' )
+  #   card << Vpim::DirectoryInfo::Field.create('URL', 'http://www.example.com/user' )
+  #   card << Vpim::DirectoryInfo::Field.create('FN', 'User Name' )
   #   puts card.to_s
   class Vcard < DirectoryInfo
 
@@ -154,7 +154,7 @@ module Vpim
 
     # The value of the field named +name+, optionally limited to fields of
     # type +type+. If no match is found, nil is returned, if multiple matches
-    # are found, the first match to have one of its type values be 'pref'
+    # are found, the first match to have one of its type values be 'PREF'
     # (preferred) is returned, otherwise the first match is returned.
     def [](name, type=nil)
       fields = enum_by_name(name).find_all { |f| type == nil || f.type?(type) }
@@ -226,7 +226,7 @@ module Vpim
 
     # Deprecated.
     def nickname #:nodoc:
-      nn = self['nickname']
+      nn = self['NICKNAME']
       if nn && nn == ''
         nn = nil
       end

data/lib/vpim/version.rb

@@ -0,0 +1,16 @@
+=begin
+  Copyright (C) 2006 Sam Roberts
+
+  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 Vpim
+  VERSION = "0.323"
+
+  # Return the API version as a string.
+  def Vpim.version
+    VERSION
+  end
+end