hipbot 0.0.5 → 0.1.0

data/.gitignore

@@ -1 +1,2 @@
 *.gem
+test_bot.rb

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gem 'rake'
 gem 'eventmachine'

data/Gemfile.lock

@@ -1,25 +1,32 @@
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     active_support (3.0.0)
       activesupport (= 3.0.0)
     activesupport (3.0.0)
-    addressable (2.2.8)
-    crack (0.1.6)
+    addressable (2.3.2)
+    cookiejar (0.3.0)
     daemons (1.1.8)
     diff-lcs (1.1.3)
-    em-http-request (0.3.0)
-      addressable (>= 2.0.0)
-      escape_utils
-      eventmachine (>= 0.12.9)
-    escape_utils (0.2.4)
-    eventmachine (0.12.10)
-    httparty (0.5.2)
-      crack (= 0.1.6)
+    em-http-request (1.0.2)
+      addressable (>= 2.2.3)
+      cookiejar
+      em-socksify
+      eventmachine (>= 1.0.0.beta.4)
+      http_parser.rb (>= 0.5.3)
+    em-socksify (0.2.0)
+      eventmachine (>= 1.0.0.beta.4)
+    eventmachine (1.0.0.rc.4)
+    http_parser.rb (0.5.3)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
     i18n (0.6.0)
     metaclass (0.0.1)
-    mocha (0.11.4)
+    mocha (0.12.1)
       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)

data/README.md

@@ -1,6 +1,7 @@
 # Hipbot
 
 [![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.
 
@@ -84,6 +85,8 @@ end
 
 (Use with caution!)
 
+For more examples, check out (https://github.com/pewniak747/hipbot/tree/master/examples)
+
 #### Response helpers
 
 Use http helpers (`get`, `post`, `put`, `delete`) to preform a http request:
@@ -159,14 +162,14 @@ heroku ps:scale worker=1
 
 ## TODO:
 
-* handle auto joining on room invite
-* add database storage with postgresql adapter
-* rewrite SimpleMUCClient
+* add plugins support
 * add extended logging
-* handle private messages callbacks in the same way
 
 ### Done:
 
+* ~~rewrite SimpleMUCClient~~
+* ~~handle private messages callbacks~~
+* ~~handle auto joining on room invite~~
 * ~~add support for custom helpers~~
   * ~~mentions - returns list of @mentions in message~~
   * ~~sender_name - returns sender's first name~~

data/examples/cleverbot.rb

@@ -0,0 +1,23 @@
+# example bot that simulates intelligence
+# using http://cleverbot.com/ api
+
+require 'hipbot'
+require 'cleverbot'
+require 'htmlentities'
+
+class CleverHipbot < Hipbot::Bot
+  configure do |c|
+    c.jid = ENV['HIPBOT_JID']
+    c.password = ENV['HIPBOT_PASSWORD']
+    c.name = ENV['HIPBOT_NAME']
+  end
+
+  cleverbot = ::Cleverbot::Client.new
+
+  on /(.+)/ do |message|
+    coder = HTMLEntities.new
+    reply(coder.decode(cleverbot.write(message)))
+  end
+end
+
+CleverHipbot.start!

data/examples/google_images.rb

@@ -0,0 +1,35 @@
+# Pull out a random image from the Google Images API and display it
+# Uses: google_image_api http://rubygems.org/gems/google_image_api
+# Author Rushi Vishavadia <rushi.v@gmail.com>
+
+require 'hipbot'
+require 'google_image_api'
+
+class SampleBot < Hipbot::Bot
+  configure do |c|
+    c.jid = ENV['HIPBOT_JID']
+    c.password = ENV['HIPBOT_PASSWORD']
+    c.name = ENV['HIPBOT_NAME']
+  end
+
+  on /\Aimage (.+)/i do |img_str|
+    max = 8 # max number of results you want to pull a random
+    puts img_str
+    begin
+      results = GoogleImageApi.find(img_str, :rsz => max)
+      if results.raw_data["responseStatus"] == 200 and results.images.size > 0
+        reply(results.images.take(max).sample['unescapedUrl'])
+      elsif results.raw_data["responseStatus"] == 200 and results.images.size == 0
+        reply("I'm sorry I couldn't find an image for #{img_str}")
+      else
+        reply("I'm sorry, an error occurred. Try again please") # Most likely a 403
+      end
+    rescue => e
+      reply("I'm sorry, an error occurred trying to find that image")
+      p e.message
+      p e.backtrace
+    end
+  end
+end
+
+SampleBot.start!

data/lib/hipbot.rb

@@ -1,10 +1,11 @@
 require 'active_support/all'
+require 'ostruct'
 require 'eventmachine'
 require 'em-http-request'
 require 'xmpp4r'
 require 'xmpp4r/muc'
 
-require 'hipbot/patches/mucclient'
+require 'hipbot/patches/hipchat_client'
 require 'hipbot/patches/encoding'
 
 require 'hipbot/adapters/hipchat/hipchat'
@@ -13,9 +14,11 @@ require 'hipbot/adapters/telnet/telnet'
 require 'hipbot/adapters/telnet/connection'
 require 'hipbot/bot'
 require 'hipbot/configuration'
+require 'hipbot/collection'
+require 'hipbot/http_response'
 require 'hipbot/message'
 require 'hipbot/reaction'
 require 'hipbot/response'
-require 'hipbot/http_response'
 require 'hipbot/room'
+require 'hipbot/user'
 require 'hipbot/version'

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

@@ -3,120 +3,153 @@ module Hipbot
     module Hipchat
       class Connection
         def initialize bot
-          initialize_bot(bot)
-          initialize_jabber
-          initialize_rooms
-          join_rooms
+          @bot = bot
+          @bot.connection = self
+
+          return unless setup_bot
           setup_timers
         end
 
-        def reply room, message
-          send_message(room, message)
+        def restart!
+          exit_all_rooms # TODO: Nice quit
+          setup_bot
         end
 
-        def restart!
-          leave_rooms
-          initialize_jabber
+        def send_to_room(room, message)
+          @client.send_message(:groupchat, room.id, message)
+        end
+
+        def send_to_user(user, message)
+          @client.send_message(:chat, user.id, message)
+        end
+
+        def set_topic(room, topic)
+          @client.send_message(:groupchat, room.id, nil, topic)
+        end
+
+        def set_presence(status = nil, type = :available)
+          @client.set_presence(type, nil, status)
+        end
+
+        private
+
+        def setup_bot
+          return unless initialize_client
           initialize_rooms
+          initialize_users
+          initialize_callbacks
           join_rooms
+          set_presence('Hello humans!')
+          true
         end
 
-        private
+        def initialize_client
+          ::Jabber.debug = true
+          @client = ::Jabber::MUC::HipchatClient.new(@bot.jid + '/' + @bot.name)
+          @client.connect(@bot.password)
+        end
 
         def initialize_rooms
-          @muc_browser = Jabber::MUC::MUCBrowser.new(@jabber)
-          @rooms = @muc_browser.muc_rooms('conf.hipchat.com').map { |jid, name|
-            ::Hipbot::Room.new(jid, name)
-          }
+          Room.bot = @bot
+          @client.get_rooms.each do |r|
+            Room.create(r[:item].jid, r[:item].iname, topic: r[:details]['topic'])
+          end
+          true
         end
 
-        def initialize_bot bot
-          @bot = bot
-          @bot.connection = self
+        def initialize_users
+          User.bot = @bot
+          @client.get_users.each do |v|
+            params = {
+              email:   v[:vcard]['EMAIL/USERID'],
+              mention: v[:item].attributes['mention_name'],
+              title:   v[:vcard]['TITLE'],
+              photo:   v[:vcard]['PHOTO'],
+            }
+            User.create(v[:item].jid, v[:item].iname, params)
+          end
+          true
         end
 
-        def initialize_jabber
-          @jabber ||= ::Jabber::Client.new(@bot.jid)
-          @jabber.connect
-          @jabber.auth(@bot.password)
-          @jabber.send(::Jabber::Presence.new.set_type(:available))
+        def join_rooms
+          if Room.empty?
+            Jabber::debuglog "No rooms to join"
+            return false
+          end
+          Room.each do |room_jid, _|
+            @client.join(room_jid)
+          end
+          true
         end
 
-        def join_rooms
-          rooms.each do |room|
-            puts "Joining #{room.name}"
-
-            # TODO rewrite (Simple)MUCClient to handle many rooms from one object
-            # as there is no need to create distinct objects and callback for each
-            # room since all of them have to process same data from @jabber stream.
-            # We probably should be able to do something like this:
-            # @jabber.set_presence([room1, room2], :available)
-            # @jabber.on_event do |time, jid, message| # JID includes sender and room/chat
-            # @jabber.send(jid, message)
-            room.connection = ::Jabber::MUC::SimpleMUCClient.new(@jabber)
-            room.connection.on_message do |time, sender, message|
-              puts "#{room.name} > #{time} <#{sender}> #{message}"
-              begin
-                @bot.tell(sender, room, message)
-              rescue => e
-                puts e.inspect
-                e.backtrace.each do |line|
-                  puts line
-                end
+        def exit_all_rooms
+          Room.each do |room_jid, _|
+            @client.exit(room_jid, 'bye bye!')
+          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
 
-            # TODO Get and store all user data from HipChat API
-            room.users = []
-            room.connection.on_join do |time, nick|
-              room.users << nick
+          @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
-            room.connection.on_leave do |time, nick|
-              room.users.delete(nick)
-            end
-            room.connection.join("#{room.jid}/#{@bot.name}", nil, :history => false)
           end
 
-          # TODO handle sending private messages with 'reply'.
-          # Simplest way is to add room object for each private chat with param
-          # to distinguish whether to use conf or chat domain
-          # rooms.first.connection.on_private_message do |time, jid, message|
-            # send_message rooms.first, 'hello!', jid
-
-            ## Alternative sending:
-            # msg = ::Jabber::Message.new(jid, 'hello!')
-            # msg.type = :chat
-            # @jabber.send(msg)
-
-            ## We can trigger normal message callback but 'reply' won't work since hipchat PM uses
-            ## different jid (user_room@chat.hipchat.com/client_name)
-            # rooms.first.connection.message_block.call(time, sender, message)
-          # 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 leave_rooms
-          rooms.each do |room|
-            puts "Leaving #{room.name}"
-            room.connection.exit
+          @client.on_presence do |room_jid, user_name, pres|
+            room = Room[room_jid]
+            next if room.blank? || user_name.blank?
+            user = User[user_name]
+            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)
+              room.user_ids << user.id
+            end
           end
+
+          @client.activate_callbacks
         end
 
         def setup_timers
-          ::EM::add_periodic_timer(10) {
-            if !@jabber.nil? && @jabber.is_disconnected?
-              initialize_jabber
-              join_rooms
-            end
+          ::EM::add_periodic_timer(60) {
+            @client.keep_alive(@bot.password) if @client.present?
           }
         end
 
-        def send_message room, message, jid = nil
-          room.connection.say(message, jid)
-        end
-
-        def rooms
-          @rooms || []
-        end
       end
     end
   end

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

@@ -1,8 +1,6 @@
 module Hipbot
   module Adapters
     module Hipchat
-      delegate :reply, to: :connection
-
       def start!
         ::EM::run do
           ::EM.error_handler do |e|
@@ -15,6 +13,10 @@ module Hipbot
           Connection.new(self)
         end
       end
+
+      def method_missing(sym, *args, &block)
+        connection.send sym, *args, &block
+      end
     end
   end
 end

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

@@ -9,7 +9,7 @@ module Hipbot
 
         def receive_data(data)
           sender, room, message = *data.strip.split(':')
-          @bot.tell(sender, room, message)
+          @bot.react(sender, room, message)
         end
       end
     end

data/lib/hipbot/adapters/telnet/telnet.rb

@@ -1,7 +1,7 @@
 module Hipbot
   module Adapters
     module Telnet
-      def reply room, message
+      def send_to_room room, message
         connection.send_data("#{self}:#{room}:#{message}\n")
       end