BrowserMob::__setProxyCapabilities() - Code Metrics - Inspection of "code cleaning" - edno/codeception-browsermob - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 50d506...6e1ad5 )

by Greg

created 2016-07-13 18:12 UTC

BrowserMob::__setProxyCapabilities() D

↳ Parent: BrowserMob

Complexity

Conditions	16
Paths	16

Size

Total Lines	48
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes	11
Bugs	3	Features	3

Metric	Value
c	11
b	3
f	3
dl	0
loc	48
rs	4.9765
cc	16
eloc	36
nc	16
nop	1

How to fix Complexity

<?php
namespace Codeception\Extension;

use Codeception\Module;
use Codeception\Exception\ModuleException;
use Codeception\Exception\ModuleConfigException;
use \PHPBrowserMobProxy_Client as BMP;
use \Requests;
use \RuntimeException;

/**
 * @method void _open()
 * @method void _close()
 * @method string _newHar(string $label='')
 * @method string _newPage(string $label='')
 * @method string _blacklist(string $regexp, integer $status_code)
 * @method string _whitelist(string $regexp, integer $status_code)
 * @method string _basicAuth(string $domain, string[] $options)
 * @method string _headers(string[] $options)
 * @method string _responseInterceptor(string $js)
 * @method string _requestInterceptor(string $js)
 * @method Requests_Response _limits(string[] $options)
 * @method Requests_Response _timeouts(string[] $options)
 * @method string _remapHosts(string $address, string $ip_address)
 * @method string _waitForTrafficToStop(integer $quiet_period, integer $timeout)
 * @method string _clearDnsCache()
 * @method string _rewriteUrl(string $match, string $replace)
 * @method string _retry(integer $retry_count)
 */
class BrowserMob extends Module
{

    protected $config = ['host', 'port', 'autostart', 'blacklist', 'whitelist', 'limits', 'timeouts', 'redirect', 'retry', 'basicAuth', 'littleproxy'];

    protected $requiredFields = ['host'];

    protected $response;

    private $bmp;

    /**
     * @codeCoverageIgnore
     * @ignore Codeception specific
     */
    public function _initialize()
    {
        $host = $this->config['host'];
        if (isset($this->config['port'])) {
            $host = $host.':'.$this->config['port'];
        }

        // test if proxy is available
        if (static::__pingProxy($host)) {
            $this->bmp = new BMP($host);
        } else {
            throw new ModuleConfigException(__CLASS__, "Proxy '{$host}' cannot be reached");
        }

        // start a new BrowserMobProxy session
        if (isset($this->config['autostart'])) {
            if (true === (bool) $this->config['autostart']) {
                $this->openProxy();
            }
        }
    }

    protected static function __pingProxy($url)
    {
        try {
            $response = Requests::get('http://'.$url.'/proxy/');
        } catch (\Exception $e) {
            throw new ModuleException(__CLASS__, $e->getMessage());
        }

        return $response->success;
    }

    protected function __setProxyCapabilities($options)
    {
        foreach ($options as $config => $data) {
            if (false === empty($data)) {
                switch ((string) $config) {
                    case 'blacklist':
                        foreach ($data['patterns'] as $pattern) {
                            $this->_blacklist($pattern, $data['code']);
                            if (false === $this->response->success) {
                                break;
                            }
                        }
                        break;
                    case 'whitelist':
                        $patterns = implode(',', $data['patterns']);
                        $this->_whitelist($patterns, $data['code']);
                        break;
                    case 'limits':
                        $this->_limits($data);
                        break;
                    case 'timeouts':
                        $this->_timeouts($data);
                        break;
                    case 'redirect':
                        foreach ($data as $entry) {
                            $this->_remapHosts($entry['domain'], $entry['ip']);
                            if (false === $this->response->success) {
                                break;
                            }
                        }
                        break;
                    case 'retry':
                        $this->_retry($data);
                        break;
                    case 'basicAuth':
                        foreach ($data as $entry) {
                            $this->_basicAuth($entry['domain'], $entry['options']);
                            if (false === $this->response->success) {
                                break;
                            }
                        }
                        break;
                    default:
                        // do nothing
                }
            }
        }
    }

    public function getProxyPort()
    {
        return $this->bmp->port;
    }

    public function openProxy($capabilities = null)
    {
        $this->_open();
        if (empty($capabilities)) {
            $capabilities = $this->config;

        }
        $this->__setProxyCapabilities($capabilities);
        return $this->getProxyPort();
    }

    public function closeProxy()
    {
        $this->_close();
    }

    public function startHar()
    {
        $this->_newHar();
        return $this->response->success;
    }

    public function startPage()
    {
        $this->_newPage();
        return $this->response->success;
    }

    public function getHar()
    {
        return $this->bmp->har;
    }

    public function setHeaders($headers)
    {
        $this->response = $this->_headers($headers);
        return $this->response->success;
    }

    // magic function that exposes BrowserMobProxy API pulic methods
    public function __call($name, $args)
    {
        // check if is a command call
        if (preg_match('/^_[A-z]+$/', $name)) {
            // extract standard method name
            $name = preg_filter('/_/', '', $name);
            // set call array for calling method
            $call = array($this->bmp, $name);
            // check if method is callable
            if (is_callable($call)) {
                $ret = call_user_func_array($call, $args);
                if (get_class($ret) === 'Requests_Response') {
                    $this->response = $ret;
                    if (false === $ret->success) {
                        throw new ModuleConfigException(__CLASS__, "Proxy response error '{$ret->status_code}' {$ret->body}");
                    }
                }
            } else {
                throw new RuntimeException("Method ${name} does not exist or is not callable");
            }
        } else {
            throw new RuntimeException("Method ${method} does not exist or is not callable");
        }
        $ret = (isset($ret)) ? $ret : null;
        return $ret;
    }

}


1			<?php
2			namespace Codeception\Extension;
3
4			use Codeception\Module;
5			use Codeception\Exception\ModuleException;
6			use Codeception\Exception\ModuleConfigException;
7			use \PHPBrowserMobProxy_Client as BMP;
8			use \Requests;
9			use \RuntimeException;
10
11			/**
12			* @method void _open()
13			* @method void _close()
14			* @method string _newHar(string $label='')
15			* @method string _newPage(string $label='')
16			* @method string _blacklist(string $regexp, integer $status_code)
17			* @method string _whitelist(string $regexp, integer $status_code)
18			* @method string _basicAuth(string $domain, string[] $options)
19			* @method string _headers(string[] $options)
20			* @method string _responseInterceptor(string $js)
21			* @method string _requestInterceptor(string $js)
22			* @method Requests_Response _limits(string[] $options)
23			* @method Requests_Response _timeouts(string[] $options)
24			* @method string _remapHosts(string $address, string $ip_address)
25			* @method string _waitForTrafficToStop(integer $quiet_period, integer $timeout)
26			* @method string _clearDnsCache()
27			* @method string _rewriteUrl(string $match, string $replace)
28			* @method string _retry(integer $retry_count)
29			*/
30			class BrowserMob extends Module
31			{
32
33			protected $config = ['host', 'port', 'autostart', 'blacklist', 'whitelist', 'limits', 'timeouts', 'redirect', 'retry', 'basicAuth', 'littleproxy'];
34
35			protected $requiredFields = ['host'];
36
37			protected $response;
38
39			private $bmp;
40
41			/**
42			* @codeCoverageIgnore
43			* @ignore Codeception specific
44			*/
45			public function _initialize()
46			{
47			$host = $this->config['host'];
48			if (isset($this->config['port'])) {
49			$host = $host.':'.$this->config['port'];
50			}
51
52			// test if proxy is available
53			if (static::__pingProxy($host)) {
54			$this->bmp = new BMP($host);
55			} else {
56			throw new ModuleConfigException(__CLASS__, "Proxy '{$host}' cannot be reached");
57			}
58
59			// start a new BrowserMobProxy session
60			if (isset($this->config['autostart'])) {
61			if (true === (bool) $this->config['autostart']) {
62			$this->openProxy();
63			}
64			}
65			}
66
67			protected static function __pingProxy($url)
68			{
69			try {
70			$response = Requests::get('http://'.$url.'/proxy/');
71			} catch (\Exception $e) {
72			throw new ModuleException(__CLASS__, $e->getMessage());
73			}
74
75			return $response->success;
76			}
77
78			protected function __setProxyCapabilities($options)
79			{
80			foreach ($options as $config => $data) {
81			if (false === empty($data)) {
82			switch ((string) $config) {
83			case 'blacklist':
84			foreach ($data['patterns'] as $pattern) {
85			$this->_blacklist($pattern, $data['code']);
86			if (false === $this->response->success) {
87			break;
88			}
89			}
90			break;
91			case 'whitelist':
92			$patterns = implode(',', $data['patterns']);
93			$this->_whitelist($patterns, $data['code']);
94			break;
95			case 'limits':
96			$this->_limits($data);
97			break;
98			case 'timeouts':
99			$this->_timeouts($data);
100			break;
101			case 'redirect':
102			foreach ($data as $entry) {
103			$this->_remapHosts($entry['domain'], $entry['ip']);
104			if (false === $this->response->success) {
105			break;
106			}
107			}
108			break;
109			case 'retry':
110			$this->_retry($data);
111			break;
112			case 'basicAuth':
113			foreach ($data as $entry) {
114			$this->_basicAuth($entry['domain'], $entry['options']);
115			if (false === $this->response->success) {
116			break;
117			}
118			}
119			break;
120			default:
121			// do nothing
122			}
123			}
124			}
125			}
126
127			public function getProxyPort()
128			{
129			return $this->bmp->port;
130			}
131
132			public function openProxy($capabilities = null)
133			{
134			$this->_open();
135			if (empty($capabilities)) {
136			$capabilities = $this->config;
			1 ignored issue – show Coding Style introduced 2016-07-12 18:33 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$capabilities`. This often makes code more readable. Loading history...
137			}
138			$this->__setProxyCapabilities($capabilities);
139			return $this->getProxyPort();
140			}
141
142			public function closeProxy()
143			{
144			$this->_close();
145			}
146
147			public function startHar()
148			{
149			$this->_newHar();
150			return $this->response->success;
151			}
152
153			public function startPage()
154			{
155			$this->_newPage();
156			return $this->response->success;
157			}
158
159			public function getHar()
160			{
161			return $this->bmp->har;
162			}
163
164			public function setHeaders($headers)
165			{
166			$this->response = $this->_headers($headers);
167			return $this->response->success;
168			}
169
170			// magic function that exposes BrowserMobProxy API pulic methods
171			public function __call($name, $args)
172			{
173			// check if is a command call
174			if (preg_match('/^_[A-z]+$/', $name)) {
175			// extract standard method name
176			$name = preg_filter('/_/', '', $name);
177			// set call array for calling method
178			$call = array($this->bmp, $name);
179			// check if method is callable
180			if (is_callable($call)) {
181			$ret = call_user_func_array($call, $args);
182			if (get_class($ret) === 'Requests_Response') {
183			$this->response = $ret;
184			if (false === $ret->success) {
185			throw new ModuleConfigException(__CLASS__, "Proxy response error '{$ret->status_code}' {$ret->body}");
186			}
187			}
188			} else {
189			throw new RuntimeException("Method ${name} does not exist or is not callable");
190			}
191			} else {
192			throw new RuntimeException("Method ${method} does not exist or is not callable");
193			}
194			$ret = (isset($ret)) ? $ret : null;
195			return $ret;
196			}
197
198			}
199

edno / codeception-browsermob

Push — master ( 50d506...6e1ad5 )

BrowserMob::__setProxyCapabilities() D

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like