add_to_calendar 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3067d7dd6fcf157682aa1e25172ad8fd591262168b42f7a453712c5d7483b36d
-  data.tar.gz: 8152eee8b227acecaf7e7abba6625b7a785e18f2cd786f2f56b777179d9b1647
+  metadata.gz: 066bd5d8dca47c52812bd31e3025bebc8dc2cb26a0401565b069d9b14cce5b6f
+  data.tar.gz: ed67f1f5d08cb1a318948a4c4315aa9aa23dcebda93a03899e715fe60deb0f48
 SHA512:
-  metadata.gz: b5c7a1dc4e614fcd1d1d819ee788f29689a815f0b944429423586f71b1b4841ea6377eab52400b8a8c507daf84280f99171fa04d1c98f583145ddd249e40eb0e
-  data.tar.gz: 1f2419f32a56d07bcfd9d632a700aae5f89d79cf87a4255fd8ddeb5e302cd809b2c17b166efb33e31f267137f81ba3e15c91804ff80ab5e0fdb99f6fa3f31ddd
+  metadata.gz: e0bdd471038f1e8deaadab3382de66287df61abf6f747a9a4567a5ed231776e38d683b57ed429a2865364d29f435ffd6d3c7cfd1499c7ac5290b785af1b0ce0b
+  data.tar.gz: d5cb5db508ceb12c74b68e492b36393bd46c0ec4c844854bf90346ddec0a9338e0961b864f0d682f8c78b150aa6c79b85c6b26cb1952e52fbf1610c9213c894d

data/.github/workflows/tests.yml

@@ -0,0 +1,25 @@
+name: Ruby Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake test

data/Gemfile.lock

@@ -1,25 +1,25 @@
 PATH
   remote: .
   specs:
-    add_to_calendar (0.3.0)
+    add_to_calendar (0.5.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.3.3)
     method_source (1.0.0)
     minitest (5.18.0)
-    pry (0.13.1)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rake (13.0.1)
     timecop (0.9.6)
-    tzinfo (2.0.2)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    tzinfo-data (1.2020.1)
+    tzinfo-data (1.2024.1)
       tzinfo (>= 1.0.0)
 
 PLATFORMS
@@ -29,9 +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.4.12
+   2.3.9

data/README.md

@@ -1,6 +1,6 @@
 # AddToCalendar
 
-A ruby gem to generate 'Add To Calendar' URLs for Android, Apple, Google, Office 365, Outlook, Outlook.com and Yahoo calendars.
+A ruby gem to generate 'Add To Calendar' URLs for Android, Apple, Google, Hey, 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)
 
@@ -41,6 +41,9 @@ 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.hey_url
+#=> "https://app.hey.com/calendar/ical_events/new?ical_source=BEGIN%3AVCALENDAR%0AVERSION%3A2.0%0APRODID%3A-//AddToCalendar//RubyGem//EN%0ABEGIN%3AVEVENT%0ASUMMARY%3AHolly%27s%209th%20birthday%21%0ADTSTAMP%3A20240913T151029Z%0ADTSTART%3A20240906T123000Z%0ADTEND%3A20240906T133000Z%0AUID%3A-20240906T123000Z-Holly%27s%209th%20birthday%21%0AEND%3AVEVENT%0AEND%3AVCALENDAR"
+
 @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"
 
@@ -78,8 +81,12 @@ 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,
-    all_day: true # defaults to false
+    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)
@@ -96,6 +103,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
 
@@ -107,7 +115,6 @@ cal = AddToCalendar::URLs.new(**event_attributes)
 
 - 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  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

@@ -34,6 +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.3.0"
+  VERSION = "0.5.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, :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 @@ module AddToCalendar
       @description = description
       @add_url_to_description = add_url_to_description
       @all_day = all_day
+      @organizer = organizer
   
       validate_attributes
     end
@@ -92,6 +92,59 @@ module AddToCalendar
       return calendar_url
     end
 
+    def hey_url
+      calendar_url = "https://app.hey.com/calendar/ical_events/new?ical_source=BEGIN%3AVCALENDAR%0AVERSION%3A2.0%0APRODID%3A-//AddToCalendar//RubyGem//EN%0ABEGIN%3AVEVENT"
+      
+      params = {}
+      params[:SUMMARY] = url_encode(title)
+      params[:DTSTAMP] = Time.now.strftime("%Y%m%dT%H%M%SZ")
+  
+      if all_day
+        one_day = 1 * 24 * 60 * 60
+        params["DTSTART%3BVALUE=DATE"] = format_date(start_datetime)
+        if end_datetime
+          params["DTEND%3BVALUE=DATE"] = format_date(end_datetime + one_day)
+        else
+          params["DTEND%3BVALUE=DATE"] = format_date(start_datetime + one_day)
+        end
+      else
+        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[:URL] = url_encode(url) if url
+      params[:UID] = "-#{utc_datetime(start_datetime)}-#{url_encode(title)}"
+      params[:DESCRIPTION] = url_encode_hey(description) if description
+      if add_url_to_description && url
+        if params[:DESCRIPTION]
+          params[:DESCRIPTION] << "\n\n#{url_encode(url)}"
+        else
+          params[:DESCRIPTION] = url_encode(url)
+        end
+      end
+      if organizer
+        params[:ORGANIZER] = url_encode("CN=\"#{organizer[:name]}\"%3Amailto%3A#{organizer[:email]}")
+      end
+      params[:LOCATION] = url_encode(location) if location
+      
+      new_line = "%0A"
+      params.each do |key, value|
+        if key == :ORGANIZER
+          calendar_url << "#{new_line}#{key}%3B#{value}"
+        else
+          calendar_url << "#{new_line}#{key}%3A#{value}"
+        end
+      end
+  
+      calendar_url << "%0AEND%3AVEVENT%0AEND%3AVCALENDAR"
+    
+      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")
@@ -126,6 +179,9 @@ module AddToCalendar
         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 +197,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"
@@ -181,6 +241,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)
@@ -313,6 +379,17 @@ module AddToCalendar
         }.join("\\n")
       end
 
+      def url_encode_hey(s)
+        string = s.dup # don't modify original input
+        string.split("\n").map { |e|
+          if e.empty?
+            e
+          else
+            url_encode(e)
+          end
+        }.join("\n")
+      end
+
       def yahoo_param(key)
         if key == :in_loc
           key.to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: add_to_calendar
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jared Turner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2024-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -92,14 +92,14 @@ 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
@@ -122,6 +122,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/FUNDING.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -156,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
 summary: Generate 'Add To Calendar' URLs for Android, Apple, Google, Office 365, Outlook,