twitch-bot 4.1.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b95458f55a188c3e08f200675f0147561f9316aea8eeac3f570eb5a1f984e755
-  data.tar.gz: b63b75edbe1b0f2fa6f31e8e0ca1064e8a6c6b0cf9defd9f91f13646ca48fdc6
+  metadata.gz: 62d03f6a524a016a3c7472f473699677c203961d5c0db80d8345da5a2e48397d
+  data.tar.gz: c9a11d3c030bf1a9debf6bb66b06a18b80d814347b123dc41f070d4cd5670064
 SHA512:
-  metadata.gz: 9b1be2870429a4748980a9490749181275a0d59ac9cae46be6538e7a93e98dcbd6fbdf6614b9a6701e508156e35d5db77c98685ea44dcae8263461a3dc8f58e9
-  data.tar.gz: a6be65d6a5369df67ec3243c7c17313a45fb7df135ea862c0b04e92b2d5ac6953c18993277e33772f373dfbdc6d46154edfc36e287788c6f388e5829a80104a7
+  metadata.gz: 34fe79b2b493e373bf79665dd001bda15e6c4bc87e6c70ba2a6bb0a34a6190b1800450ffcdfa850f167c29e8ec25a5a1bee2837116a9d1b93313f213b170475e
+  data.tar.gz: 9cdf0dde5c84e3fac9f5e1a37d8aaddddd284086e900390dac97f384c364a11a138cbad0bd098a96eaf5020a99b749a38149111890c9f798d169b46f77f895f1

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # 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.

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/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.1.1"
+    VERSION = "5.0.0"
   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.1.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"
@@ -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.