Simplify response succes and failure return code (#47)

Simplify response succes and failure return code

Author: GhaziTriki

src/Responses/BaseResponse.php

@@ -24,6 +24,9 @@
  */
 abstract class BaseResponse
 {
+    const SUCCESS = 'SUCCESS';
+    const FAILED  = 'FAILED';
+
     /**
      * @var \SimpleXMLElement
      */
@@ -70,4 +73,14 @@ public function getMessage()
     {
         return $this->rawXml->message->__toString();
     }
+
+    public function success()
+    {
+        return $this->getReturnCode() === self::SUCCESS;
+    }
+
+    public function failed()
+    {
+        return $this->getReturnCode() === self::FAILED;
+    }
 }

tests/BigBlueButtonTest.php

@@ -64,6 +64,7 @@ public function testApiVersion()
         $apiVersion = $this->bbb->getApiVersion();
         $this->assertEquals('SUCCESS', $apiVersion->getReturnCode());
         $this->assertEquals('2.0', $apiVersion->getVersion());
+        $this->assertTrue($apiVersion->success());
     }
 
     /* Create Meeting */
@@ -91,6 +92,7 @@ public function testCreateMeeting()
         $params = $this->generateCreateParams();
         $result = $this->bbb->createMeeting($this->getCreateMock($params));
         $this->assertEquals('SUCCESS', $result->getReturnCode());
+        $this->assertTrue($result->success());
     }
 
     /**
@@ -105,6 +107,7 @@ public function testCreateMeetingWithDocumentUrl()
 
         $this->assertCount(1, $params->getPresentations());
         $this->assertEquals('SUCCESS', $result->getReturnCode());
+        $this->assertTrue($result->success());
     }
 
     /**
@@ -119,6 +122,7 @@ public function testCreateMeetingWithDocumentUrlAndFileName()
 
         $this->assertCount(1, $params->getPresentations());
         $this->assertEquals('SUCCESS', $result->getReturnCode());
+        $this->assertTrue($result->success());
     }
 
     /**
@@ -133,6 +137,7 @@ public function testCreateMeetingWithDocumentEmbedded()
 
         $this->assertCount(1, $params->getPresentations());
         $this->assertEquals('SUCCESS', $result->getReturnCode());
+        $this->assertTrue($result->success());
     }
 
     /**
@@ -148,6 +153,7 @@ public function testCreateMeetingWithMultiDocument()
 
         $this->assertCount(2, $params->getPresentations());
         $this->assertEquals('SUCCESS', $result->getReturnCode());
+        $this->assertTrue($result->success());
     }
 
     /* Join Meeting */
@@ -182,6 +188,7 @@ public function testJoinMeeting()
 
         $joinMeeting = $this->bbb->joinMeeting($joinMeetingMock);
         $this->assertEquals('SUCCESS', $joinMeeting->getReturnCode());
+        $this->assertTrue($joinMeeting->success());
         $this->assertNotEmpty($joinMeeting->getAuthToken());
         $this->assertNotEmpty($joinMeeting->getUserId());
         $this->assertNotEmpty($joinMeeting->getSessionToken());
@@ -222,6 +229,7 @@ public function testSetConfigXML()
         $params                = $this->generateCreateParams();
         $createMeetingResponse = $this->bbb->createMeeting($this->getCreateMock($params));
         $this->assertEquals('SUCCESS', $createMeetingResponse->getReturnCode());
+        $this->assertTrue($createMeetingResponse->success());
 
         // Execute setConfigXML request
         $params             = ['meetingId' => $createMeetingResponse->getMeetingId()];
@@ -231,6 +239,7 @@ public function testSetConfigXML()
 
         $result = $this->bbb->setConfigXML($setConfigXMLParams);
         $this->assertEquals('SUCCESS', $result->getReturnCode());
+        $this->assertTrue($result->success());
         $this->assertNotEmpty($result->getToken());
     }
 
@@ -258,13 +267,15 @@ public function testEndMeeting()
         $endMeeting = new EndMeetingParameters($meeting->getMeetingId(), $meeting->getModeratorPassword());
         $result     = $this->bbb->endMeeting($endMeeting);
         $this->assertEquals('SUCCESS', $result->getReturnCode());
+        $this->assertTrue($result->success());
     }
 
     public function testEndNonExistingMeeting()
     {
         $params = $this->generateEndMeetingParams();
         $result = $this->bbb->endMeeting($this->getEndMeetingMock($params));
         $this->assertEquals('FAILED', $result->getReturnCode());
+        $this->assertTrue($result->failed());
     }
 
     /* Is Meeting Running */
@@ -273,6 +284,7 @@ public function testIsMeetingRunning()
     {
         $result = $this->bbb->isMeetingRunning(new IsMeetingRunningParameters($this->faker->uuid));
         $this->assertEquals('SUCCESS', $result->getReturnCode());
+        $this->assertTrue($result->success());
         $this->assertEquals(false, $result->isRunning());
     }
 
@@ -307,6 +319,7 @@ public function testGetMeetingInfo()
 
         $result = $this->bbb->getMeetingInfo(new GetMeetingInfoParameters($meeting->getMeetingId(), $meeting->getModeratorPassword()));
         $this->assertEquals('SUCCESS', $result->getReturnCode());
+        $this->assertTrue($result->success());
     }
 
     public function testGetRecordingsUrl()
@@ -319,6 +332,7 @@ public function testGetRecordings()
     {
         $result = $this->bbb->getRecordings(new GetRecordingsParameters());
         $this->assertEquals('SUCCESS', $result->getReturnCode());
+        $this->assertTrue($result->success());
     }
 
     public function testPublishRecordingsUrl()
@@ -331,6 +345,7 @@ public function testPublishRecordings()
     {
         $result = $this->bbb->publishRecordings(new PublishRecordingsParameters('non-existing-id-' . $this->faker->sha1, true));
         $this->assertEquals('FAILED', $result->getReturnCode());
+        $this->assertTrue($result->failed());
     }
 
     public function testDeleteRecordingsUrl()
@@ -343,6 +358,7 @@ public function testDeleteRecordings()
     {
         $result = $this->bbb->deleteRecordings(new DeleteRecordingsParameters('non-existing-id-' . $this->faker->sha1));
         $this->assertEquals('FAILED', $result->getReturnCode());
+        $this->assertTrue($result->failed());
     }
 
     public function testUpdateRecordingsUrl()
@@ -362,5 +378,6 @@ public function testUpdateRecordings()
         $params = $this->generateUpdateRecordingsParams();
         $result = $this->bbb->updateRecordings($this->getUpdateRecordingsParamsMock($params));
         $this->assertEquals('FAILED', $result->getReturnCode());
+        $this->assertTrue($result->failed());
     }
 }