ApiController::index() - Code Metrics - Inspection of "Default device update & image rates change" - uidaho/smartsettia - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#133)

unknown
created 2017-12-06 04:25 UTC
ApiController::index() A

↳ Parent: ApiController
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0
<?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 Carbon\Carbon;

class ApiController extends Controller
{
    /**
     * Creates a json response for all the devices.
     *
     * @return \Illuminate\Http\JsonResponse
     */    
    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 \Illuminate\Http\JsonResponse
     */    
    public function show(Device $device)
    {
        return response()->json($device, 200);
    }

    /**
     * Updates the status of a device.
     *
     * @param  Request  $request
     * @return \Illuminate\Http\JsonResponse
     */
    public function update(Request $request)
    {
        // Validate the request
        $validator = Validator::make($request->all(), [
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            'uuid'          => 'required|size:36|uuid|exists:devices,uuid',
            'token'         => 'required|max:60|alpha_num|exists:devices,token',
            'version'       => 'nullable|max:32|version',
            'hostname'      => 'nullable|max:255|url',
            'ip'            => 'nullable|ip',
            'mac_address'   => 'nullable|size:12|mac',
            'time'          => 'nullable|date',
            'cover_status'  => 'nullable|alpha|max:7|in:opening,closing,open,closed,locked,error',
            'cover_command'  => 'nullable|alpha|max:5|in:open,close',
            'error_msg'     => 'nullable|max:1000|error_string',
        ])->validate();
        
        // Get the device record.
        $device = Device::getDeviceByUUID($request->input('uuid'));
        $device = Device::getDeviceByUUID(/** @scrutinizer ignore-type */ $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->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));
        
        // 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 \Illuminate\Http\JsonResponse
     */
    public function sensor(Request $request)
    {
        // Validate the request
        $validator = Validator::make($request->all(), [
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            'uuid'          => 'required|size:36|uuid|exists:devices,uuid',
            'token'         => 'required|max:60|alpha_num|exists:devices,token',
            'sensor_data.*.name'   => 'required|min:2|max:190|name',
            'sensor_data.*.type'   => 'required|max:190|type_name',
            'sensor_data.*.value'  => 'required|max:190|value_string',
        ])->validate();
        
        // Get the device record.
        $device = Device::getDeviceByUUID($request->input('uuid'));
        $device = Device::getDeviceByUUID(/** @scrutinizer ignore-type */ $request->input('uuid'));
        
        // Update the device.
// 		"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) {
            $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));
        
        // Return the new device info including the token.
        return response()->json([ 'data' => $device->toArray() ], 201);
    }
    
    /**
     * Registers a new device.
     *
     * @param  Request  $request
     * @return \Illuminate\Http\JsonResponse
     */
    public function register(Request $request)
    {
        // Validate the request.
        $validator = Validator::make($request->all(), [
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            'uuid' => 'required|size:36|uuid',
            'challenge' => 'required|min:6|string',
        ])->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'))) {
        if ($device = Device::getDeviceByUUID(/** @scrutinizer ignore-type */ $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));
        //Notification::send(User::managers(), new DeviceRegister($device));
        
        // 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 \Illuminate\Http\JsonResponse
     */
    public function image(Request $request) {
        // Validate the request.
        $validator = Validator::make($request->all(), [
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            'uuid'          => 'required|size:36|uuid|exists:devices,uuid',
            'token'         => 'required|max:60|alpha_num|exists:devices,token',
            'image'         => 'required|image|mimes:jpeg,jpg,png,gif|max:2048',
        ])->validate();
        
        // Get the device record.
        $device = Device::getDeviceByUUID($request->input('uuid'));
        $device = Device::getDeviceByUUID(/** @scrutinizer ignore-type */ $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.

uidaho / smartsettia

Pull Request — master (#133)

ApiController::index() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
