twitch_chatter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7d4ba180e523e3c21f4124b3b12c166b6e21b7af9f8c6a882ee5a01bb22b543
-  data.tar.gz: 9a92e1418e6f7b95b13ae87fd283365c16e0ec2688ec795457679c512c25efb8
+  metadata.gz: 0cd70432c7cb5123a7377b95203e38f2c97cdd04d185a59dfd59356e59b4658c
+  data.tar.gz: 2e46bc4c3fbfffe262716cef079b1e988a5624c31dc9a4fa623ea9021d753b1f
 SHA512:
-  metadata.gz: 236cea705bb4b56208403dd37dbad1ddf5dc10200a91a9ebdc52a4cbcca9b8424ef853ddef0ef0d32fc3a841b0b1963d4ea1682ab9a84b91298625c33a87d26c
-  data.tar.gz: 8cfe361fb854df8eb88c6ca3abee5b09b81836c1e42ad9462a0fbc4e2874323fbdbbea92f874056d22bc85eca319bbd8955d78a8fe84a33544debc4d44866150
+  metadata.gz: f9387375052d6c148931b7330f26701cefcb6dac48fab53a97ef8741db12833cb4d7a288f8dbc1d081cbf6cbcd802e4fdb7b8f82680cab40d2cc3566ea413645
+  data.tar.gz: 5b6dc9d6a7cb115effb39016c309bbe1dd310cf1875c634841602238de1a123a9d41bf87f589c18046f5555dfaa2535f962c5b93996171af83b8fd74158b62bf

data/lib/twitch_chatter/bot.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Twitch
+  # @example
+  #   bot = Twitch::Bot.new
+  #
+  #   bot.ready do
+  #     puts "Ready!"
+  #   end
+  #
+  #   bot.join(:twitchgaming) do |message|
+  #     puts "#{message.channel} #{message.user}: #{message.text}"
+  #   end
+  #
+  #   bot.start
+  class Bot
+    # Default options for Twitch websocket. Nicknames starting with "justinfan" are considered anonymous.
+    # @api private
+    DEFAULT_OPTIONS = {
+      nick: "justinfan0735",
+      websocket_url: "wss://irc-ws.chat.twitch.tv:443",
+    }.freeze
+
+    include Concerns::Channels
+
+    def initialize(**options)
+      @nick = options[:nick] || DEFAULT_OPTIONS[:nick]
+      @websocket_url = Async::HTTP::Endpoint.parse(options[:websocket_url] || DEFAULT_OPTIONS[:websocket_url])
+    end
+
+    # @yield
+    # @yieldparam
+    def ready(&block)
+      @ready_handle = block
+    end
+
+    # @return [Boolean]
+    def ready?
+      @ws != nil
+    end
+
+    # @return [Async::Task]
+    def start
+      Async do
+        Async::WebSocket::Client.connect(@websocket_url) do |ws|
+          @ws = ws
+          ws.write("NICK #{@nick}")
+          resume_pending
+          @ready_handle&.call
+
+          while (ws_message = ws.read)
+            data = ws_message.to_str
+            if data.start_with?("PING")
+              ws.write("PONG :tmi.twitch.tv")
+              next
+            end
+
+            next unless data.include?("PRIVMSG")
+
+            message = Message.new(data, connection: self)
+            @message_handle&.call(message)
+            streams[message.channel.to_sym].each do |block|
+              block.call(message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twitch_chatter/concerns/channels.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Twitch
+  # Mixin modules
+  # @private
+  module Concerns
+    # Mixin for channel-related methods
+    # @private
+    module Channels
+      # @return [Array<Symbol>]
+      def channels
+        streams.keys
+      end
+
+      # @yield
+      # @yieldparam streamer [Symbol]
+      # @yieldreturn [nil]
+      def joined(&block)
+        @join_handle = block
+      end
+
+      # @yield
+      # @yieldparam streamer [Symbol]
+      # @yieldreturn [nil]
+      def left(&block)
+        @leave_handle = block
+      end
+
+      # @param streamer [Symbol, String]
+      # @yield
+      # @yieldparam message [Twitch::Message]
+      # @yieldreturn [nil]
+      # @example
+      #   bot.join(:twitchgaming) do |message|
+      #     puts "##{message.channel} #{message.sender}: #{message}"
+      #   end
+      def join(streamer, &block)
+        streamer = streamer.to_sym
+        unless ready?
+          yield_join(streamer, &block)
+          return
+        end
+
+        streams[streamer] = [] unless streams.key?(streamer)
+        streams[streamer] << block if block_given?
+        @ws.write("JOIN ##{streamer}")
+        @join_handle&.call(streamer)
+      end
+
+      # @param streamer [Symbol, String]
+      # @example
+      #   bot.leave(:twitchgaming)
+      def leave(streamer)
+        streamer = streamer.to_sym
+        streams[streamer] = []
+        @ws.write("PART ##{streamer}")
+        @leave_handle&.call(streamer)
+      end
+
+      # @yield
+      # @yieldparam message [Twitch::Message]
+      # @yieldreturn [nil]
+      # @example
+      #   bot.message do |message|
+      #     puts "##{message.channel} #{message.sender}: #{message}"
+      #   end
+      def message(&block)
+        @message_handle = block
+      end
+
+      alias_method :part, :leave
+      alias_method :on_leave, :leave
+      alias_method :on_join, :joined
+      alias_method :on_message, :message
+
+      private
+
+      def streams
+        @streams ||= {}
+      end
+
+      def pending
+        @pending ||= {}
+      end
+
+      def yield_join(streamer, &block)
+        pending[streamer] = [] if streamer
+        pending[streamer] << block
+      end
+
+      def resume_pending
+        pending.each do |streamer, blocks|
+          blocks.each { |block| join(streamer, &block) }
+        end
+      end
+    end
+  end
+end

data/lib/twitch_chatter/concerns.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Twitch
+  require_relative "concerns/channels"
+end

data/lib/twitch_chatter/models/channel.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Twitch
+  # @!attribute [r] name
+  #  @return [Symbol] Name of the channel
+  # @example
+  #   channel = Twitch::Channel.new("twitchgaming")
+  class Channel
+    attr_reader :name
+
+    # @param name [String, Symbol]
+    # @param connection [Bot, nil] For internal usage
+    def initialize(name, connection: nil)
+      @name = name.to_sym
+      @connection = connection
+    end
+
+    # @yield
+    # @yieldparam message [Twitch::Message]
+    # @return [nil]
+    def join(&block)
+      @connection.join(@name, &block)
+    end
+
+    # @return [nil]
+    def leave
+      @connection.leave(@name)
+    end
+
+    # @return [Symbol]
+    def to_sym
+      @name
+    end
+
+    # @return [String]
+    def to_s
+      @name.to_s
+    end
+
+    # @param other [Channel, Symbol]
+    # @return [Boolean]
+    def ==(other)
+      if other.is_a?(Channel)
+        return @name == other.name
+      end
+
+      @name == other.to_sym
+    end
+  end
+end

data/lib/twitch_chatter/models/message.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Twitch
+  # @!attribute [r] sender
+  #   @return [Channel] Sender of the message
+  # @!attribute [r] channel
+  #  @return [Channel] Channel the message was sent to
+  # @!attribute [r] content
+  #   @return [String] Content of the message
+  # @!attribute [r] raw
+  #   @return [String] Raw message from Twitch
+  # @example
+  #   message = Twitch::Message.new(":ttlnow!ttlnow@ttlnow.tmi.twitch.tv PRIVMSG #ttlnow :Hello world!\r\n")
+  #   message.sender.name  # => :ttlnow
+  #   message.channel.name # => :ttlnow
+  #   message.content      # => "Hello world!"
+  #   message.raw          # => ":ttlnow!ttlnow@ttlnow.tmi.twitch.tv PRIVMSG #ttlnow :Hello world!\r\n"
+  class Message < String
+    attr_reader :sender, :channel, :content, :raw
+
+    # @param raw [String] Raw IRC websocket message from Twitch
+    # @param connection [Bot, nil] For internal usage
+    # @example
+    #   message = Twitch::Message.new(":ttlnow!ttlnow@ttlnow.tmi.twitch.tv PRIVMSG #ttlnow :Hello world!\r\n")
+    def initialize(raw, connection: nil)
+      split = raw.split(" ")
+      content = split[3..-1].join(" ")[1..-1]
+      super(content)
+
+      @content = content
+      @channel = Channel.new(split[2][1..-1], connection: connection)
+      @sender = Channel.new(split[0].split("!")[0][1..-1])
+      @raw = raw
+    end
+
+    alias_method :text, :content
+    alias_method :streamer, :channel
+  end
+end

data/lib/twitch_chatter/models.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Twitch
+  require_relative "models/channel"
+  require_relative "models/message"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twitch_chatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dylan Hackworth
@@ -9,7 +9,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2024-05-21 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.26.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.26.1
 description: A Ruby gem for Twitch's chat IRC websocket
 email: me@dylhack.dev
 executables: []
@@ -17,6 +31,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/twitch_chatter.rb
+- lib/twitch_chatter/bot.rb
+- lib/twitch_chatter/concerns.rb
+- lib/twitch_chatter/concerns/channels.rb
+- lib/twitch_chatter/models.rb
+- lib/twitch_chatter/models/channel.rb
+- lib/twitch_chatter/models/message.rb
 homepage: https://github.com/dylhack/twitch-chat-gem
 licenses:
 - MIT
@@ -30,7 +50,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.1.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="