add_to_calendar 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1fba2b9dfdd72ba02d3d29413d1035c6f726569610e18227802cfd85f11e7af
-  data.tar.gz: ab89af6a02c276049dbbcac88fca397e37c3305084836a5e8467629064d414f2
+  metadata.gz: 24986348b563ba6eee3ee7c510092434f8e24d76c1ddd402484e31951cbb94f0
+  data.tar.gz: eda31a7a266b15e4b82db84ed250a2da999b0f5efe6fc565b75c8e7ea3286a57
 SHA512:
-  metadata.gz: ddc95426b93e001ea114f67b587b721ddea084d2f7607316181ee8c56e002a5c881ae10653d0a4ba9f4fdfee57c918f92e3d3320f54e4cbf9a9bf79faea59b8d
-  data.tar.gz: 4b0015473216a8da08b990ee5e290e80e8e2b8b873971a2197c84da30aaa1489d6878a10c03ed5efbffa5f719148b60434ca99dbeee1eee6cdbd3fccdf3a3a03
+  metadata.gz: 4da59f54a6a6099646425189a66481e0450e6ac9cd6ea56806c455e74fcddd1f0055150a9951db600821a7c854593f23a049879eb85c972b1677205463397af9
+  data.tar.gz: 3d3eef19ecd6bf9f56440253c2f1cbf9d3ea090ea16e83d067191ecc61ac2fdabd49a20398adc206498a451a36355287ff06e8a726b89b416cbe45888418b3dc

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    add_to_calendar (0.2.0)
-      tzinfo (~> 2.0.2)
-      tzinfo-data (~> 1.2020.1)
+    add_to_calendar (0.2.5)
+      tzinfo (>= 1.1, < 3)
+      tzinfo-data (~> 1.2020)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
 # AddToCalendar
 
-A ruby gem to generate 'Add To Calendar' URLs for Apple, Google, Office 365, Outlook, Outlook.com and Yahoo calendars.
+A ruby gem to generate 'Add To Calendar' URLs for Android, Apple, Google, Office 365, Outlook, Outlook.com and Yahoo calendars.
 
 If this gem brings you some value feel free to buy me a coffee :) [![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/P5P71PK9T)
 
@@ -50,14 +50,9 @@ 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"
-
-@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"
+# android_url, apple_url and outlook_url are simply helper methods that call ical_url and return the same string.
 ```
 
 ### Creating HTML links
@@ -68,7 +63,7 @@ Or install it yourself as:
 
 <a href="<%= @cal.yahoo_url %>">Add to Yahoo Calendar</a>
 
-<!-- for ical_url, apple_url and outlook_url you can set the filename like so -->
+<!-- for ical_url, android_url, apple_url and outlook_url you can set the filename like so -->
 <a download="calendar-event.ics" href="<%= @cal.ical_url %>">Download iCal</a>
 ```
 
@@ -104,11 +99,13 @@ 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  is deprecating IE 11 support and only offers a simplified interface which does not work with the add event URL.
+- `Office 365` and `Outlook.com` do not work on mobile. This seems to be an issue on Microsoft's side. Their mobile web interface does not support the 'create event' URLs and the links do not open the apps if you have them installed.
 
 ### More details
 
@@ -118,6 +115,10 @@ cal = AddToCalendar::URLs.new(event_attributes)
 
 I couldn't find an approriate gem or javascript library that did exactly what I wanted. So I decided to scratch my own itch to solve a problem for a startup I'm working on: https://www.littlefutures.org
 
+## Releases
+
+- https://rubygems.org/gems/add_to_calendar
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/add_to_calendar.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jared Turner"]
   spec.email         = ["jaredlt01@gmail.com"]
 
-  spec.summary       = "Generate 'Add To Calendar' URLs for Google, Apple, Office 365, Outlook, Yahoo calendars"
+  spec.summary       = "Generate 'Add To Calendar' URLs for Android, Apple, Google, Office 365, Outlook, Outlook.com and Yahoo calendars"
   # spec.description   = %q{TODO: Write a longer description or delete this line.}
   spec.homepage      = "https://github.com/jaredlt/add_to_calendar"
   spec.license       = "MIT"
@@ -28,8 +28,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0'
 
-  spec.add_dependency "tzinfo", "~> 2.0.2"
-  spec.add_dependency "tzinfo-data", "~> 1.2020.1"
+  spec.add_dependency "tzinfo", ">= 1.1", "< 3"
+  spec.add_dependency "tzinfo-data", "~> 1.2020"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0.1"

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,23 +105,23 @@ 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(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)}"
+          params[:DESCRIPTION] << "\\n\\n#{url_encode(url)}"
         else
           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|
-        calendar_url << "#{new_line}#{key}=#{value}"
+        calendar_url << "#{new_line}#{key}:#{value}"
       end
 
       calendar_url << "%0AEND:VEVENT%0AEND:VCALENDAR"
@@ -136,6 +136,10 @@ module AddToCalendar
     def outlook_url
       ical_url
     end
+
+    def android_url
+      ical_url
+    end
   
     private
       def validate_attributes
@@ -169,17 +173,17 @@ module AddToCalendar
           raise MicrosoftServiceError, ":service must be 'outlook.com' or 'office365'. '#{service}' given"
         end
         params = {}
-        params[:subject] = url_encode(title)
+        params[:subject] = url_encode(title.gsub(' & ', ' and '))
         params[:startdt] = utc_datetime_microsoft(start_datetime)
         if end_datetime
           params[:enddt] = utc_datetime_microsoft(end_datetime)
         else
           params[:enddt] = utc_datetime_microsoft(start_datetime + 60*60) # 1 hour later
         end
-        params[:body] = url_encode(description) if description
+        params[:body] = url_encode(newlines_to_html_br(description)) if description
         if add_url_to_description && url
           if params[:body]
-            params[:body] << url_encode("\n\n#{url}")
+            params[:body] << url_encode(newlines_to_html_br("\n\n#{url}"))
           else
             params[:body] = url_encode(url)
           end
@@ -194,27 +198,31 @@ module AddToCalendar
       end
 
       def utc_datetime(datetime)
-        t = timezone.local_time(
-          datetime.strftime("%Y").to_i, 
-          datetime.strftime("%m").to_i, 
-          datetime.strftime("%d").to_i, 
-          datetime.strftime("%H").to_i, 
-          datetime.strftime("%M").to_i, 
-          datetime.strftime("%S").to_i
-        ).utc
+        t = timezone.local_to_utc(
+          Time.new(
+            datetime.strftime("%Y").to_i, 
+            datetime.strftime("%m").to_i, 
+            datetime.strftime("%d").to_i, 
+            datetime.strftime("%H").to_i, 
+            datetime.strftime("%M").to_i, 
+            datetime.strftime("%S").to_i
+          )
+        )
 
         return t.strftime('%Y%m%dT%H%M%SZ')
       end
 
       def utc_datetime_microsoft(datetime)
-        t = timezone.local_time(
-          datetime.strftime("%Y").to_i, 
-          datetime.strftime("%m").to_i, 
-          datetime.strftime("%d").to_i, 
-          datetime.strftime("%H").to_i, 
-          datetime.strftime("%M").to_i, 
-          datetime.strftime("%S").to_i
-        ).utc
+        t = timezone.local_to_utc(
+          Time.new(
+            datetime.strftime("%Y").to_i, 
+            datetime.strftime("%m").to_i, 
+            datetime.strftime("%d").to_i, 
+            datetime.strftime("%H").to_i, 
+            datetime.strftime("%M").to_i, 
+            datetime.strftime("%S").to_i
+          )
+        )
 
         return t.strftime('%Y-%m-%dT%H:%M:%SZ')
       end
@@ -230,5 +238,25 @@ module AddToCalendar
       def seconds_to_hours_minutes(sec)
         "%02d%02d" % [sec / 3600, sec / 60 % 60]
       end
+
+      def newlines_to_html_br(string)
+        string.gsub(/(?:\n\r?|\r\n?)/, '<br>')
+      end
+
+      def url_encode_ical(s)
+        # per https://tools.ietf.org/html/rfc5545#section-3.3.11
+        string = s.dup # don't modify original input
+        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)
+          end
+        }.join("\\n")
+      end
   end
 end

data/lib/add_to_calendar/version.rb

@@ -1,3 +1,3 @@
 module AddToCalendar
-  VERSION = "0.2.0"
+  VERSION = "0.2.5"
 end

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: add_to_calendar
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Jared Turner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: tzinfo-data
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2020.1
+        version: '1.2020'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2020.1
+        version: '1.2020'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -139,6 +145,6 @@ requirements: []
 rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: Generate 'Add To Calendar' URLs for Google, Apple, Office 365, Outlook, Yahoo
-  calendars
+summary: Generate 'Add To Calendar' URLs for Android, Apple, Google, Office 365, Outlook,
+  Outlook.com and Yahoo calendars
 test_files: []