hipchat_bot 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

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,74 @@
+# HipchatBot
+
+Simple and configurable bot for Hipchat! 
+
+Obviously adapted from https://github.com/gammons/happy_fun_time_bot, but revised with a new shorter name and
+to work on Ruby 1.9.3 since the original is broken. 
+
+100% of the credit to https://github.com/gammons/happy_fun_time_bot
+and [gammons](https://github.com/gammons) for this gem. I just made it work on 1.9.3
+
+Lets take a look!
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'hipchat_bot'
+
+@bot = HipchatBot.new(:jid => "xxxx@chat.hipchat.com", 
+                           :nick => "Hipchat 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?
+HipChat Bot:  Oh HAI Bob!!!
+```
+
+### So many IdeazzZz!!
+
+**Add responders to insert random images of dogs in costumes!**
+
+```
+Bob: !findimage dog costume
+HipChat Bot: Here ya go!
+```
+![](http://spoilurpets.com/images/Lobster%20Paws%20Dog%20Costume.JPG)
+
+
+**Kick off a build!**
+
+```
+Bob: !build_the_app
+HipChat Bot: All tests PASSED!
+```
+
+![](http://thehairpin.com/wp-content/uploads/2010/12/womanpic1001_228x342.jpeg)
+
+**Deploy your app!**
+
+```
+Bob: !deploy
+HipChat 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) 2012 Nathan Esquenazi. See LICENSE.txt for further details.
+Copyright (c) 2011 Grant Ammons. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/examples/example.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'hipchat_bot'
+
+# For hipchat, your :jid, :room and :password are available at https://www.hipchat.com/account/xmpp
+@bot = HipchatBot.new(:jid => "xxxxx@chat.hipchat.com", :nick => "ImageBot", :room => "your_room@conf.hipchat.com", :password => "xxx")
+
+# calling !heybot will return a simple response.
+@bot.add_responder('heybot') do |from, args|
+  "Hai, #{from}!!"
+end
+
+# endless loop.  Use bluepill or something else to daemonize it.
+@bot.run!

data/examples/find_image.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+%w(rubygems hipchat_bot httparty).each {|r| require r }
+
+# For hipchat, your :jid, :room and :password are available at https://www.hipchat.com/account/xmpp
+@bot = HipchatBot.new(:jid => "xxxxx@chat.hipchat.com", :nick => "ImageBot", :room => "your_room@conf.hipchat.com", :password => "xxx")
+
+# Let's create a simple image getter from google.
+class Google
+  include HTTParty
+  format :json
+
+  def self.get_image_url(search, options = {:start => 0})
+    if options[:random]
+      options[:start] = rand(12)
+    end
+
+    res = Google.get("https://ajax.googleapis.com/ajax/services/search/images?v=1.0&safe=active&start=#{options[:start]}&rsz=8&q=#{URI.escape(search)}")
+    res["responseData"]["results"][0]["url"]
+  end
+
+  def self.get_youtube_url(search)
+    res = Google.get("http://gdata.youtube.com/feeds/api/videos?q=#{URI.escape(args)}&alt=json")
+    res["feed"]["entry"][0]["link"][0]['href']
+  end
+end
+
+
+# let's find some images!
+@bot.add_responder('findimage') do |from, args|
+  url = Google.get_image_url(args)
+  "Look! #{url}"
+end
+
+@bot.run!

data/hipchat_bot.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hipchat_bot/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nathan Esquenazi"]
+  gem.email         = ["nesquena@gmail.com"]
+  gem.description   = %q{Easily create hipchat bots that can respond to anything!}
+  gem.summary       = %q{Simple XMPP bot framework}
+  gem.homepage      = %q{http://github.com/bazaarlabs/hipchat_bot}
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "hipchat_bot"
+  gem.require_paths = ["lib"]
+  gem.version       = HipchatBot::VERSION
+
+  gem.add_runtime_dependency('xmpp4r', ">= 0")
+  gem.add_runtime_dependency('json', ">= 0")
+  gem.add_runtime_dependency('httparty', ">= 0")
+  gem.add_development_dependency('rspec', "~> 2")
+  gem.add_development_dependency('yard', "~> 0.6.0")
+  gem.add_development_dependency('bundler', "~> 1")
+end

data/lib/hipchat_bot.rb

@@ -0,0 +1,67 @@
+require "hipchat_bot/version"
+require 'rubygems'
+require 'xmpp4r'
+require 'xmpp4r/muc/helper/simplemucclient'
+require 'open-uri'
+require 'cgi'
+
+$: << File.expand_path(File.dirname(__FILE__))
+
+require 'responder'
+require 'hipchat_bot/muc_client'
+
+class HipchatBot
+  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  = nil, &block)
+    responders << Responder.new(command, &block)
+  end
+
+  def run!
+    connect
+    loop { sleep 1 }
+  end
+
+  private
+
+  def process(from, command)
+    return [] if !responders.any? {|r| r.command.nil? } and !(command =~ self.config[:command_regex])
+
+    responders.select {|r| r.responds_to?($1) }.map  do |responder|
+      args = command.split
+      args.shift
+      ret = responder.block.call(from, args.join(' '))
+      send_response(ret)
+      ret
+    end
+  end
+
+  def send_response(msg)
+    muc.send Jabber::Message.new(muc.room, msg)
+  end
+end

data/lib/hipchat_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/hipchat_bot/version.rb

@@ -0,0 +1,3 @@
+class HipchatBot
+  VERSION = "0.1.0"
+end

data/lib/responder.rb

@@ -0,0 +1,17 @@
+class Responder
+  attr_accessor :command, :block
+
+  def initialize(command, &block)
+    @command = command
+    @block = block
+  end
+
+  def responds_to?(command)
+    # respond to all if our command is nil.
+    return true if @command.nil?
+
+    # otherwise parse out the command and make sure it matches
+    # our command.
+    @command == command.split.first
+  end
+end

data/spec/hip_chat_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "HipchatBot" do
+  it "should load everything properly" do
+    HipchatBot
+    lambda { HipchatBot.new }.should_not raise_error
+  end
+
+  describe "commands" do
+    it "should have a configurable command regex" do
+      @bot = HipchatBot.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 = HipchatBot.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
+
+    it "should contain the args in the args arg" do
+      @bot.add_responder("argarg") { |from, args| "your args are #{args}" }
+      @bot.send(:process, "bob", "!argarg monkey costume").should == ["your args are monkey costume"]
+    end
+
+    it "should respond to all messages if we did not specify a specific responder" do
+      @bot.add_responder { |from, args| "got it." }
+      @bot.send(:process, "jim", "sending some stuff").should == ["got it."]
+    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 'hipchat_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,158 @@
+--- !ruby/object:Gem::Specification
+name: hipchat_bot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Nathan Esquenazi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xmpp4r
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Easily create hipchat bots that can respond to anything!
+email:
+- nesquena@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- examples/example.rb
+- examples/find_image.rb
+- hipchat_bot.gemspec
+- lib/hipchat_bot.rb
+- lib/hipchat_bot/muc_client.rb
+- lib/hipchat_bot/version.rb
+- lib/responder.rb
+- spec/hip_chat_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/bazaarlabs/hipchat_bot
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple XMPP bot framework
+test_files:
+- spec/hip_chat_spec.rb
+- spec/spec_helper.rb