Merge pull request #283 from montymxb/push-status

Added ParsePushStatus class and updated tests.

Author: Benjamin Wilson Friedman

README.md

@@ -231,10 +231,33 @@ ParsePush::send(array(
     "data" => $data
 ), true);
 
-// Get Push Status Id
-$reponse = ParsePush::send($data, true);
-if(isset($response['_headers']['X-Push-Status-Id'])) {
-    // Retrieve info on _PushStatus using the id
+// Get Push Status
+$response = ParsePush::send($data, true);
+if(ParsePush::hasStatus($response)) {
+
+    // Retrieve PushStatus object
+    $pushStatus = ParsePush::getStatus($response);
+    
+    // get push status string
+    $status = $pushStatus->getPushStatus();
+    
+    if($status == "succeeded") {
+        // handle a successful push request
+        
+    } else if($status == "running") {
+        // handle a running push request
+        
+    } else if($status == "failed") {
+        // push request did not succeed
+        
+    }
+    
+    // get # pushes sent
+    $sent = $pushStatus->getPushesSent();
+    
+    // get # pushes failed
+    $failed = $pushStatus->getPushesFailed();
+    
 }
 ```
 

src/Parse/ParseClient.php

@@ -122,6 +122,10 @@ public static function initialize($app_id, $rest_key, $master_key, $enableCurlEx
             ParseInstallation::registerSubclass();
         }
 
+        if(!ParseObject::hasRegisteredSubclass('_PushStatus')) {
+            ParsePushStatus::registerSubclass();
+        }
+
         ParseSession::registerSubclass();
         self::$applicationId = $app_id;
         self::$restKey = $rest_key;

src/Parse/ParsePush.php

@@ -77,4 +77,50 @@ public static function send($data, $useMasterKey = false)
             true
         );
     }
+
+    /**
+     * Returns whether or not the given response has a push status
+     * Checks to see if X-Push-Status-Id is present in $response
+     *
+     * @param array $response    Response from ParsePush::send
+     * @return bool
+     */
+    public static function hasStatus($response)
+    {
+        return(
+            isset($response['_headers']) &&
+            isset($response['_headers']['X-Parse-Push-Status-Id'])
+        );
+
+    }
+
+    /**
+     * Returns the PushStatus for a response from ParsePush::send
+     *
+     * @param array $response   Response from ParsePush::send
+     * @return null|ParsePushStatus
+     */
+    public static function getStatus($response)
+    {
+        if(!isset($response['_headers'])) {
+            // missing headers
+            return null;
+
+        }
+
+        $headers = $response['_headers'];
+
+        if(!isset($headers['X-Parse-Push-Status-Id'])) {
+            // missing push status id
+            return null;
+
+        }
+
+        // get our push status id
+        $pushStatusId = $response['_headers']['X-Parse-Push-Status-Id'];
+
+        // return our push status if it exists
+        return ParsePushStatus::getFromId($pushStatusId);
+
+    }
 }

src/Parse/ParsePushStatus.php

@@ -0,0 +1,133 @@
+<?php
+
+namespace Parse;
+
+/**
+ * ParsePushStatus - Representation of PushStatus for push notifications
+ *
+ * @author Ben Friedman <[email protected]>
+ */
+class ParsePushStatus extends ParseObject
+{
+    public static $parseClassName = '_PushStatus';
+
+    /**
+     * Returns a push status object or null from an id
+     *
+     * @param string $id    Id to get this push status by
+     * @return ParsePushStatus|null
+     */
+    public static function getFromId($id)
+    {
+        try {
+            // return the associated PushStatus object
+            $query = new ParseQuery(self::$parseClassName);
+            return $query->get($id, true);
+
+        } catch (ParseException $pe) {
+            // no push found
+            return null;
+
+        }
+
+    }
+
+    /**
+     * Gets the time this push was sent at
+     *
+     * @return \DateTime
+     */
+    public function getPushTime()
+    {
+        return new \DateTime($this->get("pushTime"));
+
+    }
+
+    /**
+     * Gets the query used to send this push
+     *
+     * @return ParseQuery
+     */
+    public function getPushQuery()
+    {
+        $query = $this->get("query");
+
+        // get the conditions
+        $queryConditions = json_decode($query, true);
+
+        // setup a query
+        $query = new ParseQuery(self::$parseClassName);
+
+        // set the conditions
+        $query->_setConditions($queryConditions);
+
+        return $query;
+
+    }
+
+    /**
+     * Gets the payload
+     *
+     * @return array
+     */
+    public function getPushPayload()
+    {
+        return json_decode($this->get("payload"), true);
+
+    }
+
+    /**
+     * Gets the source of this push
+     *
+     * @return string
+     */
+    public function getPushSource()
+    {
+        return $this->get("source");
+
+    }
+
+    /**
+     * Gets the status of this push
+     *
+     * @return string
+     */
+    public function getPushStatus()
+    {
+        return $this->get("status");
+
+    }
+
+    /**
+     * Gets the number of pushes sent
+     *
+     * @return int
+     */
+    public function getPushesSent()
+    {
+        return $this->get("numSent");
+
+    }
+
+    /**
+     * Gets the hash for this push
+     *
+     * @return string
+     */
+    public function getPushHash()
+    {
+        return $this->get("pushHash");
+
+    }
+
+    /**
+     * Gets the number of pushes failed
+     *
+     * @return int
+     */
+    public function getPushesFailed()
+    {
+        return $this->get("numFailed");
+
+    }
+}

src/Parse/ParseQuery.php

@@ -134,6 +134,30 @@ private function addCondition($key, $condition, $value)
         $this->where[$key][$condition] = ParseClient::_encode($value, true);
     }
 
+    /**
+     * Sets the conditions of this parse query from an array
+     *
+     * @param array $conditions Array of Conditions to set
+     * @throws ParseException
+     */
+    public function _setConditions($conditions)
+    {
+        if(!is_array($conditions)) {
+            throw new ParseException("Conditions must be in an array");
+
+        }
+
+        // iterate over and add each condition
+        foreach($conditions as $key => $entry) {
+            foreach($entry as $condition => $value) {
+                $this->addCondition($key, $condition, $value);
+
+            }
+
+        }
+
+    }
+
     /**
      * Add a constraint to the query that requires a particular key's value to
      * be not equal to the provided value.

tests/Parse/ParseObjectTest.php

@@ -6,6 +6,7 @@
 use Parse\ParseACL;
 use Parse\ParseInstallation;
 use Parse\ParseObject;
+use Parse\ParsePushStatus;
 use Parse\ParseQuery;
 use Parse\ParseRole;
 use Parse\ParseSession;
@@ -997,6 +998,7 @@ public function testNoRegisteredSubclasses()
         ParseRole::_unregisterSubclass();
         ParseInstallation::_unregisterSubclass();
         ParseSession::_unregisterSubclass();
+        ParsePushStatus::_unregisterSubclass();
 
         new ParseObject('TestClass');