Morphatic\AutoDeploy\Origins\Github

Complexity

Total Complexity

8

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	2

5 Methods

Rating	Name	Duplication	Size	Complexity
A	originated()	0	12	3
A	verify()	0	11	2
A	event()	0	4	1
A	getRepoUrl()	0	4	1
A	getCommitId()	0	4	1

<?php

namespace Morphatic\AutoDeploy\Origins;

class Github extends AbstractOrigin implements OriginInterface
{
    /**
     * The name of the origin.
     *
     * @var string
     */
    public $name = 'Github';

    /**
     * Determines whether or not the Request originated from Github.
     *
     * @param Illuminate\Http\Request $this->request The Request object

There is no parameter named $this->request. Was it maybe removed?

     *
     * @return bool Returns true if the request originated from Github. False otherwise.
     */
    public function originated()
    {
        // Correct IP range for Github maintained here:
        // https://help.github.com/articles/what-ip-addresses-does-github-use-that-i-should-whitelist/
        $has_github_header = false !== strpos($this->request->header('User-Agent'), 'GitHub-Hookshot');

$has_github_header does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $has_github_ip = $this->ipInRange($this->request->server('REMOTE_ADDR'), '192.30.252.0', 22);

$has_github_ip does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        if ($has_github_header && $has_github_ip) {

$has_github_header does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

This if statement, and the following return statement can be replaced with return $has_github_header && $has_github_ip;.

            return true;
        }

        return false;
    }

    /**
     * Verifies the authenticity of a webhook request from Github.
     *
     * Follows the procedure described here: https://developer.github.com/webhooks/securing/
     *
     * @param Illuminate\Http\Request $this->request The Request object

There is no parameter named $this->request. Was it maybe removed?

     *
     * @return bool Returns true if the request is authentic. False otherwise.

Should the return type not be null|boolean?

     */
    public function verify()
    {
        // get the Github signature
        $xhub = $this->request->header('X-Hub-Signature') ?: 'nothing';

        // reconstruct the hash on this side
        $hash = 'sha1='.hash_hmac('sha1', $this->request->getContent(), config('auto-deploy.secret'));

        // securely compare them
        return hash_equals($xhub, $hash);
    }

    /**
     * Gets the event the triggered the webhook request.
     *
     * @param Illuminate\Http\Request $this->request The Request object

There is no parameter named $this->request. Was it maybe removed?

     *
     * @return string The name of the event, e.g. push, release, create, etc.
     */
    public function event()
    {
        return $this->request->header('X-GitHub-Event');
    }

    /**
     * Gets the URL to be cloned from.
     *
     * @param Illuminate\Http\Request $request The Request object

There is no parameter named $request. Was it maybe removed?

     *
     * @return string The URL of the repo.
     */
    public function getRepoUrl()
    {
        return $this->request->json('repository.clone_url');
    }

    /**
     * Gets the ID of the commit that is to be cloned.
     *
     * @param Illuminate\Http\Request $request The Request object

There is no parameter named $request. Was it maybe removed?

     *
     * @return string The commit ID.
     */
    public function getCommitId()
    {
        return $this->request->json('after');
    }
}