Cancel message test, some debugging and phpdoc fixes

Author: Roemerb

.gitignore

@@ -1,3 +1,4 @@
 .apikey
+*.swp
 .idea/
 vendor/

src/Spryng/SpryngRestApi/Resources/MessageClient.php

@@ -27,11 +27,10 @@ class MessageClient extends BaseClient
         'scheduled_from',
         'scheduled_until',
         'status'
-    ]
+    ];
 
     public function create(Message $message)
     {
-        Utils::assert($message->encoding);
         Utils::assert($message->body);
         Utils::assert($message->originator);
         Utils::assert($message->recipients);
@@ -48,15 +47,17 @@ public function create(Message $message)
             ->addParameter('originator', $message->getOriginator())
             ->addParameter('recipients', $message->getRecipients())
             ->addParameter('reference', $message->getReference())
+            ->addParameter('scheduled_at', $message->getScheduledAt())
             ->send();
     }
-    
+
     /**
      * List existing message instances. Use $filters to filter the results
      *
      * @param string[] $filters Filters to limit the results
-     * 
-     * @return Spryng\SpryngRestApi\Http\Response
+     *
+     * @return Response|null
+     * @throws ValidationException
      */
     public function list($filters = [])
     {
@@ -83,12 +84,16 @@ public function list($filters = [])
     /**
      * Cancel a message scheduled in the future.
      *
-     * @param mixed $id The ID of the message to be canceled
+     * @param string|Message $id The ID of the message to be canceled
      * 
-     * @return Spryng\SpryngRestApi\Http\Response
+     * @return Response
      */
     public function cancel($id)
     {
+        if ($id instanceof Message) // also allow message instances
+        {
+            $id = $id->getId();
+        }
         return (new Request(
             $this->api->getBaseUrl(),
             HttpClient::METHOD_POST,

src/Spryng/SpryngRestApi/Utils.php

@@ -2,7 +2,7 @@
 
 namespace Spryng\SpryngRestApi;
 
-use Spryng\SpryngRestApi\Exceptions;
+use Spryng\SpryngRestApi\Exceptions\ValidationException;
 
 class Utils
 {       

test/MessageTest.php

@@ -3,6 +3,7 @@
 namespace Spryng\SpryngRestApi\Test;
 
 use PHPUnit\Framework\TestCase;
+use Spryng\SpryngRestApi\Exceptions\ValidationException;
 use Spryng\SpryngRestApi\Objects\Message;
 use Spryng\SpryngRestApi\Spryng;
 
@@ -13,7 +14,7 @@ class MessageTest extends TestCase
 {
     protected $API_KEY;
     protected $RECIPIENT = [''];
-    protected $messageId = '';
+    protected $messageId = '90797ce7-a20d-434a-9c00-553e31d9ce03';
 
     /**
      * @var Spryng
@@ -34,12 +35,24 @@ public function testSendMessage()
         $message->setBody('test!');
         $message->setRecipients($this->RECIPIENT);
         $message->setOriginator('Spryng');
+        $message->setEncoding('plain');
 
-        $response = $this->instance->message->send($message);
+        $response = $this->instance->message->create($message);
 
         $this->assertTrue($response->wasSuccessful());
     }
 
+    public function testMissingRequiredParametersThrowsException()
+    {
+        $message = new Message();
+        $message->setBody('test!');
+        $message->setRecipients($this->RECIPIENT);
+        // Originator is missing
+
+        $this->expectException(ValidationException::class);
+        $this->instance->message->create($message);
+    }
+
     public function testGetMessage()
     {
         $response = $this->instance->message->show($this->messageId);
@@ -53,6 +66,22 @@ public function testGetMessage()
         $this->assertNotNull($obj->getCreatedAt());
     }
 
+    public function testScheduleAndCancelMessage()
+    {
+        $message = new Message();
+        $message->setBody('Scheduled');
+        $message->setOriginator('Spryng');
+        $message->setRecipients($this->RECIPIENT);
+        $message->setScheduledAt('2022-01-01T15:00:00+00:00');
+
+        $response = $this->instance->message->create($message);
+        $this->assertTrue($response->wasSuccessful());
+        $message = $response->toObject();
+
+        $response = $this->instance->message->cancel($message->getId());
+        $this->assertTrue($response->wasSuccessful());
+    }
+
     public function testShowAll()
     {
         $response = $this->instance->message->showAll(1, 20);