calfilter 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-05-02
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+example.rb
+lib/calfilter.rb
+lib/calfilter/cgi.rb
+lib/calfilter/tripit.rb
+test/test_calfilter.rb
+test/test_calfilter_cgi.rb

data/README.txt

@@ -0,0 +1,69 @@
+= calfilter
+
+* http://opensource.thinkrelevance.com/wiki/calfilter
+
+== DESCRIPTION:
+
+calfilter is a small library to assist in writing filtering
+programs for icalendar files or streams.  It can be used for
+various purposes, including:
+
+* removing items from icalendar feeds that are not interesting to you
+* removing private information from your own calendar before publishing it to others
+* reformatting a provided calendar to highlight particular information
+
+== FEATURES/PROBLEMS:
+
+* require 'calfilter/tripit' to add some methods specific to
+  tripit.com calendar feeds.
+
+* require 'calfilter/cgi' to automatically turn your filter into
+  a CGI script.  The CGI object is available as 'CalFilter::CGI'.
+
+== SYNOPSIS:
+
+  require 'calfilter'
+
+  cals = filter_calendars_at('some_url') do |cal|
+      cal.keep(:events)  # not journals, todos, or freebusys
+    
+      cal.filter_events do |evt|
+          # Remove events I've marked private
+          evt.remove if evt.description =~ /PRIVATE/
+          # Don't reveal phone numbers of my contacts
+          evt.description.sub! /\d{3}-\d{4}/, '###-####'
+      end
+  end
+
+== REQUIREMENTS:
+
+calfilter depends on the icalendar gem.
+
+== INSTALL:
+
+sudo gem install calfilter
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Relevance, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/calfilter.rb'
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject do |x|
+      Array(x).first == 'hoe'
+    end
+  end
+end
+
+Hoe.new('calfilter', CalFilter::VERSION) do |p|
+  p.rubyforge_name = 'thinkrelevance'
+  p.developer('Glenn Vanderburg', 'glenn@thinkrelevance.com')
+  p.extra_deps = %w{icalendar}
+end
+
+# vim: syntax=Ruby

data/example.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+gem 'calfilter'
+require 'calfilter'
+require 'calfilter/cgi'
+
+filter_calendars_at(CalFilter::CGI.query_string}) do |cal|
+  cal.keep(:events) # drop todos, journals, etc.
+  
+  cal.filter_events do |evt|
+    evt.keep if evt.dtstart >= Date.today # ignore stuff in the past
+  end
+end

data/lib/calfilter/cgi.rb

@@ -0,0 +1,38 @@
+require 'calfilter'
+require 'cgi'
+require 'stringio'
+
+module CalFilter
+
+  class CGIWrapper
+    attr_reader :output_stream
+    
+    def initialize(output_stream)
+      set_cgi_constant
+      CalFilter.output_stream = @output_stream = output_stream
+    end
+    
+    def create_cgi_instance
+      CGI.new
+    end
+    
+    def set_cgi_constant
+      CalFilter.const_set('CGI', create_cgi_instance) unless CalFilter.const_defined?('CGI')
+    end
+    
+    def finish
+      CGI.out('text/calendar; charset=utf-8'){ output_stream.string }
+    end
+  end
+
+  def self.make_cgi_wrapper
+    CGIWrapper.new(StringIO.new)
+  end
+  
+  CGIWRAPPER = make_cgi_wrapper
+  
+end
+
+at_exit do
+  CalFilter::CGIWRAPPER.finish
+end

data/lib/calfilter/tripit.rb

@@ -0,0 +1,31 @@
+require 'calfilter'
+
+module CalFilter
+  module TripIt
+    EVENT_TYPES = {
+      # The keys are the $1 strings from description =~ /^\[(.*?)\]/m
+      nil          => :trip,
+      'Flight'     => :flight,
+      'Car Rental' => :car,
+      'Hotel'      => :hotel,
+      'Directions' => :directions,
+      'Activity'   => :activity
+    }
+    
+    def tripit_type(*args)
+      return :unknown unless __kind__ == 'event'
+      if args.empty?
+          description =~ /^\[(.+?)\]/m
+          TripIt::EVENT_TYPES[$1] || :unknown
+        else
+          args.include?(tripit_type)
+        end
+      end
+    end
+
+  end
+  
+  class ResourceWrapper
+    include TripIt
+  end
+end

data/lib/calfilter.rb

@@ -0,0 +1,166 @@
+%w{rubygems icalendar date open-uri}.each{|l| require l}
+
+module CalFilter
+  VERSION = '1.0.0'
+  
+  def self.output_stream
+    @output_stream
+  end
+  
+  def self.output_stream=(stream)
+    @output_stream = stream
+  end
+  
+  class FilterError < RuntimeError
+  end
+
+  class ResourceWrapper
+    def initialize(delegate, kind)
+      @delegate = delegate
+      @kind = kind
+    end
+    
+    def __delegate__
+      @delegate
+    end
+    
+    def __action__
+      @keep_or_remove || :default
+    end
+    
+    def __kind__
+      @kind
+    end
+
+    def remove
+      __flag__ :remove
+    end
+    
+    def keep
+      __flag__ :keep
+    end
+    
+    def method_missing(symbol, *args, &block)
+      __delegate__.send(symbol, *args, &block)
+    end
+
+    protected
+    
+    def __flag__(sym)
+      other_sym = (sym == :keep ? :remove : :keep)
+      raise FilterError, "Cannot both keep and remove the same #{@kind}", __caller__ if @keep_or_remove == other_sym
+      @keep_or_remove = sym
+      throw :bailout if sym == :remove
+    end
+    
+    def __caller__
+      f = __FILE__
+      stack = caller
+      stack.each_with_index do |s, i|
+        return stack[i..-1] unless s =~ Regexp.new("^#{Regexp.escape(f)}:")
+      end
+    end
+    
+  end
+
+  class CalendarWrapper < ResourceWrapper
+    RESOURCE_TYPES = %w{events freebusys journals todos}
+    
+    def initialize(calendar)
+      super(calendar, 'calendar')
+    end
+    
+    def remove(*args)
+      if args.empty?
+        super
+      else
+        __remove_elements__ :remove, args
+      end
+    end
+    
+    def keep(*args)
+      if args.empty?
+        super
+      else
+        __remove_elements__ :keep, RESOURCE_TYPES.map{|t|t.to_sym} - args
+      end
+    end
+    
+    def method_missing(symbol, *args, &block)
+      if symbol.to_s =~ /^filter_(.*)$/ && RESOURCE_TYPES.include?($1)
+        __filter_resource__($1, *args, &block)
+      else
+        super(symbol, *args, &block)
+      end
+    end
+    
+    private
+    
+    def __remove_elements__(sym, to_remove)
+      other_sym = (sym == :keep ? :remove : :keep)
+      raise FilterError, "Cannot call both keep and remove for elements in the same calendar", __caller__ if @keep_or_remove_elements == other_sym
+      @keep_or_remove_elements = sym
+      to_remove.each{|sym| __delegate__.send(sym).clear}
+    end
+      
+    def __filter_resource__(resource_type)
+      resources = __delegate__.send(resource_type.to_sym)
+      return resources unless block_given?
+      actions = resources.map do |res| 
+        wrapper = CalFilter.wrap_resource(res, resource_type)
+        catch(:bailout) do
+          yield wrapper
+        end
+        wrapper.__action__
+      end
+      __delegate__.send("#{resource_type}=".to_sym, CalFilter::keep_or_delete_items(resources, resource_type, actions))
+    end
+    
+  end
+  
+  def self.wrap_calendar(cal)
+    CalendarWrapper.new(cal)
+  end
+  
+  def self.wrap_resource(res, plural_resource_type)
+    # This works with the particular resource names in Icalendar:
+    singular_resource_type = plural_resource_type.sub(/s$/, '')
+    ResourceWrapper.new(res, singular_resource_type)
+  end
+  
+  def self.keep_or_delete_items(items, type, actions)
+    if actions.include?(:keep) && actions.include?(:remove)
+      raise CalFilter::FilterError, "Cannot both keep and remove #{type} in the same group.", caller(2)
+    end
+    keep_action = (actions.include?(:keep) ? :keep : :default)
+    kept_items = []
+    items.each_with_index{|item, i| kept_items << item if actions[i] == keep_action}
+    kept_items
+  end
+  
+end
+
+def filter_calendars_at(url, &block)
+  filter_calendars(open(url, 'r'), &block)
+end
+
+def filter_calendars(ics_data, &block)
+  filter_icalendars(Icalendar.parse(ics_data), &block)
+end
+
+def filter_icalendars(cals)
+  return cals unless block_given?
+  actions = cals.map do |cal| 
+    wrapper = CalFilter.wrap_calendar(cal)
+    catch(:bailout) do
+      yield wrapper
+    end
+    wrapper.__action__
+  end
+  new_cals = CalFilter::keep_or_delete_items(cals, 'calendars', actions)
+  os = CalFilter.output_stream
+  unless os.nil?
+    new_cals.each{|cal| os.puts cal.to_ical}
+  end
+  new_cals
+end

data/test/test_calfilter.rb

@@ -0,0 +1,102 @@
+require 'rubygems'
+require 'test/spec'
+require 'mocha'
+
+require 'calfilter'
+
+describe "filtering calendars" do
+  it "should pass things straight through" do
+    expected_cals = [1, 2, 3]
+    actual_cals = filter_icalendars(expected_cals.dup)
+    assert_equal expected_cals.size, actual_cals.size
+  end
+  
+  it "should delete a calendar when told" do
+    cals = filter_icalendars([1, 2, 3]){|cal| cal.remove if cal.__delegate__ == 2}
+    assert_equal [1, 3], cals
+  end
+  
+  it "should keep a calendar when told" do
+    cals = filter_icalendars([1, 2, 3]){|cal| cal.keep if cal.__delegate__ == 2}
+    assert_equal [2], cals
+  end
+  
+  it "should delete parts of a calendar when told" do
+    cals = filter_icalendars(%w{1 2 3}) do |cal| 
+      events = mock(:clear => nil)
+      cal.__delegate__.stubs(:events).returns(events)
+      cal.remove(:events)
+    end
+  end
+  
+  it "should keep parts of a calendar when told" do
+    cals = filter_icalendars(%w{1 2 3}) do |cal| 
+      events = mock(:clear => nil)
+      cal.__delegate__.stubs(:events).returns(events)
+      cal.keep(:freebusys, :journals, :todos)
+    end
+  end
+  
+  it "should complain if we both keep and remove a calendar" do
+    assert_raise(CalFilter::FilterError) do
+      cals = filter_icalendars([1]){|cal| cal.keep; cal.remove}
+    end
+  end
+  
+  it "should complain if we keep one calendar and remove another" do
+    assert_raises(CalFilter::FilterError) do
+      cals = filter_icalendars([1, 2, 3]) do |cal|
+        case cal.__delegate__
+        when 1: cal.keep;
+        when 2: cal.remove;
+        end
+      end
+    end
+  end
+  
+  it "should delegate unknown methods to the Calendar objects" do
+    results = []
+    cals = filter_icalendars([0, 1]){|cal| results << cal.zero?}
+    assert_equal [true, false], results
+  end
+    
+end
+
+describe "filtering resources" do
+  before do
+    @cal = Icalendar::Calendar.new
+    @cal.event do
+      dtstart     Date.new(2005, 04, 29)
+      dtend       Date.new(2005, 04, 28)
+      summary     "Meeting with the man."
+      description "Have a long lunch meeting and decide nothing..."
+      klass       "PRIVATE"
+    end
+    @cal.event do
+      dtstart     Date.new(2006, 04, 29)
+      dtend       Date.new(2005, 04, 28)
+      summary     "Project review"
+      description "Find a bunch of stuff to complain about and get complaining." 
+      klass       "PUBLIC"
+    end
+  end
+  
+  xit "should leave resources alone if no block specified" do
+    filter_icalendars([@cal]) do |cal|
+      cal.__delegate__.expects(:events).returns(@cal.events)
+      cal.filter_events
+    end
+  end
+  
+  xit "should delete a resource when told"
+  #@calw = CalFilter.wrap_resource(@cal.events, 'events')
+  
+  xit "should keep a resource when told" 
+  
+  xit "should complain if we both keep and remove a resource"
+  
+  xit "should complain if we keep one resource and remove another"
+  
+  xit "should delegate unknown methods to the resource objects"
+  
+end

data/test/test_calfilter_cgi.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'test/spec'
+require 'mocha'
+
+require 'calfilter'
+
+def at_exit(&block)
+  $at_exit_block = block
+end
+
+describe "calfilter cgi scripts" do
+  before(:all) do
+    CalFilter::CGI = ''
+    require 'calfilter/cgi'
+  end
+  
+  it "should initialize a CGIWrapper object" do
+    assert_not_nil CalFilter::CGIWrapper
+  end
+  
+  it "should set CalFilter's output stream" do
+    assert_not_nil CalFilter::CGIWRAPPER.output_stream
+    assert_equal CalFilter::CGIWRAPPER.output_stream, CalFilter.output_stream
+  end
+  
+  it "should finish the CGI on process exit" do
+    CalFilter::CGIWRAPPER.expects(:finish)
+    $at_exit_block.call
+  end
+  
+  it "should write proper output when finishing" do
+    CalFilter::CGI.expects(:out).with('text/calendar; charset=utf-8')
+    CalFilter::CGIWRAPPER.finish
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: calfilter
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Glenn Vanderburg
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDRDCCAiygAwIBAgIBADANBgkqhkiG9w0BAQUFADBIMQ4wDAYDVQQDDAVnbGVu
+  bjEeMBwGCgmSJomT8ixkARkWDnRoaW5rcmVsZXZhbmNlMRYwFAYKCZImiZPyLGQB
+  GRYGY29tZ2x2MB4XDTA4MDMwNDIwNDIzNFoXDTA5MDMwNDIwNDIzNFowSDEOMAwG
+  A1UEAwwFZ2xlbm4xHjAcBgoJkiaJk/IsZAEZFg50aGlua3JlbGV2YW5jZTEWMBQG
+  CgmSJomT8ixkARkWBmNvbWdsdjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
+  ggEBALXdD5Y00ZMPO/dL8sj1IcfomhezB+9rsO/FoCnR9TJyaOGPBAJBEfyA3SkP
+  hpbCkkUDpNlRR2sQHrtqBJovpw2oX6zakrG8PnDQQPU1oo0tWkiDtPFQc9lgDJOA
+  S/nQiS2D9rusOmpj84KpC6DUN80M+ap9z04Xadobuv7Cer/dTOfs4skUBiN/aonA
+  qtaRNOlOPGyPGiCa8tUQd53fVml2hSKIgt/+HfBHHWZkHs9UQRsqd7GICFi5R24i
+  ZNXbaRzw4637eCcjBhlEes9KMJOwayZ1KXHWzOdSzRJUI6nT4AQjw3GCyuXBmCY0
+  LFrbGOLYuqfiv/zr+Z+qqyI3Ul0CAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8E
+  BAMCBLAwHQYDVR0OBBYEFOsd6jtw384ogcRecKkFdFpm9SQkMA0GCSqGSIb3DQEB
+  BQUAA4IBAQBokYH6Pe63OU1O9t4z6jEom2NDieUlLWD9PTshI4UXUjxd83mjmg/Y
+  Cer/yqFHqQEW6BLNRmH6l2lw2Rb8CZdlh7K8Q8F/94M+actty2UvMgTyVEtOnyh/
+  QU8nqEil5vl7ppCwDeSF32cebsQoimkgAamOxVZVe5ipP1+UIO+Eu92Jt5k0hrnd
+  1Fz3W+wrffm45P2X/6Z36dXgZKn8dlHuYtsqgpQxBC92oE7UqHXvwAu3FFe+1EV7
+  LrV1pr2EyieDotJOooYNz/E+9ZeL14MBhDOVmPr4KHTTK4VwdxFtAKu2QK/NfAAl
+  zrNa6ECLh1VS/pV78rYbAO1ZXsg3l7bY
+  -----END CERTIFICATE-----
+
+date: 2008-05-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: icalendar
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "calfilter is a small library to assist in writing filtering programs for icalendar files or streams.  It can be used for various purposes, including:  * removing items from icalendar feeds that are not interesting to you * removing private information from your own calendar before publishing it to others * reformatting a provided calendar to highlight particular information"
+email: 
+- glenn@thinkrelevance.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- example.rb
+- lib/calfilter.rb
+- lib/calfilter/cgi.rb
+- lib/calfilter/tripit.rb
+- test/test_calfilter.rb
+- test/test_calfilter_cgi.rb
+has_rdoc: true
+homepage: http://opensource.thinkrelevance.com/wiki/calfilter
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: thinkrelevance
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: calfilter is a small library to assist in writing filtering programs for icalendar files or streams
+test_files: 
+- test/test_calfilter.rb
+- test/test_calfilter_cgi.rb

metadata.gz.sig

@@ -0,0 +1 @@
+u\�p S`S"y�+�a7��8i���0ԏ��B�(l3_�8�Ƚ��2p;���7v���ln�s;��ֵ;�l=�}���o�lށ�F%�̭XB�������d۾�;���!>�Yʿ�f;��1 �x��&�=.�EJ�W6@�#�+�L��S��y.�̿��q_T�ʙ2Ѭ$��\��\U�$�J�>>�����l|~@����vg��k-X$Z�i-��S��;��j3�6=h