Sipgate::getUsername() - Code Metrics - Inspection of "calls method added to retrieve currently establish..." - orkhanahmadov/sipgate - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 440b32...f0f4ad )

by Orkhan

created 2019-05-21 09:50 UTC

Sipgate::getUsername() A

↳ Parent: Sipgate

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Orkhanahmadov\Sipgate;

use GuzzleHttp\Client;
use Orkhanahmadov\Sipgate\Resources\Call;
use Orkhanahmadov\Sipgate\Resources\Device;
use Orkhanahmadov\Sipgate\Resources\History;
use Orkhanahmadov\Sipgate\Resources\User;

class Sipgate implements Telephony
{
    /**
     * @var string|null
     */
    private $username = null;
    /**
     * @var string|null
     */
    private $password = null;
    /**
     * @var Client
     */
    private $client;

    /**
     * Sipgate constructor.
     *
     * @param string|null $username
     * @param string|null $password
     */
    public function __construct(?string $username = null, ?string $password = null)
    {
        $this->username = $username;
        $this->password = $password;

        $this->client = new Client(['base_uri' => 'https://api.sipgate.com/v2/']);
    }

    /**
     * @param string $username
     * @param string $password
     *
     * @return Sipgate
     */
    public function setBasicAuthCredentials(string $username, string $password)
    {
        $this->username = $username;
        $this->password = $password;

        return $this;
    }

    /**
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @return array|null
     */
    public function account(): ?array
    {
        return $this->sendRequest('account');
    }

    /**
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @return array
     */
    public function users(): array
    {
        $response = $this->sendRequest('users');

        $users = [];
        foreach ($response['items'] as $user) {
            array_push($users, new User($user));
        }

        return $users;
    }

    /**
     * @param User|string $user
     *
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @return array
     */
    public function devices($user): array
    {
        $userId = $user instanceof User ? $user->id : $user;

        $response = $this->sendRequest($userId.'/devices');

        $devices = [];
        foreach ($response['items'] as $device) {
            array_push($devices, new Device($user, $device));
        }

        return $devices;
    }

    /**
     * Returns currently established calls
     *
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @return array
     */
    public function calls(): array
    {
        $response = $this->sendRequest('calls');

        $calls = [];
        foreach ($response['data'] as $call) {
            array_push($calls, new Call($call));
        }

        return $calls;
    }

    /**
     * @param Device|string $device
     * @param string|int    $callee
     * @param array         $options
     *
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @return string
     */
    public function initiateCall($device, $callee, array $options = []): string
    {
        $response = $this->sendRequest('sessions/calls', 'POST', [
            'json' => [
                'caller'   => $device instanceof Device ? $device->id : $device,
                'callee'   => $callee,
                'callerId' => isset($options['callerId']) ? $options['callerId'] : null,
            ],
        ]);

        if (isset($options['recording'], $options['recording']['value'], $options['recording']['announcement'])) {
            $this->recordCall(
                $response['sessionId'],
                $options['recording']['value'],
                $options['recording']['announcement']
            );
        }

        return $response['sessionId'];
    }

    /**
     * @param string $callId
     * @param bool   $value
     * @param bool   $announcement
     *
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @return bool
     */
    public function recordCall(string $callId, bool $value, bool $announcement): bool
    {
        $this->sendRequest('calls/'.$callId.'/recording', 'PUT', [
            'json' => [
                'value'        => $value,
                'announcement' => $announcement,
            ],
        ]);

        return $value;
    }

    /**
     * @param array $options
     *
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @return array
     */
    public function history(array $options = []): array
    {
        $response = $this->sendRequest('history', 'GET', ['query' => $options]);

        $history = [];
        foreach ($response['items'] as $item) {
            array_push($history, new History($item));
        }

        return $history;
    }

    /**
     * @param string $url
     * @param string $method
     * @param array  $options
     *
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @return array|null
     */
    private function sendRequest(string $url, string $method = 'GET', array $options = []): ?array
    {
        $response = $this->client->request($method, $url, array_merge(
            [
                'headers' => ['Accept' => 'application/json'],
                'auth'    => [$this->username, $this->password],
            ],
            $options
        ));

        return json_decode($response->getBody()->getContents(), true);
    }

    /**
     * @param Client $client
     */
    public function setClient(Client $client): void
    {
        $this->client = $client;
    }

    /**
     * @return string|null
     */
    public function getUsername(): ?string
    {
        return $this->username;
    }

    /**
     * @return string|null
     */
    public function getPassword(): ?string
    {
        return $this->password;
    }
}


1			<?php
2
3			namespace Orkhanahmadov\Sipgate;
4
5			use GuzzleHttp\Client;
6			use Orkhanahmadov\Sipgate\Resources\Call;
7			use Orkhanahmadov\Sipgate\Resources\Device;
8			use Orkhanahmadov\Sipgate\Resources\History;
9			use Orkhanahmadov\Sipgate\Resources\User;
10
11			class Sipgate implements Telephony
12			{
13			/**
14			* @var string\|null
15			*/
16			private $username = null;
17			/**
18			* @var string\|null
19			*/
20			private $password = null;
21			/**
22			* @var Client
23			*/
24			private $client;
25
26			/**
27			* Sipgate constructor.
28			*
29			* @param string\|null $username
30			* @param string\|null $password
31			*/
32			public function __construct(?string $username = null, ?string $password = null)
33			{
34			$this->username = $username;
35			$this->password = $password;
36
37			$this->client = new Client(['base_uri' => 'https://api.sipgate.com/v2/']);
38			}
39
40			/**
41			* @param string $username
42			* @param string $password
43			*
44			* @return Sipgate
45			*/
46			public function setBasicAuthCredentials(string $username, string $password)
47			{
48			$this->username = $username;
49			$this->password = $password;
50
51			return $this;
52			}
53
54			/**
55			* @throws \GuzzleHttp\Exception\GuzzleException
56			*
57			* @return array\|null
58			*/
59			public function account(): ?array
60			{
61			return $this->sendRequest('account');
62			}
63
64			/**
65			* @throws \GuzzleHttp\Exception\GuzzleException
66			*
67			* @return array
68			*/
69			public function users(): array
70			{
71			$response = $this->sendRequest('users');
72
73			$users = [];
74			foreach ($response['items'] as $user) {
75			array_push($users, new User($user));
76			}
77
78			return $users;
79			}
80
81			/**
82			* @param User\|string $user
83			*
84			* @throws \GuzzleHttp\Exception\GuzzleException
85			*
86			* @return array
87			*/
88			public function devices($user): array
89			{
90			$userId = $user instanceof User ? $user->id : $user;
91
92			$response = $this->sendRequest($userId.'/devices');
93
94			$devices = [];
95			foreach ($response['items'] as $device) {
96			array_push($devices, new Device($user, $device));
97			}
98
99			return $devices;
100			}
101
102			/**
103			* Returns currently established calls
104			*
105			* @throws \GuzzleHttp\Exception\GuzzleException
106			*
107			* @return array
108			*/
109			public function calls(): array
110			{
111			$response = $this->sendRequest('calls');
112
113			$calls = [];
114			foreach ($response['data'] as $call) {
115			array_push($calls, new Call($call));
116			}
117
118			return $calls;
119			}
120
121			/**
122			* @param Device\|string $device
123			* @param string\|int $callee
124			* @param array $options
125			*
126			* @throws \GuzzleHttp\Exception\GuzzleException
127			*
128			* @return string
129			*/
130			public function initiateCall($device, $callee, array $options = []): string
131			{
132			$response = $this->sendRequest('sessions/calls', 'POST', [
133			'json' => [
134			'caller' => $device instanceof Device ? $device->id : $device,
135			'callee' => $callee,
136			'callerId' => isset($options['callerId']) ? $options['callerId'] : null,
137			],
138			]);
139
140			if (isset($options['recording'], $options['recording']['value'], $options['recording']['announcement'])) {
141			$this->recordCall(
142			$response['sessionId'],
143			$options['recording']['value'],
144			$options['recording']['announcement']
145			);
146			}
147
148			return $response['sessionId'];
149			}
150
151			/**
152			* @param string $callId
153			* @param bool $value
154			* @param bool $announcement
155			*
156			* @throws \GuzzleHttp\Exception\GuzzleException
157			*
158			* @return bool
159			*/
160			public function recordCall(string $callId, bool $value, bool $announcement): bool
161			{
162			$this->sendRequest('calls/'.$callId.'/recording', 'PUT', [
163			'json' => [
164			'value' => $value,
165			'announcement' => $announcement,
166			],
167			]);
168
169			return $value;
170			}
171
172			/**
173			* @param array $options
174			*
175			* @throws \GuzzleHttp\Exception\GuzzleException
176			*
177			* @return array
178			*/
179			public function history(array $options = []): array
180			{
181			$response = $this->sendRequest('history', 'GET', ['query' => $options]);
182
183			$history = [];
184			foreach ($response['items'] as $item) {
185			array_push($history, new History($item));
186			}
187
188			return $history;
189			}
190
191			/**
192			* @param string $url
193			* @param string $method
194			* @param array $options
195			*
196			* @throws \GuzzleHttp\Exception\GuzzleException
197			*
198			* @return array\|null
199			*/
200			private function sendRequest(string $url, string $method = 'GET', array $options = []): ?array
201			{
202			$response = $this->client->request($method, $url, array_merge(
203			[
204			'headers' => ['Accept' => 'application/json'],
205			'auth' => [$this->username, $this->password],
206			],
207			$options
208			));
209
210			return json_decode($response->getBody()->getContents(), true);
211			}
212
213			/**
214			* @param Client $client
215			*/
216			public function setClient(Client $client): void
217			{
218			$this->client = $client;
219			}
220
221			/**
222			* @return string\|null
223			*/
224			public function getUsername(): ?string
225			{
226			return $this->username;
227			}
228
229			/**
230			* @return string\|null
231			*/
232			public function getPassword(): ?string
233			{
234			return $this->password;
235			}
236			}
237

orkhanahmadov / sipgate

Push — master ( 440b32...f0f4ad )

Sipgate::getUsername() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like