absentee_camper 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in absentee_camper.gemspec
+gemspec

data/README.md

@@ -0,0 +1,77 @@
+#Absentee Camper
+
+This gem will monitor a Campfire room for @mentions, and notify the
+mentioned users via email if they aren't in the room.  Multiple users
+can be mentioned in one Campfire message, and each user will receive one
+notification email.  The email message will contain the message that was
+triggered by the @mention.
+
+## Usage
+
+1. `gem install absentee_camper`
+2. `ABSENTEE_CAMPER_CONFIG=/path/to/config absentee_camper`
+
+## Monitoring User
+
+It is recommended to create a user for the sole purpose of monitoring
+the Campfire room (e.g. Campfire Bot), and use that user's API token when running
+Absentee Camper.  The reason is that if you don't, and instead use the
+API token of a "real" user, that user will never be able to leave the
+Campfire room because Absentee Camper will be running under that user.
+This means that any mentions of that user won't trigger an email since
+they will always be present in the room.
+
+## Configuration
+
+Here is a sample config file:
+
+    ---
+    room_id: 12345
+    token: 'your-token'
+    campfire_subdomain: 'your-subdomain'
+    replyto_email_domain: 'your-replyto-domain'
+    users:
+      john: 12345
+      steve: 678910
+
+* `room_id` - The ID of the room you wish to monitor.  This can be found
+  in the URL for the room.
+* `token` - The API token for the monitoring user.
+* `campfire_subdomain` - This can be found in the Campfire URL (e.g. _subdomain_.campfirenow.com)
+* `replyto_email_domain` - The subdomain you would like to appear in the
+  email _from_ address.
+* `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`.
+
+## TODO
+
+* 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.
+
+* Provide a means other than email, such as text messaging, to notify
+  the users.
+
+## Contributing
+
+Do the usual fork -> change -> pull request dance.

data/absentee_camper.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "absentee_camper/version"
+
+Gem::Specification.new do |s|
+  s.name        = "absentee_camper"
+  s.version     = AbsenteeCamper::VERSION
+  s.authors     = ["Chad Boyd", "David Reese"]
+  s.email       = ["hoverlover@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Monitors a Campfire room for @mentions, and emails the @mentioned user with the message if they aren't in the room.}
+  s.description = s.summary
+
+  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"]
+
+  s.add_dependency('settingslogic', '~> 2.0')
+  s.add_dependency('yajl-ruby', '~> 0.8')
+  s.add_dependency('httparty', '~> 0.7')
+  s.add_dependency('pony', '~> 1.3')
+
+  s.add_development_dependency('rspec', '~> 2.6.0')
+end

data/bin/absentee_camper

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'absentee_camper'
+
+AbsenteeCamper::Monitor.new.start

data/lib/absentee_camper/campfire/api.rb

@@ -0,0 +1,24 @@
+module AbsenteeCamper
+  module Campfire
+    module API
+      extend self
+      include HTTParty
+
+      base_uri   "https://#{Config.campfire_subdomain}.campfirenow.com"
+      basic_auth Config.token, 'x'
+      headers    'Content-Type' => 'application/json'
+
+      def rooms
+        get('/rooms.json')["rooms"]
+      end
+
+      def room(room_id)
+        Room.new(room_id)
+      end
+
+      def user(id)
+        get("/users/#{id}.json")["user"]
+      end
+    end
+  end
+end

data/lib/absentee_camper/campfire/room.rb

@@ -0,0 +1,65 @@
+module AbsenteeCamper
+  module Campfire
+    class Room
+      attr_reader :room_id
+
+      def initialize(room_id)
+        @room_id = room_id
+      end
+
+      def join
+        post 'join'
+      end
+
+      def leave
+        post 'leave'
+      end
+
+      def lock
+        post 'lock'
+      end
+
+      def unlock
+        post 'unlock'
+      end
+
+      def message(message)
+        send_message message
+      end
+
+      def paste(paste)
+        send_message paste, 'PasteMessage'
+      end
+
+      def play_sound(sound)
+        send_message sound, 'SoundMessage'
+      end
+
+      def transcript
+        get('transcript')['messages']
+      end
+
+      def info
+        API.get "/room/#{room_id}.json"
+      end
+
+      private
+
+      def send_message(message, type = 'Textmessage')
+        post 'speak', :body => {:message => {:body => message, :type => type}}.to_json
+      end
+
+      def get(action, options = {})
+        API.get room_url_for(action), options
+      end
+
+      def post(action, options = {})
+        API.post room_url_for(action), options
+      end
+
+      def room_url_for(action)
+        "/room/#{room_id}/#{action}.json"
+      end
+    end
+  end
+end

data/lib/absentee_camper/config.rb

@@ -0,0 +1,27 @@
+module AbsenteeCamper
+  class Config < ::Settingslogic
+    source ENV['ABSENTEE_CAMPER_CONFIG']
+
+    def inititalize
+      Pony.options = {
+        # Uncomment for use with Gmail
+        #
+        #:via => :smtp, :via_options => {
+        #:address              => 'smtp.gmail.com',
+        #:port                 => '587',
+        #:enable_starttls_auto => true,
+        #:user_name            => 'your username',
+        #:password             => 'your password',
+        #:authentication       => :plain, # :plain, :login, :cram_md5, no auth by default
+        #:domain               => "localhost.localdomain" # the HELO domain provided by the client to the server
+        #},
+        :from => "campfire-#{room_id}@#{replyto_email_domain}",
+        :subject => '[Campfire] People are talking about you!'
+      }
+    end
+
+    def room_uri
+      "https://#{campfire_subdomain}.campfirenow.com/room/#{room_id}"
+    end
+  end
+end

data/lib/absentee_camper/monitor.rb

@@ -0,0 +1,81 @@
+module AbsenteeCamper
+  class Monitor
+    include Campfire
+
+    def initialize
+      @room = Room.new(Config.room_id)
+      @room.join
+    end
+
+    def users_in_room(room)
+      response = room.info
+      raise "Error while retrieving room info: #{response.message}" if response.code != 200
+
+      room = JSON.parse(response.body)
+      room['room']['users']
+    end
+
+    def user_info(user_id)
+      response = API.get("/users/#{user_id}.json")
+
+      if response.code != 200
+        user_name = Config.users.detect { |kv| kv[1] == user_id }[0]
+        raise "Error while retrieving user info for #{user_name}: #{response.message}"
+      end
+
+      user = JSON.parse(response.body)
+      user['user']
+    end
+
+    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}
+
+      #{Config.room_uri}
+      BODY
+    end
+
+    def log(message)
+      puts message
+    end
+
+    def start
+      log "monitoring room #{Config.room_id} at #{API.base_uri} ..."
+
+      url = URI.parse("http://#{Config.token}:x@streaming.campfirenow.com/room/#{Config.room_id}/live.json")
+
+      begin
+        Yajl::HttpStream.get(url) do |message|
+          if message['type'] == 'TextMessage'
+            body = message['body']
+            log body
+
+            body.scan(/@\w+/).each do |mention|
+              mentioned = mention[1..-1]
+              if Config.users.keys.include? mentioned
+                user_id = Config.users[mentioned]
+
+                begin
+                  # If the user isn't in the room, fire off an email to them
+                  unless users_in_room(@room).map { |u| u['id'] }.include? user_id
+                    email_address = user_info(user_id)['email_address']
+                    @room.message("[Sent an email to #{mentioned}.]")
+                    log "sending email to #{mentioned} at #{email_address}"
+
+                    Pony.mail :to => email_address, :body => email_body(body)
+                  end
+                rescue
+                  log $!
+                end
+              end
+            end
+          end
+        end
+      rescue Yajl::HttpStream::HttpError => e
+        log "Error connecting to campfire: #{e.message}"
+      end
+    end
+  end
+end

data/lib/absentee_camper/version.rb

@@ -0,0 +1,3 @@
+module AbsenteeCamper
+  VERSION = '0.0.1'
+end

data/lib/absentee_camper.rb

@@ -0,0 +1,19 @@
+require "rubygems"
+require "uri"
+require "yajl/http_stream"
+require 'httparty'
+require 'json'
+require 'pony'
+require 'settingslogic'
+
+module AbsenteeCamper
+  autoload :Config, 'absentee_camper/config'
+  autoload :Monitor, 'absentee_camper/monitor'
+  autoload :API, 'absentee_camper/campfire/api'
+  autoload :Room, 'absentee_camper/campfire/room'
+
+  module Campfire
+    autoload :API, 'absentee_camper/campfire/api'
+    autoload :Room, 'absentee_camper/campfire/room'
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: absentee_camper
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chad Boyd
+- David Reese
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-22 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: settingslogic
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: pony
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id005
+description: Monitors a Campfire room for @mentions, and emails the @mentioned user with the message if they aren't in the room.
+email: 
+- hoverlover@gmail.com
+executables: 
+- absentee_camper
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- absentee_camper.gemspec
+- bin/absentee_camper
+- lib/absentee_camper.rb
+- lib/absentee_camper/campfire/api.rb
+- lib/absentee_camper/campfire/room.rb
+- lib/absentee_camper/config.rb
+- lib/absentee_camper/monitor.rb
+- lib/absentee_camper/version.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Monitors a Campfire room for @mentions, and emails the @mentioned user with the message if they aren't in the room.
+test_files: []
+