BrowserKit::resetHttpHeaders() - Code Metrics - Inspection of "Reset request headers after send" - Behatch/contexts - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#164)

by Vincent

created 2016-04-04 16:16 UTC

BrowserKit::resetHttpHeaders() A

↳ Parent: BrowserKit

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	2	Features	1

Metric	Value
c	2
b	2
f	1
dl	0
loc	10
rs	9.4285
cc	2
eloc	5
nc	2
nop	0

<?php

namespace Sanpi\Behatch\HttpCall\Request;

use Behat\Mink\Driver\Goutte\Client as GoutteClient;
use Behat\Mink\Mink;
use Symfony\Component\BrowserKit\Client as BrowserKitClient;

class BrowserKit
{
    protected $mink;

    public function __construct(Mink $mink)
    {
        $this->mink = $mink;
    }

    public function getMethod()
    {
        return $this->getRequest()
            ->getMethod();
    }

    public function getUri()
    {
        return $this->getRequest()
            ->getUri();
    }

    public function getServer()
    {
        return $this->getRequest()
            ->getServer();
    }

    public function getParameters()
    {
        return $this->getRequest()
            ->getParameters();
    }

    protected function getRequest()
    {
        $client = $this->mink->getSession()->getDriver()->getClient();
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.
    }
}
        // BC layer for BrowserKit 2.2.x and older
        if (method_exists($client, 'getInternalRequest')) {
            $request = $client->getInternalRequest();
        } else {
            $request = $client->getRequest();
        }
        return $request;
    }

    public function getContent()
    {
        return $this->mink->getSession()->getPage()->getContent();
    }

    public function send($method, $url, $parameters = [], $files = [], $content = null, $headers = [])
    {
        $client = $this->mink->getSession()->getDriver()->getClient();
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.
    }
}

        $client->followRedirects(false);
        $client->request($method, $url, $parameters, $files, $headers, $content);
        $client->followRedirects(true);
        $this->resetHttpHeaders();

        return $this->mink->getSession()->getPage();
    }

    public function setHttpHeader($name, $value)
    {
        $client = $this->mink->getSession()->getDriver()->getClient();
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.
    }
}
        // Goutte\Client
        if (method_exists($client, 'setHeader')) {
            $client->setHeader($name, $value);
        } else {
            // Symfony\Component\BrowserKit\Client

            /* taken from Behat\Mink\Driver\BrowserKitDriver::setRequestHeader */
            $contentHeaders = array('CONTENT_LENGTH' => true, 'CONTENT_MD5' => true, 'CONTENT_TYPE' => true);
            $name = str_replace('-', '_', strtoupper($name));

            // CONTENT_* are not prefixed with HTTP_ in PHP when building $_SERVER
            if (!isset($contentHeaders[$name])) {
                $name = 'HTTP_' . $name;
            }
            /* taken from Behat\Mink\Driver\BrowserKitDriver::setRequestHeader */

            $client->setServerParameter($name, $value);
        }
    }

    public function getHttpHeaders()
    {
        return array_change_key_case(
            $this->mink->getSession()->getResponseHeaders(),
            CASE_LOWER
        );
    }

    public function getHttpHeader($name)
    {
        $name = strtolower($name);
        $headers = $this->getHttpHeaders();

        if (isset($headers[$name])) {
            if (is_array($headers[$name])) {
                $value = implode(', ', $headers[$name]);
            }
            else {
                $value = $headers[$name];
            }
        }
        else {
            throw new \OutOfBoundsException(
                "The header '$name' doesn't exist"
            );
        }
        return $value;
    }

    protected function resetHttpHeaders()
    {
        /** @var GoutteClient|BrowserKitClient $client */
        $client = $this->mink->getSession()->getDriver()->getClient();
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.
    }
}

        $client->setServerParameters([]);
        if ($client instanceof GoutteClient) {
            $client->resetHeaders();
        }
    }
}


1			<?php
2
3			namespace Sanpi\Behatch\HttpCall\Request;
4
5			use Behat\Mink\Driver\Goutte\Client as GoutteClient;
6			use Behat\Mink\Mink;
7			use Symfony\Component\BrowserKit\Client as BrowserKitClient;
8
9			class BrowserKit
10			{
11			protected $mink;
12
13			public function __construct(Mink $mink)
14			{
15			$this->mink = $mink;
16			}
17
18			public function getMethod()
19			{
20			return $this->getRequest()
21			->getMethod();
22			}
23
24			public function getUri()
25			{
26			return $this->getRequest()
27			->getUri();
28			}
29
30			public function getServer()
31			{
32			return $this->getRequest()
33			->getServer();
34			}
35
36			public function getParameters()
37			{
38			return $this->getRequest()
39			->getParameters();
40			}
41
42			protected function getRequest()
43			{
44			$client = $this->mink->getSession()->getDriver()->getClient();
			0 ignored issues – show Bug introduced 2016-04-04 16:18 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Mink\Driver\DriverInterface` as the method `getClient()` does only exist in the following implementations of said interface: `Behat\Mink\Driver\BrowserKitDriver`, `Behat\Mink\Driver\GoutteDriver`. 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...
45			// BC layer for BrowserKit 2.2.x and older
46			if (method_exists($client, 'getInternalRequest')) {
47			$request = $client->getInternalRequest();
48			} else {
49			$request = $client->getRequest();
50			}
51			return $request;
52			}
53
54			public function getContent()
55			{
56			return $this->mink->getSession()->getPage()->getContent();
57			}
58
59			public function send($method, $url, $parameters = [], $files = [], $content = null, $headers = [])
60			{
61			$client = $this->mink->getSession()->getDriver()->getClient();
			0 ignored issues – show Bug introduced 2016-04-04 16:18 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Mink\Driver\DriverInterface` as the method `getClient()` does only exist in the following implementations of said interface: `Behat\Mink\Driver\BrowserKitDriver`, `Behat\Mink\Driver\GoutteDriver`. 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			$client->followRedirects(false);
64			$client->request($method, $url, $parameters, $files, $headers, $content);
65			$client->followRedirects(true);
66			$this->resetHttpHeaders();
67
68			return $this->mink->getSession()->getPage();
69			}
70
71			public function setHttpHeader($name, $value)
72			{
73			$client = $this->mink->getSession()->getDriver()->getClient();
			0 ignored issues – show Bug introduced 2016-04-04 16:18 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Mink\Driver\DriverInterface` as the method `getClient()` does only exist in the following implementations of said interface: `Behat\Mink\Driver\BrowserKitDriver`, `Behat\Mink\Driver\GoutteDriver`. 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...
74			// Goutte\Client
75			if (method_exists($client, 'setHeader')) {
76			$client->setHeader($name, $value);
77			} else {
78			// Symfony\Component\BrowserKit\Client
79
80			/* taken from Behat\Mink\Driver\BrowserKitDriver::setRequestHeader */
81			$contentHeaders = array('CONTENT_LENGTH' => true, 'CONTENT_MD5' => true, 'CONTENT_TYPE' => true);
82			$name = str_replace('-', '_', strtoupper($name));
83
84			// CONTENT_* are not prefixed with HTTP_ in PHP when building $_SERVER
85			if (!isset($contentHeaders[$name])) {
86			$name = 'HTTP_' . $name;
87			}
88			/* taken from Behat\Mink\Driver\BrowserKitDriver::setRequestHeader */
89
90			$client->setServerParameter($name, $value);
91			}
92			}
93
94			public function getHttpHeaders()
95			{
96			return array_change_key_case(
97			$this->mink->getSession()->getResponseHeaders(),
98			CASE_LOWER
99			);
100			}
101
102			public function getHttpHeader($name)
103			{
104			$name = strtolower($name);
105			$headers = $this->getHttpHeaders();
106
107			if (isset($headers[$name])) {
108			if (is_array($headers[$name])) {
109			$value = implode(', ', $headers[$name]);
110			}
111			else {
112			$value = $headers[$name];
113			}
114			}
115			else {
116			throw new \OutOfBoundsException(
117			"The header '$name' doesn't exist"
118			);
119			}
120			return $value;
121			}
122
123			protected function resetHttpHeaders()
124			{
125			/** @var GoutteClient\|BrowserKitClient $client */
126			$client = $this->mink->getSession()->getDriver()->getClient();
			0 ignored issues – show Bug introduced 2016-04-04 16:18 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Mink\Driver\DriverInterface` as the method `getClient()` does only exist in the following implementations of said interface: `Behat\Mink\Driver\BrowserKitDriver`, `Behat\Mink\Driver\GoutteDriver`. 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...
127
128			$client->setServerParameters([]);
129			if ($client instanceof GoutteClient) {
130			$client->resetHeaders();
131			}
132			}
133			}
134

Behatch / contexts

Pull Request — master (#164)

BrowserKit::resetHttpHeaders() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like