RubyGems - mumboe-vpim - Versions diffs - 0.7 - Mend

mumboe-vpim 0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (69) hide show

data/CHANGES +510 -0
data/COPYING +58 -0
data/README +185 -0
data/lib/vpim/address.rb +219 -0
data/lib/vpim/agent/atomize.rb +104 -0
data/lib/vpim/agent/base.rb +73 -0
data/lib/vpim/agent/calendars.rb +173 -0
data/lib/vpim/agent/handler.rb +26 -0
data/lib/vpim/agent/ics.rb +161 -0
data/lib/vpim/attachment.rb +102 -0
data/lib/vpim/date.rb +222 -0
data/lib/vpim/dirinfo.rb +277 -0
data/lib/vpim/duration.rb +119 -0
data/lib/vpim/enumerator.rb +32 -0
data/lib/vpim/field.rb +614 -0
data/lib/vpim/icalendar.rb +384 -0
data/lib/vpim/maker/vcard.rb +16 -0
data/lib/vpim/property/base.rb +193 -0
data/lib/vpim/property/common.rb +315 -0
data/lib/vpim/property/location.rb +38 -0
data/lib/vpim/property/priority.rb +43 -0
data/lib/vpim/property/recurrence.rb +69 -0
data/lib/vpim/property/resources.rb +24 -0
data/lib/vpim/repo.rb +261 -0
data/lib/vpim/rfc2425.rb +367 -0
data/lib/vpim/rrule.rb +591 -0
data/lib/vpim/time.rb +40 -0
data/lib/vpim/vcard.rb +1456 -0
data/lib/vpim/version.rb +18 -0
data/lib/vpim/vevent.rb +187 -0
data/lib/vpim/view.rb +90 -0
data/lib/vpim/vjournal.rb +58 -0
data/lib/vpim/vpim.rb +65 -0
data/lib/vpim/vtodo.rb +103 -0
data/lib/vpim.rb +13 -0
data/samples/README.mutt +93 -0
data/samples/ab-query.rb +57 -0
data/samples/agent.ru +10 -0
data/samples/cmd-itip.rb +156 -0
data/samples/ex_cpvcard.rb +55 -0
data/samples/ex_get_vcard_photo.rb +22 -0
data/samples/ex_mkv21vcard.rb +34 -0
data/samples/ex_mkvcard.rb +64 -0
data/samples/ex_mkyourown.rb +29 -0
data/samples/ics-dump.rb +210 -0
data/samples/ics-to-rss.rb +84 -0
data/samples/mutt-aliases-to-vcf.rb +45 -0
data/samples/osx-wrappers.rb +86 -0
data/samples/reminder.rb +209 -0
data/samples/rrule.rb +71 -0
data/samples/tabbed-file-to-vcf.rb +390 -0
data/samples/vcf-dump.rb +86 -0
data/samples/vcf-lines.rb +61 -0
data/samples/vcf-to-ics.rb +22 -0
data/samples/vcf-to-mutt.rb +121 -0
data/test/test_agent_atomize.rb +84 -0
data/test/test_agent_calendars.rb +128 -0
data/test/test_agent_ics.rb +96 -0
data/test/test_all.rb +17 -0
data/test/test_date.rb +120 -0
data/test/test_dur.rb +41 -0
data/test/test_field.rb +156 -0
data/test/test_ical.rb +437 -0
data/test/test_misc.rb +13 -0
data/test/test_repo.rb +129 -0
data/test/test_rrule.rb +1030 -0
data/test/test_vcard.rb +973 -0
data/test/test_view.rb +79 -0
metadata +140 -0

data/lib/vpim/agent/calendars.rb ADDED Viewed

@@ -0,0 +1,173 @@
+=begin
+  Copyright (C) 2008 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
+require "cgi"
+require "uri"
+require "vpim/repo"
+require "vpim/agent/atomize"
+module Vpim
+  module Agent
+    # On failure, raise this with an error message. text/plain for now,
+    # text/html later. Will convert to a 404 and a message.
+    class NotFound < Exception
+      def initialize(name, path)
+        super %{Resource "#{name}" under "#{path.prefix}" was not found!}
+      end
+    end
+    class Path
+      def self.split_path(path)
+        begin
+          path = path.to_ary
+        rescue NameError
+          path = path.split("/")
+        end
+        path.map{|w| CGI.unescape(w)}
+      end
+      # URI is the uri being queried, base is where this path is mounted under?
+      def initialize(uri, base = "")
+        @uri  = URI.parse(uri.to_s)
+        #pp [uri, base, @uri]
+       if @uri.path.size == 0
+         @uri.path = "/"
+       end
+        @path = Path.split_path(@uri.path)
+        @base = base.to_str
+        @mark = 0
+        @base.split.size.times{ shift }
+      end
+      def uri
+        @uri.to_s
+      end
+      def to_path
+        self
+      end
+      # TODO - call this #next
+      def shift
+        if @path[@mark]
+          @path[@mark += 1]
+        end
+      end
+      def append(name, scheme = nil)
+        uri = @uri.dup
+        uri.path += "/" + CGI.escape(name)
+        if scheme
+          uri.scheme = scheme
+        end
+        uri
+      end
+      def prefix(len = nil)
+        len ||= @mark
+        @path[0, len].map{|p| CGI.escape(p)}.join("/") + "/"
+      end
+    end
+    module Form
+      ATOM  = Atomize::MIME
+      HTML  = "text/html"
+      ICS   = "text/calendar"
+      PLAIN = "text/plain"
+      VCF   = "text/directory"
+    end
+    # Return an HTML description of a list of resources accessible under this
+    # path.
+    class ResourceList
+      def initialize(description, items)
+        @description = description
+        @items = items
+      end
+      def get(path)
+        return <<__, Form::HTML
+<html><body>
+#{@description}
+<ul>
+  #{
+    @items.map do |name,description,scheme|
+      "<li><a href=\"#{path.append(name,scheme)}\">#{description || name}</a></li>\n"
+    end
+  }
+</ul>
+</body></html>
+__
+      end
+    end
+    # Return calendar information based on RESTful (lovein' the jargon...)
+    # paths. Input is a Vpim::Repo.
+    #
+    #   .../coding/month/atom
+    #   .../coding/events/month/ics              <- next month?
+    #   .../coding/events/month/2008-04/ics      <- a specified month?
+    #   .../coding/week/atom
+    #   .../year/atom
+    class Calendars
+      def initialize(repo)
+        @repo = repo
+      end
+      class Calendar
+        def initialize(cal)
+          @cal = cal
+          @list = ResourceList.new(
+              "Calendar #{@cal.name.inspect}:",
+              [
+                ["calendar", "download"],
+                ["calendar", "subscription", "webcal"],
+                ["atom",     "syndication"],
+              ]
+            )
+        end
+        def get(path)
+          form = path.shift
+          # TODO should redirect to an object, so that extra paths can be
+          # handled more gracefully.
+          case form
+          when nil
+            return @list.get(path)
+          when "calendar"
+            return @cal.encode, Form::ICS
+          when "atom"
+            return Atomize.calendar(@cal, path.uri, nil, @cal.name).to_xml, Form::ATOM
+          else
+            raise NotFound.new(form, path)
+          end
+        end
+      end
+      # Get object at this path. Return value is a tuple of data and mime content type.
+      def get(path)
+        case name = path.to_path.shift
+        when nil
+          list = ResourceList.new("Calendars:", @repo.map{|c| c.name})
+          return list.get(path)
+        else
+          if cal = @repo.find{|c| c.name == name}
+            return Calendar.new(cal).get(path)
+          else
+            raise NotFound.new(name, path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vpim/agent/handler.rb ADDED Viewed

@@ -0,0 +1,26 @@
+=begin
+  Copyright (C) 2009 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
+require 'sinatra/base'
+# Auto-choose our handler based on the environment.
+# TODO Code should be in Sinatra, and should handle Thin, Mongrel, etc.
+Sinatra::Base.configure do
+  server = Sinatra::Base.server
+  Sinatra::Base.set :server, Proc.new {
+      if ENV.include?("PHP_FCGI_CHILDREN")
+        break "fastcgi" # Must NOT be the correct class name!
+      elsif ENV.include?("REQUEST_METHOD")
+        break "cgi" # Must NOT be the correct class name!
+      else
+        # Fall back on whatever it was going to be.
+        server
+      end
+  }
+end

data/lib/vpim/agent/ics.rb ADDED Viewed

@@ -0,0 +1,161 @@
+=begin
+  Copyright (C) 2009 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
+require 'cgi'
+require 'vpim/agent/base'
+require 'vpim/agent/atomize'
+require 'vpim/repo'
+require 'vpim/view'
+require 'sinatra/base'
+module Vpim
+  module Agent
+    class Ics < Base
+      use_in_file_templates!
+      def atomize(caluri, feeduri)
+        repo = Vpim::Repo::Uri.new(caluri)
+        cal = repo.find{true}
+        cal = View.week(cal)
+        feed = Agent::Atomize.calendar(cal, feeduri, caluri, cal.name)
+        return feed.to_xml,  Agent::Atomize::MIME
+      end
+      ## Route handlers:
+      def get_base(from)
+        @url_base = script_url   # agent mount point
+        @url_ics  = from         # ics from here
+        @url_atom = nil          # atom feed from here, if ics is accessible
+        @url_error= nil          # error message, if is is not accessible
+        if not from.empty?
+          begin
+            atomize(from, "http://example.com")
+            @url_atom = @url_base + "/atom" + "?" + from
+          rescue
+            @url_error = CGI.escapeHTML($!.to_s)
+          end
+        end
+        haml :"vpim/agent/ics/view"
+      end
+      # When we support other forms..
+      #get '/ics/:form' do
+      #  form = params[:form]
+      def get_atom(caluri)
+        if caluri.empty?
+          redirect script_url
+        end
+        feeduri = script_url + "/atom?" + caluri
+        begin
+          xml, xmltype = atomize(caluri, feeduri)
+          content_type xmltype
+          body xml
+        rescue
+          redirect script_url + "?" + caluri
+        end
+      end
+      def get_style
+        content_type 'text/css'
+        css :"vpim/agent/ics/style"
+      end
+      ## Sinatra routing:
+      get '/?' do
+        get_base(env['QUERY_STRING'])
+      end
+      post "/?" do
+        redirect script_url + "?" + (params[:url] || "")
+      end
+      get "/atom" do
+        get_atom(env['QUERY_STRING'])
+      end
+      get '/style.css' do
+        get_style
+      end
+    end # Ics
+  end # Agent
+end # Vpim
+__END__
+@@vpim/agent/ics/style
+body {
+  background-color: gray;
+}
+h1 {
+  border-bottom: 3px solid #8B0000;
+  font-size: large;
+}
+form {
+  margin-left: 10%;
+}
+input.text {
+  width: 80%;
+}
+a {
+  color: black;
+}
+a:hover {
+  color: #8B0000;
+}
+tt {
+  margin-left: 10%;
+}
+.footer {
+  border-top: 3px solid #8B0000;
+}
+@@vpim/agent/ics/view
+!!! strict
+%html
+  %head
+    %title Subscribe to calendar feeds as atom feeds
+    %link{:href => script_url + "/style.css", :media => "screen", :type => "text/css"}
+    %meta{:"http-equiv" => "Content-Type", :content => "text/html;charset=utf-8"}
+  %body
+    %h1 Subscribe to calendar feeds as atom feeds
+    %p
+      Calendar feeds are great, but when you want a reminder of what's coming up
+      in the next week, you might want those events as an atom feed.
+    %p
+      Paste the URL of the calendar below, submit it, and subscribe.
+    %form{:method => 'POST', :action => script_url}
+      %p
+        %input.text{:type => 'text', :name => 'url', :value => @url_ics}
+        %input{:type => 'submit', :value => 'Submit'}
+    - if @url_atom
+      %p
+        Subscribe to
+        %a{:href => @url_ics}= @url_ics
+        as:
+      %ul.feed
+        %li
+          %a{:href => @url_atom}= @url_atom
+          (atom feed)
+    - if @url_error
+      %p
+        Sorry, trying to access
+        %tt=@url_ics
+        resulted in:
+      %p
+        %tt= @url_error
+    .footer
+      :textile
+        Brought from the "Octet Cloud":http://octetcloud.com/ using "vPim":http://vpim.rubyforge.org/, by cloud monkey "Sam Roberts":mailto:vieuxtech@gmail.com.

data/lib/vpim/attachment.rb ADDED Viewed

@@ -0,0 +1,102 @@
+=begin
+  Copyright (C) 2008 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
+require 'vpim/icalendar'
+module Vpim
+  # Attachments are used by both iCalendar and vCard. They are either a URI or
+  # inline data, and their decoded value will be either a Uri or a Inline, as
+  # appropriate.
+  #
+  # Besides the methods specific to their class, both kinds of object implement
+  # a set of common methods, allowing them to be treated uniformly:
+  # - Uri#to_io, Inline#to_io: return an IO from which the value can be read.
+  # - Uri#to_s, Inline#to_s: return the value as a String.
+  # - Uri#format, Inline#format: the format of the value. This is supposed to
+  #   be an "iana defined" identifier (like "image/jpeg"), but could be almost
+  #   anything (or nothing) in practice.  Since the parameter is optional, it may
+  #   be "".
+  #
+  # The objects can also be distinguished by their class, if necessary.
+  module Attachment
+    # TODO - It might be possible to autodetect the format from the first few
+    # bytes of the value, and return the appropriate MIME type when format
+    # isn't defined.
+    #
+    # iCalendar and vCard put the format in different parameters, and the
+    # default kind of value is different.
+    def Attachment.decode(field, defkind, fmtparam) #:nodoc:
+      format = field.pvalue(fmtparam) || ''
+      kind = field.kind || defkind
+      case kind
+      when 'text'
+        Inline.new(Vpim.decode_text(field.value), format)
+      when 'uri'
+        Uri.new(field.value_raw, format)
+      when 'binary'
+        Inline.new(field.value, format)
+      else
+        raise InvalidEncodingError, "Attachment of type #{kind} is not allowed"
+      end
+    end
+    # Extends a String to support some of the same methods as Uri.
+    class Inline < String
+      def initialize(s, format) #:nodoc:
+        @format = format
+        super(s)
+      end
+      # Return an IO object for the inline data. See +stringio+ for more
+      # information.
+      def to_io
+        StringIO.new(self)
+      end
+      # The format of the inline data.
+      # See Attachment.
+      attr_reader :format
+    end
+    # Encapsulates a URI and implements some methods of String.
+    class Uri
+      def initialize(uri, format) #:nodoc:
+        @uri = uri
+        @format = format
+      end
+      # The URI value.
+      attr_reader :uri
+      # The format of the data referred to by the URI.
+      # See Attachment.
+      attr_reader :format
+      # Return an IO object from opening the URI.  See +open-uri+ for more
+      # information.
+      def to_io
+        open(@uri)
+      end
+      # Return the String from reading the IO object to end-of-data.
+      def to_s
+        to_io.read(nil)
+      end
+      def inspect #:nodoc:
+        s = "<#{self.class.to_s}: #{uri.inspect}>"
+        s << ", #{@format.inspect}" if @format
+        s
+      end
+    end
+  end
+end

data/lib/vpim/date.rb ADDED Viewed

@@ -0,0 +1,222 @@
+=begin
+  Copyright (C) 2008 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
+require 'date'
+# Extensions to the standard library Date.
+class Date
+  TIME_START = Date.new(1970, 1, 1)
+  SECS_PER_DAY = 24 * 60 * 60
+  # Converts this object to a Time object, or throws an ArgumentError if
+  # conversion is not possible because it is before the start of epoch.
+  def vpim_to_time
+    raise ArgumentError, 'date is before the start of system time' if self < TIME_START
+    days = self - TIME_START
+    Time.at((days * SECS_PER_DAY).to_i)
+  end
+  # If wday responds to to_str, convert it to the wday number by searching for
+  # a wday that matches, using as many characters as are in wday to do the
+  # comparison. wday must be 2 or more characters long in order to be a unique
+  # match, other than that, "mo", "Mon", and "MonDay" are all valid strings
+  # for wday 1.
+  #
+  # This method can be called on a valid wday, and it will return it. Perhaps
+  # it should be called by default inside the Date#new*() methods so that
+  # non-integer wday arguments can be used? Perhaps a similar method should
+  # exist for months? But with months, we all know January is 1, who can
+  # remember where Date chooses to start its wday count!
+  #
+  # Examples:
+  #  Date.bywday(2004, 2, Date.str2wday('TU')) => the first Tuesday in
+  #    February
+  #  Date.bywday(2004, 2, Date.str2wday(2)) => the same day, but notice
+  #    that a valid wday integer can be passed right through.
+  #
+  def Date.str2wday(wdaystr)
+    return wdaystr unless wdaystr.respond_to? :to_str
+    str = wdaystr.to_str.upcase
+    if str.length < 2
+      raise ArgumentError, 'wday #{wday} is not long enough to be a unique weekday name'
+    end
+    wday = Date::DAYNAMES.map { |n| n.slice(0, str.length).upcase }.index(str)
+    return wday if wday
+    raise ArgumentError, 'wday #{wdaystr} was not a recognizable weekday name'
+  end
+  # Create a new Date object for the date specified by year +year+, month
+  # +mon+, and day-of-the-week +wday+.
+  #
+  # The nth, +n+, occurrence of +wday+ within the period will be generated
+  # (+n+ defaults to 1).  If +n+ is positive, the nth occurrence from the
+  # beginning of the period will be returned, if negative, the nth occurrence
+  # from the end of the period will be returned.
+  #
+  # The period is a year, unless +month+ is non-nil, in which case it is just
+  # that month.
+  #
+  # Examples:
+  # - Date.bywday(2004, nil, 1, 9) => the ninth Sunday of 2004
+  # - Date.bywday(2004, nil, 1) => the first Sunday of 2004
+  # - Date.bywday(2004, nil, 1, -2) => the second last Sunday of 2004
+  # - Date.bywday(2004, 12, 1) => the first sunday in the 12th month of 2004
+  # - Date.bywday(2004, 2, 2, -1) => last Tuesday in the 2nd month in 2004
+  # - Date.bywday(2004, -2, 3, -2) => second last Wednesday in the second last month of 2004
+  #
+  # Compare this to Date.new, which allows a Date to be created by
+  # day-of-the-month, mday, to Date.ordinal, which allows a Date to be created by
+  # day-of-the-year, yday, and to Date.commercial, which allows a Date to be created
+  # by day-of-the-week, but within a specific week.
+  def Date.bywday(year, mon, wday, n = 1, sg=Date::ITALY)
+    # Normalize mon to 1-12.
+    if mon
+      if mon > 12 ||  mon == 0 || mon < -12
+         raise ArgumentError, "mon #{mon} must be 1-12 or negative 1-12"
+      end
+      if mon < 0
+        mon = 13 + mon
+      end
+    end
+    if wday < 0 || wday > 6
+      raise ArgumentError, 'wday must be in range 0-6, or a weekday name'
+    end
+    # Determine direction of indexing.
+    inc = n <=> 0
+    if inc == 0
+      raise ArgumentError, 'n must be greater or less than zero'
+    end
+    # if !mon, n is index into year, but direction of search is determined by
+    # sign of n
+    d = Date.new(year, mon ? mon : inc, inc, sg)
+    while d.wday != wday
+      d += inc
+    end
+    # Now we have found the first/last day with the correct wday, search
+    # for nth occurrence, by jumping by n.abs-1 weeks forward or backward.
+    d += 7 * (n.abs - 1) * inc
+    if d.year != year
+      raise ArgumentError, 'n is out of bounds of year'
+    end
+    if mon && d.mon != mon
+      raise ArgumentError, 'n is out of bounds of month'
+    end
+    d
+  end
+  # Return the first day of the week for the specified date. Commercial weeks
+  # start on Monday, but the weekstart can be specified (as 0-6, where 0 is
+  # sunday, or in formate of Date.str2day).
+  def Date.weekstart(year, mon, day, weekstart="MO")
+    wkst = Date.str2wday(weekstart)
+    d = Date.new(year, mon, day)
+    until d.wday == wkst
+      d = d - 1
+    end
+    d
+  end
+end
+# DateGen generates arrays of dates matching simple criteria.
+class DateGen
+  # Generate an array of a week's dates, where week is specified by year, mon,
+  # day, and the weekstart (the day-of-week that is considered the "first" day
+  # of that week, 0-6, where 0 is sunday).
+  def DateGen.weekofdate(year, mon, day, weekstart)
+    d = Date.weekstart(year, mon, day, weekstart)
+    week = []
+    7.times do
+      week << d
+      d = d + 1
+    end
+    week
+  end
+  # Generate an array of dates on +wday+ (the day-of-week,
+  # 0-6, where 0 is Sunday).
+  #
+  # If +n+ is specified, only the nth occurrence of +wday+ within the period
+  # will be generated.  If +n+ is positive, the nth occurrence from the
+  # beginning of the period will be returned, if negative, the nth occurrence
+  # from the end of the period will be returned.
+  #
+  # The period is a year, unless +month+ is non-nil, in which case it is just
+  # that month.
+  #
+  # Examples:
+  # - DateGen.bywday(2004, nil, 1, 9) => the ninth Sunday in 2004
+  # - DateGen.bywday(2004, nil, 1) => all Sundays in 2004
+  # - DateGen.bywday(2004, nil, 1, -2) => second last Sunday in 2004
+  # - DateGen.bywday(2004, 12, 1) => all sundays in December 2004
+  # - DateGen.bywday(2004, 2, 2, -1) => last Tuesday in February in 2004
+  # - DateGen.bywday(2004, -2, 3, -2) => second last Wednesday in November of 2004
+  #
+  # Compare to Date.bywday(), which allows a single Date to be created with
+  # similar criteria.
+  def DateGen.bywday(year, month, wday, n = nil)
+    seed = Date.bywday(year, month, wday, n ? n : 1)
+    dates = [ seed ]
+    return dates if n
+    succ = seed.clone
+    # Collect all matches until we're out of the year (or month, if specified)
+    loop do
+      succ += 7
+      break if succ.year != year
+      break if month && succ.month != seed.month
+      dates.push succ
+    end
+    dates.sort!
+    dates
+  end
+  # Generate an array of dates on +mday+ (the day-of-month, 1-31). For months
+  # in which the +mday+ is not present, no date will be generated.
+  #
+  # The period is a year, unless +month+ is non-nil, in which case it is just
+  # that month.
+  #
+  # Compare to Date.new(), which allows a single Date to be created with
+  # similar criteria.
+  def DateGen.bymonthday(year, month, mday)
+    months = month ? [ month ] : 1..12
+    dates = [ ]
+    months.each do |m|
+      begin
+        dates << Date.new(year, m, mday)
+      rescue ArgumentError
+        # Don't generate dates for invalid combinations (Feb 29, when it's not
+        # a leap year, for example).
+        #
+        # TODO - should we raise when month is out of range, or mday can never
+        # be in range (32)?
+      end
+    end
+    dates
+  end
+end