twitch_chatter 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cd70432c7cb5123a7377b95203e38f2c97cdd04d185a59dfd59356e59b4658c
-  data.tar.gz: 2e46bc4c3fbfffe262716cef079b1e988a5624c31dc9a4fa623ea9021d753b1f
+  metadata.gz: fff1b37e345e021646f75631a1ec5515d10f05cbf4f238b4f2136878b5b9b02d
+  data.tar.gz: b47c19eaff099c6a439e864f80ed72e85b15a68f4fcbc2d4ef2a85454f47b947
 SHA512:
-  metadata.gz: f9387375052d6c148931b7330f26701cefcb6dac48fab53a97ef8741db12833cb4d7a288f8dbc1d081cbf6cbcd802e4fdb7b8f82680cab40d2cc3566ea413645
-  data.tar.gz: 5b6dc9d6a7cb115effb39016c309bbe1dd310cf1875c634841602238de1a123a9d41bf87f589c18046f5555dfaa2535f962c5b93996171af83b8fd74158b62bf
+  metadata.gz: 984d51eda98c57546a8e906cef1b7d2d96dfd7d0d9de91c2c42bb18ff825279f24b9f3d85eab199eaf3f6a427ddb2d446db946102e0a1d17e90aef1559bfafac
+  data.tar.gz: 58909f2b18253651a6cc2d37ec36fa5d2381279a5f203f332eebe5b6441cdaffcee71bb488e53212915f8ed1e2b53b37d2f4e9e3cf9bd9973f18dfbd6b525df1

data/lib/twitch_chatter/bot.rb

@@ -21,8 +21,6 @@ module Twitch
       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])
@@ -45,8 +43,7 @@ module Twitch
         Async::WebSocket::Client.connect(@websocket_url) do |ws|
           @ws = ws
           ws.write("NICK #{@nick}")
-          resume_pending
-          @ready_handle&.call
+          dispatch_ready
 
           while (ws_message = ws.read)
             data = ws_message.to_str
@@ -57,14 +54,109 @@ module Twitch
 
             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
+            dispatch(Message.new(data, connection: self))
           end
         end
       end
     end
+
+    # @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 dispatch(message)
+      @message_handle&.call(message)
+      streams[message.channel.to_sym].each do |block|
+        block.call(message)
+      end
+    end
+
+    def dispatch_ready
+      join_all
+      @ready_handle&.call
+    end
+
+    def streams
+      @streams ||= {}
+    end
+
+    def pending
+      @pending ||= {}
+    end
+
+    def yield_join(streamer, &block)
+      pending[streamer] = [] if streamer
+      pending[streamer] << block
+    end
+
+    def join_all
+      pending.each do |streamer, blocks|
+        blocks.each { |block| join(streamer, &block) }
+      end
+    end
   end
 end

data/lib/twitch_chatter/models/channel.rb

@@ -37,7 +37,7 @@ module Twitch
       @name.to_s
     end
 
-    # @param other [Channel, Symbol]
+    # @param other [Channel, String, Symbol]
     # @return [Boolean]
     def ==(other)
       if other.is_a?(Channel)

data/lib/twitch_chatter/models/message.rb

@@ -10,24 +10,25 @@ module Twitch
   # @!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 = Twitch::Message.new(":justinfan!justinfan@justinfan.tmi.twitch.tv PRIVMSG #twitchgaming :Hello world!\r\n")
+  #   message.sender.name  # => :justinfan
+  #   message.channel.name # => :twitchgaming
   #   message.content      # => "Hello world!"
-  #   message.raw          # => ":ttlnow!ttlnow@ttlnow.tmi.twitch.tv PRIVMSG #ttlnow :Hello world!\r\n"
+  #   message.raw          # => ":justinfan!justinfan@justinfan.tmi.twitch.tv PRIVMSG #justinfan :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")
+    #   message = Twitch::Message.new(":justinfan!justinfan@justinfan.tmi.twitch.tv PRIVMSG #twitchgaming :Hello world!\r\n")
     def initialize(raw, connection: nil)
       split = raw.split(" ")
       content = split[3..-1].join(" ")[1..-1]
       super(content)
 
       @content = content
+      @connection = connection
       @channel = Channel.new(split[2][1..-1], connection: connection)
       @sender = Channel.new(split[0].split("!")[0][1..-1])
       @raw = raw
@@ -35,5 +36,38 @@ module Twitch
 
     alias_method :text, :content
     alias_method :streamer, :channel
+    alias_method :user, :sender
+
+    USERNAME = /[a-zA-Z0-9_]{4,25}/
+    # @return [Array<Twitch::Channel>] List of usernames mentioned in the message
+    def mentions
+      return @mentions if @mentions
+
+      @mentions = []
+      @content.split(" ").each do |word|
+        match = word.match(/@#{USERNAME}/)
+        next unless match
+
+        @mentions << Channel.new(match[0][1..-1], connection: @connection)
+      end
+
+      @mentions
+    end
+
+    LINK = %r{(https?://[^\s]+)}
+    # @return [Array<String>] List of links mentioned in the message
+    def links
+      return @links if @links
+
+      @links = []
+      @content.split(" ").each do |word|
+        match = word.match(LINK)
+        next unless match
+
+        @links << match[0]
+      end
+
+      @links
+    end
   end
 end

data/lib/twitch_chatter.rb

@@ -3,7 +3,6 @@
 require "async"
 require "async/http/endpoint"
 require "async/websocket/client"
-require_relative "twitch_chatter/concerns"
 require_relative "twitch_chatter/models"
 require_relative "twitch_chatter/bot"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitch_chatter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Dylan Hackworth
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2024-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-websocket
@@ -32,17 +32,15 @@ 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
+homepage: https://github.com/dylhack/twitch_chatter
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/dylhack/twitch-chat-gem
-post_install_message:
+  source_code_uri: https://github.com/dylhack/twitch_chatter
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -58,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.9
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Read-only Twitch chat client.
 test_files: []

data/lib/twitch_chatter/concerns/channels.rb

@@ -1,98 +0,0 @@
-# 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

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