Better error handling (Fab1en#11)

nelsonko · Aug 11, 2019 · 1e9d31c · 1e9d31c
2 parents e98843d + d246aff
commit 1e9d31c
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 62 deletions.
diff --git a/src/RocketChatChannel.php b/src/RocketChatChannel.php
@@ -51,8 +51,7 @@ public function create(){
 			$this->id = $response->body->channel->_id;
 			return $response->body->channel;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+		    throw $this->createExceptionFromResponse($response, "Could not create new channel");
 		}
 	}
 
@@ -66,8 +65,7 @@ public function info() {
 			$this->id = $response->body->channel->_id;
 			return $response->body;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not get channel info");
 		}
 	}
 
@@ -87,9 +85,7 @@ public function postMessage( $text ) {
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			if( isset($response->body->error) )	echo( $response->body->error . "\n" );
-			else if( isset($response->body->message) )	echo( $response->body->message . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not post message to channel $this->name");
 		}
 	}
 
@@ -104,8 +100,7 @@ public function close(){
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not remove channel from the user’s list of channels");
 		}
 	}
 
@@ -120,8 +115,7 @@ public function delete(){
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not delete channel $this->name");
 		}
 	}
 
@@ -139,8 +133,7 @@ public function kick( $user ){
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not kick user $user from channel $this->name");
 		}
 	}
 
@@ -158,8 +151,7 @@ public function invite( $user ) {
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not invite user $user to channel $this->name");
 		}
 	}
 
@@ -177,8 +169,7 @@ public function addOwner( $user ) {
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not add user $user as owner of channel $this->name");
 		}
 	}
 
@@ -196,8 +187,7 @@ public function removeOwner( $user ) {
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not kick user $user from chanel $this->name");
 		}
 	}
 

diff --git a/src/RocketChatClient.php b/src/RocketChatClient.php
@@ -18,6 +18,16 @@ function __construct(){
 		Request::ini( $tmp );
 	}
 
+	protected function createExceptionFromResponse($response, $prefix){
+        if(!empty($response->body->error)){
+            return new \Exception("$prefix: ".$response->body->error);
+        } else if(!empty($response->body)){
+            return new \Exception("$prefix: ".$response->body);
+        } else {
+            return new \Exception("$prefix: unknown error!");
+        }
+    }
+
 	/**
 	* Get version information. This simple method requires no authentication.
 	*/
@@ -36,10 +46,8 @@ public function me() {
 			if( isset($response->body->success) && $response->body->success == true ) {
 				return $response->body;
 			}
-		} else {
-			echo( $response->body->message . "\n" );
-			return false;
 		}
+        throw $this->createExceptionFromResponse($response, "Could not list channels");
 	}
 
 	/**
@@ -54,8 +62,7 @@ public function list_users(){
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return $response->body->users;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not list users");
 		}
 	}
 
@@ -72,8 +79,7 @@ public function list_groups() {
 			}
 			return $groups;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not list groups");
 		}
 	}
 
@@ -90,8 +96,7 @@ public function list_channels() {
 			}
 			return $groups;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not list channels");
 		}
 	}
 

diff --git a/src/RocketChatGroup.php b/src/RocketChatGroup.php
@@ -51,8 +51,7 @@ public function create(){
 			$this->id = $response->body->group->_id;
 			return $response->body->group;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+			throw $this->createExceptionFromResponse($response, "Could not create a private group");
 		}
 	}
 
@@ -66,8 +65,7 @@ public function info() {
 			$this->id = $response->body->group->_id;
 			return $response->body;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not get info about the group");
 		}
 	}
 
@@ -87,10 +85,8 @@ public function postMessage( $text ) {
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			if( isset($response->body->error) )	echo( $response->body->error . "\n" );
-			else if( isset($response->body->message) )	echo( $response->body->message . "\n" );
-			return false;
-		}
+            throw $this->createExceptionFromResponse($response, "Could not post message");
+        }
 	}
 
 	/**
@@ -104,8 +100,7 @@ public function close(){
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not remove private group");
 		}
 	}
 
@@ -120,8 +115,7 @@ public function delete(){
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not delete a private group");
 		}
 	}
 
@@ -139,8 +133,7 @@ public function kick( $user ){
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could kick user $user from group");
 		}
 	}
 
@@ -158,12 +151,11 @@ public function invite( $user ) {
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
-		}
+            throw $this->createExceptionFromResponse($response, "Could not invite user $user to the private group");
+        }
 	}
 
-        /**
+    /**
 	 * Adds owner to the private group.
 	 */
 	public function addOwner( $user ) {
@@ -177,8 +169,7 @@ public function addOwner( $user ) {
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not add user $user as owner of private group");
 		}
 	}
 
@@ -196,8 +187,7 @@ public function removeOwner( $user ) {
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not remove user $user as owner of private group");
 		}
 	}
 }

diff --git a/src/RocketChatSettings.php b/src/RocketChatSettings.php
@@ -30,7 +30,7 @@ public function get( $id ){
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return $response->body->value;
 		} else {
-			echo( $response->body->error . "\n" );
+		    throw $this->createExceptionFromResponse($response, "Could not get setting $id");
 		}
 	}
 
@@ -45,7 +45,7 @@ public function update( $id, $value ){
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			echo( $response->body->error . "\n" );
+		    throw $this->createExceptionFromResponse($response, "Could not update setting $id to $value");
 		}
 	}
 
@@ -59,8 +59,7 @@ public function check(){
 		fclose($f);
 
 		if( $settings === null ) {
-			echo "Erreur de décodage json pour le fichier {$this->file}\n";
-			return;
+		    throw new \Exception("Not possible to decode local settings file: $this->file");
 		}
 
 		foreach($settings as $id => $value){

diff --git a/src/RocketChatUser.php b/src/RocketChatUser.php
@@ -6,6 +6,7 @@
 use RocketChat\Client;
 
 class User extends Client {
+
 	public $username;
 	private $password;
 	public $id;
@@ -43,8 +44,7 @@ public function login($save_auth = true) {
 			$this->id = $response->body->data->userId;
 			return $response->body->data;
 		} else {
-			echo( $response->body->message . "\n" );
-			return false;
+			throw $this->createExceptionFromResponse($response, "Could not authenticate with the REST API");
 		}
 	}
 
@@ -60,8 +60,7 @@ public function info() {
 			$this->email = $response->body->user->emails[0]->address;
 			return $response->body;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+			throw $this->createExceptionFromResponse($response, "Could not get user's information");
 		}
 	}
 
@@ -82,8 +81,7 @@ public function create() {
 			$this->id = $response->body->user->_id;
 			return $response->body->user;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not create new user");
 		}
 	}
 
@@ -103,8 +101,7 @@ public function delete() {
 		if( $response->code == 200 && isset($response->body->success) && $response->body->success == true ) {
 			return true;
 		} else {
-			echo( $response->body->error . "\n" );
-			return false;
+            throw $this->createExceptionFromResponse($response, "Could not delete user");
 		}
 	}
 }