ApprovalsDispatcher::approvers() - Code Metrics - Inspection of "Approval emails and fixes" - silverstripe/deploynaut - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#699)

by Sean

created 2016-10-10 20:02 UTC

ApprovalsDispatcher::approvers() B

↳ Parent: ApprovalsDispatcher

Complexity

Conditions	4
Paths	6

Size

Total Lines	22
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	8.9197
c	0
b	0
f	0
cc	4
eloc	14
nc	6
nop	1

<?php

class ApprovalsDispatcher extends Dispatcher {
namespace YourVendor;

class YourClass { }

	const ACTION_APPROVALS = 'approvals';

	const ALLOW_APPROVAL = 'ALLOW_APPROVAL';

	const ALLOW_APPROVAL_BYPASS = 'ALLOW_APPROVAL_BYPASS';

	/**
	 * @var array
	 */
	private static $allowed_actions = [

		'approvers',
		'submit',
		'cancel',
		'approve',
		'reject'
	];

	private static $dependencies = [
		'formatter' => '%$DeploynautAPIFormatter'
	];

	/**
	 * @var \DNProject
	 */
	protected $project = null;

	/**
	 * @var \DNEnvironment
	 */
	protected $environment = null;

	/**
	 * @var array
	 */
	private static $action_types = [

		self::ACTION_APPROVALS
	];

	/**
	 * This is a per request cache of $this->project()->listMembers()
	 * @var null|array
	 */
	private static $_cache_project_members = null;

	public function init() {

		parent::init();

		$this->project = $this->getCurrentProject();
		if (!$this->project) {
			return $this->project404Response();
		}

		// Performs canView permission check by limiting visible projects
		$this->environment = $this->getCurrentEnvironment($this->project);
		if (!$this->environment) {
			return $this->environment404Response();
		}
	}

	/**
	 * @param \SS_HTTPRequest $request
	 * @return \SS_HTTPResponse
	 */
	public function approvers(SS_HTTPRequest $request) {
		$list = [];

		if (self::$_cache_project_members === null) {
			self::$_cache_project_members = $this->project->listMembers();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
		}

		foreach (self::$_cache_project_members as $data) {
			if ($this->project->allowed(self::ALLOW_APPROVAL, Member::get()->byId($data['MemberID']))) {

				$list[] = [
					'id' => $data['MemberID'],
					'email' => $data['Email'],
					'role' => $data['RoleTitle'],
					'name' => $data['FullName']
				];
			}
		}

		return $this->getAPIResponse([
			'approvers' => $list
		], 200);
	}

	/**
	 * @param \SS_HTTPRequest $request
	 * @return \SS_HTTPResponse
	 */
	public function submit(SS_HTTPRequest $request) {
		if ($request->httpMethod() !== 'POST') {
			return $this->getAPIResponse(['message' => 'Method not allowed, requires POST'], 405);
		}

		$deployment = DNDeployment::get()->byId($request->postVar('id'));
		$errorResponse = $this->validateDeployment($deployment);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		if ($errorResponse instanceof \SS_HTTPResponse) {
			return $errorResponse;
		}

		$approver = Member::get()->byId($request->postVar('approver_id'));
		if ($approver && $approver->exists()) {
			if (!$this->project->allowed(ApprovalsDispatcher::ALLOW_APPROVAL, $approver)) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				return $this->getAPIResponse(['message' => 'The given approver does not have permissions to approve'], 403);
			}

			$deployment->ApproverID = $approver->ID;
			$deployment->write();
		}

		try {
			$deployment->getMachine()->apply(DNDeployment::TR_SUBMIT);
		} catch (\Exception $e) {
			return $this->getAPIResponse([
				'message' => $e->getMessage()
			], 400);
		}

		return $this->getAPIResponse([
			'message' => 'Deployment request has been submitted',
			'deployment' => $this->formatter->getDeploymentData($deployment)
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		], 200);
	}

	/**
	 * @param \SS_HTTPRequest $request
	 * @return \SS_HTTPResponse
	 */
	public function cancel(SS_HTTPRequest $request) {
		if ($request->httpMethod() !== 'POST') {
			return $this->getAPIResponse(['message' => 'Method not allowed, requires POST'], 405);
		}

		$deployment = DNDeployment::get()->byId($request->postVar('id'));
		$errorResponse = $this->validateDeployment($deployment);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		if ($errorResponse instanceof \SS_HTTPResponse) {
			return $errorResponse;
		}

		// @todo permission checking for cancelling an approval request
		try {
			$deployment->getMachine()->apply(DNDeployment::TR_NEW);
		} catch (\Exception $e) {
			return $this->getAPIResponse([
				'message' => $e->getMessage()
			], 400);
		}

		return $this->getAPIResponse([
			'message' => 'Deployment request has been cancelled',
			'deployment' => $this->formatter->getDeploymentData($deployment)
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		], 200);
	}

	/**
	 * @param \SS_HTTPRequest $request
	 * @return \SS_HTTPResponse
	 */
	public function approve(SS_HTTPRequest $request) {
		if ($request->httpMethod() !== 'POST') {
			return $this->getAPIResponse(['message' => 'Method not allowed, requires POST'], 405);
		}

		$deployment = DNDeployment::get()->byId($request->postVar('id'));
		$errorResponse = $this->validateDeployment($deployment);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		if ($errorResponse instanceof \SS_HTTPResponse) {
			return $errorResponse;
		}

		// ensure we have either bypass or approval permission of the logged in user
		if (
			!$this->project->allowed(self::ALLOW_APPROVAL_BYPASS, Member::currentUser())

			|| !$this->project->allowed(self::ALLOW_APPROVAL, Member::currentUser())

		) {
			return $this->getAPIResponse(['message' => 'You are not authorised to approve or bypass this deployment'], 403);
		}

		// check for specific permission depending on the current state of the deployment:
		// submitted => approved requires approval permissions
		// new => approved requires bypass permissions.
		if (

			$deployment->State === DNDeployment::STATE_SUBMITTED
			&& !$this->project->allowed(self::ALLOW_APPROVAL, Member::currentUser())

		) {
			return $this->getAPIResponse(['message' => 'You are not authorised to approve this deployment'], 403);
		}
		if (

			$deployment->State === DNDeployment::STATE_NEW
			&& !$this->project->allowed(self::ALLOW_APPROVAL_BYPASS, Member::currentUser())

		) {
			return $this->getAPIResponse(['message' => 'You are not authorised to bypass approval of this deployment'], 403);
		}

		// if the current user is not the person who was selected for approval on submit, but they got
		// here because they still have permission, then change the approver to the current user
		if (Member::currentUserID() !== $deployment->ApproverID) {
			$deployment->ApproverID = Member::currentUserID();
			$deployment->write();
		}

		try {
			$deployment->getMachine()->apply(DNDeployment::TR_APPROVE);
		} catch (\Exception $e) {
			return $this->getAPIResponse([
				'message' => $e->getMessage()
			], 400);
		}

		return $this->getAPIResponse([
			'message' => 'Deployment request has been approved',
			'deployment' => $this->formatter->getDeploymentData($deployment)
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		], 200);
	}

	/**
	 * @param \SS_HTTPRequest $request
	 * @return \SS_HTTPResponse
	 */
	public function reject(SS_HTTPRequest $request) {
		if ($request->httpMethod() !== 'POST') {
			return $this->getAPIResponse(['message' => 'Method not allowed, requires POST'], 405);
		}

		$deployment = DNDeployment::get()->byId($request->postVar('id'));
		$errorResponse = $this->validateDeployment($deployment);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		if ($errorResponse instanceof \SS_HTTPResponse) {
			return $errorResponse;
		}
		// reject permissions are the same as can approve
		if (!$this->project->allowed(self::ALLOW_APPROVAL, Member::currentUser())) {

			return $this->getAPIResponse(['message' => 'You are not authorised to reject this deployment'], 403);
		}

		// if the current user is not the person who was selected for approval on submit, but they got
		// here because they still have permission, then change the approver to the current user
		if (Member::currentUserID() !== $deployment->ApproverID) {
			$deployment->ApproverID = Member::currentUserID();
			$deployment->write();
		}

		try {
			$deployment->getMachine()->apply(DNDeployment::TR_REJECT);
		} catch (\Exception $e) {
			return $this->getAPIResponse([
				'message' => $e->getMessage()
			], 400);
		}

		return $this->getAPIResponse([
			'message' => 'Deployment request has been rejected',
			'deployment' => $this->formatter->getDeploymentData($deployment)
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		], 200);
	}

	/**
	 * Check if a DNDeployment exists and do permission checks on it. If there is something wrong it will return
	 * an APIResponse with the error, otherwise null.
	 *
	 * @param \DNDeployment $deployment
	 *
	 * @return null|SS_HTTPResponse
	 */
	protected function validateDeployment(\DNDeployment $deployment) {

		if (!$deployment || !$deployment->exists()) {
			return $this->getAPIResponse(['message' => 'This deployment does not exist'], 404);
		}
		if ($deployment->EnvironmentID != $this->environment->ID) {
			return $this->getAPIResponse(['message' => 'This deployment does not belong to the environment'], 403);
		}
		if (!$deployment->canView()) {
			return $this->getAPIResponse(['message' => 'You are not authorised to view this deployment'], 403);
		}
		return null;
	}

	/**
	 * @param string $name
	 * @return array
	 */
	public function getModel($name = '') {
		return [];
	}

	/**
	 * @param string $action
	 * @return string
	 */
	public function Link($action = '') {
		return \Controller::join_links($this->environment->Link(), self::ACTION_APPROVALS, $action);
	}

}


1			<?php
2
3			class ApprovalsDispatcher extends Dispatcher {
			0 ignored issues – show Coding Style introduced 2016-10-04 02:48 UTC by Report Bug Copy Issue Report The property $allowed_actions is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2016-10-04 02:48 UTC by Report Bug Copy Issue Report The property $action_types is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style Compatibility introduced 2016-10-04 02:48 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history... Coding Style introduced 2016-10-04 03:13 UTC by Report Bug Copy Issue Report The property $_cache_project_members is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
4
5			const ACTION_APPROVALS = 'approvals';
6
7			const ALLOW_APPROVAL = 'ALLOW_APPROVAL';
8
9			const ALLOW_APPROVAL_BYPASS = 'ALLOW_APPROVAL_BYPASS';
10
11			/**
12			* @var array
13			*/
14			private static $allowed_actions = [
			0 ignored issues – show Comprehensibility introduced 2016-10-05 01:39 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
15			'approvers',
16			'submit',
17			'cancel',
18			'approve',
19			'reject'
20			];
21
22			private static $dependencies = [
23			'formatter' => '%$DeploynautAPIFormatter'
24			];
25
26			/**
27			* @var \DNProject
28			*/
29			protected $project = null;
30
31			/**
32			* @var \DNEnvironment
33			*/
34			protected $environment = null;
35
36			/**
37			* @var array
38			*/

silverstripe / deploynaut

Pull Request — master (#699)

ApprovalsDispatcher::approvers() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like