NOTE

Currently, this only works with my campfire-bot fork. Hopefully, the maintainers of the main repo will pull in my changes.

CampfireBot::AbsenteeCamper Build Status

This is a plugin for use with 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. Install the gems: gem install campfire-bot campfire-bot-absentee-camper
  2. Create your absentee-camper-config.yml file (see below)
  3. Register the plugin to your main campfire-bot config.yml file
  4. campfire-bot <environment>, where <environment> is the matching environment from config.yml.

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 <[email protected]>
    :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 settings apply. You can specify multiple environments (e.g. development, test, etc).
  • pony_options - The configuration options for 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

  • 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.