vpim 0.658 → 0.695

data/CHANGES

@@ -1,3 +1,9 @@
+0.695 - 2009-03-01
+
+- Alpha versions of vPim agent (http://agent.octetcloud.com)
+- Fixed: reminder app had drifted out of sync with API change
+
+
 0.657 - 2008-08-14
 
 - Date#to_time renamed to Date#vpim_to_time. Apparently Rails also patches the core.

data/bin/reminder

@@ -18,8 +18,8 @@ Usage: #{$0} [where]
 
 Shows events and todos occuring soon.
 
-By default, the Apple iCal v3 calendars are used, but if a location where
-.ics files is specified, any calendars found there will be used.
+By default, the Apple iCal v3 calendars are used, but if a location where .ics
+files can be found is specified, any calendars found there will be used.
 
 Options
   -h,--help        Print this helpful message.
@@ -29,6 +29,7 @@ Options
 EOF
 
 opt_debug = nil
+opt_dump = nil
 opt_verbose = nil
 opt_days  = 7
 
@@ -53,6 +54,9 @@ opts.each do |opt, arg|
 
     when "--debug" then
       opt_verbose = true
+      if opt_debug
+        opt_dump = true
+      end
       opt_debug = true
   end
 end
@@ -64,12 +68,12 @@ if ARGV.length > 0
     calendars << cal
   end
 else
-  Vpim::Repo::Ical3.each() do |cal|
+  Vpim::Repo::Apple3.new.each() do |cal|
     calendars << cal
   end
 end
 
-if opt_debug
+if opt_dump
   pp ARGV
   pp calendars
 end
@@ -81,7 +85,7 @@ t0[0] = t0[1] = t0[2] = 0 # sec,min,hour = 0
 t0 = Time.local(*t0)
 t1 = t0 + opt_days * SECSPERDAY
 
-if opt_debug
+if opt_dump
   puts "to: #{t0}"
   puts "t1: #{t1}"
 end
@@ -95,12 +99,13 @@ all_events = []
 all_todos  = []
 
 calendars.each do |cal|
-  if opt_debug; puts cal.name; end
+  if opt_debug; puts "Calendar: #{cal.name}"; end
 
+  # TODO - mv collection algorithm to library
   begin
     cal.events.each do |e|
       begin
-        if opt_debug; pp e; end
+        if opt_dump; pp e; end
         if e.occurs_in?(t0, t1)
           if e.summary
             all_events.push(e)
@@ -111,12 +116,13 @@ calendars.each do |cal|
       end
     end
 
-    all_todos.concat(cal.todos)
+    all_todos.concat(cal.todos.to_a)
   end
 end
 
 puts
 
+# TODO - mv sorting algorithm to library
 def start_of_first_occurrence(t0, t1, e)
   e.occurrences(t1) do |t|
     # An event might start before t0, but end after it..., in which case
@@ -137,7 +143,7 @@ all_events.each do |e|
 
   if opt_verbose
     if e.description;   puts "  description=#{e.description}"; end
-    if e.comments;      puts "  comment=#{e.comments.first}"; end
+    if e.comments.any?; puts "  comment=#{e.comments.first}"; end
     if e.location;      puts "  location=#{e.location}"; end
     if e.status;        puts "  status=#{e.status}"; end
     if e.dtstart;       puts "  dtstart=#{e.dtstart}"; end
@@ -145,15 +151,15 @@ all_events.each do |e|
   end
 
   i = 1
-  e.occurrences.each_until(t1).each do |t|
+  e.occurrences(t1) do |t|
     # An event might start before t0, but end after it..., in which case
     # we are still interested.
     dstr = ''
     if e.duration
-      d = e.duration
       dstr = " for #{Vpim::Duration.new(e.duration).to_s}"
     end
 
+    # TODO - mv to library, as variant of occurs_in?
     if (t + (e.duration || 0)) >= t0
       puts "  ##{i} on #{t}#{dstr}"
       i += 1

data/lib/vpim/agent/app.rb

@@ -0,0 +1,194 @@
+=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'
+require 'vpim/agent/atomize'
+require 'vpim/repo'
+require 'vpim/view'
+
+require 'cgi'
+
+configure do
+  server = Sinatra::Application.server
+  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
+
+# I could wrap the Repo/Calendar/Atomize in a small class that would memoize
+# ical data and atom output. Maybe even do an HTTP head for fast detection of
+# change? Does a calendar have updated information? Can we memoize atom when
+# ics doesn't change?
+
+module Vpim
+  module Agent
+    module App
+      def self.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
+    end
+  end
+end
+
+get '/ics' do
+  from = env['QUERY_STRING']
+
+  url = URI.parse(request.url)
+  url.query = nil
+  url_base = url.to_s
+  url_atom = nil
+
+  @url_ics  = from      # ics from here
+  @url_atom = nil
+
+  if not from.empty?
+    # Error out if we can't atomize the feed
+    Vpim::Agent::App.atomize(from, "http://example.com")
+
+    url = URI.parse(request.url)
+    url.path << "/atom"
+    url_atom = url.to_s
+  end
+
+  @url_base = url_base  # clean input form
+  @url_atom = url_atom  # atomized ics from here
+
+  haml :"ics.haml"
+end
+
+post '/ics' do
+  from = params[:url]
+  url = URI.parse(request.url)
+  url.query = from
+  redirect url.to_s
+end
+
+# When we support other forms..
+#get '/ics/:form' do
+#  form = params[:form]
+get '/ics/atom' do
+  from = env['QUERY_STRING']
+  port = env["SERVER_PORT"].to_i
+  here = request.url
+
+  if from.empty?
+    url = URI.parse(here)
+    url.path.sub(/atom$/, "")
+    redirect here.to_s
+  end
+
+  xml, xmltype = Vpim::Agent::App.atomize(from, here)
+
+  content_type xmltype
+  body xml
+end
+
+get '/ics/style.css' do
+  content_type 'text/css'
+  sass :"ics.sass"
+end
+
+error do
+  @url_error = CGI.escapeHTML(env['sinatra.error'].inspect)
+  haml :"ics.haml"
+end
+
+use_in_file_templates!
+
+# FIXME - hard-coded :action paths below, bad!
+
+__END__
+@@ics.sass
+body
+  :background-color gray
+  :font-size medium
+  a
+    :color black
+    :font-style italic
+  a:hover
+    :color darkred
+
+#header
+  :border-bottom 3px solid darkred
+  #title
+    :color black
+    :font-size large
+
+.text
+  :width 80%
+-#:color yellow
+
+#submit
+  :margin-top 30px
+  :margin-left 5%
+  #form
+    :padding
+      :top 10px
+      :bottom 10px
+      :left 10px
+      :right 10px
+    :text-align left
+    #url
+      :width 80%
+    #button
+      :font-weight bold
+      :text-align center
+
+#subscribe
+  :margin-left 5%
+-#.feed
+-#  :margin-left 10%
+  
+#footer
+  :border-top 3px solid darkred
+  :margin-top 20px
+@@ics.haml
+%html
+  %head
+    %title Subscribe to calendar feeds as atom feeds
+    %link{:href => '/ics/style.css', :media => 'screen', :type => 'text/css'}
+  %body
+    #header
+      %span#title Subscribe to calendar feeds as atom feeds
+    #submit
+      .text Calendar feeds are great, but sometimes all you want is an atom feed of what's coming up in the next week.
+      .text Paste the URL of the calendar below, submit it, and subscribe.
+      %form#form{:method => 'POST', :action => '/ics'}
+        %input#url{:name => 'url', :value => params[:url]}
+        %input#button{:type => 'submit', :value => 'Submit'}
+    - if @url_atom
+      #subscribe
+        .text
+          Subscribe to
+          %a{:href => @url_ics}= @url_ics
+          as:
+        %ul.feed
+          %a{:href => @url_atom}= @url_atom
+          (atom feed)
+    - if @url_error
+      #error.text
+        #preamble Sorry, trying to access:
+        #source= @url_ics
+        #transition resulted in:
+        #destination= @url_error
+    #footer
+      .text
+        :textile
+          Coming from the "Octet Cloud":http://octetcloud.com/ using "vPim":http://vpim.rubyforge.org/, piloted by cloud monkey "Sam Roberts":mailto:vieuxtech@gmail.com
+

data/lib/vpim/agent/atomize.rb

@@ -0,0 +1,101 @@
+=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 "atom"
+
+module Vpim
+  module Agent
+
+    module Atomize
+      MIME = "application/atom+xml"
+
+      # +ical+, an icalendar, or at least a Repo calendar's subset of an Icalendar
+      # +feeduri+, the atom xml should know the URI of where the feed is available from.
+      # +caluri+, optionally, the URI of the calendar its converted from.
+      #
+      # TODO - and the URI of an alternative/html representation of this feed?
+      def self.calendar(ical, feeduri, caluri = nil, calname = nil)
+        mime = MIME
+
+        feeduri = feeduri.to_str
+        caluri = caluri
+        calname = (calname or caluri or "Unknown").to_str
+
+        f = Atom::Feed.new
+        # Mandatory attributes:
+        # For ID, we should use http://.../ics/atom?....., or just the URL of the ics?
+        #   I think it can be a full URI... or maybe a sha-1 of our full URI?
+        # or like gmail, no id for feed,
+        #   <id>tag:gmail.google.com,2004:1295062805013769502</id>
+        #
+        f.id = feeduri
+        f.title = calname
+        f.updated = Time.now
+        f.authors << Atom::Person.new(:name => (caluri or calname))
+        f.generator = Atom::Generator.new do |g|
+          g.name = Vpim::PRODID
+          g.uri = "http://vpim.rubyforge.org"
+          g.version = Vpim::VERSION
+        end
+
+        f.links << Atom::Link.new do |l|
+          l.href = feeduri
+          l.type = mime
+          l.rel  = :self
+        end
+
+        if caluri
+          # This is maybe better described as :via, but with :alternate being
+          # an html view of this feed.
+          f.links << Atom::Link.new do |l|
+            l.href = caluri
+            l.type = "text/calendar"
+            l.rel  = :alternate
+          end
+        end
+
+        # .icon = uri to the vAgent icon
+        entry_id = 0
+        ical.events do |ve|
+          # TODO - infinite?
+          ve.occurrences do |t|
+            f.entries << Atom::Entry.new do |e|
+              # iCalendar -> atom
+              # -----------------
+              # summary -> title
+              # description -> text/content
+              # uid -> id
+              # created -> published?
+              # organizer -> author?
+              # contact -> author?
+              # last-mod -> semantically, this is updated, but atom doesn't
+              #   have the notion that an entry has a relationship to a time,
+              #   other than the time the entry itself was published, and when
+              #   the entry gets updated. We'll abuse updated for the event's time.
+              # categories -> where do "tags" go in atom, if anywhere?
+              # attachment -> into a link?
+              e.title = ve.summary if ve.summary
+              e.content = Atom::Content::Text.new(ve.description) if ve.description
+              e.updated = t
+
+              # Use "tag:", as defined by RFC4151, and use event UID if possible. Otherwise,
+              # construct something. Maybe I should mix something in to make it unique for
+              # each time a feed is generated for the calendar?
+              entry_id += 1
+              tag = ve.uid || "#{entry_id}@#{feeduri}"
+              e.id = "tag:vpim.rubyforge.org,2009:#{tag}"
+            end
+          end
+        end
+        return f
+      end
+    end # Atomize
+
+  end # Agent
+end # Vpim
+

data/lib/vpim/agent/calendars.rb

@@ -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
+