Morphatic\AutoDeploy\Origins\Github

Complexity

Total Complexity

7

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	0	Features	3

5 Methods

Rating	Name	Duplication	Size	Complexity
A	isOrigin()	0	9	2
A	isAuthentic()	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.
     *
     * @return bool Returns true if the request originated from Github. False otherwise.
     */
    public function isOrigin()
    {
        // Correct IP range for Github maintained here:
        // https://help.github.com/articles/what-ip-addresses-does-github-use-that-i-should-whitelist/
        $hasGithubHeader = false !== strpos($this->request->header('User-Agent'), 'GitHub-Hookshot');
        $hasGithubIp = $this->isIpInRange($this->request->server('REMOTE_ADDR'), '192.30.252.0', 22);

        return $hasGithubHeader && $hasGithubIp;
    }

    /**
     * Verifies the authenticity of a webhook request from Github.
     *
     * Follows the procedure described here: https://developer.github.com/webhooks/securing/
     *
     * @return bool Returns true if the request is authentic. False otherwise.

Should the return type not be null|boolean?

     */
    public function isAuthentic()
    {
        // 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.
     *
     * @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.
     *
     * @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.
     *
     * @return string The commit ID.
     */
    public function getCommitId()
    {
        return $this->request->json('after');
    }
}