Improvements

README.md

@@ -3,37 +3,59 @@
 The purpose of this bot is to send a message to your team's Slack when is someones birthday.
 
 
-## Setup & Deploy
+## Setup
+
+1. Clone this repo to a desired location on your own computer
+2. Configure an [Incoming Webhook URL](https://api.slack.com/incoming-webhooks) from Slack
+3. Choose your desired database structure file ( `<ext>` : YAML / JSON ).
+   ( YAML is easier to configure as you have to bother about the indentation with spaces alone. You'll have to bother a lot more with JSON - Parentheses, commas. But in the end it's what you're more comfortable with that matters. )
+   1. Make a copy of the `birthdays.<ext>.example` file naming it to `birthdays.<ext>`.
+   2. Populate your birthdays database with the birthdays of your team members.
+      * NB : You can either use their real names or their usernames. Just remember to configure the mention configuration correctly.
+4. Make a copy of the `configurations.json.example` file naming it `configurations.json`. Update the configuration values according to your preferences
+```
+    {
+       "db_path"		: "birthdays.<ext>",			# according to your preference
+									# birthdays.yaml for YAML and birthdays.json for JSON
+       "mention"		: <true | false>,			# depends on your database configuration format
+									# if you're using real names, set this value to false
+									# if you're using usernames, set this value to true
+       "slack_url"		: "https://hooks.slack.com/...",	# the webhook URL you configured in step 2.
+       "channel_name"		: "<channel_name>",			# the channel you want your wishes to be sent to
+       "greeting_message"	: "Happy birthday!"			# the wish you would like the bot to send
+       "bot_name"		: "Birthday Bot"			# the name of the bot sending the wish
+       "bot_emoji"		: ":tada:"				# the emoji the bot should use as it's icon
+    }
+```
+
+## Deploy
 
 ### Heroku
 
-1. Clone this repo to a desire location at your own computer
-2. Get your [Incoming Webhook URL](https://api.slack.com/incoming-webhooks) from Slack
-3. Save the url at `configurations.json` file and fill in the rest of the configurations as you like
-4. Set your birthdays list using the format `FirstName LastName YY MM DD` at the `birthdays.txt` file
-5. Create a blank app at Heroku
-6. Push your code to Heroku
-7. The bot was developed with the **2.2.6** version of ruby, any other versions may require changes.
-7. Run `heroku addons:create scheduler:standard` to add the Scheduler add-on to your deploy
-8. Run `heroku addons:open scheduler` to configure the scheduler
-9. Click **Add a new job** and type `rake congratulate` as the command
-10. Set frequency to **Daily** and choose the **Time** you want to be notified
+1. Create a blank app at Heroku
+2. Push your code to Heroku
+3. The bot was developed with the **2.2.6** version of ruby, any other versions may require changes.
+4. Run `heroku addons:create scheduler:standard` to add the Scheduler add-on to your deploy
+5. Run `heroku addons:open scheduler` to configure the scheduler
+6. Click **Add a new job** and type `rake congratulate` as the command
+7. Set frequency to **Daily** and choose the **Time** you want to be notified
 
 ### Custom Server
 
-1. Clone this repo to a desire location at your own server
-2. Get your [Incoming Webhook URL](https://api.slack.com/incoming-webhooks) from Slack
-3. Save the url at `configurations.json` file and fill in the rest of the configurations as you like
-4. Set your birthdays list using the format `FirstName LastName YY MM DD` at the `birthdays.txt` file
-5. Run `crontab -e` to edit your crontab
-6. Add this line to the crontab and save it: `0 9 * * * cd /clone/location && /usr/local/bin/rake congratulate` (replace `/clone/location` by the location where you cloned the repo)
+1. Run `crontab -e` to edit your crontab
+2. Add this line to the crontab and save it:
+   `@daily cd /clone/location && /usr/local/bin/rake congratulate`
+   * replace `/clone/location` with the location where you cloned the repo)
+   * the `@daily` `cron` shorthand might vary among servers and/or distributions.
+     Replace `@daily` with a time of your preference according to the [`cron` syntax](http://tldp.org/LDP/lame/LAME/linux-admin-made-easy/using-cron.html).
+   * Remember to verify the timezone setting of your server or you won't get the expected result.
 
 
 ## Contributors 
 
 This project was originally created by [Tiago Botelho](https://github.com/tiagonbotelho), while he was an intern at [jeKnowledge](http://jeknowledge.pt/).
 
-It was later revised by [Diogo Nunes](http://www.diogonunes.com/) from [EqualExperts](https://www.equalexperts.com/) and [João Bernardo](http://jbernardo.me) from [jeKnowledge](http://jeknowledge.pt/).
+It was later revised by [Diogo Nunes](http://www.diogonunes.com/) from [EqualExperts](https://www.equalexperts.com/), [João Bernardo](http://jbernardo.me) from [jeKnowledge](http://jeknowledge.pt/) and @shinenelson.
 
 ## License
 

birthdays.json.example

@@ -0,0 +1,17 @@
+{
+	"01" :
+		{
+			"01" : [ "elvina.slovak" ]
+		},
+
+	"02" :
+		{
+			"02" : [ "john.doe", "jane.doe" ],
+			"28" : [ "chris.nolan" ],
+		},
+
+	"04" :
+		{
+			"15" : [ "erwin.down", "leora.pontious", "randy.young" ]
+		}
+}

birthdays.yaml.example

@@ -0,0 +1,9 @@
+"01" :
+    "01" : [ "elvina.slovak" ]
+
+"02" :
+    "02" : [ "john.doe", "jane.doe" ]
+    "28" : [ "chris.nolan" ]
+
+"04" :
+    "15" : [ "erwin.down", "leora.pontious", "randy.young" ]

configurations.json → configurations.json.example

@@ -1,4 +1,6 @@
 {
+  "birthdays_path":   "birthdays.yaml",
+  "mention":          true,
   "slack_url":        "https://hooks.slack.com/...",
   "channel_name":     "general",
   "greeting_message": "Happy birthday !",

lib/birthday_bot.rb

@@ -3,26 +3,45 @@
 require 'birthday_reader'
 
 class BirthdayBot 
-  @@path = "birthdays.txt"
 
   def initialize()
     @config = ConfigReader.new
     @config.load('configurations.json')
   end
 
   def start!
-    birthdays = BirthdayReader.get_birthdays(@@path)
-    today = Time.now 
+    birthdays = BirthdayReader.get_birthdays(@config.birthdays_path)
 
-    puts "Checking who was born today (#{today.to_s})"
-    birthdays.each do |b|
-      if (b[3].to_i == today.month) && (b[4].to_i == today.day)
-        message = "#{@config.greeting_message} #{b[0]} #{b[1]}" 
-        HTTParty.post(@config.slack_url, body: { channel: @config.channel_name,
-                                                 username: @config.bot_name,
-                                                 text: message,
-                                                 icon_emoji: @config.bot_emoji }.to_json)
+    puts "Checking who was born today ( #{ Time.now.to_s } )"
+    unless birthdays.nil?
+      users = "#{ mention birthdays[0] }"
+      if birthdays.count > 1
+        puts "#{ birthdays.count } people were born today"
+        if birthdays.count == 2
+          users = " #{ mention birthdays[0] } and #{ mention birthdays[1] } "
+        else
+           for i in 1..birthdays.count-2
+             users.concat( ", #{ mention birthdays[i] }" )
+           end
+           users.concat( " and #{ mention birthdays[i+1] } " )
+        end
       end
+      message = "#{users} #{@config.greeting_message}"
+      HTTParty.post(@config.slack_url, body: { channel: @config.channel_name,
+                                               username: @config.bot_name,
+                                               text: message,
+                                               icon_emoji: @config.bot_emoji }.to_json)
+    else
+      puts "Today is a day that no one was born"
     end
   end
+
+  def mention ( name )
+    if @config.mention
+      "<@#{ name }>"
+    else
+      name
+    end
+  end
+
 end

lib/birthday_reader.rb

@@ -1,12 +1,13 @@
+require 'yaml'
+
 class BirthdayReader
   def self.get_birthdays(file_path)
     birthdays = []
     if File.exist?(file_path) 
-      file = File.new(file_path, 'r')
-      file.each_line do |line|
-        birthdays << line.chomp.split
-      end
-      file.close
+	bday_list = YAML.load_file(file_path)
+	unless bday_list.nil? || bday_list.empty?
+          birthdays = bday_list[Time.now.month.to_s][Time.now.day.to_s]
+        end
     end
     return birthdays
   end

lib/config_reader.rb

@@ -1,7 +1,9 @@
 require 'json'
 
 class ConfigReader
-  attr_accessor :slack_url,
+  attr_accessor :birthdays_path,
+                :mention,
+                :slack_url,
                 :channel_name,
                 :greeting_message,
                 :bot_name,
@@ -11,6 +13,8 @@ def load(filename)
     if File.exist?(filename)
       file = File.read(filename)
       config = JSON.parse(file)
+      @birthdays_path = config['birthdays_path']
+      @mention = config['mention']
       @slack_url = config['slack_url']
       @channel_name = config['channel_name']
       @greeting_message = config['greeting_message']