add_to_calendar 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1424db1a7b175365602cda45a451d53eabaf14e67058003ef7b024d6984d93bd
-  data.tar.gz: 9e050f1eaf3fb403493000f1487bff404636c5f778b59b72f421caaf5dc00379
+  metadata.gz: b1fba2b9dfdd72ba02d3d29413d1035c6f726569610e18227802cfd85f11e7af
+  data.tar.gz: ab89af6a02c276049dbbcac88fca397e37c3305084836a5e8467629064d414f2
 SHA512:
-  metadata.gz: 175b9b699feba0968eb11516e95b84f894bc4a4f7c721d7e65b0af084bd005436a8e6655bf71e50d77fb48ae930cb0ab788ba0cbce4d2c8b23aec1c05fb7e91b
-  data.tar.gz: e98fcbb260cd9ff707d227df4f37113860592af5397932ce2d356e8bd928a3f219827d5e7e48f6e446feb0fdd2349f7e8fa94383b2dc29b13d6088a94e64eb33
+  metadata.gz: ddc95426b93e001ea114f67b587b721ddea084d2f7607316181ee8c56e002a5c881ae10653d0a4ba9f4fdfee57c918f92e3d3320f54e4cbf9a9bf79faea59b8d
+  data.tar.gz: 4b0015473216a8da08b990ee5e290e80e8e2b8b873971a2197c84da30aaa1489d6878a10c03ed5efbffa5f719148b60434ca99dbeee1eee6cdbd3fccdf3a3a03

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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    add_to_calendar (0.1.0)
+    add_to_calendar (0.2.0)
       tzinfo (~> 2.0.2)
       tzinfo-data (~> 1.2020.1)
 
@@ -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,6 +41,13 @@ 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"
@@ -107,6 +114,10 @@ cal = AddToCalendar::URLs.new(event_attributes)
 
 - 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
+
 ## 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

@@ -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.required_ruby_version = '>= 2.0'
+
   spec.add_dependency "tzinfo", "~> 2.0.2"
   spec.add_dependency "tzinfo-data", "~> 1.2020.1"
 
   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,6 +84,16 @@ 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
@@ -152,6 +159,40 @@ 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(description) if description
+        if add_url_to_description && url
+          if params[:body]
+            params[:body] << url_encode("\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, 
@@ -162,11 +203,23 @@ module AddToCalendar
           datetime.strftime("%S").to_i
         ).utc
 
-        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_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
+
+        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
 

data/lib/add_to_calendar/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: add_to_calendar
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jared Turner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -58,14 +58,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 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -128,7 +129,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:
   - - ">="