Add GetInvitedFriends, RemoveInvitedFriend client funcs (#47)

closes #46

Author: mooseburgr

models.go

@@ -400,6 +400,31 @@ type inviteFriendSettings struct {
 	FilterTelevision  string `json:"filterTelevision"`
 }
 
+type invitedFriendsResponse struct {
+	XMLName           xml.Name        `xml:"MediaContainer"`
+	FriendlyName      string          `xml:"friendlyName,attr"`
+	Identifier        string          `xml:"identifier,attr"`
+	MachineIdentifier string          `xml:"machineIdentifier,attr"`
+	Size              int             `xml:"size,attr"`
+	InvitedFriends    []InvitedFriend `xml:"Invite"`
+}
+
+type InvitedFriend struct {
+	ID           string `xml:"id,attr"`
+	CreatedAt    string `xml:"createdAt,attr"`
+	IsFriend     bool   `xml:"friend,attr"`
+	IsHome       bool   `xml:"home,attr"`
+	IsServer     bool   `xml:"server,attr"`
+	Username     string `xml:"username,attr"`
+	Email        string `xml:"email,attr"`
+	Thumb        string `xml:"thumb,attr"`
+	FriendlyName string `xml:"friendlyName,attr"`
+	Server       struct {
+		Name         string `xml:"name,attr"`
+		NumLibraries string `xml:"numLibraries,attr"`
+	} `xml:"Server"`
+}
+
 type resourcesResponse struct {
 	XMLName xml.Name     `xml:"MediaContainer"`
 	Size    int          `xml:"size,attr"`

plex.go

@@ -20,7 +20,11 @@ import (
 	"github.com/google/uuid"
 )
 
-const plexURL = "https://plex.tv"
+const (
+	plexURL         = "https://plex.tv"
+	applicationXml  = "application/xml"
+	applicationJson = "application/json"
+)
 
 func defaultHeaders() headers {
 	version := "0.0.1"
@@ -34,8 +38,8 @@ func defaultHeaders() headers {
 		ClientIdentifier: "go-plex-client-v" + version,
 		ContainerSize:    "Plex-Container-Size=50",
 		ContainerStart:   "X-Plex-Container-Start=0",
-		Accept:           "application/json",
-		ContentType:      "application/json",
+		Accept:           applicationJson,
+		ContentType:      applicationJson,
 	}
 }
 
@@ -118,7 +122,7 @@ func SignIn(username, password string) (*Plex, error) {
 	newHeaders := p.Headers
 	// Doesn't like having a content type, even form-data
 	newHeaders.ContentType = "application/x-www-form-urlencoded"
-	newHeaders.Accept = "application/json"
+	newHeaders.Accept = applicationJson
 	resp, err := p.post(query, []byte(body.Encode()), newHeaders)
 
 	if err != nil {
@@ -548,7 +552,7 @@ func (p *Plex) GetFriends() ([]Friends, error) {
 
 	newHeaders := p.Headers
 
-	newHeaders.Accept = "application/xml"
+	newHeaders.Accept = applicationXml
 
 	resp, err := p.get(query, newHeaders)
 
@@ -733,6 +737,70 @@ func (p *Plex) RemoveFriendAccessToLibrary(userID, machineID, serverID string) (
 	return true, nil
 }
 
+// GetInvitedFriends get all invited friends with request still pending
+func (p *Plex) GetInvitedFriends() ([]InvitedFriend, error) {
+
+	query := plexURL + "/api/invites/requested"
+	newHeaders := p.Headers
+	newHeaders.Accept = applicationXml
+
+	resp, err := p.get(query, newHeaders)
+	if err != nil {
+		return []InvitedFriend{}, err
+	}
+
+	if resp.StatusCode == http.StatusUnauthorized {
+		return []InvitedFriend{}, errors.New(ErrorNotAuthorized)
+	} else if resp.StatusCode != http.StatusOK {
+		return []InvitedFriend{}, fmt.Errorf(ErrorServerReplied, resp.StatusCode)
+	}
+
+	var invitedFriendsResp invitedFriendsResponse
+	defer resp.Body.Close()
+	err = xml.NewDecoder(resp.Body).Decode(&invitedFriendsResp)
+	if err != nil {
+		return []InvitedFriend{}, err
+	}
+
+	return invitedFriendsResp.InvitedFriends, nil
+}
+
+// RemoveInvitedFriend cancel pending friend invite
+func (p *Plex) RemoveInvitedFriend(inviteID string, isFriend, isServer, isHome bool) (bool, error) {
+	query := plexURL + "/api/invites/requested/" + url.QueryEscape(inviteID)
+
+	parsedQuery, parseErr := url.Parse(query)
+	if parseErr != nil {
+		return false, parseErr
+	}
+
+	vals := parsedQuery.Query()
+	vals.Add("friend", boolToOneOrZero(isFriend))
+	vals.Add("server", boolToOneOrZero(isServer))
+	vals.Add("home", boolToOneOrZero(isHome))
+
+	parsedQuery.RawQuery = vals.Encode()
+
+	query = parsedQuery.String()
+
+	resp, err := p.delete(query, p.Headers)
+	if err != nil {
+		return false, err
+	}
+
+	defer resp.Body.Close()
+	if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusBadRequest {
+		return false, errors.New(resp.Status)
+	}
+
+	result := new(resultResponse)
+	if err := xml.NewDecoder(resp.Body).Decode(result); err != nil {
+		return false, err
+	}
+
+	return result.Response.Code == 0, nil
+}
+
 // CheckUsernameOrEmail will check if the username is a Plex user or will verify an email is valid
 func (p *Plex) CheckUsernameOrEmail(usernameOrEmail string) (bool, error) {
 
@@ -767,7 +835,7 @@ func (p *Plex) StopPlayback(machineID string) error {
 
 	newHeaders := p.Headers
 
-	newHeaders.Accept = "application/xml"
+	newHeaders.Accept = applicationXml
 	newHeaders.TargetClientIdentifier = machineID
 
 	resp, err := p.get(query, newHeaders)
@@ -898,7 +966,7 @@ func (p *Plex) GetSections(machineID string) ([]ServerSections, error) {
 
 	newHeaders := p.Headers
 
-	newHeaders.Accept = "application/xml"
+	newHeaders.Accept = applicationXml
 
 	resp, err := p.get(query, newHeaders)
 
@@ -1230,7 +1298,7 @@ func (p *Plex) TerminateSession(sessionID string, reason string) error {
 	query := fmt.Sprintf("%s/status/sessions/terminate?sessionId=%s&reason=%s", p.URL, sessionID, reason)
 
 	newHeaders := p.Headers
-	newHeaders.Accept = "application/xml"
+	newHeaders.Accept = applicationXml
 
 	resp, err := p.get(query, newHeaders)
 

plex_test.go

@@ -33,7 +33,7 @@ func init() {
 func newTestServer(code int, body string) (*httptest.Server, *Plex) {
 	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		w.WriteHeader(code)
-		w.Header().Set("Content-Type", "application/xml")
+		w.Header().Set("Content-Type", applicationXml)
 		fmt.Fprintln(w, body)
 	}))
 
@@ -191,3 +191,32 @@ func TestInviteFriendResponse(t *testing.T) {
 		t.Error(err.Error())
 	}
 }
+
+func TestPlex_GetInvitedFriends_Response(t *testing.T) {
+	testData := []byte(`
+<?xml version="1.0" encoding="UTF-8"?>
+<MediaContainer friendlyName="myPlex" identifier="com.plexapp.plugins.myplex" machineIdentifier="abc123abc123abc123abc123abc123abc123" size="3">
+  <Invite id="email1@gmail.com" createdAt="1639964970" friend="0" home="0" server="1" username="" email="email1@gmail.com" thumb="" friendlyName="email1@gmail.com">
+    <Server name="Server123" numLibraries="3"/>
+  </Invite>
+  <Invite id="19661994" createdAt="1643379560" friend="0" home="1" server="0" username="home-user" email="home-user@gmail.com" thumb="https://plex.tv/users/abc/avatar?c=123" friendlyName="home-user"/>
+  <Invite id="22522496" createdAt="1643574613" friend="1" home="0" server="1" username="existing-user" email="existing-user@umn.edu" thumb="https://plex.tv/users/xyz/avatar?c=456" friendlyName="existing-user">
+    <Server name="Server123" numLibraries="3"/>
+  </Invite>
+</MediaContainer>
+	`)
+
+	result := new(invitedFriendsResponse)
+
+	if err := xml.Unmarshal(testData, result); err != nil {
+		t.Error(err.Error())
+	}
+}
+
+func TestPlex_RemoveInvitedFriend(t *testing.T) {
+	success, err := plexConn.RemoveInvitedFriend("email-id-dne@gmail.com", false, true, false)
+	if err.Error() != "404 Not Found" {
+		// expect a 404
+		t.Errorf("success: %v, error: %v", success, err)
+	}
+}

utils.go

@@ -172,7 +172,7 @@ func (p *Plex) post(query string, body []byte, h headers) (*http.Response, error
 		return &http.Response{}, err
 	}
 
-	// req.Header.Set("Content-Type", "application/json")
+	// req.Header.Set("Content-Type", applicationJson)
 	req.Header.Add("Accept", h.Accept)
 	req.Header.Add("X-Plex-Platform", h.Platform)
 	req.Header.Add("X-Plex-Platform-Version", h.PlatformVersion)
@@ -271,3 +271,11 @@ func (p *Plex) put(query string, body []byte, h headers) (*http.Response, error)
 
 	return resp, nil
 }
+
+func boolToOneOrZero(input bool) string {
+	if input {
+		return "1"
+	} else {
+		return "0"
+	}
+}