Add organizer for ical

Author: jaredlt

README.md

@@ -79,7 +79,11 @@ event_attributes = {
     url: "https://www.ruby-lang.org/en/",
     description: "Join us to learn all about Ruby.",
     add_url_to_description: true, # defaults to true
-    all_day: true # defaults to false
+    all_day: true, # defaults to false
+    organizer: { 
+      name: "First Last",
+      email: "email@example.com"
+    }
 }
 
 cal = AddToCalendar::URLs.new(**event_attributes)
@@ -96,6 +100,7 @@ cal = AddToCalendar::URLs.new(**event_attributes)
 | 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 |
 | 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
 

lib/add_to_calendar.rb

@@ -8,13 +8,12 @@
 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, :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)
+    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
@@ -24,6 +23,7 @@ def initialize(start_datetime:, end_datetime: nil, title:, timezone:, location:
       @description = description
       @add_url_to_description = add_url_to_description
       @all_day = all_day
+      @organizer = organizer
 
       validate_attributes
     end
@@ -126,6 +126,9 @@ def ical_url
         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
@@ -141,7 +144,11 @@ def ical_url
 
       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"
@@ -181,6 +188,12 @@ def validate_attributes
         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)

test/add_to_calendar_test.rb

@@ -270,4 +270,15 @@ def test_calling_class_methods_should_not_mutate_initialized_attributes
     assert cal.location == "20 W 34th St, New York, NY 10001"
   end
 
+  def test_attribute_organizer_must_be_valid
+    assert_raises(ArgumentError) do
+      AddToCalendar::URLs.new(
+        start_datetime: Time.new(@next_month_year,@next_month_month,@next_month_day,13,30,00,0),
+        title: @title,
+        timezone: @timezone,
+        organizer: "not valid"
+      )
+    end
+  end
+
 end

test/urls/ical_url_test.rb

@@ -246,5 +246,25 @@ def test_all_day_end_date_is_plus_one_from_end_date
 
     assert cal.ical_url == ical
   end
+
+  def test_organizer
+    cal = AddToCalendar::URLs.new(
+      start_datetime: Time.new(@next_month_year,@next_month_month,@next_month_day,13,30,00,0), 
+      end_datetime: Time.new(@next_month_year,@next_month_month,@next_month_day,14,30,00,0), 
+      title: @title, 
+      timezone: @timezone,
+      organizer: {
+        name: "Jared Turner",
+        email: "jared@example.com"
+      }
+    )
+    uid = "%0AUID:-#{cal.send(:utc_datetime, cal.start_datetime)}-#{cal.send(:url_encode_ical, cal.title)}"
+    ical = @url_with_defaults_required + 
+           "%0AORGANIZER;CN%3D%22Jared%20Turner%22%3Amailto%3Ajared%40example.com" +
+           uid + 
+           @url_end
+
+    assert cal.ical_url == ical
+  end
 
 end