hipbot 0.0.3 → 0.0.5

data/.travis.yml

@@ -2,3 +2,9 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
+notifications:
+  email:
+    recipients:
+      - pewniak747@gmail.com
+      - bartosz.kopinski@netguru.pl
+

data/Gemfile

@@ -11,6 +11,3 @@ gem 'daemons'
 
 gem 'rspec'
 gem 'mocha'
-
-# Plugins
-gem 'google-weather'

data/Gemfile.lock

@@ -14,8 +14,6 @@ GEM
       eventmachine (>= 0.12.9)
     escape_utils (0.2.4)
     eventmachine (0.12.10)
-    google-weather (0.3.0)
-      httparty (~> 0.5.0)
     httparty (0.5.2)
       crack (= 0.1.6)
     i18n (0.6.0)
@@ -23,14 +21,14 @@ GEM
     mocha (0.11.4)
       metaclass (~> 0.0.1)
     rake (0.9.2.2)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.1)
-    rspec-expectations (2.10.0)
+    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.10.1)
+    rspec-mocks (2.11.1)
     xmpp4r (0.5)
 
 PLATFORMS
@@ -41,7 +39,6 @@ DEPENDENCIES
   daemons
   em-http-request
   eventmachine
-  google-weather
   httparty
   i18n
   mocha

data/README.md

@@ -4,16 +4,16 @@
 
 Hipbot is a bot for HipChat, written in ruby & eventmachine.
 
-This is a work in progress.
-
 ## Usage
 
-Install via RubyGems
+### Install
 
 ```
 gem install hipbot
 ```
 
+### Customize
+
 In bot.rb file, subclass Hipbot::Bot and customize robot responses.
 
 ``` ruby
@@ -26,28 +26,114 @@ class MyCompanyBot < Hipbot::Bot
     c.password = 'secret'
   end
 
-  # simple reply to '@robot hello!'
   on /^hello.*/ do
     reply('hello!')
   end
+end
+
+MyCompanyBot.start!
+```
+
+You can create a response by providing simple regexp:
+
+``` ruby
+on /^hello.*/ do
+  reply('hello!')
+end
+```
+
+Responses can pass arguments from regexps:
+
+``` ruby
+on /my name is (.*)/ do |user_name|
+  reply('hello #{user_name}!')
+end
+```
+
+Define multiple regexps for a response:
+
+``` ruby
+on /my name is (.*)/, /I am (.*)/ do |name|
+  reply('hello #{user_name}!')
+end
+```
+
+Use :from to only match messages from certain users
+
+``` ruby
+on /status report/, :from => ['tom', 'dave'] do
+  reply('all clear')
+end
+```
+
+Use :room to only match messages in certain hipchat rooms
+
+``` ruby
+on /hello/, :room => ['public'] do
+  reply('hello!')
+end
+```
+
+Use :global to react to messages that are not sent directly to @robot
+
+``` ruby
+on /hey I just met you/, :global => true do
+  reply('and this is crazy...')
+end
+```
+
+(Use with caution!)
+
+#### Response helpers
+
+Use http helpers (`get`, `post`, `put`, `delete`) to preform a http request:
 
-  # tasks with arguments: '@robot deploy to production pls'
-  on /deploy to (.*) pls/ do |stage|
-    reply('deploying to #{stage}!')
-    post("http://#{stage}.example.com") do |http|
-      reply("deploy server responded with #{http.response_header.status}")
-    end
+``` ruby
+on /curl (\S+)/ do |url|
+  get url do |response|
+    reply(response.code)
+    reply(response.headers)
+    reply(response.body)
   end
+end
+```
 
-  # global messages
-  on /.*hello everyone.*/, global: true do
-    reply('hello!')
+``` ruby
+on /ping site/ do
+  get 'http://example.com', :ping => "1" # issues http://example.com?ping=1
+end
+```
+
+Inside response you have access to following variables:
+
+* `message.body` - sent message
+* `message.sender` - user who sent message
+* `message.mentions` - array of @mentions inside message, without bot
+* `room.name` - name of the current room
+
+You can define your own helpers and use them inside responses like this:
+
+``` ruby
+module HipbotHelpers
+  def project_name
+    "#{room.name}-project"
   end
 end
 
-MyCompanyBot.start!
+class Bot < Hipbot::Bot
+  configure do |c|
+    c.helpers = HipbotHelpers
+    # rest of configuration
+  end
+
+  on /what's the project called\?/ do
+    reply(project_name)
+  end
+end
 ```
 
+### Run
+
 Run hipbot as daemon by saying:
 
 ```
@@ -56,13 +142,35 @@ hipbot start
 
 Run `hipbot` to see all available commands.
 
+## Deploying to Heroku
+
+Create a Procfile & add it to your repo:
+
+```
+worker: bundle exec hipbot run
+```
+
+```
+heroku create
+git push heroku master
+heroku ps:scale web=0
+heroku ps:scale worker=1
+```
+
 ## TODO:
 
-* add support for custom helpers
-  * mentions - returns list of @mentions in message
-  * sender_name - returns sender's first name
-  * 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 ...`)
+* handle auto joining on room invite
+* add database storage with postgresql adapter
+* rewrite SimpleMUCClient
 * add extended logging
+* handle private messages callbacks in the same way
+
+### Done:
+
+* ~~add support for custom helpers~~
+  * ~~mentions - returns list of @mentions in message~~
+  * ~~sender_name - returns sender's first name~~
+  * ~~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 ...`)~~

data/bin/hipbot

@@ -2,4 +2,11 @@
 
 require 'daemons'
 
-Daemons.run('bot.rb')
+hipbot_file = 'bot.rb'
+
+if File.exists?(hipbot_file)
+  Daemons.run(hipbot_file)
+else
+  puts "File #{hipbot_file} not found!"
+  exit 1
+end

data/hipbot.gemspec

@@ -20,5 +20,6 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "eventmachine", ["~> 0.12.10"]
   gem.add_runtime_dependency "em-http-request", ["~> 0.3.0"]
   gem.add_runtime_dependency "xmpp4r", ["~> 0.5"]
-  gem.add_runtime_dependency "google-weather", ["~> 0.3.0"]
+  gem.add_development_dependency "rspec", ['~> 2.11.0']
+  gem.add_development_dependency "mocha", ['~> 0.11.4']
 end

data/lib/hipbot.rb

@@ -3,18 +3,19 @@ require 'eventmachine'
 require 'em-http-request'
 require 'xmpp4r'
 require 'xmpp4r/muc'
-require 'hipbot/mucclient'
-require 'hipbot/encoding'
 
-require 'hipbot/adapters/hipchat'
-require 'hipbot/adapters/telnet'
+require 'hipbot/patches/mucclient'
+require 'hipbot/patches/encoding'
+
+require 'hipbot/adapters/hipchat/hipchat'
+require 'hipbot/adapters/hipchat/connection'
+require 'hipbot/adapters/telnet/telnet'
+require 'hipbot/adapters/telnet/connection'
 require 'hipbot/bot'
 require 'hipbot/configuration'
 require 'hipbot/message'
 require 'hipbot/reaction'
 require 'hipbot/response'
+require 'hipbot/http_response'
 require 'hipbot/room'
 require 'hipbot/version'
-
-# Plugins
-require 'google_weather'

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

@@ -0,0 +1,123 @@
+module Hipbot
+  module Adapters
+    module Hipchat
+      class Connection
+        def initialize bot
+          initialize_bot(bot)
+          initialize_jabber
+          initialize_rooms
+          join_rooms
+          setup_timers
+        end
+
+        def reply room, message
+          send_message(room, message)
+        end
+
+        def restart!
+          leave_rooms
+          initialize_jabber
+          initialize_rooms
+          join_rooms
+        end
+
+        private
+
+        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)
+          }
+        end
+
+        def initialize_bot bot
+          @bot = bot
+          @bot.connection = self
+        end
+
+        def initialize_jabber
+          @jabber ||= ::Jabber::Client.new(@bot.jid)
+          @jabber.connect
+          @jabber.auth(@bot.password)
+          @jabber.send(::Jabber::Presence.new.set_type(:available))
+        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
+              end
+            end
+
+            # TODO Get and store all user data from HipChat API
+            room.users = []
+            room.connection.on_join do |time, nick|
+              room.users << nick
+            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
+
+        def leave_rooms
+          rooms.each do |room|
+            puts "Leaving #{room.name}"
+            room.connection.exit
+          end
+        end
+
+        def setup_timers
+          ::EM::add_periodic_timer(10) {
+            if !@jabber.nil? && @jabber.is_disconnected?
+              initialize_jabber
+              join_rooms
+            end
+          }
+        end
+
+        def send_message room, message, jid = nil
+          room.connection.say(message, jid)
+        end
+
+        def rooms
+          @rooms || []
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Hipbot
+  module Adapters
+    module Hipchat
+      delegate :reply, to: :connection
+
+      def start!
+        ::EM::run do
+          ::EM.error_handler do |e|
+            puts e.inspect
+            e.backtrace.each do |line|
+              puts line
+            end
+          end
+
+          Connection.new(self)
+        end
+      end
+    end
+  end
+end

data/lib/hipbot/adapters/{telnet.rb → telnet/connection.rb}

@@ -1,10 +1,6 @@
 module Hipbot
   module Adapters
     module Telnet
-      def reply room, message
-        connection.send_data("#{self}:#{room}:#{message}\n")
-      end
-
       class Connection < EM::Connection
         def initialize bot
           @bot = bot
@@ -16,12 +12,6 @@ module Hipbot
           @bot.tell(sender, room, message)
         end
       end
-
-      def start!
-        ::EM::run do
-          ::EM::connect('0.0.0.0', 3001, Connection, self)
-        end
-      end
     end
   end
 end