App\Http\Controllers\ApiController

Complexity

Total Complexity

10

Size/Duplication

Total Lines	216
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes	3
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	index()	0	4	1
A	show()	0	4	1
B	update()	0	45	2
B	sensor()	0	46	2
B	register()	0	46	3
B	image()	0	28	1

<?php

namespace App\Http\Controllers;

use Validator;
use Illuminate\Http\Request;
use App\Device;
use App\Deviceimage;
use App\User;
use App\Sensor;
use App\SensorData;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Storage;
use Carbon\Carbon;

class ApiController extends Controller
{
    /**
     * Creates a json response for all the devices.
     *
     * @return Response
     */    
    public function index()
    {
        return response()->json(['data' => 'SmartSettia API - Bad request type.'], 400);
    }

    /**
     * Creates a json response for a specifc device.
     *
     * @param  Device  $device
     * @return Response
     */    
    public function show(Device $device)
    {
        return response()->json($device, 200);
    }

    /**
     * Updates the status of a device.
     *
     * @param  Request  $request
     * @return Response
     */
    public function update(Request $request)
    {
        // Validate the request
        $validator = Validator::make($request->all(), [

$validator is not used, you could remove the assignment.

            'uuid'          => 'required|string|max:255|exists:devices,uuid',
            'token'         => 'required|string|max:60|exists:devices,token',
            'version'       => 'nullable|string|max:32',
            'hostname'      => 'nullable|string|max:255',
            'ip'            => 'nullable|ip',
            'mac_address'   => 'nullable|string|min:12|max:12',
            'time'          => 'nullable|date',
            'cover_status'  => 'nullable|string|max:32',
            'cover_command'  => 'nullable|alpha|max:5|in:open,close',
            'error_msg'     => 'nullable|string',
            'limitsw_open'   => 'nullable|boolean',
            'limitsw_closed' => 'nullable|boolean',
        ])->validate();
        
        // Get the device record.
        $device = Device::getDeviceByUUID($request->input('uuid'));
        
        // Update the device.
        $device->version = $request->input('version');
        $device->hostname = $request->input('hostname');
        $device->ip = $request->input('ip');
        $device->mac_address = $request->input('mac_address');
        $device->time = $request->input('time');
        $device->cover_status = $request->input('cover_status');
        if ($request->input('cover_command') != null)
            $device->cover_command = $request->input('cover_command');
        $device->error_msg = $request->input('error_msg');
        $device->limitsw_open = $request->input('limitsw_open');
        $device->limitsw_closed = $request->input('limitsw_closed');
        $device->last_network_update_at = Carbon::now();
        
        $device->save();
        
        // A 'Registered' event is created and will trigger any relevant
        // observers, such as sending a confirmation email or any 
        // code that needs to be run as soon as the device is created.
        //event(new Registered(true));

70% of this comment could be valid code. Did you maybe forget this after debugging?

        
        // Return the new device info including the token.
        return response()->json(['data' => $device->toArray()], 201);
    }
    
    /**
     * Updates the sensors of a device.
     *
     * @param  Request  $request
     * @return Response
     */
    public function sensor(Request $request)
    {
        // Validate the request
        $validator = Validator::make($request->all(), [

$validator is not used, you could remove the assignment.

            'uuid'          => 'required|string|max:255|exists:devices,uuid',
            'token'         => 'required|string|max:60|exists:devices,token',
            'sensor_data.*.name'   => 'required|max:190',
            'sensor_data.*.type'   => 'required|max:190',
            'sensor_data.*.value'  => 'required|max:190',
        ])->validate();
        
        // Get the device record.
        $device = Device::getDeviceByUUID($request->input('uuid'));
        
        // Update the device.

58% of this comment could be valid code. Did you maybe forget this after debugging?

// 		"sensor_data": {
// 			{ "name": "cpu", "type": "cpu_temperature", "value": cpu_temp() },
// 			{ "name": "temperature", "type": "temperature", "value": temperature() },
// 			{ "name": "humidity", "type": "humidity", "value": humidity() },
// 			{ "name": "moisture_01", "type": "moisture", "value": 0.00 },
// 			{ "name": "moisture_02", "type": "moisture", "value": 0.00 },
// 			{ "name": "light_in", "type": "light", "value": 0.00 },
// 			{ "name": "light_out", "type": "light", "value": 0.00 }
// 		}
        $sensor_datas = $request->input('sensor_data');
        foreach ($sensor_datas as $sensor_data) {

The expression $sensor_datas of type string|array is not guaranteed to be traversable. How about adding an additional type check?

            $sensor = Sensor::firstOrCreate([
                "device_id" => $device->id,
                "name" => $sensor_data['name'], 
                "type" => $sensor_data['type']
            ]);
            
            SensorData::create([
                "sensor_id" => $sensor->id,
                "value" => $sensor_data['value']
            ]);
        }
        
        // A 'Registered' event is created and will trigger any relevant
        // observers, such as sending a confirmation email or any 
        // code that needs to be run as soon as the device is created.
        //event(new Registered(true));

70% of this comment could be valid code. Did you maybe forget this after debugging?

        
        // Return the new device info including the token.
        return response()->json(['data' => $device->toArray()], 201);
    }
    
    /**
     * Registers a new device.
     *
     * @param  Request  $request
     * @return Response
     */
    public function register(Request $request)
    {
        // Validate the request.
        $validator = Validator::make($request->all(), [

$validator is not used, you could remove the assignment.

            'uuid' => 'required|string|max:255',
            'challenge' => 'required|string|min:6',
        ])->validate();
        
        // If challenge string doesnt match then send 401 unauthorized.
        if ($request->input('challenge') != env('API_CHALLENGE', 'temppass')) {
            return response()->json(['data' => 'Bad challenge.'], 401);
        }
        
        // If the uuid already exists then just send them the record.
        if ($device = Device::getDeviceByUUID($request->input('uuid'))) {
            return response()->json([ 'data' => [ 
                'name' => $device->name,
                'uuid' => $device->uuid,
                'id' => $device->id,
                'token' => $device->token,
            ]], 200);
        }
        
        // Create the new device.
        $device = new Device;
        $device->name = 'New Device';
        $device->uuid = $request->input('uuid');
        $device->save();
        
        // Create an api token for the new device.
        $device->generateToken();
        
        // A 'Registered' event is created and will trigger any relevant
        // observers, such as sending a confirmation email or any 
        // code that needs to be run as soon as the device is created.
        //event(new Registered(true));

70% of this comment could be valid code. Did you maybe forget this after debugging?

        //Notification::send(User::managers(), new DeviceRegister($device));

64% of this comment could be valid code. Did you maybe forget this after debugging?

        
        // Return the new device info including the token.
        return response()->json([ 'data' => [ 
            'name' => $device->name,
            'uuid' => $device->uuid,
            'id' => $device->id,
            'token' => $device->token,
        ]], 201);
    }
    
    /**
     * Updates the image for a device.
     *
     * @param  Request  $request
     * @return Response
     */
    public function image(Request $request) {
        // Validate the request.
        $validator = Validator::make($request->all(), [

$validator is not used, you could remove the assignment.

            'uuid'          => 'required|string|max:255|exists:devices,uuid',
            'token'         => 'required|string|max:60|exists:devices,token',
            'image'         => 'required|image|mimes:jpeg,jpg,png,gif|max:2048',
        ])->validate();
        
        // Get the device record.
        $device = Device::getDeviceByUUID($request->input('uuid'));
        
        // Save the image to disk.
        $path = $request->file('image')->storeAs('deviceimage', $device['id'], 'private');
        
        // Update the url for the image.
        $deviceimage = Deviceimage::updateOrCreate(
            ['device_id' => $device['id']],
            ['url' => $path]
        );
        
        // Force the updated_at timestamp to update as the url may not change.
        $deviceimage->touch();
        
        return response()->json([ 'data' => [ 
            'id' => $deviceimage['id'],
            'url' => $path,
        ]], 201);
    }
}

// HTTP STATUS CODES:
// 200: OK. The standard success code and default option.
// 201: Object created. Useful for the store actions.
// 204: No content. When an action was executed successfully, but there is no content to return.
// 206: Partial content. Useful when you have to return a paginated list of resources.
// 400: Bad request. The standard option for requests that fail to pass validation.
// 401: Unauthorized. The user needs to be authenticated.
// 403: Forbidden. The user is authenticated, but does not have the permissions to perform an action.
// 404: Not found. This will be returned automatically by Laravel when the resource is not found.
// 500: Internal server error. Ideally you're not going to be explicitly returning this, but if something unexpected breaks, this is what your user is going to receive.
// 503: Service unavailable. Pretty self explanatory, but also another code that is not going to be returned explicitly by the application.