slackbot_frd 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8e1ae54ee35f6483bf1a209d5c233dc94e2b937
-  data.tar.gz: c8dbcc68b6a1dfcebb81226c0a16455792acae6b
+  metadata.gz: 5e04887e283e05c9f2dfa317752af3b3afc0aff3
+  data.tar.gz: 50cd078d62ba3fd848fb971b8e8bc3c7e4b462c8
 SHA512:
-  metadata.gz: a180c87abea6a0e14aacd4a280274458cdef7ef224649c2a58b464630d5462f74c0fed7beebd5ea344afeefe2ea87802721fbc2fcd1d9231fba6a2fb5d096c04
-  data.tar.gz: be3640e1231e738f9e5304096745437bb0759880b6726307c274fbfe193995878fc3485b5bc8bffd2873277f39a28681d88e4055eeabf49b6d90fb01679d1786
+  metadata.gz: 8da01ed22e52b72b5fe4f87b3c7c7c561f65e65ed0d4c3214e40e2a585620454d16680aad862ef4f6b35a66b64136397fa29bbf8d6a974fac27366f2cf2b96e6
+  data.tar.gz: 6cee701b7c18747ace4a3732df3d866997df8d84ebb1155e4e99d83a72187a4eccc5eda8659444f7a6572adc0a609963e17a47991cd137e6274ea201eef277f8

data/bin/slackbot-frd

@@ -43,7 +43,7 @@ class SlackbotFrdBin < Thor
     end
   end
 
-  desc "new", "Generate a new slackbot_frd project"
+  desc "new <project-name>", "Generate a new slackbot_frd project"
   long_desc <<-LONGDESC
     new will generate a skeleton for a new slackbot_frd project
   LONGDESC
@@ -86,6 +86,8 @@ class SlackbotFrdBin < Thor
           "botdir" : ".",
           "daemonize" : false,
           "bots" : [],
+          "log_level" : "debug",
+          "log_file" : "my-cool-bot.log",
           "my_bots_config_option" : "<bot-specific-option>"
       }
     CONFIG_FILE_SKELETON
@@ -314,18 +316,17 @@ class SlackbotFrdBin < Thor
       class ExampleBot < SlackbotFrd::Bot
         def add_callbacks(slack_connection)
           # When a user sends a message, echo that message back in reverse
-          slack_connection.on_message do |user, channel, message|
-            slack_connection.send_message(channel, message.reverse)
+          slack_connection.on_message do |user:, channel:, message:, timestamp:|
+            slack_connection.send_message(channel: channel, message: message.reverse)
           end
 
           # When a user joins a channel, greet that user as a bot
-          slack_connection.on_channel_joined do |user, channel|
+          slack_connection.on_channel_joined do |user:, channel:|
             slack_connection.send_message_as_user(
-              channel,
-              ":skull: ohai \#{user}, welcome to #\#{channel}! :ghost:",
-              "Graveyard Greeting Bot",
-              ":graveyard:",
-              true
+              channel: channel,
+              message: ":skull: ohai \#{user}, welcome to #\#{channel}! :ghost:",
+              username: "Graveyard Greeting Bot",
+              emoji: ":graveyard:"
             )
           end
         end

data/lib/slackbot_frd/lib/slack_connection.rb

@@ -91,69 +91,72 @@ module SlackbotFrd
       @on_disconnected_callbacks.push(block)
     end
 
-    def on_message(user = :any, channel = :any, &block)
+    def on_message(user: :any, channel: :any, &block)
       wrap_user_or_channel_lookup_on_callback('on_message', user, channel) do
-        @on_message_callbacks.add(user_name_to_id(user), channel_name_to_id(channel), block)
+        @on_message_callbacks.add(user: user_name_to_id(user), channel: channel_name_to_id(channel), callback: block)
       end
     end
 
-    def on_channel_left(user = :any, channel = :any, &block)
+    def on_channel_left(user: :any, channel: :any, &block)
       wrap_user_or_channel_lookup_on_callback('on_message_channel_left', user, channel) do
-        @on_channel_left_callbacks.add(user_name_to_id(user), channel_name_to_id(channel), block)
+        @on_channel_left_callbacks.add(user: user_name_to_id(user), channel: channel_name_to_id(channel), callback: block)
       end
     end
 
-    def on_channel_joined(user = :any, channel = :any, &block)
+    def on_channel_joined(user: :any, channel: :any, &block)
       wrap_user_or_channel_lookup_on_callback('on_message_channel_joined', user, channel) do
         u = user_name_to_id(user)
         c = channel_name_to_id(channel)
-        @on_channel_joined_callbacks.add(u, c, block)
+        @on_channel_joined_callbacks.add(user: u, channel: c, callback: block)
       end
     end
 
-    def send_message(channel, message)
-      unless @ws
-        log_and_add_to_error_file("Cannot send message '#{message}' as user to channel '#{channel}' because not connected to wss stream")
+    def send_message(channel:, message:, username: nil, avatar_emoji: nil, avatar_url: nil)
+      if username && (avatar_emoji || avatar_url)
+        send_message_as_bot(
+          channel: channel,
+          message: message,
+          username: username,
+          avatar_emoji: avatar_emoji,
+          avatar_url: avatar_url
+        )
+      else
+        send_message_as_user(channel: channel, message: message)
       end
+    end
 
-      SlackbotFrd::Log.debug("#{self.class}: Sending message '#{message}' as user to channel '#{channel}'")
+    def delete_message(channel:, timestamp:)
+      SlackbotFrd::Log.debug("#{self.class}: Deleting message with timestamp '#{timestamp}' from channel '#{channel}'")
 
-      begin
-        resp = @ws.send({
-          id: event_id,
-          type: "message",
-          channel: channel_name_to_id(channel),
-          text: message
-        }.to_json)
+      resp = SlackbotFrd::SlackMethods::ChatDelete.delete(
+        token: @token,
+        channel: channel_name_to_id(channel),
+        timestamp: timestamp
+      )
 
-        SlackbotFrd::Log.debug("#{self.class}: Received response:  #{resp}")
-      rescue SocketError => e
-        log_and_add_to_error_file(socket_error_message(e))
-      end
+      SlackbotFrd::Log.debug("#{self.class}: Received response:  #{resp}")
     end
 
-    def send_message_as_user(channel, message, username, avatar, avatar_is_emoji)
-      SlackbotFrd::Log.debug("#{self.class}: Sending message '#{message}' as user '#{username}' to channel '#{channel}'")
+    def post_reaction(name:, channel: nil, timestamp: nil)
+      SlackbotFrd::Log.debug("#{self.class}: Posting reaction '#{name}' to channel '#{channel}' with timestamp '#{timestamp}'")
 
-      resp = SlackbotFrd::SlackMethods::ChatPostMessage.postMessage(
-        @token,
-        channel_name_to_id(channel),
-        message,
-        username,
-        avatar,
-        avatar_is_emoji
+      resp = SlackbotFrd::SlackMethods::ReactionsAdd.add(
+        token: @token,
+        name: name,
+        channel: channel_name_to_id(channel),
+        timestamp: timestamp
       )
 
       SlackbotFrd::Log.debug("#{self.class}: Received response:  #{resp}")
     end
 
-    def invite_user(user, channel)
+    def invite_user(user: user, channel: channel)
       SlackbotFrd::Log.debug("#{self.class}: Inviting user '#{user}' to channel '#{channel}'")
 
       resp = SlackbotFrd::SlackMethods::ChannelsInvite.invite(
-        @token,
-        user_name_to_id(user),
-        channel_name_to_id(channel),
+        token: @token,
+        user: user_name_to_id(user),
+        channel: channel_name_to_id(channel),
       )
 
       SlackbotFrd::Log.debug("#{self.class}: Received response:  #{resp}")
@@ -220,6 +223,44 @@ module SlackbotFrd
       @channel_name_to_id[nc]
     end
 
+    private
+    def send_message_as_user(channel: channel, message: message)
+      unless @ws
+        log_and_add_to_error_file("Cannot send message '#{message}' as user to channel '#{channel}' because not connected to wss stream")
+      end
+
+      SlackbotFrd::Log.debug("#{self.class}: Sending message '#{message}' as user to channel '#{channel}'")
+
+      begin
+        resp = @ws.send({
+          id: event_id,
+          type: "message",
+          channel: channel_name_to_id(channel),
+          text: message
+        }.to_json)
+
+        SlackbotFrd::Log.debug("#{self.class}: Received response:  #{resp}")
+      rescue SocketError => e
+        log_and_add_to_error_file(socket_error_message(e))
+      end
+    end
+
+    private
+    def send_message_as_bot(channel:, message:, username:, avatar_emoji: nil, avatar_url: nil)
+      SlackbotFrd::Log.debug("#{self.class}: Sending message '#{message}' as bot user '#{username}' to channel '#{channel}'")
+
+      resp = SlackbotFrd::SlackMethods::ChatPostMessage.postMessage(
+        token: @token,
+        channel: channel_name_to_id(channel),
+        message: message,
+        username: username,
+        avatar_emoji: avatar_emoji,
+        avatar_url: avatar_url
+      )
+
+      SlackbotFrd::Log.debug("#{self.class}: Received response:  #{resp}")
+    end
+
     private
     def wrap_user_or_channel_lookup_on_callback(callback_name, user, channel)
       begin
@@ -227,7 +268,7 @@ module SlackbotFrd
       rescue SlackbotFrd::InvalidChannelError => e
         log_and_add_to_error_file("Unable to add #{callback_name} callback for channel '#{channel}'.  Lookup of channel name to ID failed.  Check network connection, and ensure channel exists and is accessible")
       rescue SlackbotFrd::InvalidUserError => e
-        log_and_add_to_error_file("Unable to add #{callback_name} callback for user '#{user}'.  Lookup of channel name to ID failed.  Check network connection and ensure user exists")
+        log_and_add_to_error_file("Unable to add #{callback_name} callback for user '#{user}'.  Lookup of user name to ID failed.  Check network connection and ensure user exists")
       end
     end
 
@@ -268,6 +309,7 @@ module SlackbotFrd
       user = :bot if message["subtype"] == "bot_message"
       channel = message["channel"]
       text = message["text"]
+      ts = message["ts"]
 
       unless user
         SlackbotFrd::Log.warn("#{self.class}: Chat message doesn't include user! message: #{message}")
@@ -279,7 +321,7 @@ module SlackbotFrd
         return
       end
 
-      @on_message_callbacks.where_include_all(user, channel).each do |callback|
+      @on_message_callbacks.where_include_all(user: user, channel: channel).each do |callback|
         # instance_exec allows the user to call send_message and send_message_as_user
         # without prefixing like this: slack_connection.send_message()
         #  
@@ -287,7 +329,12 @@ module SlackbotFrd
         # for now we aren't going to do it
         #
         #instance_exec(user_id_to_name(user), channel_id_to_name(channel), text, &callback)
-        callback.call(user_id_to_name(user), channel_id_to_name(channel), text)
+        callback.call(
+          user: user_id_to_name(user),
+          channel: channel_id_to_name(channel),
+          message: text,
+          timestamp: ts
+        )
       end
     end
 
@@ -297,8 +344,8 @@ module SlackbotFrd
       user = message["user"]
       user = :bot if message["subtype"] == "bot_message"
       channel = message["channel"]
-      @on_channel_joined_callbacks.where_include_all(user, channel).each do |callback|
-        callback.call(user_id_to_name(user), channel_id_to_name(channel))
+      @on_channel_joined_callbacks.where_include_all(user: user, channel: channel).each do |callback|
+        callback.call(user: user_id_to_name(user), channel: channel_id_to_name(channel))
       end
     end
 
@@ -308,8 +355,8 @@ module SlackbotFrd
       user = message["user"]
       user = :bot if message["subtype"] == "bot_message"
       channel = message["channel"]
-      @on_channel_left_callbacks.where_include_all(user, channel).each do |callback|
-        callback.call(user_id_to_name(user), channel_id_to_name(channel))
+      @on_channel_left_callbacks.where_include_all(user: user, channel: channel).each do |callback|
+        callback.call(user: user_id_to_name(user), channel: channel_id_to_name(channel))
       end
     end
 

data/lib/slackbot_frd/lib/user_channel_callbacks.rb

@@ -8,7 +8,7 @@ module SlackbotFrd
       @conditions[:any][:any] = []
     end
 
-    def init(user, channel)
+    def init(user:, channel:)
       unless user
         Log::error("#{self.class}: Invalid user '#{user}'")
         raise InvalidUserError.new
@@ -23,13 +23,13 @@ module SlackbotFrd
       @conditions[user][channel] ||= []
     end
 
-    def add(user, channel, callback)
-      init(user, channel)
+    def add(user:, channel:, callback:)
+      init(user: user, channel: channel)
       @conditions[user][channel].push(callback)
     end
 
-    def where(user, channel)
-      init(user, channel)
+    def where(user:, channel:)
+      init(user: user, channel: channel)
       @conditions[user][channel] || []
     end
 
@@ -37,8 +37,8 @@ module SlackbotFrd
       @conditions[:any][:any] || []
     end
 
-    def where_include_all(user, channel)
-      init(user, channel)
+    def where_include_all(user:, channel:)
+      init(user: user, channel: channel)
       retval = @conditions[:any][:any].dup || []
       retval.concat(@conditions[user][:any] || [])
       retval.concat(@conditions[:any][channel] || [])

data/lib/slackbot_frd/slack_methods/channels_info.rb

@@ -9,11 +9,11 @@ module SlackbotFrd
 
       attr_reader :response
 
-      def self.members(token, channel)
-        ChannelsInfo.new(token, channel).connect.members
+      def self.members(token:, channel:)
+        ChannelsInfo.new(token: token, channel: channel).connect.members
       end
 
-      def initialize(token, channel)
+      def initialize(token:, channel:)
         @token = token
         @channel = channel
       end

data/lib/slackbot_frd/slack_methods/channels_invite.rb

@@ -9,11 +9,11 @@ module SlackbotFrd
 
       attr_reader :response
 
-      def self.invite(token, user, channel)
-        ChannelsInvite.new(token, user, channel).run
+      def self.invite(token:, user:, channel:)
+        ChannelsInvite.new(token: token, user: user, channel: channel).run
       end
 
-      def initialize(token, user, channel)
+      def initialize(token:, user:, channel:)
         @token = token
         @user = user
         @channel = channel

data/lib/slackbot_frd/slack_methods/chat_delete.rb

@@ -0,0 +1,33 @@
+require 'httparty'
+require 'json'
+
+module SlackbotFrd
+  module SlackMethods
+    class ChatDelete
+      include HTTParty
+      base_uri 'https://slack.com/api/chat.delete'
+
+      def self.delete(token:, channel:, timestamp:)
+        r = ChatDelete.new(token: token, channel: channel, timestamp: timestamp)
+        r.delete
+      end
+
+      def initialize(token:, channel:, timestamp:)
+        @token = token
+        @channel = channel
+        @timestamp = timestamp
+      end
+
+      def delete
+        body = {
+          token: @token,
+          channel: @channel,
+          ts: @timestamp,
+        }
+
+        @response = self.class.post('', :body => body)
+        @response
+      end
+    end
+  end
+end

data/lib/slackbot_frd/slack_methods/chat_post_message.rb

@@ -7,18 +7,25 @@ module SlackbotFrd
       include HTTParty
       base_uri 'https://slack.com/api/chat.postMessage'
 
-      def self.postMessage(token, channel, message, username = nil, avatar = nil, avatar_is_emoji = nil)
-        r = ChatPostMessage.new(token, channel, message, username, avatar, avatar_is_emoji)
+      def self.postMessage(token:, channel:, message:, username: nil, avatar_emoji: nil, avatar_url: nil)
+        r = ChatPostMessage.new(
+          token: token,
+          channel: channel,
+          message: message,
+          username: username,
+          avatar_emoji: avatar_emoji,
+          avatar_url: avatar_url
+        )
         r.postMessage
       end
 
-      def initialize(token, channel, message, username = nil, avatar = nil, avatar_is_emoji = nil)
+      def initialize(token:, channel:, message:, username: nil, avatar_emoji: nil, avatar_url: nil)
         @token = token
         @channel = channel
         @message = message
         @username = username
-        @avatar = avatar
-        @avatar_is_emoji = avatar_is_emoji
+        @avatar_emoji = avatar_emoji
+        @avatar_url = avatar_url
       end
 
       def postMessage
@@ -31,8 +38,8 @@ module SlackbotFrd
         if @username
           body.merge!({ username: @username })
 
-          if @avatar_is_emoji
-            body.merge!({ icon_emoji: @avatar })
+          if @avatar_emoji
+            body.merge!({ icon_emoji: @avatar_emoji })
           else
             body.merge!({ icon_url: @avatar })
           end

data/lib/slackbot_frd/slack_methods/reactions_add.rb

@@ -0,0 +1,40 @@
+require 'httparty'
+require 'json'
+
+module SlackbotFrd
+  module SlackMethods
+    class ReactionsAdd
+      include HTTParty
+      base_uri 'https://slack.com/api/reactions.add'
+
+      def self.add(token:, name:, channel: nil, timestamp: nil)
+        r = ReactionsAdd.new(token: token, name: name, channel: channel, timestamp: timestamp)
+        r.add
+      end
+
+      def initialize(token:, name:, channel: nil, timestamp: nil)
+        @token = token
+        @name = name
+        @channel = channel
+        @timestamp = timestamp
+      end
+
+      def add
+        body = {
+          token: @token,
+          name: @name
+        }
+
+        if @channel && @timestamp
+          body.merge!({
+            channel: @channel,
+            timestamp: @timestamp
+          })
+        end
+
+        @response = self.class.post('', :body => body)
+        @response
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slackbot_frd
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Ben Porter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2015-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -175,8 +175,10 @@ files:
 - lib/slackbot_frd/slack_methods/channels_info.rb
 - lib/slackbot_frd/slack_methods/channels_invite.rb
 - lib/slackbot_frd/slack_methods/channels_list.rb
+- lib/slackbot_frd/slack_methods/chat_delete.rb
 - lib/slackbot_frd/slack_methods/chat_post_message.rb
 - lib/slackbot_frd/slack_methods/im_channels_list.rb
+- lib/slackbot_frd/slack_methods/reactions_add.rb
 - lib/slackbot_frd/slack_methods/rtm_start.rb
 - lib/slackbot_frd/slack_methods/users_list.rb
 homepage: https://github.com/FreedomBen/slackbot_frd