twke 0.0.1 → 0.1.0

data/README.md

@@ -0,0 +1,47 @@
+# twke
+
+twke (pronounced *twee-kee*) is an extensible Campfire bot inspired by
+Hubot and created by the [Librato team](http://librato.com) 
+with the [Scamp framework](https://github.com/wjessop/Scamp).
+His primary mission is to assist in the day-to-day DevOps activities of
+a team building and operating a *SaaS* platform.
+
+## Contributing to twke
+twke's plugin system is modeled after
+[Github-Services](https://github.com/github/github-services) and
+creating a new plugin is extremely straightforward:
+
+1. Fork the project
+1. Start a feature branch
+1. Create a new file in `/plugins` called `plugin_name.rb`, using the
+following template:
+
+    ```ruby
+    class Plugin::PluginName < Plugin
+      def add_routes(rp)
+        rp.route 'foo' do
+          say 'bar'
+        end
+        
+        rp.route 'hello' do
+          say "Hello World!"
+        end
+      end
+    end
+    ```
+1. Commit and push until you are happy with your contribution
+1. Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+1. Submit a pull request from your fork to josephruscio/twke
+
+## Colophon
+
+twke is named after the [ambuquad designated
+TWKE-4](https://secure.wikimedia.org/wikipedia/en/wiki/Twiki) who
+faithfully accompanied Buck Rogers in the 25th Century. His
+voice has been described as a cross between Yosemite Sam and Porky Pig,
+and he usually prefixed any speech with a low-pitched "bidi-bidi-bidi".
+
+### Copyright
+
+Copyright (c) 2011 Joseph Ruscio. See LICENSE.txt for
+further details.

data/Rakefile

@@ -20,7 +20,7 @@ Jeweler::Tasks.new do |gem|
   gem.summary = %Q{Bidi-Bidi-Bidi!}
   gem.description = %Q{The ambuquad that has your back.}
   gem.email = "joe@ruscio.org"
-  gem.authors = ["Joseph Ruscio"]
+  gem.authors = ["Joseph Ruscio", "Mike Heffner"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/bin/twke

@@ -11,19 +11,54 @@ require 'twke'
 require 'optparse'
 
 # Define the options and their default values
-$options = {}
+$options = {
+  :api_key => ENV['TWKE_API_KEY'],
+  :subdomain =>  ENV['TWKE_SUBDOMAIN'],
+  :name => "twke",
+  :rooms => ENV['TWKE_ROOMS'],
+  :verbose => false
+}
 
 optparse = OptionParser.new do|opts|
-	opts.banner = "Usage: #{File.basename(__FILE__)} <options>\n"
+  opts.banner = "Usage: #{File.basename(__FILE__)} <options>\n"
 
-	# help
-	opts.on( '-h', '--help', 'Display this screen' ) do
-		puts opts
-		exit
-	end
+  opts.on( '-k', '--api-key k', "Campfire API Key") do |k|
+    $options[:api_key] = k
+  end
+
+  opts.on( '-s', '--subdomain s', "Campfire Subdomain") do |s|
+    $options[:subdomain] = s
+  end
+
+  opts.on( '-n', '--name n', "Name that twke responds to (defaults to 'twke')") do |n|
+    $options[:name] = n
+  end
+
+  #TODO: support more than one room
+  opts.on( '-r', '--rooms r', "Room IDs for twke to join") do |r|
+    $options[:rooms] = r
+  end
+
+  opts.on( '-V', '--verbose', "Operate in verbose fashion") do
+    $options[:verbose] = true
+  end
+
+  # help
+  opts.on( '-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
 end
 
 # Parse the options
 optparse.parse!
 
-puts "bidi-bidi-bidi!"
+# Add :verbose => true to get debug output, otherwise the logger will output INFO
+scamp = Scamp.new(:api_key => $options[:api_key],
+                  :subdomain => $options[:subdomain],
+                  :verbose => $options[:verbose])
+
+Twke::Routes.load(scamp)
+
+#TODO: support more than one room
+scamp.connect!([$options[:rooms].to_i])

data/lib/twke.rb

@@ -1,3 +1,22 @@
 module Twke
+  require 'scamp'
+
+  require 'twke/routes.rb'
   require 'twke/plugin.rb'
+
+  def self.version
+    File.read(File.join(File.dirname(__FILE__), '../VERSION')).chomp
+  end
+
+  def self.plugin(plgn)
+    puts "Registering plugin #{plgn.plugin_name}"
+  end
+
+  def self.shutdown
+    exit 0
+  end
 end
+
+Dir["#{File.dirname(__FILE__)}/../plugins/**/*.rb"].each { |plugin|
+  load plugin
+}

data/lib/twke/plugin.rb

@@ -1,2 +1,41 @@
 class Plugin
+  class << self
+
+    # Returns a short name for the plugin
+    #
+    def plugin_name
+      @plugin_name ||= begin
+        str = name.dup
+        str.downcase!
+        str.sub! /.*:/, ''
+        str
+      end
+    end
+
+    # Track all the available plugins
+    #
+    def plugins
+      @plugins ||= []
+    end
+
+    # Invoked when adding routes. Pass in params here. Could expand
+    # this to receive a number of events.
+    #
+    def routes(rp)
+      plgin = new()
+
+      if plgin.respond_to?(:add_routes)
+        plgin.add_routes(rp)
+      end
+    end
+
+    # Registers the current plugin with the system.
+    #
+    # Returns nothing.
+    def inherited(plgn)
+      Plugin.plugins << plgn
+      Twke.plugin(plgn)
+      super
+    end
+  end
 end

data/lib/twke/routes.rb

@@ -0,0 +1,42 @@
+module Twke
+  module Routes
+    class RoutePrefix
+      def initialize(str = nil)
+        @levels = []
+        @levels.push(str) if str
+      end
+
+      def route(str, *opts, &blk)
+        @levels.push(str)
+        Routes.add(@levels.join(" "), *opts, &blk)
+        @levels.pop
+      end
+
+      def method_missing(name, &blk)
+        @levels.push(name)
+        yield
+        @levels.pop
+      end
+    end
+
+    class << self
+      attr_accessor :conn
+
+      def load(scamp)
+        @@conn = scamp
+
+        # TODO: Only load the configured plugins
+        Plugin.plugins.each do |plgin|
+          # TODO: always prefix with 'twke', configurable later?
+          plgin.routes(RoutePrefix.new('twke'))
+        end
+      end
+
+      def add(str, *opts, &blk)
+        @@conn.behaviour do
+          match(str, *opts, &blk)
+        end
+      end
+    end
+  end
+end

data/plugins/admin.rb

@@ -0,0 +1,13 @@
+class Plugin::Admin < Plugin
+  # Invoked to define routes.
+  def add_routes(rp)
+    rp.admin do
+      rp.route 'respawn' do
+        say "Initiating respawn"
+        EM::Timer.new(2) do
+          Twke::shutdown
+        end
+      end
+    end
+  end
+end

data/plugins/twiki.rb

@@ -0,0 +1,14 @@
+# Fun with twke
+#
+class Plugin::Twiki < Plugin
+  # Invoked to define routes.
+  def add_routes(rp)
+    rp.route 'bidi' do
+      say 'bidi-bidi-bidi!'
+    end
+
+    rp.route 'version' do
+      say "Twke version: #{Twke.version}"
+    end
+  end
+end

data/twke.gemspec

@@ -5,30 +5,33 @@
 
 Gem::Specification.new do |s|
   s.name = %q{twke}
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Joseph Ruscio"]
-  s.date = %q{2011-09-24}
+  s.authors = ["Joseph Ruscio", "Mike Heffner"]
+  s.date = %q{2011-09-27}
   s.default_executable = %q{twke}
   s.description = %q{The ambuquad that has your back.}
   s.email = %q{joe@ruscio.org}
   s.executables = ["twke"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "bin/twke",
     "lib/twke.rb",
     "lib/twke/plugin.rb",
+    "lib/twke/routes.rb",
+    "plugins/admin.rb",
+    "plugins/twiki.rb",
     "test/helper.rb",
     "test/test_twke.rb",
     "twke.gemspec"

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: twke
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
 - Joseph Ruscio
+- Mike Heffner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-24 00:00:00.000000000 -07:00
+date: 2011-09-27 00:00:00.000000000 -07:00
 default_executable: twke
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scamp
-  requirement: &2161492380 !ruby/object:Gem::Requirement
+  requirement: &2153515900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +23,10 @@ dependencies:
         version: 0.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *2161492380
+  version_requirements: *2153515900
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2161491620 !ruby/object:Gem::Requirement
+  requirement: &2153515080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +34,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161491620
+  version_requirements: *2153515080
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2161490840 !ruby/object:Gem::Requirement
+  requirement: &2153514320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +45,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2161490840
+  version_requirements: *2153514320
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2161489500 !ruby/object:Gem::Requirement
+  requirement: &2153513580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +56,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2161489500
+  version_requirements: *2153513580
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2161477440 !ruby/object:Gem::Requirement
+  requirement: &2153512780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,7 +67,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161477440
+  version_requirements: *2153512780
 description: The ambuquad that has your back.
 email: joe@ruscio.org
 executables:
@@ -74,18 +75,21 @@ executables:
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - bin/twke
 - lib/twke.rb
 - lib/twke/plugin.rb
+- lib/twke/routes.rb
+- plugins/admin.rb
+- plugins/twiki.rb
 - test/helper.rb
 - test/test_twke.rb
 - twke.gemspec
@@ -105,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4543077646895532291
+      hash: -3484703329107985583
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/README.rdoc

@@ -1,19 +0,0 @@
-= twke
-
-Description goes here.
-
-== Contributing to twke
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Joseph Ruscio. See LICENSE.txt for
-further details.
-