twitchbot 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4eb24be58e5d670664da6a08c56cf3007ed3477b08c0d3e73bae57d7ee4bac29
+  data.tar.gz: 1ae2d56adbb8bdd41529888c3abb7d7b9f509147beddedc0fe385e54104c5b73
+SHA512:
+  metadata.gz: a1354939320f1d974ab95107db9385e801aebf0f6b3c090d0f6a7d33f9db6c0a17bccd8e94179b6ecf8112d6f0a20623c7d3ce81a74f36c497c7170596dcdb64
+  data.tar.gz: ac3048f9253dcac655ec2a99787057a3ff9e3a8937af159576d11087d784b1a61d2d168fba7d701ff362630eea4294610056bf99e2eb1979bfe27263eceb9b71

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Charles Ray Shisler III
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# Twitchbot
+
+A plugin-based framework for creating Twitch chat bots, written in Ruby and based on `EventMachine` and `Faye::WebSocket`.
+
+Notes:
+* Plugins are first class citizens
+* Helper functions implemented to gate-keep commands
+* Bot can currently only join one channel (it might stay that way)
+* Read the source until I get all the documentation completed
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twitchbot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twitchbot
+
+## Getting Started
+
+Require Twitchbot
+
+    require 'twitchbot'
+    
+Create Plugins
+
+    # MessagePlugin, which listens for the registered command preceeded by the Bot command_prefix
+    class HiPlugin
+      include Twitchbot::MessagePlugin
+    
+      register command: 'hi', method: :say_hi
+    
+      def say_hi(message, arg)
+        message.respond 'Hello world!'
+      end
+    end
+    
+    # TimedPlugin, which fires off the registered command periodically
+    class ShoutOutPlugin
+      include Twitchbot::TimedPlugin
+    
+      register method: :social, interval: 15 # Time in seconds
+    
+      def social(handler)
+        handler.send_channel('Hello! Check my social media out!')
+      end
+    end
+    
+    # Plugin, which listens for registered commands according to the raw IRC command
+    class PutsPlugin
+        include Twitchbot::Plugin
+        
+        register command: 'PRIVMSG', method: :put_string
+        
+        def put_string(handler)
+            handler.messages.each do |message|
+                puts message
+            end
+        end
+    end
+    
+Create and start `Bot`
+
+    bot = Twitchbot::Bot.new do |bot|
+      bot.username = 'bot_name'
+      bot.password = 'oauth:password'
+      bot.channel = 'channel_name'
+      bot.plugins = [HiPlugin, ShoutOutPlugin, PutsPlugin]
+      bot.debug = true
+      # bot.command_prefix = '$' # Default is '!'
+    end
+    
+    bot.start
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/craysiii/twitchbot.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'twitchbot'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/twitchbot.rb

@@ -0,0 +1,5 @@
+require 'twitchbot/version'
+require 'twitchbot/bot'
+require 'twitchbot/plugin'
+require 'twitchbot/message_plugin'
+require 'twitchbot/timed_plugin'

data/lib/twitchbot/bot.rb

@@ -0,0 +1,74 @@
+require 'eventmachine'
+require 'faye/websocket'
+
+require_relative 'event_handler'
+require_relative 'channel'
+require_relative 'plugin/debug_plugin'
+require_relative 'plugin/auth_plugin'
+require_relative 'plugin/ping_plugin'
+require_relative 'plugin/channel_plugin'
+require_relative 'plugin/message_queue_plugin'
+
+module Twitchbot
+  # Main Bot class that we pass all bot account information to, as well as any
+  # plugins that should be used
+  class Bot
+    # @return [String] Username of the bot account
+    attr_accessor :username
+    # @return [String] Password of the bot account
+    attr_accessor :password
+    # @return [Channel] The channel that the bot is connected to
+    attr_accessor :channel
+    # @return [Array] The plugins that are in use by the bot
+    attr_accessor :plugins
+    # @return [Boolean] Whether the bot should display debug info to STDOUT
+    attr_accessor :debug
+    # @return [Array] The array of messages that are to be sent to the server
+    attr_accessor :message_queue
+    # @return [String] The prefix to use when defining and parsing commands e.g. +!+
+    attr_accessor :command_prefix
+
+    # The connection URL for Twitch
+    DEFAULT_URL = 'wss://irc-ws.chat.twitch.tv'.freeze
+    # The built-in plugins to be used
+    DEFAULT_PLUGINS = [AuthPlugin,
+                       PingPlugin,
+                       ChannelPlugin,
+                       MessageQueuePlugin,
+                       DebugPlugin].freeze
+    # The events that eventmachine  dispatches to any plugins in use
+    DEFAULT_EVENTS = %i[error close open message].freeze
+
+    # Create a new Bot instance, passing a block to set the necessary
+    # attributes to have the bot function
+    def initialize
+      @username = ''
+      @password = ''
+      @channel = ''
+      @plugins = []
+      @message_queue = Queue.new
+      @command_prefix = '!'
+
+      yield self
+
+      @channel = Channel.new(@channel)
+    end
+
+    # Start the event loop, initiate the websocket client, and register the
+    # plugins with eventmachine
+    def start
+      EM.run do
+        connection = Faye::WebSocket::Client.new DEFAULT_URL
+        plugins = (@plugins << DEFAULT_PLUGINS).flatten!.reverse!.map! &:new
+        DEFAULT_EVENTS.each do |default_event|
+          connection.on(default_event) do |em_event|
+            handler = EventHandler.new em_event, connection, self
+            plugins.each do |plugin|
+              plugin.send(default_event, handler)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twitchbot/channel.rb

@@ -0,0 +1,22 @@
+module Twitchbot
+  # Class responsible for keeping track of channel attributes such as channel
+  # state and users in the channel
+  #
+  # TODO: Implement channel states e.g. r9k, emote-only, sub-only, slow
+  # TODO: Capture channel id from tags
+  class Channel
+    # @return [String] Name of the channel we have joined
+    attr_reader :name
+    # @return [Hash] Mapping of user objects according to their username
+    attr_accessor :users
+
+    def initialize(name)
+      @name = name
+      @users = {}
+    end
+  end
+
+  def to_s
+    @name
+  end
+end

data/lib/twitchbot/event_handler.rb

@@ -0,0 +1,50 @@
+require_relative 'message'
+
+module Twitchbot
+  # Class responsible for handling the eventmachine event that is provided
+  # whenever an event is fired
+  class EventHandler
+    # @return [Bot] The bot that the channel is a member of
+    attr_reader :bot
+    # @return [Array] The different messages received
+    attr_reader :messages
+    # @return [Faye::WebSocket::Client] The WebSocket client instance
+    attr_reader :connection
+
+    def initialize(event, connection, bot)
+      @connection = connection
+      @bot = bot
+
+      if event.respond_to? :data
+        @chunks = event.data.split "\n"
+        @messages = []
+        @chunks.each do |chunk|
+          @messages << Message.new(self, chunk.chomp)
+        end
+      end
+    end
+
+    # Add a raw message to the message queue
+    def send_raw(message)
+      @bot.message_queue.push(message)
+    end
+
+    # Add a formatted channel message to the message queue
+    def send_channel(message)
+      @bot.message_queue.push("PRIVMSG ##{bot.channel.name} :#{message}")
+    end
+
+    # 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}")
+    end
+
+    # Method that provides a shortcut to grab the first message in an event
+    # handler. We can typically use this after authenticating, but there is no
+    # guarantee that twitch will not send multiple 'messages' in a single
+    # +:message+ event
+    def message
+      @messages.first
+    end
+  end
+end

data/lib/twitchbot/message.rb

@@ -0,0 +1,78 @@
+require_relative 'user'
+
+module Twitchbot
+  # Class responsible for parsing messages created in [EventHandler]
+  #
+  # TODO: Clean this up because its ugly
+  # TODO: Parse message-id
+  class Message
+    # @return [Integer] Number of bits that have been included in a message
+    attr_reader :bits
+    # @return [User] User that the message was sent by
+    attr_reader :user
+    # @return [Channel] Channel that the message was sent to
+    attr_reader :channel
+    # @return [String] IRC command of the raw IRC message
+    attr_reader :command
+    # @return [String] Raw IRC message received
+    attr_reader :raw
+    # @return [String] Sender of the IRC message
+    attr_reader :sender
+    # @return [String] Target of the IRC message
+    attr_reader :target
+    # @return [String] Content of the IRC message
+    attr_reader :payload
+
+    def initialize(handler, raw_message)
+      @handler = handler
+      @raw = raw_message
+      msg = @raw.dup
+      @tags = msg.slice! /^\S+/ if tagged?
+
+      msg.lstrip!
+      /^(?<sender>:\S+) (?<command>\S+)( (?<target>\S+))?( (?<payload>.+))?$/ =~ msg
+      @sender = sender
+      @command = command
+      @target = target
+      @payload = payload
+
+      if message?
+        @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 || ''
+        /:(?<user>\w+)/ =~ @sender
+        if @channel.users.key? user
+          @channel.users[user].update_attributes display_name, user_id, badges
+        else
+          @channel.users[user] = User.new user, display_name, user_id, badges
+        end
+        @user = @channel.users[user]
+      end
+    end
+
+    # Method to determine if the IRC message includes any tags from the +:twitch.tv/tags+ capability
+    def tagged?
+      @raw.start_with? '@'
+    end
+
+    # Method to determine if the IRC message is an actual message to the [Channel] by a [User]
+    def message?
+      @command.eql? 'PRIVMSG'.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}")
+    end
+
+    # Method to determine if the IRC message is a PING challenge
+    def ping?
+      @raw.start_with? 'PING'
+    end
+  end
+end

data/lib/twitchbot/message_plugin.rb

@@ -0,0 +1,47 @@
+module Twitchbot
+  module MessagePlugin
+
+    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.message?
+          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)
+          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

data/lib/twitchbot/plugin.rb

@@ -0,0 +1,55 @@
+module Twitchbot
+  # Base Plugin module that listens for IRC commands and calls the associated
+  # method of the class that includes it
+  module Plugin
+
+    # The commands that are registered to this base module via classes that
+    # include it
+    #
+    # Example state during runtime:
+    #   { AuthPlugin: { '376': :request_caps }, ChannelPlugin: { 'CAP': :join_channel, 'JOIN': :process_join, 'PART': :process_part } }
+    COMMANDS = {}
+
+    # Method that can be overriden to react to the eventmachine +:open+ event
+    def open(handler) end
+
+    # Method that reacts to the eventmachine +:message+ event and processes each
+    # message in the {EventHandler}, calling the appropriate method if available.
+    #
+    # It is not recommended to override this method unless you plan on handling
+    # all logic for reacting to methods yourself.
+    def message(handler)
+      handler.messages.each do |message|
+        command = message&.command
+        # Grab all registered methods of the including class
+        commands = COMMANDS[self.class]
+        if !command.nil? && !commands[command].nil?
+          # Call the including class method and pass the EventHandler to it
+          send(commands[command], handler)
+        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

data/lib/twitchbot/plugin/auth_plugin.rb

@@ -0,0 +1,37 @@
+require_relative '../plugin'
+
+module Twitchbot
+  # Plugin to handle authenticating the bot account and authorizing the use of
+  # all available Twitch IRCv3 capabilities
+  class AuthPlugin
+    include Twitchbot::Plugin
+
+    # The capabilities available to request
+    CAPABILITIES = %w(
+                      twitch.tv/tags
+                      twitch.tv/commands
+                      twitch.tv/membership
+                   ).freeze
+
+    # Send bot account credentials after the connection has opened
+    def open(handler)
+      handler.send_raw "PASS #{handler.bot.password}"
+      handler.send_raw "NICK #{handler.bot.username}"
+    end
+
+    register command: '376', method: :request_caps
+    # Listen for the last message of a successful authentication attempt and
+    # request capabilities
+    #
+    #   > :tmi.twitch.tv 001 bot :Welcome, GLHF!
+    #   > :tmi.twitch.tv 002 bot :Your host is tmi.twitch.tv
+    #   > :tmi.twitch.tv 003 bot :This server is rather new
+    #   > :tmi.twitch.tv 004 bot :-
+    #   > :tmi.twitch.tv 375 bot :-
+    #   > :tmi.twitch.tv 372 bot :You are in a maze of twisty passages, all alike.
+    #   > :tmi.twitch.tv 376 bot :>
+    def request_caps(handler)
+      handler.send_raw "CAP REQ :#{CAPABILITIES.join ' '}"
+    end
+  end
+end

data/lib/twitchbot/plugin/channel_plugin.rb

@@ -0,0 +1,51 @@
+require_relative '../plugin'
+require_relative '../user'
+
+module Twitchbot
+  # Plugin to handle joining the specified channel, as well as maintaining a
+  # list of users who have joined or left the channel
+  #
+  # TODO: Handle 353 and 366 (NAMES list)
+  class ChannelPlugin
+    include Twitchbot::Plugin
+
+    register command: 'CAP', method: :join_channel
+    # Listen for the response from AuthPlugin#request_caps and request to join
+    # the channel
+    #
+    #   > :tmi.twitch.tv CAP * ACK :twitch.tv/tags twitch.tv/commands twitch.tv/membership
+    def join_channel(handler)
+      handler.send_raw "JOIN ##{handler.bot.channel.name}"
+    end
+
+    register command: 'JOIN', method: :process_join
+    # Listen for any JOIN commands and add the user to the channel user list
+    #
+    #   > :<user>!<user>@<user>.tmi.twitch.tv JOIN #<channel>
+    def process_join(handler)
+      channel = handler.bot.channel
+      handler.messages.each do |message|
+        /:(?<sender>\w+)/ =~ message.raw
+        unless channel.users.key? sender
+          channel.users[sender] = User.new sender
+        end
+      end
+    end
+
+    register command: 'PART', method: :process_part
+    # Listen for any PART commands and remove the user from the channel user
+    # list
+    #
+    #   > :<user>!<user>@<user>.tmi.twitch.tv PART #<channel>
+    def process_part(handler)
+      channel = handler.bot.channel
+      handler.messages.each do |message|
+        /:(?<sender>\w+)/ =~ message.raw
+        if channel.users.key? sender
+          channel.users.delete sender
+        end
+      end
+    end
+  end
+end
+

data/lib/twitchbot/plugin/debug_plugin.rb

@@ -0,0 +1,34 @@
+require_relative '../plugin'
+
+module Twitchbot
+  # Plugin to handle displaying debug information such as raw messages received
+  # as well as connection events e.g. open, close, error
+  class DebugPlugin
+    include Twitchbot::Plugin
+
+    # Display to the user that the connection has been opened
+    def open(handler)
+      puts '! Connection established' if handler.bot.debug
+    end
+
+    # Display to the user any raw messages that have been received from the
+    # server
+    def message(handler)
+      if handler.bot.debug
+        handler.messages.each do |line|
+          puts "> #{line.raw}"
+        end
+      end
+    end
+
+    # Display to the user that the connection has encountered an error
+    def error(handler)
+      puts '! Error occurred' if handler.bot.debug
+    end
+
+    # Display to the user that the connection has been closed
+    def close(handler)
+      puts '! Connection closed' if handler.bot.debug
+    end
+  end
+end

data/lib/twitchbot/plugin/message_queue_plugin.rb

@@ -0,0 +1,24 @@
+require_relative '../timed_plugin'
+
+module Twitchbot
+  # Plugin to handle sending messages to the server that have been queued from
+  # any plugins running.
+  #
+  # TODO: Implement different levels of rate limiting according to bot status e.g. :mod, :verified, :trusted
+  class MessageQueuePlugin
+    include Twitchbot::TimedPlugin
+
+    # The most privileged bot can only send 7200 messages every 30 seconds
+    register method: :send_message, interval: (30 / 7200)
+    # Pull a message from the message queue if any are available and send to the
+    # server
+    def send_message(handler)
+      queue = handler.bot.message_queue
+      unless queue.empty?
+        message = queue.pop
+        puts "< #{message}" if handler.bot.debug
+        handler.connection.send message
+      end
+    end
+  end
+end

data/lib/twitchbot/plugin/ping_plugin.rb

@@ -0,0 +1,16 @@
+require_relative '../plugin'
+
+module Twitchbot
+  # Plugin to handle any PING messages from the server and keep the connection
+  # alive
+  class PingPlugin
+    include Twitchbot::Plugin
+
+    # Listen for any PING messages and respond with PONG
+    #
+    #   > PING :tmi.twitch.tv
+    def message(handler)
+      handler.send_raw('PONG :tmi.twitch.tv') if handler.message.ping?
+    end
+  end
+end

data/lib/twitchbot/timed_plugin.rb

@@ -0,0 +1,47 @@
+require 'eventmachine'
+
+module Twitchbot
+  # Base Plugin module that registers methods that should be called periodically
+  module TimedPlugin
+
+    COMMANDS = {}
+
+    # Method that reacts to the eventmachine +:open+ event and creates a new
+    # eventmachine periodic timer for each plugin of this type
+    #
+    # It is not recommended to override this method unless you plan on handling
+    # all logic for managing timed plugins yourself
+    def open(handler)
+      COMMANDS[self.class].each do |command, interval|
+        EM::PeriodicTimer.new(interval) do
+          send(command, handler)
+        end
+      end
+    end
+
+    # Method that can be overriden to react to the eventmachine +:message+ event
+    def message(event) end
+
+    # Method that can be overriden to react to the eventmachine +:error+ event
+    def error(event) end
+
+    # Method that can be overriden to react to the eventmachine +:close+ event
+    def close(event) 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[:method]] = params[:interval]
+        end
+      end
+    end
+  end
+end

data/lib/twitchbot/user.rb

@@ -0,0 +1,80 @@
+module Twitchbot
+  # Class responsible for keeping track of a user attributes such as their
+  # display name, id, any badges they have, and implementing helper functions
+  # to determine if different qualities of the user
+  class User
+    # @return [String] Server ID for the user
+    attr_reader :id
+    # @return [Hash] Collection of known badges for the user
+    attr_reader :badges
+
+    def initialize(name, display_name = nil, id = nil, badges = 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)
+      @display_name = display_name
+      @user_id = id
+      @badges = process_badges(badges)
+    end
+
+    # Method to grab the best representation of a user
+    def name
+      @display_name || @name
+    end
+
+    # Method to determine if the user is a moderator of the channel
+    def mod?
+      @badges.key? 'moderator'
+    end
+
+    # Method to determine if the user is a subscriber to the channel
+    def sub?
+      @badges.key? 'subscriber'
+    end
+
+    # Method to determine if the user has Twitch Prime
+    def prime?
+      @badges.key? 'premium'
+    end
+
+    # Method to determine if the user has ever donated to the channel
+    def donator?
+      @badges.key? 'bits'
+    end
+
+    # Method to determine if the user is a channel founder
+    def founder?
+      @badges.key? 'founder'
+    end
+
+    # Method to determine if the user is on the leaderboard for subscriber gifts
+    def sub_gift_leader?
+      @badges.key? 'sub-gift-leader'
+    end
+
+    # Method to determine if the user is on the leaderboard for bit gifts
+    def bits_leader?
+      @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
+  end
+end

data/lib/twitchbot/version.rb

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

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: twitchbot
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Charles Ray Shisler III
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.7
+description: 
+email:
+- charles@cray.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- lib/twitchbot.rb
+- lib/twitchbot/bot.rb
+- lib/twitchbot/channel.rb
+- lib/twitchbot/event_handler.rb
+- lib/twitchbot/message.rb
+- lib/twitchbot/message_plugin.rb
+- lib/twitchbot/plugin.rb
+- lib/twitchbot/plugin/auth_plugin.rb
+- lib/twitchbot/plugin/channel_plugin.rb
+- lib/twitchbot/plugin/debug_plugin.rb
+- lib/twitchbot/plugin/message_queue_plugin.rb
+- lib/twitchbot/plugin/ping_plugin.rb
+- lib/twitchbot/timed_plugin.rb
+- lib/twitchbot/user.rb
+- lib/twitchbot/version.rb
+homepage: https://github.com/craysiii/twitchbot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A framework for creating Twitch.tv chat bots
+test_files: []