hipbot 0.1.0 → 0.2.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
+  - 2.0.0
 notifications:
   email:
     recipients:

data/Gemfile

@@ -5,9 +5,10 @@ gem 'eventmachine'
 gem 'em-http-request'
 gem 'xmpp4r'
 gem 'httparty'
-gem 'active_support'
+gem 'activesupport'
 gem 'i18n'
 gem 'daemons'
 
 gem 'rspec'
+gem 'guard-rspec'
 gem 'mocha'

data/Gemfile.lock

@@ -1,51 +1,72 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    active_support (3.0.0)
-      activesupport (= 3.0.0)
-    activesupport (3.0.0)
-    addressable (2.3.2)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.3.3)
+    coderay (1.0.9)
     cookiejar (0.3.0)
-    daemons (1.1.8)
-    diff-lcs (1.1.3)
-    em-http-request (1.0.2)
+    daemons (1.1.9)
+    diff-lcs (1.2.2)
+    em-http-request (1.0.3)
       addressable (>= 2.2.3)
       cookiejar
       em-socksify
       eventmachine (>= 1.0.0.beta.4)
       http_parser.rb (>= 0.5.3)
-    em-socksify (0.2.0)
+    em-socksify (0.2.1)
       eventmachine (>= 1.0.0.beta.4)
-    eventmachine (1.0.0.rc.4)
+    eventmachine (1.0.3)
+    formatador (0.2.4)
+    guard (1.7.0)
+      formatador (>= 0.2.4)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (2.5.2)
+      guard (>= 1.1)
+      rspec (~> 2.11)
     http_parser.rb (0.5.3)
-    httparty (0.8.3)
+    httparty (0.10.2)
       multi_json (~> 1.0)
-      multi_xml
-    i18n (0.6.0)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.4)
+    listen (0.7.3)
+    lumberjack (1.0.3)
     metaclass (0.0.1)
-    mocha (0.12.1)
+    method_source (0.8.1)
+    mocha (0.13.3)
       metaclass (~> 0.0.1)
-    multi_json (1.3.6)
-    multi_xml (0.5.1)
-    rake (0.9.2.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.2)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.1)
+    multi_json (1.7.2)
+    multi_xml (0.5.3)
+    pry (0.9.12)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    slop (3.4.4)
+    thor (0.18.1)
     xmpp4r (0.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  active_support
+  activesupport
   daemons
   em-http-request
   eventmachine
+  guard-rspec
   httparty
   i18n
   mocha

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://secure.travis-ci.org/pewniak747/hipbot.png?branch=master)](http://travis-ci.org/pewniak747/hipbot)
 [![Code Climate](https://codeclimate.com/github/pewniak747/hipbot.png)](https://codeclimate.com/github/pewniak747/hipbot)
 
-Hipbot is a bot for HipChat, written in ruby & eventmachine.
+Hipbot is a XMPP bot for HipChat, written in ruby & eventmachine.
 
 ## Usage
 
@@ -15,21 +15,44 @@ gem install hipbot
 
 ### Customize
 
-In bot.rb file, subclass Hipbot::Bot and customize robot responses.
+Create `bot.rb` file, subclass `Hipbot::Bot` and customize the responses.
 
 ``` ruby
 require 'hipbot'
 
 class MyCompanyBot < Hipbot::Bot
   configure do |c|
-    c.name = 'robot'
-    c.jid = 'changeme@chat.hipchat.com'
-    c.password = 'secret'
+    c.name      = 'robot' # required
+    c.jid       = 'changeme@chat.hipchat.com' # required
+    c.password  = 'secret' # required
+    c.teams     = { vip: ['John', 'Mike'] }
+    c.rooms     = { project_rooms: ['Project 1', 'Project 2'] }
+    c.plugins   = [ PluginClass ]
   end
 
-  on /^hello.*/ do
+  on /^hello/ do
     reply('hello!')
   end
+
+  on /^restart/, from: :vip do
+    # ...
+    reply('restarting...')
+  end
+
+  on /^deploy/, room: :project_rooms do
+    # ...
+    reply('deploying...')
+  end
+
+  default do
+    reply('I don\'t understand you!')
+  end
+end
+
+class PluginClass < Hipbot::Plugin
+  on /^plugin/ do
+    reply('this is from plugin!')
+  end
 end
 
 MyCompanyBot.start!
@@ -38,7 +61,7 @@ MyCompanyBot.start!
 You can create a response by providing simple regexp:
 
 ``` ruby
-on /^hello.*/ do
+on /^hello/ do
   reply('hello!')
 end
 ```
@@ -59,10 +82,15 @@ on /my name is (.*)/, /I am (.*)/ do |name|
 end
 ```
 
-Use :from to only match messages from certain users
+Use :from to only match messages from certain users or user groups defined in configuration
 
 ``` ruby
-on /status report/, :from => ['tom', 'dave'] do
+configure do |c|
+  # ...
+  c.teams = { vip: ['John', 'Mike'] }
+end
+
+on /status report/, from: ['Tom', 'Dave', :vip] do
   reply('all clear')
 end
 ```
@@ -70,7 +98,12 @@ end
 Use :room to only match messages in certain hipchat rooms
 
 ``` ruby
-on /hello/, :room => ['public'] do
+configure do |c|
+  # ...
+  c.rooms = { project_rooms: ['Project 1', 'Project 2'] }
+end
+
+on /hello/, room: ['Public Room', :project_rooms] do
   reply('hello!')
 end
 ```
@@ -78,7 +111,7 @@ end
 Use :global to react to messages that are not sent directly to @robot
 
 ``` ruby
-on /hey I just met you/, :global => true do
+on /hey I just met you/, global: true do
   reply('and this is crazy...')
 end
 ```
@@ -103,7 +136,7 @@ end
 
 ``` ruby
 on /ping site/ do
-  get 'http://example.com', :ping => "1" # issues http://example.com?ping=1
+  get 'http://example.com', ping: "1" # issues http://example.com?ping=1
 end
 ```
 
@@ -125,8 +158,8 @@ end
 
 class Bot < Hipbot::Bot
   configure do |c|
+    # ...
     c.helpers = HipbotHelpers
-    # rest of configuration
   end
 
   on /what's the project called\?/ do
@@ -135,6 +168,42 @@ class Bot < Hipbot::Bot
 end
 ```
 
+#### Plugins
+
+To define a plugin, subclass `Hipbot::Plugin` and add responses like in bot:
+
+``` ruby
+class GreeterPlugin < Hipbot::Plugin
+  on /^hello/ do
+    reply('hello there!')
+  end
+end
+```
+
+You can gain access to plugin data inside reaction with `plugin` helper:
+
+``` ruby
+class GreeterPlugin < Hipbot::Plugin
+  attr_accessor :language
+  def initialize(language)
+    self.language = language
+  end
+
+  on /^hello/ do
+    case plugin.language
+    when :en
+      reply("hello!")
+    when :pl
+      reply("cześć!")
+    when :jp
+      reply("おはよう！")
+    end
+  end
+end
+```
+
+For a collection of open-source plugins, see https://github.com/netguru/hipbot-plugins
+
 ### Run
 
 Run hipbot as daemon by saying:
@@ -162,11 +231,10 @@ heroku ps:scale worker=1
 
 ## TODO:
 
-* add plugins support
-* add extended logging
-
 ### Done:
 
+* ~~add extended logging~~
+* ~~add plugins support~~
 * ~~rewrite SimpleMUCClient~~
 * ~~handle private messages callbacks~~
 * ~~handle auto joining on room invite~~
@@ -176,4 +244,4 @@ heroku ps:scale worker=1
   * ~~allow injecting custom module to response object, adding arbitrary methods~~
 * ~~handle reconnecting after disconnect/failure~~
 * ~~add support for multiple regexps for one response~~
-* ~~add support for responses in particular room (`on //, :room => ['public'] do ...`)~~
+* ~~add support for responses in particular room (`on //, room: ['public'] do ...`)~~

data/hipbot.gemspec

@@ -15,11 +15,12 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Hipbot::VERSION
   gem.add_runtime_dependency "daemons", ["~> 1.1.8"]
-  gem.add_runtime_dependency "active_support", ["~> 3.0.0"]
+  gem.add_runtime_dependency "activesupport", ["~> 3.2.12"]
   gem.add_runtime_dependency "i18n", ["~> 0.6.0"]
-  gem.add_runtime_dependency "eventmachine", ["~> 0.12.10"]
-  gem.add_runtime_dependency "em-http-request", ["~> 0.3.0"]
+  gem.add_runtime_dependency "eventmachine", ["~> 1.0.3"]
+  gem.add_runtime_dependency "em-http-request", ["~> 1.0.3"]
   gem.add_runtime_dependency "xmpp4r", ["~> 0.5"]
-  gem.add_development_dependency "rspec", ['~> 2.11.0']
-  gem.add_development_dependency "mocha", ['~> 0.11.4']
+  gem.add_development_dependency "rspec", ['~> 2.13.0']
+  gem.add_development_dependency "guard-rspec", ['~> 2.5.1']
+  gem.add_development_dependency "mocha", ['~> 0.13.3']
 end

data/lib/hipbot.rb

@@ -8,14 +8,17 @@ require 'xmpp4r/muc'
 require 'hipbot/patches/hipchat_client'
 require 'hipbot/patches/encoding'
 
+require 'hipbot/logger'
 require 'hipbot/adapters/hipchat/hipchat'
 require 'hipbot/adapters/hipchat/connection'
 require 'hipbot/adapters/telnet/telnet'
 require 'hipbot/adapters/telnet/connection'
+require 'hipbot/reactable'
 require 'hipbot/bot'
+require 'hipbot/plugin'
 require 'hipbot/configuration'
 require 'hipbot/collection'
-require 'hipbot/http_response'
+require 'hipbot/helpers'
 require 'hipbot/message'
 require 'hipbot/reaction'
 require 'hipbot/response'

data/lib/hipbot/adapters/hipchat/connection.rb

@@ -6,8 +6,7 @@ module Hipbot
           @bot = bot
           @bot.connection = self
 
-          return unless setup_bot
-          setup_timers
+          setup_error_handler && setup_bot && setup_timers
         end
 
         def restart!
@@ -34,23 +33,21 @@ module Hipbot
         private
 
         def setup_bot
-          return unless initialize_client
-          initialize_rooms
-          initialize_users
-          initialize_callbacks
-          join_rooms
-          set_presence('Hello humans!')
-          true
+          initialize_client do
+            initialize_rooms
+            initialize_users
+            initialize_callbacks
+            join_rooms
+            set_presence('Hello humans!')
+          end
         end
 
         def initialize_client
-          ::Jabber.debug = true
           @client = ::Jabber::MUC::HipchatClient.new(@bot.jid + '/' + @bot.name)
-          @client.connect(@bot.password)
+          yield if @client.connect(@bot.password)
         end
 
         def initialize_rooms
-          Room.bot = @bot
           @client.get_rooms.each do |r|
             Room.create(r[:item].jid, r[:item].iname, topic: r[:details]['topic'])
           end
@@ -58,13 +55,12 @@ module Hipbot
         end
 
         def initialize_users
-          User.bot = @bot
           @client.get_users.each do |v|
             params = {
-              email:   v[:vcard]['EMAIL/USERID'],
+                email: v[:vcard]['EMAIL/USERID'],
               mention: v[:item].attributes['mention_name'],
-              title:   v[:vcard]['TITLE'],
-              photo:   v[:vcard]['PHOTO'],
+                title: v[:vcard]['TITLE'],
+                photo: v[:vcard]['PHOTO'],
             }
             User.create(v[:item].jid, v[:item].iname, params)
           end
@@ -72,84 +68,93 @@ module Hipbot
         end
 
         def join_rooms
-          if Room.empty?
-            Jabber::debuglog "No rooms to join"
-            return false
-          end
-          Room.each do |room_jid, _|
-            @client.join(room_jid)
+          with_rooms do |rooms|
+            rooms.each do |r|
+              @client.join(r.id)
+            end
           end
-          true
         end
 
         def exit_all_rooms
-          Room.each do |room_jid, _|
-            @client.exit(room_jid, 'bye bye!')
+          with_rooms do |rooms|
+            rooms.each do |r|
+              @client.exit(r.id, 'bye bye!')
+            end
           end
         end
 
         def initialize_callbacks
-          @client.on_message do |room_jid, user_name, message|
-            room = Room[room_jid]
-            user = User[user_name]
-            next if room.nil? && user.nil?
-            room.params.topic = message.subject if message.subject.present?
-            next if user_name == @bot.name || message.body.blank?
-            Jabber::debuglog "[#{Time.now}] <#{room.name}> #{user_name}: #{message.body}"
-            begin
-              @bot.react(user, room, message.body)
-            rescue => e
-              Jabber::debuglog e.inspect
-              e.backtrace.each do |line|
-                Jabber::debuglog line
-              end
-            end
-          end
+          @client.on_message{ |*args| message_callback *args }
+          @client.on_private_message{ |*args| private_message_callback *args }
+          @client.on_invite{ |*args| invite_callback *args }
+          @client.on_presence{ |*args| presence_callback *args }
+          @client.activate_callbacks
+        end
 
-          @client.on_private_message do |user_jid, message|
-            user = User[user_jid]
-            next if user.blank? || user.name == @bot.name
-            if message.body.nil?
-              # if message.active?
-              # elsif message.inactive?
-              # elsif message.composing?
-              # elsif message.gone?
-              # elsif message.paused?
-              # end
-            else
-              @bot.react(user, nil, message.body)
-            end
+        def message_callback room_jid, user_name, message
+          with_sender(room_jid, user_name) do |room, user|
+            room.params.topic = message.subject if message.subject.present?
+            return if user_name == @bot.name || message.body.blank?
+            @bot.react(user, room, message.body)
           end
+        end
 
-          @client.on_invite do |room_jid, user_name, room_name, topic|
-            Room.create(room_jid, room_name, topic: topic)
-            @client.join(room_jid)
-          end
+        def invite_callback room_jid, user_name, room_name, topic
+          Room.create(room_jid, room_name, topic: topic)
+          @client.join(room_jid)
+        end
 
-          @client.on_presence do |room_jid, user_name, pres|
-            room = Room[room_jid]
-            next if room.blank? || user_name.blank?
-            user = User[user_name]
+        def presence_callback room_jid, user_name, pres
+          with_sender(room_jid, user_name) do |room, user|
             if pres == 'unavailable'
               if user_name == @bot.name
                 room.delete
               elsif user.present?
                 room.user_ids.delete(user.id)
               end
-            elsif pres.blank? && user.present? && room.user_ids.exclude?(user.id)
+            elsif pres.blank? && room.user_ids.exclude?(user.id)
               room.user_ids << user.id
             end
           end
+        end
 
-          @client.activate_callbacks
+        def private_message_callback user_jid, message
+          with_user(user_jid) do |user|
+            @bot.react(user, nil, message.body) if user.name != @bot.name
+          end if message.body.present?
+        end
+
+        def with_rooms
+          return Jabber::debuglog 'No rooms found' if Room.empty?
+          yield Room
+        end
+
+        def with_sender room_id, user_id
+          room = Room[room_id]
+          with_user(user_id) do |user|
+            yield room, user
+          end if room.present?
+        end
+
+        def with_user user_id
+          user = User[user_id]
+          yield user if user
         end
 
         def setup_timers
-          ::EM::add_periodic_timer(60) {
+          ::EM::add_periodic_timer(60) do
             @client.keep_alive(@bot.password) if @client.present?
-          }
+          end
         end
 
+        def setup_error_handler
+          ::EM.error_handler do |e|
+            Jabber::debuglog e.inspect
+            e.backtrace.each do |line|
+              Jabber::debuglog line
+            end
+          end
+        end
       end
     end
   end