vpim 0.597 → 0.602

data/samples/cmd-itip.rb

@@ -0,0 +1,156 @@
+#!/usr/bin/env ruby
+
+$-w = true
+$:.unshift File.dirname($0) + '/../lib'
+
+require 'getoptlong'
+
+require 'vpim/icalendar'
+require 'vpim/duration'
+
+include Vpim
+
+# TODO - $0 is the full path, fix it.
+HELP =<<EOF
+Usage: #{$0} <invitation.ics>
+
+Options
+  -h,--help         Print this helpful message.
+  -d,--debug        Print debug information.
+
+  -m,--my-addrs     My email addresses, a REGEX.
+Examples:
+EOF
+
+opt_debug = nil
+opt_print = true
+
+# Ways to get this:
+#  Use a --mutt option, and steal it from muttrc,
+#  from $USER, $LOGNAME,, from /etc/passwd...
+opt_myaddrs = nil
+
+opts = GetoptLong.new(
+  [ "--help",    "-h",   GetoptLong::NO_ARGUMENT ],
+
+  [ "--myaddrs", "-m",   GetoptLong::REQUIRED_ARGUMENT ],
+
+  [ "--accept",  "-a",   GetoptLong::REQUIRED_ARGUMENT ],
+  [ "--reject",  "-r",   GetoptLong::REQUIRED_ARGUMENT ],
+  [ "--debug",   "-d",   GetoptLong::NO_ARGUMENT ]
+)
+
+opts.each do |opt, arg|
+  case opt
+    when "--help" then
+      puts HELP
+      exit 0
+
+    when "--debug" then
+      require 'pp'
+      opt_debug = true
+
+    when "--myaddrs" then
+      opt_myaddrs = Regexp.new(arg, 'i')
+  end
+end
+
+if ARGV.length < 1
+  puts "no input files specified, try -h!\n"
+  exit 1
+end
+
+ARGV.each do |file|
+  cals = Vpim::Icalendar.decode(File.open(file))
+
+  cals.each do |cal|
+    if opt_debug
+      puts "vCalendar: version=#{cal.version/10.0} producer='#{cal.producer}'"
+      if cal.protocol; puts "  protocol-method=#{cal.protocol}"; end
+    end
+
+    events = cal.events
+
+    if events.size != 1
+      raise "!! #{events.size} calendar events is more than 1!"
+    end
+
+    events.each do |e|
+      summary = e.summary || e.comment || ''
+
+      case cal.protocol.upcase
+        when 'PUBLISH'
+          puts "Notification of:  #{summary}"
+
+        when 'REQUEST'
+          puts "Request for:  #{summary}"
+
+        when 'REPLY'
+
+        else
+          raise "!! unhandled protocol type #{cal.protocol}!"
+      end
+
+      puts "Organized by: #{e.organizer.to_s}"
+
+      # TODO - spec as hours/mins/secs
+      e.occurences.each_with_index do |t, i|
+        if(i < 1)
+          puts "At time: #{t}" +( e.duration ? " for #{Duration.secs(e.duration).to_s}" : '' )
+        else
+          puts "... and others"
+          break
+        end
+      end
+
+      if e.location;     puts "Located at: #{e.location}"; end
+
+      if e.description
+        puts finish="-- Description --"
+        puts e.description
+      end
+
+      if e.comments
+        puts finish="-- Comment --"
+        puts "   comment=#{e.comments}"
+      end
+
+      if e.attendees.first
+
+        puts finish="-- Attendees --"
+
+        e.attendees.each_with_index do |a,i|
+          puts "#{i} #{a.to_s}"
+          if !opt_myaddrs || a.uri =~ opt_myaddrs
+            puts "  participation-status: #{a.partstat ? a.partstat.downcase : 'unknown'}"
+            puts "  response-requested? #{a.rsvp ? 'yes' : 'no'}"
+          end
+        end
+      end
+
+      if finish
+        puts '-' * finish.length
+      end
+
+      if opt_debug
+        if e.status;       puts "   status=#{e.status}"; end
+                           puts "   uid=#{e.uid}"
+                           puts "   dtstamp=#{e.dtstamp.to_s}"
+                           puts "   dtstart=#{e.dtstart.to_s}"
+        if e.dtend;        puts "     dtend=#{e.dtend.to_s}"; end
+        if e.rrule;        puts "   rrule=#{e.rrule}"; end
+      end
+    end
+
+    todos = cal.todos
+    todos.each do |e|
+      s = e.status ? " (#{e.status})" : ''
+      puts "Todo#{s}: #{e.summary}"
+    end
+
+    if opt_debug
+      pp cals
+    end
+  end
+end
+

data/samples/ex_cpvcard.rb

@@ -0,0 +1,55 @@
+require 'vpim/vcard'
+
+ORIGINAL =<<'---'
+BEGIN:VCARD
+VERSION:3.0
+FN:Jimmy Death
+N:Death;Jimmy;;Dr.;
+TEL:+416 123 1111
+TEL;type=home,pref:+416 123 2222
+TEL;type=work,fax:+416+123+3333
+EMAIL;type=work:drdeath@work.com
+EMAIL;type=pref:drdeath@home.net
+NOTE:Do not call.
+END:VCARD
+---
+
+original = Vpim::Vcard.decode(ORIGINAL).first
+
+puts original
+
+modified = Vpim::Vcard::Maker.make2 do |maker|
+  # Set the fullname field to use family-given name order.
+  maker.name do |n|
+    n.fullname = "#{original.name.family} #{original.name.given}"
+  end
+
+  # Copy original fields, with some changes:
+  # - set only work email addresses and telephone numbers to be preferred.
+  # - don't copy notes
+  maker.copy(original) do |field|
+    if field.name? 'EMAIL'
+      field = field.copy
+      field.pref = field.type? 'work'
+    end
+    if field.name? 'TEL'
+      field = field.copy
+      field.pref = field.type? 'work'
+    end
+    if field.name? 'NOTE'
+      field = nil
+    end
+    field
+  end
+end
+
+puts '---'
+puts modified
+
+Vpim::Vcard::Maker.make2(modified) do |maker|
+  maker.nickname = "Your Last Friend"
+end
+
+puts '---'
+puts modified
+

data/samples/ex_get_vcard_photo.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+
+require 'vpim/vcard'
+
+vcf = open(ARGV[0] || 'data/vcf/Sam Roberts.vcf')
+
+card = Vpim::Vcard.decode(vcf).first
+
+card.photos.each_with_index do |photo, i|
+  file = "_photo_#{i}."
+
+  if photo.format
+    file += photo.format.gsub('/', '_')
+  else
+    # You are your own if PHOTO doesn't include a format. AddressBook.app
+    # exports TIFF, for example, but doesn't specify that.
+    file += 'tiff'
+  end
+
+  open(file, 'w').write photo.to_s
+end
+

data/samples/ex_mkv21vcard.rb

@@ -0,0 +1,34 @@
+# Note that while most version 3.0 vCards should be valid 2.1 vCards, they
+# aren't guaranteed to be. vCard 2.1 is reasonably well supported on decode,
+# I'm not sure how well it works on encode.
+#
+# Most things should work, but you should test whether this works with your 2.1
+# vCard decoder. Also, avoid base64 encoding, or do it manually.
+require 'vpim/vcard'
+
+# Create a new 2.1 vCard.
+card21 = Vpim::DirectoryInfo.create(
+  [
+    Vpim::DirectoryInfo::Field.create('VERSION', '2.1')
+  ], 'VCARD')
+
+Vpim::Vcard::Maker.make2(card21) do |maker|
+  maker.name do |n|
+    n.prefix = 'Dr.'
+    n.given = 'Jimmy'
+    n.family = 'Death'
+  end
+
+end
+
+puts card21
+
+# Copy and modify a 2.1 vCard, preserving it's version.
+mod21 = Vpim::Vcard::Maker.make2(Vpim::DirectoryInfo.create([], 'VCARD')) do |maker|
+  maker.copy card21
+  maker.nickname = 'some name'
+end
+
+puts '---'
+puts mod21
+

data/samples/ex_mkvcard.rb

@@ -0,0 +1,64 @@
+require 'vpim/vcard'
+
+card = Vpim::Vcard::Maker.make2 do |maker|
+  maker.add_name do |name|
+    name.prefix = 'Dr.'
+    name.given = 'Jimmy'
+    name.family = 'Death'
+  end
+
+  maker.add_addr do |addr|
+    addr.preferred = true
+    addr.location = 'work'
+    addr.street = '12 Last Row, 13th Section'
+    addr.locality = 'City of Lost Children'
+    addr.country = 'Cinema'
+  end
+
+  maker.add_addr do |addr|
+    addr.location = [ 'home', 'zoo' ]
+    addr.delivery = [ 'snail', 'stork', 'camel' ]
+    addr.street = '12 Last Row, 13th Section'
+    addr.locality = 'City of Lost Children'
+    addr.country = 'Cinema'
+  end
+
+  maker.nickname = "The Good Doctor"
+
+  maker.birthday = Date.today
+
+  maker.add_photo do |photo|
+    photo.link = 'http://example.com/image.png'
+  end
+
+  maker.add_photo do |photo|
+    photo.image = "File.open('drdeath.jpg').read # a fake string, real data is too large :-)"
+    photo.type = 'jpeg'
+  end
+
+  maker.add_tel('416 123 1111')
+
+  maker.add_tel('416 123 2222') { |t| t.location = 'home'; t.preferred = true }
+
+  maker.add_impp('joe') do |impp|
+    impp.preferred = 'yes'
+    impp.location = 'mobile'
+  end
+
+  maker.add_x_aim('example') do |xaim|
+    xaim.location = 'row12'
+  end
+
+  maker.add_tel('416-123-3333') do |tel|
+    tel.location = 'work'
+    tel.capability = 'fax'
+  end
+
+  maker.add_email('drdeath@work.com') { |e| e.location = 'work' }
+
+  maker.add_email('drdeath@home.net') { |e| e.preferred = 'yes' }
+
+end
+
+puts card
+

data/samples/ex_mkyourown.rb

@@ -0,0 +1,29 @@
+require 'vpim/vcard'
+
+module Vpim
+  class  Vcard
+    class Maker
+      # Add a user-defined field, X-MY-OWN:.
+      #
+      # This can be done both to encode custom fields, or to add support for
+      # fields that Vcard::Maker doesn't support. In the latter case, please
+      # submit your methods so I can add them to vPim.
+      def add_my_own(value)
+        @card << Vpim::DirectoryInfo::Field.create( 'X-MY-OWN', value.to_str );
+      end
+    end
+  end
+end
+
+
+card = Vpim::Vcard.create # ... or load from somewhere
+
+Vpim::Vcard::Maker.make2(card) do |m|
+  m.add_name do |n|
+    n.given = 'Given'
+  end
+  m.add_my_own 'my value'
+end
+
+puts card
+

data/samples/ics-dump.rb

@@ -0,0 +1,210 @@
+#!/usr/bin/env ruby
+#
+# Calendars are in ~/Library/Calendars/
+
+$-w = true
+$:.unshift File.dirname($0) + '/../lib'
+
+require 'getoptlong'
+require 'pp'
+require 'open-uri'
+
+require 'vpim/icalendar'
+require 'vpim/duration'
+
+include Vpim
+
+HELP =<<EOF
+Usage: #{$0} <vcard>...
+
+Options
+  -h,--help         Print this helpful message.
+  -n,--node         Dump as nodes.
+  -d,--debug        Print debug information.
+  -m,--metro        Convert metro.
+
+Examples:
+EOF
+
+opt_debug = nil
+opt_node  = false
+
+opts = GetoptLong.new(
+  [ "--help",    "-h",   GetoptLong::NO_ARGUMENT ],
+  [ "--node",    "-n",   GetoptLong::NO_ARGUMENT ],
+  [ "--debug",   "-d",   GetoptLong::NO_ARGUMENT ]
+)
+
+opts.each do |opt, arg|
+  case opt
+    when "--help" then
+      puts HELP
+      exit 0
+
+    when "--node" then
+      opt_node = true
+
+    when "--debug" then
+      opt_debug = true
+  end
+end
+
+if ARGV.length < 1
+  puts "no input files specified, try -h!\n"
+  exit 1
+end
+
+if opt_node
+
+  ARGV.each do |file|
+    tree = Vpim.expand(Vpim.decode(File.open(file).read(nil)))
+    pp tree
+  end
+
+  exit 0
+end
+
+def v2s(v)
+  case v
+  when Vpim::Icalendar::Attachment
+    if v.binary
+      "#{v.format.inspect} binary #{v.binary.inspect}"
+    else
+      s = "#{v.format.inspect} uri #{v.uri.inspect}"
+      begin
+        s << " #{v.value.gets.inspect}..."
+      rescue
+        s << " (#{$!.class})"
+      end
+    end
+  else
+    v #.inspect
+  end
+end
+
+
+def puts_properties(c)
+  [
+    :access_class,
+    :attachments,
+    :categories,
+    :comments,
+    :completed,
+    :contacts,
+    :created,
+    :description,
+    :dtend,
+    :dtstamp,
+    :dtstart,
+    :due,
+    :geo,
+    :location,
+    :organizer,
+    :percent_complete,
+    :priority,
+    :sequence,
+    :status,
+    :summary,
+    :transparency,
+    :uid,
+    :url,
+  ].each do |m|
+    if c.respond_to? m
+      v = c.send(m)
+      case v
+      when Array
+        v.each_with_index do |v,i|
+          puts "  #{m}[#{i}]=<#{v2s v}>"
+        end
+      else
+        if v
+          puts "  #{m}=<#{v2s v}>"
+        end
+      end
+    end
+  end
+
+  begin
+    if c.duration;     puts "   duration=#{Duration.secs(c.duration).to_s}"; end
+  rescue NoMethodError
+  end
+
+  c.attendees.each_with_index do |a,i|
+    puts "  attendee[#{i}]=#{a.to_s}"
+    puts "   role=#{a.role.upcase} participation-status=#{a.partstat.upcase} rsvp?=#{a.rsvp ? 'yes' : 'no'}"
+  end
+
+  [
+    'RRULE',
+    'RDATE',
+    'EXRULE',
+    'EXDATE',
+  ].each do |m|
+    c.propvaluearray(m).each_with_index do |v,i|
+      puts "  #{m}[#{i}]=<#{v.to_s}>"
+
+      case
+      when i == 1 && m != 'RRULE'
+        # Anything that isn't an RRULE isn't supported at all.
+        puts "  ==> #{m} is unsupported!"
+      when i == 2 && m == 'RRULE'
+        # If there was more than 1 RRULE, its not supported.
+        puts "  ==> More than one RRULE is unsupported!"
+      end
+    end
+  end
+
+  begin
+    c.occurences.each_with_index do |t, i|
+      if(i < 10)
+        puts "   #{i+1} -> #{t}"
+      else
+        puts "   ..."
+        break;
+      end
+    end
+  rescue ArgumentError
+    # No occurences.
+  end
+
+end
+
+ARGV.each do |file|
+  puts "===> ", file
+  cals = Vpim::Icalendar.decode(
+    (file == "-") ? $stdin : open(file)
+    )
+
+  cals.each_with_index do |cal, i|
+    if i > 0
+      puts
+    end
+
+    puts "Icalendar[#{i}]:"
+    puts " version=#{cal.version/10.0}"
+    puts " producer=#{cal.producer}"
+
+    if cal.protocol; puts " protocol=#{cal.protocol}"; end
+
+    events = cal.events
+
+    cal.components.each_with_index do |c, i|
+        puts " #{c.class.to_s.sub(/.*::/,'')}[#{i}]:"
+
+        begin
+          puts_properties(c)
+        rescue => e
+          cb = e.backtrace
+          pp e
+          print cb.shift, ":", e.message, " (", e.class, ")\n"
+          cb.each{|c| print "\tfrom ", c, "\n"}
+          exit 1
+        end
+    end
+
+    if opt_debug
+      pp cals
+    end
+  end
+end
+

data/samples/ics-to-rss.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+#
+# Call with --print to print RSS to stdout, otherwise it runs as a WEBrick
+# servelet on port 8080.
+#
+# This comes from an idea of Dave Thomas' that he described here:
+#
+#   http://pragprog.com/pragdave/Tech/Blog/ToDos.rdoc
+#
+# He generously sent me his code, and I reimplemented it with vPim and rss/maker.
+#
+# RSS Content-Types:
+#
+#   RSS 1.0 -> application/rdf+xml
+#   RSS 2.0 -> text/xml
+#   RSS 0.9 -> text/xml
+#   ATOM    -> application/xml
+
+require 'rss/maker'
+require 'vpim/icalendar'
+
+class IcalToRss
+  def initialize(calendars, title, link, language = 'en-us')
+    @rss = RSS::Maker.make("0.9") do |maker|
+      maker.channel.title = title
+      maker.channel.link = link
+      maker.channel.description = title
+      maker.channel.language = language
+
+      # These are required, or RSS::Maker silently returns nil!
+      maker.image.url = "maker.image.url"
+      maker.image.title = "maker.image.title"
+
+      calendars.each do |file|
+        Vpim::Icalendar.decode(File.open(file)).each do |cal|
+          cal.todos.each do |todo|
+            if !todo.status || todo.status.upcase != "COMPLETED"
+              item = maker.items.new_item
+              item.title = todo.summary
+              item.link =  todo.properties['url'] || link
+              item.description = todo.description || todo.summary
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def to_rss
+    @rss.to_s
+  end
+end
+
+TITLE = "Sam's ToDo List"
+LINK  = "http://ensemble.local/~sam"
+
+if ARGV[0] == "--print"
+
+  puts IcalToRss.new( Dir[ "/Users/sam/Library/Calendars/*.ics" ], TITLE, LINK ).to_rss
+
+else
+
+  require 'webrick'
+
+  class IcalRssTodoServlet < WEBrick::HTTPServlet::AbstractServlet
+    def do_GET(req, resp)   
+      resp.body = IcalToRss.new( Dir[ "/Users/sam/Library/Calendars/*.ics" ], TITLE, LINK ).to_rss
+      resp['content-type'] = 'text/xml'
+      raise WEBrick::HTTPStatus::OK
+    end
+  end
+
+  server = WEBrick::HTTPServer.new( :Port => 8080 )
+
+  server.mount( '/', IcalRssTodoServlet )
+
+  ['INT', 'TERM'].each { |signal| 
+    trap(signal) { server.shutdown }
+  }
+
+  server.start
+
+end
+

data/samples/mutt-aliases-to-vcf.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+$-w = true
+$:.unshift File.dirname($0) + '/../lib'
+
+require 'vpim/vcard'
+
+ARGV.each do |file|
+
+  File.open(file).each do |line|
+
+    if line =~ /\s*alias\s+(\w+)\s+(.*)/
+      nick = $1
+      rhs  = $2
+      email = nil
+      name = nil
+
+      case rhs
+        when /(.*)<(.*)>/
+          email = $2
+          name = $1
+        else
+          email = rhs
+          name = nick
+          nick = nil
+      end
+
+      card = Vpim::Vcard::Maker.make2 do |maker|
+        # don't have the broken-down name, we'll have to leave it blank
+        maker.name { |n| n.fullname = name }
+
+        # Set preferred, its the only one...
+        maker.add_email( email ) { |e| e.preferred = true }
+
+        maker.nickname = nick if nick
+       
+        # mark as auto-generated, it makes it easier to see them
+        maker.add_field( Vpim::DirectoryInfo::Field.create('note', "auto-generated-from-mutt-aliases") )
+      end
+
+      puts card.to_s
+    end
+  end
+end
+