Skip to content

Commit

Permalink
add new isSystemMessage & level to PrivateMessage pinnedChat
Browse files Browse the repository at this point in the history
  • Loading branch information
@MahdiBM
MahdiBM committed Jun 24, 2023
1 parent 218db80 commit 70f97da
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 22 deletions.
16 changes: 12 additions & 4 deletions Sources/TwitchIRC/IncomingMessage/PrivateMessage.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,17 +53,23 @@ public struct PrivateMessage: MessageWithBadges {
public var canonicalAmount = UInt()
public var currency = String()
public var exponent = UInt()

public var isSystemMessage = Bool()
public var level = String()

internal init(
amount: UInt,
canonicalAmount: UInt,
currency: String,
exponent: UInt
exponent: UInt,
isSystemMessage: Bool,
level: String
) {
self.amount = amount
self.canonicalAmount = canonicalAmount
self.currency = currency
self.exponent = exponent
self.isSystemMessage = isSystemMessage
self.level = level
}

public init() { }
Expand Down Expand Up @@ -188,11 +194,13 @@ public struct PrivateMessage: MessageWithBadges {
amount: parser.uint(for: "pinned-chat-paid-amount"),
canonicalAmount: parser.uint(for: "pinned-chat-paid-canonical-amount"),
currency: parser.string(for: "pinned-chat-paid-currency"),
exponent: parser.uint(for: "pinned-chat-paid-exponent")
exponent: parser.uint(for: "pinned-chat-paid-exponent"),
isSystemMessage: parser.bool(for: "pinned-chat-paid-is-system-message"),
level: parser.string(for: "pinned-chat-paid-level")
)

let deprecatedKeys = ["turbo", "mod", "vip", "subscriber", "user-type"]
let occasionalKeys = [["crowd-chant-parent-msg-id"], ["bits"], ["emote-only"], ["msg-id"], ["custom-reward-id"], ["client-nonce"], ["flags"], ["first-msg"], ["reply-parent-display-name", "reply-parent-user-login", "reply-parent-msg-body", "reply-parent-msg-id", "reply-parent-user-id"], ["pinned-chat-paid-amount", "pinned-chat-paid-canonical-amount", "pinned-chat-paid-currency", "pinned-chat-paid-exponent"], ["reply-thread-parent-user-login", "reply-thread-parent-msg-id"]]
let occasionalKeys = [["crowd-chant-parent-msg-id"], ["bits"], ["emote-only"], ["msg-id"], ["custom-reward-id"], ["client-nonce"], ["flags"], ["first-msg"], ["reply-parent-display-name", "reply-parent-user-login", "reply-parent-msg-body", "reply-parent-msg-id", "reply-parent-user-id"], ["pinned-chat-paid-amount", "pinned-chat-paid-canonical-amount", "pinned-chat-paid-currency", "pinned-chat-paid-exponent"], ["pinned-chat-paid-is-system-message", "pinned-chat-paid-level"], ["reply-thread-parent-user-login", "reply-thread-parent-msg-id"]]

self.parsingLeftOvers = parser.getLeftOvers(
excludedUnusedKeys: deprecatedKeys,
Expand Down
41 changes: 23 additions & 18 deletions Tests/TwitchIRCTests/IncomingMessageTests/PrivateMessageTests.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -247,41 +247,44 @@ final class PrivateMessageTests: XCTestCase {

/// Tests `pinnedChat`.
func testParsedValues8() throws {
let string = "@badge-info=subscriber/3;badges=vip/1,subscriber/3,sub-gifter/300;color=#FFFF00;display-name=2Taqz;emotes=;first-msg=0;flags=;id=cd943357-38bf-4bc9-b524-c0da490dcc36;mod=0;pinned-chat-paid-amount=1200;pinned-chat-paid-canonical-amount=10;pinned-chat-paid-currency=EUR;pinned-chat-paid-exponent=2;returning-chatter=0;room-id=117855516;subscriber=1;tmi-sent-ts=1664561279533;turbo=0;user-id=249610052;user-type=;vip=1 :2taqz!2taqz@2taqz.tmi.twitch.tv PRIVMSG #domino :und wieder 12€ verbrennen"
let string = #"@badge-info=subscriber/8;badges=vip/1,subscriber/6,sub-gift-leader/1;color=#00FF7F;display-name=r3born_9999;emotes=;first-msg=0;flags=;id=011c7c65-6bab-4a9c-973e-2e04154e3877;mod=0;pinned-chat-paid-amount=100;pinned-chat-paid-canonical-amount=100;pinned-chat-paid-currency=USD;pinned-chat-paid-exponent=2;pinned-chat-paid-is-system-message=0;pinned-chat-paid-level=ONE;returning-chatter=0;room-id=123721524;subscriber=1;tmi-sent-ts=1687641306105;turbo=0;user-id=767491027;user-type=;vip=1 :r3born_9999!r3born_9999@r3born_9999.tmi.twitch.tv PRIVMSG #juicyjcr :will gift 5 subs as well if u clutch up"#

let msg: PrivateMessage = try TestUtils.parseAndUnwrap(string: string)

XCTAssertEqual(msg.channel, "domino")
XCTAssertEqual(msg.message, "und wieder 12€ verbrennen")
XCTAssertEqual(msg.badgeInfo, ["subscriber/3"])
XCTAssertEqual(msg.badges, ["vip/1", "subscriber/3", "sub-gifter/300"])
XCTAssertEqual(msg.channel, "juicyjcr")
XCTAssertEqual(msg.message, "will gift 5 subs as well if u clutch up")
XCTAssertEqual(msg.badgeInfo, ["subscriber/8"])
XCTAssertEqual(msg.badges, ["vip/1", "subscriber/6", "sub-gift-leader/1"])
XCTAssertEqual(msg.bits, "")
XCTAssertEqual(msg.color, "#FFFF00")
XCTAssertEqual(msg.displayName, "2Taqz")
XCTAssertEqual(msg.userLogin, "2taqz")
XCTAssertEqual(msg.color, "#00FF7F")
XCTAssertEqual(msg.displayName, "r3born_9999")
XCTAssertEqual(msg.userLogin, "r3born_9999")
XCTAssertEqual(msg.emotes, "")
XCTAssertEqual(msg.emoteOnly, false)
XCTAssertEqual(msg.flags, [])
XCTAssertEqual(msg.firstMessage, false)
XCTAssertEqual(msg.returningChatter, false)
XCTAssertEqual(msg.messageId, "")
XCTAssertEqual(msg.id, "cd943357-38bf-4bc9-b524-c0da490dcc36")
XCTAssertEqual(msg.id, "011c7c65-6bab-4a9c-973e-2e04154e3877")
XCTAssertEqual(msg.crowdChantParentMessageId, "")
XCTAssertEqual(msg.customRewardId, "")
XCTAssertEqual(msg.roomId, "117855516")
XCTAssertEqual(msg.tmiSentTs, 1664561279533)
XCTAssertEqual(msg.roomId, "123721524")
XCTAssertEqual(msg.tmiSentTs, 1687641306105)
XCTAssertEqual(msg.clientNonce, "")
XCTAssertEqual(msg.userId, "249610052")
XCTAssertEqual(msg.userId, "767491027")
XCTAssertTrue(msg.replyParent == .init())
XCTAssertTrue(msg.pinnedChat == .init(
amount: 1200,
canonicalAmount: 10,
currency: "EUR",
exponent: 2
))
amount: 100,
canonicalAmount: 100,
currency: "USD",
exponent: 2,
isSystemMessage: false,
level: "ONE"
), "\(msg.pinnedChat)")
XCTAssertTrue(msg.parsingLeftOvers.isEmpty, "Non-empty parsing left-overs: \(msg.parsingLeftOvers)")
}

/// Reply Thread Parent
func testParsedValues9() throws {
let string = #"@badge-info=predictions/Pompeyo;badges=predictions/blue-1,premium/1;client-nonce=c5639d11fdac91cad488f52a0c0a927a;color=#FFF200;display-name=fladhi;emotes=;first-msg=0;flags=;id=c96d75f7-6fe0-41d0-bd27-80643426613c;mod=0;reply-parent-display-name=RoyaleAlchemist;reply-parent-msg-body=Clash\sRoyale\sAPI\sestá\sde\svuelta\sPogChamp\sPogChamp\s.\sSi\shubo\sun\smantenimiento\so\suna\sinterrupción\sdel\sservicio,\sya\sdebería\shaber\sterminado.\sRoyale\sAlchemist\snecesitará\sentre\s5\sy\s1 0\sminutos\spara\srecuperarse\spor\scompleto\s|\s@Pompeyo4;reply-parent-msg-id=0e772349-8bcd-42cb-9c91-1c9eece83af8;reply-parent-user-id=684111155;reply-parent-user-login=royalealchemist;reply-thread-parent-msg-id=0e772349-8bcd-42cb-9c91-1c9eece83af8;reply-thread-parent-user-login=royalealchemist;returning-chatter=0;room-id=118220323;subscriber=0;tmi-sent-ts=1687334511793;turbo=0;user-id=686358047;user-type= :[email protected] PRIVMSG #pompeyo4 :@RoyaleAlchemist whoAsked"#

Expand Down Expand Up @@ -350,4 +353,6 @@ private func == (lhs: PrivateMessage.PinnedChat, rhs: PrivateMessage.PinnedChat)
&& lhs.amount == rhs.amount
&& lhs.currency == rhs.currency
&& lhs.canonicalAmount == rhs.canonicalAmount
&& lhs.isSystemMessage == rhs.isSystemMessage
&& lhs.level == rhs.level
}

0 comments on commit 70f97da

Please sign in to comment.