Merge pull request #78 from twitchdev/feature/eventsub-catchup-july-2021

updating eventsub to match production

Author: lleadbet

.gitignore

@@ -17,7 +17,7 @@ twitch-cli
 *.html
 
 # Editor configs
-.vsvode/
+.vscode/
 .idea/
 
 # junk files

.vscode/settings.json

@@ -28,6 +28,7 @@ var (
 	cost           int64
 	count          int
 	description    string
+	gameID         string
 )
 
 var eventCmd = &cobra.Command{
@@ -90,6 +91,7 @@ func init() {
 	triggerCmd.Flags().StringVarP(&itemName, "item-name", "n", "", "Manually set the name of the event payload item (for example the reward ID in redemption events). For stream events, this is the game title.")
 	triggerCmd.Flags().Int64VarP(&cost, "cost", "C", 0, "Amount of bits or channel points redeemed/used in the event.")
 	triggerCmd.Flags().StringVarP(&description, "description", "d", "", "Title the stream should be updated with.")
+	triggerCmd.Flags().StringVarP(&gameID, "game-id", "G", "", "Sets the game/category ID for applicable events.")
 
 	// retrigger flags
 	retriggerCmd.Flags().StringVarP(&forwardAddress, "forward-address", "F", "", "Forward address for mock event.")
@@ -134,6 +136,7 @@ func triggerCmdRun(cmd *cobra.Command, args []string) {
 			Cost:           cost,
 			Description:    description,
 			ItemName:       itemName,
+			GameID:         gameID,
 		})
 
 		if err != nil {

cmd/events.go

@@ -20,6 +20,7 @@ type MockEventParameters struct {
 	Cost         int64
 	IsPermanent  bool
 	Description  string
+	GameID       string
 }
 
 type MockEventResponse struct {

docs/event.md

@@ -30,6 +30,7 @@ type TriggerParameters struct {
 	Count          int
 	Description    string
 	ItemName       string
+	GameID         string
 }
 
 type TriggerResponse struct {
@@ -53,6 +54,9 @@ func Fire(p TriggerParameters) (string, error) {
 		p.FromUser = util.RandomUserID()
 	}
 
+	if p.GameID == "" {
+		p.GameID = fmt.Sprint(util.RandomInt(10 * 1000))
+	}
 	eventParamaters := events.MockEventParameters{
 		ID:           util.RandomGUID(),
 		Trigger:      p.Event,
@@ -67,6 +71,7 @@ func Fire(p TriggerParameters) (string, error) {
 		ItemID:       p.ItemID,
 		Description:  p.Description,
 		ItemName:     p.ItemName,
+		GameID:       p.GameID,
 	}
 
 	e, err := types.GetByTriggerAndTransport(p.Event, p.Transport)

internal/events/event.go

@@ -1,10 +1,9 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-package authorization_revoke
+package authorization
 
 import (
 	"encoding/json"
-	"errors"
 	"time"
 
 	"github.com/spf13/viper"
@@ -18,11 +17,12 @@ var transportsSupported = map[string]bool{
 	models.TransportEventSub: true,
 }
 
-var triggerSupported = []string{"revoke"}
+var triggerSupported = []string{"revoke", "grant"}
 
 var triggerMapping = map[string]map[string]string{
 	models.TransportEventSub: {
 		"revoke": "user.authorization.revoke",
+		"grant":  "user.authorization.grant",
 	},
 }
 
@@ -66,8 +66,6 @@ func (e Event) GenerateEvent(params events.MockEventParameters) (events.MockEven
 		if err != nil {
 			return events.MockEventResponse{}, err
 		}
-	case models.TransportWebSub:
-		return events.MockEventResponse{}, errors.New("Websub is unsupported for authorization revoke events")
 	default:
 		return events.MockEventResponse{}, nil
 	}

internal/events/trigger/trigger_event.go

@@ -1,6 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-package authorization_revoke
+package authorization
 
 import (
 	"encoding/json"
@@ -29,29 +29,14 @@ func TestEventSub(t *testing.T) {
 	r, err := Event{}.GenerateEvent(params)
 	a.Nil(err)
 
-	var body models.AuthorizationRevokeEventSubResponse // replace with actual value
+	var body models.AuthorizationRevokeEventSubResponse
 	err = json.Unmarshal(r.JSON, &body)
 	a.Nil(err)
 
 	a.NotEmpty(body.Event.ClientID)
 	a.Equal(body.Event.ClientID, body.Subscription.Condition.ClientID)
 	a.Equal("1234", body.Event.ClientID)
 }
-func TestWebSub(t *testing.T) {
-	a := test_setup.SetupTestEnv(t)
-
-	params := *&events.MockEventParameters{
-		FromUserID: fromUser,
-		ToUserID:   toUser,
-		Transport:  models.TransportWebSub,
-		Trigger:    "revoke",
-	}
-
-	_, err := Event{}.GenerateEvent(params)
-	a.NotNil(err)
-
-	// write tests here for websub
-}
 func TestFakeTransport(t *testing.T) {
 	a := test_setup.SetupTestEnv(t)
 

internal/events/types/authorization_revoke/authorization_revoke.go renamed to internal/events/types/authorization/authorization.go

@@ -0,0 +1,107 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+package drop
+
+import (
+	"encoding/json"
+	"fmt"
+	"time"
+
+	"github.com/twitchdev/twitch-cli/internal/events"
+	"github.com/twitchdev/twitch-cli/internal/models"
+	"github.com/twitchdev/twitch-cli/internal/util"
+)
+
+var transportsSupported = map[string]bool{
+	models.TransportWebSub:   false,
+	models.TransportEventSub: true,
+}
+
+var triggerSupported = []string{"drop"}
+
+var triggerMapping = map[string]map[string]string{
+	models.TransportEventSub: {
+		"drop": "drop.entitlement.grant",
+	},
+}
+
+type Event struct{}
+
+func (e Event) GenerateEvent(params events.MockEventParameters) (events.MockEventResponse, error) {
+	var event []byte
+	var err error
+
+	if params.ItemID == "" {
+		params.ItemID = util.RandomGUID()
+	}
+
+	if params.Description == "" {
+		params.Description = fmt.Sprintf("%v", util.RandomInt(1000))
+	}
+	switch params.Transport {
+	case models.TransportEventSub:
+		body := &models.DropsEntitlementEventSubResponse{
+			Subscription: models.EventsubSubscription{
+				ID:      params.ID,
+				Status:  "enabled",
+				Type:    triggerMapping[params.Transport][params.Trigger],
+				Version: "1",
+				Condition: models.EventsubCondition{
+					OrganizationID: params.FromUserID,
+				},
+				Transport: models.EventsubTransport{
+					Method:   "webhook",
+					Callback: "null",
+				},
+				Cost:      0,
+				CreatedAt: util.GetTimestamp().Format(time.RFC3339Nano),
+			},
+			Events: []models.DropsEntitlementEventSubEvent{
+				{
+					ID: util.RandomGUID(),
+					Data: models.DropsEntitlementEventSubEventData{
+						OrganizationID: params.FromUserID,
+						CategoryID:     params.GameID,
+						CategoryName:   "",
+						CampaignID:     util.RandomGUID(),
+						EntitlementID:  util.RandomGUID(),
+						BenefitID:      params.ItemID,
+						UserID:         params.ToUserID,
+						UserName:       params.ToUserName,
+						UserLogin:      params.ToUserName,
+						CreatedAt:      util.GetTimestamp().Format(time.RFC3339Nano),
+					},
+				},
+			},
+		}
+		event, err = json.Marshal(body)
+		if err != nil {
+			return events.MockEventResponse{}, err
+		}
+	default:
+		return events.MockEventResponse{}, nil
+	}
+
+	return events.MockEventResponse{
+		ID:       params.ID,
+		JSON:     event,
+		FromUser: params.FromUserID,
+		ToUser:   params.ToUserID,
+	}, nil
+}
+
+func (e Event) ValidTransport(t string) bool {
+	return transportsSupported[t]
+}
+
+func (e Event) ValidTrigger(t string) bool {
+	for _, ts := range triggerSupported {
+		if ts == t {
+			return true
+		}
+	}
+	return false
+}
+func (e Event) GetTopic(transport string, trigger string) string {
+	return triggerMapping[transport][trigger]
+}

internal/events/types/authorization_revoke/authorization_revoke_test.go renamed to internal/events/types/authorization/authorization_test.go

@@ -0,0 +1,75 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+package drop
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/twitchdev/twitch-cli/internal/events"
+	"github.com/twitchdev/twitch-cli/internal/models"
+	"github.com/twitchdev/twitch-cli/test_setup"
+)
+
+var fromUser = "1234"
+var toUser = "4567"
+
+func TestEventSub(t *testing.T) {
+	a := test_setup.SetupTestEnv(t)
+
+	params := *&events.MockEventParameters{
+		FromUserID: fromUser,
+		ToUserID:   toUser,
+		Transport:  models.TransportEventSub,
+		Trigger:    "drop",
+	}
+
+	r, err := Event{}.GenerateEvent(params)
+	a.Nil(err)
+
+	var body models.DropsEntitlementEventSubResponse
+	err = json.Unmarshal(r.JSON, &body)
+	a.Nil(err)
+
+	a.Len(body.Events, 1)
+}
+
+func TestFakeTransport(t *testing.T) {
+	a := test_setup.SetupTestEnv(t)
+
+	params := *&events.MockEventParameters{
+		FromUserID: fromUser,
+		ToUserID:   toUser,
+		Transport:  "fake_transport",
+		Trigger:    "drop",
+	}
+
+	r, err := Event{}.GenerateEvent(params)
+	a.Nil(err)
+	a.Empty(r)
+}
+func TestValidTrigger(t *testing.T) {
+	a := test_setup.SetupTestEnv(t)
+
+	r := Event{}.ValidTrigger("drop")
+	a.Equal(true, r)
+
+	r = Event{}.ValidTrigger("notdrop")
+	a.Equal(false, r)
+}
+
+func TestValidTransport(t *testing.T) {
+	a := test_setup.SetupTestEnv(t)
+
+	r := Event{}.ValidTransport(models.TransportEventSub)
+	a.Equal(true, r)
+
+	r = Event{}.ValidTransport("noteventsub")
+	a.Equal(false, r)
+}
+func TestGetTopic(t *testing.T) {
+	a := test_setup.SetupTestEnv(t)
+
+	r := Event{}.GetTopic(models.TransportEventSub, "drop")
+	a.NotNil(r)
+}