add_to_calendar 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ccdbe13aa98bd8e94caba7b5ab6b270a7d180f29d4b45229275c1d58a4da0c7
-  data.tar.gz: c75a18bf0b11590e57ecf129f5b5b4a9abbbc665e50ef8017ca2b66a2d81e872
+  metadata.gz: 3067d7dd6fcf157682aa1e25172ad8fd591262168b42f7a453712c5d7483b36d
+  data.tar.gz: 8152eee8b227acecaf7e7abba6625b7a785e18f2cd786f2f56b777179d9b1647
 SHA512:
-  metadata.gz: b15f499801d1d934d6903ac75f43122d60e38023600591b4a4e7d8286bee3a610c26f52b8b968bdc4a257216334c4bf300201ee3137f5cd8a0871ddafb31ce9f
-  data.tar.gz: 4a6fa0af927ff0676b0248ec869627c77c12e60feca22e884d62e83545e6f0d5e04ec4b3d69a05be5ae60f221c3cc537f50b342ad3d58d68dc166c367213dff6
+  metadata.gz: b5c7a1dc4e614fcd1d1d819ee788f29689a815f0b944429423586f71b1b4841ea6377eab52400b8a8c507daf84280f99171fa04d1c98f583145ddd249e40eb0e
+  data.tar.gz: 1f2419f32a56d07bcfd9d632a700aae5f89d79cf87a4255fd8ddeb5e302cd809b2c17b166efb33e31f267137f81ba3e15c91804ff80ab5e0fdb99f6fa3f31ddd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    add_to_calendar (0.2.4)
+    add_to_calendar (0.3.0)
       tzinfo (>= 1.1, < 3)
       tzinfo-data (~> 1.2020)
 
@@ -11,11 +11,12 @@ GEM
     coderay (1.1.2)
     concurrent-ruby (1.1.6)
     method_source (1.0.0)
-    minitest (5.14.0)
+    minitest (5.18.0)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rake (13.0.1)
+    timecop (0.9.6)
     tzinfo (2.0.2)
       concurrent-ruby (~> 1.0)
     tzinfo-data (1.2020.1)
@@ -30,6 +31,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   pry (~> 0.13.1)
   rake (~> 13.0.1)
+  timecop (~> 0.9)
 
 BUNDLED WITH
-   2.0.2
+   2.4.12

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)
 
@@ -52,12 +52,7 @@ Or install it yourself as:
 @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"
 
-# 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>
 ```
 
@@ -83,10 +78,11 @@ event_attributes = {
     location: "20 W 34th St, New York, NY 10001", 
     url: "https://www.ruby-lang.org/en/",
     description: "Join us to learn all about Ruby.",
-    add_url_to_description: true # defaults to true
+    add_url_to_description: true # defaults to true,
+    all_day: true # defaults to false
 }
 
-cal = AddToCalendar::URLs.new(event_attributes)
+cal = AddToCalendar::URLs.new(**event_attributes)
 ```
 
 | Attribute              | Required? | Class      | Notes |
@@ -98,7 +94,8 @@ cal = AddToCalendar::URLs.new(event_attributes)
 | location               | No        | String     |       |
 | url                    | No        | String     | Most providers do not have a native URL field. If you set `url` it will be added to the end of the description field (see `add_url_to_description`) |
 | description            | No        | String     | Accepts newlines by passing `\n` Eg. `"Join us for fun & drinks\n\nPS. Smart casual"` |
-| add_url_to_description | No        | true/false | defaults to `true`. Set `add_url_to_description: false` to stop the URL from being added to the description |
+| add_url_to_description | No        | true/false | Defaults to `true`. Set `add_url_to_description: false` to stop the URL from being added to the description |
+| all_day                | No        | true/false | <ul><li>Defaults to `false`.</li><li>When set to `true` the times will be ignored.</li><li>If no end_datetime provided it will be a single day event.</li><li>When providing end_datetime, use the final day of the event (eg. 1 day event start: 2023-05-01, end: 2023-05-01; 3 day event start: 2023-05-01, end: 2023-05-03).</li><li>Some calendars require you to specify the _day after_ as the end date which feels counterintuitive, this Gem takes care of that for you.</li></ul> |
 
 ### Timezones and offsets
 
@@ -109,7 +106,8 @@ cal = AddToCalendar::URLs.new(event_attributes)
 ### 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 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.
+- 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
 

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 Apple, Google, Office 365, Outlook, Outlook.com and 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"
@@ -35,4 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0.1"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "pry", "~> 0.13.1"
+  spec.add_development_dependency "timecop", "~> 0.9"
 end

data/lib/add_to_calendar/version.rb

@@ -1,3 +1,3 @@
 module AddToCalendar
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

data/lib/add_to_calendar.rb

@@ -13,8 +13,8 @@ module AddToCalendar
   class Error < StandardError; end
   
   class URLs
-    attr_accessor :start_datetime, :end_datetime, :title, :timezone, :location, :url, :description, :add_url_to_description
-    def initialize(start_datetime:, end_datetime: nil, title:, timezone:, location: nil, url: nil, description: nil, add_url_to_description: true)
+    attr_accessor :start_datetime, :end_datetime, :title, :timezone, :location, :url, :description, :add_url_to_description, :all_day
+    def initialize(start_datetime:, end_datetime: nil, title:, timezone:, location: nil, url: nil, description: nil, add_url_to_description: true, all_day: false)
       @start_datetime = start_datetime
       @end_datetime = end_datetime
       @title = title
@@ -23,6 +23,7 @@ module AddToCalendar
       @url = url
       @description = description
       @add_url_to_description = add_url_to_description
+      @all_day = all_day
   
       validate_attributes
     end
@@ -32,11 +33,7 @@ module AddToCalendar
       calendar_url = "https://www.google.com/calendar/render?action=TEMPLATE"
       params = {}
       params[:text] = url_encode(title)
-      if end_datetime
-        params[:dates] = "#{format_date_google(start_datetime)}/#{format_date_google(end_datetime)}"
-      else
-        params[:dates] = "#{format_date_google(start_datetime)}/#{format_date_google(start_datetime + 60*60)}" # end time is 1 hour later
-      end
+      params[:dates] = google_dates(start_datetime, end_datetime, all_day)
       params[:ctz] = timezone.identifier
       params[:location] = url_encode(location) if location
       params[:details] = url_encode(description) if description
@@ -56,17 +53,28 @@ module AddToCalendar
     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"
+      # Eg. https://calendar.yahoo.com/?v=60&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"
       params = {}
       params[:title] = url_encode(title)
-      params[:st] = utc_datetime(start_datetime)
-      if end_datetime
-        seconds = duration_seconds(start_datetime, end_datetime)
-        params[:dur] = seconds_to_hours_minutes(seconds)
+      if all_day
+        params[:st] = format_date(start_datetime)
+        if end_datetime
+          params[:et] = format_date(end_datetime)
+        else
+          params[:et] = format_date(start_datetime)
+        end
+        params[:dur] = "allday"
       else
-        params[:dur] = "0100" 
+        params[:st] = utc_datetime(start_datetime)
+        if end_datetime
+          seconds = duration_seconds(start_datetime, end_datetime)
+          params[:dur] = seconds_to_hours_minutes(seconds)
+        else
+          params[:dur] = "0100" 
+        end
       end
+
       params[:desc] = url_encode(description) if description
       if add_url_to_description && url
         if params[:desc]
@@ -78,7 +86,7 @@ module AddToCalendar
       params[:in_loc] = url_encode(location) if location
 
       params.each do |key, value|
-        calendar_url << "&#{key}=#{value}"
+        calendar_url << "&#{yahoo_param(key)}=#{value}"
       end
   
       return calendar_url
@@ -97,13 +105,25 @@ module AddToCalendar
     def ical_url
       # 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"
+      calendar_url = "data:text/calendar;charset=utf8,BEGIN:VCALENDAR%0AVERSION:2.0%0APRODID:-//AddToCalendar//RubyGem//EN%0ABEGIN:VEVENT"
+
       params = {}
-      params[:DTSTART] = utc_datetime(start_datetime)
-      if end_datetime
-        params[:DTEND] = utc_datetime(end_datetime)
+      params[:DTSTAMP] = Time.now.strftime("%Y%m%dT%H%M%SZ")
+      if all_day
+        one_day = 1 * 24 * 60 * 60
+        params["DTSTART;VALUE=DATE"] = format_date(start_datetime)
+        if end_datetime
+          params["DTEND;VALUE=DATE"] = format_date(end_datetime + one_day)
+        else
+          params["DTEND;VALUE=DATE"] = format_date(start_datetime + one_day)
+        end
       else
-        params[:DTEND] = utc_datetime(start_datetime + 60*60) # 1 hour later
+        params[:DTSTART] = utc_datetime(start_datetime)
+        if end_datetime
+          params[:DTEND] = utc_datetime(end_datetime)
+        else
+          params[:DTEND] = utc_datetime(start_datetime + 60*60) # 1 hour later
+        end
       end
       params[:SUMMARY] = url_encode_ical(title)
       params[:URL] = url_encode(url) if url
@@ -136,6 +156,10 @@ module AddToCalendar
     def outlook_url
       ical_url
     end
+
+    def android_url
+      ical_url
+    end
   
     private
       def validate_attributes
@@ -169,12 +193,23 @@ module AddToCalendar
           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)
+        params[:subject] = url_encode(title.gsub(' & ', ' and '))
+        if all_day
+          one_day = 1 * 24 * 60 * 60
+          params[:startdt] = microsoft_date(start_datetime)
+          if end_datetime
+            params[:enddt] = microsoft_date(end_datetime + one_day)
+          else
+            params[:enddt] = microsoft_date(start_datetime + one_day)
+          end
+          params[:allday] = "true"
         else
-          params[:enddt] = utc_datetime_microsoft(start_datetime + 60*60) # 1 hour later
+          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
         end
         params[:body] = url_encode(newlines_to_html_br(description)) if description
         if add_url_to_description && url
@@ -222,11 +257,34 @@ module AddToCalendar
 
         return t.strftime('%Y-%m-%dT%H:%M:%SZ')
       end
+
+      def microsoft_date(date)
+        date.strftime('%Y-%m-%d')
+      end
+
+      def google_dates(start_datetime, end_datetime, all_day)
+        one_day = 1 * 24 * 60 * 60
+        if all_day
+          if end_datetime
+            "#{format_date(start_datetime)}/#{format_date(end_datetime + one_day)}"
+          else
+            "#{format_date(start_datetime)}/#{format_date(start_datetime + one_day)}"
+          end
+        elsif end_datetime
+          "#{format_datetime_google(start_datetime)}/#{format_datetime_google(end_datetime)}"
+        else
+          "#{format_datetime_google(start_datetime)}/#{format_datetime_google(start_datetime + 60*60)}" # end time is 1 hour later
+        end
+      end
   
-      def format_date_google(start_datetime)
+      def format_datetime_google(start_datetime)
         start_datetime.strftime('%Y%m%dT%H%M%S')
       end
 
+      def format_date(date)
+        date.strftime('%Y%m%d')
+      end
+
       def duration_seconds(start_time, end_time)
         (start_time.to_i - end_time.to_i).abs
       end
@@ -254,5 +312,13 @@ module AddToCalendar
           end
         }.join("\\n")
       end
+
+      def yahoo_param(key)
+        if key == :in_loc
+          key.to_s
+        else
+          key.to_s.upcase
+        end
+      end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: add_to_calendar
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Jared Turner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2023-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -100,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: 
 email:
 - jaredlt01@gmail.com
@@ -142,9 +156,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
-summary: Generate 'Add To Calendar' URLs for Apple, Google, Office 365, Outlook, Outlook.com
-  and Yahoo calendars
+summary: Generate 'Add To Calendar' URLs for Android, Apple, Google, Office 365, Outlook,
+  Outlook.com and Yahoo calendars
 test_files: []