twitch-bot 4.1.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59dabc57f451a9054c650af520cacc2b05b2532538d22080404a19a30be51c35
-  data.tar.gz: d6f75053e902744d29c512abc89ebfca97acfb46fc4f7a5362c61faec9902534
+  metadata.gz: c93a3e736df843858523b560468c2e8f5b485753d962048a53a1d31288dac8e7
+  data.tar.gz: 0bcecc94bf291ba8f1cbdd95643fef3fcb63dec42a60b19b6b4714a99412e48a
 SHA512:
-  metadata.gz: 9d25aae7bfcf9b00aca8d9cfde3d76e480c933aa12ac03ea7b74406f96645db3d374455b5152dd420e854bb87f15048ffa03eea59e7b266fe5c9a5207df25d43
-  data.tar.gz: 5baf4cf1ca8392c2d92c80b1d7582c01fe0a9ec3911e14decd8aca2d0e72503f7a20cb3521367c833e7c6de4f874dbbeeb62cbde6f3dfcd365cdc714cd20e264
+  metadata.gz: 1dd1afaf1758e6e284286c574d6e1c97c7173431ecec73570394193e174afd8ed2216bf6f22cec76f4ac0c0b379b4fdcf0ef93d275664870b8247f0da2f880a7
+  data.tar.gz: 2457c8f76af99c2b0293ffce6bc6269df1cc0c07f9a3aa54fbfb210e28c791f34e42eee7eeb89da00d523da6b9853454c8ad0b561d182667e80280f962253f76

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog Twitch::Bot
 
+## v5.0.1
+
+- [FIX] Environment variable `REDIS_URL` now has precedence over configuration 
+  object values.
+
+## 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.

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

@@ -4,6 +4,10 @@ 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 = []

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
@@ -25,17 +27,15 @@ module Twitch
         attr_reader :client, :redis
 
         def connect_db
-          url = redis_config_url || ENV["REDIS_URL"]
+          url = ENV["REDIS_URL"] || redis_config_url
           ::Redis.new(url: url)
         end
 
         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.1.0"
+    VERSION = "5.0.1"
   end
 end

data/spec/twitch/bot/command_handler_spec.rb

@@ -1,6 +1,10 @@
 # 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)

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.1.0
+  version: 5.0.1
 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"
@@ -221,7 +221,7 @@ homepage: https://github.com/geewiz/twitch-bot
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -237,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.