ZendeskChannel::__construct() - Code Metrics - Inspection of "Enable notification to update existing ticket" - assaqqaf/zendesk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#13)

by Abdullah

created 2017-01-16 06:51 UTC

ZendeskChannel::__construct() A

↳ Parent: ZendeskChannel

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

namespace NotificationChannels\Zendesk;

use Illuminate\Support\Arr;
use Zendesk\API\HttpClient;
use Illuminate\Notifications\Notification;
use NotificationChannels\Zendesk\Exceptions\CouldNotSendNotification;

class ZendeskChannel
{
    /** @var HttpClient */
    protected $client;

    /** @var array */
    protected $parameters;

    /** @param HttpClient $client */
    public function __construct(HttpClient $client)
    {
        $this->client = $client;
    }

    /**
     * Send the given notification.
     *
     * @param mixed $notifiable
     * @param \Illuminate\Notifications\Notification $notification
     *
     * @throws \NotificationChannels\Zendesk\Exceptions\InvalidConfiguration
     * @throws \NotificationChannels\Zendesk\Exceptions\CouldNotSendNotification
     */
    public function send($notifiable, Notification $notification)
    {
        $this->parameters = $notification->toZendesk($notifiable)->toArray();


        $id = $this->parameters['ticket'];

        if (! is_null($id)) {
            return $this->updateTicket($id, $notifiable);
        }

        return $this->createNewTicket($notifiable);
    }

    /**
     * Send update ticket request.
     *
     * @param mixed $notifiable
     */
    private function updateTicket($id, $notifiable)

    {
        $this->prepareUpdateParameters();

        try {
            $this->client->tickets()->update($id, $this->parameters);
        } catch (\Exception $e) {
            throw CouldNotSendNotification::serviceRespondedWithAnError($e->getMessage());
        }
    }

    /**
     * Send create ticket request.
     *
     * @param mixed $notifiable
     */
    private function createNewTicket($notifiable)

    {
        $this->prepareCreateParameter($notifiable);

        try {
            $this->client->tickets()->create($this->parameters);
        } catch (\Exception $e) {
            throw CouldNotSendNotification::serviceRespondedWithAnError($e->getMessage());
        }
    }

    /**
     * Prepare the parameters before update request send.
     *
     * @param mixed $notifiable
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function prepareUpdateParameters()
    {
        unset($this->parameters['subject'], $this->parameters['requester'], $this->parameters['description'], $this->parameters['ticket']);
    }

    /**
     * Prepare the parameters before create request send.
     *
     * @param mixed $notifiable
     */
    private function prepareCreateParameter($notifiable)
    {
        // Check if the requester data is not set
        if (! isset($this->parameters['requester']['name']) || $this->parameters['requester']['name'] === '') {
            $routing = collect($notifiable->routeNotificationFor('Zendesk'));
            if (! Arr::has($routing, ['name', 'email'])) {
                return;
            }

            $this->parameters['requester']['name'] = $routing['name'];
            $this->parameters['requester']['email'] = $routing['email'];
        }

        unset($this->parameters['ticket']);
    }
}


1			<?php
2
3			namespace NotificationChannels\Zendesk;
4
5			use Illuminate\Support\Arr;
6			use Zendesk\API\HttpClient;
7			use Illuminate\Notifications\Notification;
8			use NotificationChannels\Zendesk\Exceptions\CouldNotSendNotification;
9
10			class ZendeskChannel
11			{
12			/** @var HttpClient */
13			protected $client;
14
15			/** @var array */
16			protected $parameters;
17
18			/** @param HttpClient $client */
19	3		public function __construct(HttpClient $client)
20			{
21	3		$this->client = $client;
22	3		}
23
24			/**
25			* Send the given notification.
26			*
27			* @param mixed $notifiable
28			* @param \Illuminate\Notifications\Notification $notification
29			*
30			* @throws \NotificationChannels\Zendesk\Exceptions\InvalidConfiguration
31			* @throws \NotificationChannels\Zendesk\Exceptions\CouldNotSendNotification
32			*/
33	3		public function send($notifiable, Notification $notification)
34			{
35	3		$this->parameters = $notification->toZendesk($notifiable)->toArray();
			1 ignored issue – show Bug introduced 2017-01-14 04:40 UTC by Report Bug Copy Issue Report The method `toZendesk()` 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...
36
37	3		$id = $this->parameters['ticket'];
38
39	3		if (! is_null($id)) {
40	1		return $this->updateTicket($id, $notifiable);
41			}
42
43	2		return $this->createNewTicket($notifiable);
44			}
45
46			/**
47			* Send update ticket request.
48			*
49			* @param mixed $notifiable
50			*/
51	1	View Code Duplication	private function updateTicket($id, $notifiable)
			1 ignored issue – show Unused Code introduced 2017-01-16 06:38 UTC by Report Bug Copy Issue Report The parameter `$notifiable` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Duplication introduced 2017-01-16 06:38 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...
52			{
53	1		$this->prepareUpdateParameters();
54
55			try {
56	1		$this->client->tickets()->update($id, $this->parameters);
57			} catch (\Exception $e) {
58			throw CouldNotSendNotification::serviceRespondedWithAnError($e->getMessage());
59			}
60	1		}
61
62			/**
63			* Send create ticket request.
64			*
65			* @param mixed $notifiable
66			*/
67	2	View Code Duplication	private function createNewTicket($notifiable)
			1 ignored issue – show Duplication introduced 2017-01-16 06:38 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...
68			{
69	2		$this->prepareCreateParameter($notifiable);
70
71			try {
72	2		$this->client->tickets()->create($this->parameters);
73			} catch (\Exception $e) {
74			throw CouldNotSendNotification::serviceRespondedWithAnError($e->getMessage());
75			}
76	2		}
77
78			/**
79			* Prepare the parameters before update request send.
80			*
81			* @param mixed $notifiable
			0 ignored issues – show Bug introduced 2017-01-16 06:38 UTC by Report Bug Copy Issue Report There is no parameter named `$notifiable`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
82			*/
83	1		public function prepareUpdateParameters()
84			{
85	1		unset($this->parameters['subject'], $this->parameters['requester'], $this->parameters['description'], $this->parameters['ticket']);
86	1		}
87
88			/**
89			* Prepare the parameters before create request send.
90			*
91			* @param mixed $notifiable
92			*/
93	2		private function prepareCreateParameter($notifiable)
94			{
95			// Check if the requester data is not set
96	2		if (! isset($this->parameters['requester']['name']) \|\| $this->parameters['requester']['name'] === '') {
97	1		$routing = collect($notifiable->routeNotificationFor('Zendesk'));
98	1		if (! Arr::has($routing, ['name', 'email'])) {
99			return;
100			}
101
102	1		$this->parameters['requester']['name'] = $routing['name'];
103	1		$this->parameters['requester']['email'] = $routing['email'];
104			}
105
106	2		unset($this->parameters['ticket']);
107	2		}
108			}
109

assaqqaf / zendesk

Pull Request — master (#13)

ZendeskChannel::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like