Merge branch 'empty_alert' into safari

Conflicts:
	notification.go

Author: nathany

README.md

@@ -85,6 +85,10 @@ for ft := range f.Receive() {
 }
 ```
 
+Note that the channel returned from `Receive` will close after the
+[feedback service](https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/CommunicatingWIthAPS.html#//apple_ref/doc/uid/TP40008194-CH101-SW3)
+has no more data to send.
+
 ## Running the tests
 
 We use [Ginkgo](https://onsi.github.io/ginkgo) for our testing framework and

example/example.go

@@ -28,7 +28,7 @@ func main() {
 
 		p := apns.NewPayload()
 		p.APS.Alert.Body = body
-		p.APS.Badge = badge
+		p.APS.Badge = &badge
 
 		p.SetCustomValue("link", "yourapp://precache/20140718")
 

feedback.go

@@ -61,6 +61,8 @@ func NewFeedbackWithFiles(gw string, certFile string, keyFile string) (Feedback,
 	return Feedback{Conn: &conn}, nil
 }
 
+// Receive returns a read only channel for APNs feedback. The returned channel
+// will close when there is no more data to be read.
 func (f Feedback) Receive() <-chan FeedbackTuple {
 	fc := make(chan FeedbackTuple)
 	go f.receive(fc)

notification.go

@@ -38,6 +38,7 @@ type NotificationResult struct {
 }
 
 type Alert struct {
+	// Do not add fields without updating the implementation of isZero.
 	Body         string   `json:"body,omitempty"`
 	Title        string   `json:"title,omitempty"`
 	Action       string   `json:"action,omitempty"`
@@ -47,12 +48,42 @@ type Alert struct {
 	LaunchImage  string   `json:"launch-image,omitempty"`
 }
 
+func (a *Alert) isZero() bool {
+	return len(a.Body) == 0 && len(a.LocKey) == 0 && len(a.LocArgs) == 0 && len(a.ActionLocKey) == 0 && len(a.LaunchImage) == 0
+}
+
 type APS struct {
-	Alert            Alert    `json:"alert,omitempty"`
-	Badge            *int     `json:"badge,omitempty"`
-	Sound            string   `json:"sound,omitempty"`
-	ContentAvailable int      `json:"content-available,omitempty"`
-	URLArgs          []string `json:"url-args,omitempty"`
+	Alert            Alert
+	Badge            *int // 0 to clear notifications, nil to leave as is.
+	Sound            string
+	ContentAvailable int
+	URLArgs          []string
+	Category         string // requires iOS 8+
+}
+
+func (aps APS) MarshalJSON() ([]byte, error) {
+	data := make(map[string]interface{})
+
+	if !aps.Alert.isZero() {
+		data["alert"] = aps.Alert
+	}
+	if aps.Badge != nil {
+		data["badge"] = aps.Badge
+	}
+	if aps.Sound != "" {
+		data["sound"] = aps.Sound
+	}
+	if aps.ContentAvailable != 0 {
+		data["content-available"] = aps.ContentAvailable
+	}
+	if aps.Category != "" {
+		data["category"] = aps.Category
+	}
+	if aps.URLArgs != nil && len(aps.URLArgs) != 0 {
+		data["url-args"] = aps.URLArgs
+	}
+
+	return json.Marshal(data)
 }
 
 type Payload struct {
@@ -62,6 +93,26 @@ type Payload struct {
 	customValues map[string]interface{}
 }
 
+func (p *Payload) MarshalJSON() ([]byte, error) {
+	if len(p.MDM) != 0 {
+		p.customValues["mdm"] = p.MDM
+	} else {
+		p.customValues["aps"] = p.APS
+	}
+
+	return json.Marshal(p.customValues)
+}
+
+func (p *Payload) SetCustomValue(key string, value interface{}) error {
+	if key == "aps" {
+		return errors.New("cannot assign a custom APS value in payload")
+	}
+
+	p.customValues[key] = value
+
+	return nil
+}
+
 type Notification struct {
 	ID          string
 	DeviceToken string
@@ -79,26 +130,6 @@ func NewPayload() *Payload {
 	return &Payload{customValues: map[string]interface{}{}}
 }
 
-func (p *Payload) SetCustomValue(key string, value interface{}) error {
-	if key == "aps" {
-		return errors.New("cannot assign a custom APS value in payload")
-	}
-
-	p.customValues[key] = value
-
-	return nil
-}
-
-func (p *Payload) MarshalJSON() ([]byte, error) {
-	if len(p.MDM) != 0 {
-		p.customValues["mdm"] = p.MDM
-	} else {
-		p.customValues["aps"] = p.APS
-	}
-
-	return json.Marshal(p.customValues)
-}
-
 func (n Notification) ToBinary() ([]byte, error) {
 	b := []byte{}
 

notification_test.go

@@ -104,6 +104,25 @@ var _ = Describe("Notifications", func() {
 
 	Describe("Payload", func() {
 		Describe("#MarshalJSON", func() {
+			Context("no alert (as with Passbook)", func() {
+				It("should not contain the alert struct", func() {
+					p := apns.NewPayload()
+					b, err := json.Marshal(p)
+
+					Expect(err).To(BeNil())
+					Expect(b).To(Equal([]byte(`{"aps":{}}`)))
+				})
+			})
+			Context("no alert with content available (as with Newsstand)", func() {
+				It("should not contain the alert struct", func() {
+					p := apns.NewPayload()
+					p.APS.ContentAvailable = 1
+					b, err := json.Marshal(p)
+
+					Expect(err).To(BeNil())
+					Expect(b).To(Equal([]byte(`{"aps":{"content-available":1}}`)))
+				})
+			})
 			Context("with only APS", func() {
 				It("should marshal APS", func() {
 					p := apns.NewPayload()
@@ -155,7 +174,7 @@ var _ = Describe("Notifications", func() {
 				j, err := json.Marshal(a)
 
 				Expect(err).To(BeNil())
-				Expect(j).To(Equal([]byte(`{"alert":{},"badge":0}`)))
+				Expect(j).To(Equal([]byte(`{"badge":0}`)))
 			})
 		})
 		Context("no badge specified (do nothing)", func() {
@@ -165,7 +184,7 @@ var _ = Describe("Notifications", func() {
 				j, err := json.Marshal(a)
 
 				Expect(err).To(BeNil())
-				Expect(j).To(Equal([]byte(`{"alert":{}}`)))
+				Expect(j).To(Equal([]byte(`{}`)))
 			})
 		})
 	})
@@ -223,7 +242,7 @@ var _ = Describe("Notifications", func() {
 					var frameLen, identifier, expiry uint32
 					var priority byte
 					var tok [32]byte
-					var payload [20]byte
+					var payload [10]byte
 
 					binary.Read(buf, binary.BigEndian, &command)
 					binary.Read(buf, binary.BigEndian, &frameLen)
@@ -254,7 +273,7 @@ var _ = Describe("Notifications", func() {
 					binary.Read(buf, binary.BigEndian, &priority)
 
 					Expect(command).To(Equal(uint8(2)))
-					Expect(frameLen).To(Equal(uint32(76)))
+					Expect(frameLen).To(Equal(uint32(66)))
 
 					// Token
 					Expect(tokID).To(Equal(uint8(1)))
@@ -263,8 +282,8 @@ var _ = Describe("Notifications", func() {
 
 					// Payload
 					Expect(payloadID).To(Equal(uint8(2)))
-					Expect(payloadLen).To(Equal(uint16(20)))
-					Expect(payload).To(Equal([20]byte{123, 34, 97, 112, 115, 34, 58, 123, 34, 97, 108, 101, 114, 116, 34, 58, 123, 125, 125, 125}))
+					Expect(payloadLen).To(Equal(uint16(10)))
+					Expect(payload).To(Equal([10]byte{123, 34, 97, 112, 115, 34, 58, 123, 125, 125}))
 
 					// Identifier
 					Expect(identifierID).To(Equal(uint8(3)))