Ntb\RestAPI\RestTest

Complexity

Total Complexity

4

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	5	1
A	makeApiRequest()	0	26	2
A	createSession()	0	9	1

<?php

namespace Ntb\RestAPI;

/**
 * Rest test class can work as base class for your functional tests. It provides some helpful methods to test your rest
 * api more easily.
 */
abstract class RestTest extends \SapphireTest {

    /**
     * The namespace of your api.
     * @var string
     */
    protected $namespace = 'v/1';

    /**
     * The route to the session without the namespace.
     * @var string
     */
    protected $sessionRoute = 'sessions';

    public function setUp() {
        parent::setUp();
        // clear cache
        \SS_Cache::factory('rest_cache')->clean(\Zend_Cache::CLEANING_MODE_ALL);
    }


    /**
     * Perform an api request with the given options
     *
     * @param string $path the request path; can consist of resource name, identifier and GET params
     * @param array $options
     *  * string `body` the data
     *  * int `code` the expected response code
     *  * string `method` the http method
     *  * ApiSession `session` the test session
     *  * string `token` the auth token
     *  * array `postVars` the post data, eg. multi form or files
     * @return array
     * @throws \SS_HTTPResponse_Exception
     */
    protected function makeApiRequest($path, $options=[]) {
        $settings = array_merge([
            'session' => null,
            'token' => null,
            'method' => 'GET',
            'body' => null,
            'postVars' => null,
            'code' => 200
        ], $options);
        $headers = [
            'Accept' => 'application/json'
        ];
        if($settings['token']) {
            $headers['Authorization'] = "Bearer {$settings['token']}";
        }
        $response = \Director::test(
            \Controller::join_links($this->namespace, $path),
            $settings['postVars'],
            $settings['session'],

$settings['session'] is of type null, but the function expects a object<Session>|array.

            $settings['method'],
            $settings['body'],
            $headers
        );
        $this->assertEquals($settings['code'], $response->getStatusCode(), "Wrong status code: {$response->getBody()}");

The method assertEquals() does not seem to exist on object<Ntb\RestAPI\RestTest>.

        return json_decode($response->getBody(), true);
    }

    /**
     * Creates a session for the api.
     *
     * @param string $email the email of the user
     * @param string $password the password for the user
     * @return array the current session with `token`
     */
    protected function createSession($email='considine.colby@gmail.com', $password='password') {
        $data = [
            'email' => $email,
            'password' => $password
        ];
        $dataString = json_encode($data);
        $result = $this->makeApiRequest('SessionRoute', ['body' => $dataString, 'method' => 'POST']);
        return $result['session'];
    }
}