TrelloChannel::__construct() - Code Metrics - Inspection of "Adds method for adding comments when creating Trel..." - laravel-notification-channels/trello - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#7)

unknown

created 2017-06-23 14:46 UTC

TrelloChannel::__construct() A

↳ Parent: TrelloChannel

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	5
ccs	0
cts	5
cp	0
rs	9.4285
cc	1
eloc	3
nc	1
nop	1
crap	2

<?php

namespace NotificationChannels\Trello;

use GuzzleHttp\Client;
use Illuminate\Notifications\Notification;
use Illuminate\Support\Arr;
use NotificationChannels\Trello\Exceptions\CouldNotAddComment;
use NotificationChannels\Trello\Exceptions\CouldNotSendNotification;
use NotificationChannels\Trello\Exceptions\InvalidConfiguration;

class TrelloChannel
{
    const API_ENDPOINT = 'https://api.trello.com/1/cards/';

    /** @var Client */
    protected $client;

    /** @var key trello key */
    protected $key;

    /** @param Client $client */
    public function __construct(Client $client)
    {
        $this->client = $client;
        $this->key = config('services.trello.key');
    }

    /**
     * Send the given notification.
     *
     * @param mixed $notifiable
     * @param \Illuminate\Notifications\Notification $notification
     *
     * @throws \NotificationChannels\Trello\Exceptions\InvalidConfiguration
     * @throws \NotificationChannels\Trello\Exceptions\CouldNotSendNotification
     * @throws \NotificationChannels\Trello\Exceptions\CouldAddComment
     */
    public function send($notifiable, Notification $notification)
    {
        if (!$routing = collect($notifiable->routeNotificationFor('Trello'))) {
            return;
        }

        if (is_null($this->key)) {
            throw InvalidConfiguration::configurationNotSet();
        }

        $trelloParameters = $notification->toTrello($notifiable)->toArray();

        $trelloCardComments = $notification->toTrello($notifiable)->getComments();


        $response = $this->client->post(self::API_ENDPOINT . '?key=' . $this->key . '&token=' . $routing->get('token'), [
            'form_params' => Arr::set($trelloParameters, 'idList', $routing->get('idList')),
        ]);

        if ($response->getStatusCode() !== 200) {
            throw CouldNotSendNotification::serviceRespondedWithAnError($response);
        }

        if ($trelloCardComments) {
            $this->addComments($notifiable, $trelloCardComments, $response);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
    }

    /**
     * Add comments to newly created card.
     * @param mixed $notifiable
     * @param array  $trelloCardComments array holding the comments to add
     * @param Response $response           response object from the trello api
     *
     * @throws \NotificationChannels\Trello\Exceptions\CouldAddComment
     */
    public function addComments($notifiable, array $trelloCardComments, $response)
    {
        if (!$routing = collect($notifiable->routeNotificationFor('Trello'))) {
            return;
        }

        $cardId = json_decode($response->getBody()->getContents())->id;
        foreach ($trelloCardComments as $comment) {
            $response = $this->client->post(self::API_ENDPOINT . $cardId . '/actions/comments?key=' . $this->key . '&token=' . $routing->get('token'), [
                'form_params' => ['text' => $comment],
            ]);
            if ($response->getStatusCode() !== 200) {
                throw CouldNotAddComment::serviceRespondedWithAnError($response);
            }
        }
    }

}


1			<?php
2
3			namespace NotificationChannels\Trello;
4
5			use GuzzleHttp\Client;
6			use Illuminate\Notifications\Notification;
7			use Illuminate\Support\Arr;
8			use NotificationChannels\Trello\Exceptions\CouldNotAddComment;
9			use NotificationChannels\Trello\Exceptions\CouldNotSendNotification;
10			use NotificationChannels\Trello\Exceptions\InvalidConfiguration;
11
12			class TrelloChannel
13			{
14			const API_ENDPOINT = 'https://api.trello.com/1/cards/';
15
16			/** @var Client */
17			protected $client;
18
19			/** @var key trello key */
20			protected $key;
21
22			/** @param Client $client */
23			public function __construct(Client $client)
24			{
25			$this->client = $client;
26			$this->key = config('services.trello.key');
27			}
28
29			/**
30			* Send the given notification.
31			*
32			* @param mixed $notifiable
33			* @param \Illuminate\Notifications\Notification $notification
34			*
35			* @throws \NotificationChannels\Trello\Exceptions\InvalidConfiguration
36			* @throws \NotificationChannels\Trello\Exceptions\CouldNotSendNotification
37			* @throws \NotificationChannels\Trello\Exceptions\CouldAddComment
38			*/
39			public function send($notifiable, Notification $notification)
40			{
41			if (!$routing = collect($notifiable->routeNotificationFor('Trello'))) {
42			return;
43			}
44
45			if (is_null($this->key)) {
46			throw InvalidConfiguration::configurationNotSet();
47			}
48
49			$trelloParameters = $notification->toTrello($notifiable)->toArray();
			0 ignored issues – show Bug introduced 2016-08-14 18:38 UTC by Report Bug Copy Issue Report The method `toTrello()` does not seem to exist on `object<Illuminate\Notifications\Notification>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
50			$trelloCardComments = $notification->toTrello($notifiable)->getComments();
			0 ignored issues – show Bug introduced 2017-06-23 14:51 UTC by Report Bug Copy Issue Report The method `toTrello()` does not seem to exist on `object<Illuminate\Notifications\Notification>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
51
52			$response = $this->client->post(self::API_ENDPOINT . '?key=' . $this->key . '&token=' . $routing->get('token'), [
53			'form_params' => Arr::set($trelloParameters, 'idList', $routing->get('idList')),
54			]);
55
56			if ($response->getStatusCode() !== 200) {
57			throw CouldNotSendNotification::serviceRespondedWithAnError($response);
58			}
59
60			if ($trelloCardComments) {
61			$this->addComments($notifiable, $trelloCardComments, $response);
			0 ignored issues – show Documentation introduced 2017-06-23 14:51 UTC by Report Bug Copy Issue Report `$response` is of type `object<Psr\Http\Message\ResponseInterface>`, but the function expects a `object<NotificationChannels\Trello\Response>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
62			}
63			}
64
65			/**
66			* Add comments to newly created card.
67			* @param mixed $notifiable
68			* @param array $trelloCardComments array holding the comments to add
69			* @param Response $response response object from the trello api
70			*
71			* @throws \NotificationChannels\Trello\Exceptions\CouldAddComment
72			*/
73			public function addComments($notifiable, array $trelloCardComments, $response)
74			{
75			if (!$routing = collect($notifiable->routeNotificationFor('Trello'))) {
76			return;
77			}
78
79			$cardId = json_decode($response->getBody()->getContents())->id;
80			foreach ($trelloCardComments as $comment) {
81			$response = $this->client->post(self::API_ENDPOINT . $cardId . '/actions/comments?key=' . $this->key . '&token=' . $routing->get('token'), [
82			'form_params' => ['text' => $comment],
83			]);
84			if ($response->getStatusCode() !== 200) {
85			throw CouldNotAddComment::serviceRespondedWithAnError($response);
86			}
87			}
88			}
89
90			}
91

laravel-notification-channels / trello

Pull Request — master (#7)

TrelloChannel::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like