vpim 0.658 → 0.695

data/lib/vpim/repo.rb

@@ -7,6 +7,7 @@
 =end
 
 require 'enumerator'
+require "net/http"
 
 require 'plist'
 
@@ -19,6 +20,7 @@ module Vpim
   # Currently supported repository types are:
   # - Repo::Apple3, an Apple iCal3 repository.
   # - Repo::Directory, a directory hierarchy containing .ics files
+  # - Repo::Uri, a URI that identifies a single iCalendar
   #
   # All repository types support at least the methods of Repo, and all
   # repositories return calendars that support at least the methods of
@@ -79,7 +81,9 @@ module Vpim
           return Enumerable::Enumerator.new(self, :each, klass)
         end
 
-        cals = Vpim::Icalendar.decode(File.open(file))
+        cals = open(file) do |io|
+          Vpim::Icalendar.decode(io)
+        end
 
         cals.each do |cal|
           cal.each(klass, &block)
@@ -176,6 +180,82 @@ module Vpim
         self
       end
     end
+
+    class Uri < Repo
+      def self.uri_check(uri)
+        uri = case uri
+               when URI
+                 uri
+               else
+                 begin
+                   URI.parse(uri)
+                 rescue URI::InvalidURIError => e
+                   raise ArgumentError, "Invalid URI for #{uri.inspect} - #{e.to_s}"
+                 end
+               end
+        unless uri.scheme == "http"
+          raise ArgumentError, "Unsupported URI scheme for #{uri.inspect}"
+        end
+        uri
+      end
+
+      class Calendar < Repo::Calendar
+        def body
+        end
+
+        def initialize(uri) #:nodoc:
+          @uri = Uri.uri_check(uri)
+        end
+
+        def name #:nodoc:
+          @uri.to_s
+        end
+
+        def displayed #:nodoc:
+          true
+        end
+
+        def each(klass, &block) #:nodoc:
+          unless iterator?
+            return Enumerable::Enumerator.new(self, :each, klass)
+          end
+
+          cals = Vpim::Icalendar.decode(encode)
+
+          cals.each do |cal|
+            cal.each(klass, &block)
+          end
+          self
+        end
+
+        def encode #:nodoc:
+          Net::HTTP.get_response(@uri) do |result|
+            accum = ""
+=begin
+better to let this pass up as an invalid encoding error
+            if result.code != "200"
+              raise StandardError,
+                "HTTP GET of #{@uri.to_s.inspect} failed with #{result.code} #{result.error_type}"
+            end
+=end
+            result.read_body do |chunk|
+              accum << chunk
+            end
+            return accum
+          end
+        end
+
+      end
+
+      def initialize(where)
+        @where = Uri.uri_check(where)
+      end
+
+      def each #:nodoc:
+        yield Calendar.new(@where)
+        self
+      end
+    end
   end
 end
 

data/lib/vpim/version.rb

@@ -7,9 +7,9 @@
 =end
 
 module Vpim
-  PRODID = '-//Ensemble Independent//vPim 0.658//EN'
+  PRODID = '-//Ensemble Independent//vPim 0.695//EN'
 
-  VERSION = '0.658'
+  VERSION = '0.695'
 
   # Return the API version as a string.
   def Vpim.version

data/samples/reminder.rb

@@ -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/test/test_agent_app.rb

@@ -0,0 +1,74 @@
+require 'test/common'
+require 'sinatra/test/unit'
+
+require 'vpim/agent/app'
+
+class IcsAgent < Test::Unit::TestCase
+
+  def to_str
+    @caldata
+  end
+
+  def setup
+    @thrd = data_on_port(self, 9876)
+  end
+  def teardown
+    @thrd.kill
+  end
+
+  def test_ics_atom_query
+    @caldata = open('test/calendars/weather.calendar/Events/1205042405-0-0.ics').read
+
+    get '/ics/atom?http://127.0.0.1:9876'
+
+    #pp @response
+    assert(@response.body =~ /<\?xml/)
+    assert_equal(Vpim::Agent::Atomize::MIME, @response['Content-Type'])
+    assert_equal(200, @response.status)
+    assert(@response.body =~ Regexp.new(
+      Regexp.quote(
+        "<id>http://example.org/ics/atom?http://127.0.0.1:9876</id>"
+    )), @response.body)
+  end
+
+  def test_ics
+    get '/ics'
+
+    assert(@response.body =~ /<html/)
+    assert_equal('text/html', @response['Content-Type'])
+    assert_equal(200, @response.status)
+    assert(@response.body =~ Regexp.new(
+      Regexp.quote("<title>Subscribe")), @response.body)
+  end
+
+  def test_ics_query
+    @caldata = open('test/calendars/weather.calendar/Events/1205042405-0-0.ics').read
+
+    get '/ics?http://127.0.0.1:9876'
+
+    assert(@response.body =~ /<html/)
+    assert_equal('text/html', @response['Content-Type'])
+    assert_equal(200, @response.status)
+
+    assert(@response.body =~ Regexp.new(
+      Regexp.quote("Subscribe to")), @response.body)
+  end
+
+  def test_ics_atom
+    get '/ics/atom'
+    assert_equal(302, @response.status)
+  end
+
+=begin
+
+WTF? Sinatra doesn't run it's error catcher in unit test mode?
+  def test_ics_atom_query_bad
+    get '/ics/atom?http://example.com'
+    assert_equal(500, @response.status)
+    assert(@response.body =~ Regexp.new(
+      Regexp.quote("error")), @response.body)
+  end
+=end
+
+end
+

data/test/test_agent_atomize.rb

@@ -0,0 +1,84 @@
+require 'test/common'
+
+require 'vpim/agent/atomize'
+require 'vpim/icalendar'
+require 'vpim/view'
+
+class TextAgentAtomize < Test::Unit::TestCase
+
+  def atomize(cal, feeduri, caluri, filter=nil)
+    ical = Vpim::Icalendar.decode(cal).first
+    if filter
+      ical = filter.call(ical)
+    end
+    feed = Vpim::Agent::Atomize.calendar(ical, feeduri, caluri)
+    return ical, feed
+  end
+
+  def test_minimal
+    ical, feed = atomize(<<'__', "http://example.com/feed", "http://example.com/calendar")
+BEGIN:VCALENDAR
+BEGIN:VEVENT
+DTSTART:20090214T144503
+END:VEVENT
+END:VCALENDAR
+__
+
+  assert_equal(feed.entries.size, 1)
+  assert_equal("http://example.com/feed", feed.id)
+  assert_equal("http://example.com/calendar", feed.title)
+  assert(feed.to_xml.to_str)
+  assert_equal(nil, feed.entries.first.title)
+  assert_equal(nil, feed.entries.first.content)
+  #puts feed.to_xml
+  end
+
+  def test_small
+    ical, feed = atomize(<<'__', "http://example.com/feed", "http://example.com/calendar")
+BEGIN:VCALENDAR
+BEGIN:VEVENT
+DTSTART:20090214T144503
+SUMMARY:I am summarized
+DESCRIPTION:And I am described
+UID:very, very, unique
+END:VEVENT
+END:VCALENDAR
+__
+
+  assert_equal(feed.entries.size, 1)
+  assert_equal("http://example.com/feed", feed.id)
+  assert_equal("http://example.com/calendar", feed.title)
+  assert_equal("I am summarized", feed.entries.first.title)
+  assert_equal("And I am described", feed.entries.first.content)
+  assert(feed.to_xml.to_str)
+  #puts feed.to_xml
+  end
+
+  def test_recurring
+    filter = proc do |cal|
+      Vpim::View.week(cal)
+    end
+    ical, feed = atomize(<<'__', "http://example.com/feed", "http://example.com/calendar", filter)
+BEGIN:VCALENDAR
+BEGIN:VEVENT
+DTSTART:20090214T144503
+RRULE:FREQ=weekly
+SUMMARY:I am summarized
+DESCRIPTION:And I am described
+UID:very, very, unique
+END:VEVENT
+END:VCALENDAR
+__
+
+  puts feed.to_xml
+  assert_equal(1, feed.entries.size)
+  assert_equal("http://example.com/feed", feed.id)
+  assert_equal("http://example.com/calendar", feed.title)
+  assert_equal("I am summarized", feed.entries.first.title)
+  assert_equal("And I am described", feed.entries.first.content)
+  assert(feed.to_xml.to_str)
+  end
+
+end
+
+

data/test/test_agent_calendars.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+
+require 'vpim/repo'
+require 'vpim/agent/calendars'
+require 'test/common'
+
+class TestAgentCalendars < Test::Unit::TestCase
+  Apple3 = Vpim::Repo::Apple3
+  Directory = Vpim::Repo::Directory
+  Uri = Vpim::Repo::Uri
+  Agent = Vpim::Agent
+  Path = Agent::Path
+  NotFound = Agent::NotFound
+
+  def setup
+    @testdir = Dir.getwd + "/test" #File.dirname($0) doesn't work with rcov :-(
+    @caldir = @testdir + "/calendars"
+    @eventsz = Dir[@caldir + "/**/*.ics"].size
+    assert(@testdir)
+    assert(test(?d, @caldir), "no caldir "+@caldir)
+  end
+
+  def assert_is_text_calendar(text)
+    lines = text.split("\n")
+    lines = lines.first, lines.last
+    assert_equal("BEGIN:VCALENDAR", lines.first.upcase, lines)
+    assert_equal("END:VCALENDAR", lines.last.upcase, lines)
+  end
+
+  def test_agent_calendars
+    repo = Apple3.new(@caldir)
+    rest = Agent::Calendars.new(repo)
+
+    out1, form = rest.get(Path.new("http://host/here", "/here"))
+    assert_equal("text/html", form)
+    #puts(out1)
+
+    out1, form = rest.get(Path.new("http://host/here/weather%2fLeavenworth", "/here"))
+    assert_equal("text/html", form)
+    #puts(out1)
+
+    out2, form = rest.get(Path.new("http://host/here/weather%2fLeavenworth/calendar", "/here"))
+    assert_equal("text/calendar", form)
+    assert_is_text_calendar(out2)
+
+    #assert_equal(out1, out2)
+
+    assert_raise(Vpim::Agent::NotFound) do
+      rest.get(Path.new("http://host/here/weather%2fLeavenworth/an_unknown_protocol", "/here"))
+    end
+    assert_raise(Vpim::Agent::NotFound) do
+      rest.get(Path.new("http://host/here/no_such_calendar", "/here"))
+    end
+
+    assert_equal(["","/","/"], Vpim::Agent::Path.split_path("/%2F/%2F"))
+    assert_equal(["/","/"], Vpim::Agent::Path.split_path("%2F/%2F"))
+    assert_equal(["calendars", "weather/Leavenworth"],
+                 Vpim::Agent::Path.split_path("calendars/weather%2FLeavenworth"))
+  end
+
+  def test_agent_calendar_atom
+    repo = Apple3.new(@caldir)
+    rest = Agent::Calendars.new(repo)
+
+    out, form = rest.get(Path.new("http://host/here/weather%2fLeavenworth/atom", "/here"))
+    assert_equal("application/atom+xml", form)
+    #pp out
+    #assert_is_atom(out)
+  end
+
+  def _test_path_shift(url, shifts)
+    # last shift should be a nil
+    shifts << nil
+
+    # presence or absence of a trailing / should not affect shifting
+    ["", "/"].each do |trailer|
+      path = Path.new(url + trailer)
+      shifts.each do |_|
+        assert_equal(_, path.shift)
+      end
+    end
+  end
+
+  def test_path_shift
+    _test_path_shift("http://host.ex", [])
+    _test_path_shift("http://host.ex/a", ["a"])
+    _test_path_shift("http://host.ex/a/b", ["a", "b"])
+    _test_path_shift("http://host.ex/a/b/c", ["a", "b", "c"])
+  end
+
+  def _test_path_prefix(base, parts, shifts, prefix)
+    path = Path.new(base+parts.join("/"))
+    shifts.times{ path.shift }
+    assert_equal(prefix, path.prefix)
+  end
+
+  def test_path_prefix
+    _test_path_prefix("http://host.ex/", [], 0, "/")
+    _test_path_prefix("http://host.ex/", ["a"], 0, "/")
+    _test_path_prefix("http://host.ex/", ["a"], 1, "/")
+    _test_path_prefix("http://host.ex/", ["a"], 2, "/a/")
+    _test_path_prefix("http://host.ex/", ["a"], 3, "/a/")
+    _test_path_prefix("http://host.ex/", ["a", "b"], 0, "/")
+    _test_path_prefix("http://host.ex/", ["a", "b"], 1, "/")
+    _test_path_prefix("http://host.ex/", ["a", "b"], 2, "/a/")
+    _test_path_prefix("http://host.ex/", ["a", "b"], 3, "/a/b/")
+  end
+
+=begin
+  def test_atomize
+    repo = Apple3.new(@caldir)
+    cal = repo.find{true}
+    a = Vpim::Agent::Atomize.new(cal)
+    assert( a.get(Path.new("http://example.com/path")))
+  end
+
+  def x_test_uri_query
+    uri = "http://example.com/ics/atom?http://localhost:9876"
+
+    repo = Uri.new("http://localhost:9876")
+    rest = Agent::Calendars.new(repo)
+    out1, form = rest.get(Path.new("http://example.com/ics", "/ics/atom"))
+    p [out1, form]
+  end
+=end
+
+end
+