ics_parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cd9cb4de61ebafff4c36462820aac8f46fa839f
+  data.tar.gz: 5b8ae88900375e3cd0102ac70ab840dc6afa7edd
+SHA512:
+  metadata.gz: 04285a82a6adbabfb8b3ac1154a016a7e02e28be06cb5df1f1f102dac557f9f372b27894ad8b410fa96ead56fee9d6a9850b48e218a89de4f1a4ca4e9fe89056
+  data.tar.gz: 7e0d3503fa4228dad2df895c1f1f69c87bbf4bd898c5ab12715cfe42d958b58a3191d5a77a2a7a1fb1b352019703ff4516a606aaa572f2525c00ed82861814d3

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/README.md

@@ -0,0 +1,31 @@
+IcsParser
+=========
+
+Reads an ICalendar file and returns the events in an array.
+
+Also supports recurring events with excluded dates (using EXDATE).
+
+It is not complete and I have only tested it on my feed (exported from Apple iCloud)
+so do not rely on it.
+
+# Example
+
+```
+require 'ics_parser'
+
+parser = IcsParser.from_file('path/to/file')
+# or parser = IcsParser.from_string(calendar)
+events = parser.events
+
+events.each do |event|
+  puts event.summary # string
+  puts event.starts_at # Time
+  puts event.ends_at # Time
+end
+```
+
+# Installation
+
+```
+gem install ics_parser
+```

data/ics_parser.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "ics_parser"
+  spec.version       = '0.0.1'
+  spec.authors       = ["Matúš Tomlein"]
+  spec.email         = ["matus@tomlein.org"]
+  spec.summary       = %q{Reads iCalendar feeds and returns events in an array.}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/matus-tomlein/ics_parser"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/event_parser.rb

@@ -0,0 +1,121 @@
+require 'ostruct'
+require 'time'
+
+class EventParser
+  def initialize(calendar_content)
+    @calendar_content = calendar_content
+  end
+
+  def events
+    events = []
+
+    get_events_in_calendar.each do |event|
+      summary = parse_summary event
+      starts_at = parse_starts_at event
+      ends_at = parse_ends_at event
+
+      if recurring_event? event
+        recurring_dates = parse_recurring_dates(event)
+
+        recurring_dates.each do |recurring_starts_at, recurring_ends_at|
+          events << new_event(summary,
+                              recurring_starts_at,
+                              recurring_ends_at)
+        end
+      else
+        events << new_event(summary,
+                            starts_at,
+                            ends_at)
+      end
+    end
+
+    events
+  end
+
+  private
+
+  def new_event(summary, starts_at, ends_at)
+    OpenStruct.new(summary: summary,
+                   starts_at: starts_at,
+                   ends_at: ends_at)
+  end
+
+  def get_events_in_calendar
+    beginnings = @calendar_content.split('BEGIN:VEVENT')
+    events = []
+
+    beginnings.each do |event_beginning|
+      next unless event_beginning.include? 'END:VEVENT'
+
+      events << event_beginning.split('END:VEVENT').first
+    end
+
+    events
+  end
+
+  def parse_summary(event)
+    /SUMMARY:(.*)/.match(event)[1]
+  end
+
+  def parse_starts_at(event)
+    Time.parse(/DTSTART[\w\/=;]*:(\d+T\d+)/.match(event)[1])
+  end
+
+  def parse_ends_at(event)
+    Time.parse(/DTEND[\w\/=;]*:(\d+T\d+)/.match(event)[1])
+  end
+
+  def recurring_event?(event)
+    event.include? 'RRULE:FREQ=WEEKLY;'
+  end
+
+  def parse_recurring_dates(event)
+    recurring_dates = {}
+    starts_at = parse_starts_at event
+    ends_at = parse_ends_at event
+    summary = parse_summary event
+
+    if event.include? 'RRULE:FREQ=WEEKLY;COUNT='
+      count = /RRULE:FREQ=WEEKLY;COUNT=(\d+)/.match(event)[1].to_i
+
+      count.times do |i|
+        recurring_starts_at = add_days_to_time(starts_at, i * 7)
+        recurring_ends_at = add_days_to_time(ends_at, i * 7)
+
+        unless is_date_excluded?(recurring_starts_at, event)
+          recurring_dates[recurring_starts_at] = recurring_ends_at
+        end
+      end
+
+    elsif event.include? 'RRULE:FREQ=WEEKLY;UNTIL='
+      until_time = Time.parse(/RRULE:FREQ=WEEKLY;UNTIL=(\d+T\d+)/.match(event)[1])
+
+      last_starts_at = starts_at
+      last_ends_at = ends_at
+
+      while last_starts_at <= until_time
+        unless is_date_excluded?(last_starts_at, event)
+          recurring_dates[last_starts_at] = last_ends_at
+        end
+
+        last_starts_at = add_days_to_time(last_starts_at, 7)
+        last_ends_at = add_days_to_time(last_ends_at, 7)
+      end
+
+    else
+      raise "Unsupported recurring event type: #{summary}"
+    end
+
+    recurring_dates
+  end
+
+  def is_date_excluded?(date, event)
+    date_str = date.strftime '%Y%m%dT%I%M%S'
+    not_excluded = /EXDATE[\w\/=;]*:#{date_str}/.match(event).nil?
+    !not_excluded
+  end
+
+  def add_days_to_time(time, days)
+    time + (days * 24 * 60 * 60)
+  end
+end

data/lib/ics_parser.rb

@@ -0,0 +1,19 @@
+require_relative 'event_parser'
+
+class IcsParser
+  def self.from_file(file)
+    from_string(File.read(file))
+  end
+
+  def self.from_string(text)
+    return IcsParser.new(text)
+  end
+
+  def initialize(calendar_content)
+    @calendar_content = calendar_content
+  end
+
+  def events
+    EventParser.new(@calendar_content).events
+  end
+end

data/spec/event_parser_spec.rb

@@ -0,0 +1,100 @@
+require_relative 'spec_helper'
+
+describe EventParser do
+  let(:sample_data) { File.read 'spec/sample.ics' }
+  let(:parser) { EventParser.new(sample_data) }
+
+  context 'one time event' do
+    let(:event) do
+      parser.events.find {|event| event.summary == 'one time event' }
+    end
+
+    it 'has the right start time' do
+      expect(event.starts_at).to eq Time.new(2015, 2, 24, 12, 30)
+    end
+
+    it 'has the right end time' do
+      expect(event.ends_at).to eq Time.new(2015, 2, 24, 13, 15)
+    end
+  end
+
+  context 'recurring weekly event' do
+    let(:events) do
+      parser.events.find_all {|event| event.summary == 'recurring weekly event' }
+    end
+
+    it 'found 7 events' do
+      expect(events.size).to eq 7
+    end
+
+    it 'have the right start times' do
+      expected_times = [
+        Time.new(2015, 4, 15, 14, 0),
+        Time.new(2015, 4, 22, 14, 0),
+        Time.new(2015, 4, 29, 14, 0),
+        Time.new(2015, 5, 6, 14, 0),
+        Time.new(2015, 5, 13, 14, 0),
+        Time.new(2015, 5, 20, 14, 0),
+        Time.new(2015, 5, 27, 14, 0)
+      ]
+      times = events.map {|event| event.starts_at }
+      expect(times).to eq expected_times
+    end
+
+    it 'have the right end times' do
+      expected_times = [
+        Time.new(2015, 4, 15, 16, 0),
+        Time.new(2015, 4, 22, 16, 0),
+        Time.new(2015, 4, 29, 16, 0),
+        Time.new(2015, 5, 6, 16, 0),
+        Time.new(2015, 5, 13, 16, 0),
+        Time.new(2015, 5, 20, 16, 0),
+        Time.new(2015, 5, 27, 16, 0)
+      ]
+      times = events.map {|event| event.ends_at }
+      expect(times).to eq expected_times
+    end
+  end
+
+  context 'recurring event with exdates' do
+    let(:events) do
+      parser.events.find_all {|event| event.summary == 'recurring event with exdates' }
+    end
+
+    it 'found some events' do
+      expect(events.size).to be > 1
+    end
+
+    it 'contains the correct dates' do
+      times = events.map {|event| event.starts_at }
+
+      expect(times).to include Time.new(2014, 11, 19, 9, 0)
+      expect(times).to include Time.new(2014, 11, 26, 9, 0)
+    end
+
+    it 'didn\'t find the excluded events' do
+      times = events.map {|event| event.starts_at }
+
+      excluded_times = [
+        Time.new(2015, 4, 8, 9, 0),
+        Time.new(2015, 6, 10, 9, 0),
+        Time.new(2015, 4, 15, 9, 0),
+        Time.new(2015, 5, 20, 9, 0),
+        Time.new(2015, 3, 25, 9, 0),
+        Time.new(2015, 6, 3, 9, 0),
+        Time.new(2014, 12, 3, 9, 0),
+        Time.new(2015, 3, 11, 9, 0),
+        Time.new(2015, 7, 8, 9, 0),
+        Time.new(2014, 12, 24, 9, 0),
+        Time.new(2014, 12, 31, 9, 0),
+        Time.new(2015, 7, 1, 9, 0),
+        Time.new(2015, 6, 24, 9, 0),
+        Time.new(2015, 4, 1, 9, 0),
+      ]
+
+      excluded_times.each do |excluded_time|
+        expect(times).not_to include excluded_time
+      end
+    end
+  end
+end

data/spec/ics_parser_spec.rb

@@ -0,0 +1,5 @@
+require_relative 'spec_helper'
+
+describe IcsParser do
+  let(:sample_data) { File.read 'spec/sample.ics' }
+end

data/spec/sample.ics

@@ -0,0 +1,71 @@
+BEGIN:VCALENDAR
+CALSCALE:GREGORIAN
+VERSION:2.0
+METHOD:PUBLISH
+X-WR-CALNAME:Supervision
+X-WR-TIMEZONE:Europe/Copenhagen
+X-APPLE-CALENDAR-COLOR:#FFCC00
+BEGIN:VTIMEZONE
+TZID:Europe/Copenhagen
+BEGIN:DAYLIGHT
+TZOFFSETFROM:+0100
+RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=-1SU
+DTSTART:19810329T020000
+TZNAME:CEST
+TZOFFSETTO:+0200
+END:DAYLIGHT
+BEGIN:STANDARD
+TZOFFSETFROM:+0200
+RRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU
+DTSTART:19961027T030000
+TZNAME:CET
+TZOFFSETTO:+0100
+END:STANDARD
+END:VTIMEZONE
+BEGIN:VEVENT
+CREATED:20150614T194602Z
+UID:3DE997B6-EB52-4893-A922-6A1BCB35340F
+RRULE:FREQ=WEEKLY;COUNT=7
+DTEND;TZID=Europe/Copenhagen:20150415T160000
+TRANSP:OPAQUE
+SUMMARY:recurring weekly event
+DTSTART;TZID=Europe/Copenhagen:20150415T140000
+DTSTAMP:20150614T194602Z
+SEQUENCE:0
+END:VEVENT
+BEGIN:VEVENT
+CREATED:20150614T194154Z
+UID:7B924445-C7BC-4F0A-BCFD-EFBF4394EAFA
+DTEND;TZID=Europe/Copenhagen:20150224T131500
+TRANSP:OPAQUE
+SUMMARY:one time event
+DTSTART;TZID=Europe/Copenhagen:20150224T123000
+DTSTAMP:20150614T194154Z
+SEQUENCE:0
+END:VEVENT
+BEGIN:VEVENT
+CREATED:20150614T193544Z
+UID:6371A3DF-17C9-47B7-9277-F7D2596CCD36
+RRULE:FREQ=WEEKLY;UNTIL=20150714T235959Z
+DTEND;TZID=Europe/Copenhagen:20141119T100000
+EXDATE;TZID=Europe/Copenhagen:20150408T090000
+EXDATE;TZID=Europe/Copenhagen:20150610T090000
+EXDATE;TZID=Europe/Copenhagen:20150415T090000
+EXDATE;TZID=Europe/Copenhagen:20150520T090000
+EXDATE;TZID=Europe/Copenhagen:20150325T090000
+EXDATE;TZID=Europe/Copenhagen:20150603T090000
+EXDATE;TZID=Europe/Copenhagen:20141203T090000
+EXDATE;TZID=Europe/Copenhagen:20150311T090000
+EXDATE;TZID=Europe/Copenhagen:20150708T090000
+EXDATE;TZID=Europe/Copenhagen:20141224T090000
+EXDATE;TZID=Europe/Copenhagen:20141231T090000
+EXDATE;TZID=Europe/Copenhagen:20150701T090000
+EXDATE;TZID=Europe/Copenhagen:20150624T090000
+EXDATE;TZID=Europe/Copenhagen:20150401T090000
+TRANSP:OPAQUE
+SUMMARY:recurring event with exdates
+DTSTART;TZID=Europe/Copenhagen:20141119T090000
+DTSTAMP:20150614T193544Z
+SEQUENCE:0
+END:VEVENT
+END:VCALENDAR

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require File.expand_path("../../lib/ics_parser", __FILE__)
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ics_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matúš Tomlein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email:
+- matus@tomlein.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- ics_parser.gemspec
+- lib/event_parser.rb
+- lib/ics_parser.rb
+- spec/event_parser_spec.rb
+- spec/ics_parser_spec.rb
+- spec/sample.ics
+- spec/spec_helper.rb
+homepage: https://github.com/matus-tomlein/ics_parser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Reads iCalendar feeds and returns events in an array.
+test_files:
+- spec/event_parser_spec.rb
+- spec/ics_parser_spec.rb
+- spec/sample.ics
+- spec/spec_helper.rb