Client::ping() - Code Metrics - Inspection of "reconnect stale websocket" - nopolabs/yabot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b0e1f8...ce2c58 )

by Dan

created 2017-07-27 03:47 UTC

Client::ping() A

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Nopolabs\Yabot\Slack;


use Closure;
use Nopolabs\Yabot\Helpers\ConfigTrait;
use Nopolabs\Yabot\Helpers\LogTrait;
use Psr\Log\LoggerInterface;
use React\Promise\PromiseInterface;
use Slack\Channel;
use Slack\ChannelInterface;
use Slack\Payload;
use Slack\RealTimeClient;
use Slack\User;

class Client
{
    use ConfigTrait;
    use LogTrait;

    /** @var RealTimeClient */
    private $realTimeClient;

    /** @var Users */
    private $users;

    /** @var Channels */
    private $channels;

    /** @var User */
    protected $authedUser;

    public function __construct(
        RealTimeClient $realTimeClient,
        Users $users,
        Channels $channels,
        array $config = [],
        LoggerInterface $log = null)
    {
        $this->realTimeClient = $realTimeClient;
        $this->users = $users;
        $this->channels = $channels;
        $this->setConfig($config);
        $this->setLog($log);
    }

    public function init() : Client
    {
        $this->initChannelUpdateHandlers();
        $this->initUserUpdateHandlers();

        return $this;
    }

    public function update(Closure $authedUserUpdated)
    {
        $this->updateUsers();
        $this->updateChannels();
        $this->updateAuthedUser($authedUserUpdated);
    }

    public function onEvent($event, array $onEvent)
    {
        $this->realTimeClient->on($event, function(Payload $payload) use ($onEvent) {
            call_user_func($onEvent, $payload);
        });
    }

    public function getRealTimeClient()
    {
        return $this->realTimeClient;
    }

    public function getAuthedUser()
    {
        return $this->authedUser;
    }

    public function getAuthedUsername()
    {
        return $this->authedUser->getUsername();
    }

    public function connect() : PromiseInterface
    {
        return $this->realTimeClient->connect();
    }

    public function disconnect()
    {
        $this->realTimeClient->disconnect();
    }

    public function reconnect() : PromiseInterface
    {
        $this->realTimeClient->disconnect();
        return $this->realTimeClient->connect();
    }

    public function ping() : PromiseInterface
    {
        return $this->getRealTimeClient()->ping();
    }

    public function say($text, $channelOrName, array $additionalParameters = [])
    {
        $channel = $channelOrName;
        if (!($channel instanceof ChannelInterface)) {
            $channel = $this->getChannelByName($channelOrName);
            if (!($channel instanceof ChannelInterface)) {
                $channel = $this->getChannelById($channelOrName);
                if (!($channel instanceof ChannelInterface)) {
                    $this->warning('No channel, trying to say: '.$text);
                    return;
                }
            }
        }

        if (empty($additionalParameters) && $this->useWebSocket()) {
            // WebSocket send does not support message formatting.
            $this->send($text, $channel);
            return;
        }

        // Http post send supports message formatting.
        $this->post($text, $channel, $additionalParameters);
    }

    public function send($text, ChannelInterface $channel)
    {
        $this->realTimeClient->send($text, $channel);
    }

    public function post($text, ChannelInterface $channel, array $additionalParameters = [])

    {
        $parameters = array_merge([
            'text' => $text,
            'channel' => $channel->getId(),
            'as_user' => true,
        ], $additionalParameters);

        $this->realTimeClient->apiCall('chat.postMessage', $parameters);
    }

    public function directMessage($text, $userName)

    {
        $parameters = [
            'text' => $text,
            'channel' => $userName,
            'as_user' => false,
        ];

        $this->realTimeClient->apiCall('chat.postMessage', $parameters);
    }

    /**
     * @param $id
     * @return null|User
     */
    public function getUserById($id)
    {
        return $this->users->byId($id);
    }

    /**
     * @param $name
     * @return null|User
     */
    public function getUserByName($name)
    {
        return $this->users->byName($name);
    }

    /**
     * @param $id
     * @return null|Channel
     */
    public function getChannelById($id)
    {
        return $this->channels->byId($id);
    }

    /**
     * @param $name
     * @return null|Channel
     */
    public function getChannelByName($name)
    {
        return $this->channels->byName($name);
    }

    protected function useWebSocket() : bool
    {
        return (bool) $this->get('use.websocket', false);
    }

    protected function updateUsers()
    {
        $this->realTimeClient->getUsers()->then(function(array $users) {
            $this->users->update($users);
        });
    }

    protected function updateChannels()
    {
        $this->realTimeClient->getChannels()->then(function(array $channels) {
            $this->channels->update($channels);
        });
    }

    protected function updateAuthedUser(Closure $authedUserUpdated)
    {
        $this->realTimeClient->getAuthedUser()->then(function(User $user) use ($authedUserUpdated) {
            $this->authedUser = $user;
            $authedUserUpdated($user);
        });
    }

    protected function initChannelUpdateHandlers()
    {
        $events = ['channel_created', 'channel_deleted', 'channel_rename'];
        foreach ($events as $event) {
            $this->onEvent($event, [$this, 'updateChannels']);
        }
    }

    protected function initUserUpdateHandlers()
    {
        $events = ['user_change'];
        foreach ($events as $event) {
            $this->onEvent($event, [$this, 'updateUsers']);
        }
    }
}

1		<?php
2
3		namespace Nopolabs\Yabot\Slack;
4
5
6		use Closure;
7		use Nopolabs\Yabot\Helpers\ConfigTrait;
8		use Nopolabs\Yabot\Helpers\LogTrait;
9		use Psr\Log\LoggerInterface;
10		use React\Promise\PromiseInterface;
11		use Slack\Channel;
12		use Slack\ChannelInterface;
13		use Slack\Payload;
14		use Slack\RealTimeClient;
15		use Slack\User;
16
17		class Client
18		{
19		use ConfigTrait;
20		use LogTrait;
21
22		/** @var RealTimeClient */
23		private $realTimeClient;
24
25		/** @var Users */
26		private $users;
27
28		/** @var Channels */
29		private $channels;
30
31		/** @var User */
32		protected $authedUser;
33
34		public function __construct(
35		RealTimeClient $realTimeClient,
36		Users $users,
37		Channels $channels,
38		array $config = [],
39		LoggerInterface $log = null)
40		{
41		$this->realTimeClient = $realTimeClient;
42		$this->users = $users;
43		$this->channels = $channels;
44		$this->setConfig($config);
45		$this->setLog($log);
46		}
47
48		public function init() : Client
49		{
50		$this->initChannelUpdateHandlers();
51		$this->initUserUpdateHandlers();
52
53		return $this;
54		}
55
56		public function update(Closure $authedUserUpdated)
57		{
58		$this->updateUsers();
59		$this->updateChannels();
60		$this->updateAuthedUser($authedUserUpdated);
61		}
62
63		public function onEvent($event, array $onEvent)
64		{
65		$this->realTimeClient->on($event, function(Payload $payload) use ($onEvent) {
66		call_user_func($onEvent, $payload);
67		});
68		}
69
70		public function getRealTimeClient()
71		{
72		return $this->realTimeClient;
73		}
74
75		public function getAuthedUser()
76		{
77		return $this->authedUser;
78		}
79
80		public function getAuthedUsername()
81		{
82		return $this->authedUser->getUsername();
83		}
84
85		public function connect() : PromiseInterface
86		{
87		return $this->realTimeClient->connect();
88		}
89
90		public function disconnect()
91		{
92		$this->realTimeClient->disconnect();
93		}
94
95		public function reconnect() : PromiseInterface
96		{
97		$this->realTimeClient->disconnect();
98		return $this->realTimeClient->connect();
99		}
100
101		public function ping() : PromiseInterface
102		{
103		return $this->getRealTimeClient()->ping();
104		}
105
106		public function say($text, $channelOrName, array $additionalParameters = [])
107		{
108		$channel = $channelOrName;
109		if (!($channel instanceof ChannelInterface)) {
110		$channel = $this->getChannelByName($channelOrName);
111		if (!($channel instanceof ChannelInterface)) {
112		$channel = $this->getChannelById($channelOrName);
113		if (!($channel instanceof ChannelInterface)) {
114		$this->warning('No channel, trying to say: '.$text);
115		return;
116		}
117		}
118		}
119
120		if (empty($additionalParameters) && $this->useWebSocket()) {
121		// WebSocket send does not support message formatting.
122		$this->send($text, $channel);
123		return;
124		}
125
126		// Http post send supports message formatting.
127		$this->post($text, $channel, $additionalParameters);
128		}
129
130		public function send($text, ChannelInterface $channel)
131		{
132		$this->realTimeClient->send($text, $channel);
133		}
134
135	View Code Duplication	public function post($text, ChannelInterface $channel, array $additionalParameters = [])
		0 ignored issues – show Duplication introduced 2017-07-12 18:32 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
136		{
137		$parameters = array_merge([
138		'text' => $text,
139		'channel' => $channel->getId(),
140		'as_user' => true,
141		], $additionalParameters);
142
143		$this->realTimeClient->apiCall('chat.postMessage', $parameters);
144		}
145
146	View Code Duplication	public function directMessage($text, $userName)
		0 ignored issues – show Duplication introduced 2017-07-12 18:32 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
147		{
148		$parameters = [
149		'text' => $text,
150		'channel' => $userName,
151		'as_user' => false,
152		];
153
154		$this->realTimeClient->apiCall('chat.postMessage', $parameters);
155		}
156
157		/**
158		* @param $id
159		* @return null\|User
160		*/
161		public function getUserById($id)
162		{
163		return $this->users->byId($id);
164		}
165
166		/**
167		* @param $name
168		* @return null\|User
169		*/
170		public function getUserByName($name)
171		{
172		return $this->users->byName($name);
173		}
174
175		/**
176		* @param $id
177		* @return null\|Channel
178		*/
179		public function getChannelById($id)
180		{
181		return $this->channels->byId($id);
182		}
183
184		/**
185		* @param $name
186		* @return null\|Channel
187		*/
188		public function getChannelByName($name)
189		{
190		return $this->channels->byName($name);
191		}
192
193		protected function useWebSocket() : bool
194		{
195		return (bool) $this->get('use.websocket', false);
196		}
197
198		protected function updateUsers()
199		{
200		$this->realTimeClient->getUsers()->then(function(array $users) {
201		$this->users->update($users);
202		});
203		}
204
205		protected function updateChannels()
206		{
207		$this->realTimeClient->getChannels()->then(function(array $channels) {
208		$this->channels->update($channels);
209		});
210		}
211
212		protected function updateAuthedUser(Closure $authedUserUpdated)
213		{
214		$this->realTimeClient->getAuthedUser()->then(function(User $user) use ($authedUserUpdated) {
215		$this->authedUser = $user;
216		$authedUserUpdated($user);
217		});
218		}
219
220		protected function initChannelUpdateHandlers()
221		{
222		$events = ['channel_created', 'channel_deleted', 'channel_rename'];
223		foreach ($events as $event) {
224		$this->onEvent($event, [$this, 'updateChannels']);
225		}
226		}
227
228		protected function initUserUpdateHandlers()
229		{
230		$events = ['user_change'];
231		foreach ($events as $event) {
232		$this->onEvent($event, [$this, 'updateUsers']);
233		}
234		}
235		}

nopolabs / yabot

Push — master ( b0e1f8...ce2c58 )

Client::ping() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like