twitch_chatter 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0626809247948353252813fb4a42078bab2df4e08d51c78f3a709147d2c18b9
-  data.tar.gz: f71b8c46884ee66112eca143d7b195170a34ed382967b86c25b88aeca9773d0b
+  metadata.gz: 492969da096c5b1c22a1470cf299261cc6df2df03d48fc8b05ed29bfc0fc4b0c
+  data.tar.gz: 023faac7d335744978a18cd976c4669c8c062a630d4443b8235e49c01ca8566f
 SHA512:
-  metadata.gz: 55d5d7fd4159fe3b17817ba8ead6e0d06308c422d21516f83b121cab1b41b98e5fe217d7cbf294ba19832e7a795e6da13cbde788453ff51a151d4100cc31edfe
-  data.tar.gz: 9f6697054a4f8af92583aacad9f529a036f6adf4795c8e7255ef98287df3870609a22cc182801ec4983d14a42b48d2f104ec5c7852f8de382369e8cfc3b2909f
+  metadata.gz: 8a59850e2a9194d7034abd2944bdd07b3219718c9f45c4be8a15ba8535070b22f151726e0805733cc07e1b9a5b5b9422ec344a3eb51f2287b422c50eaf812d9c
+  data.tar.gz: a27584857fd99b20d7e7923022ceacaf1c459b468c36b7719b29878c704ec6a0d88f6f8406c9dee8f81c935c7cb53656642adaa14a7c3e7d82003bb96610bf61

data/lib/twitch_chatter/bot.rb

@@ -21,22 +21,25 @@ module Twitch
       websocket_url: "wss://irc-ws.chat.twitch.tv:443",
     }.freeze
 
+    # @see [DEFAULT_OPTIONS]
     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
+    # Dispatched on websocket connect, but before channel joins
+    # @yield [nil]
     def ready(&block)
       @ready_handle = block
     end
 
+    # If we're connected to Twitch's websocket
     # @return [Boolean]
     def ready?
       @ws != nil
     end
 
+    # Begin pulling messages
     # @return [Async::Task]
     def start
       Async do
@@ -54,7 +57,7 @@ module Twitch
 
             next unless data.include?("PRIVMSG")
 
-            dispatch(Message.new(data, connection: self))
+            dispatch(Message.new(data, bot: self))
           end
         end
       end
@@ -64,27 +67,22 @@ module Twitch
 
     # @return [Array<Symbol>]
     def channels
-      streams.keys
+      streams.keys.map { |s| Channel.new(s, bot: self) }
     end
 
-    # @yield
-    # @yieldparam streamer [Symbol]
-    # @yieldreturn [nil]
+    # @yieldparam [Symbol] streamer
     def joined(&block)
       @join_handle = block
     end
 
-    # @yield
-    # @yieldparam streamer [Symbol]
-    # @yieldreturn [nil]
+    # @yieldparam [Symbol] streamer
     def left(&block)
       @leave_handle = block
     end
 
     # @param streamer [Symbol, String]
-    # @yield
     # @yieldparam message [Twitch::Message]
-    # @yieldreturn [nil]
+    # @return [nil]
     # @example
     #   bot.join(:twitchgaming) do |message|
     #     puts "##{message.channel} #{message.sender}: #{message}"
@@ -100,9 +98,12 @@ module Twitch
       streams[streamer] << block if block_given?
       @ws.write("JOIN ##{streamer}")
       @join_handle&.call(streamer)
+      nil
     end
 
+    # Disconnects from channel and removes all message callbacks.
     # @param streamer [Symbol, String]
+    # @return [nil]
     # @example
     #   bot.leave(:twitchgaming)
     def leave(streamer)
@@ -112,11 +113,10 @@ module Twitch
       streams[streamer] = []
       @ws.write("PART ##{streamer}")
       @leave_handle&.call(streamer)
+      nil
     end
 
-    # @yield
     # @yieldparam message [Twitch::Message]
-    # @yieldreturn [nil]
     # @example
     #   bot.message do |message|
     #     puts "##{message.channel} #{message.sender}: #{message}"
@@ -126,7 +126,7 @@ module Twitch
     end
 
     alias_method :part, :leave
-    alias_method :on_leave, :leave
+    alias_method :on_leave, :left
     alias_method :on_join, :joined
     alias_method :on_message, :message
 
@@ -140,8 +140,8 @@ module Twitch
     end
 
     def dispatch_ready
-      join_all
       @ready_handle&.call
+      join_all
     end
 
     def streams

data/lib/twitch_chatter/models/channel.rb

@@ -4,27 +4,26 @@ module Twitch
   # @!attribute [r] name
   #  @return [Symbol] Name of the channel
   # @example
-  #   channel = Twitch::Channel.new("twitchgaming")
+  #   channel = Twitch::Channel.new(:twitchgaming)
   class Channel
+    # @return [String]
     attr_reader :name
 
-    # @param name [String, Symbol]
-    # @param connection [Bot, nil] For internal usage
-    def initialize(name, connection: nil)
+    # @param [String, Symbol] name
+    # @param [Bot, nil] bot
+    def initialize(name, bot: nil)
       @name = name.to_sym
-      @connection = connection
+      @bot = bot
     end
 
-    # @yield
-    # @yieldparam message [Twitch::Message]
-    # @return [nil]
+    # (see Bot#join)
     def join(&block)
-      @connection.join(@name, &block)
+      @bot.join(@name, &block)
     end
 
-    # @return [nil]
+    # (see Bot#join)
     def leave
-      @connection.leave(@name)
+      @bot.leave(@name)
     end
 
     # @return [Symbol]
@@ -37,6 +36,7 @@ module Twitch
       @name.to_s
     end
 
+    # @return [String]
     def to_url
       "https://twitch.tv/#{@name}"
     end
@@ -44,7 +44,7 @@ module Twitch
     alias_method :link, :to_url
     alias_method :href, :to_url
 
-    # @param other [Channel, String, Symbol]
+    # @param [Channel, String, Symbol] other
     # @return [Boolean]
     def ==(other)
       if other.is_a?(Channel)

data/lib/twitch_chatter/models/message.rb

@@ -1,36 +1,34 @@
 # 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(":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          # => ":justinfan!justinfan@justinfan.tmi.twitch.tv PRIVMSG #justinfan :Hello world!\r\n"
-  class Message < String
-    attr_reader :sender, :channel, :content, :raw
+  class Message
+    # @return [Channel] Sender of the message
+    attr_reader :sender
+    # @return [Channel] Channel the message was sent to
+    attr_reader :channel
+    # @return [String] Content of the message
+    attr_reader :content
+    # @return [String] Raw message from Twitch
+    attr_reader :raw
 
     # @param raw [String] Raw IRC websocket message from Twitch
-    # @param connection [Bot, nil] For internal usage
+    # @param bot [Bot, nil] bot
     # @example
     #   message = Twitch::Message.new(":justinfan!justinfan@justinfan.tmi.twitch.tv PRIVMSG #twitchgaming :Hello world!\r\n")
-    def initialize(raw, connection: nil)
+    def initialize(raw, bot: 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], connection: connection)
+      @bot = bot
+      @channel = Channel.new(split[2][1..-1], bot: bot)
+      @sender = Channel.new(split[0].split("!")[0][1..-1], bot: bot)
       @raw = raw
     end
 
@@ -38,6 +36,8 @@ module Twitch
     alias_method :streamer, :channel
     alias_method :user, :sender
 
+    # Username regexp
+    # @api private
     USERNAME = /[a-zA-Z0-9_]{4,25}/
     # @return [Array<Twitch::Channel>] List of usernames mentioned in the message
     def mentions
@@ -48,12 +48,14 @@ module Twitch
         match = word.match(/@#{USERNAME}/)
         next unless match
 
-        @mentions << Channel.new(match[0][1..-1], connection: @connection)
+        @mentions << Channel.new(match[0][1..-1], bot: @bot)
       end
 
       @mentions
     end
 
+    # Link regexp
+    # @api private
     LINK = %r{(https?://[^\s]+)}
     # @return [Array<String>] List of links mentioned in the message
     # @example

data/lib/twitch_chatter.rb

@@ -3,8 +3,6 @@
 require "async"
 require "async/http/endpoint"
 require "async/websocket/client"
-require_relative "twitch_chatter/models"
-require_relative "twitch_chatter/bot"
 
 # @author Dylan Hackworth <me@dylhack.dev>
 # @example
@@ -20,4 +18,6 @@ require_relative "twitch_chatter/bot"
 #
 #   bot.start
 module Twitch
+  require_relative "twitch_chatter/models"
+  require_relative "twitch_chatter/bot"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitch_chatter
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Dylan Hackworth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-04 00:00:00.000000000 Z
+date: 2024-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-websocket