add_to_calendar 0.1.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1424db1a7b175365602cda45a451d53eabaf14e67058003ef7b024d6984d93bd
-  data.tar.gz: 9e050f1eaf3fb403493000f1487bff404636c5f778b59b72f421caaf5dc00379
+  metadata.gz: 9ccdbe13aa98bd8e94caba7b5ab6b270a7d180f29d4b45229275c1d58a4da0c7
+  data.tar.gz: c75a18bf0b11590e57ecf129f5b5b4a9abbbc665e50ef8017ca2b66a2d81e872
 SHA512:
-  metadata.gz: 175b9b699feba0968eb11516e95b84f894bc4a4f7c721d7e65b0af084bd005436a8e6655bf71e50d77fb48ae930cb0ab788ba0cbce4d2c8b23aec1c05fb7e91b
-  data.tar.gz: e98fcbb260cd9ff707d227df4f37113860592af5397932ce2d356e8bd928a3f219827d5e7e48f6e446feb0fdd2349f7e8fa94383b2dc29b13d6088a94e64eb33
+  metadata.gz: b15f499801d1d934d6903ac75f43122d60e38023600591b4a4e7d8286bee3a610c26f52b8b968bdc4a257216334c4bf300201ee3137f5cd8a0871ddafb31ce9f
+  data.tar.gz: 4a6fa0af927ff0676b0248ec869627c77c12e60feca22e884d62e83545e6f0d5e04ec4b3d69a05be5ae60f221c3cc537f50b342ad3d58d68dc166c367213dff6

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: jaredlt
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    add_to_calendar (0.1.0)
-      tzinfo (~> 2.0.2)
-      tzinfo-data (~> 1.2020.1)
+    add_to_calendar (0.2.4)
+      tzinfo (>= 1.1, < 3)
+      tzinfo-data (~> 1.2020)
 
 GEM
   remote: https://rubygems.org/
@@ -15,7 +15,7 @@ GEM
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rake (12.3.3)
+    rake (13.0.1)
     tzinfo (2.0.2)
       concurrent-ruby (~> 1.0)
     tzinfo-data (1.2020.1)
@@ -29,7 +29,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   minitest (~> 5.0)
   pry (~> 0.13.1)
-  rake (~> 12.3.3)
+  rake (~> 13.0.1)
 
 BUNDLED WITH
    2.0.2

data/README.md

@@ -1,8 +1,8 @@
 # AddToCalendar
 
-A ruby gem to generate 'Add To Calendar' URLs for Google, Apple, Office 365*, Outlook and Yahoo calendars.
+A ruby gem to generate 'Add To Calendar' URLs for Apple, Google, Office 365, Outlook, Outlook.com and Yahoo calendars.
 
-*Office 365 not yet available
+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)
 
 ## Installation
 
@@ -41,16 +41,23 @@ Or install it yourself as:
 @cal.yahoo_url
 #=> "https://calendar.yahoo.com/?v=60&view=d&type=20&title=Christmas%20party%21&st=20201212T133000Z&dur=0100"
 
+@cal.office365_url
+#=> "https://outlook.office.com/calendar/0/deeplink/compose?path=/calendar/action/compose&rru=addevent&subject=Christmas%20party%21&startdt=2020-12-12T13:30:00Z&enddt=2020-12-12T14:30:00Z"
+
+# For outlook.com, different to Outlook the desktop application below
+@cal.outlook_com_url
+#=> "https://outlook.live.com/calendar/0/deeplink/compose?path=/calendar/action/compose&rru=addevent&subject=Christmas%20party%21&startdt=2020-12-12T13:30:00Z&enddt=2020-12-12T14:30:00Z"
+
 # 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
@@ -97,16 +104,25 @@ 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
 
 - Read the [Wiki](https://github.com/jaredlt/add_to_calendar/wiki) for more specific details
 
+## Why build this?
+
+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 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"
@@ -26,11 +26,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "tzinfo", "~> 2.0.2"
-  spec.add_dependency "tzinfo-data", "~> 1.2020.1"
+  spec.required_ruby_version = '>= 2.0'
+
+  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", "~> 12.3.3"
+  spec.add_development_dependency "rake", "~> 13.0.1"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "pry", "~> 0.13.1"
 end

data/lib/add_to_calendar.rb

@@ -1,6 +1,7 @@
 require "add_to_calendar/version"
 
-# needed for url_encode method
+# erb util needed for url_encode method
+# CGI::escape uses + instead of %20 which doesn't work for ical files
 require "erb"
 include ERB::Util
 require 'tzinfo'
@@ -32,9 +33,9 @@ module AddToCalendar
       params = {}
       params[:text] = url_encode(title)
       if end_datetime
-        params[:dates] = "#{format_date(start_datetime)}/#{format_date(end_datetime)}"
+        params[:dates] = "#{format_date_google(start_datetime)}/#{format_date_google(end_datetime)}"
       else
-        params[:dates] = "#{format_date(start_datetime)}/#{format_date(start_datetime + 60*60)}" # end time is 1 hour later
+        params[:dates] = "#{format_date_google(start_datetime)}/#{format_date_google(start_datetime + 60*60)}" # end time is 1 hour later
       end
       params[:ctz] = timezone.identifier
       params[:location] = url_encode(location) if location
@@ -54,10 +55,6 @@ module AddToCalendar
       return calendar_url
     end
 
-    # def office_365_url
-
-    # end
-
     def yahoo_url
       # Eg. https://calendar.yahoo.com/?v=60&view=d&type=20&title=Holly%27s%208th%20Birthday!&st=20200615T170000Z&dur=0100&desc=Join%20us%20to%20celebrate%20with%20lots%20of%20games%20and%20cake!&in_loc=7%20Apartments,%20London
       calendar_url = "https://calendar.yahoo.com/?v=60&view=d&type=20"
@@ -87,9 +84,19 @@ module AddToCalendar
       return calendar_url
     end
 
+    def office365_url
+      # Eg. https://outlook.live.com/calendar/0/deeplink/compose?path=/calendar/action/compose&rru=addevent&subject=Holly%27s%208th%20Birthday%21&startdt=2020-05-12T12:30:00Z&enddt=2020-05-12T16:00:00Z&body=Come%20join%20us%20for%20lots%20of%20fun%20%26%20cake%21%0A%0Ahttps%3A%2F%2Fwww.example.com%2Fevent-details&location=Flat%204%2C%20The%20Edge%2C%2038%20Smith-Dorrien%20St%2C%20London%2C%20N1%207GU
+      microsoft("office365")
+    end
+    
+    def outlook_com_url
+      # Eg. https://outlook.live.com/calendar/0/deeplink/compose?path=/calendar/action/compose&rru=addevent&subject=Holly%27s%208th%20Birthday%21&startdt=2020-05-12T12:30:00Z&enddt=2020-05-12T16:00:00Z&body=Come%20join%20us%20for%20lots%20of%20fun%20%26%20cake%21%0A%0Ahttps%3A%2F%2Fwww.example.com%2Fevent-details&location=Flat%204%2C%20The%20Edge%2C%2038%20Smith-Dorrien%20St%2C%20London%2C%20N1%207GU
+      microsoft("outlook.com")
+    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)
@@ -98,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"
@@ -152,21 +159,71 @@ module AddToCalendar
         end
       end
 
+      def microsoft(service)
+        # Eg. 
+        if service == "outlook.com"
+          calendar_url = "https://outlook.live.com/calendar/0/deeplink/compose?path=/calendar/action/compose&rru=addevent"
+        elsif service == "office365"
+          calendar_url = "https://outlook.office.com/calendar/0/deeplink/compose?path=/calendar/action/compose&rru=addevent"
+        else
+          raise MicrosoftServiceError, ":service must be 'outlook.com' or 'office365'. '#{service}' given"
+        end
+        params = {}
+        params[:subject] = url_encode(title)
+        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(newlines_to_html_br(description)) if description
+        if add_url_to_description && url
+          if params[:body]
+            params[:body] << url_encode(newlines_to_html_br("\n\n#{url}"))
+          else
+            params[:body] = url_encode(url)
+          end
+        end
+        params[:location] = url_encode(location) if location
+  
+        params.each do |key, value|
+          calendar_url << "&#{key}=#{value}"
+        end
+    
+        return calendar_url
+      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
+          )
+        )
 
-        formatted = t.strftime('%Y%m%dT%H%M%SZ')
+        return t.strftime('%Y%m%dT%H%M%SZ')
+      end
+
+      def utc_datetime_microsoft(datetime)
+        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
   
-      # Google Calendar format (rename method?)
-      def format_date(start_datetime)
+      def format_date_google(start_datetime)
         start_datetime.strftime('%Y%m%dT%H%M%S')
       end
 
@@ -177,5 +234,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.1.0"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: add_to_calendar
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.4
 platform: ruby
 authors:
 - Jared Turner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-06-22 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: 2.0.2
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        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
@@ -58,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +107,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -128,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -138,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 Apple, Google, Office 365, Outlook, Outlook.com
+  and Yahoo calendars
 test_files: []