AuthenticatesApplications::authenticateAsInstallation() - Code Metrics - m1guelpf/integration - Measure and Improve Code Quality continuously with Scrutinizer

authenticateAsInstallation() A
last analyzed 2017-12-09 18:22 UTC

↳ Parent: AuthenticatesApplications

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	3

<?php

/*
 * This file is part of UnMarkDocs.
 *
 * Copyright (c) Miguel Piedrafita - All Rights Reserved
 *
 * Unauthorized copying of this file, via any medium is strictly prohibited
 * Proprietary and confidential
 * Written by Miguel Piedrafita <[email protected]>
 */

namespace M1guelpf\Integration;

use Github\Client as GitHub;
use Lcobucci\JWT\Token as JWT;

trait AuthenticatesApplications
{
    /**
     * Authenticates as an installation.
     *
     * @param int     $installation_id
     * @param GitHub  $github
     * @param JWT     $jwt
     *
     * @return GitHub
     */
    protected function authenticateAsInstallation(int $installation_id, GitHub $github, JWT $jwt) : GitHub

    {
        $token = $github->api('apps')->createInstallationToken($installation_id);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $github->authenticate($token['token'], null, GitHub::AUTH_HTTP_TOKEN);

        return $github;
    }

    /**
     * Authenticates as an application.
     *
     * @param GitHub  $github
     * @param JWT     $jwt
     *
     * @return GitHub
     */
    protected function authenticateAsApplication(GitHub $github, JWT $jwt) : GitHub
    {
        $github->authenticate($jwt, null, GitHub::AUTH_JWT);

        return $github;
    }
}


1			<?php
2
3			/*
4			* This file is part of UnMarkDocs.
5			*
6			* Copyright (c) Miguel Piedrafita - All Rights Reserved
7			*
8			* Unauthorized copying of this file, via any medium is strictly prohibited
9			* Proprietary and confidential
10			* Written by Miguel Piedrafita <[email protected]>
11			*/
12
13			namespace M1guelpf\Integration;
14
15			use Github\Client as GitHub;
16			use Lcobucci\JWT\Token as JWT;
17
18			trait AuthenticatesApplications
19			{
20			/**
21			* Authenticates as an installation.
22			*
23			* @param int $installation_id
24			* @param GitHub $github
25			* @param JWT $jwt
26			*
27			* @return GitHub
28			*/
29			protected function authenticateAsInstallation(int $installation_id, GitHub $github, JWT $jwt) : GitHub
			0 ignored issues – show Unused Code introduced 2017-12-09 18:18 UTC by Report Bug Copy Issue Report The parameter `$jwt` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
30			{
31			$token = $github->api('apps')->createInstallationToken($installation_id);
			0 ignored issues – show Bug introduced 2017-12-09 18:18 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Github\Api\ApiInterface` as the method `createInstallationToken()` does only exist in the following implementations of said interface: `Github\Api\Apps`, `Github\Api\Integrations`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
32			$github->authenticate($token['token'], null, GitHub::AUTH_HTTP_TOKEN);
33
34			return $github;
35			}
36
37			/**
38			* Authenticates as an application.
39			*
40			* @param GitHub $github
41			* @param JWT $jwt
42			*
43			* @return GitHub
44			*/
45			protected function authenticateAsApplication(GitHub $github, JWT $jwt) : GitHub
46			{
47			$github->authenticate($jwt, null, GitHub::AUTH_JWT);
48
49			return $github;
50			}
51			}
52

m1guelpf / integration

authenticateAsInstallation() A last analyzed 2017-12-09 18:22 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

authenticateAsInstallation() A
last analyzed 2017-12-09 18:22 UTC