twitchbot 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eb24be58e5d670664da6a08c56cf3007ed3477b08c0d3e73bae57d7ee4bac29
-  data.tar.gz: 1ae2d56adbb8bdd41529888c3abb7d7b9f509147beddedc0fe385e54104c5b73
+  metadata.gz: 4d0c016d500046220ef061dc024c9a98f201c59cc89e9536f09752b3f82df330
+  data.tar.gz: c1228859476211eaf4f8d4b4ac099fd56e21c181474c3a557a68b3daf6790c79
 SHA512:
-  metadata.gz: a1354939320f1d974ab95107db9385e801aebf0f6b3c090d0f6a7d33f9db6c0a17bccd8e94179b6ecf8112d6f0a20623c7d3ce81a74f36c497c7170596dcdb64
-  data.tar.gz: ac3048f9253dcac655ec2a99787057a3ff9e3a8937af159576d11087d784b1a61d2d168fba7d701ff362630eea4294610056bf99e2eb1979bfe27263eceb9b71
+  metadata.gz: 7f7cbee9b6ed3575acc0e9d77b0dbb40c426e6529f9cb829c41bea583793c00d085e26fc399f72c284bb61dea7a166f17be1ca39acff8cca1baaf3745a781010
+  data.tar.gz: a93d6c30bc1d1630b96cf1a92bcbd34d79f5432a868306d08ab9c9e17779496f746bdf01e90783aeccd3eeaef4fc11e545fdcf215629609448c77ce7dd744219

data/lib/twitchbot.rb

@@ -3,3 +3,4 @@ require 'twitchbot/bot'
 require 'twitchbot/plugin'
 require 'twitchbot/message_plugin'
 require 'twitchbot/timed_plugin'
+require 'twitchbot/whisper_plugin'

data/lib/twitchbot/event_handler.rb

@@ -36,7 +36,7 @@ module Twitchbot
 
     # Add a whisper to the specified user to the message queue
     def send_whisper(user, message)
-      @bot.message_queue.push("PRIVMSG jtv :/w #{user} :#{message}")
+      @bot.message_queue.push("PRIVMSG #jtv :/w #{user} #{message}")
     end
 
     # Method that provides a shortcut to grab the first message in an event

data/lib/twitchbot/message.rb

@@ -36,23 +36,26 @@ module Twitchbot
       @target = target
       @payload = payload
 
-      if message?
+      if message? || whisper?
         @payload.slice! 0, 1
         @channel = @handler.bot.channel
-        /bits=(?<bits>\d+)/ =~ @tags
-        @bits = bits.nil? ? 0 : bits.to_i
-        /display-name=(?<display_name>\w+)/ =~ @tags
-        /user-id=(?<user_id>[a-zA-Z0-9\-]+)/ =~ @tags
-        /badges=(?<badges>[a-zA-Z\/,0-9\-]+)/ =~ @tags
-        badges = badges || ''
+        @display_name = @tags[/display-name=(\w+)/, 1]
+        @user_id = @tags[/user-id=(?<user_id>\d+)/, 1]
         /:(?<user>\w+)/ =~ @sender
         if @channel.users.key? user
-          @channel.users[user].update_attributes display_name, user_id, badges
+          @channel.users[user].update_attributes @display_name, @user_id
         else
-          @channel.users[user] = User.new user, display_name, user_id, badges
+          @channel.users[user] = User.new user, @display_name, @user_id
         end
         @user = @channel.users[user]
       end
+
+      if message?
+        /bits=(?<bits>\d+)/ =~ @tags
+        @bits = bits.nil? ? 0 : bits.to_i
+        /badges=(?<badges>[a-zA-Z\/,0-9\-]+)/ =~ @tags
+        @user.update_badges badges || ''
+      end
     end
 
     # Method to determine if the IRC message includes any tags from the +:twitch.tv/tags+ capability
@@ -65,9 +68,29 @@ module Twitchbot
       @command.eql? 'PRIVMSG'.freeze
     end
 
+    # Method to determine if the IRC message is a whisper to the bot
+    def whisper?
+      @command.eql? 'WHISPER'.freeze
+    end
+
     # Method to respond to the IRC message target with a private message
     def respond(message)
-      @handler.bot.message_queue.push("PRIVMSG #{@target} :#{message}")
+      if message?
+        send_channel message
+      end
+      if whisper?
+        send_whisper @user, message
+      end
+    end
+
+    # Method to send a message to the joined [Channel]
+    def send_channel(message)
+      @handler.send_channel message
+    end
+
+    # Method to send a whisper to the specified [User]
+    def send_whisper(user, message)
+      @handler.send_whisper user, message
     end
 
     # Method to determine if the IRC message is a PING challenge

data/lib/twitchbot/message_plugin.rb

@@ -9,6 +9,7 @@ module Twitchbot
     def message(handler)
       handler.messages.each do |message|
         if message.message?
+          # TODO: Extract this block from WhisperPlugin and MessagePlugin
           prefix = handler.bot.command_prefix
           _, _command, arguments = message.payload.partition(
               /#{Regexp.escape prefix}\S+/
@@ -16,7 +17,7 @@ module Twitchbot
           command = _command.delete prefix
           commands = COMMANDS[self.class]
           if !command.nil? && !commands[command].nil?
-            send(commands[command], message, arguments)
+            send(commands[command], message, arguments.lstrip)
           end
         end
       end

data/lib/twitchbot/user.rb

@@ -8,18 +8,26 @@ module Twitchbot
     # @return [Hash] Collection of known badges for the user
     attr_reader :badges
 
-    def initialize(name, display_name = nil, id = nil, badges = nil)
+    def initialize(name, display_name = nil, id = nil)
       @name = name
       @display_name = display_name
       @id = id
-      @badges = badges.nil? ? nil : process_badges(badges)
     end
 
     # Method to update the main attributes of a user
-    def update_attributes(display_name, id, badges)
+    def update_attributes(display_name, id)
       @display_name = display_name
       @user_id = id
-      @badges = process_badges(badges)
+    end
+
+    # Method to process the string representation of badges into a Hash so that
+    # we can query it for specific badges and levels of the badges
+    def update_badges(badge)
+      @badges = {}
+      badge.split(',').each do |_badge|
+        type, value = _badge.split '/'
+        @badges[type] = value.to_i
+      end
     end
 
     # Method to grab the best representation of a user
@@ -27,6 +35,11 @@ module Twitchbot
       @display_name || @name
     end
 
+    # Method to determine if the user is the broadcaster of the channel
+    def streamer?
+      @badges.key? 'broadcaster'
+    end
+
     # Method to determine if the user is a moderator of the channel
     def mod?
       @badges.key? 'moderator'
@@ -62,17 +75,6 @@ module Twitchbot
       @badges.key? 'bits-leader'
     end
 
-    # Method to process the string representation of badges into a Hash so that
-    # we can query it for specific badges and levels of the badges
-    def process_badges(badges)
-      badge = {}
-      badges.split(',').each do |_badge|
-        type, value = _badge.split '/'
-        badge[type] = value.to_i
-      end
-      badge
-    end
-
     def to_s
       name
     end

data/lib/twitchbot/version.rb

@@ -1,3 +1,3 @@
 module Twitchbot
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.freeze
 end

data/lib/twitchbot/whisper_plugin.rb

@@ -0,0 +1,48 @@
+module Twitchbot
+  module WhisperPlugin
+
+    COMMANDS = {}
+
+    # Method that can be overriden to react to the eventmachine +:open+ event
+    def open(handler) end
+
+    def message(handler)
+      handler.messages.each do |message|
+        if message.whisper?
+          # TODO: Extract this block from WhisperPlugin and MessagePlugin
+          prefix = handler.bot.command_prefix
+          _, _command, arguments = message.payload.partition(
+              /#{Regexp.escape prefix}\S+/
+          )
+          command = _command.delete prefix
+          commands = COMMANDS[self.class]
+          if !command.nil? && !commands[command].nil?
+            send(commands[command], message, arguments.lstrip)
+          end
+        end
+      end
+    end
+
+    # Method that can be overriden to react to the eventmachine +:error+ event
+    def error(handler) end
+
+    # Method that can be overriden to react to the eventmachine +:close+ event
+    def close(handler) end
+
+    # Define a class method called register on each class that includes this
+    # module, which allows the user to add methods to the +COMMANDS+ constant
+    #
+    #   def self.register(command:, method:)
+    #     COMMANDS[base] = {} if COMMANDS[base].nil?
+    #     COMMANDS[base][params[:command]] = params[:method]
+    #   end
+    def self.included(klass)
+      klass.instance_eval do
+        define_singleton_method 'register' do |params|
+          COMMANDS[klass] = {} if COMMANDS[klass].nil?
+          COMMANDS[klass][params[:command]] = params[:method]
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitchbot
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Charles Ray Shisler III
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2019-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,6 +106,7 @@ files:
 - lib/twitchbot/timed_plugin.rb
 - lib/twitchbot/user.rb
 - lib/twitchbot/version.rb
+- lib/twitchbot/whisper_plugin.rb
 homepage: https://github.com/craysiii/twitchbot
 licenses:
 - MIT