twitch-bot 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38e0242c3bca6c9dbf21deab310f99435146e3e7be852ba50d26a489c81f2f24
-  data.tar.gz: 17963e5b6af86dcd2892d20a80661f2a44afc46692375b207c2f55600664e5b3
+  metadata.gz: 7f73427a772e3b29804f8ef6066b2d4ea44259f0c095218a9e63b1caddae7dd3
+  data.tar.gz: 282e8a62f638085d855c1a6fca1717b314b0f5b3fe6671fb5e4c07fd32e4bf17
 SHA512:
-  metadata.gz: 3d77d780322da5aeb3df98caa3991995be44e0b67c8510473fa66ccc533b8c3cfd0169dc1082726fcf4c7f26f324ac4086d3f6af300d933a47882263d5372203
-  data.tar.gz: 4c1e4e6cbbde65ce58dc0683e43f6de1ebdeaa62582375304b554beaad604b8f69f95a6bfa3821490e6cdb03f1eb02b2b3d37972ea0eee7a4189803aa0661156
+  metadata.gz: 72e2a1d4d0292645703d1110109004d2b20b346decd30677432dc5d3890c39b5a869a9b2cc31774e9adf37ffbe4fcaf90ec1d7a6f1784756f032100603f0826c
+  data.tar.gz: 41e166ebb07600f9d667bee2c88599e0c51874b572b63a9e3ded8047f67fbe339e9be7e1b753df0a935ae251748a09b49891c6c65f4832976fa9a8e64718ee20

data/.github/workflows/main.yml

@@ -7,20 +7,27 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
-
+    container: ruby:2.6
+    services:
+      redis:
+        image: redis
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.x
     - name: Bundle
       run: |
         gem install bundler
         bundle install --jobs 4 --retry 3
-    - name: Build and test
+    - name: Test
       run: |
         bundle exec rake test
+      env:
+        REDIS_HOST: redis
+        REDIS_PORT: 6379
 
   release:
     if: startsWith(github.ref, 'refs/tags/v')
@@ -28,7 +35,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby
+    - name: Setup
       uses: actions/setup-ruby@v1
       with:
         ruby-version: 2.6.x

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog Twitch::Bot
 
+## v3.2.0
+
+* [NEW] This release introduces a `Memory::Redis` class that allows users to provide their bot with a persistent memory storage.
+
 ## v3.1.0
 
 * [NEW] Client provides a persistent memory in form of a key/value store.

data/README.md

@@ -1,5 +1,7 @@
 # Twitch::Bot
 
+![](https://github.com/geewiz/twitch-bot/workflows/Ruby%20Gem/badge.svg)
+
 `twitch-bot` provides a Twitch chat client object that can be used for building Twitch chat bots.
 
 This gem is based on [`twitch-chat`](https://github.com/EnotPoloskun/twitch-chat).

data/docker-compose.yml

@@ -0,0 +1,7 @@
+version: "3"
+
+services:
+  redis:
+    image: redis
+    ports:
+      - "6379:6379"

data/lib/twitch/bot.rb

@@ -13,6 +13,7 @@ require_relative "bot/message"
 require_relative "bot/irc_message"
 require_relative "bot/message_parser"
 require_relative "bot/memory/hash"
+require_relative "bot/memory/redis"
 require_relative "bot/channel"
 require_relative "bot/adapter/irc"
 require_relative "bot/adapter/terminal"

data/lib/twitch/bot/client.rb

@@ -34,7 +34,7 @@ module Twitch
         setup_logging
 
         memory_class = config.setting("memory") || "Twitch::Bot::Memory::Hash"
-        @memory = Object.const_get(memory_class).new
+        @memory = Object.const_get(memory_class).new(client: self)
 
         adapter_class = config.setting("adapter") || "Twitch::Bot::Adapter::Irc"
         @adapter = Object.const_get(adapter_class).new(client: self)

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

@@ -4,8 +4,10 @@ module Twitch
   module Bot
     # Manage a key/value store for our bot
     module Memory
+      # Implement an ephemeral memory using a Hash
       class Hash
-        def initialize
+        def initialize(client:)
+          @client = client
           @kvstore = {}
         end
 
@@ -19,7 +21,7 @@ module Twitch
 
         private
 
-        attr_reader :kvstore
+        attr_reader :client, :kvstore
       end
     end
   end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "redis"
+
+module Twitch
+  module Bot
+    module Memory
+      # Implement persistent memory based on Redis
+      class Redis
+        def initialize(client:)
+          @client = client
+          @redis = connect_db
+        end
+
+        def store(key, value)
+          redis.set(key, value)
+        end
+
+        def retrieve(key)
+          redis.get(key)
+        end
+
+        private
+
+        attr_reader :client, :redis
+
+        def connect_db
+          config = client.config
+          host = config.setting("redis_host") ||
+            ENV["REDIS_HOST"] || "localhost"
+          port = config.setting("redis_port") ||
+            ENV["REDIS_PORT"] || 6379
+          ::Redis.new(host: host, port: port)
+        end
+      end
+    end
+  end
+end

data/lib/twitch/bot/version.rb

@@ -2,6 +2,6 @@
 
 module Twitch
   module Bot
-    VERSION = "3.1.0"
+    VERSION = "3.2.0"
   end
 end

data/spec/twitch/bot/client_spec.rb

@@ -14,7 +14,7 @@ RSpec.describe Twitch::Bot::Client do
     )
   end
 
-  describe "#trigger" do
+  describe "#dispath" do
     it "responds to a Ping message" do
       ping_message_fake = Struct.new(:type, :hostname, :user)
       message = ping_message_fake.new(:ping, "test.twitch", nil)

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

@@ -3,7 +3,7 @@
 RSpec.describe Twitch::Bot::Memory::Hash do
   describe "#store" do
     it "persists a value for a key" do
-      mem = described_class.new
+      mem = described_class.new(client: nil)
 
       mem.store("foo", "bar")
 

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+RSpec.describe Twitch::Bot::Memory::Redis do
+  describe "#store" do
+    it "persists a value for a key" 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")
+
+      expect(mem.retrieve("foo")).to eq "bar"
+    end
+  end
+end

data/twitch-bot.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "redis", "~> 4.1"
+
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "freistil-rubocop"
   spec.add_development_dependency "guard", "~> 2.16"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twitch-bot
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Jochen Lillich
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2020-04-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +201,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- docker-compose.yml
 - lib/twitch/bot.rb
 - lib/twitch/bot/adapter/irc.rb
 - lib/twitch/bot/adapter/terminal.rb
@@ -199,6 +214,7 @@ files:
 - lib/twitch/bot/irc_message.rb
 - lib/twitch/bot/logger.rb
 - lib/twitch/bot/memory/hash.rb
+- lib/twitch/bot/memory/redis.rb
 - lib/twitch/bot/message.rb
 - lib/twitch/bot/message/user_message.rb
 - lib/twitch/bot/message_parser.rb
@@ -207,6 +223,7 @@ files:
 - spec/twitch/bot/client_spec.rb
 - spec/twitch/bot/config_spec.rb
 - spec/twitch/bot/memory/hash_spec.rb
+- spec/twitch/bot/memory/redis_spec.rb
 - spec/twitch/bot/message/user_message_spec.rb
 - spec/twitch/bot/message_parser_spec.rb
 - twitch-bot.gemspec
@@ -239,5 +256,6 @@ test_files:
 - spec/twitch/bot/client_spec.rb
 - spec/twitch/bot/config_spec.rb
 - spec/twitch/bot/memory/hash_spec.rb
+- spec/twitch/bot/memory/redis_spec.rb
 - spec/twitch/bot/message/user_message_spec.rb
 - spec/twitch/bot/message_parser_spec.rb