hipbot 0.2.0 → 1.0.0.rc1

data/.gitignore

@@ -1,2 +1,3 @@
 *.gem
-test_bot.rb
+test_bot.rb
+coverage/*

data/Gemfile

@@ -11,4 +11,5 @@ gem 'daemons'
 
 gem 'rspec'
 gem 'guard-rspec'
+gem 'coveralls', require: false
 gem 'mocha'

data/Gemfile.lock

@@ -6,7 +6,14 @@ GEM
       multi_json (~> 1.0)
     addressable (2.3.3)
     coderay (1.0.9)
+    colorize (0.5.8)
     cookiejar (0.3.0)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
     daemons (1.1.9)
     diff-lcs (1.2.2)
     em-http-request (1.0.3)
@@ -37,6 +44,7 @@ GEM
     lumberjack (1.0.3)
     metaclass (0.0.1)
     method_source (0.8.1)
+    mime-types (1.23)
     mocha (0.13.3)
       metaclass (~> 0.0.1)
     multi_json (1.7.2)
@@ -46,6 +54,8 @@ GEM
       method_source (~> 0.8)
       slop (~> 3.4)
     rake (10.0.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
       rspec-expectations (~> 2.13.0)
@@ -54,6 +64,10 @@ GEM
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.13.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
     slop (3.4.4)
     thor (0.18.1)
     xmpp4r (0.5)
@@ -63,6 +77,7 @@ PLATFORMS
 
 DEPENDENCIES
   activesupport
+  coveralls
   daemons
   em-http-request
   eventmachine

data/README.md

@@ -2,6 +2,9 @@
 
 [![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)
+[![Coverage Status](https://coveralls.io/repos/pewniak747/hipbot/badge.png?branch=master)](https://coveralls.io/r/pewniak747/hipbot)
+[![Dependency Status](https://gemnasium.com/pewniak747/hipbot.png)](https://gemnasium.com/pewniak747/hipbot)
+[![Gem Version](https://badge.fury.io/rb/hipbot.png)](http://badge.fury.io/rb/hipbot)
 
 Hipbot is a XMPP bot for HipChat, written in ruby & eventmachine.
 
@@ -17,7 +20,7 @@ gem install hipbot
 
 Create `bot.rb` file, subclass `Hipbot::Bot` and customize the responses.
 
-``` ruby
+```ruby
 require 'hipbot'
 
 class MyCompanyBot < Hipbot::Bot
@@ -27,7 +30,6 @@ class MyCompanyBot < Hipbot::Bot
     c.password  = 'secret' # required
     c.teams     = { vip: ['John', 'Mike'] }
     c.rooms     = { project_rooms: ['Project 1', 'Project 2'] }
-    c.plugins   = [ PluginClass ]
   end
 
   on /^hello/ do
@@ -49,7 +51,9 @@ class MyCompanyBot < Hipbot::Bot
   end
 end
 
-class PluginClass < Hipbot::Plugin
+class PluginClass
+  include Hipbot::Plugin
+
   on /^plugin/ do
     reply('this is from plugin!')
   end
@@ -60,7 +64,7 @@ MyCompanyBot.start!
 
 You can create a response by providing simple regexp:
 
-``` ruby
+```ruby
 on /^hello/ do
   reply('hello!')
 end
@@ -68,7 +72,7 @@ end
 
 Responses can pass arguments from regexps:
 
-``` ruby
+```ruby
 on /my name is (.*)/ do |user_name|
   reply('hello #{user_name}!')
 end
@@ -76,7 +80,7 @@ end
 
 Define multiple regexps for a response:
 
-``` ruby
+```ruby
 on /my name is (.*)/, /I am (.*)/ do |name|
   reply('hello #{user_name}!')
 end
@@ -84,7 +88,7 @@ end
 
 Use :from to only match messages from certain users or user groups defined in configuration
 
-``` ruby
+```ruby
 configure do |c|
   # ...
   c.teams = { vip: ['John', 'Mike'] }
@@ -97,7 +101,7 @@ end
 
 Use :room to only match messages in certain hipchat rooms
 
-``` ruby
+```ruby
 configure do |c|
   # ...
   c.rooms = { project_rooms: ['Project 1', 'Project 2'] }
@@ -110,7 +114,7 @@ end
 
 Use :global to react to messages that are not sent directly to @robot
 
-``` ruby
+```ruby
 on /hey I just met you/, global: true do
   reply('and this is crazy...')
 end
@@ -124,7 +128,7 @@ For more examples, check out (https://github.com/pewniak747/hipbot/tree/master/e
 
 Use http helpers (`get`, `post`, `put`, `delete`) to preform a http request:
 
-``` ruby
+```ruby
 on /curl (\S+)/ do |url|
   get url do |response|
     reply(response.code)
@@ -134,7 +138,7 @@ on /curl (\S+)/ do |url|
 end
 ```
 
-``` ruby
+```ruby
 on /ping site/ do
   get 'http://example.com', ping: "1" # issues http://example.com?ping=1
 end
@@ -149,7 +153,7 @@ Inside response you have access to following variables:
 
 You can define your own helpers and use them inside responses like this:
 
-``` ruby
+```ruby
 module HipbotHelpers
   def project_name
     "#{room.name}-project"
@@ -170,10 +174,11 @@ end
 
 #### Plugins
 
-To define a plugin, subclass `Hipbot::Plugin` and add responses like in bot:
+To define a plugin, include `Hipbot::Plugin` and add responses like in bot:
 
-``` ruby
-class GreeterPlugin < Hipbot::Plugin
+```ruby
+class GreeterPlugin
+  include Hipbot::Plugin
   on /^hello/ do
     reply('hello there!')
   end
@@ -182,12 +187,11 @@ end
 
 You can gain access to plugin data inside reaction with `plugin` helper:
 
-``` ruby
-class GreeterPlugin < Hipbot::Plugin
+```ruby
+class GreeterPlugin
+  include Hipbot::Plugin
+
   attr_accessor :language
-  def initialize(language)
-    self.language = language
-  end
 
   on /^hello/ do
     case plugin.language
@@ -200,6 +204,10 @@ class GreeterPlugin < Hipbot::Plugin
     end
   end
 end
+
+GreeterPlugin.configure do |c|
+  c.language = :jp
+end
 ```
 
 For a collection of open-source plugins, see https://github.com/netguru/hipbot-plugins

data/hipbot.gemspec

@@ -2,8 +2,8 @@
 require File.expand_path('../lib/hipbot/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Tomasz Pewiński"]
-  gem.email         = ["pewniak747@gmail.com"]
+  gem.authors       = ["Bartosz Kopiński", "Tomasz Pewiński"]
+  gem.email         = ["bartosz.kopinski@netguru.pl", "pewniak747@gmail.com"]
   gem.description   = "Hipbot is a bot for HipChat, written in ruby & eventmachine."
   gem.summary       = "Hipbot is a bot for HipChat, written in ruby & eventmachine."
   gem.homepage      = "http://github.com/pewniak747/hipbot"

data/lib/hipbot.rb

@@ -19,6 +19,7 @@ require 'hipbot/plugin'
 require 'hipbot/configuration'
 require 'hipbot/collection'
 require 'hipbot/helpers'
+require 'hipbot/match'
 require 'hipbot/message'
 require 'hipbot/reaction'
 require 'hipbot/response'

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

@@ -2,10 +2,8 @@ module Hipbot
   module Adapters
     module Hipchat
       class Connection
-        def initialize bot
-          @bot = bot
-          @bot.connection = self
-
+        def initialize
+          Hipbot.connection = self
           setup_error_handler && setup_bot && setup_timers
         end
 
@@ -15,71 +13,78 @@ module Hipbot
         end
 
         def send_to_room(room, message)
+          Hipbot.logger.info("REPLY in #{room}: #{message}")
           @client.send_message(:groupchat, room.id, message)
         end
 
         def send_to_user(user, message)
+          Hipbot.logger.info("REPLY to #{user}: #{message}")
           @client.send_message(:chat, user.id, message)
         end
 
         def set_topic(room, topic)
+          Hipbot.logger.info("TOPIC set in #{room} to '#{topic}'")
           @client.send_message(:groupchat, room.id, nil, topic)
         end
 
         def set_presence(status = nil, type = :available)
+          Hipbot.logger.info("PRESENCE set to #{type} with '#{status}'")
           @client.set_presence(type, nil, status)
         end
 
-        private
+        protected
 
         def setup_bot
           initialize_client do
             initialize_rooms
             initialize_users
             initialize_callbacks
+            set_bot_user
             join_rooms
             set_presence('Hello humans!')
           end
         end
 
         def initialize_client
-          @client = ::Jabber::MUC::HipchatClient.new(@bot.jid + '/' + @bot.name)
-          yield if @client.connect(@bot.password)
+          @client = ::Jabber::MUC::HipchatClient.new(Hipbot.jid)
+          yield if @client.connect(Hipbot.password)
         end
 
         def initialize_rooms
-          @client.get_rooms.each do |r|
-            Room.create(r[:item].jid, r[:item].iname, topic: r[:details]['topic'])
+          @client.get_rooms.each do |room_data|
+            room = Room.find_or_create_by(id: room_data[:item].jid.to_s)
+            room.update_attributes({
+                 name: room_data[:item].iname,
+                topic: room_data[:details]['topic'],
+            })
           end
-          true
         end
 
         def initialize_users
-          @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)
+          @client.get_users.each do |user_data|
+            user = User.find_or_create_by(id: user_data.delete(:jid))
+            user.update_attributes(user_data)
+
+            if user.attributes['email'].nil?
+              user.update_attributes(@client.get_user_details(user.id))
+            end
           end
-          true
+        end
+
+        def set_bot_user
+          Hipbot.configuration.user = User[Hipbot.jid]
+          @client.name = Hipbot.user
         end
 
         def join_rooms
-          with_rooms do |rooms|
-            rooms.each do |r|
-              @client.join(r.id)
-            end
+          with_rooms do |room|
+            @client.join(room.id)
           end
         end
 
         def exit_all_rooms
-          with_rooms do |rooms|
-            rooms.each do |r|
-              @client.exit(r.id, 'bye bye!')
-            end
+          with_rooms do |room|
+            @client.exit(room.id, 'bye bye!')
           end
         end
 
@@ -93,40 +98,40 @@ module Hipbot
 
         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)
+            room.update_attribute(:topic, message.subject) if message.subject.present?
+            return if user_name == Hipbot.name || message.body.blank?
+            Hipbot.react(user, room, message.body)
           end
         end
 
         def invite_callback room_jid, user_name, room_name, topic
-          Room.create(room_jid, room_name, topic: topic)
+          Room.create(id: room_jid, name: room_name, topic: topic)
           @client.join(room_jid)
         end
 
         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
+              if user_name == Hipbot.name
                 room.delete
               elsif user.present?
-                room.user_ids.delete(user.id)
+                room.users.delete(user)
               end
-            elsif pres.blank? && room.user_ids.exclude?(user.id)
-              room.user_ids << user.id
+            elsif pres.blank? && room.users.exclude?(user)
+              room.users << user
             end
           end
         end
 
         def private_message_callback user_jid, message
           with_user(user_jid) do |user|
-            @bot.react(user, nil, message.body) if user.name != @bot.name
+            Hipbot.react(user, nil, message.body) if user.name != Hipbot.name
           end if message.body.present?
         end
 
         def with_rooms
-          return Jabber::debuglog 'No rooms found' if Room.empty?
-          yield Room
+          return Hipbot.logger.error 'No rooms found' if Room.empty?
+          Room.each{ |room| yield room }
         end
 
         def with_sender room_id, user_id
@@ -143,15 +148,15 @@ module Hipbot
 
         def setup_timers
           ::EM::add_periodic_timer(60) do
-            @client.keep_alive(@bot.password) if @client.present?
+            @client.keep_alive(Hipbot.password) if @client.present?
           end
         end
 
         def setup_error_handler
           ::EM.error_handler do |e|
-            Jabber::debuglog e.inspect
+            Hipbot.logger.error e.inspect
             e.backtrace.each do |line|
-              Jabber::debuglog line
+              Hipbot.logger.error line
             end
           end
         end

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

@@ -2,7 +2,7 @@ module Hipbot
   module Adapters
     module Hipchat
       def start!
-        connection = Connection.new(self)
+        connection = Connection.new
       end
 
       def method_missing(sym, *args, &block)

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

@@ -2,14 +2,13 @@ module Hipbot
   module Adapters
     module Telnet
       class Connection < EM::Connection
-        def initialize bot
-          @bot = bot
-          @bot.connection = self
+        def initialize
+          Hipbot.connection = self
         end
 
         def receive_data(data)
-          sender, room, message = *data.strip.split(':')
-          @bot.react(sender, room, message)
+          sender, room, message = data.strip.split(':')
+          Hipbot.react(sender, room, message)
         end
       end
     end