birthdaze 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e67d3efa62158e2181f474f0c1dbf9b62769316e84ace36ac95ab5da98a9629c
-  data.tar.gz: f529457feccd008ac0f90151ac788ee44cdd967c094fffcf198f4ab1b52fdab2
+  metadata.gz: 60d1e0d4cb56c5fdd6c578e7d1ef1646a1b251c64cd042e651c1552c228ef6cd
+  data.tar.gz: 3a4be8ee6d1387114f86cec4a4ea6e8341651809379e465ad36befa68258ff3f
 SHA512:
-  metadata.gz: 440b163d77844aedc8107f02627206767737e476910c916a756b471a40964bb676d384133c6df5f6be64acec38e9cdf2c8860c77b698c767dc165ef84744fb57
-  data.tar.gz: e1118b722644022c47385827f2f23f5323fee6620fb8cfd88d1afa2c0dfbbbd796709c2d2f69bf4b02a8186c36f25d0215a8fabf104e33b1be12186749025d65
+  metadata.gz: c8428ae748a6035cb02bab6bda57253ac86ae84d8a199b4e39aca2a6ef640733c8e31bea6e88d6081da0e7dcfa4636f5b1216e807b20fd131c5fbb3de6dcff73
+  data.tar.gz: d7696650ca9c4330b4f72ff0a2a3d893ad05f3d3ff61a6f83f45600ce140463ea87b471fc6b269231e2841952c5808ca7c1bfbdcb0d609cd40f8ed7174045471

data/README.md

@@ -1,4 +1,44 @@
 # Birthdaze
 
+[View on RubyGems](https://rubygems.org/gems/birthdaze)
+
 Birthdaze is a tool to generate a calendar of your contacts’ birthdays
 from a CardDAV server account.
+
+## Installation
+
+```bash
+gem install ruby
+```
+
+Note Birthdaze relies on the `curb` gem, which requires `libcurl4-openssl-dev` to be installed.
+
+## Setup
+
+You’ll need a config file in the `~/.config/birthdaze.yaml` that looks like the below:
+
+```yaml
+username: <username>
+password: <password>
+url: <url>
+ical_output: <path to output file>
+days_warning: <number of days warning>
+```
+
+## Usage
+
+Print a list of all birthdays.
+```bash
+birthdaze list
+```
+
+Generate an iCalendar file of your contacts’ birthdays.
+```bash
+birthdaze generate
+```
+
+## Notes
+
+- If a contact has a birthdate, the birthday will be set as recurring from that year. Otherwise,
+  it will be set as recurring from the current year.
+

data/lib/birthdaze.rb

@@ -1,4 +1,5 @@
 require "carddav"
+require "digest"
 require "icalendar"
 require "thor"
 require "yaml"
@@ -58,13 +59,20 @@ class Birthdaze < Thor
 
     @calendar = Icalendar::Calendar.new
     birthdays.each do |birthday|
-      @calendar.event do |event|
-        event.dtstart = Icalendar::Values::Date.new(start_date(birthday))
-        event.dtend = Icalendar::Values::Date.new(end_date(birthday))
-        event.summary = summary(birthday)
-        event.description = description(birthday)
-        event.rrule = "FREQ=YEARLY;"
-      end
+      event = Icalendar::Event.new
+      event.uid = uid(birthday)
+      event.dtstart = Icalendar::Values::Date.new(start_date(birthday))
+      event.dtend = Icalendar::Values::Date.new(end_date(birthday))
+      event.summary = summary(birthday)
+      event.description = description(birthday)
+      event.rrule = "FREQ=YEARLY;"
+      event.alarm do |alarm|
+        alarm.action = "DISPLAY"
+        alarm.description = "It is #{birthday[:name]}’s birthday on #{birthday[:day]}/#{birthday[:month]}"
+        alarm.summary = "Birthday reminder: #{birthday[:name]}"
+        alarm.trigger = "-P#{config['days_warning']}D"
+      end if config["days_warning"]
+      @calendar.add_event(event)
     end
     @calendar.publish
   end
@@ -80,6 +88,13 @@ class Birthdaze < Thor
     date.strftime("%Y%m%d")
   end
 
+  # Format a deterministic UID for the event so it isn’t re-added every time the calendar is re-generated
+  def uid(birthday)
+    uid = Digest::SHA2.hexdigest("#{birthday[:name]}#{birthday[:day]}#{birthday[:month]}")[0..35]
+    uid[8] = uid[13] = uid[18] = uid[23] = '-'
+    uid
+  end
+
   def summary(birthday)
     "🎂 #{birthday[:name]}’s birthday"
   end
@@ -90,9 +105,6 @@ class Birthdaze < Thor
     "#{birthday[:name]} was born in #{birthday[:birth_year]}"
   end
 
-  def set_reminders
-  end
-
   def birthday_regex
     # We need the dash for dates which don’t specify a year
     /.*BDAY.*:([\d-]*).*/
@@ -114,7 +126,7 @@ class Birthdaze < Thor
     return nil if date.length < 8
 
     birth_year = date[0..3]
-    return nil if birth_year == "1604" # This is set (for some reason) by DAVx⁵
+    return nil if birth_year == "1604" # This is set by some apps for birth dates without a year
     birth_year
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: birthdaze
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - T S Vallender
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-03 00:00:00.000000000 Z
+date: 2024-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carddav
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.5
 signing_key: 
 specification_version: 4
 summary: Generate a birthday calendar from CardDAV