add_to_calendar 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 735242b817fc47985c9ba42dac9623eae14ca6a9b92ef51097321a562a520b63
-  data.tar.gz: 0b3b95d809779120ce76ad1748f431980566422385c3e817183c3b195828487b
+  metadata.gz: 8aff21a2c3fa1774cf66361fd8ee0c622f0ccf2fd49fb3e72076ef59bff25395
+  data.tar.gz: 857af7085fca3048223d84164c186c812f7d8f1dff1924653c42c5a74ef2988b
 SHA512:
-  metadata.gz: 73ca22730936819071d80504c54a471b18cd17b6f8b0b1f4a35c79758ca7e1762b53c9d8b57637c6f2f7fc2552b5097e7a7bce6984aba849b3e3f286c3774bc4
-  data.tar.gz: c73793ded24a174c81ee7411a16b8e3a09e426ec208b388a9f905f6aa6457d57b8880c9df99650965ff0ce2c4deca254d6920543af95ab25075e5bc18dbce573
+  metadata.gz: 616a8be90a3e717363a103aae6a5a49df1b7989cb7df701585fc203a90e4be6032644b53436b5c82dd26106ed8d94519a3dd4a63c5640fd8c766eae1f8418305
+  data.tar.gz: 0f1bef8067ff2aab99807c8aa02a7d3234be487328ab1a1cef0495ade1830c5f4f722c61b08fc9635fe3d9fa277e621875f68381f9c03a9c3a53ebb67c50ec67

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    add_to_calendar (0.2.2)
+    add_to_calendar (0.2.3)
       tzinfo (>= 1.1, < 3)
       tzinfo-data (~> 1.2020)
 

data/README.md

@@ -50,14 +50,14 @@ Or install it yourself as:
 
 # ical provides a data-uri which will download a properly formatted *.ics file (see 'Creating HTML links' section)
 @cal.ical_url
-#=> "data:text/calendar;charset=utf8,BEGIN:VCALENDAR%0AVERSION:2.0%0ABEGIN:VEVENT%0ADTSTART=20201212T133000Z%0ADTEND=20201212T143000Z%0ASUMMARY=Christmas%20party%21%0AUID=-20201212T133000Z-Christmas%20party%21%0AEND:VEVENT%0AEND:VCALENDAR"
+#=> "data:text/calendar;charset=utf8,BEGIN:VCALENDAR%0AVERSION:2.0%0ABEGIN:VEVENT%0ADTSTART:20201212T133000Z%0ADTEND:20201212T143000Z%0ASUMMARY:Christmas%20party%21%0AUID:-20201212T133000Z-Christmas%20party%21%0AEND:VEVENT%0AEND:VCALENDAR"
 
 # apple_url and outlook_url are simply helper methods that call ical_url
 @cal.apple_url
-#=> "data:text/calendar;charset=utf8,BEGIN:VCALENDAR%0AVERSION:2.0%0ABEGIN:VEVENT%0ADTSTART=20201212T133000Z%0ADTEND=20201212T143000Z%0ASUMMARY=Christmas%20party%21%0AUID=-20201212T133000Z-Christmas%20party%21%0AEND:VEVENT%0AEND:VCALENDAR"
+#=> "data:text/calendar;charset=utf8,BEGIN:VCALENDAR%0AVERSION:2.0%0ABEGIN:VEVENT%0ADTSTART:20201212T133000Z%0ADTEND:20201212T143000Z%0ASUMMARY:Christmas%20party%21%0AUID:-20201212T133000Z-Christmas%20party%21%0AEND:VEVENT%0AEND:VCALENDAR"
 
 @cal.outlook_url
-#=> "data:text/calendar;charset=utf8,BEGIN:VCALENDAR%0AVERSION:2.0%0ABEGIN:VEVENT%0ADTSTART=20201212T133000Z%0ADTEND=20201212T143000Z%0ASUMMARY=Christmas%20party%21%0AUID=-20201212T133000Z-Christmas%20party%21%0AEND:VEVENT%0AEND:VCALENDAR"
+#=> "data:text/calendar;charset=utf8,BEGIN:VCALENDAR%0AVERSION:2.0%0ABEGIN:VEVENT%0ADTSTART:20201212T133000Z%0ADTEND:20201212T143000Z%0ASUMMARY:Christmas%20party%21%0AUID:-20201212T133000Z-Christmas%20party%21%0AEND:VEVENT%0AEND:VCALENDAR"
 ```
 
 ### Creating HTML links
@@ -104,11 +104,12 @@ cal = AddToCalendar::URLs.new(event_attributes)
 
 - Offset values eg. "2020-05-13 15:31:00 **+05:00**" are ignored. It is only important that you have the correct date and time numbers set. The timezone is set directly using its own attribute `timezone`.
 - You must set a timezone so that when users add the event to their calendar it shows at their correct local time. 
-  - Eg. London event @ `2020-05-13 13:30:00` will save in a New Yorkers calendar as local time `2020-05-13 17:30:00`
+  - Eg. London event @ `2020-05-13 13:30:00` will save in a New Yorker's calendar as local time `2020-05-13 17:30:00`
 
 ### Browser support
 
-- IE11 and lower will not work for `ical_url`, `apple_url` and `outlook_url` (IE does not properly support [data-uri links](https://caniuse.com/#feat=datauri). See [#16](https://github.com/jaredlt/add_to_calendar/issues/16)). 
+- IE11 and lower will not work for `ical_url`, `apple_url` and `outlook_url` (IE does not properly support [data-uri links](https://caniuse.com/#feat=datauri). See [#16](https://github.com/jaredlt/add_to_calendar/issues/16)).
+- IE11 will also not work with `Yahoo`, but this is because Yahoo only offers a simplified interface for IE11 which does not work with the add event URL.
 
 ### More details
 

data/lib/add_to_calendar.rb

@@ -95,8 +95,8 @@ module AddToCalendar
     end
 
     def ical_url
-      # Downloads a *.ics file provided as a data:text href
-      # Eg. data:text/calendar;charset=utf8,BEGIN:VCALENDAR%0AVERSION:2.0%0ABEGIN:VEVENT%0ADTSTART=20200610T123000Z%0ADTEND=20200610T133000Z%0ASUMMARY=Holly%27s%208th%20Birthday%21%0AURL=https%3A%2F%2Fwww.example.com%2Fevent-details%0ADESCRIPTION=Come%20join%20us%20for%20lots%20of%20fun%20%26%20cake%21\n\nhttps%3A%2F%2Fwww.example.com%2Fevent-details%0ALOCATION=Flat%204%2C%20The%20Edge%2C%2038%20Smith-Dorrien%20St%2C%20London%2C%20N1%207GU%0AUID=-https%3A%2F%2Fwww.example.com%2Fevent-details%0AEND:VEVENT%0AEND:VCALENDAR
+      # Downloads a *.ics file provided as a data-uri
+      # Eg. "data:text/calendar;charset=utf8,BEGIN:VCALENDAR%0AVERSION:2.0%0ABEGIN:VEVENT%0ADTSTART:20200512T123000Z%0ADTEND:20200512T160000Z%0ASUMMARY:Holly%27s%208th%20Birthday%21%0AURL:https%3A%2F%2Fwww.example.com%2Fevent-details%0ADESCRIPTION:Come%20join%20us%20for%20lots%20of%20fun%20%26%20cake%21\\n\\nhttps%3A%2F%2Fwww.example.com%2Fevent-details%0ALOCATION:Flat%204%5C%2C%20The%20Edge%5C%2C%2038%20Smith-Dorrien%20St%5C%2C%20London%5C%2C%20N1%207GU%0AUID:-https%3A%2F%2Fwww.example.com%2Fevent-details%0AEND:VEVENT%0AEND:VCALENDAR"
       calendar_url = "data:text/calendar;charset=utf8,BEGIN:VCALENDAR%0AVERSION:2.0%0ABEGIN:VEVENT"
       params = {}
       params[:DTSTART] = utc_datetime(start_datetime)
@@ -105,9 +105,9 @@ module AddToCalendar
       else
         params[:DTEND] = utc_datetime(start_datetime + 60*60) # 1 hour later
       end
-      params[:SUMMARY] = url_encode(title)
+      params[:SUMMARY] = url_encode_ical(title)
       params[:URL] = url_encode(url) if url
-      params[:DESCRIPTION] = url_encode_ical_description(description) if description
+      params[:DESCRIPTION] = url_encode_ical(description) if description
       if add_url_to_description && url
         if params[:DESCRIPTION]
           params[:DESCRIPTION] << "\\n\\n#{url_encode(url)}"
@@ -115,9 +115,9 @@ module AddToCalendar
           params[:DESCRIPTION] = url_encode(url)
         end
       end
-      params[:LOCATION] = url_encode(location) if location
+      params[:LOCATION] = url_encode_ical(location) if location
       params[:UID] = "-#{url_encode(url)}" if url
-      params[:UID] = "-#{utc_datetime(start_datetime)}-#{url_encode(title)}" unless params[:UID] # set uid based on starttime and title only if url is unavailable
+      params[:UID] = "-#{utc_datetime(start_datetime)}-#{url_encode_ical(title)}" unless params[:UID] # set uid based on starttime and title only if url is unavailable
       
       new_line = "%0A"
       params.each do |key, value|
@@ -239,12 +239,17 @@ module AddToCalendar
         string.gsub(/(?:\n\r?|\r\n?)/, '<br>')
       end
 
-      def url_encode_ical_description(description)
-        description.split("\n").map { |e| 
-          if e == "\n"
-            "\\n"
+      def url_encode_ical(string)
+        # per https://tools.ietf.org/html/rfc5545#section-3.3.11
+        string.gsub!("\\", "\\\\\\") # \ >> \\     --yes, really: https://stackoverflow.com/questions/6209480/how-to-replace-backslash-with-double-backslash
+        string.gsub!(",", "\\,")
+        string.gsub!(";", "\\;")
+        string.gsub!("\r\n", "\n") # so can handle all newlines the same
+        string.split("\n").map { |e|
+          if e.empty?
+            e
           else
-            url_encode(e) if e != "\n" 
+            url_encode(e)
           end
         }.join("\\n")
       end

data/lib/add_to_calendar/version.rb

@@ -1,3 +1,3 @@
 module AddToCalendar
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: add_to_calendar
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Jared Turner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-18 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo