twitch_chatter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7d4ba180e523e3c21f4124b3b12c166b6e21b7af9f8c6a882ee5a01bb22b543
-  data.tar.gz: 9a92e1418e6f7b95b13ae87fd283365c16e0ec2688ec795457679c512c25efb8
+  metadata.gz: 65e839a944e5c1d2d0bf8049e954c12435872fb290c0027f6b42764375f8a61a
+  data.tar.gz: 0baa96f98a7b0161e44da032bb4c9387faf6c36aacda7be36924cc35f974035d
 SHA512:
-  metadata.gz: 236cea705bb4b56208403dd37dbad1ddf5dc10200a91a9ebdc52a4cbcca9b8424ef853ddef0ef0d32fc3a841b0b1963d4ea1682ab9a84b91298625c33a87d26c
-  data.tar.gz: 8cfe361fb854df8eb88c6ca3abee5b09b81836c1e42ad9462a0fbc4e2874323fbdbbea92f874056d22bc85eca319bbd8955d78a8fe84a33544debc4d44866150
+  metadata.gz: cd559c343272abf40568722b859ecc73806dcb0627bf05e53f3280fe3590c09df9a4e146300353f619a54936c227dca5c5dab9729f6f66f2e70250f1b40524dc
+  data.tar.gz: 622feea1abcd924c2ff8d2fd6310685d5b38f947b2d0e806e46e2e3c0f93ae3fdba52a4b1fcdf48006763b1d0ea472d78becf5969f6928bc6b7f1bcc7dcc36f4

data/lib/twitch_chatter/bot.rb

@@ -0,0 +1,162 @@
+# 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
+
+    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}")
+          dispatch_ready
+
+          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")
+
+            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

@@ -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, String, 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,72 @@
+# 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
+
+    # @param raw [String] Raw IRC websocket message from Twitch
+    # @param connection [Bot, nil] For internal usage
+    # @example
+    #   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
+    end
+
+    alias_method :text, :content
+    alias_method :streamer, :channel
+
+    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/models.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Twitch
+  require_relative "models/channel"
+  require_relative "models/message"
+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,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: twitch_chatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dylan Hackworth
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
-dependencies: []
+date: 2024-05-26 00:00:00.000000000 Z
+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,12 +31,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/twitch_chatter.rb
-homepage: https://github.com/dylhack/twitch-chat-gem
+- lib/twitch_chatter/bot.rb
+- lib/twitch_chatter/models.rb
+- lib/twitch_chatter/models/channel.rb
+- lib/twitch_chatter/models/message.rb
+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
@@ -30,7 +48,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:
   - - ">="
@@ -38,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: []