Improve default logging. Add resubs

Author: ryanwinchester

lib/tmi.ex

@@ -216,6 +216,10 @@ defmodule TMI do
     Logger.debug("[#{bot_string(module)}] WHISPER - <#{event.user_login}> #{event.message}")
   end
 
+  def default_handle_event(%TMI.Events.Unrecognized{msg: %ExIRC.Message{} = msg}, module) do
+    Logger.debug("[#{bot_string(module)}] [#{msg.cmd}] #{inspect(msg.args)}")
+  end
+
   def default_handle_event(event, module) do
     Logger.debug("[#{bot_string(module)}] EVENT\n#{inspect(event, pretty: true)}")
   end
@@ -353,6 +357,11 @@ defmodule TMI do
           params ->
             tag_string
             |> TMI.IRC.Tags.parse!()
+            |> tap(fn tags ->
+              if Map.get(tags, "custom-reward-id") do
+                IO.inspect(msg, pretty: true)
+              end
+            end)
             |> TMI.Event.from_map_with_name(:message, params)
         end
 

lib/tmi/events/channel_update.ex

@@ -3,8 +3,11 @@ defmodule TMI.Events.ChannelUpdate do
   When we get a ROOMSTATE notice in IRC or a chat settings update from EventSub.
   """
   use TMI.Event, fields: [
-    # TODO: Follower-only, sub-only, slow-mode, unique (is that r9k?)?
     :emote_only?,
+    :followers_only?,
+    :unique_only?,
+    :subs_only?,
+    :slow_delay,
     :channel_id,
     :channel
   ]

lib/tmi/events/message.ex

@@ -20,6 +20,7 @@ defmodule TMI.Events.Message do
       :timestamp,
       :user_id,
       :user_login,
-      :user_type
+      :user_type,
+      :reward_id
     ]
 end

lib/tmi/events/resub.ex

@@ -0,0 +1,35 @@
+defmodule TMI.Events.Resub do
+  @moduledoc """
+  Sub event.
+  IRC `msg-id` is `sub` and EventSub name is `sub`.
+  """
+  use TMI.Event,
+    fields: [
+      :id,
+      :channel_id,
+      :channel,
+      :plan,
+      :plan_name,
+      :system_message,
+      :timestamp,
+      :gifted?,
+      :goal_type,
+      :goal_current,
+      :goal_target,
+      :goal_contributions,
+      :share_streak?,
+      :months,
+      :badge_info,
+      :badges,
+      :color,
+      :cumulative_months,
+      :login,
+      :display_name,
+      :is_mod?,
+      :is_turbo?,
+      :is_sub?,
+      :is_vip?,
+      :user_id,
+      :user_type
+    ]
+end

lib/tmi/events/sub.ex

@@ -19,7 +19,6 @@ defmodule TMI.Events.Sub do
       :goal_contributions,
       :share_streak?,
       :months,
-      # --- user fields ---
       :badge_info,
       :badges,
       :color,
@@ -31,10 +30,6 @@ defmodule TMI.Events.Sub do
       :is_sub?,
       :is_vip?,
       :user_id,
-      :user_type,
-      # --- recipient fields ---
-      :recipient_display_name,
-      :recipient_id,
-      :recipient_login
+      :user_type
     ]
 end

lib/tmi/fields.ex

@@ -419,7 +419,7 @@ defmodule TMI.Fields do
   Applies only to messages with more than 9 characters. Is `true` if users must
   post unique messages; otherwise, `false`.
   """
-  @type r9k? :: boolean()
+  @type unique_only? :: boolean()
 
   @typedoc """
   Twitch IRC tag `returning-chatter`.
@@ -609,6 +609,12 @@ defmodule TMI.Fields do
   """
   @type is_vip? :: boolean()
 
+  @typedoc """
+  [UNDOCUMENTED]
+  Twitch IRC tag `custom-reward-id`. Got this in a message that was a custom reward.
+  """
+  @type reward_id :: String.t()
+
   ## Unrecognized stuff...
 
   @typedoc """

lib/tmi/handler.ex

@@ -5,7 +5,7 @@ defmodule TMI.Handler do
 
   ## The common bits...
 
-  @callback handle_event(TMI.event()) :: any
+  @callback handle_event(event :: TMI.event()) :: any
 
   @callback handle_mention(message :: String.t(), sender :: String.t(), channel :: String.t()) ::
               any

lib/tmi/irc/parsing/event_mapping.ex

@@ -28,7 +28,7 @@ defmodule TMI.IRC.Parsing.EventMapping do
     #   "" => :sub,
     #   "" => :sub_message,
     #   "" => :sub_end,
-    #   "" => :resub,
+    "resub" => :resub,
     #   "" => :sub_gift,
     "submysterygift" => :community_sub_gift,
     "subgift" => :sub_gift,

lib/tmi/irc/parsing/tag_mapping.ex

@@ -8,6 +8,7 @@ defmodule TMI.IRC.Parsing.TagMapping do
     "bits" => :bits,
     "client-nonce" => :client_nonce,
     "color" => :color,
+    "custom-reward-id" => :reward_id,
     "display-name" => :display_name,
     "emotes" => :emotes,
     "emote-only" => :emote_only?,
@@ -69,7 +70,7 @@ defmodule TMI.IRC.Parsing.TagMapping do
     "pinned-chat-paid-exponent" => :exponent,
     "pinned-chat-paid-is-system-message" => :system_message?,
     "pinned-chat-paid-level" => :level,
-    "r9k" => :r9k?,
+    "r9k" => :unique_only?,
     "reply-parent-display-name" => :parent_user_display_name,
     "reply-parent-msg-body" => :parent_message,
     "reply-parent-msg-id" => :parent_id,

lib/tmi/irc/tags.ex

@@ -200,6 +200,10 @@ defmodule TMI.IRC.Tags do
     {tag_name(key), String.to_integer(val)}
   end
 
+  defp tag_map({"slow" = key, val}) do
+    {tag_name(key), String.to_integer(val)}
+  end
+
   defp tag_map({"user-type" = key, val}) do
     type =
       case val do
@@ -276,6 +280,10 @@ defmodule TMI.IRC.Tags do
     {tag_name(key), val == "1"}
   end
 
+  defp tag_map({"r9k" = key, val}) do
+    {tag_name(key), val == "1"}
+  end
+
   defp tag_map({"msg-param-prior-gifter-anonymous" = key, val}) do
     {tag_name(key), val == "true"}
   end