happy_fun_time_bot 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--debug

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+gem 'ruby-debug'
+gem 'xmpp4r'
+gem 'json'
+gem 'httparty'
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,46 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    columnize (0.3.2)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    httparty (0.7.7)
+      crack (= 0.1.8)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.1)
+    linecache (0.43)
+    rake (0.9.0)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    xmpp4r (0.5)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  httparty
+  jeweler (~> 1.6.0)
+  json
+  rcov
+  rspec (~> 2.3.0)
+  ruby-debug
+  xmpp4r
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Grant Ammons
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+<h1>Happy fun time bot</h1>
+
+Have happy fun times with this configurable XMPP bot!  It is SO easy to use!
+
+Lets take a look!
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'happy_fun_time_bot'
+
+@bot = HappyFunTimeBot.new(:jid => "xxxx@chat.hipchat.com", 
+                           :nick => "HappyFunTime Bot", 
+                           :room => "123_your_talk_chan@conf.hipchat.com", 
+                           :password => "xxxx")
+
+@bot.add_responder('heybot') do |from, args|
+  "Oh HAI #{from}!!!"
+end
+
+@bot.run!
+```
+
+```
+Bob: !heybot what's up?
+HappyFunTime Bot:  Oh HAI Bob!!!
+```
+
+### So many IdeazzZz!!
+
+**Add responders to insert random images of dogs in costumes!**
+
+```
+Bob: !findimage dog costume
+HappyFunTime Bot: Here ya go!
+```
+![](http://spoilurpets.com/images/Lobster%20Paws%20Dog%20Costume.JPG)
+
+
+**Kick off a build!**
+
+```
+Bob: !build_the_app
+HappyFunTime Bot: All tests PASSED!
+```
+
+![](http://thehairpin.com/wp-content/uploads/2010/12/womanpic1001_228x342.jpeg)
+
+**Deploy your app!**
+
+```
+Bob: !deploy
+HappyFunTime Bot: Deploying now!
+```
+
+=== Bot creation Options:
+
+* `:jid` - Required.
+* `:nick` - The nickname for the bot to use.
+* `:room` - Required.  The room to enter.
+* `:password` - The bot's password.
+* `:command_regex` - The regular expression to test for a command.  The default is a ! followed by a word.  e.g. `/^!(.+)$/`
+
+== Copyright
+
+Copyright (c) 2011 Grant Ammons. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "happy_fun_time_bot"
+  gem.homepage = "http://github.com/gammons/happy_fun_time_bot"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple XMPP bot framework}
+  gem.description = %Q{Easily create bots that can respond to anything!}
+  gem.email = "grant@pipelinedealsco.com"
+  gem.authors = ["Grant Ammons"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/bot/muc_client.rb

@@ -0,0 +1,65 @@
+# We want the MUC functionality to just handle shit for us.  Unfortunately we
+# have to override/repeat the join method in order to add the directive that
+# will disable the history being sent to us. :-(
+module Jabber
+  module MUC
+    class MUCClient
+      
+      def join(jid, password=nil)
+        if active?
+          raise "MUCClient already active"
+        end
+        
+        @jid = (jid.kind_of?(JID) ? jid : JID.new(jid))
+        activate
+        
+        # Joining
+        pres = Presence.new
+        pres.to = @jid
+        pres.from = @my_jid
+        xmuc = XMUC.new
+        xmuc.password = password
+        pres.add(xmuc)
+        
+        # NOTE: Adding 'maxstanzas="0"' to 'history' subelement of xmuc nixes
+        # the history being sent to us when we join.
+        history = XMPPElement.new('history')
+        history.add_attributes({'maxstanzas' => '0'})
+        xmuc.add(history)
+        
+        # We don't use Stream#send_with_id here as it's unknown
+        # if the MUC component *always* uses our stanza id.
+        error = nil
+        @stream.send(pres) { |r|
+          if from_room?(r.from) and r.kind_of?(Presence) and r.type == :error
+            # Error from room
+            error = r.error
+            true
+            # type='unavailable' may occur when the MUC kills our previous instance,
+            # but all join-failures should be type='error'
+          elsif r.from == jid and r.kind_of?(Presence) and r.type != :unavailable
+            # Our own presence reflected back - success
+            if r.x(XMUCUser) and (i = r.x(XMUCUser).items.first)
+              @affiliation = i.affiliation  # we're interested in if it's :owner
+              @role = i.role                # :moderator ?
+            end
+            
+            handle_presence(r, false)
+            true
+          else
+            # Everything else
+            false
+          end
+        }
+        
+        if error
+          deactivate
+          raise ServerError.new(error)
+        end
+        
+        self
+      end
+      
+    end
+  end
+end

data/lib/happy_fun_time_bot.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'xmpp4r'
+require 'xmpp4r/muc/helper/simplemucclient'
+require 'open-uri'
+require 'cgi'
+require 'httparty'
+require 'ruby-debug'
+
+$: << File.expand_path(File.dirname(__FILE__))
+
+require 'responder'
+require 'bot/muc_client'
+
+class HappyFunTimeBot
+  attr_accessor :config, :client, :muc, :responders, :command_regexp
+
+  def initialize(config = {})
+    config = {:command_regex => /^!(.+)$/}.merge(config)
+    self.client = Jabber::Client.new(config[:jid])
+    self.muc    = Jabber::MUC::SimpleMUCClient.new(client)
+    self.command_regexp = /^!(.+)$/
+    self.responders = []
+    self.config = config
+
+    Jabber.debug = true if Jabber.logger = config[:debug]
+    self
+  end
+
+  def connect
+    client.connect
+    client.auth(self.config[:password])
+    client.send(Jabber::Presence.new.set_type(:available))
+
+    salutation = config[:nick].split(/\s+/).first
+
+    muc.on_message { |time, nick, text| process(nick, text) }
+
+    muc.join(self.config[:room] + '/' + self.config[:nick])
+    self
+  end
+
+  def add_responder(command  = '', &block)
+    responders << Responder.new(command, &block)
+  end
+
+  def run!
+    connect
+    loop { sleep 1 }
+  end
+
+  private
+
+  def process(from, command)
+    return [] unless command =~ self.config[:command_regex]
+    responders.select {|r| r.responds_to?($1) }.map  do |responder|
+      ret = responder.block.call(from, command.split.shift)
+      send_response(ret)
+      ret
+    end
+  end
+
+  def send_response(msg)
+    muc.send Jabber::Message.new(muc.room, msg)
+  end
+end

data/lib/responder.rb

@@ -0,0 +1,12 @@
+class Responder
+  attr_accessor :command, :block
+
+  def initialize(command, &block)
+    @command = command
+    @block = block
+  end
+
+  def responds_to?(command)
+    @command == command.split.first
+  end
+end

data/spec/happy_fun_time_bot_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'ruby-debug'
+
+describe "HappyFunTimeBot" do
+  it "should load everything properly" do
+    HappyFunTimeBot
+    lambda { HappyFunTimeBot.new }.should_not raise_error
+  end
+
+  describe "commands" do
+    it "should have a configurable command regex" do
+      @bot = HappyFunTimeBot.new(:command_regex => /^#(.+)$/)
+      @bot.stub(:send_response)
+      @bot.add_responder("findimage") { |from, args| "finding an image" }
+      @bot.send(:process, "bob", "#findimage monkey").should == ["finding an image"]
+      @bot.send(:process, "bob", "!findimage monkey").should == []
+    end
+  end
+
+  describe "responding" do
+    before(:each) do
+      @bot = HappyFunTimeBot.new
+      @bot.stub(:send_response)
+    end
+
+    it "should respond if there is a responder" do
+      @bot.add_responder("findimage") { |from, args| "finding an image" }
+      @bot.send(:process, "bob", "!findimage monkey").should == ["finding an image"]
+    end
+
+    it "should have multiple responses" do
+      @bot.add_responder("findimage") { |from, args| "finding an image" }
+      @bot.add_responder("google") { |from, args| "googling for you, #{from}." }
+
+      @bot.send(:process, "bob", "!findimage monkey").should == ["finding an image"]
+      @bot.send(:process, "bob", "!google monkey").should == ["googling for you, bob."]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'happy_fun_time_bot'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification 
+name: happy_fun_time_bot
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Grant Ammons
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-10 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: ruby-debug
+  type: :runtime
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: xmpp4r
+  type: :runtime
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: json
+  type: :runtime
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: httparty
+  type: :runtime
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rspec
+  type: :development
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: yard
+  type: :development
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  type: :development
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  type: :development
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  type: :development
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id009
+description: Easily create bots that can respond to anything!
+email: grant@pipelinedealsco.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/bot/muc_client.rb
+- lib/happy_fun_time_bot.rb
+- lib/responder.rb
+- spec/happy_fun_time_bot_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/gammons/happy_fun_time_bot
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Simple XMPP bot framework
+test_files: []
+