RubyGems - campfire-bot - Versions diffs - 0.1.0 → 1.0.0 - Mend

campfire-bot 0.1.0 → 1.0.0

Files changed (43) hide show

data/.gitignore CHANGED

@@ -1,4 +1,4 @@
-*config.yml
+config.yml
 tmp/*
 var/*
 .bundle

data/Gemfile CHANGED

@@ -1,3 +1,8 @@
 source :gemcutter
-gemspec
+gem 'twitter-stream'
+gem 'tinder', ">= 1.4.3"
+gem 'mime-types'
+gem 'activesupport'
+gem 'logging'
+gem 'i18n'

data/README.textile CHANGED

@@ -8,15 +8,26 @@ h2. Installation
 @gem install campfire-bot@
+h3. Download
+Download the source from "github":http://github.com/joshwand/campfire-bot
 h3. Configuration
-Create a @config.yml@ in the directory from which you will run the bot. Use @config.example.yml@ as an example.
+Create a @config.yml@ in the root of the source directory. Use @config.example.yml@ as an example.
 h2. Usage
-To run the bot, run @campfire-bot@ with the environment name as the argument:
+To run the bot, run @campfire-bot@ with the following parameters:
+  -c config FILE          path to config file
+  -e ENVIRONMENT_NAME     environment name to load from config file
+  -p plugin PLUGIN_PATH   path to your plugins
+Example:
-  campfire-bot development
+@campfire-bot -c config.yml -e production -p ./plugins@
 h2. Known issues
@@ -41,5 +52,4 @@ h3. Contributors
 * Marcel M. Cary - "github":http://github.com/mcary
 * Hugh Evans - "github":http://github.com/artpop
 * Sean O'Dowd - "github":http://github.com/seanodowd
-* Andrew Erickson - "github":http://github.com/aerickson
-* Chad Boyd - "github":http://github.com/hoverlover
+* Andrew Erickson - "github":http://github.com/aerickson

data/bin/campfire-bot CHANGED

@@ -1,13 +1,59 @@
 #!/usr/bin/env ruby
-# Run this script with the environment as the only argument. eg. ./script/campfire-bot development
-BOT_ENVIRONMENT = ARGV.first
-BOT_ROOT        = '.'
+# Run this script with the environment as the only argument. eg. ./script/bot development
+# BOT_ENVIRONMENT = ARGV.first
+# BOT_ROOT        = File.join(File.dirname(__FILE__), '..')
 require 'rubygems'
-require 'bundler/setup'
+# require 'bundler/setup'
+require 'optparse'
 require 'bot'
+# require File.join(BOT_ROOT, 'lib', 'bot')
+options = {}
+begin
+  optparse = OptionParser.new do |opts|
+    opts.banner = "Usage: campfire-bot [options]"
+    opts.on("-cCONFIG_FILE", "--config CONFIG_FILE", "path to your config file") do |config|
+      options[:config_file] = config
+    end
+    opts.on("-eENVIRONMENT", "--environment ENVIRONMENT", "the environment name as specified in the config file") do |env|
+      options[:env] = env
+    end
+    opts.on( "-pPLUGIN_PATH", "--plugin_path PLUGIN_PATH",
+             "path to your plugins folder" ) do |pp|
+      options[:plugin_path] = pp
+    end
+    opts.on_tail("-h", "--help", "prints this help text") do
+      p opts
+      exit
+    end
+  end
+  optparse.parse!
+  mandatory = [:config_file, :env, :plugin_path]
+  missing = mandatory.select{ |param| options[param].nil? }
+  if not missing.empty?
+    puts "Missing options: #{missing.join(', ')}"
+    puts optparse
+    exit
+  end
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+  puts $!.to_s
+  puts optparse
+  exit
+end
+bot.create(options[:config_file], options[:env], options[:plugin_path])
-bot = CampfireBot::Bot.instance
 bot.connect
-bot.run
+bot.run

data/campfire-bot.gemspec CHANGED

@@ -5,8 +5,8 @@ require "version"
 Gem::Specification.new do |s|
   s.name        = "campfire-bot"
   s.version     = CampfireBot::VERSION
-  s.authors     = ["Josh Wand", "Chad Boyd"]
-  s.email       = ["", "hoverlover@gmail.com"]
+  s.authors     = ["Josh Wand", "Tim Riley"]
+  s.email       = ["josh@joshwand.com"]
   s.homepage    = "https://github.com/joshwand/campfire-bot"
   s.summary     = %q{This is a bot for 37 Signals’ Campfire chat service.}
   s.description = s.summary
@@ -14,14 +14,11 @@ Gem::Specification.new do |s|
   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", "plugins"]
+  s.require_paths = ["lib"]
   s.add_dependency 'twitter-stream', '~> 0.1'
   s.add_dependency 'tinder', '>= 1.4.3'
-  s.add_dependency 'hpricot', '~> 0.8.3'
-  s.add_dependency 'mime-types', '~> 1.16'
-  s.add_dependency 'activesupport', '~> 3.1.3'
+  s.add_dependency 'activesupport', '~> 3.0.3'
   s.add_dependency 'logging', '~> 1.4.3'
-  s.add_dependency 'eventmachine', '~> 0.12.10'
   s.add_dependency 'i18n', '~> 0.5.0'
 end

data/config.example.yml CHANGED

@@ -1,10 +1,9 @@
 development:
   site: campfire_subdomain_name
   use_ssl: true
-  log_dir: var
   rooms:
   - Main room
-  - <%= "Other room" %> # ERB interpolation
+  - Other room
   api_key: your_api_key
   nickname: Bot
   fullname: Bot Name
@@ -29,3 +28,5 @@ production:
     - basecamp
   svn_urls:
     - http://your.svn/url/
+  svn_username: your_svn_username
+  svn_password: your_svn_password

data/lib/bot.rb CHANGED

@@ -7,43 +7,47 @@ require 'yaml'
 require 'eventmachine'
 require 'logging'
 require 'fileutils'
-require 'erb'
+# Local Libs
+require "message"
+require "event"
+require "plugin"
 require 'tinder'
 module CampfireBot
-  autoload :Plugin, 'plugin'
-  autoload :Event, 'event'
-  autoload :Message, 'message'
   class Bot
     # this is necessary so the room and campfire objects can be accessed by plugins.
     include Singleton
     # FIXME - these will be invalid if disconnected. handle this.
-    attr_reader :campfire, :rooms, :config, :log
-    def initialize
-      if BOT_ENVIRONMENT.nil?
-        puts "you must specify a BOT_ENVIRONMENT"
-        exit 1
-      end
-      @timeouts = 0
-      @config   = YAML::load(ERB.new(File.read("#{BOT_ROOT}/config.yml")).result)[BOT_ENVIRONMENT]
-      @rooms    = {}
+    attr_reader :campfire, :rooms, :config, :log, :environment_name
+    def create(config_file, environment_name, plugin_path)
+      @config   = YAML::load(File.read(config_file))[environment_name]
+      @plugin_path = plugin_path
+      @environment_name = environment_name
       @root_logger = Logging.logger["CampfireBot"]
       @log = Logging.logger[self]
-      log_dir = @config['log_dir']
-      Dir.mkdir(log_dir) unless Dir.exists? log_dir
       # TODO much of this should be configurable per environment
-      @root_logger.add_appenders Logging.appenders.rolling_file("#{log_dir}/#{BOT_ENVIRONMENT}.log",
+      @root_logger.add_appenders Logging.appenders.rolling_file("#{@environment_name}.log",
                             :layout => Logging.layouts.pattern(:pattern => "%d | %-6l | %-12c | %m\n"),
                             :age => 'daily',
                             :keep => 7)
       @root_logger.level = @config['log_level'] rescue :info
+      @timeouts = 0
+      @rooms    = {}
     end
+    # def initialize
+    # end
     def connect
       load_plugins unless !@config['enable_plugins']
       begin
@@ -60,8 +64,7 @@ module CampfireBot
     def run(interval = 5)
       catch(:stop_listening) do
         trap('INT') { throw :stop_listening }
-        trap('TERM') { throw :stop_listening }
         # since room#listen blocks, stick it in its own thread
         @rooms.each_pair do |room_name, room|
           Thread.new do
@@ -119,9 +122,6 @@ module CampfireBot
           end
         end
       end
-      # Leave the room so users won't be under the false impression that the bot is still running.
-      @rooms.each_value.map(&:leave)
     end
     private
@@ -143,7 +143,7 @@ module CampfireBot
     def load_plugins
       @config['enable_plugins'].each do |plugin_name|
-        require "campfire_bot/#{plugin_name}"
+        load "#{@plugin_path}/#{plugin_name}.rb"
       end
       # And instantiate them

data/lib/version.rb CHANGED

@@ -1,3 +1,3 @@
 module CampfireBot
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

metadata CHANGED

@@ -1,22 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: campfire-bot
 version: !ruby/object:Gem::Version
-  prerelease: false
+  hash: 23
+  prerelease:
   segments:
-  - 0
   - 1
   - 0
-  version: 0.1.0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors:
 - Josh Wand
-- Chad Boyd
+- Tim Riley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-12-08 00:00:00 -06:00
-default_executable:
+date: 2012-02-16 00:00:00 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter-stream
@@ -26,6 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
+        hash: 9
         segments:
         - 0
         - 1
@@ -40,6 +41,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
+        hash: 1
         segments:
         - 1
         - 4
@@ -48,98 +50,56 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency
-  name: hpricot
+  name: activesupport
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
+        hash: 1
         segments:
+        - 3
         - 0
-        - 8
         - 3
-        version: 0.8.3
+        version: 3.0.3
   type: :runtime
   version_requirements: *id003
-- !ruby/object:Gem::Dependency
-  name: mime-types
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        segments:
-        - 1
-        - 16
-        version: "1.16"
-  type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        segments:
-        - 3
-        - 1
-        - 3
-        version: 3.1.3
-  type: :runtime
-  version_requirements: *id005
 - !ruby/object:Gem::Dependency
   name: logging
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
+        hash: 1
         segments:
         - 1
         - 4
         - 3
         version: 1.4.3
   type: :runtime
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency
-  name: eventmachine
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        segments:
-        - 0
-        - 12
-        - 10
-        version: 0.12.10
-  type: :runtime
-  version_requirements: *id007
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency
   name: i18n
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
+        hash: 11
         segments:
         - 0
         - 5
         - 0
         version: 0.5.0
   type: :runtime
-  version_requirements: *id008
+  version_requirements: *id005
 description: "This is a bot for 37 Signals\xE2\x80\x99 Campfire chat service."
 email:
-- ""
-- hoverlover@gmail.com
+- josh@joshwand.com
 executables:
 - campfire-bot
 extensions: []
@@ -149,9 +109,7 @@ extra_rdoc_files: []
 files:
 - .autotest
 - .gitignore
-- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - README.textile
 - TODO
 - bin/campfire-bot
@@ -163,38 +121,6 @@ files:
 - lib/message.rb
 - lib/plugin.rb
 - lib/version.rb
-- plugins/accountability.rb
-- plugins/austin.rb
-- plugins/basecamp.rb
-- plugins/beer.rb
-- plugins/beijing_tally.rb
-- plugins/boop.rb
-- plugins/bruce.rb
-- plugins/bugzilla.rb
-- plugins/calvin.rb
-- plugins/chuck.rb
-- plugins/dilbert.rb
-- plugins/excuse.rb
-- plugins/fail.rb
-- plugins/figlet.rb
-- plugins/fun.rb
-- plugins/garfield.rb
-- plugins/generic_search.rb
-- plugins/help.rb
-- plugins/infobot.rb
-- plugins/insult.rb
-- plugins/jira.rb
-- plugins/lolcats.rb
-- plugins/our_quotes.rb
-- plugins/quote.rb
-- plugins/schneier.rb
-- plugins/seen.rb
-- plugins/signal_filter.rb
-- plugins/svn.rb
-- plugins/twitter_echo.rb
-- plugins/unfuddle.rb
-- plugins/weather.rb
-- plugins/xkcd.rb
 - spec/beer_spec.rb
 - spec/bugzilla_spec.rb
 - spec/command_spec.rb
@@ -263,7 +189,6 @@ files:
 - vendor/escape/rdoc/index.html
 - vendor/escape/rdoc/rdoc-style.css
 - vendor/escape/test/test-escape.rb
-has_rdoc: true
 homepage: https://github.com/joshwand/campfire-bot
 licenses: []
@@ -272,12 +197,12 @@ rdoc_options: []
 require_paths:
 - lib
-- plugins
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
+      hash: 3
       segments:
       - 0
       version: "0"
@@ -286,13 +211,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
+      hash: 3
       segments:
       - 0
       version: "0"
 requirements: []
 rubyforge_project:
-rubygems_version: 1.3.7
+rubygems_version: 1.8.16
 signing_key:
 specification_version: 3
 summary: "This is a bot for 37 Signals\xE2\x80\x99 Campfire chat service."