phparia\Api\DeviceStates

Complexity

Total Complexity

7

Size/Duplication

Total Lines	83
Duplicated Lines	22.89 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getDeviceStates()	12	12	2
A	getDeviceState()	7	7	1
A	updateDeviceState()	0	13	2
A	deleteDeviceState()	0	9	2

<?php

/*
 * Copyright 2014 Brian Smith <wormling@gmail.com>.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace phparia\Api;

use GuzzleHttp\Exception\RequestException;
use phparia\Client\AriClientAware;
use phparia\Exception\ConflictException;
use phparia\Exception\NotFoundException;
use phparia\Resources\DeviceState;

/**
 * DeviceStates API
 *
 * @author Brian Smith <wormling@gmail.com>
 */
class DeviceStates extends AriClientAware
{
    const DEVICE_STATE_UNKNOWN = 'UNKNOWN';
    const DEVICE_STATE_NOT_INUSE = 'NOT_INUSE';
    const DEVICE_STATE_INUSE = 'INUSE';
    const DEVICE_STATE_BUSY = 'BUSY';
    const DEVICE_STATE_INVALID = 'INVALID';
    const DEVICE_STATE_UNAVAILABLE = 'UNAVAILABLE';
    const DEVICE_STATE_RINGING = 'RINGING';
    const DEVICE_STATE_RINGINUSE = 'RINGINUSE';
    const DEVICE_STATE_ONHOLD = 'ONHOLD';

    /**
     * List all ARI controlled device states.
     *
     * @return DeviceState[]
     */
    public function getDeviceStates()
    {
        $uri = 'deviceStates';
        $response = $this->client->getEndpoint()->get($uri);

        $deviceStates = [];
        foreach (\GuzzleHttp\json_decode($response->getBody()) as $deviceState) {
            $deviceStates[] = new DeviceState($this->client, $deviceState);
        }

        return $deviceStates;
    }

    /**
     * Retrieve the current state of a device.
     *
     * @param string $deviceName
     * @return DeviceState
     */
    public function getDeviceState($deviceName)
    {
        $uri = "deviceStates/$deviceName";
        $response = $this->client->getEndpoint()->get($uri);

        return new DeviceState($this->client, \GuzzleHttp\json_decode($response->getBody()));
    }

    /**
     * Change the state of a device controlled by ARI. (Note - implicitly creates the device state).
     *
     * @param string $deviceName Name of the device
     * @param string $deviceState (required) Device state value
     * @throws ConflictException
     * @throws NotFoundException
     */
    public function updateDeviceState($deviceName, $deviceState)
    {
        $uri = "deviceStates/$deviceName";
        try {
            $this->client->getEndpoint()->put($uri, [
                'form_params' => [
                    'deviceState' => $deviceState,
                ]
            ]);
        } catch (RequestException $e) {
            $this->processRequestException($e);
        }
    }

    /**
     * Destroy a device-state controlled by ARI.
     *
     * @param string $deviceName Name of the device
     * @throws ConflictException
     * @throws NotFoundException
     */
    public function deleteDeviceState($deviceName)
    {
        $uri = "deviceStates/$deviceName";
        try {
            $this->client->getEndpoint()->delete($uri);
        } catch (RequestException $e) {
            $this->processRequestException($e);
        }
    }
}