hipbot 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef74572ebd12e87ab892010a3c8c0bae5b146584
-  data.tar.gz: 03a8912f6c9958a88d3e2294844f6fc5fa5b7bc9
+  metadata.gz: ef69ec3d9ca84e1a5bf80f9e15d107b9e4bd2ec4
+  data.tar.gz: a875ec05d94328a7fb6a7c7f0dfbd3c207b4f6d9
 SHA512:
-  metadata.gz: e8f9b8bd967a44c5b0b09057c63b257418f988a616e02cb63d91f55a26115f72da08ff3d82ead405ed48f38d7e24d8bf458bf6ed45d49bd16ab483c77d4e0bd2
-  data.tar.gz: e174318fef49cc39dc116ce31057d5377a015c35989f4b2be9451fbb7737b98dae68f6de96bd1a2c8111be5dbaa245e61ae081f938a3bee1b43078e625a315ce
+  metadata.gz: d003c361dee535be8929fc219e16523ee02030383a9c607a119d4dad7fca9530feece39073119f32a0359d55b5ac67a7594dcfda44d8481a42d7d3371b1874eb
+  data.tar.gz: e5bf6173b705a247963f67c77e6b6d67d7c352cc1aee8c4f4d00ce709d7121d7d93b01422701509e6b6eb2fd7d603c7087b3b36f5cd87ed8cf8f753a030da184

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.0
   - jruby-19mode
   - rbx-19mode
   - jruby-head

data/Gemfile

@@ -1,14 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'rake'
-gem 'eventmachine'
-gem 'em-http-request'
-gem 'httparty'
-gem 'activesupport'
-gem 'daemons'
+gemspec
 gem 'xmpp4r-hipchat', github: 'bartoszkopinski/xmpp4r-hipchat', branch: 'master'
 
-gem 'rspec'
-gem 'guard-rspec'
 gem 'coveralls', require: false
-gem 'mocha'

data/README.md

@@ -373,6 +373,22 @@ end
 on /^My name is (.*)$/, :hello
 ```
 
+### Presence reaction
+Use `on_presence` in the same way as `on` to make presence reactions:
+```ruby
+class MyBot < Hipbot::Bot
+  # ...
+  on_presence do |status|
+    case status
+    when 'unavailable'
+      reply("Bye bye, #{sender.name}!")
+    when ''
+      reply("Welcome, #{sender.name}!")
+    end
+  end
+end
+```
+
 ### Scopes
 Use `scope` blocks to extract common options:
 ```ruby
@@ -432,7 +448,7 @@ end
 ```
 
 ### User managment
-This behavior is experimental and not officially supported by HipChat. Bot must be an admin in order to perform this actions.
+This behavior is experimental and not officially supported by HipChat. Bot must be an admin in order to perform these actions.
 ```ruby
 on /^kick (.*)/ do |user_name|
   user = Hipbot::User.find_by(name: user_name)

data/hipbot.gemspec

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# -*- encoding: utf-8 -*-
 require File.expand_path('../lib/hipbot/version', __FILE__)
 
 Gem::Specification.new do |gem|
@@ -15,12 +15,12 @@ Gem::Specification.new do |gem|
   gem.name          = "hipbot"
   gem.require_paths = ["lib"]
   gem.version       = Hipbot::VERSION
-  gem.add_runtime_dependency "xmpp4r-hipchat", [">= 0.0.3"]
-  gem.add_runtime_dependency "daemons", [">= 1.1.8"]
-  gem.add_runtime_dependency "activesupport", [">= 3.2.12"]
-  gem.add_runtime_dependency "eventmachine", [">= 1.0.3"]
-  gem.add_runtime_dependency "em-http-request", [">= 1.0.3"]
-  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']
+  gem.add_runtime_dependency "xmpp4r-hipchat", ["= 0.0.4"]
+  gem.add_runtime_dependency "daemons", ["~> 1.1"]
+  gem.add_runtime_dependency "activesupport", [">= 3.0.0"]
+  gem.add_runtime_dependency "eventmachine", ["~> 1.0"]
+  gem.add_runtime_dependency "em-http-request", ["~> 1.1"]
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "guard-rspec"
 end

data/lib/hipbot.rb

@@ -40,6 +40,7 @@ require 'hipbot/match'
 require 'hipbot/message'
 require 'hipbot/reaction'
 require 'hipbot/response'
+require 'hipbot/presence'
 require 'hipbot/room'
 require 'hipbot/user'
 require 'hipbot/version'

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

@@ -47,7 +47,7 @@ module Hipbot
             user.update_attributes(user_data)
 
             if user.attributes['email'].nil?
-              # user.update_attributes(client.get_user_details(user.id))
+              user.update_attributes(client.get_user_details(user.id))
             end
             user.id
           end

data/lib/hipbot/callbacks/room_presence.rb

@@ -15,10 +15,13 @@ module Hipbot
       def handle_room_presence
         with_room(id: room_id) do |room|
           with_user(name: user_name) do |user|
+            Hipbot.react_to_presence(user, presence, room)
             if offline_presence?
               room.on_leave(user)
             elsif online_presence? && !room.users.include?(user)
               room.on_join(user)
+            else
+              # TODO: Availability status change handling
             end
           end
         end

data/lib/hipbot/configuration.rb

@@ -8,7 +8,10 @@ module Hipbot
 
     def initialize
       self.adapter       = Adapters::Hipchat
-      self.exception_handler = Proc.new{ |e| Hipbot.logger.error(e) }
+      self.exception_handler = Proc.new do |e|
+        Hipbot.logger.error(e.message)
+        e.backtrace.each { |line| Hipbot.logger.error(line) }
+      end
       self.helpers       = Module.new
       self.jid           = ''
       self.join          = :all

data/lib/hipbot/helpers.rb

@@ -2,7 +2,7 @@ module Hipbot
   module Helpers
     [:get, :post, :put, :delete].each do |method|
       define_method method do |url, query = {}, &block|
-        Http::Request.new(url, query, method).(&block)
+        Http::Request.new(url, query, method).call(&block)
       end
       module_function method
     end

data/lib/hipbot/http.rb

@@ -1,17 +1,13 @@
-# encoding: utf-8
 module Hipbot
   module Http
-    class Request < Struct.new(:url, :params, :method)
+    class Request < Struct.new(:url, :query, :method)
       DEFAULT_HEADERS     = { 'accept-encoding' => 'gzip, compressed' }.freeze
       CONNECTION_SETTINGS = { connect_timeout: 5, inactivity_timeout: 10 }.freeze
       ERROR_CALLBACK      = ->(error){ Hipbot.logger.error(error) }
 
       def initialize *args
         super
-        self.params ||= {}
-        self.params = params.has_key?(:query) ? params : { query: params }
-        self.params = { head: DEFAULT_HEADERS }.merge(params)
-        Hipbot.logger.info("HTTP-REQUEST: #{url} #{params}")
+        Hipbot.logger.info("HTTP-REQUEST: #{url} #{query}")
       end
 
       def call &success_block
@@ -29,12 +25,12 @@ module Hipbot
         instance_exec(e, &Hipbot.exception_handler)
       end
 
-      def http options = {}
-        @http ||= connection.send(method, params.merge(options))
+      def http
+        @http ||= connection.send(method, query: query.merge(head: DEFAULT_HEADERS))
       end
 
       def connection
-        @connection ||= EM::HttpRequest.new(url, CONNECTION_SETTINGS)
+        EM::HttpRequest.new(url, CONNECTION_SETTINGS)
       end
     end
 
@@ -57,7 +53,6 @@ module Hipbot
       end
 
       def json
-        binding.pry
         @json ||= JSON.parse(body) || {}
       end
     end

data/lib/hipbot/logger.rb

@@ -2,10 +2,8 @@ require 'logger'
 
 module Hipbot
   class Logger < ::Logger
-    def add(severity, message = nil, progname = nil, &block)
-      msg = message || (block_given? and block.call) || progname
-      severity_name = { 0 => "DEBUG", 1 => "INFO", 2 => "WARN", 3 => "ERROR", 4 => "FATAL", 5 => "UNKNOWN" }[severity]
-      super(severity, "[#{severity_name}][#{Time.now}] #{msg}")
+    def format_message(severity, timestamp, progname, msg)
+      "[#{severity}][#{Time.now}] #{msg}\n"
     end
   end
 end

data/lib/hipbot/match.rb

@@ -28,7 +28,7 @@ module Hipbot
     end
 
     def matches_scope?
-      reaction.global? || message.for?(Hipbot.user) || message.private?
+      reaction.global? || message.private? || message.for?(Hipbot.user)
     end
 
     def matches_place?
@@ -44,7 +44,7 @@ module Hipbot
     end
 
     def matches_condition?
-      reaction.condition.(*reaction.condition.parameters.map{ |parameter| message.send(parameter.last) })
+      reaction.condition.call(*reaction.condition.parameters.map{ |parameter| message.send(parameter.last) })
     end
 
     def message_text

data/lib/hipbot/matchable.rb

@@ -2,7 +2,13 @@ module Hipbot
   module Matchable
     def react sender, room, body
       message = Message.new(body, room, sender)
-      matches = message_matches(message)
+      matches = set_matches(reaction_sets, message)
+      Match.invoke_all(matches)
+    end
+
+    def react_to_presence sender, status, room
+      presence = Presence.new(sender, status, room)
+      matches  = set_matches(presence_reaction_sets, presence)
       Match.invoke_all(matches)
     end
 
@@ -16,6 +22,10 @@ module Hipbot
       plugins.map(&:class)
     end
 
+    def presence_reaction_sets
+      reactables.map(&:presence_reactions)
+    end
+
     def reaction_sets
       reactables.each_with_object([]) do |reactable, array|
         array.unshift(reactable.reactions)
@@ -23,16 +33,16 @@ module Hipbot
       end
     end
 
-    def message_matches message
-      reaction_sets.each do |reactions|
+    def set_matches sets, message
+      sets.each do |reactions|
         matches = reactions_matches(message, reactions)
         return matches if matches.any?
       end
       []
     end
 
-    def reactions_matches message, reactions
-      reactions.map{ |reaction| reaction.match_with(message) }.select(&:matches?)
+    def reactions_matches matchable, reactions
+      reactions.map{ |reaction| reaction.match_with(matchable) }.select(&:matches?)
     end
   end
 end

data/lib/hipbot/presence.rb

@@ -0,0 +1,17 @@
+module Hipbot
+  class Presence < Struct.new(:sender, :body, :room)
+
+    def initialize *args
+      super
+      Hipbot.logger.info("PRESENCE from #{sender} in #{room}")
+    end
+
+    def for? _
+      true
+    end
+
+    def private?
+      room.nil?
+    end
+  end
+end

data/lib/hipbot/reactable.rb

@@ -2,11 +2,17 @@ module Hipbot
   module Reactable
     include Cache
 
-    attr_cache :reactions, :default_reactions, :options_stack
+    attr_cache :reactions, :default_reactions, :presence_reactions, :options_stack
     attr_cache :reaction_factory do
       ReactionFactory.new(self)
     end
 
+    def on_presence *params, &block
+      scope *params do
+        presence_reactions << to_reaction(block)
+      end
+    end
+
     def on *params, &block
       scope *params do
         reactions << to_reaction(block)

data/lib/hipbot/reaction.rb

@@ -71,7 +71,7 @@ module Hipbot
     protected
 
     def replace_symbols values, replacements_hash
-      Array(values).flat_map{ |v| replacements_hash[v] || v }.uniq
+      Array(values).flat_map{ |v| replacements_hash[v] || v }.map(&:to_s)
     end
   end
 end

data/lib/hipbot/storages/hash.rb

@@ -77,12 +77,12 @@ module Hipbot
           end
         end
 
-        # protected
+        protected
 
-        # def method_missing name, *args, &block
-        #   return all.public_send(name, *args, &block) if Array.instance_methods.include?(name)
-        #   super
-        # end
+        def method_missing name, *args, &block
+          return all.public_send(name, *args, &block) if Array.instance_methods.include?(name)
+          super
+        end
       end
     end
   end

data/lib/hipbot/user.rb

@@ -15,9 +15,5 @@ module Hipbot
     def myself?
       self == Hipbot.user
     end
-
-    def guest?
-      attributes[:role] == 'visitor'
-    end
   end
 end

data/lib/hipbot/version.rb

@@ -1,3 +1,3 @@
 module Hipbot
-  VERSION = "1.0.0"
+  VERSION = "1.0.3"
 end

data/spec/integration/my_hipbot.rb

@@ -44,10 +44,6 @@ class CoolPlugin
   on /respond cool/ do
     reply('cool responded')
   end
-
-  default do
-    reply("I didn't understand you")
-  end
 end
 
 class MyHipbot < Hipbot::Bot
@@ -63,6 +59,19 @@ class MyHipbot < Hipbot::Bot
     reply('What do you mean, Other Guy?')
   end
 
+  default do
+    reply("I didn't understand you")
+  end
+
+  on_presence do |status|
+    case status
+    when :available
+      reply("Welcome, #{sender.name}!")
+    when :unavailable
+      reply("Bye bye, #{sender.name}!")
+    end
+  end
+
   desc 'greets the user'
   on /^hello hipbot!$/ do
     reply('hello!')

data/spec/integration/my_hipbot_spec.rb

@@ -20,145 +20,152 @@ describe MyHipbot do
     end
   end
 
+  describe 'presence reactions' do
+    it 'greets joining user', focus: true do
+      subject.should_receive(:send_to_room).with(room, 'Welcome, John Doe!')
+      subject.react_to_presence(sender, :available, room)
+    end
+  end
+
   describe 'replying' do
     it 'should reply to hello' do
-      subject.expects(:send_to_room).with(room, 'hello!')
+      subject.should_receive(:send_to_room).with(room, 'hello!')
       subject.react(sender, room, '@robot hello hipbot!')
     end
 
     it 'should reply with argument' do
-      subject.expects(:send_to_room).with(room, "I know I'm cool")
+      subject.should_receive(:send_to_room).with(room, "I know I'm cool")
       subject.react(sender, room, '@robot you\'re cool, robot')
     end
 
     it 'should reply to global message' do
-      subject.expects(:send_to_room).with(room, 'hello!')
+      subject.should_receive(:send_to_room).with(room, 'hello!')
       subject.react(sender, room, 'hi everyone!')
     end
 
     it 'should respond with default reply' do
-      subject.expects(:send_to_room).with(room, "I didn't understand you")
+      subject.should_receive(:send_to_room).with(room, "I didn't understand you")
       subject.react(sender, room, '@robot blahlblah')
     end
   end
 
   describe '"from" option' do
     it 'reacts to sender from required team' do
-      subject.expects(:send_to_room).with(room, 'restarting')
+      subject.should_receive(:send_to_room).with(room, 'restarting')
       subject.react(sender, room, '@robot restart')
     end
 
     it 'ignores sender when not in team' do
-      subject.expects(:send_to_room).with(room, 'What do you mean, Other Guy?')
+      subject.should_receive(:send_to_room).with(room, 'What do you mean, Other Guy?')
       subject.react(other_sender, room, '@robot restart')
     end
   end
 
   describe '"room" option' do
     it 'reacts in required room' do
-      subject.expects(:send_to_room).with(room, 'deploying')
+      subject.should_receive(:send_to_room).with(room, 'deploying')
       subject.react(sender, room, '@robot deploy')
     end
 
     it 'ignores other rooms' do
-      subject.expects(:send_to_room).with(other_room, "I didn't understand you")
+      subject.should_receive(:send_to_room).with(other_room, "I didn't understand you")
       subject.react(sender, other_room, '@robot deploy')
     end
   end
 
   describe 'room=true' do
     it 'reacts in any room' do
-      subject.expects(:send_to_room).with(room, 'doing room thing')
+      subject.should_receive(:send_to_room).with(room, 'doing room thing')
       subject.react(sender, room, '@robot room thing')
     end
 
     it 'ignores room commands if not in room' do
-      subject.expects(:send_to_user).with(sender, "I didn't understand you")
+      subject.should_receive(:send_to_user).with(sender, "I didn't understand you")
       subject.react(sender, nil, 'room thing')
     end
   end
 
   describe 'room=false' do
     it 'ignores private command in room' do
-      subject.expects(:send_to_room).with(room, "I didn't understand you")
+      subject.should_receive(:send_to_room).with(room, "I didn't understand you")
       subject.react(sender, room, '@robot private thing')
     end
 
     it 'allows private command if not in room' do
-      subject.expects(:send_to_user).with(sender, 'doing private thing')
+      subject.should_receive(:send_to_user).with(sender, 'doing private thing')
       subject.react(sender, nil, 'private thing')
     end
   end
 
   describe 'scope' do
     it 'sets its attributes to every reaction inside' do
-      subject.expects(:send_to_room).with(room, 'doing John Doe thing')
+      subject.should_receive(:send_to_room).with(room, 'doing John Doe thing')
       subject.react(sender, room, '@robot John Doe thing')
     end
 
     it 'does not match other senders' do
-      subject.expects(:send_to_room).with(room, 'What do you mean, Other Guy?')
+      subject.should_receive(:send_to_room).with(room, 'What do you mean, Other Guy?')
       subject.react(other_sender, room, '@robot John Doe thing')
     end
 
     it 'merges params if embedded' do
-      subject.expects(:send_to_room).with(room, 'doing John Doe project thing')
+      subject.should_receive(:send_to_room).with(room, 'doing John Doe project thing')
       subject.react(sender, room, '@robot John Doe project thing')
     end
 
     it 'ignores message from same sander in other room' do
-      subject.expects(:send_to_room).with(other_room, "I didn't understand you")
+      subject.should_receive(:send_to_room).with(other_room, "I didn't understand you")
       subject.react(sender, other_room, '@robot John Doe project thing')
     end
 
     it 'ignores message from other sender in same room' do
-      subject.expects(:send_to_room).with(room, 'What do you mean, Other Guy?')
+      subject.should_receive(:send_to_room).with(room, 'What do you mean, Other Guy?')
       subject.react(other_sender, room, '@robot John Doe project thing')
     end
   end
 
   describe 'custom helpers' do
     it 'should have access to room variable' do
-      subject.expects(:send_to_room).with(room, 'Project: Project 1')
+      subject.should_receive(:send_to_room).with(room, 'Project: Project 1')
       subject.react(sender, room, '@robot tell me the project name')
     end
 
     it 'should have access to message variable' do
-      subject.expects(:send_to_room).with(room, 'you are John')
+      subject.should_receive(:send_to_room).with(room, 'you are John')
       subject.react(sender, room, '@robot tell me my name')
     end
   end
 
   describe 'plugins' do
     it 'should reply to reaction defined in plugin' do
-      subject.expects(:send_to_room).with(room, 'awesome responded')
+      subject.should_receive(:send_to_room).with(room, 'awesome responded')
       subject.react(sender, room, '@robot respond awesome')
     end
 
     it 'should reply to reaction defined in second plugin' do
-      subject.expects(:send_to_room).with(room, 'cool responded')
+      subject.should_receive(:send_to_room).with(room, 'cool responded')
       subject.react(sender, room, '@robot respond cool')
     end
   end
 
   describe 'method reaction' do
     it 'should reply to a method reaction defined in plugin' do
-      subject.expects(:send_to_room).with(room, 'parameter: empty')
+      subject.should_receive(:send_to_room).with(room, 'parameter: empty')
       subject.react(sender, room, '@robot method reaction')
     end
 
     it 'should reply to a method reaction defined in plugin with parameters' do
-      subject.expects(:send_to_room).with(room, 'parameter: method param')
+      subject.should_receive(:send_to_room).with(room, 'parameter: method param')
       subject.react(sender, room, '@robot method reaction method param')
     end
 
     it 'should reply to a scope method reaction defined in plugin' do
-      subject.expects(:send_to_room).with(room, 'scope method reaction')
+      subject.should_receive(:send_to_room).with(room, 'scope method reaction')
       subject.react(sender, room, '@robot scope method reaction')
     end
 
-    it 'should reply to a scope regexp with method reaction defined in plugin', focus: true do
-      subject.expects(:send_to_room).with(room, 'parameter: empty')
+    it 'should reply to a scope regexp with method reaction defined in plugin' do
+      subject.should_receive(:send_to_room).with(room, 'parameter: empty')
       subject.react(sender, room, '@robot scope regexp')
     end
   end