vpim2 0.0.1

data/samples/README.mutt

@@ -0,0 +1,93 @@
+
+** cmd-itip.rb
+
+This script pretty-prints iTIP calendar invitations, often sent by email using iMIP
+as text/calendar objects.
+
+Download the latest vPim from:
+
+  http://rubyforge.org/projects/vpim/
+
+It requires Ruby to be installed.
+
+Install vpim:
+
+  tar -xzf vpim-XX.tgz
+  cd vpim-XX
+  ruby install.rb config
+  ruby install.rb setup
+  sudo ruby install.rb install
+
+Install cmd-itip.rb into your path, perhaps without the extension.
+
+  cp samples/cmd-itip.rb ~/bin/cmd-itip
+  chmod +x ~/bin/cmd-itip
+
+Modify your ~/.mailcap or /etc/mailcap files to call cmd-itip, add a line like:
+
+  text/calendar; cmd-itip --myaddr "sroberts@" %s; copiousoutput
+
+If you give a REGEX to --myaddr to tell cmd-itip your email addresses, cmd-itip
+will avoid printing some information on the attendees to an invitation.
+
+Modify muttrc to autoview calendars with a command like:
+
+  auto_view text/calendar
+
+Notes on Notes;
+
+Because Domino sends a close-to-unreadable text/plain attachment along with the
+text/calendar in a multipart/alternative, and the text/plain is first in the
+alternatives, the garbage will be at the top, and the nicely printed calendar
+at the bottom. Because of this, I reorder the view preference so the calendar
+invitation is clearly printed at the top of the message with a muttrc command
+like:
+
+ alternative_order text/calendar text/plain
+
+Domino also includes the calendar twice in the mail message, so you'll see it
+twice, I don't know what to do about that.
+
+Notes on application/octet-stream:
+
+Some calendar programs, such as Apple's Mail.app, wrongly send iCalendar attachments
+with a content-type of application/octet-stream. In order to be processed correctly, use
+the mutt 1.5 or later capability to lookup the correct MIME content-type based on the
+file extension. Put this in your muttrc file:
+
+ mime_lookup application/octet-stream
+
+and ensure /etc/mime.types or ~/.mime.types contains:
+
+  text/calendar       ics
+
+
+
+** vcf-to-mutt.rb
+
+This script searches a set of vCards can output the results as a Mutt query response,
+or a Mutt aliases file.
+
+It used to support querying the OS X Address Book, but that is better done with lbdb, see
+http://www.spinnaker.de/lbdb/.
+
+To install, you must:
+
+1 - install vPim (see README)
+
+3 - copy vcf-to-mutt into a directory in your path, such
+    as ~/bin, and chmod +x vcf-to-mutt.rb to make it executable.
+
+4 - Put in your muttrc file (either ~/.muttrc or ~/.mutt/muttrc) a line such as:
+
+set query_command = "vcf-to-mutt.rb '%s'"
+
+5 - The query command ("Q") will query the address book, control-t will give you auto-completion
+    of email addresses, see the Mutt manual page.
+
+
+** mutt-aliases-to-vcf.rb
+
+This script converts a mutt aliases file into a vCard file.
+
+

data/samples/ab-query.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+$-w = true
+$:.unshift File.dirname($0) + '/../lib'
+
+require 'osx-wrappers'
+
+require 'getoptlong'
+require 'vpim/vcard'
+require 'osx-wrappers'
+
+HELP =<<EOF
+Usage: ab-query.rb [--me] [--all]
+
+Queries the OS X Address Book for vCards.
+
+ -h, --help print this helpful message
+ -m, --me   list my vCard
+ -a, --all  list all vCards
+EOF
+
+opts = GetoptLong.new(
+  [ "--help",    "-h",              GetoptLong::NO_ARGUMENT ],
+  [ "--me",      "-m",              GetoptLong::NO_ARGUMENT ],
+  [ "--all",     "-a",              GetoptLong::NO_ARGUMENT ]
+)
+
+abook = nil
+
+opts.each do |opt, arg|
+  case opt
+    when "--help" then
+      puts HELP
+      exit 0
+
+    when "--all" then
+      abook = OSX::ABAddressBook.sharedAddressBook unless abook
+
+      abook.people.to_a.each {
+        |person|
+
+        puts person.vCard
+      }
+
+    when "--me" then
+     abook = OSX::ABAddressBook.sharedAddressBook unless abook
+
+     puts abook.me.vCard
+  end
+end
+
+
+unless abook
+  puts HELP
+  exit 1
+end
+

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.occurrences.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
+