wesabot 1.0.1 → 1.1.0

data/bin/wesabot

@@ -23,6 +23,16 @@ config = Campfire::Configuration.new
 daemonize = false
 pidfile = nil
 
+# if there's an /etc/wesabot directory, set that as the default config
+# location, and load wesabot.yml if it exists
+DEFAULT_CONFIG_DIR = "/etc/wesabot" # yeah, screw Windows
+if File.directory?(DEFAULT_CONFIG_DIR) and File.readable?(DEFAULT_CONFIG_DIR)
+  if File.readable?(wesabot_config = File.join(DEFAULT_CONFIG_DIR, "wesabot.yml"))
+    config = Campfire::FileConfiguration.new(wesabot_config)
+  end
+  config.config_dir = DEFAULT_CONFIG_DIR
+end
+
 # get configuration from ARGV
 optparse = OptionParser.new do |opts|
   opts.banner = "Usage: #{File.basename($0)} [options]"
@@ -30,12 +40,22 @@ optparse = OptionParser.new do |opts|
   opts.separator ""
   opts.separator "Options:"
 
+  opts.on("--config-dir DIR", "Configuration directory for wesabot and plugins") do |path|
+    if File.directory?(path) and File.readable?(path)
+      # load wesabot.yml if it exists
+      if File.readable?(wesabot_config = File.join(path, "wesabot.yml"))
+        config = Campfire::FileConfiguration.new(wesabot_config)
+      end
+      config.config_dir = path
+    else
+      optparse.warn "Configuration directory #{path} does not exist or is not readable. Ignoring."
+    end
+  end
+
   opts.on("-c", "--config FILE", "Configuration file") do |path|
     config = Campfire::FileConfiguration.new(File.expand_path(path, oldpwd))
   end
 
-  opts.separator "OR"
-
   opts.on("-t", "--token TOKEN", "API token (required)") do |api_token|
     config.api_token = api_token
   end

data/config/wesabot.yml.sample

@@ -1,4 +1,5 @@
 api_token: ecca8793813bd3e5720d9d562285db
 subdomain: example
 room: Development
-datauri: sqlite3:///path/to/database
+datauri: sqlite3:///path/to/database
+config_dir: /etc/wesabot

data/lib/campfire/configuration.rb

@@ -20,12 +20,13 @@ module Campfire
       self.logger = data[:logger] || data[:logfile] || Logger.new(STDOUT)
       self.google_api_key = data[:google_api_key]
       self.ssl_verify = data[:ssl_verify] != false
+      self.config_dir = data[:config_dir]
     end
 
     public
 
     attr_accessor :api_token, :subdomain, :room, :verbose, :datauri, :logger, 
-                  :google_api_key, :ssl_verify
+                  :google_api_key, :ssl_verify, :config_dir
 
     alias_method :verbose?, :verbose
 

data/lib/campfire/polling_bot/plugin.rb

@@ -17,7 +17,8 @@ module Campfire
             gsub(/([[:lower:]\d])([[:upper:]])/,'\1_\2').
             tr("-", "_").
             downcase
-        filepath = File.join(self.class.directory, "#{name}.yml")
+        config_dir = bot.config.config_dir || self.class.directory
+        filepath = File.join(config_dir, "#{name}.yml")
         if File.exists?(filepath)
           self.config = YAML.load_file(filepath)
         else
@@ -79,6 +80,8 @@ module Campfire
         plugin_classes = self.subclasses.sort {|a,b| b.priority <=> a.priority }
         # initialize plugins
         plugins = plugin_classes.map { |p_class| p_class.new }
+        # remove any plugins that require a config and don't have one
+        plugins.reject! {|p| p.requires_config? and p.config.empty?}
         return plugins
       end
 
@@ -123,6 +126,18 @@ module Campfire
         self.class.priority
       end
 
+      def self.requires_config(flag = true)
+        @requires_config = flag
+      end
+
+      def self.requires_config?
+        @requires_config
+      end
+
+      def requires_config?
+        self.class.requires_config?
+      end
+
       # called from Plugin objects to indicate what kinds of messages they accept
       # if the :addressed_to_me flag is true, it will only accept messages addressed
       # to the bot (e.g. "Wes, ____" or "______, Wes")

data/lib/campfire/polling_bot/plugins/airbrake/airbrake_plugin.rb

@@ -4,6 +4,7 @@ require 'airbrake/error'
 class AirbrakePlugin < Campfire::PollingBot::Plugin
   accepts :text_message, :addressed_to_me => true
   priority 10
+  requires_config
   
   def initialize
     super

data/lib/campfire/polling_bot/plugins/deploy/deploy_plugin.rb

@@ -3,7 +3,8 @@ require 'open-uri'
 # Plugin to get a list of commits that are on deck to be deployed
 class DeployPlugin < Campfire::PollingBot::Plugin
   accepts :text_message, :addressed_to_me => true
-
+  requires_config
+  
   def process(message)
     case message.command
     when /deploy\s([^\s\!]+)(?:(?: to)? (staging|nine|production))?( with migrations)?/

data/lib/campfire/polling_bot/plugins/tweet/tweet_plugin.rb

@@ -2,6 +2,7 @@
 class TweetPlugin < Campfire::PollingBot::Plugin
   accepts :text_message, :addressed_to_me => true
   priority 20
+  requires_config
 
   def process(message)
     case message.command

data/lib/campfire/sample_plugin.rb

@@ -1,12 +1,14 @@
-# Sample Campfire plugin. Plugins must be placed in the plugins directory in order to be loaded.
+# Sample Campfire plugin. Plugins must be placed in the plugins directory in 
+# order to be loaded.
 class SamplePlugin < Campfire::PollingBot::Plugin
-  # accept - specify which kinds of messages this plugin accepts. Put each type on its own line.
-  # You may optionally set :addressed_to_me => true to get only messages addressed to the bot.
+  # accept - specify which kinds of messages this plugin accepts. Put each type 
+  # on its own line. You may optionally set :addressed_to_me => true to get only
+  # messages addressed to the bot.
   # For example,
   #   accept :text_message, :addressed_to_me => true
-  # Will only accept text messages that are in the form "<bot name>, ..." or "... <bot name>".
-  # The body of the message minus the bot name will be returned by the 'command' method of the
-  # message.
+  # Will only accept text messages that are in the form "<bot name>, ..." or 
+  # "... <bot name>". The body of the message minus the bot name will be 
+  # returned by the 'command' method of the message.
   #
   # Message types are:
   #  - :all - all messages
@@ -24,31 +26,40 @@ class SamplePlugin < Campfire::PollingBot::Plugin
   accepts :text_message, :addressed_to_me => true
   accepts :paste_message
   
-  # priority is used to determine the plugin's order in the plugin queue. A higher number represents
-  # a higher priority. There are no upper or lower bounds. If you don't specify a priority, it defaults
-  # to 0.
+  # priority is used to determine the plugin's order in the plugin queue. A 
+  # higher number represents a higher priority. There are no upper or lower 
+  # bounds. If you don't specify a priority, it defaults to 0.
   
   priority 10
   
-  # If you need to do any one-time setup when the plugin is initially loaded, do it here. Optional. 
+  # include requires_config if the plugin requires a configuration file, and
+  # shouldn't be loaded if a configuration file can't be found
+
+  requires_config
+
+  # If you need to do any one-time setup when the plugin is initially loaded, 
+  # do it here. Optional. 
   def initialize
   end
   
-  # If your plugin implements the heartbeat method, it will be called every time the bot polls the room
-  # for activity (currently every 3 seconds), whether or not there are any new messages. The heartbeat
-  # method is optional. It does not take any parameters.
+  # If your plugin implements the heartbeat method, it will be called every 
+  # time the bot polls the room for activity (currently every 3 seconds), 
+  # whether or not there are any new messages. The heartbeat method is optional. 
+  # It does not take any parameters.
   def heartbeat
   end
   
-  # process is the only method your plugin needs to implement. This is called by the bot whenever it
-  # has a new message that matches one of the message types accepted by the plugin. See Campfire::Message
-  # for message documentation.
-  # If no other plugins should receive the message after this plugin, return HALT.
+  # process is the only method your plugin needs to implement. This is called 
+  # by the bot whenever it has a new message that matches one of the message 
+  # types accepted by the plugin. See Campfire::Message for message 
+  # documentation.
+  # If no other plugins should receive the message after this plugin, return 
+  # HALT.
   def process(message)
   end
   
-  # help is actually functionality provided by another plugin, HelpPlugin. Just return an array of
-  # ['command', 'description'] tuples
+  # help is actually functionality provided by another plugin, HelpPlugin. Just 
+  # return an array of ['command', 'description'] tuples
   def help
     [['some command', 'description of some command'],
      ['some other command', 'description of some other command']]

data/lib/campfire/version.rb

@@ -1,3 +1,3 @@
 module Campfire
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wesabot
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Brad Greenlee
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-13 00:00:00 Z
+date: 2011-09-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: tinder