ApiTest::setUp() - Code Metrics - Inspection of "Add BasicAuthClient and AbstractApi" - adam-paterson/ibm-watson-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 2c75a2...3f95e8 )

by Adam

created 2018-09-20 15:30 UTC

ApiTest::setUp() A

↳ Parent: ApiTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.7333
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace IBM\Watson\Common\Tests;

use Mockery as m;
use IBM\Watson\Common\stubs\Api;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

class ApiTest extends AbstractTestCase
{
    /**
     * @var \IBM\Watson\Common\Api\ApiInterface
     */
    private $api;

    public function setUp()
    {
        parent::setUp();

        $this->api = new Api($this->httpClient, $this->requestBuilder);

        $this->requestBuilder

            ->shouldReceive('create')
            ->once()
            ->andReturn(m::mock(RequestInterface::class));

        $this->httpClient

            ->shouldReceive('sendRequest')
            ->once()
            ->andReturn(m::mock(ResponseInterface::class));
    }

    public function testGet()
    {
        $this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodGet());
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.
    }
}
    }

    public function testHead()
    {
        $this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodHead());
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.
    }
}
    }

    public function testTrace()
    {
        $this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodTrace());
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.
    }
}
    }

    public function testPost()
    {
        $this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodPost());
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.
    }
}
    }

    public function testPut()
    {
        $this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodPut());
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.
    }
}
    }

    public function testPatch()
    {
        $this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodPatch());
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.
    }
}
    }

    public function testDelete()
    {
        $this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodDelete());
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.
    }
}
    }

    public function testOptions()
    {
        $this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodOptions());
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.
    }
}
    }
}


1			<?php
2
3			namespace IBM\Watson\Common\Tests;
4
5			use Mockery as m;
6			use IBM\Watson\Common\stubs\Api;
7			use Psr\Http\Message\RequestInterface;
8			use Psr\Http\Message\ResponseInterface;
9
10			class ApiTest extends AbstractTestCase
11			{
12			/**
13			* @var \IBM\Watson\Common\Api\ApiInterface
14			*/
15			private $api;
16
17			public function setUp()
18			{
19			parent::setUp();
20
21			$this->api = new Api($this->httpClient, $this->requestBuilder);
22
23			$this->requestBuilder
			0 ignored issues – show Bug introduced 2018-09-20 15:39 UTC by Report Bug Copy Issue Report The method `shouldReceive()` does not seem to exist on `object<IBM\Watson\Common\RequestBuilderInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
24			->shouldReceive('create')
25			->once()
26			->andReturn(m::mock(RequestInterface::class));
27
28			$this->httpClient
			0 ignored issues – show Bug introduced 2018-09-20 15:39 UTC by Report Bug Copy Issue Report The method `shouldReceive()` does not seem to exist on `object<Http\Client\HttpClient>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
29			->shouldReceive('sendRequest')
30			->once()
31			->andReturn(m::mock(ResponseInterface::class));
32			}
33
34			public function testGet()
35			{
36			$this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodGet());
			0 ignored issues – show Bug introduced 2018-09-20 15:39 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `IBM\Watson\Common\Api\ApiInterface` as the method `httpMethodGet()` does only exist in the following implementations of said interface: `IBM\Watson\Common\stubs\Api`. 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...
37			}
38
39			public function testHead()
40			{
41			$this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodHead());
			0 ignored issues – show Bug introduced 2018-09-20 15:39 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `IBM\Watson\Common\Api\ApiInterface` as the method `httpMethodHead()` does only exist in the following implementations of said interface: `IBM\Watson\Common\stubs\Api`. 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...
42			}
43
44			public function testTrace()
45			{
46			$this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodTrace());
			0 ignored issues – show Bug introduced 2018-09-20 15:39 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `IBM\Watson\Common\Api\ApiInterface` as the method `httpMethodTrace()` does only exist in the following implementations of said interface: `IBM\Watson\Common\stubs\Api`. 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...
47			}
48
49			public function testPost()
50			{
51			$this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodPost());
			0 ignored issues – show Bug introduced 2018-09-20 15:39 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `IBM\Watson\Common\Api\ApiInterface` as the method `httpMethodPost()` does only exist in the following implementations of said interface: `IBM\Watson\Common\stubs\Api`. 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...
52			}
53
54			public function testPut()
55			{
56			$this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodPut());
			0 ignored issues – show Bug introduced 2018-09-20 15:39 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `IBM\Watson\Common\Api\ApiInterface` as the method `httpMethodPut()` does only exist in the following implementations of said interface: `IBM\Watson\Common\stubs\Api`. 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...
57			}
58
59			public function testPatch()
60			{
61			$this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodPatch());
			0 ignored issues – show Bug introduced 2018-09-20 15:39 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `IBM\Watson\Common\Api\ApiInterface` as the method `httpMethodPatch()` does only exist in the following implementations of said interface: `IBM\Watson\Common\stubs\Api`. 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...
62			}
63
64			public function testDelete()
65			{
66			$this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodDelete());
			0 ignored issues – show Bug introduced 2018-09-20 15:39 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `IBM\Watson\Common\Api\ApiInterface` as the method `httpMethodDelete()` does only exist in the following implementations of said interface: `IBM\Watson\Common\stubs\Api`. 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...
67			}
68
69			public function testOptions()
70			{
71			$this->assertInstanceOf(ResponseInterface::class, $this->api->httpMethodOptions());
			0 ignored issues – show Bug introduced 2018-09-20 15:39 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `IBM\Watson\Common\Api\ApiInterface` as the method `httpMethodOptions()` does only exist in the following implementations of said interface: `IBM\Watson\Common\stubs\Api`. 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...
72			}
73			}
74

adam-paterson / ibm-watson-sdk

Push — develop ( 2c75a2...3f95e8 )

ApiTest::setUp() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like