mirror of
				https://github.com/BookStackApp/BookStack.git
				synced 2025-10-29 16:09:29 +03:00 
			
		
		
		
	
		
			
				
	
	
		
			46 lines
		
	
	
		
			1.1 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			46 lines
		
	
	
		
			1.1 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
| <?php namespace Tests\Api;
 | |
| 
 | |
| trait TestsApi
 | |
| {
 | |
| 
 | |
|     protected $apiTokenId = 'apitoken';
 | |
|     protected $apiTokenSecret = 'password';
 | |
| 
 | |
|     /**
 | |
|      * Set the API editor role as the current user via the API driver.
 | |
|      */
 | |
|     protected function actingAsApiEditor()
 | |
|     {
 | |
|         $this->actingAs($this->getEditor(), 'api');
 | |
|         return $this;
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * Format the given items into a standardised error format.
 | |
|      */
 | |
|     protected function errorResponse(string $message, int $code): array
 | |
|     {
 | |
|         return ["error" => ["code" => $code, "message" => $message]];
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * Format the given (field_name => ["messages"]) array
 | |
|      * into a standard validation response format.
 | |
|      */
 | |
|     protected function validationResponse(array $messages): array
 | |
|     {
 | |
|         $err = $this->errorResponse("The given data was invalid.", 422);
 | |
|         $err['error']['validation'] = $messages;
 | |
|         return $err;
 | |
|     }
 | |
|     /**
 | |
|      * Get an approved API auth header.
 | |
|      */
 | |
|     protected function apiAuthHeader(): array
 | |
|     {
 | |
|         return [
 | |
|             "Authorization" => "Token {$this->apiTokenId}:{$this->apiTokenSecret}"
 | |
|         ];
 | |
|     }
 | |
| 
 | |
| } |