slack-bot-server 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58eb298f86ae1232eae9487d0fc28c27eb15a9b4
-  data.tar.gz: 7cfe32f6ff625b0e6cee19872378d50021502396
+  metadata.gz: f1086fe2f192f0ea950041f91799d67bc8e7966e
+  data.tar.gz: 85e02d179a2fb1ca62c8064206244fb3da90c197
 SHA512:
-  metadata.gz: 906ea70d84f329a2b4ef0e3968c33dd32892d55a7c3d6db18f6a9d9ba1cfbf3177587f9bf0ae6399e371ffdcbe0312231c18e44f132088140cb9942fcb4219a7
-  data.tar.gz: 963d701368d4038051b42d63b1869831fb3c03163b9bce3737822e2a8df5fbe4c44407851e8c4ebeb4cb0cc21703b2ea67c84d81ee317463403d1005b68605a6
+  metadata.gz: 6c48425cac63a28ffe08a8af43702183b532127307f61807db94088470e6a4d050011fb5c5b732ba10d00ab8eab51736b73b9c98aa7d2e97fbc6fb5d803e6daa
+  data.tar.gz: 3a09cc3baa9e35cf4193a7638627e584b7b7413ea85fe06ed2b9470393fb295890255bd66cdb6bde928946c44df03d873c3fc373f7151a0a1210392d1b212b45

data/CHANGELOG.md

@@ -1,28 +1,42 @@
 ## Unreleased
 
+## 0.4.5
+
+### Added
+- Add `on_slack_event` for adding low-level event callbacks like `team_join` or `presence_changed`
+
+
 ## 0.4.4
 
-### Changes
+### Added
 - Add new bot-private API method `user_message?(data)`, which returns true if the message is some utterance from a user
+
+### Changes
 - Allow replying from the low-level `on(:message)` callback, although caution should be exercised when doing this (i.e. make sure you aren't replying to bot or other low-level API messages!)
 
+
 ## 0.4.3
 
-### Changes
+### Added
 - Add `clear` method to queues
+
+### Changes
 - Upgrate `slack-ruby-client` dependency to latest version
 
+
 ## 0.4.2
 
 ### Changes
 - Re-use error raising from within Slack::Web::Api
 - Prevent bots with the same key as existing bots from being added (@keydunov)
 
+
 ## 0.4.1
 
 ### Changes
 - Fixed detection of RTM-compatible messages
 
+
 ## 0.4.0
 
 ### Added

data/lib/slack_bot_server/bot.rb

@@ -1,3 +1,4 @@
+require 'slack_bot_server/logging'
 require 'slack'
 require 'slack-ruby-client'
 
@@ -31,6 +32,8 @@ require 'slack-ruby-client'
 #   end
 #
 class SlackBotServer::Bot
+  include SlackBotServer::Logging
+  extend SlackBotServer::Logging
 
   # The user ID of the special slack user +SlackBot+
   SLACKBOT_USER_ID = 'USLACKBOT'
@@ -161,8 +164,7 @@ class SlackBotServer::Bot
         @last_received_user_message = data if user_message?(data)
         handle_message(data)
       rescue => e
-        log error: e
-        log backtrace: e.backtrace
+        log_error e
       end
     end
 
@@ -172,6 +174,8 @@ class SlackBotServer::Bot
       run_callbacks(:finish)
     end
 
+    register_low_level_callbacks_on(@client)
+
     @client.start_async
   rescue Slack::Web::Api::Error => e
     raise ConnectionError.new(e.message, e.response)
@@ -329,11 +333,16 @@ class SlackBotServer::Bot
         end
       end
     end
-  end
 
-  # on :start do
-  #   load_channels
-  # end
+    def low_level_callbacks
+      @low_level_callbacks ||= []
+    end
+
+    # Define a callback to use when a low-level slack event is fired
+    def on_slack_event(name, &block)
+      self.low_level_callbacks << [name, block]
+    end
+  end
 
   on :finish do
     start if @running
@@ -359,21 +368,16 @@ class SlackBotServer::Bot
     end
   end
 
-  def log(*args)
-    SlackBotServer.logger.info(log_string(*args))
-  end
-
-  def debug(*args)
-    SlackBotServer.logger.debug(log_string(*args))
-  end
-
-  def log_string(*args)
-    text = if args.length == 1 && args.first.is_a?(String)
-      args.first
-    else
-      args.map { |a| a.is_a?(String) ? a : a.inspect }.join(", ")
+  def register_low_level_callbacks_on(client)
+    self.class.low_level_callbacks.each do |(type, callback)|
+      client.on(type) do |*args|
+        begin
+          callback.call(*args)
+        rescue => e
+          log_error e
+        end
+      end
     end
-    "[BOT/#{bot_user_name}] #{text}"
   end
 
   def is_im_channel?(id)

data/lib/slack_bot_server/logging.rb

@@ -0,0 +1,28 @@
+module SlackBotServer::Logging
+  def log(*args)
+    SlackBotServer.logger.info(log_string(*args))
+  end
+
+  def debug(*args)
+    SlackBotServer.logger.debug(log_string(*args))
+  end
+
+  def log_error(e)
+    SlackBotServer.logger.warn("ERROR: #{e} - #{e.message}")
+    SlackBotServer.logger.warn(e.backtrace.join("\n"))
+  end
+
+  def log_string(*args)
+    text = if args.length == 1 && args.first.is_a?(String)
+      args.first
+    else
+      args.map { |a| a.is_a?(String) ? a : a.inspect }.join(", ")
+    end
+    prefix = if self.respond_to?(:bot_user_name)
+      "[BOT/#{bot_user_name}]"
+    else
+      nil
+    end
+    [prefix, text].join(" ")
+  end
+end

data/lib/slack_bot_server/server.rb

@@ -1,6 +1,7 @@
 require 'slack_bot_server/bot'
 require 'slack_bot_server/simple_bot'
 require 'slack_bot_server/redis_queue'
+require 'slack_bot_server/logging'
 require 'eventmachine'
 
 # Implements a server for running multiple Slack bots. Bots can be
@@ -48,6 +49,8 @@ require 'eventmachine'
 #   itself
 #
 class SlackBotServer::Server
+  include SlackBotServer::Logging
+
   attr_reader :queue
 
   # Creates a new {Server}
@@ -164,15 +167,10 @@ class SlackBotServer::Server
     end
   end
 
-  def log(message)
-    text = message.is_a?(String) ? message : message.inspect
-    SlackBotServer.logger.info(text)
-  end
-
-  def log_error(e)
-    SlackBotServer.logger.warn("Error in server: #{e} - #{e.message}")
-    SlackBotServer.logger.warn(e.backtrace.join("\n"))
-  end
+  # def log(message)
+  #   text = message.is_a?(String) ? message : message.inspect
+  #   SlackBotServer.logger.info(text)
+  # end
 
   def with_bot(key)
     if bot = bot(key)

data/lib/slack_bot_server/version.rb

@@ -1,4 +1,4 @@
 module SlackBotServer
   # The current version of the +SlackBotServer+ framework
-  VERSION = "0.4.4"
+  VERSION = "0.4.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slack-bot-server
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - James Adam
@@ -156,6 +156,7 @@ files:
 - lib/slack_bot_server.rb
 - lib/slack_bot_server/bot.rb
 - lib/slack_bot_server/local_queue.rb
+- lib/slack_bot_server/logging.rb
 - lib/slack_bot_server/redis_queue.rb
 - lib/slack_bot_server/remote_control.rb
 - lib/slack_bot_server/server.rb