twitch-bot 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a10dd280ea4e2cf20e4d4066f119b13622aae30e7d03f9bd3c6407113b05e5b8
-  data.tar.gz: 58c80ab7b5c89b67e317986713e854d4797048bca8d5cde5c11da2966022a54f
+  metadata.gz: b2e0942b8b6cf90e70cfec766be2664cf708f33b849bb2b59c5cc546f202e947
+  data.tar.gz: 54af782c020710290308fe279e10d52dd5bd6dc088254ae997c257854c53f9e2
 SHA512:
-  metadata.gz: c8c987740eff97e5b02e8b0b3a9c996d43948de76cedfe3ba83464c9115f025b81691f0de167cdaa91a82a4499d5c1a88ac5d926d1260f7a76b7ea280b7b9d02
-  data.tar.gz: 00a30a330696adbbf506fc4858b52a8e1cb4670ad56a49606433ad05d185868f62bed7ca4e09b0758a40d8817cd513ce59c10cd099e979b64fbf04209eb707b4
+  metadata.gz: 833f91e3d01dd7b2c5fd894e026c5a62155350146df9d7e80172fc68c99961f7e6986cb4b03f53e76785d53ddbcb70dcd414b1224d03d8b50a56b0fb525fcae2
+  data.tar.gz: 5e8bae84a2ab043e4aabb70206bb93eaf163e4bdd7711c7dde4d3977bd4100ddcff2bba905fcd68ca7ed81f5976a3346e8b42372b0c6a40f07cf31d965325bb8

data/.gitignore

@@ -13,3 +13,6 @@
 *.o
 *.a
 mkmf.log
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --require spec_helper
+--format doc

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog Twitch::Bot
+
+## v2.0.0
+
+* [BREAKING] The standard text message class is now named
+`Twitch::Bot::Message::UserMessage` and uses the type symbol `:user_message`. It has added methods to handle bot commands.
+* [CHANGED] Major restructuring of both class hierarchy and class responsibilities.
+
+## v1.0.0 Initial release
+
+This is the first release of `Twitch::Bot`, a fork and evolution of the `Twitch::Chat` gem. Its goal is to become a cleanly designed framework for building Twitch chat bots.

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Pavel Astraukh
+Copyright (c) 2014 Pavel Astraukh, 2020 Jochen Lillich
 
 MIT License
 

data/README.md

@@ -4,6 +4,8 @@
 
 This gem is based on the `twitch-chat` gem by https://github.com/EnotPoloskun.
 
+_As of April 2020, this gem is under heavy development. I've created it to develop my own Twitch chat bot and will add more functionality. Feel free to add issues with suggestions and feature requests!_
+
 ## Installation
 
 Add this line to your application's `Gemfile`:

data/lib/twitch/bot/client.rb

@@ -140,8 +140,8 @@ module Twitch
         log_data = data.gsub(/(PASS oauth:)(\w+)/) do
           "#{Regexp.last_match(1)}#{'*' * Regexp.last_match(2).size}"
         end
+        logger.debug "< #{log_data}"
 
-        logger.info "< #{log_data}"
         socket.puts(data)
       end
 
@@ -186,7 +186,7 @@ module Twitch
         @input_thread = Thread.start do
           while running
             line = read_socket
-            logger.info "> #{line}"
+            logger.debug "> #{line}"
             irc_message = IrcMessage.new(line)
             trigger(Twitch::Bot::MessageParser.new(irc_message).message)
           end

data/lib/twitch/bot/message/user_message.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Twitch
+  module Bot
+    module Message
+      # This class stores the details of a user's chat message.
+      class UserMessage < Base
+        attr_reader :text, :user
+
+        def initialize(text:, user:)
+          @text = text
+          @user = user
+          @type = :user_message
+        end
+
+        def command_name?(check_command)
+          command == check_command
+        end
+
+        def command?
+          !(command.nil? || command.empty?)
+        end
+
+        def command
+          first_word.match(/^!(\w+)/) do |match|
+            match.captures&.first
+          end
+        end
+
+        def command_args
+          text_words.tap(&:shift)
+        end
+
+        private
+
+        def text_words
+          text.split(/\s+/)
+        end
+
+        def first_word
+          text_words.first
+        end
+      end
+    end
+  end
+end

data/lib/twitch/bot/message.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Twitch
+  module Bot
+    module Message
+      # This class is the abstract base class for IRC events.
+      class Base < Twitch::Bot::Event
+        def initialize(_message)
+          @type = :unknown
+        end
+      end
+
+      # This class represents an event that is not supported.
+      class NotSupported < Base
+        attr_reader :message
+
+        def initialize(message)
+          @message = message
+          @type = :not_supported
+        end
+      end
+
+      # This class stores the details of a Ping event.
+      class Ping < Base
+        attr_reader :hostname
+
+        def initialize(hostname:)
+          @hostname = hostname
+          @type = :ping
+        end
+      end
+
+      # This class stores the details of a Mode event.
+      class Mode < Base
+        attr_reader :user, :mode
+
+        def initialize(user:, mode:)
+          @user = user
+          @mode = mode
+          @type = :mode
+        end
+      end
+
+      # This class stores the details of an Authenticated event.
+      class Authenticated < Base
+        def initialize
+          @type = :authenticated
+        end
+      end
+
+      # This class stores the details of a Join event.
+      class Join < Base
+        def initialize
+          @type = :join
+        end
+      end
+
+      # This class stores the details of a Subscription event.
+      class Subscription < Base
+        attr_reader :user
+
+        def initialize(user:)
+          @user = user
+          @type = :subscription
+        end
+      end
+
+      # This class stores the details of a LoginFailed event.
+      class LoginFailed < Base
+        attr_reader :user
+
+        def initialize(user:)
+          @user = user
+          @type = :login_failed
+        end
+      end
+
+      # This class stores the details of a SlowMode event.
+      class SlowMode < Base
+        attr_reader :status, :channel
+
+        def initialize(status:, channel:)
+          @status = status
+          @channel = channel
+          @type = :slow_mode
+        end
+
+        def enabled?
+          status.to_i.positive?
+        end
+      end
+
+      # This class stores the details of a FollowersOnlyMode event.
+      class FollowersOnlyMode < Base
+        attr_reader :status
+
+        def initialize(status:)
+          @status = status
+          @type = :followers_only_mode
+        end
+      end
+
+      # This class stores the details of a SubsOnlyMode event.
+      class SubsOnlyMode < Base
+        attr_reader :status, :channel
+
+        def initialize(status:, channel:)
+          @status = status
+          @channel = channel
+          @type = :subs_only_mode
+        end
+      end
+
+      # This class stores the details of a R9kMode event.
+      class R9kMode < Base
+        attr_reader :status, :channel
+
+        def initialize(status:, channel:)
+          @status = status
+          @channel = channel
+          @type = :r9k_mode
+        end
+      end
+    end
+  end
+end
+
+require_relative "message/user_message"

data/lib/twitch/bot/message_parser.rb

@@ -30,7 +30,7 @@ module Twitch
         if parser
           parser.new(irc_message).call
         else
-          NotSupportedMessage.new(irc_message)
+          Message::NotSupported.new(irc_message)
         end
       end
     end
@@ -47,43 +47,53 @@ module Twitch
     # Parses a PING IRC command
     class PingCommandParser < CommandParser
       def call
-        PingMessage.new(message)
+        Message::Ping.new(hostname: message.params.last)
       end
     end
 
     # Parses a PRIVMSG IRC command
     class PrivMsgCommandParser < CommandParser
       def call
-        if message.user == "twitchnotify"
-          if message.text.match?(/just subscribed!/)
-            SubscriptionMessage.new(message)
+        user = message.user
+        text = message.text
+        if user == "twitchnotify"
+          if text.match?(/just subscribed!/)
+            Message::Subscription.new(
+              user: message.params.last.split(" ").first,
+            )
           else
-            NotSupportedMessage.new(message)
+            Message::NotSupported.new(message)
           end
         else
-          ChatMessageMessage.new(message)
+          Message::UserMessage.new(text: text, user: user)
         end
       end
     end
 
     # Parses a MODE IRC command
     class ModeCommandParser < CommandParser
+      MODE_CHANGE = {
+        "-o" => :remove_moderator,
+        "+o" => :add_moderator,
+      }.freeze
+
       def call
-        ModeMessage.new(message)
+        params = message.params
+        Message::Mode.new(user: params.last, mode: MODE_CHANGE[params[1]])
       end
     end
 
     # Parses a 372 IRC status code/command.
     class AuthenticatedCommandParser < CommandParser
       def call
-        AuthenticatedMessage.new(message)
+        Message::Authenticated.new
       end
     end
 
     # Parses a 366 IRC status code/command.
     class JoinCommandParser < CommandParser
       def call
-        JoinMessage.new(message)
+        Message::Join.new
       end
     end
 
@@ -91,19 +101,54 @@ module Twitch
     class RoomStateCommandParser < CommandParser
       def call
         roomstate_tags = {
-          "slow" => SlowModeMessage,
-          "followers-only" => FollowersOnlyModeMessage,
-          "subs-only" => SubsOnlyModeMessage,
-          "r9k" => R9kModeMessage,
+          "slow" => SlowModeParser,
+          "followers-only" => FollowersOnlyModeParser,
+          "subs-only" => SubsOnlyModeParser,
+          "r9k" => R9kModeParser,
         }
 
-        roomstate_tags.each do |tag, event|
+        roomstate_tags.each do |tag, parser|
           if message.tags.include?(tag)
-            return event.new(message)
+            return parser.new(message).call
           end
         end
 
-        NotSupportedMessage.new(message)
+        Message::NotSupported.new(message)
+      end
+    end
+
+    class SlowModeParser < CommandParser
+      def call
+        Message::SlowMode.new(
+          status: message.tags["slow"],
+          channel: message.channel,
+        )
+      end
+    end
+
+    class FollowersOnlyModeParser < CommandParser
+      def call
+        Message::FollowersOnlyMode.new(
+          status: message.tags["followers-only"],
+        )
+      end
+    end
+
+    class SubsOnlyModeParser < CommandParser
+      def call
+        Message::SubsOnlyMode.new(
+          status: message.tags["subs-only"],
+          channel: message.channel,
+        )
+      end
+    end
+
+    class R9kModeParser < CommandParser
+      def call
+        Message::R9kMode.new(
+          status: message.tags["r9k"],
+          channel: message.channel,
+        )
       end
     end
 
@@ -111,9 +156,9 @@ module Twitch
     class NoticeCommandParser < CommandParser
       def call
         if message.params.last.match?(/Login authentication failed/)
-          LoginFailedMessage.new(message)
+          Message::LoginFailed.new(user: message.user)
         else
-          NotSupportedMessage.new(message)
+          Message::NotSupported.new(message)
         end
       end
     end

data/lib/twitch/bot/version.rb

@@ -2,6 +2,6 @@
 
 module Twitch
   module Bot
-    VERSION = "1.0.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/twitch/bot.rb

@@ -3,7 +3,7 @@
 require_relative "bot/version"
 require_relative "bot/event"
 require_relative "bot/event_handler"
-require_relative "bot/twitch_message"
+require_relative "bot/message"
 require_relative "bot/irc_message"
 require_relative "bot/message_parser"
 require_relative "bot/channel"

data/spec/spec_helper.rb

@@ -1,4 +1,18 @@
 # frozen_string_literal: true
 
+require "bundler/setup"
+require "rspec/core"
 require "pry-byebug"
 require_relative "../lib/twitch/bot"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/twitch/bot/client_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Twitch::Bot::Client do
+RSpec.describe Twitch::Bot::Client do
   let!(:client) do
     connection = Twitch::Bot::Connection.new(
       nickname: "test", password: "test",

data/spec/twitch/bot/message/user_message_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+RSpec.describe Twitch::Bot::Message::UserMessage do
+  it "recognizes a bot command" do
+    message = described_class.new(
+      text: "!command argument1",
+      user: "tester",
+    )
+
+    expect(message.command?).to be true
+  end
+
+  it "recognizes a specific bot command" do
+    message = described_class.new(
+      text: "!command argument1",
+      user: "tester",
+    )
+
+    expect(message.command_name?("command")).to be true
+  end
+
+  it "does not recognize normal text as a command" do
+    message = described_class.new(
+      text: "nocommand here",
+      user: "tester",
+    )
+
+    binding.pry
+    expect(message.command?).to be false
+  end
+
+  it "does not mistake text for a command" do
+    message = described_class.new(
+      text: "nocommand here",
+      user: "tester",
+    )
+
+    expect(message.command_name?("nocommand")).to be false
+  end
+
+  it "parses a bot command" do
+    message = described_class.new(
+      text: "!command argument1",
+      user: "tester",
+    )
+
+    expect(message.command).to eq "command"
+  end
+
+  it "does not return a command for normal text" do
+    message = described_class.new(
+      text: "nocommand here",
+      user: "tester",
+    )
+
+    expect(message.command).to be nil
+  end
+end

data/spec/twitch/bot/message_parser_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Twitch::Bot::MessageParser do
+RSpec.describe Twitch::Bot::MessageParser do
   context "when we receive a PRIVMSG message" do
     it "parses a chat message event" do
       irc_message = Twitch::Bot::IrcMessage.new(<<~RAW)
@@ -9,7 +9,7 @@ describe Twitch::Bot::MessageParser do
 
       event = described_class.new(irc_message).message
 
-      expect(event.type).to eq :chat_message
+      expect(event.type).to eq :user_message
       expect(event.text).to eq "BibleThump"
       expect(event.user).to eq "enotpoloskun"
     end
@@ -115,7 +115,6 @@ describe Twitch::Bot::MessageParser do
 
     event = described_class.new(irc_message).message
 
-    expect(event.user).to eq nil
     expect(event.type).to eq :ping
     expect(event.hostname).to eq host
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitch-bot
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jochen Lillich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-13 00:00:00.000000000 Z
+date: 2020-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -179,6 +179,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".vscode/launch.json"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -192,11 +193,13 @@ files:
 - lib/twitch/bot/event.rb
 - lib/twitch/bot/event_handler.rb
 - lib/twitch/bot/irc_message.rb
+- lib/twitch/bot/message.rb
+- lib/twitch/bot/message/user_message.rb
 - lib/twitch/bot/message_parser.rb
-- lib/twitch/bot/twitch_message.rb
 - lib/twitch/bot/version.rb
 - spec/spec_helper.rb
 - spec/twitch/bot/client_spec.rb
+- spec/twitch/bot/message/user_message_spec.rb
 - spec/twitch/bot/message_parser_spec.rb
 - twitch-bot.gemspec
 homepage: https://github.com/geewiz/twitch-bot
@@ -226,4 +229,5 @@ summary: twitch-bot is a Twitch chat client that uses Twitch IRC that can be use
 test_files:
 - spec/spec_helper.rb
 - spec/twitch/bot/client_spec.rb
+- spec/twitch/bot/message/user_message_spec.rb
 - spec/twitch/bot/message_parser_spec.rb

data/lib/twitch/bot/twitch_message.rb

@@ -1,147 +0,0 @@
-# frozen_string_literal: true
-
-# TODO: Use namespace
-
-module Twitch
-  module Bot
-    # This class is the abstract base class for IRC events.
-    class TwitchMessage < Twitch::Bot::Event
-      def initialize(_message)
-        @type = :unknown
-      end
-    end
-
-    # This class represents an event that is not supported.
-    class NotSupportedMessage < TwitchMessage
-      attr_reader :message
-
-      def initialize(message)
-        @message = message
-        @type = :not_supported
-      end
-    end
-
-    # This class stores the details of a Ping event.
-    class PingMessage < TwitchMessage
-      attr_reader :hostname, :user
-
-      def initialize(message)
-        @user = message.user
-        @hostname = message.params.last
-        @type = :ping
-      end
-    end
-
-    # This class stores the details of a Mode event.
-    class ModeMessage < TwitchMessage
-      attr_reader :user, :mode
-
-      MODE_CHANGE = {
-        "+o" => :add_moderator,
-        "-o" => :remove_moderator,
-      }.freeze
-      def initialize(message)
-        params = message.params
-        @user = params.last
-        @mode = MODE_CHANGE[params[1]]
-        @type = :mode
-      end
-    end
-
-    # This class stores the details of an Authenticated event.
-    class AuthenticatedMessage < TwitchMessage
-      def initialize(_message)
-        @type = :authenticated
-      end
-    end
-
-    # This class stores the details of a Join event.
-    class JoinMessage < TwitchMessage
-      def initialize(_message)
-        @type = :join
-      end
-    end
-
-    # This class stores the details of a Subscription event.
-    class SubscriptionMessage < TwitchMessage
-      attr_reader :user
-
-      def initialize(message)
-        @user = message.params.last.split(" ").first
-        @type = :subscription
-      end
-    end
-
-    # This class stores the details of a ChatMessage event.
-    class ChatMessageMessage < TwitchMessage
-      attr_reader :text, :user
-
-      def initialize(message)
-        @text = message.text
-        @user = message.user
-        @type = :chat_message
-      end
-
-      def bot_command?(command)
-        text.split(/\s+/).first.match?(/^!#{command}/)
-      end
-    end
-
-    # This class stores the details of a LoginFailed event.
-    class LoginFailedMessage < TwitchMessage
-      attr_reader :user
-
-      def initialize(message)
-        @user = message.user
-        @type = :login_failed
-      end
-    end
-
-    # This class stores the details of a SlowMode event.
-    class SlowModeMessage < TwitchMessage
-      attr_reader :status, :channel
-
-      def initialize(message)
-        @status = message.tags["slow"]
-        @channel = message.channel
-        @type = :slow_mode
-      end
-
-      def enabled?
-        status.to_i.positive?
-      end
-    end
-
-    # This class stores the details of a FollowersOnlyMode event.
-    class FollowersOnlyModeMessage < TwitchMessage
-      attr_reader :status
-
-      def initialize(message)
-        @status = message.tags["followers-only"]
-        @type = :followers_only_mode
-      end
-    end
-
-    # This class stores the details of a SubsOnlyMode event.
-    class SubsOnlyModeMessage < TwitchMessage
-      attr_reader :status, :channel
-
-      def initialize(message)
-        @status = message.tags["subs-only"]
-        @channel = message.channel
-        @type = :subs_only_mode
-      end
-    end
-
-    # This class stores the details of a R9kMode event.
-    class R9kModeMessage < TwitchMessage
-      attr_reader :status, :channel
-
-      def initialize(message)
-        @status = message.tags["r9k"]
-        @channel = message.channel
-        @type = :r9k_mode
-      end
-    end
-  end
-end