campfire-bot-absentee-camper 0.0.1 → 0.1.0

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+log

data/Gemfile

@@ -8,4 +8,6 @@ group :development, :test do
   gem 'guard'
   gem 'guard-rspec'
   gem 'rake'
+  gem 'ruby-debug19'
+  gem 'growl'
 end

data/lib/campfire_bot/absentee_camper.rb

@@ -23,9 +23,10 @@ module CampfireBot
         room = msg[:room]
 
         body = msg['body']
-        body.scan(/@\w+/).each do |mention|
+        body.scan(/@\w+/).map(&:downcase).uniq.each do |mention|
           mentioned = mention[1..-1]
           if plugin_config['users'].keys.include? mentioned
+
             # If the user isn't in the room, fire off a notification
             unless room.users.map { |u| u['id'] }.include? user_id_from_config(mentioned)
               NotificationManager.new(room, plugin_config['users'][mentioned]).send_notifications body

data/lib/campfire_bot/absentee_camper/version.rb

@@ -1,5 +1,5 @@
 module CampfireBot
   module AbsenteeCamper
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/spec/absentee-camper-config.yml

@@ -0,0 +1,24 @@
+---
+test:
+  pony_options:
+    # NOTE: The colons before these options are very important.
+    #       Pony requires that the keys be symbols and not strings.
+    #
+    :from: Absentee Camper <no-reply@your-company.com>
+    :subject: "[Campfire] People are talking about you!"
+    :via: :smtp
+    :via_options:
+      :address: smtp.sendgrid.net
+      :port: 587
+      :enable_starttls_auto: true
+      :authentication: plain
+      :user_name: your-user-name
+      :password: secret
+  users:
+    # User with custom (and possibly multiple) notifiers
+    chad:
+      id: 1234567
+      notification_methods:
+        Prowl: your-prowl-api-key
+    # Default email notifier
+    john: 987654

data/spec/config.yml

@@ -0,0 +1,13 @@
+---
+test:
+  site: my_site
+  use_ssl: true
+  log_dir: log
+  rooms:
+    - General
+  api_key: fake-key
+  nickname: Campfire Bot
+  fullname: Campfire Bot
+  enable_plugins:
+    - absentee_camper
+

data/spec/lib/campfire_bot/absentee_camper_spec.rb

@@ -0,0 +1,146 @@
+require 'spec_helper'
+
+module CampfireBot
+  module AbsenteeCamper
+    include Notification
+
+    describe Plugin do
+      describe :role_call do
+        let(:users_in_config) { plugin_config['users'] }
+        let(:user_names_in_config) { users_in_config.keys }
+        let(:user_name_not_in_config) do
+          if user_names_in_config.include?(user_name = 'joel')
+            raise "User name expected to not be in config is present"
+          end
+
+          user_name
+        end
+
+        let(:room) do
+          room = double('room')
+
+          # No users present in room by default
+          room.stub(:users).and_return([])
+          room.stub(:speak)
+          room
+        end
+
+        let(:message) do
+          {
+            :room => room,
+
+            # @mentions can be added to body as needed
+            'body' => body_without_mention
+          }
+        end
+        let(:body_without_mention) { "hey there!" }
+        let(:notification_manager) { double("notification manager") }
+
+        it "notifies people that are @mentioned" do
+          user_name = user_names_in_config.first
+          add_users_to_message user_name
+
+          sends_notification_to user_name
+          subject.role_call message
+        end
+
+        it "doesn't send notifications to people that aren't mentioned" do
+          add_users_to_message user_name_not_in_config
+
+          does_not_send_notification
+          subject.role_call message
+        end
+
+        context "when @mentioning a user that is present in the room" do
+          let(:user_in_room) { user_names_in_config.first }
+
+          before do
+            room.stub(:users).and_return([{ 'id' => users_in_config.values.first['id'] }])
+          end
+
+          it "doesn't send a notification" do
+            add_users_to_message user_in_room
+            subject.role_call message
+          end
+        end
+
+        it "is case-insenstive to @mentions" do
+          user_name = user_names_in_config.first
+
+          mixed_case = user_name[0].upcase + user_name[1..-1]
+          add_users_to_message mixed_case
+          sends_notification_to user_name
+          subject.role_call message
+
+          reset_message_body
+
+          add_users_to_message user_name.upcase
+          sends_notification_to user_name
+          subject.role_call message
+        end
+
+        context "when multiple users are @mentioned" do
+          before do
+            add_users_to_message *user_names_in_config
+          end
+
+          it "sends a notification to each user @mentioned" do
+            times = 0
+            user_names_in_config.each do |name|
+              times += 1
+
+              NotificationManager
+                .should_receive(:new)
+                .with(room, users_in_config[name])
+                .and_return(notification_manager)
+            end
+
+            notification_manager.should_receive(:send_notifications).with(message['body']).exactly(times).times
+            subject.role_call message
+          end
+        end
+
+        context "when the same user is @mentioned multiple times" do
+          let(:name) { user_names_in_config.first }
+
+          before do
+            # use different variations in case also
+            same_names = [name, name.upcase]
+            add_users_to_message *same_names
+          end
+
+          it "only sends one notification" do
+            sends_notification_to name
+            subject.role_call message
+          end
+        end
+
+        def reset_message_body
+          message['body'] = body_without_mention
+        end
+
+        def add_users_to_message(*users)
+          message['body'] = "#{mentionize_users(users)} #{message['body']}"
+        end
+
+        def mentionize_users(users)
+          users.map { |user| "@#{user}" }.join(' ')
+        end
+
+        def sends_notification_to(name)
+          NotificationManager
+            .should_receive(:new)
+            .with(room, users_in_config[name])
+            .and_return(notification_manager)
+
+          notification_manager.should_receive(:send_notifications).with(message['body'])
+        end
+
+        def does_not_send_notification
+          NotificationManager.should_not_receive(:new)
+          NotificationManager.any_instance.should_not_receive(:send_notifications)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,13 +1,17 @@
 require "rubygems"
 require "bundler/setup"
 Bundler.require(:default, :test)
+require 'ruby-debug'
 
-BOT_ROOT = '..'
+BOT_ROOT = File.join(FileUtils.pwd, 'spec')
 BOT_ENVIRONMENT = 'test'
 require 'bot'
 require 'absentee_camper'
 
 RSpec.configure do |config|
+  config.include CampfireBot::AbsenteeCamper::Notification
+  config.include CampfireBot::AbsenteeCamper::Config
+
   config.before do
     CampfireBot::AbsenteeCamper::Logger.stub(:instance).and_return(double('logger').as_null_object)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: campfire-bot-absentee-camper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-03 00:00:00.000000000Z
+date: 2011-10-13 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: campfire-bot
-  requirement: &70151619075160 !ruby/object:Gem::Requirement
+  requirement: &70221517964260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *70151619075160
+  version_requirements: *70221517964260
 - !ruby/object:Gem::Dependency
   name: pony
-  requirement: &70151619063060 !ruby/object:Gem::Requirement
+  requirement: &70221517963420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70151619063060
+  version_requirements: *70221517963420
 - !ruby/object:Gem::Dependency
   name: prowl
-  requirement: &70151619062520 !ruby/object:Gem::Requirement
+  requirement: &70221517962640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 0.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *70151619062520
+  version_requirements: *70221517962640
 description: Plugin for campfire-bot that monitors incoming messages and notifies
   a user that is @mentioned if they aren't present.
 email:
@@ -68,9 +68,12 @@ files:
 - lib/campfire_bot/absentee_camper/notification/notification_manager.rb
 - lib/campfire_bot/absentee_camper/notification/prowl_notifier.rb
 - lib/campfire_bot/absentee_camper/version.rb
+- spec/absentee-camper-config.yml
+- spec/config.yml
 - spec/lib/campfire_bot/absentee_camper/notification/email_notifier_spec.rb
 - spec/lib/campfire_bot/absentee_camper/notification/notification_manager_spec.rb
 - spec/lib/campfire_bot/absentee_camper/notification/prowl_notifier_spec.rb
+- spec/lib/campfire_bot/absentee_camper_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
@@ -98,7 +101,10 @@ specification_version: 3
 summary: Plugin for campfire-bot that monitors incoming messages and notifies a user
   that is @mentioned if they aren't present.
 test_files:
+- spec/absentee-camper-config.yml
+- spec/config.yml
 - spec/lib/campfire_bot/absentee_camper/notification/email_notifier_spec.rb
 - spec/lib/campfire_bot/absentee_camper/notification/notification_manager_spec.rb
 - spec/lib/campfire_bot/absentee_camper/notification/prowl_notifier_spec.rb
+- spec/lib/campfire_bot/absentee_camper_spec.rb
 - spec/spec_helper.rb