Newsletter::getApi() - Code Metrics - Inspection of "added function for loading all interest categories..." - spatie/laravel-newsletter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#228)

unknown

created 2020-02-22 23:08 UTC

Newsletter::getApi() A

↳ Parent: Newsletter

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Spatie\Newsletter;

use DrewM\MailChimp\MailChimp;

class Newsletter
{
    /** @var \DrewM\MailChimp\MailChimp */
    protected $mailChimp;

    /** @var \Spatie\Newsletter\NewsletterListCollection */
    protected $lists;

    public function __construct(MailChimp $mailChimp, NewsletterListCollection $lists)
    {
        $this->mailChimp = $mailChimp;

        $this->lists = $lists;
    }

    public function subscribe(string $email, array $mergeFields = [], string $listName = '', array $options = [])

    {
        $list = $this->lists->findByName($listName);

        $options = $this->getSubscriptionOptions($email, $mergeFields, $options);

        $response = $this->mailChimp->post("lists/{$list->getId()}/members", $options);

        if (! $this->lastActionSucceeded()) {
            return false;
        }

        return $response;
    }

    public function subscribePending(string $email, array $mergeFields = [], string $listName = '', array $options = [])
    {
        $options = array_merge($options, ['status' => 'pending']);

        return $this->subscribe($email, $mergeFields, $listName, $options);
    }

    public function subscribeOrUpdate(string $email, array $mergeFields = [], string $listName = '', array $options = [])

    {
        $list = $this->lists->findByName($listName);

        $options = $this->getSubscriptionOptions($email, $mergeFields, $options);

        $response = $this->mailChimp->put("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}", $options);

        if (! $this->lastActionSucceeded()) {
            return false;
        }

        return $response;
    }

    public function getMembers(string $listName = '', array $parameters = [])
    {
        $list = $this->lists->findByName($listName);

        return $this->mailChimp->get("lists/{$list->getId()}/members", $parameters);
    }

    public function getMember(string $email, string $listName = '')
    {
        $list = $this->lists->findByName($listName);

        return $this->mailChimp->get("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}");
    }

    public function getMemberActivity(string $email, string $listName = '')
    {
        $list = $this->lists->findByName($listName);

        return $this->mailChimp->get("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}/activity");
    }

    public function hasMember(string $email, string $listName = ''): bool
    {
        $response = $this->getMember($email, $listName);

        if (! isset($response['email_address'])) {
            return false;
        }

        if (strtolower($response['email_address']) != strtolower($email)) {
            return false;
        }

        return true;
    }

    public function isSubscribed(string $email, string $listName = ''): bool
    {
        $response = $this->getMember($email, $listName);

        if (! isset($response)) {
            return false;
        }

        if ($response['status'] != 'subscribed') {
            return false;
        }

        return true;
    }

    public function unsubscribe(string $email, string $listName = '')

    {
        $list = $this->lists->findByName($listName);

        $response = $this->mailChimp->patch("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}", [
            'status' => 'unsubscribed',
        ]);

        if (! $this->lastActionSucceeded()) {
            return false;
        }

        return $response;
    }

    public function updateEmailAddress(string $currentEmailAddress, string $newEmailAddress, string $listName = '')

    {
        $list = $this->lists->findByName($listName);

        $response = $this->mailChimp->patch("lists/{$list->getId()}/members/{$this->getSubscriberHash($currentEmailAddress)}", [
            'email_address' => $newEmailAddress,
        ]);

        return $response;
    }

    public function delete(string $email, string $listName = '')

    {
        $list = $this->lists->findByName($listName);

        $response = $this->mailChimp->delete("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}");

        return $response;
    }

    public function deletePermanently(string $email, string $listName = '')

    {
        $list = $this->lists->findByName($listName);

        $response = $this->mailChimp->post("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}/actions/delete-permanent");

        return $response;
    }

    public function getTags(string $email, string $listName = '')
    {
        $list = $this->lists->findByName($listName);

        return $this->mailChimp->get("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}/tags");
    }

    public function addTags(array $tags, string $email, string $listName = '')

    {
        $list = $this->lists->findByName($listName);

        $payload = collect($tags)->map(function ($tag) {
            return ['name' => $tag, 'status' => 'active'];
        })->toArray();

        return $this->mailChimp->post("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}/tags", [
            'tags' => $payload,
        ]);
    }

    public function removeTags(array $tags, string $email, string $listName = '')

    {
        $list = $this->lists->findByName($listName);

        $payload = collect($tags)->map(function ($tag) {
            return ['name' => $tag, 'status' => 'inactive'];
        })->toArray();

        return $this->mailChimp->post("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}/tags", [
            'tags' => $payload,
        ]);
    }

    public function createCampaign(
        string $fromName,
        string $replyTo,
        string $subject,
        string $html = '',
        string $listName = '',
        array $options = [],
        array $contentOptions = [])
    {
        $list = $this->lists->findByName($listName);

        $defaultOptions = [
            'type' => 'regular',
            'recipients' => [
                'list_id' => $list->getId(),
            ],
            'settings' => [
                'subject_line' => $subject,
                'from_name' => $fromName,
                'reply_to' => $replyTo,
            ],
        ];

        $options = array_merge($defaultOptions, $options);

        $response = $this->mailChimp->post('campaigns', $options);

        if (! $this->lastActionSucceeded()) {
            return false;
        }

        if ($html === '') {
            return $response;
        }

        if (! $this->updateContent($response['id'], $html, $contentOptions)) {
            return false;
        }

        return $response;
    }

    public function updateContent(string $campaignId, string $html, array $options = [])
    {
        $defaultOptions = compact('html');

        $options = array_merge($defaultOptions, $options);

        $response = $this->mailChimp->put("campaigns/{$campaignId}/content", $options);

        if (! $this->lastActionSucceeded()) {
            return false;
        }

        return $response;
    }

    public function getListInterestCategories(int $count = 10, int $offset = 0, string $type = null, string $listName = '')
    {
        $list = $this->lists->findByName($listName);

        $options = [
            'count' => $count,
            'offset' => $offset,
        ];

        if ($type) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $options['type'] = $type;
        }

        return $this->mailChimp->get("lists/{$list->getId()}/interest-categories", $options);
    }

    public function getApi(): MailChimp
    {
        return $this->mailChimp;
    }

    /**
     * @return string|false
     */
    public function getLastError()
    {
        return $this->mailChimp->getLastError();
    }

    public function lastActionSucceeded(): bool
    {
        return $this->mailChimp->success();
    }

    protected function getSubscriberHash(string $email): string
    {
        return $this->mailChimp->subscriberHash($email);
    }

    protected function getSubscriptionOptions(string $email, array $mergeFields, array $options): array
    {
        $defaultOptions = [
            'email_address' => $email,
            'status' => 'subscribed',
            'email_type' => 'html',
        ];

        if (count($mergeFields)) {
            $defaultOptions['merge_fields'] = $mergeFields;
        }

        $options = array_merge($defaultOptions, $options);

        return $options;
    }
}


1		<?php
2
3		namespace Spatie\Newsletter;
4
5		use DrewM\MailChimp\MailChimp;
6
7		class Newsletter
8		{
9		/** @var \DrewM\MailChimp\MailChimp */
10		protected $mailChimp;
11
12		/** @var \Spatie\Newsletter\NewsletterListCollection */
13		protected $lists;
14
15		public function __construct(MailChimp $mailChimp, NewsletterListCollection $lists)
16		{
17		$this->mailChimp = $mailChimp;
18
19		$this->lists = $lists;
20		}
21
22	View Code Duplication	public function subscribe(string $email, array $mergeFields = [], string $listName = '', array $options = [])
		0 ignored issues – show Duplication introduced 2017-08-30 15:29 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...
23		{
24		$list = $this->lists->findByName($listName);
25
26		$options = $this->getSubscriptionOptions($email, $mergeFields, $options);
27
28		$response = $this->mailChimp->post("lists/{$list->getId()}/members", $options);
29
30		if (! $this->lastActionSucceeded()) {
31		return false;
32		}
33
34		return $response;
35		}
36
37		public function subscribePending(string $email, array $mergeFields = [], string $listName = '', array $options = [])
38		{
39		$options = array_merge($options, ['status' => 'pending']);
40
41		return $this->subscribe($email, $mergeFields, $listName, $options);
42		}
43
44	View Code Duplication	public function subscribeOrUpdate(string $email, array $mergeFields = [], string $listName = '', array $options = [])
		0 ignored issues – show Duplication introduced 2017-08-30 15:29 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...
45		{
46		$list = $this->lists->findByName($listName);
47
48		$options = $this->getSubscriptionOptions($email, $mergeFields, $options);
49
50		$response = $this->mailChimp->put("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}", $options);
51
52		if (! $this->lastActionSucceeded()) {
53		return false;
54		}
55
56		return $response;
57		}
58
59		public function getMembers(string $listName = '', array $parameters = [])
60		{
61		$list = $this->lists->findByName($listName);
62
63		return $this->mailChimp->get("lists/{$list->getId()}/members", $parameters);
64		}
65
66		public function getMember(string $email, string $listName = '')
67		{
68		$list = $this->lists->findByName($listName);
69
70		return $this->mailChimp->get("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}");
71		}
72
73		public function getMemberActivity(string $email, string $listName = '')
74		{
75		$list = $this->lists->findByName($listName);
76
77		return $this->mailChimp->get("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}/activity");
78		}
79
80		public function hasMember(string $email, string $listName = ''): bool
81		{
82		$response = $this->getMember($email, $listName);
83
84		if (! isset($response['email_address'])) {
85		return false;
86		}
87
88		if (strtolower($response['email_address']) != strtolower($email)) {
89		return false;
90		}
91
92		return true;
93		}
94
95		public function isSubscribed(string $email, string $listName = ''): bool
96		{
97		$response = $this->getMember($email, $listName);
98
99		if (! isset($response)) {
100		return false;
101		}
102
103		if ($response['status'] != 'subscribed') {
104		return false;
105		}
106
107		return true;
108		}
109
110	View Code Duplication	public function unsubscribe(string $email, string $listName = '')
		0 ignored issues – show Duplication introduced 2017-08-30 15:29 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...
111		{
112		$list = $this->lists->findByName($listName);
113
114		$response = $this->mailChimp->patch("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}", [
115		'status' => 'unsubscribed',
116		]);
117
118		if (! $this->lastActionSucceeded()) {
119		return false;
120		}
121
122		return $response;
123		}
124
125	View Code Duplication	public function updateEmailAddress(string $currentEmailAddress, string $newEmailAddress, string $listName = '')
		0 ignored issues – show Duplication introduced 2017-08-30 15:29 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...
126		{
127		$list = $this->lists->findByName($listName);
128
129		$response = $this->mailChimp->patch("lists/{$list->getId()}/members/{$this->getSubscriberHash($currentEmailAddress)}", [
130		'email_address' => $newEmailAddress,
131		]);
132
133		return $response;
134		}
135
136	View Code Duplication	public function delete(string $email, string $listName = '')
		0 ignored issues – show Duplication introduced 2019-04-23 13:07 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...
137		{
138		$list = $this->lists->findByName($listName);
139
140		$response = $this->mailChimp->delete("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}");
141
142		return $response;
143		}
144
145	View Code Duplication	public function deletePermanently(string $email, string $listName = '')
		0 ignored issues – show Duplication introduced 2019-07-27 07:57 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...
146		{
147		$list = $this->lists->findByName($listName);
148
149		$response = $this->mailChimp->post("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}/actions/delete-permanent");
150
151		return $response;
152		}
153
154		public function getTags(string $email, string $listName = '')
155		{
156		$list = $this->lists->findByName($listName);
157
158		return $this->mailChimp->get("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}/tags");
159		}
160
161	View Code Duplication	public function addTags(array $tags, string $email, string $listName = '')
		0 ignored issues – show Duplication introduced 2019-04-22 18:01 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...
162		{
163		$list = $this->lists->findByName($listName);
164
165		$payload = collect($tags)->map(function ($tag) {
166		return ['name' => $tag, 'status' => 'active'];
167		})->toArray();
168
169		return $this->mailChimp->post("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}/tags", [
170		'tags' => $payload,
171		]);
172		}
173
174	View Code Duplication	public function removeTags(array $tags, string $email, string $listName = '')
		0 ignored issues – show Duplication introduced 2019-04-22 18:01 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...
175		{
176		$list = $this->lists->findByName($listName);
177
178		$payload = collect($tags)->map(function ($tag) {
179		return ['name' => $tag, 'status' => 'inactive'];
180		})->toArray();
181
182		return $this->mailChimp->post("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}/tags", [
183		'tags' => $payload,
184		]);
185		}
186
187		public function createCampaign(
188		string $fromName,
189		string $replyTo,
190		string $subject,
191		string $html = '',
192		string $listName = '',
193		array $options = [],
194		array $contentOptions = [])
195		{
196		$list = $this->lists->findByName($listName);
197
198		$defaultOptions = [
199		'type' => 'regular',
200		'recipients' => [
201		'list_id' => $list->getId(),
202		],
203		'settings' => [
204		'subject_line' => $subject,
205		'from_name' => $fromName,
206		'reply_to' => $replyTo,
207		],
208		];
209
210		$options = array_merge($defaultOptions, $options);
211
212		$response = $this->mailChimp->post('campaigns', $options);
213
214		if (! $this->lastActionSucceeded()) {
215		return false;
216		}
217
218		if ($html === '') {
219		return $response;
220		}
221
222		if (! $this->updateContent($response['id'], $html, $contentOptions)) {
223		return false;
224		}
225
226		return $response;
227		}
228
229		public function updateContent(string $campaignId, string $html, array $options = [])
230		{
231		$defaultOptions = compact('html');
232
233		$options = array_merge($defaultOptions, $options);
234
235		$response = $this->mailChimp->put("campaigns/{$campaignId}/content", $options);
236
237		if (! $this->lastActionSucceeded()) {
238		return false;
239		}
240
241		return $response;
242		}
243
244		public function getListInterestCategories(int $count = 10, int $offset = 0, string $type = null, string $listName = '')
245		{
246		$list = $this->lists->findByName($listName);
247
248		$options = [
249		'count' => $count,
250		'offset' => $offset,
251		];
252
253		if ($type) {
		0 ignored issues – show Bug Best Practice introduced 2020-01-18 12:08 UTC by Report Bug Copy Issue Report The expression `$type` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
254		$options['type'] = $type;
255		}
256
257		return $this->mailChimp->get("lists/{$list->getId()}/interest-categories", $options);
258		}
259
260		public function getApi(): MailChimp
261		{
262		return $this->mailChimp;
263		}
264
265		/**
266		* @return string\|false
267		*/
268		public function getLastError()
269		{
270		return $this->mailChimp->getLastError();
271		}
272
273		public function lastActionSucceeded(): bool
274		{
275		return $this->mailChimp->success();
276		}
277
278		protected function getSubscriberHash(string $email): string
279		{
280		return $this->mailChimp->subscriberHash($email);
281		}
282
283		protected function getSubscriptionOptions(string $email, array $mergeFields, array $options): array
284		{
285		$defaultOptions = [
286		'email_address' => $email,
287		'status' => 'subscribed',
288		'email_type' => 'html',
289		];
290
291		if (count($mergeFields)) {
292		$defaultOptions['merge_fields'] = $mergeFields;
293		}
294
295		$options = array_merge($defaultOptions, $options);
296
297		return $options;
298		}
299		}
300

spatie / laravel-newsletter

Pull Request — master (#228)

Newsletter::getApi() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like