ACSController::handleDoor() - Code Metrics - Inspection of "acs response fix" - ArthurGuy/BBMembershipSystem - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f3dd30...542898 )

by Arthur

created 2018-02-12 20:50 UTC

ACSController::handleDoor() A

↳ Parent: ACSController

Complexity

Conditions	2
Paths	3

Size

Total Lines	14
Code Lines	7

Duplication

Lines	14
Ratio	100 %

Importance

Changes

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

<?php namespace BB\Http\Controllers;

use BB\Entities\ACSNode;
use BB\Entities\DetectedDevice;
use BB\Entities\User;
use BB\Events\MemberActivity;
use BB\Exceptions\ValidationException;
use BB\Repo\ACSNodeRepository;
use BB\Repo\EquipmentLogRepository;
use BB\Validators\ACSValidator;
use Exception;

class ACSController extends Controller
{

    /**
     * @var ACSNodeRepository
     */
    private $deviceRepository;

    /**
     * @var ACSValidator
     */
    private $ACSValidator;
    /**
     * @var \BB\Services\KeyFobAccess
     */
    private $keyFobAccess;
    /**
     * @var EquipmentLogRepository
     */
    private $equipmentLogRepository;

    function __construct(ACSNodeRepository $acsNodeRepository, ACSValidator $ACSValidator, \BB\Services\KeyFobAccess $keyFobAccess, EquipmentLogRepository $equipmentLogRepository) {

        $this->acsNodeRepository = $acsNodeRepository;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->ACSValidator     = $ACSValidator;
        $this->keyFobAccess     = $keyFobAccess;
        $this->equipmentLogRepository = $equipmentLogRepository;
    }

    public function store()
    {
        $data = \Request::only('device', 'service', 'message', 'tag', 'time', 'payload', 'signature', 'nonce', 'session_id');

        //device = the node id from the acs table - unique to each acs
        //service = what the request is for, entry, usage, consumable
        //message = system message, heartbeat, boot
        //tag = the keyfob id
        //time = the time of the action
        //payload = any extra data relavent to the request
        //signature = an encoded value generated using a secret key - oauth style
        //nonce = a unique value suitable to stop replay attacks
        //session_id = the id of the current session the user is maintaining

        $this->ACSValidator->validate($data);


        //System messages
        if (in_array($data['message'], ['boot', 'heartbeat'])) {
            return $this->handleSystemCheckIn($data['message'], $data['device'], $data['service']);
        }


        switch ($data['service']) {
            case 'entry':
                return $this->handleDoor($data);
            case 'usage':
                return $this->handleDevice($data);
            case 'consumable':
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

                break;
            case 'shop':
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

                break;
            case 'status':
                return $this->handleStatus($data);

                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            default:
                \Log::debug(json_encode($data));
        }

    }

    private function handleStatus($data)
    {
        try {
            /** @var User $user */
            $user = $this->keyFobAccess->verifyForEntry($data['tag'], 'main-door', $data['time']);
        } catch (\Exception $e) {
            return $this->sendResponse(404, []);
        }

        return $this->sendResponse(200, ['member' => $user->given_name]);
    }

    private function handleDoor($data)
    {
        //Door entry is quite simple - this will just deal with lookups

        try {
            /** @var User $user */
            $user = $this->keyFobAccess->verifyForEntry($data['tag'], 'main-door', $data['time']);
            $this->keyFobAccess->logSuccess();
        } catch (\Exception $e) {
            return $this->sendResponse(404, []);
        }

        return $this->sendResponse(200, ['member' => $user->given_name]);
    }


    private function handleDevice($data)
    {
        $sessionId = null;
        try {
            $device = ACSNode::where('device_id', $data['device'])->firstOrFail();
            if ($device->entry_device) {
                return $this->sendResponse(400, ['message' => 'This is an entry device only']);
            } else {
                $member = $this->keyFobAccess->verifyForDevice($data['tag'], $data['device'], $data['time']);
                $keyFob = $this->keyFobAccess->getKeyFob();

                if ($data['message'] == 'start') {
                    $sessionId = $this->equipmentLogRepository->recordStartCloseExisting($keyFob->user->id, $keyFob->id, $data['device']);
                    event(new MemberActivity($keyFob, $data['device']));
                } elseif ($data['message'] == 'stop') {
                    if (empty($data['session_id'])) {
                        $data['session_id'] = $this->equipmentLogRepository->findActiveUserSession($keyFob->user->id, $data['device']);
                    }
                    if (empty($data['session_id'])) {
                        return $this->sendResponse(404, ['message' => 'No active session to close']);
                    }
                    $this->equipmentLogRepository->endSession($data['session_id']);
                }
            }
        } catch (ValidationException $e) {
            return $this->sendResponse(400, ['message' => $e->getMessage()]);
        }
        return $this->sendResponse(200, ['member' => $member->given_name, 'session_id' => $sessionId]);
    }

    /**
     * System checkins are common across all devices
     * Record the time and return pending status messages
     *
     * @param $message
     * @param $device
     * @return Response
     */
    private function handleSystemCheckIn($message, $device, $service)
    {
        switch ($message) {
            case 'boot':
                $this->acsNodeRepository->logBoot($device);
                break;
            case 'heartbeat':
                $this->acsNodeRepository->logHeartbeat($device);
                break;
        }

        //The command comes from the database and will instruct the door entry system to clear its memory if set
        $cmd = $this->acsNodeRepository->popCommand($device);

        switch ($service) {
            case 'entry':
                //we don't have a system for this at the moment but could have a global shutdown option
                $deviceStatus = '1';
                break;
            case 'usage':
                //lookup the piece of equipment from the device id and get the status
                $deviceStatus = '1';
                break;
            default:
                $deviceStatus = '1';
        }

        $responseData = ['cmd' => $cmd, 'deviceStatus' => $deviceStatus];

        return $this->sendResponse(200, $responseData);
    }

    /**
     * Json encode the response data and return
     *
     * @param int   $statusCode
     * @param array $responseData
     *
     * @return \Response
     */
    private function sendResponse($statusCode = 200, array $responseData)
    {
        $responseData['time'] = time();
        $response = response()->json($responseData, $statusCode);
        $response->headers->set('Content-Length', strlen($response->getContent()));
        return $response;
    }

} 


1		<?php namespace BB\Http\Controllers;
2
3		use BB\Entities\ACSNode;
4		use BB\Entities\DetectedDevice;
5		use BB\Entities\User;
6		use BB\Events\MemberActivity;
7		use BB\Exceptions\ValidationException;
8		use BB\Repo\ACSNodeRepository;
9		use BB\Repo\EquipmentLogRepository;
10		use BB\Validators\ACSValidator;
11		use Exception;
12
13		class ACSController extends Controller
14		{
15
16		/**
17		* @var ACSNodeRepository
18		*/
19		private $deviceRepository;
		0 ignored issues – show Unused Code introduced 2015-11-23 19:55 UTC by Report Bug Copy Issue Report The property `$deviceRepository` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
20		/**
21		* @var ACSValidator
22		*/
23		private $ACSValidator;
24		/**
25		* @var \BB\Services\KeyFobAccess
26		*/
27		private $keyFobAccess;
28		/**
29		* @var EquipmentLogRepository
30		*/
31		private $equipmentLogRepository;
32
33		function __construct(ACSNodeRepository $acsNodeRepository, ACSValidator $ACSValidator, \BB\Services\KeyFobAccess $keyFobAccess, EquipmentLogRepository $equipmentLogRepository) {
		0 ignored issues – show Best Practice introduced 2018-02-03 16:48 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
34		$this->acsNodeRepository = $acsNodeRepository;
		0 ignored issues – show Bug introduced 2015-11-23 19:55 UTC by Report Bug Copy Issue Report The property `acsNodeRepository` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
35		$this->ACSValidator = $ACSValidator;
36		$this->keyFobAccess = $keyFobAccess;
37		$this->equipmentLogRepository = $equipmentLogRepository;
38		}
39
40		public function store()
41		{
42		$data = \Request::only('device', 'service', 'message', 'tag', 'time', 'payload', 'signature', 'nonce', 'session_id');
43
44		//device = the node id from the acs table - unique to each acs
45		//service = what the request is for, entry, usage, consumable
46		//message = system message, heartbeat, boot
47		//tag = the keyfob id
48		//time = the time of the action
49		//payload = any extra data relavent to the request
50		//signature = an encoded value generated using a secret key - oauth style
51		//nonce = a unique value suitable to stop replay attacks
52		//session_id = the id of the current session the user is maintaining
53
54		$this->ACSValidator->validate($data);
55
56
57		//System messages
58		if (in_array($data['message'], ['boot', 'heartbeat'])) {
59		return $this->handleSystemCheckIn($data['message'], $data['device'], $data['service']);
60		}
61
62
63		switch ($data['service']) {
64		case 'entry':
65		return $this->handleDoor($data);
66		case 'usage':
67		return $this->handleDevice($data);
68		case 'consumable':
		0 ignored issues – show Coding Style introduced 2016-03-20 15:52 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
69
70		break;
71		case 'shop':
		0 ignored issues – show Coding Style introduced 2016-03-20 15:52 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
72
73		break;
74		case 'status':
75		return $this->handleStatus($data);
76
77		break;
		0 ignored issues – show Unused Code introduced 2018-02-03 16:02 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
78		default:
79		\Log::debug(json_encode($data));
80		}
81
82		}
83
84	View Code Duplication	private function handleStatus($data)
85		{
86		try {
87		/** @var User $user */
88		$user = $this->keyFobAccess->verifyForEntry($data['tag'], 'main-door', $data['time']);
89		} catch (\Exception $e) {
90		return $this->sendResponse(404, []);
91		}
92
93		return $this->sendResponse(200, ['member' => $user->given_name]);
94		}
95
96	View Code Duplication	private function handleDoor($data)
97		{
98		//Door entry is quite simple - this will just deal with lookups
99
100		try {
101		/** @var User $user */
102		$user = $this->keyFobAccess->verifyForEntry($data['tag'], 'main-door', $data['time']);
103		$this->keyFobAccess->logSuccess();
104		} catch (\Exception $e) {
105		return $this->sendResponse(404, []);
106		}
107
108		return $this->sendResponse(200, ['member' => $user->given_name]);
109		}
110
111
112		private function handleDevice($data)
113		{
114		$sessionId = null;
115		try {
116		$device = ACSNode::where('device_id', $data['device'])->firstOrFail();
117		if ($device->entry_device) {
118		return $this->sendResponse(400, ['message' => 'This is an entry device only']);
119		} else {
120		$member = $this->keyFobAccess->verifyForDevice($data['tag'], $data['device'], $data['time']);
121		$keyFob = $this->keyFobAccess->getKeyFob();
122
123		if ($data['message'] == 'start') {
124		$sessionId = $this->equipmentLogRepository->recordStartCloseExisting($keyFob->user->id, $keyFob->id, $data['device']);
125		event(new MemberActivity($keyFob, $data['device']));
126		} elseif ($data['message'] == 'stop') {
127		if (empty($data['session_id'])) {
128		$data['session_id'] = $this->equipmentLogRepository->findActiveUserSession($keyFob->user->id, $data['device']);
129		}
130		if (empty($data['session_id'])) {
131		return $this->sendResponse(404, ['message' => 'No active session to close']);
132		}
133		$this->equipmentLogRepository->endSession($data['session_id']);
134		}
135		}
136		} catch (ValidationException $e) {
137		return $this->sendResponse(400, ['message' => $e->getMessage()]);
138		}
139		return $this->sendResponse(200, ['member' => $member->given_name, 'session_id' => $sessionId]);
140		}
141
142		/**
143		* System checkins are common across all devices
144		* Record the time and return pending status messages
145		*
146		* @param $message
147		* @param $device
148		* @return Response
149		*/
150		private function handleSystemCheckIn($message, $device, $service)
151		{
152		switch ($message) {
153		case 'boot':
154		$this->acsNodeRepository->logBoot($device);
155		break;
156		case 'heartbeat':
157		$this->acsNodeRepository->logHeartbeat($device);
158		break;
159		}
160
161		//The command comes from the database and will instruct the door entry system to clear its memory if set
162		$cmd = $this->acsNodeRepository->popCommand($device);
163
164		switch ($service) {
165		case 'entry':
166		//we don't have a system for this at the moment but could have a global shutdown option
167		$deviceStatus = '1';
168		break;
169		case 'usage':
170		//lookup the piece of equipment from the device id and get the status
171		$deviceStatus = '1';
172		break;
173		default:
174		$deviceStatus = '1';
175		}
176
177		$responseData = ['cmd' => $cmd, 'deviceStatus' => $deviceStatus];
178
179		return $this->sendResponse(200, $responseData);
180		}
181
182		/**
183		* Json encode the response data and return
184		*
185		* @param int $statusCode
186		* @param array $responseData
187		*
188		* @return \Response
189		*/
190		private function sendResponse($statusCode = 200, array $responseData)
191		{
192		$responseData['time'] = time();
193		$response = response()->json($responseData, $statusCode);
194		$response->headers->set('Content-Length', strlen($response->getContent()));
195		return $response;
196		}
197
198		}
199

ArthurGuy / BBMembershipSystem

Push — master ( f3dd30...542898 )

ACSController::handleDoor() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like