twitch-bot 4.0.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e4f03406f61c87e0daa72edc415d45fe13acfe5b33514c75a2028c119d52212
-  data.tar.gz: 2e5336cff0e7304f91725d05ec7ff5e813ad54a0127554d0f3349d72d435d5d7
+  metadata.gz: 62d03f6a524a016a3c7472f473699677c203961d5c0db80d8345da5a2e48397d
+  data.tar.gz: c9a11d3c030bf1a9debf6bb66b06a18b80d814347b123dc41f070d4cd5670064
 SHA512:
-  metadata.gz: e634d550cbd5b2dfb8f80216f11284c015aa9e6e78cb9a08557af848b92f1505f8ac66c70270ce5329aa6eccc2bc3b2f8fba39b690032f5b7e7c8d0941a5fe1f
-  data.tar.gz: cc44b72bb4656a743321e5da2596da419e8eb078e759bea9742cfffa5a2047156caae7588a4cc3a3fcb7e302999a92b00c07a7531a9105d22137bc5a44268d04
+  metadata.gz: 34fe79b2b493e373bf79665dd001bda15e6c4bc87e6c70ba2a6bb0a34a6190b1800450ffcdfa850f167c29e8ec25a5a1bee2837116a9d1b93313f213b170475e
+  data.tar.gz: 9cdf0dde5c84e3fac9f5e1a37d8aaddddd284086e900390dac97f384c364a11a138cbad0bd098a96eaf5020a99b749a38149111890c9f798d169b46f77f895f1

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog Twitch::Bot
 
+## v5.0.0
+
+- [BREAKING] Complex values like arrays and hashes get serialized as JSON before 
+  being stored in Redis.
+
+## v4.1.1
+
+- [NEW] `CommandHandler` by default responds to `:user_message` events.
+
+## v4.1.0
+
+* [NEW] New `CommandHandler` class that simplifies building chat commands.
+
 ## v4.0.1
 
 * [FIXED] Fixed test crash due to incomplete DotEnv initialization.

data/lib/twitch/bot/client.rb

@@ -11,7 +11,7 @@ module Twitch
       # Represent the event triggered when quitting the client loop.
       class StopEvent < Twitch::Bot::Event
         def initialize
-          @type = :stop
+          super(type: :stop)
         end
       end
 
@@ -22,7 +22,7 @@ module Twitch
       attr_reader :channel, :config, :memory
 
       def initialize(
-        channel: nil, config:, &block
+        config:, channel: nil, &block
       )
         @config = config
         @channel = Twitch::Bot::Channel.new(channel) if channel

data/lib/twitch/bot/command_handler.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Twitch
+  module Bot
+    # Base class for implementing chat commands
+    class CommandHandler < EventHandler
+      def self.handled_events
+        [:user_message]
+      end
+
+      def initialize(event:, client:)
+        super
+        @command_aliases = []
+      end
+
+      def call
+        if event.command? && command_aliases.include?(event.command)
+          handle_command
+        end
+      end
+
+      def command_alias(command_alias)
+        @command_aliases << command_alias
+      end
+
+      private
+
+      attr_reader :command_aliases
+
+      def handle_command
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/twitch/bot/event_handler.rb

@@ -6,6 +6,21 @@ module Twitch
     class EventHandler
       attr_reader :event, :client
 
+      #
+      # Return a list of event types this handler subscribes to
+      #
+      # @return [Array] list of event types
+      #
+      def self.handled_events
+        []
+      end
+
+      #
+      # Inititalize an event handler object
+      #
+      # @parameter event The latest event of a subscribed type
+      # @parameter client The current chat client object
+      #
       def initialize(event:, client:)
         @event = event
         @client = client
@@ -19,15 +34,6 @@ module Twitch
       def call
         raise "Unhandled #{event.type}"
       end
-
-      #
-      # Return a list of event types this handler can handle
-      #
-      # @return [Array] event type list
-      #
-      def self.handled_events
-        []
-      end
     end
   end
 end

data/lib/twitch/bot/logger.rb

@@ -16,7 +16,7 @@ module Twitch
       end
 
       def self.logger
-        @logger ||= ::Logger.new(STDOUT)
+        @logger ||= ::Logger.new($stdout)
       end
     end
   end

data/lib/twitch/bot/memory/redis.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "redis"
+require "json"
 
 module Twitch
   module Bot
@@ -13,11 +14,12 @@ module Twitch
         end
 
         def store(key, value)
-          redis.set(key, value)
+          redis.set(key, value.to_json)
         end
 
         def retrieve(key)
-          redis.get(key)
+          value = redis.get(key)
+          JSON.parse(value)
         end
 
         private
@@ -31,11 +33,9 @@ module Twitch
 
         def redis_config_url
           config = client.config
-          if config.setting("redis_host")
-            host = config.setting("redis_host") || "localhost"
-            port = config.setting("redis_port") || 6379
-            "redis://#{host}:#{port}"
-          end
+          host = config.setting("redis_host") || "localhost"
+          port = config.setting("redis_port") || 6379
+          "redis://#{host}:#{port}"
         end
       end
     end

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

@@ -10,7 +10,7 @@ module Twitch
         def initialize(text:, user:)
           @text = text
           @user = user
-          @type = :user_message
+          super(type: :user_message)
         end
 
         def command_name?(check_command)

data/lib/twitch/bot/message.rb

@@ -5,8 +5,8 @@ module Twitch
     module Message
       # This class is the abstract base class for IRC events.
       class Base < Twitch::Bot::Event
-        def initialize(_message)
-          @type = :unknown
+        def initialize(type: :unknown)
+          super(type: type)
         end
       end
 
@@ -16,7 +16,7 @@ module Twitch
 
         def initialize(message)
           @message = message
-          @type = :not_supported
+          super(type: :not_supported)
         end
       end
 
@@ -26,7 +26,7 @@ module Twitch
 
         def initialize(hostname:)
           @hostname = hostname
-          @type = :ping
+          super(type: :ping)
         end
       end
 
@@ -37,21 +37,21 @@ module Twitch
         def initialize(user:, mode:)
           @user = user
           @mode = mode
-          @type = :mode
+          super(type: :mode)
         end
       end
 
       # This class stores the details of an Authenticated event.
       class Authenticated < Base
         def initialize
-          @type = :authenticated
+          super(type: :authenticated)
         end
       end
 
       # This class stores the details of a Join event.
       class Join < Base
         def initialize
-          @type = :join
+          super(type: :join)
         end
       end
 
@@ -61,7 +61,7 @@ module Twitch
 
         def initialize(user:)
           @user = user
-          @type = :subscription
+          super(type: :subscription)
         end
       end
 
@@ -71,7 +71,7 @@ module Twitch
 
         def initialize(user:)
           @user = user
-          @type = :login_failed
+          super(type: :login_failed)
         end
       end
 
@@ -82,7 +82,7 @@ module Twitch
         def initialize(status:, channel:)
           @status = status
           @channel = channel
-          @type = :slow_mode
+          super(type: :slow_mode)
         end
 
         def enabled?
@@ -96,7 +96,7 @@ module Twitch
 
         def initialize(status:)
           @status = status
-          @type = :followers_only_mode
+          super(type: :followers_only_mode)
         end
       end
 
@@ -107,7 +107,7 @@ module Twitch
         def initialize(status:, channel:)
           @status = status
           @channel = channel
-          @type = :subs_only_mode
+          super(type: :subs_only_mode)
         end
       end
 
@@ -118,7 +118,7 @@ module Twitch
         def initialize(status:, channel:)
           @status = status
           @channel = channel
-          @type = :r9k_mode
+          super(type: :r9k_mode)
         end
       end
     end

data/lib/twitch/bot/version.rb

@@ -2,6 +2,6 @@
 
 module Twitch
   module Bot
-    VERSION = "4.0.1"
+    VERSION = "5.0.0"
   end
 end

data/lib/twitch/bot.rb

@@ -8,6 +8,7 @@ require_relative "bot/config"
 require_relative "bot/logger"
 require_relative "bot/event"
 require_relative "bot/event_handler"
+require_relative "bot/command_handler"
 require_relative "bot/default_handlers"
 require_relative "bot/message"
 require_relative "bot/irc_message"

data/spec/twitch/bot/command_handler_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+RSpec.describe Twitch::Bot::CommandHandler do
+  it "responds to user_message" do
+    expect(described_class.handled_events).to include(:user_message)
+  end
+
+  it "responds to a known command" do
+    config = Twitch::Bot::Config.new
+    client = Twitch::Bot::Client.new(config: config)
+    message = Twitch::Bot::Message::UserMessage.new(
+      text: "!mycommand test",
+      user: "testuser",
+    )
+    handler = described_class.new(event: message, client: client)
+    handler.command_alias("mycommand")
+    allow(handler).to receive(:handle_command)
+
+    handler.call
+
+    expect(handler).to have_received(:handle_command)
+  end
+end

data/spec/twitch/bot/memory/hash_spec.rb

@@ -9,5 +9,26 @@ RSpec.describe Twitch::Bot::Memory::Hash do
 
       expect(mem.retrieve("foo")).to eq "bar"
     end
+
+    it "persists an Array" do
+      mem = described_class.new(client: nil)
+
+      mem.store("foo", [1, 2])
+
+      result = mem.retrieve("foo")
+      expect(result).to be_an Array
+      expect(result[0]).to eq 1
+      expect(result[1]).to eq 2
+    end
+
+    it "persists a Hash" do
+      mem = described_class.new(client: nil)
+
+      mem.store("foo", { "bar" => "baz" })
+
+      result = mem.retrieve("foo")
+      expect(result).to be_a Hash
+      expect(result["bar"]).to eq "baz"
+    end
   end
 end

data/spec/twitch/bot/memory/redis_spec.rb

@@ -40,5 +40,44 @@ RSpec.describe Twitch::Bot::Memory::Redis do
 
       expect(mem.retrieve("foo")).to eq "bar"
     end
+
+    it "persists an Array" do
+      config = Twitch::Bot::Config.new(
+        settings: {
+          bot_user: "testuser",
+        },
+      )
+      client = Twitch::Bot::Client.new(
+        config: config,
+        channel: "testchannel",
+      )
+      mem = described_class.new(client: client)
+
+      mem.store("foo", [1, 2])
+
+      result = mem.retrieve("foo")
+      expect(result).to be_an Array
+      expect(result[0]).to eq 1
+      expect(result[1]).to eq 2
+    end
+
+    it "persists a Hash" do
+      config = Twitch::Bot::Config.new(
+        settings: {
+          bot_user: "testuser",
+        },
+      )
+      client = Twitch::Bot::Client.new(
+        config: config,
+        channel: "testchannel",
+      )
+      mem = described_class.new(client: client)
+
+      mem.store("foo", { "bar" => "baz" })
+
+      result = mem.retrieve("foo")
+      expect(result).to be_a Hash
+      expect(result["bar"]).to eq "baz"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitch-bot
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Jochen Lillich
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -174,7 +174,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
-- ".env.dist"
+- ".env.sample"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
@@ -194,6 +194,7 @@ files:
 - lib/twitch/bot/adapter/terminal.rb
 - lib/twitch/bot/channel.rb
 - lib/twitch/bot/client.rb
+- lib/twitch/bot/command_handler.rb
 - lib/twitch/bot/config.rb
 - lib/twitch/bot/default_handlers.rb
 - lib/twitch/bot/event.rb
@@ -209,6 +210,7 @@ files:
 - spec/spec_helper.rb
 - spec/twitch/bot/adapter/terminal_spec.rb
 - spec/twitch/bot/client_spec.rb
+- spec/twitch/bot/command_handler_spec.rb
 - spec/twitch/bot/config_spec.rb
 - spec/twitch/bot/memory/hash_spec.rb
 - spec/twitch/bot/memory/redis_spec.rb
@@ -219,7 +221,7 @@ homepage: https://github.com/geewiz/twitch-bot
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -235,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: twitch-bot is a Twitch chat client that uses Twitch IRC that can be used
   as a Twitch chat bot engine.
@@ -243,6 +245,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/twitch/bot/adapter/terminal_spec.rb
 - spec/twitch/bot/client_spec.rb
+- spec/twitch/bot/command_handler_spec.rb
 - spec/twitch/bot/config_spec.rb
 - spec/twitch/bot/memory/hash_spec.rb
 - spec/twitch/bot/memory/redis_spec.rb