twitch-bot 2.1.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55f8f1fa119d4344d036c5644cc8544ab4b0f9b9bac3d2d5dad21ccf157f4bed
-  data.tar.gz: d0df1fc16260d45e0187377e3aa7574dad0a85fe57c907b648e943c3c5d9303a
+  metadata.gz: 38e0242c3bca6c9dbf21deab310f99435146e3e7be852ba50d26a489c81f2f24
+  data.tar.gz: 17963e5b6af86dcd2892d20a80661f2a44afc46692375b207c2f55600664e5b3
 SHA512:
-  metadata.gz: 4a966f66085b1767a136e11947c316f9ece94893658b8dda98a1e519aadc7d2e720b9bd0dba904e3ee070041f799231ade30be3a78a33d275370dd426fba4cc8
-  data.tar.gz: f7340c7b36d5e2cf6f3e84a64d898013fe0c519361cffc6f6ad8eeacbd8b5c369f539ddfdebea90dabf034eaf648b32026805df27cca02538ae5eafbbd89357f
+  metadata.gz: 3d77d780322da5aeb3df98caa3991995be44e0b67c8510473fa66ccc533b8c3cfd0169dc1082726fcf4c7f26f324ac4086d3f6af300d933a47882263d5372203
+  data.tar.gz: 4c1e4e6cbbde65ce58dc0683e43f6de1ebdeaa62582375304b554beaad604b8f69f95a6bfa3821490e6cdb03f1eb02b2b3d37972ea0eee7a4189803aa0661156

data/.github/workflows/main.yml

@@ -0,0 +1,47 @@
+name: Ruby Gem
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    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
+      run: |
+        bundle exec rake test
+
+  release:
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: test
+    runs-on: ubuntu-latest
+    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: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        rake release
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog Twitch::Bot
 
+## v3.1.0
+
+* [NEW] Client provides a persistent memory in form of a key/value store.
+
+## v3.0.0
+
+* [BREAKING] Instead of choosing and creating the `Adapter` in the `Client`, we now inject a `Config` class into `Client` that carries our choice of Adapter. This change also makes the `Connection` class obsolete; its information went into `Config` as well.
+
 ## v2.1.1
 
 * [FIXED] Fix a few bugs missed by not running tests. We need CI...

data/README.md

@@ -2,9 +2,7 @@
 
 `twitch-bot` provides a Twitch chat client object that can be used for building Twitch chat bots.
 
-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!_
+This gem is based on [`twitch-chat`](https://github.com/EnotPoloskun/twitch-chat).
 
 ## Installation
 
@@ -28,57 +26,7 @@ $ gem install twitch-bot
 
 ## Usage
 
-```ruby
-require "twitch/bot"
-
-class JoinHandler < Twitch::Bot::EventHandler
-  def call
-    client.send_message "Hi guys!"
-  end
-
-  def self.handled_events
-    [:join]
-  end
-end
-
-class SubscriptionHandler < Twitch::Bot::EventHandler
-  def call
-    client.send_message "Hi #{event.user}, thank you for your subscription"
-  end
-
-  def self.handled_events
-    [:subscription]
-  end
-end
-
-class TimeCommandHandler < Twitch::Bot::EventHandler
-  def call
-    if event.bot_command?("time")
-      client.send_message "Current time: #{Time.now.utc}"
-    end
-  end
-
-  def self.handled_events
-    [:chat_message]
-  end
-end
-
-connection = Twitch::Bot::Connection.new(
-  nickname: "test",
-  password: "secret",
-)
-
-client = Twitch::Bot::Client.new(
-  connection: connection,
-  channel: "test",
-) do
-  register_handler(JoinHandler)
-  register_handler(SubscriptionHandler)
-  register_handler(TimeCommandHandler)
-end
-
-client.run
-```
+Refer to the [Teneggs](https://www.github.com/geewiz/teneggs) repository for an example bot implementation.
 
 ## Supported event types
 

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 
+task default: :test
 task test: %i[rubocop spec]
 
 begin

data/lib/twitch/bot/adapter/irc.rb

@@ -52,10 +52,9 @@ module Twitch
         attr_reader :socket, :client, :channel
 
         def open_socket
-          connection = client.connection
           @socket = ::TCPSocket.new(
-            connection.hostname,
-            connection.port,
+            client.config.setting("irc_hostname") || "irc.chat.twitch.tv",
+            client.config.setting("irc_port") || 6667,
           )
 
           Twitch::Bot::Logger.debug "Socket open"
@@ -95,9 +94,9 @@ module Twitch
         end
 
         def authenticate
-          connection = client.connection
-          send_data "PASS #{connection.password}"
-          send_data "NICK #{connection.nickname}"
+          config = client.config
+          send_data "PASS #{config.setting('irc_password')}"
+          send_data "NICK #{config.setting('irc_nickname')}"
         end
 
         def sanitize_data(data)

data/lib/twitch/bot/adapter/terminal.rb

@@ -5,9 +5,7 @@ module Twitch
     module Adapter
       # This adapter connects the chat client to the terminal
       class Terminal
-        def initialize(client:)
-          @client = client
-        end
+        def initialize(client:); end
 
         def connect; end
 
@@ -22,7 +20,7 @@ module Twitch
         end
 
         def send_data(data)
-          puts sanitize_data(data)
+          puts data
         end
 
         def join_channel(_channel); end
@@ -33,12 +31,6 @@ module Twitch
 
         attr_reader :client
 
-        def sanitize_data(data)
-          data.gsub(/(PASS oauth:)(\w+)/) do
-            "#{Regexp.last_match(1)}#{'*' * Regexp.last_match(2).size}"
-          end
-        end
-
         def read_message_from_terminal
           Twitch::Bot::Logger.debug "Waiting for input..."
           input = gets

data/lib/twitch/bot/client.rb

@@ -19,23 +19,35 @@ module Twitch
       USER_MESSAGES_COUNT = 20
       TWITCH_PERIOD = 30.0
 
-      attr_reader :connection
+      attr_reader :channel, :config, :memory
 
       def initialize(
-        connection:, channel: nil, &block
+        channel: nil, config:, &block
       )
-        @connection = connection
+        @config = config
         @channel = Twitch::Bot::Channel.new(channel) if channel
+
         @messages_queue = []
         @event_handlers = {}
         @event_loop_running = false
 
-        create_adapter
+        setup_logging
+
+        memory_class = config.setting("memory") || "Twitch::Bot::Memory::Hash"
+        @memory = Object.const_get(memory_class).new
+
+        adapter_class = config.setting("adapter") || "Twitch::Bot::Adapter::Irc"
+        @adapter = Object.const_get(adapter_class).new(client: self)
 
         execute_initialize_block block if block
         register_default_handlers
       end
 
+      #
+      # Register an event handler for specific event types
+      #
+      # @param [<EventHandler>] handler EventHandler class to register
+      #
       def register_handler(handler)
         handler.handled_events.each do |event_type|
           (event_handlers[event_type] ||= []) << handler
@@ -95,15 +107,13 @@ module Twitch
       private
 
       attr_reader :adapter, :event_handlers, :event_loop_running,
-                  :input_thread, :output_thread, :channel, :messages_queue
+                  :input_thread, :output_thread, :messages_queue
 
-      def create_adapter
-        adapter_class = if development_mode?
-                          Twitch::Bot::Adapter::Terminal
-                        else
-                          Twitch::Bot::Adapter::Irc
-                        end
-        @adapter = adapter_class.new(client: self)
+      def setup_logging
+        Twitch::Bot::Logger.output =
+          config.setting(:log_file) || "twitchbot.log"
+        Twitch::Bot::Logger.level =
+          (config.setting(:log_level) || "info").to_sym
       end
 
       def startup
@@ -156,10 +166,6 @@ module Twitch
         end
       end
 
-      def development_mode?
-        ENV["BOT_MODE"] == "development"
-      end
-
       def execute_initialize_block(block)
         if block.arity == 1
           block.call self
@@ -175,7 +181,7 @@ module Twitch
       end
 
       def max_messages_count
-        if channel.moderators.include?(connection.nickname)
+        if channel.moderators.include?(config.setting("botname"))
           MODERATOR_MESSAGES_COUNT
         else
           USER_MESSAGES_COUNT

data/lib/twitch/bot/config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Twitch
+  module Bot
+    # This class stores the connection details for the client.
+    class Config
+      def initialize(settings: {})
+        @settings = settings
+      end
+
+      def setting(name)
+        conf = settings
+        name_str = name.to_s
+        name_str.split("_").each do |key|
+          return nil if conf.nil?
+
+          conf = conf.fetch(key.to_sym, nil)
+        end
+        conf
+      end
+
+      private
+
+      attr_reader :settings
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Twitch
+  module Bot
+    # Manage a key/value store for our bot
+    module Memory
+      class Hash
+        def initialize
+          @kvstore = {}
+        end
+
+        def store(key, value)
+          kvstore[key] = value
+        end
+
+        def retrieve(key)
+          kvstore[key]
+        end
+
+        private
+
+        attr_reader :kvstore
+      end
+    end
+  end
+end

data/lib/twitch/bot/version.rb

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

data/lib/twitch/bot.rb

@@ -4,6 +4,7 @@ require "bundler/setup"
 Bundler.require(:default)
 
 require_relative "bot/version"
+require_relative "bot/config"
 require_relative "bot/logger"
 require_relative "bot/event"
 require_relative "bot/event_handler"
@@ -11,8 +12,8 @@ require_relative "bot/default_handlers"
 require_relative "bot/message"
 require_relative "bot/irc_message"
 require_relative "bot/message_parser"
+require_relative "bot/memory/hash"
 require_relative "bot/channel"
-require_relative "bot/connection"
 require_relative "bot/adapter/irc"
 require_relative "bot/adapter/terminal"
 require_relative "bot/client"

data/spec/twitch/bot/client_spec.rb

@@ -2,10 +2,16 @@
 
 RSpec.describe Twitch::Bot::Client do
   let!(:client) do
-    connection = Twitch::Bot::Connection.new(
-      nickname: "test", password: "test",
+    config = Twitch::Bot::Config.new(
+      settings: {
+        bot_user: "testuser",
+        adapter: "Twitch::Bot::Adapter::Terminal",
+      },
+    )
+    described_class.new(
+      config: config,
+      channel: "testchannel",
     )
-    described_class.new(connection: connection)
   end
 
   describe "#trigger" do
@@ -49,4 +55,20 @@ RSpec.describe Twitch::Bot::Client do
       expect(client).to have_received(:remove_moderator)
     end
   end
+
+  describe "#channel" do
+    it "returns the channel object" do
+      channel = client.channel
+
+      expect(channel.name).to eq "testchannel"
+    end
+  end
+
+  describe "#memory" do
+    it "stores and retrieves data" do
+      client.memory.store("foo", "bar")
+
+      expect(client.memory.retrieve("foo")).to eq "bar"
+    end
+  end
 end

data/spec/twitch/bot/config_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+RSpec.describe Twitch::Bot::Config do
+  describe "#setting" do
+    it "returns a first-level setting" do
+      config = described_class.new(
+        settings: {
+          test: "Test",
+          foo: "bar",
+        },
+      )
+
+      expect(config.setting("test")).to eq "Test"
+    end
+
+    it "returns a second-level setting" do
+      config = described_class.new(
+        settings: {
+          test: {
+            foo: "bar",
+          },
+        },
+      )
+
+      expect(config.setting("test_foo")).to eq "bar"
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RSpec.describe Twitch::Bot::Memory::Hash do
+  describe "#store" do
+    it "persists a value for a key" do
+      mem = described_class.new
+
+      mem.store("foo", "bar")
+
+      expect(mem.retrieve("foo")).to eq "bar"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitch-bot
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Jochen Lillich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-18 00:00:00.000000000 Z
+date: 2020-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -174,6 +174,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -191,18 +192,21 @@ files:
 - lib/twitch/bot/adapter/terminal.rb
 - lib/twitch/bot/channel.rb
 - lib/twitch/bot/client.rb
-- lib/twitch/bot/connection.rb
+- lib/twitch/bot/config.rb
 - lib/twitch/bot/default_handlers.rb
 - lib/twitch/bot/event.rb
 - lib/twitch/bot/event_handler.rb
 - lib/twitch/bot/irc_message.rb
 - lib/twitch/bot/logger.rb
+- lib/twitch/bot/memory/hash.rb
 - lib/twitch/bot/message.rb
 - lib/twitch/bot/message/user_message.rb
 - lib/twitch/bot/message_parser.rb
 - lib/twitch/bot/version.rb
 - spec/spec_helper.rb
 - spec/twitch/bot/client_spec.rb
+- spec/twitch/bot/config_spec.rb
+- spec/twitch/bot/memory/hash_spec.rb
 - spec/twitch/bot/message/user_message_spec.rb
 - spec/twitch/bot/message_parser_spec.rb
 - twitch-bot.gemspec
@@ -233,5 +237,7 @@ 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/config_spec.rb
+- spec/twitch/bot/memory/hash_spec.rb
 - spec/twitch/bot/message/user_message_spec.rb
 - spec/twitch/bot/message_parser_spec.rb

data/lib/twitch/bot/connection.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Twitch
-  module Bot
-    # This class stores the connection details for the client.
-    class Connection
-      attr_reader :nickname, :password, :hostname, :port
-
-      def initialize(
-        nickname:, password:, hostname: "irc.chat.twitch.tv", port: "6667"
-      )
-        @nickname = nickname
-        @password = password
-        @hostname = hostname
-        @port = port
-      end
-    end
-  end
-end