Tshock::processResponse() - Code Metrics - Inspection of "Fixed doc issue." - Austinb/GameQ - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — v3 ( 7afe0b...1e90c6 )

by Austin

created 2016-08-07 02:57 UTC

Tshock::processResponse() B

↳ Parent: Tshock

Complexity

Conditions	6
Paths	8

Size

Total Lines	56
Code Lines	29

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	27
CRAP Score	6.0118

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	56
ccs	27
cts	29
cp	0.931
rs	8.7592
cc	6
eloc	29
nc	8
nop	0
crap	6.0118

How to fix Long Method

<?php
/**
 * This file is part of GameQ.
 *
 * GameQ is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * GameQ is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
namespace GameQ\Protocols;

use GameQ\Exception\Protocol as Exception;
use GameQ\Result;

/**
 * Tshock Protocol Class
 *
 * Result from this call should be a header + JSON response
 *
 * References:
 * - https://tshock.atlassian.net/wiki/display/TSHOCKPLUGINS/REST+API+Endpoints#RESTAPIEndpoints-/status
 * - http://tshock.co/xf/index.php?threads/rest-tshock-server-status-image.430/
 *
 * Special thanks to intradox and Ruok2bu for game & protocol references
 *
 * @author Austin Bischoff <[email protected]>
 */
class Tshock extends Http
{
    /**
     * Packets to send
     *
     * @var array
     */
    protected $packets = [
        self::PACKET_STATUS => "GET /v2/server/status?players=true&rules=true HTTP/1.0\r\nAccept: */*\r\n\r\n",
    ];

    /**
     * The protocol being used
     *
     * @var string
     */
    protected $protocol = 'tshock';

    /**
     * String name of this protocol class
     *
     * @var string
     */
    protected $name = 'tshock';

    /**
     * Longer string name of this protocol class
     *
     * @var string
     */
    protected $name_long = "Tshock";

    /**
     * Normalize some items
     *
     * @var array
     */
    protected $normalize = [
        // General
        'general' => [
            // target       => source
            'dedicated'  => 'dedicated',
            'hostname'   => 'hostname',
            'mapname'    => 'world',
            'maxplayers' => 'maxplayers',
            'numplayers' => 'numplayers',
            'password'   => 'password',
        ],
        // Individual
        'player'  => [
            'name' => 'nickname',
            'team' => 'team',
        ],
    ];

    /**
     * Process the response
     *
     * @return array
     * @throws Exception
     */
    public function processResponse()
    {
        // Implode and rip out the JSON
        preg_match('/\{(.*)\}/ms', implode('', $this->packets_response), $matches);

        // Return should be JSON, let's validate
        if (($json = json_decode($matches[0])) === null) {
            throw new Exception("JSON response from Tshock protocol is invalid.");
        }

        // Check the status response
        if ($json->status != 200) {
            throw new Exception("JSON status from Tshock protocol response was '{$json->status}', expected '200'.");
        }

        $result = new Result();

        // Server is always dedicated
        $result->add('dedicated', 1);

        // Add server items
        $result->add('hostname', $json->name);
        $result->add('game_port', $json->port);
        $result->add('serverversion', $json->serverversion);
        $result->add('world', $json->world);
        $result->add('uptime', $json->uptime);
        $result->add('password', (int)$json->serverpassword);
        $result->add('numplayers', $json->playercount);
        $result->add('maxplayers', $json->maxplayers);

        // Parse players
        foreach ($json->players as $player) {
            $result->addPlayer('nickname', $player->nickname);
            $result->addPlayer('username', $player->username);
            $result->addPlayer('group', $player->group);
            $result->addPlayer('active', (int)$player->active);
            $result->addPlayer('state', $player->state);
            $result->addPlayer('team', $player->team);
        }

        // Make rules into simple array
        $rules = [];

        // Parse rules
        foreach ($json->rules as $rule => $value) {
            // Add rule but convert boolean into int (0|1)
            $rules[$rule] = (is_bool($value)) ? (int)$value : $value;
        }

        // Add rules
        $result->add('rules', $rules);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        unset($rules, $rule, $player, $value);

        return $result->fetch();
    }
}


1		<?php
2		/**
3		* This file is part of GameQ.
4		*
5		* GameQ is free software; you can redistribute it and/or modify
6		* it under the terms of the GNU Lesser General Public License as published by
7		* the Free Software Foundation; either version 3 of the License, or
8		* (at your option) any later version.
9		*
10		* GameQ is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13		* GNU Lesser General Public License for more details.
14		*
15		* You should have received a copy of the GNU Lesser General Public License
16		* along with this program. If not, see <http://www.gnu.org/licenses/>.
17		*/
18		namespace GameQ\Protocols;
19
20		use GameQ\Exception\Protocol as Exception;
21		use GameQ\Result;
22
23		/**
24		* Tshock Protocol Class
25		*
26		* Result from this call should be a header + JSON response
27		*
28		* References:
29		* - https://tshock.atlassian.net/wiki/display/TSHOCKPLUGINS/REST+API+Endpoints#RESTAPIEndpoints-/status
30		* - http://tshock.co/xf/index.php?threads/rest-tshock-server-status-image.430/
31		*
32		* Special thanks to intradox and Ruok2bu for game & protocol references
33		*
34		* @author Austin Bischoff <[email protected]>
35		*/
36		class Tshock extends Http
37		{
38		/**
39		* Packets to send
40		*
41		* @var array
42		*/
43		protected $packets = [
44		self::PACKET_STATUS => "GET /v2/server/status?players=true&rules=true HTTP/1.0\r\nAccept: /\r\n\r\n",
45		];
46
47		/**
48		* The protocol being used
49		*
50		* @var string
51		*/
52		protected $protocol = 'tshock';
53
54		/**
55		* String name of this protocol class
56		*
57		* @var string
58		*/
59		protected $name = 'tshock';
60
61		/**
62		* Longer string name of this protocol class
63		*
64		* @var string
65		*/
66		protected $name_long = "Tshock";
67
68		/**
69		* Normalize some items
70		*
71		* @var array
72		*/
73		protected $normalize = [
74		// General
75		'general' => [
76		// target => source
77		'dedicated' => 'dedicated',
78		'hostname' => 'hostname',
79		'mapname' => 'world',
80		'maxplayers' => 'maxplayers',
81		'numplayers' => 'numplayers',
82		'password' => 'password',
83		],
84		// Individual
85		'player' => [
86		'name' => 'nickname',
87		'team' => 'team',
88		],
89		];
90
91		/**
92		* Process the response
93		*
94		* @return array
95		* @throws Exception
96		*/
97	1	public function processResponse()
98		{
99		// Implode and rip out the JSON
100	1	preg_match('/\{(.*)\}/ms', implode('', $this->packets_response), $matches);
101
102		// Return should be JSON, let's validate
103	1	if (($json = json_decode($matches[0])) === null) {
104		throw new Exception("JSON response from Tshock protocol is invalid.");
105		}
106
107		// Check the status response
108	1	if ($json->status != 200) {
109		throw new Exception("JSON status from Tshock protocol response was '{$json->status}', expected '200'.");
110		}
111
112	1	$result = new Result();
113
114		// Server is always dedicated
115	1	$result->add('dedicated', 1);
116
117		// Add server items
118	1	$result->add('hostname', $json->name);
119	1	$result->add('game_port', $json->port);
120	1	$result->add('serverversion', $json->serverversion);
121	1	$result->add('world', $json->world);
122	1	$result->add('uptime', $json->uptime);
123	1	$result->add('password', (int)$json->serverpassword);
124	1	$result->add('numplayers', $json->playercount);
125	1	$result->add('maxplayers', $json->maxplayers);
126
127		// Parse players
128	1	foreach ($json->players as $player) {
129	1	$result->addPlayer('nickname', $player->nickname);
130	1	$result->addPlayer('username', $player->username);
131	1	$result->addPlayer('group', $player->group);
132	1	$result->addPlayer('active', (int)$player->active);
133	1	$result->addPlayer('state', $player->state);
134	1	$result->addPlayer('team', $player->team);
135		}
136
137		// Make rules into simple array
138	1	$rules = [];
139
140		// Parse rules
141	1	foreach ($json->rules as $rule => $value) {
142		// Add rule but convert boolean into int (0\|1)
143	1	$rules[$rule] = (is_bool($value)) ? (int)$value : $value;
144		}
145
146		// Add rules
147	1	$result->add('rules', $rules);
		1 ignored issue – show Documentation introduced 2016-08-07 03:02 UTC by Report Bug Copy Issue Report `$rules` is of type `array`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
148
149	1	unset($rules, $rule, $player, $value);
150
151	1	return $result->fetch();
152		}
153		}
154

Austinb / GameQ

Push — v3 ( 7afe0b...1e90c6 )

Tshock::processResponse() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like