add_to_calendar 0.2.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24986348b563ba6eee3ee7c510092434f8e24d76c1ddd402484e31951cbb94f0
-  data.tar.gz: eda31a7a266b15e4b82db84ed250a2da999b0f5efe6fc565b75c8e7ea3286a57
+  metadata.gz: 2c0a0f2f9901bd47c14f386ec09c72207eeebf34e04e592473c57e2b00bc3d18
+  data.tar.gz: f2cb5bf74e64fb36e47d293e8a525b784018280851a16b08817eb716c4453393
 SHA512:
-  metadata.gz: 4da59f54a6a6099646425189a66481e0450e6ac9cd6ea56806c455e74fcddd1f0055150a9951db600821a7c854593f23a049879eb85c972b1677205463397af9
-  data.tar.gz: 3d3eef19ecd6bf9f56440253c2f1cbf9d3ea090ea16e83d067191ecc61ac2fdabd49a20398adc206498a451a36355287ff06e8a726b89b416cbe45888418b3dc
+  metadata.gz: ab6dee17a03164fce02ce552f522b4fdda9414328063355611e39784e89b8d85cad3a800d9c3360d5128d2187cbaa9094596451fb2dce702c3acd91faead4024
+  data.tar.gz: 66eb54a91cba9b7adcf625e25a89ea1c64018b36e045130ba3a01a1cc317c55072fc42607903eee88103eecd102022610fb7e1b9315d284922d46eedfb6c0ce9

data/Gemfile.lock

@@ -1,22 +1,23 @@
 PATH
   remote: .
   specs:
-    add_to_calendar (0.2.5)
+    add_to_calendar (0.4.0)
       tzinfo (>= 1.1, < 3)
       tzinfo-data (~> 1.2020)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
-    concurrent-ruby (1.1.6)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
     method_source (1.0.0)
-    minitest (5.14.0)
-    pry (0.13.1)
+    minitest (5.18.0)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rake (13.0.1)
-    tzinfo (2.0.2)
+    timecop (0.9.6)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     tzinfo-data (1.2020.1)
       tzinfo (>= 1.0.0)
@@ -28,8 +29,9 @@ DEPENDENCIES
   add_to_calendar!
   bundler (~> 2.0)
   minitest (~> 5.0)
-  pry (~> 0.13.1)
+  pry (~> 0.14)
   rake (~> 13.0.1)
+  timecop (~> 0.9)
 
 BUNDLED WITH
-   2.0.2
+   2.3.9

data/README.md

@@ -78,10 +78,15 @@ 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
+    organizer: { 
+      name: "First Last",
+      email: "email@example.com"
+    }
 }
 
-cal = AddToCalendar::URLs.new(event_attributes)
+cal = AddToCalendar::URLs.new(**event_attributes)
 ```
 
 | Attribute              | Required? | Class      | Notes |
@@ -93,7 +98,9 @@ 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> |
+| organizer              | No        | Hash | <ul><li>Only supported by ical</li><li>If used you must provide both `name` and `email`</li><li>Must be in format `{ name: "First Last", email: "email@example.com" }`</li></ul> |
 
 ### Timezones and offsets
 

data/add_to_calendar.gemspec

@@ -34,5 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.0"
   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 "pry", "~> 0.14"
+  spec.add_development_dependency "timecop", "~> 0.9"
 end

data/lib/add_to_calendar/version.rb

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

data/lib/add_to_calendar.rb

@@ -8,13 +8,12 @@ require 'tzinfo'
 require 'date'
 # require 'pry'
 
-
 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, :organizer
+    def initialize(start_datetime:, end_datetime: nil, title:, timezone:, location: nil, url: nil, description: nil, add_url_to_description: true, all_day: false, organizer: nil)
       @start_datetime = start_datetime
       @end_datetime = end_datetime
       @title = title
@@ -23,6 +22,8 @@ module AddToCalendar
       @url = url
       @description = description
       @add_url_to_description = add_url_to_description
+      @all_day = all_day
+      @organizer = organizer
   
       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,15 +105,30 @@ 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)
+      if organizer
+        params[:ORGANIZER] = url_encode_ical("CN=\"#{organizer[:name]}\":mailto:#{organizer[:email]}")
+      end
       params[:URL] = url_encode(url) if url
       params[:DESCRIPTION] = url_encode_ical(description) if description
       if add_url_to_description && url
@@ -121,7 +144,11 @@ module AddToCalendar
       
       new_line = "%0A"
       params.each do |key, value|
-        calendar_url << "#{new_line}#{key}:#{value}"
+        if key == :ORGANIZER
+          calendar_url << "#{new_line}#{key};#{value}"
+        else
+          calendar_url << "#{new_line}#{key}:#{value}"
+        end
       end
 
       calendar_url << "%0AEND:VEVENT%0AEND:VCALENDAR"
@@ -161,6 +188,12 @@ module AddToCalendar
         if description
           raise(ArgumentError, ":description must be a string") unless self.description.kind_of? String
         end
+
+        if organizer
+          unless self.organizer.is_a?(Hash) && self.organizer[:name].is_a?(String) && self.organizer[:email].is_a?(String)
+            raise(ArgumentError, ":organizer must be a Hash of format { name: \"First Last\", email: \"email@example.com\" }")
+          end
+        end
       end
 
       def microsoft(service)
@@ -174,11 +207,22 @@ module AddToCalendar
         end
         params = {}
         params[:subject] = url_encode(title.gsub(' & ', ' and '))
-        params[:startdt] = utc_datetime_microsoft(start_datetime)
-        if end_datetime
-          params[:enddt] = utc_datetime_microsoft(end_datetime)
+        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
@@ -226,11 +270,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
@@ -258,5 +325,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.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Jared Turner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2023-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -92,14 +92,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.14'
+- !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,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Generate 'Add To Calendar' URLs for Android, Apple, Google, Office 365, Outlook,