campfire-bot-absentee-camper 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format doc

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in campfire-bot-absentee-camper.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rspec', '~> 2.6'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'rake'
+end

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -0,0 +1,100 @@
+# NOTE
+
+Currently, this only works with [my fork](https://github.com/hoverlover/campfire-bot).  Hopefully,
+the maintainers of the [main repo](https://github.com/joshwand/campfire-bot) will pull in my changes.
+
+#CampfireBot::AbsenteeCamper [![Build Status](https://secure.travis-ci.org/hoverlover/campfire-bot-absentee-camper.png)](http://travis-ci.org/hoverlover/campfire-bot-absentee-camper)
+
+This is a plugin for use with [campfire-bot](https://github.com/joshwand/campfire-bot).
+It will monitor a Campfire room for _@mentions_, and notify the
+mentioned users using one of the built-in notifiers (email by default)
+if they aren't present in the room.  Multiple users
+can be mentioned in one Campfire message, and each user will receive one
+notification.  The notification will contain the message that was
+triggered by the _@mention_.
+
+## Usage
+
+1. First, make sure you install the campfire-bot gem.
+2. `gem install campfire-bot-absentee-camper`
+3. Create Gemfile with the following lines:
+    gem 'campfire-bot'
+    gem 'campfire-bot-absentee-camper'
+4. Create your _absentee-camper-config.yml_ file (see below).
+5. Register the plugin to your main _config.yml_ file
+6. `bundle exec bot <environment>`, where `<environment>` is the
+   matching environment from the config file.
+
+## Configuration
+
+Here is a sample config file:
+
+    ---
+    production:
+      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
+
+* `production` - This is the environment for which the settins apply.
+  You can specify multiple environments (e.g. development, test, etc).
+* `pony_options` - The configuration options for [Pony](https://github.com/adamwiggins/pony)
+* `users` - Each user line consists of the name of the mention name and
+  that user's corresponding 37Signals Campfire user ID.  One way to get
+  this user ID is to log into Campfire as a user that has admin privileges,
+  click on the _Users_ tab, and then hover over the _change_ link of the
+  user for which you want to find the user ID and take note of the number
+  in the path (e.g. https://_your-company_.campfirenow.com/member/12345/permissions).
+  For example, if you have a user named John Smith with a
+  user ID of 12345, and you want to be able to mention them as _@john_,
+  the users line in the config file would be `john: 12345`.
+* `notification_methods` - Alternate notification methods.  Currently,
+  the only notification method other than the default (email) is Prowl.
+
+## TODO
+
+* More specs!
+* Provide context in the notification.  For example, in a Campfire
+  session there are two users: John and Steve.  Another user, Chad
+  is not present in the room:
+
+        John Smith: Hey Steve.  I am having a problem with the build.
+        Steve Stallion: Hey John.  I don't know anything about that.  You
+        should ask @chad.  That's his department.
+        John Smith: Oh, I thought you were the one that handled that.  OK,
+        I will wait for Chad's response.
+
+  Currently, the email notification that Absentee Camper sends out will
+  only contain the second message, which doesn't have any context about
+  what was being discussed.  It would be nice to set some configuration
+  variables that indicated you wanted to include context in the
+  notification message, and how many lines on either side to include.
+
+## Testing
+
+You have two options:
+
+* run `bundle exec rake`
+* run `bundle exec guard` for continuous feedback
+
+## Contributing
+
+Do the usual fork -> change -> pull request dance.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/absentee-camper-config.example.yml

@@ -0,0 +1,24 @@
+---
+production:
+  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/campfire-bot-absentee-camper.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "campfire_bot/absentee_camper/version"
+
+Gem::Specification.new do |s|
+  s.name        = "campfire-bot-absentee-camper"
+  s.version     = CampfireBot::AbsenteeCamper::VERSION
+  s.authors     = ["hoverlover"]
+  s.email       = ["hoverlover@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Plugin for campfire-bot that monitors incoming messages and notifies a user that is @mentioned if they aren't present.}
+  s.description = s.summary
+
+  s.rubyforge_project = "campfire-bot-absentee-camper"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib/campfire_bot"]
+
+  s.add_dependency 'campfire-bot', '~> 0.0.1'
+  s.add_dependency 'pony', '~> 1.3'
+  s.add_dependency 'prowl', '~> 0.1.3'
+end

data/lib/campfire_bot/absentee_camper.rb

@@ -0,0 +1,55 @@
+module CampfireBot
+  module AbsenteeCamper
+    autoload :Config, "absentee_camper/config"
+    autoload :Logger, "absentee_camper/logger"
+    autoload :NotificationManager, "absentee_camper/notification/notification_manager"
+
+    module Notification
+      autoload :EmailNotifier, "absentee_camper/notification/email_notifier"
+      autoload :ProwlNotifier, "absentee_camper/notification/prowl_notifier"
+    end
+
+    class Plugin < CampfireBot::Plugin
+      include Notification
+      include Config
+
+      on_message /@\w+/i, :role_call
+
+      def initialize
+        Logger.instance.log = bot.log
+      end
+
+      def role_call(msg)
+        room = msg[:room]
+
+        body = msg['body']
+        body.scan(/@\w+/).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
+              room.speak("[Notified #{mentioned}]")
+            end
+          end
+        end
+      end
+
+      private
+
+      def user_id_from_config(mentioned)
+        if plugin_config['users'][mentioned].is_a? Hash
+          plugin_config['users'][mentioned]['id']
+        else
+          plugin_config['users'][mentioned]
+        end
+      end
+    end
+
+    module Helpers
+      def room_uri(room)
+        "https://#{root_config['site']}.campfirenow.com/room/#{room.id}"
+      end
+    end
+  end
+end

data/lib/campfire_bot/absentee_camper/config.rb

@@ -0,0 +1,24 @@
+module CampfireBot
+  module AbsenteeCamper
+    module Config
+
+      def root_config
+        bot.config
+      end
+
+      def plugin_config
+        PluginConfig.instance.config
+      end
+
+      class PluginConfig
+        include Singleton
+
+        def initialize
+          self.config = YAML::load(ERB.new(File.read("#{BOT_ROOT}/absentee-camper-config.yml")).result)[BOT_ENVIRONMENT]
+        end
+
+        attr_accessor :config
+      end
+    end
+  end
+end

data/lib/campfire_bot/absentee_camper/logger.rb

@@ -0,0 +1,11 @@
+module CampfireBot
+  module AbsenteeCamper
+    class Logger
+      include Singleton
+      extend Forwardable
+
+      attr_accessor :log
+      def_delegators :log, :debug, :info, :warn, :error, :fatal
+    end
+  end
+end

data/lib/campfire_bot/absentee_camper/notification/email_notifier.rb

@@ -0,0 +1,41 @@
+require 'pony'
+
+module CampfireBot
+  module AbsenteeCamper
+    module Notification
+      class EmailNotifier
+        include Config
+        include Helpers
+
+        def initialize(room, user_id)
+          @email_address = room.user(user_id)['email_address']
+          @room = room
+        end
+
+        def notify(message)
+          Logger.instance.debug "sending email to #{@email_address}"
+          Pony.mail({
+            :to => @email_address,
+            :body => email_body(message)
+          }.merge(pony_options))
+        end
+
+        private
+
+        def email_body(message)
+          body = <<-BODY
+Come back to the campfire!  We're having a good time telling ghost stories!  Here's one you missed:
+
+#{message}
+
+#{room_uri(@room)}
+BODY
+        end
+
+        def pony_options
+          plugin_config['pony_options']
+        end
+      end
+    end
+  end
+end

data/lib/campfire_bot/absentee_camper/notification/notification_manager.rb

@@ -0,0 +1,33 @@
+module CampfireBot
+  module AbsenteeCamper
+    module Notification
+      class NotificationManager
+
+        def initialize(room, user_config)
+          if user_config.is_a?(Hash) and user_config['notification_methods']
+            user_config['notification_methods'].each do |notifier, initialization_info|
+              add_notifier Notification.const_get("#{notifier}Notifier".to_sym).new(room, initialization_info)
+            end
+          else
+            # Everyone gets Email notifications if no other notifier is defined.
+            # In this case, user_config is the user_id.
+
+            Logger.instance.debug "No notification methods defined.  Falling back to email notifications."
+            @notifiers = [EmailNotifier.new(room, user_config)]
+          end
+        end
+
+        def send_notifications(message)
+          @notifiers.each { |notifier| notifier.notify message }
+        end
+
+        private
+
+        def add_notifier(notifier)
+          @notifiers ||= []
+          @notifiers << notifier
+        end
+      end
+    end
+  end
+end

data/lib/campfire_bot/absentee_camper/notification/prowl_notifier.rb

@@ -0,0 +1,26 @@
+require 'prowl'
+
+module CampfireBot
+  module AbsenteeCamper
+    module Notification
+      class ProwlNotifier
+        include Config
+        include Helpers
+
+        def initialize(room, api_key)
+          @api_key = api_key
+          @room = room
+        end
+
+        def notify(message)
+          Logger.instance.debug "sending prowl notification"
+          Prowl.add(:apikey => @api_key,
+                    :application => 'Campfire',
+                    :event => @room.name,
+                    :description => message,
+                    :url => room_uri(@room))
+        end
+      end
+    end
+  end
+end

data/lib/campfire_bot/absentee_camper/version.rb

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

data/spec/lib/campfire_bot/absentee_camper/notification/email_notifier_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+module CampfireBot
+  module AbsenteeCamper
+    module Notification
+      describe EmailNotifier do
+
+        let(:email_address) { "johnny@test.com" }
+        let(:uri) { 'http://www.google.com' }
+        let(:body) do
+          body = <<-BODY
+Come back to the campfire!  We're having a good time telling ghost stories!  Here's one you missed:
+
+#{message}
+
+#{uri}
+BODY
+        end
+        let(:message) { "this is a test" }
+        let(:user_id) { 1 }
+        let(:email_address) { 'jon.levin@shredders-r-us.com' }
+        let(:room) do
+          room = double('room').as_null_object
+          room.stub(:user).with(user_id).and_return({ 'email_address' => email_address })
+          room
+        end
+        let(:pony_options) { { :via => :smtp } }
+
+        before do
+          subject.stub(:room_uri).and_return(uri)
+          EmailNotifier.any_instance.stub(:room_uri).and_return(uri)
+        end
+
+        describe :notify do
+          subject { EmailNotifier.new(room, user_id) }
+
+          before do
+            subject.stub(:plugin_config).and_return({'pony_options' => pony_options })
+          end
+
+          it "logs a message indicating the message is being sent" do
+            Pony.stub(:mail)
+            Logger.instance.should_receive(:debug).with("sending email to #{email_address}")
+            subject.notify(message)
+          end
+
+          it "sends the email with the correct information" do
+            Pony.should_receive(:mail).with({
+              :to => email_address,
+              :body => body
+            }.merge(pony_options))
+
+            subject.notify(message)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/campfire_bot/absentee_camper/notification/notification_manager_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+
+module CampfireBot
+  module AbsenteeCamper
+    module Notification
+      describe NotificationManager do
+        let(:room) { double('room').as_null_object }
+        let(:user_id) { 1 }
+
+        before(:all) do
+          NotificationManager.send :public, :add_notifier
+        end
+
+        after(:all) do
+          NotificationManager.send :private, :add_notifier
+        end
+
+        describe "creating the NotificationManager" do
+          let(:prowl_api_key) { "abcde" }
+
+          context "when the user_info is a Hash" do
+            let(:user_info) do
+              { 'id' => user_id }
+            end
+
+            context "and contains only one notification method" do
+              before do
+                user_info['notification_methods'] = { 'Prowl' => prowl_api_key }
+              end
+
+              it "creates the correct type of notifier" do
+                ProwlNotifier.should_receive(:new).with(room, prowl_api_key)
+                NotificationManager.new(room, user_info)
+              end
+
+              it "only creates one notifier" do
+                Notification
+                  .should_receive(:const_get)
+                  .once
+                  .and_return(ProwlNotifier)
+
+                NotificationManager.new(room, user_info)
+              end
+
+              it "adds the notifier to the list of notifiers" do
+                NotificationManager.any_instance.should_receive(:add_notifier).with(an_instance_of(ProwlNotifier))
+                NotificationManager.new(room, user_info)
+              end
+            end
+
+            context "and contains more than one notification method" do
+              before do
+                user_info['notification_methods'] = {
+                  'Prowl' => prowl_api_key,
+                  'Email' => user_id
+                }
+              end
+
+              it "creates the correct types of notifiers" do
+                ProwlNotifier.should_receive(:new).with(room, prowl_api_key)
+                EmailNotifier.should_receive(:new).with(room, user_id)
+
+                NotificationManager.new(room, user_info)
+              end
+
+              it "creates the correct number of notifiers" do
+                Notification
+                  .should_receive(:const_get)
+                  .exactly(user_info['notification_methods'].size)
+                  .times
+                  .and_return(ProwlNotifier, EmailNotifier)
+
+                NotificationManager.new(room, user_info)
+              end
+
+              it "adds the notifiers to the list of notifiers" do
+                # I really don't like the way I'm testing this.  Seems
+                # hacky.  I want to do something like this:
+                #
+                #   NotificationManager
+                #     .any_instance
+                #     .should_receive(:add_notifier)
+                #     .once.with(an_instance_of(ProwlNotifier))
+                #     .once.with(an_instance_of(EmailNotifier))
+                #
+                #   but, this doesn't work.
+
+                with_prowl, with_email = false
+                NotificationManager.any_instance.should_receive(:add_notifier).twice { |notifier|
+                  with_prowl = true if notifier.is_a? ProwlNotifier
+                  with_email = true if notifier.is_a? EmailNotifier
+                }
+
+                NotificationManager.new(room, user_info)
+                with_prowl.should be_true
+                with_email.should be_true
+              end
+            end
+
+            context "and the user_info is not a Hash" do
+              let(:user_info) { user_id }
+              let(:log_message) { "No notification methods defined.  Falling back to email notifications." }
+
+              it "logs a message" do
+                Logger.instance.should_receive(:debug).with(log_message)
+                NotificationManager.new(room, user_info)
+              end
+
+              it "creates an EmailNotifier by default" do
+                EmailNotifier.should_receive(:new).with(room, user_info)
+                NotificationManager.new(room, user_info)
+              end
+            end
+          end
+        end
+
+        describe "sending notifications" do
+          let(:user_info) do
+            { 'id' => user_id }
+          end
+          let(:message) { "test" }
+
+          context "when there is only one notifier" do
+            before do
+              user_info['notification_methods'] = { 'Prowl' => 'abcde' }
+            end
+
+            it "only sends one notification" do
+              ProwlNotifier.any_instance.should_receive(:notify)
+              manager = NotificationManager.new(room, user_info)
+              manager.send_notifications message
+            end
+          end
+
+          context "when there are multiple notifiers" do
+            before do
+              user_info['notification_methods'] = {
+                'Prowl' => 'abcde',
+                'Email' => user_id
+              }
+            end
+
+            it "only sends one notification" do
+              ProwlNotifier.any_instance.should_receive(:notify)
+              EmailNotifier.any_instance.should_receive(:notify)
+              manager = NotificationManager.new(room, user_info)
+              manager.send_notifications message
+            end
+          end
+
+          it "sends the correct message" do
+            EmailNotifier.any_instance.should_receive(:notify).with(message)
+            manager = NotificationManager.new(room, user_id)
+            manager.send_notifications message
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/campfire_bot/absentee_camper/notification/prowl_notifier_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module CampfireBot
+  module AbsenteeCamper
+    module Notification
+      describe ProwlNotifier do
+        let(:api_key) { '123456789' }
+        let(:application) { 'Campfire' }
+        let(:event) { 'Mentioned' }
+        let(:message) { 'testing 1 2 3' }
+        let(:uri) { 'http://www.google.com' }
+        let(:room) do
+          room = double('room').as_null_object
+          room.stub(:name).and_return(event)
+          room
+        end
+
+        subject { ProwlNotifier.new(room, api_key) }
+
+        before do
+          subject.stub(:room_uri).and_return(uri)
+        end
+
+        describe :notify do
+
+          it "logs a message indicating the message is being sent" do
+            Prowl.stub(:add)
+            Logger.instance.should_receive(:debug).with('sending prowl notification')
+            subject.notify(message)
+          end
+
+          it "sends the Prowl message" do
+            Prowl.should_receive(:add).with({
+              :apikey => api_key,
+              :application => application,
+              :event => event,
+              :description => message,
+              :url => uri
+            })
+
+            subject.notify(message)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "rubygems"
+require "bundler/setup"
+Bundler.require(:default, :test)
+
+BOT_ROOT = '..'
+BOT_ENVIRONMENT = 'test'
+require 'bot'
+require 'absentee_camper'
+
+RSpec.configure do |config|
+  config.before do
+    CampfireBot::AbsenteeCamper::Logger.stub(:instance).and_return(double('logger').as_null_object)
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: campfire-bot-absentee-camper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- hoverlover
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: campfire-bot
+  requirement: &70151619075160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70151619075160
+- !ruby/object:Gem::Dependency
+  name: pony
+  requirement: &70151619063060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70151619063060
+- !ruby/object:Gem::Dependency
+  name: prowl
+  requirement: &70151619062520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70151619062520
+description: Plugin for campfire-bot that monitors incoming messages and notifies
+  a user that is @mentioned if they aren't present.
+email:
+- hoverlover@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- absentee-camper-config.example.yml
+- campfire-bot-absentee-camper.gemspec
+- lib/campfire_bot/absentee_camper.rb
+- lib/campfire_bot/absentee_camper/config.rb
+- lib/campfire_bot/absentee_camper/logger.rb
+- lib/campfire_bot/absentee_camper/notification/email_notifier.rb
+- 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/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/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib/campfire_bot
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: campfire-bot-absentee-camper
+rubygems_version: 1.8.10
+signing_key: 
+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/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/spec_helper.rb