ical_importer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTZiMWQ4NmU4NWI1NzkwNmQxNGY3OWVlZDk3MzYwN2JhYjFmMmYxNA==
+    YzgyNDVmMDk4MjIxZDE5ZjgxYWZlZjBmN2EwMmVmMGEwOTkwNmZmNQ==
   data.tar.gz: !binary |-
-    YTdhNTFiZTRkMzRmOTAwYTA4NDUzNDIzYWQ2MDZjYzY1MTk0NmUzNg==
+    NWE0MzY0YTNlZjk2YjA2MDA5YmJmOTZiZGM3MTY2ZTJhOTM4Y2M1YQ==
 SHA512:
   metadata.gz: !binary |-
-    Mzc5MjUyMTM0ZTQ4NWFmMjBmYjQ2NDBhOTMyYjNmY2U0ZDgwYzU1OWFlY2Rk
-    MWY3NjQwZWM4MGZkZjMyN2ZiOWYzYWUxYWUxNTE5YmM3YTRlY2ZjMDRhYzM4
-    NmIyMGYxZTJhZTVhNzJjMzJlOGUzOGYxNTE4MDRmMGZkNDI4OWQ=
+    Yzk4YWUyMjdjMjZkOWM5MGRkMjZiMzZjODI5YTU3NjMyNjVmYzliNTQ4MzQ4
+    NDZiNjc4ZjdlOTNlMzE5OGYyMTUyOWI0OTEwYzk0YzViNWIzNmQwNGRhMTIz
+    ZjMwNWEwNWZkODdmMDJmOWY4Mjg1NzE1ZWJlYjhlZjMxZDdhMTc=
   data.tar.gz: !binary |-
-    NDU0MTViOGQxMzk5ZTU1NTcyN2Q1Njk4M2MzODM0MGJhOTQ0YWFlYjY3Yjk5
-    NDgzNmQxN2QwMGYwMGIxYjQyZTU0Nzc2ZmEwOThjZTI4NDJiNGQ4YTA2MWI4
-    MTI3MjAyYzNhNTcyN2MyMWQ4NjNiNTYyZDc1MDNkODhiMmRjMTU=
+    MzczNzEwMWQ2ODNhNTczZmE0YTVkZTMxMjRmMWJkYzM4YjUwMGE2NDk5NDYz
+    MTdiNmNjY2M0ZTliNjUwZDMwNWYzNGVmMTU5YWFiZTkyMDAwNmIwODEwZmFi
+    YTI3ZDUxMTZhYTY2Mzc1OGE2YzlkNGZhYTk1ZjY0YTg0MmM1MDA=

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+#### v0.3.0
+* SITE-1812-Replace-rical-with-icalendar
+
+  > Jake Waletzko: Zheng Jia: https://github.com/sportngin/ical_importer/pull/11
+
 #### v0.2.0
 * Modernize and Prepare Prep
 

data/README.md

@@ -68,6 +68,13 @@ parser.single_events
 
 * Recurrence events are not the same as recurring events
 
+# Known Issues
+
+* ICal feeds with `,`'s
+  - This gem uses icalendar version `2.3.0`. There is an issue(https://github.com/icalendar/icalendar/issues/121) when importing events with fields that do not escape `,`'s.
+  - The issue is fixed with https://github.com/icalendar/icalendar/commit/9a00cae834f78c265fdccecaf37bf3e77f91416f
+  - Add `gem 'icalendar', :git => 'https://github.com/icalendar/icalendar', :ref => '108b5278a6d4cdc150e49cdcb641e40440c8c278'` to your project's gemfile to fix this issue.
+
 # TODO
 
 * Current implementation based on an extraction from another app

data/ical_importer.gemspec

@@ -17,7 +17,8 @@ Gem::Specification.new do |gem|
   gem.version       = IcalImporter::VERSION
 
   gem.add_dependency 'activesupport', ['> 3.0.0', '< 4.0.0']
-  gem.add_dependency 'ri_cal', '~> 0.8'
+  gem.add_dependency 'tzinfo', '~> 0.3.29'
+  gem.add_dependency 'icalendar', '~> 2.3.0'
   gem.add_dependency 'i18n', '~> 0.6'
 
   gem.add_development_dependency 'rake'

data/lib/ical_importer.rb

@@ -1,5 +1,6 @@
 require 'active_support/all'
-require 'ri_cal'
+require 'tzinfo'
+require 'icalendar'
 
 require 'open-uri'
 require 'timeout'

data/lib/ical_importer/parser.rb

@@ -17,7 +17,7 @@ module IcalImporter
       if should_parse?
         @bare_feed.pos = 0
         begin
-          @feed = RiCal.parse @bare_feed
+          @feed = Icalendar.parse @bare_feed
         rescue Exception => e
           # I know, I'm dirty, fix this to log to a config'd log
         end
@@ -58,14 +58,14 @@ module IcalImporter
     private
 
     def get_timezone
-      if feed.present? && feed.first.x_properties["X-WR-TIMEZONE"].present?
-        feed.first.x_properties["X-WR-TIMEZONE"].first.value
+      if feed.present? && feed.first.custom_properties["x_wr_timezone"].present?
+        feed.first.custom_properties["x_wr_timezone"].first.value
       end
     end
 
     def get_name
-      if feed.present? && feed.first.x_properties["X-WR-CALNAME"].present?
-        feed.first.x_properties["X-WR-CALNAME"].first.value
+      if feed.present? && feed.first.custom_properties["x_wr_calname"].present?
+        feed.first.custom_properties["x_wr_calname"].first.value
       end
     end
 

data/lib/ical_importer/recurrence_event_builder.rb

@@ -7,7 +7,7 @@ module IcalImporter
     end
 
     def <<(event)
-      raise ArgumentError, "Must be a RiCal Event" unless event.is_a? RiCal::Component::Event
+      raise ArgumentError, "Must be an Icalendar Event" unless event.is_a? Icalendar::Event
       @events_to_build << event
     end
 
@@ -24,10 +24,10 @@ module IcalImporter
     def build_new_local_event(remote_event)
       remote_event = RemoteEvent.new remote_event
       LocalEvent.new({
-        :uid => remote_event.uid,
-        :title => remote_event.summary,
-        :description => remote_event.description,
-        :location => remote_event.location || '',
+        :uid => remote_event.uid.to_s,
+        :title => remote_event.summary.to_s,
+        :description => remote_event.description.to_s,
+        :location => remote_event.location.to_s,
         :start_date_time => remote_event.start_date_time,
         :end_date_time => remote_event.end_date_time,
         :date_exclusions => [DateExclusion.new(remote_event.recurrence_id)],

data/lib/ical_importer/remote_event.rb

@@ -2,12 +2,12 @@ module IcalImporter
   class RemoteEvent
     attr_accessor :event, :utc
     alias :utc? :utc
-    delegate :uid, :summary, :location, :recurrence_id, :description, :recurs?, :rrule_property, :exdate, :to => :event
+    delegate :uid, :summary, :location, :description, :rrule, :exdate, :to => :event
 
     def initialize(event)
       @event = event
       begin
-        @utc = @event.dtstart.try(:tzid) != :floating
+        @utc = @event.dtstart.tz_utc
       rescue
         @utc = true
       end
@@ -21,6 +21,10 @@ module IcalImporter
       get_date_time_for :dtend
     end
 
+    def recurrence_id
+      event.recurrence_id ? event.recurrence_id.to_datetime : nil
+    end
+
     def all_day_event?
       begin
         (Time.parse(end_date_time.to_s) - Time.parse(start_date_time.to_s)) >= 1.day
@@ -31,11 +35,11 @@ module IcalImporter
 
     def event_attributes
       {
-        :uid => uid,
-        :title => summary,
+        :uid => uid.to_s,
+        :title => summary.to_s,
         :utc => utc?,
-        :description => description,
-        :location => location || '',
+        :description => description.to_s,
+        :location => location.to_s,
         :start_date_time => start_date_time,
         :end_date_time => end_date_time,
         :all_day_event => all_day_event?
@@ -48,8 +52,8 @@ module IcalImporter
       event_method = event_method.to_sym
       raise ArgumentError, "Should be dtend or dtstart" unless [:dtstart, :dtend].include? event_method
       event_time = event.send event_method
-      if event_time.is_a? DateTime
-        (event_time.tzid == :floating) ? event_time : event_time.utc
+      if event_time.respond_to?(:tz_utc)
+        (event_time.tz_utc) ? event_time.utc : event_time.to_datetime
       else
         begin
           event_time.to_datetime

data/lib/ical_importer/single_event_builder.rb

@@ -12,8 +12,8 @@ module IcalImporter
     def build
       # handle recuring events
       @local_event.tap do |le|
-        if @event.recurs?
-          @rrule = @event.rrule_property.first # only support recurrence on one schedule
+        if @event.rrule.present?
+          @rrule = @event.rrule.first # only support recurrence on one schedule
           # set out new event's basic rucurring properties
           le.attributes = recurrence_attributes
 
@@ -49,27 +49,28 @@ module IcalImporter
 
     def recurrence_attributes
       {
-        :recur_interval => recur_map[@rrule.freq],
-        :recur_interval_value => @rrule.interval,
+        :recur_interval => recur_map[@rrule.frequency],
+        :recur_interval_value => @rrule.interval || 1,
         :recur_end_date => @rrule.until.try(:to_datetime)
       }
     end
 
     def set_date_exclusion
       # set any date exclusions
-      @local_event.date_exclusions = @event.exdate.flatten.map{|d| DateExclusion.new(d)}
+      @local_event.date_exclusions = @event.exdate.flatten.map{|d| DateExclusion.new(d.to_datetime)}
     end
 
     def frequency_set
-      # if .bounded? is an integer that's googles "recur X times"
+      # if bounded is an integer that's googles "recur X times"
       # if that's the case we try to figure out the date it should be by
-      # multiplying thise "X" times by the frequency that the event recurrs
-      case @rrule.freq
+      # multiplying this "X" times by the frequency that the event recurrs
+      interval = @rrule.interval || 1
+      case @rrule.frequency
       when "DAILY"
-        @local_event.recur_end_date = @local_event.start_date_time + (@rrule.bounded? * @rrule.interval - 1).days if @rrule.bounded?.is_a? Fixnum # convert X times to a date
+        @local_event.recur_end_date = @local_event.start_date_time + (@rrule.count * interval - 1).days if @rrule.count.is_a? Fixnum # convert X times to a date
       when "WEEKLY"
-        if @rrule.to_ical.include?("BYDAY=")
-          remote_days = @rrule.to_ical.split("BYDAY=").last.split(";WKST=").first.split(',')
+        if @rrule.value_ical.include?("BYDAY=")
+          remote_days = @rrule.value_ical.split("BYDAY=").last.split(";WKST=").first.split(',')
           day_map.each do |abbr, day|
             @local_event.send "recur_week_#{day}=", remote_days.include?(abbr)
           end
@@ -80,12 +81,12 @@ module IcalImporter
           end
         end
         # recurrence X times is probably broken - we can select multiple times in a week
-        @local_event.recur_end_date = @local_event.start_date_time + ((@rrule.bounded? * @rrule.interval - 1) / remote_days.length).weeks if @rrule.bounded?.is_a?(Fixnum)
+        @local_event.recur_end_date = @local_event.start_date_time + ((@rrule.count * interval - 1) / remote_days.length).weeks if @rrule.count.is_a? Fixnum
       when "MONTHLY"
-        @local_event.recur_month_repeat_by = (@rrule.to_ical =~ /BYDAY/) ? "day_of_week" : "day_of_month"
-        @local_event.recur_end_date = @local_event.start_date_time + (@rrule.bounded? * @rrule.interval - 1).months if @rrule.bounded?.is_a? Fixnum # convert X times to a date
+        @local_event.recur_month_repeat_by = (@rrule.value_ical =~ /BYDAY/) ? "day_of_week" : "day_of_month"
+        @local_event.recur_end_date = @local_event.start_date_time + (@rrule.count * interval - 1).months if @rrule.count.is_a? Fixnum # convert X times to a date
       when "YEARLY"
-        @local_event.recur_end_date = @local_event.start_date_time + (@rrule.bounded? * @rrule.interval - 1).years if @rrule.bounded?.is_a? Fixnum # convert X times to a date
+        @local_event.recur_end_date = @local_event.start_date_time + (@rrule.count * interval - 1).years if @rrule.count.is_a? Fixnum # convert X times to a date
       end
     end
 

data/lib/ical_importer/version.rb

@@ -1,3 +1,3 @@
 module IcalImporter
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/ical_importer/parser_spec.rb

@@ -13,7 +13,7 @@ module IcalImporter
     describe '#initialize' do
       it "parses with rical" do
         Parser.any_instance.stub(:open_ical).and_return bare_stuff
-        RiCal.should_receive(:parse).with bare_stuff
+        Icalendar.should_receive(:parse).with bare_stuff
         Parser.new(url)
       end
 
@@ -102,7 +102,7 @@ module IcalImporter
       it "finds the feed's timezone out of the x properties" do
         @value = stub
         @value.should_receive(:value)
-        subject.stub :feed => [stub(x_properties: { "X-WR-TIMEZONE" =>  [@value] })]
+        subject.stub :feed => [stub(custom_properties: { "x_wr_timezone" =>  [@value] })]
         subject.send(:get_timezone)
       end
 
@@ -111,7 +111,7 @@ module IcalImporter
       end
 
       it "returns nil if no timezone x property exists" do
-        subject.stub :feed => [stub(x_properties: { "X-WR-DERPHERP" =>  [@value] })]
+        subject.stub :feed => [stub(custom_properties: { "x_wr_derpherp" =>  [@value] })]
         subject.send(:get_timezone).should be_nil
       end
     end
@@ -120,7 +120,7 @@ module IcalImporter
       it "finds the feed's name out of the x properties" do
         @value = stub
         @value.should_receive(:value)
-        subject.stub :feed => [stub(x_properties: { "X-WR-CALNAME" =>  [@value] })]
+        subject.stub :feed => [stub(custom_properties: { "x_wr_calname" =>  [@value] })]
         subject.send(:get_name)
       end
 
@@ -129,7 +129,7 @@ module IcalImporter
       end
 
       it "returns nil if no name x property exists" do
-        subject.stub :feed => [stub(x_properties: { "X-WR-DERPHERP" =>  [@value] })]
+        subject.stub :feed => [stub(custom_properties: { "x_wr_derpherp" =>  [@value] })]
         subject.send(:get_name).should be_nil
       end
     end

data/spec/ical_importer/recurrence_event_builder_spec.rb

@@ -17,7 +17,7 @@ module IcalImporter
 
       it "fails with incorrect event type" do
         new_event = stub(:is_a? => false)
-        expect { subject.<<(new_event) }.to raise_error(ArgumentError, "Must be a RiCal Event")
+        expect { subject.<<(new_event) }.to raise_error(ArgumentError, "Must be an Icalendar Event")
       end
     end
 
@@ -34,13 +34,13 @@ module IcalImporter
     end
 
     describe "#build_new_local_event" do
-      let(:remote_event) { stub :summary => "birthdayy",
-                           :uid => 1,
-                           :description => "do stuff",
-                           :location => "here",
+      let(:remote_event) { stub :summary => stub(:to_s => "birthdayy"),
+                           :uid => stub(:to_s => 1),
+                           :description => stub(:to_s => "do stuff"),
+                           :location => stub(:to_s => "here"),
                            :start_date_time => "today",
                            :end_date_time => "tomorrow",
-                           :recurrence_id => 1
+                           :recurrence_id => "20120715".to_datetime
       }
       it "creates a new event" do
         RemoteEvent.stub(:new => remote_event)

data/spec/ical_importer/remote_event_spec.rb

@@ -2,10 +2,9 @@ require 'spec_helper'
 module IcalImporter
   describe RemoteEvent do
     subject { RemoteEvent.new(event) }
-    let(:event) { stub :dtstart => stub(:tzid => nil) }
+    let(:event) { stub :dtstart => stub(:tz_utc => true) }
     it { should respond_to :description }
-    it { should respond_to :recurs? }
-    it { should respond_to :rrule_property }
+    it { should respond_to :rrule }
     it { should respond_to :exdate }
     describe "#initialize" do
       describe "dtstart tzid nil" do
@@ -16,7 +15,7 @@ module IcalImporter
       end
 
       describe "dtstart tzid == :floating" do
-        let(:event) { stub :dtstart => stub(:tzid => :floating) }
+        let(:event) { stub :dtstart => stub(:tz_utc => false) }
         it "sets utc and event" do
           subject.event.should == event
           subject.utc?.should == false
@@ -42,7 +41,8 @@ module IcalImporter
       describe "without a floating tzid" do
         let(:event) { stub :dtstart => stub(
           :is_a? => true,
-          :tzid => nil,
+          :utc? => true,
+          :tz_utc => true,
           :time => "20120715".to_datetime,
           :utc => "20120715".to_datetime.utc) }
         it "uses the utc time of the datetime" do
@@ -52,13 +52,13 @@ module IcalImporter
     end
 
     describe "#event_attributes" do
-      let(:event) { RiCal.parse(sample_ics).first.events.first }
+      let(:event) { Icalendar.parse(sample_ics).first.events.first }
       it "fills in some attributes" do
         subject.event_attributes.should == {
           :uid => "1629F7A5-5A69-43CB-899E-4CE9BD5F069F",
           :title => "Recurring Event",
           :utc => true,
-          :description => nil,
+          :description => "",
           :location => "",
           :start_date_time => "Wed, 14 Sep 2016 00:00:00 +0000".to_datetime,
           :end_date_time => "Thu, 15 Sep 2016 00:00:00 +0000".to_datetime,

data/spec/ical_importer/single_event_builder_spec.rb

@@ -2,13 +2,13 @@ require 'spec_helper'
 module IcalImporter
   describe SingleEventBuilder do
     subject { SingleEventBuilder.new(event) }
-    let(:event) { RiCal.parse(sample_ics('mn_twins')).first.events.first }
+    let(:event) { Icalendar.parse(sample_ics('mn_twins')).first.events.first }
     describe "#build" do
       it "builds an event" do
         new_event = subject.build
         new_event.should be_a LocalEvent
         new_event.title.should == "Spring Training: Tampa Bay 3 - Minnesota 7"
-        new_event.utc?.should == true
+        new_event.utc?.should == false
         new_event.description.should == "Spring Training: Tampa Bay 3 - Minnesota 7\n\nClick below for game previews, wraps and boxscores plus video, tickets, stats, gameday and more!\nhttp://mlb.mlb.com/mlb/gameday/index.jsp?gid=2012_03_03_tbamlb_minmlb_1\n\nWatch or Listen with MLB.TV: http://mlb.mlb.com/schedule/index.jsp?c_id=min&m=03&y=2012\n\nLocal Radio: 1500 ESPN"
         new_event.location.should == "Lee County Sports Complex, Hammond County Stadium, Lee County"
         new_event.all_day_event.should == false

data/spec/support/mn_twins.ics

@@ -29,9 +29,9 @@ DTEND;TZID=America/New_York:20120303T160500
 DTSTAMP:20120806T221604Z
 UID:332106@mlb.com
 CREATED:20111130T212813Z
-DESCRIPTION:Spring Training: Tampa Bay 3 - Minnesota 7\n\nClick below for game previews, wraps and boxscores plus video, tickets, stats, gameday and more!\nhttp://mlb.mlb.com/mlb/gameday/index.jsp?gid=2012_03_03_tbamlb_minmlb_1\n\nWatch or Listen with MLB.TV: http://mlb.mlb.com/schedule/index.jsp?c_id=min&m=03&y=2012\n\nLocal Radio: 1500 ESPN
+DESCRIPTION:Spring Training: Tampa Bay 3 - Minnesota 7\n\nClick below for game previews\, wraps and boxscores plus video\, tickets\, stats\, gameday and more!\nhttp://mlb.mlb.com/mlb/gameday/index.jsp?gid=2012_03_03_tbamlb_minmlb_1\n\nWatch or Listen with MLB.TV: http://mlb.mlb.com/schedule/index.jsp?c_id=min&m=03&y=2012\n\nLocal Radio: 1500 ESPN
 LAST-MODIFIED:20120307T194443Z
-LOCATION:Lee County Sports Complex, Hammond County Stadium, Lee County
+LOCATION:Lee County Sports Complex\, Hammond County Stadium\, Lee County
 SUMMARY:Spring Training: Tampa Bay 3 - Minnesota 7
 TRANSP:TRANSPARENT
 SEQUENCE:2
@@ -43,9 +43,9 @@ DTEND;TZID=America/New_York:20120305T220500
 DTSTAMP:20120806T221604Z
 UID:332124@mlb.com
 CREATED:20111130T212816Z
-DESCRIPTION:Spring Training: Boston 10 - Minnesota 2\n\nClick below for game previews, wraps and boxscores plus video, tickets, stats, gameday and more!\nhttp://mlb.mlb.com/mlb/gameday/index.jsp?gid=2012_03_05_bosmlb_minmlb_1\n\nWatch or Listen with MLB.TV: http://mlb.mlb.com/schedule/index.jsp?c_id=min&m=03&y=2012\n\nLocal TV: MLBN (delay), FS-N+, MLB.TV\nLocal Radio: 1500 ESPN
+DESCRIPTION:Spring Training: Boston 10 - Minnesota 2\n\nClick below for game previews\, wraps and boxscores plus video\, tickets\, stats\, gameday and more!\nhttp://mlb.mlb.com/mlb/gameday/index.jsp?gid=2012_03_05_bosmlb_minmlb_1\n\nWatch or Listen with MLB.TV: http://mlb.mlb.com/schedule/index.jsp?c_id=min&m=03&y=2012\n\nLocal TV: MLBN (delay)\, FS-N+\, MLB.TV\nLocal Radio: 1500 ESPN
 LAST-MODIFIED:20120307T200743Z
-LOCATION:Lee County Sports Complex, Hammond County Stadium, Lee County
+LOCATION:Lee County Sports Complex\, Hammond County Stadium\, Lee County
 SUMMARY:Spring Training: Boston 10 - Minnesota 2
 TRANSP:TRANSPARENT
 SEQUENCE:2
@@ -1409,4 +1409,4 @@ TRANSP:TRANSPARENT
 SEQUENCE:0
 URL:http://mlb.mlb.com/mlb/gameday/index.jsp?gid=2012_09_30_detmlb_minmlb_1
 END:VEVENT
-END:VCALENDAR
+END:VCALENDAR

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ical_importer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jon Phenow
@@ -31,19 +31,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.0.0
 - !ruby/object:Gem::Dependency
-  name: ri_cal
+  name: tzinfo
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.3.29
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.3.29
+- !ruby/object:Gem::Dependency
+  name: icalendar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement