ics 0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+*.sw*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2-p0@ics

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    ics (0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.4.2)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    awesome_print (0.3.1)
+    diff-lcs (1.1.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  awesome_print
+  ics!
+  rspec (= 2.3.0)

data/README.rdoc

@@ -0,0 +1,74 @@
+= ICS
+
+ICS is a library that reads ICS files and parses them into ICS::Event objects.
+
+== Usage
+
+=== Short version
+
+  require 'rubygems'
+  require 'ics'
+  events = ICS::Event.file(File.open('calendar.ics'))
+  events.map(&:summary)
+  #=> ['Walk dog', 'Solve world hunger, tell noone', ...]
+
+=== Longer version
+
+The ICS::Event class can read in and parse an exported .ics file. For example, from iCal, export a calendar (select calendar, File, Export..., Export...):
+  ICS::Event.file(File.open('calendar.ics'))
+will return an array of events with whatever attributes are in the .ics file for each event. The ICS::Event object will have a method name for each attribute in lower case form.
+  # calendar.ics
+  ...
+  SUMMARY:Grocery shopping
+  ...
+  
+  # ruby environment
+  event.summary
+  #=> 'Grocery shopping'
+
+Here are a list of known attributes:
+* TRANSP
+* DTEND
+* UID
+* DTSTAMP
+* LOCATION
+* DESCRIPTION
+* URL
+* STATUS
+* SEQUENCE
+* SUMMARY
+* DTSTART
+* CREATED
+# For the alarm...
+* # BEGIN:VALARM (ignored)
+* X-WR-ALARMUID
+* TRIGGER
+* ATTACH
+* ACTION
+* # END:VALARM (ignored)
+
+=== Data type casting
+
+By default, each attribute method returns a string literal. For convenience, attribute methods can be easily defined in the ICS::Event class for customized behavior. Currently <tt>ICS::Event#dtstart</tt> is the only one that is defined:
+  event.dtstart.class
+  #=> Time
+
+=== More "Railsy"
+
+<tt>ICS::Event#started_at</tt> is an alias for <tt>ICS::Event#dtstart</tt>. <tt>ICS::Event#started_on</tt> returns a Date object converted from <tt>ICS::Event#dtstart</tt>. More later...
+
+=== Metadata
+
+Some attributes have some metadata attached to them. For example, sometimes the DTSTART attribute has the time zone:
+
+  DTSTART;TZID=America/Chicago:20100331T190000
+
+As of this version, metadata is ignored.
+
+== Installation
+
+  gem install ics
+
+== Ruby
+
+Written in Ruby 1.9.2p0.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/ics.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ics/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ics"
+  s.version     = ICS::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Jared Ning']
+  s.email       = ['jared@redningja.com']
+  s.summary     = 'Read .ics files'
+  s.description = 'Parse exported .ics files into Event objects.'
+
+  s.rubyforge_project = "ics"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'autotest'
+  s.add_development_dependency 'awesome_print'
+  s.add_development_dependency 'rspec', '2.3.0'
+end

data/lib/ics.rb

@@ -0,0 +1 @@
+require 'ics/event'

data/lib/ics/event.rb

@@ -0,0 +1,60 @@
+require 'date'
+
+module ICS
+
+  class Event
+
+    # Given a hash of attributes, define a method for each key that returns the value.
+    # Attributes stored in instance variable.
+    def initialize(attributes = {})
+      @attributes = attributes
+      attributes.each do |key, val|
+        unless respond_to?(key)
+          self.class.send :define_method, key do
+            @attributes[key]
+          end
+        end
+      end
+    end
+
+    # Return time object.
+    # Assumes time in UTC.
+    def dtstart
+      return nil unless @attributes[:dtstart]
+      DateTime.parse(@attributes[:dtstart]).to_time.utc
+    end
+    alias_method :started_at, :dtstart
+
+    def started_on
+      dtstart.to_date if dtstart
+    end
+
+    class << self
+
+      # Given an exported ical file, parse it and create events.
+      def file(file)
+        # format line endings.
+        content = file.readlines.map(&:chomp).join($/)
+        line_ending = $/
+        content.split("BEGIN:VEVENT#{line_ending}")[1..-1].map do |data_string|
+          data_string = data_string.split("END:VEVENT#{line_ending}").first
+          new parse(data_string)
+        end
+      end
+
+      def parse(str)
+        str.split($/).inject({}) do |hash, line|
+          key, value = line.split(':', 2)
+          next hash if key =~ /^BEGIN/ # Ignore any other book ends.
+          value = value.chomp if value
+          key = key.split(';', 2).first # Ignore extra data other than just the name of the attribute.
+          hash[key.downcase.to_sym] = value
+          hash
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/ics/version.rb

@@ -0,0 +1,3 @@
+module ICS
+  VERSION = "0.1"
+end

data/spec/event_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe ICS::Event do
+
+  it 'parses event data string and generates a hash' do
+    ICS::Event.parse("NAME:value with spaces\nKEY:val").should == {:name => 'value with spaces', :key => 'val'}
+  end
+
+  it 'should read a file, parse it, and return an array of events' do
+    file = file_with_content(<<-END)
+BEGIN:VEVENT
+INDEX:0
+END:VEVENT
+BEGIN:VEVENT
+INDEX:1
+END:VEVENT
+END
+    events = ICS::Event.file(file)
+    events.size.should == 2
+    events.each_with_index do |event, i|
+      event.index.should == i.to_s
+    end
+  end
+
+  it 'should be initialized with a hash of attributes and have keys defined as methods returning values' do
+    event = ICS::Event.new(:attribute => '1')
+    event.should respond_to(:attribute)
+    event.attribute.should == '1'
+  end
+
+  it '#dtstart should return time object' do
+    time = Time.now.utc
+    event = ICS::Event.new(:dtstart => time.strftime('%Y%m%dT%H%M%SZ'))
+    event.dtstart.to_i.should == time.to_i
+  end
+
+  it 'should handle real file' do
+    events = ICS::Event.file(File.open('spec/example_events.ics'))
+    events.size.should == 2
+  end
+
+  it 'should parse attributes ignoring extra data like time zone for DTSTART' do
+    data = 'DTSTART;TZID=asdfasdf:1'
+    ICS::Event.parse(data).should == {:dtstart => '1'}
+  end
+
+end

data/spec/example_events.ics

@@ -0,0 +1,33 @@
+BEGIN:VEVENT
+TRANSP:OPAQUE
+DTEND:20091011T020000Z
+UID:D388E9D6-CD69-487F-80EB-A9095B8E29DC
+DTSTAMP:20091123T233512Z
+LOCATION:
+DESCRIPTION:
+URL;VALUE=URI:http://www.whatsthematterwithkansas.com/trailer.html
+STATUS:CONFIRMED
+SEQUENCE:5
+SUMMARY:What's the Matter \nwith Kansas?
+DTSTART:20091011T010000Z
+CREATED:20090915T012027Z
+BEGIN:VALARM
+X-WR-ALARMUID:44215ABF-8E3E-490F-BE97-46EAAEAB526B
+TRIGGER:PT0S
+ATTACH;VALUE=URI:Glass
+ACTION:AUDIO
+END:VALARM
+END:VEVENT
+BEGIN:VEVENT
+TRANSP:OPAQUE
+DTEND;TZID=America/Chicago:20100331T200000
+UID:C4676085-7B38-4A1A-9382-C3503A3A87A5
+DTSTAMP:20100420T050645Z
+LOCATION:
+DESCRIPTION:
+STATUS:CONFIRMED
+SEQUENCE:2
+SUMMARY:traffic
+DTSTART;TZID=America/Chicago:20100331T190000
+CREATED:20100401T004845Z
+END:VEVENT

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'ics'
+require 'tempfile'
+require 'awesome_print'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include Macros
+end

data/spec/support/macros.rb

@@ -0,0 +1,10 @@
+module Macros
+
+  def file_with_content(content)
+    file = Tempfile.new('tmp')
+    file.write content
+    file.rewind
+    file
+  end
+
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: ics
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Jared Ning
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: awesome_print
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  version_requirements: *id003
+description: Parse exported .ics files into Event objects.
+email: 
+- jared@redningja.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- ics.gemspec
+- lib/ics.rb
+- lib/ics/event.rb
+- lib/ics/version.rb
+- spec/event_spec.rb
+- spec/example_events.ics
+- spec/spec_helper.rb
+- spec/support/macros.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ics
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Read .ics files
+test_files: 
+- spec/event_spec.rb
+- spec/example_events.ics
+- spec/spec_helper.rb
+- spec/support/macros.rb