NewsletterTest::setUp() - Code Metrics - Inspection of "Throw exceptions when a call to the underlying API..." - spatie/laravel-newsletter - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#157)

by Barnabas
created 2018-04-19 14:35 UTC
NewsletterTest::setUp() A

↳ Parent: NewsletterTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	17
Code Lines	8
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
dl	0
loc	17
rs	9.4285
c	1
b	0
f	0
cc	1
eloc	8
nc	1
nop	0
<?php

namespace Spatie\Newsletter\Test;

use DrewM\MailChimp\MailChimp;
use Mockery;
use PHPUnit\Framework\TestCase;
use Spatie\Newsletter\Exceptions\FailedResponse;
use Spatie\Newsletter\Newsletter;
use Spatie\Newsletter\NewsletterListCollection;

class NewsletterTest extends TestCase
{
    /** @var Mockery\Mock */
    protected $mailChimpApi;

    /** @var \Spatie\Newsletter\Newsletter */
    protected $newsletter;

    public function setUp()
    {
        $this->mailChimpApi = Mockery::mock(MailChimp::class);

        $newsletterLists = NewsletterListCollection::createFromConfig(
            [
                'lists' => [
                    'list1' => ['id' => 123],
                    'list2' => ['id' => 456],
                ],
                'defaultListName' => 'list1',
            ]

        );

        $this->newsletter = new Newsletter($this->mailChimpApi, $newsletterLists);
    }

    public function tearDown()
    {
        parent::tearDown();

        if ($container = Mockery::getContainer()) {
            $this->addToAssertionCount($container->mockery_getExpectationCount());
        }

        Mockery::close();
    }

    /** @test */
    public function it_can_subscribe_someone()

    {
        $email = '[email protected]';

        $url = 'lists/123/members';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('post')->withArgs([
            $url,
            [
                'email_address' => $email,
                'status' => 'subscribed',
                'email_type' => 'html',
            ],
        ]);

        $this->newsletter->subscribe($email);
    }

    /** @test */
    public function it_throws_an_exception_if_subscribing_someone_fails()

    {
        $email = '[email protected]';

        $url = 'lists/123/members';

        $this->mailChimpApi->shouldReceive('success')->andReturn(false);
        $this->mailChimpApi->shouldReceive('post')->withArgs([
            $url,
            [
                'email_address' => $email,
                'status' => 'subscribed',
                'email_type' => 'html',
            ],
        ])->andReturn('failure');

        try {
            $this->newsletter->subscribe($email);
        } catch (FailedResponse $e) {
            $this->assertEquals('failure', $e->response);
            return;
        }

        $this->fail('Expected FailedResponse exception to be thrown');
    }

    /** @test */
    public function it_can_subscribe_someone_as_pending()

    {
        $email = '[email protected]';

        $url = 'lists/123/members';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('post')->withArgs([
            $url,
            [
                'email_address' => $email,
                'status' => 'pending',
                'email_type' => 'html',
            ],
        ]);

        $this->newsletter->subscribePending($email);
    }

    /** @test */
    public function it_throws_an_exception_if_subscribing_someone_as_pending_fails()

    {
        $email = '[email protected]';

        $url = 'lists/123/members';

        $this->mailChimpApi->shouldReceive('success')->andReturn(false);
        $this->mailChimpApi->shouldReceive('post')->withArgs([
            $url,
            [
                'email_address' => $email,
                'status' => 'pending',
                'email_type' => 'html',
            ],
        ])->andReturn('failure');

        try {
            $this->newsletter->subscribePending($email);
        } catch (FailedResponse $e) {
            $this->assertEquals('failure', $e->response);
            return;
        }

        $this->fail('Expected FailedResponse exception to be thrown');
    }

    /** @test */
    public function it_can_subscribe_or_update_someone()

    {
        $email = '[email protected]';

        $url = 'lists/123/members';

        $subscriberHash = 'abc123';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('subscriberHash')
            ->once()
            ->withArgs([$email])
            ->andReturn($subscriberHash);

        $this->mailChimpApi->shouldReceive('put')->withArgs([
            "{$url}/{$subscriberHash}",
            [
                'email_address' => $email,
                'status' => 'subscribed',
                'email_type' => 'html',
            ],
        ]);

        $this->newsletter->subscribeOrUpdate($email);
    }

    /** @test */
    public function it_throws_an_exception_if_subscribing_or_updating_someone_fails()
    {
        $email = '[email protected]';

        $url = 'lists/123/members';

        $subscriberHash = 'abc123';

        $this->mailChimpApi->shouldReceive('success')->andReturn(false);
        $this->mailChimpApi->shouldReceive('subscriberHash')
            ->once()
            ->withArgs([$email])
            ->andReturn($subscriberHash);

        $this->mailChimpApi->shouldReceive('put')->withArgs([
            "{$url}/{$subscriberHash}",
            [
                'email_address' => $email,
                'status' => 'subscribed',
                'email_type' => 'html',
            ],
        ])->andReturn('failure');

        try {
            $this->newsletter->subscribeOrUpdate($email);
        } catch (FailedResponse $e) {
            $this->assertEquals('failure', $e->response);
            return;
        }

        $this->fail('Expected FailedResponse exception to be thrown');
    }

    /** @test */
    public function it_can_subscribe_someone_with_merge_fields()
    {
        $email = '[email protected]';

        $mergeFields = ['FNAME' => 'Freek'];

        $url = 'lists/123/members';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('post')
            ->once()
            ->withArgs([
                $url,
                [
                    'email_address' => $email,
                    'status' => 'subscribed',
                    'merge_fields' => $mergeFields,
                    'email_type' => 'html',
                ],
            ]);

        $this->newsletter->subscribe($email, $mergeFields);
    }

    /** @test */
    public function it_can_subscribe_or_update_someone_with_merge_fields()
    {
        $email = '[email protected]';

        $mergeFields = ['FNAME' => 'Freek'];

        $url = 'lists/123/members';

        $subscriberHash = 'abc123';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('subscriberHash')
            ->once()
            ->withArgs([$email])
            ->andReturn($subscriberHash);

        $this->mailChimpApi->shouldReceive('put')
            ->once()
            ->withArgs([
                "{$url}/{$subscriberHash}",
                [
                    'email_address' => $email,
                    'status' => 'subscribed',
                    'merge_fields' => $mergeFields,
                    'email_type' => 'html',
                ],
            ]);

        $this->newsletter->subscribeOrUpdate($email, $mergeFields);
    }

    /** @test */
    public function it_can_subscribe_someone_to_an_alternative_list()

    {
        $email = '[email protected]';

        $url = 'lists/456/members';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('post')
            ->once()
            ->withArgs([
                $url,
                [
                    'email_address' => $email,
                    'status' => 'subscribed',
                    'email_type' => 'html',
                ],
            ]);

        $this->newsletter->subscribe($email, [], 'list2');
    }

    /** @test */
    public function it_can_subscribe_or_update_someone_to_an_alternative_list()

    {
        $email = '[email protected]';

        $url = 'lists/456/members';

        $subscriberHash = 'abc123';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('subscriberHash')
            ->once()
            ->withArgs([$email])
            ->andReturn($subscriberHash);

        $this->mailChimpApi->shouldReceive('put')
            ->once()
            ->withArgs([
                "{$url}/{$subscriberHash}",
                [
                    'email_address' => $email,
                    'status' => 'subscribed',
                    'email_type' => 'html',
                ],
            ]);

        $this->newsletter->subscribeOrUpdate($email, [], 'list2');
    }

    /** @test */
    public function it_can_override_the_defaults_when_subscribing_someone()
    {
        $email = '[email protected]';

        $url = 'lists/123/members';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('post')
            ->once()
            ->withArgs([
                $url,
                [
                    'email_address' => $email,
                    'status' => 'pending',
                    'email_type' => 'text',
                ],
            ]);

        $this->newsletter->subscribe($email, [], '', ['email_type' => 'text', 'status' => 'pending']);
    }

    /** @test */
    public function it_can_override_the_defaults_when_subscribing_or_updating_someone()
    {
        $email = '[email protected]';

        $url = 'lists/123/members';

        $subscriberHash = 'abc123';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('subscriberHash')
            ->once()
            ->withArgs([$email])
            ->andReturn($subscriberHash);

        $this->mailChimpApi->shouldReceive('put')
            ->once()
            ->withArgs([
                "{$url}/{$subscriberHash}",
                [
                    'email_address' => $email,
                    'status' => 'pending',
                    'email_type' => 'text',
                ],
            ]);

        $this->newsletter->subscribeOrUpdate($email, [], '', ['email_type' => 'text', 'status' => 'pending']);
    }

    /** @test */
    public function it_can_change_the_email_address_of_a_subscriber()
    {
        $email = '[email protected]';
        $newEmail = '[email protected]';

        $url = 'lists/123/members';

        $subscriberHash = 'abc123';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('subscriberHash')
            ->once()
            ->withArgs([$email])
            ->andReturn($subscriberHash);

        $this->mailChimpApi
            ->shouldReceive('patch')
            ->once()
            ->withArgs([
                "{$url}/{$subscriberHash}",
                [
                    'email_address' => $newEmail,
                ],
            ]);

        $this->newsletter->updateEmailAddress($email, $newEmail);
    }

    /** @test */
    public function it_can_unsubscribe_someone()
    {
        $email = '[email protected]';

        $subscriberHash = 'abc123';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('subscriberHash')
            ->once()
            ->withArgs([$email])
            ->andReturn($subscriberHash);

        $this->mailChimpApi
            ->shouldReceive('patch')
            ->once()
            ->withArgs([
                "lists/123/members/{$subscriberHash}",
                [
                    'status' => 'unsubscribed',
                ],
            ]);

        $this->newsletter->unsubscribe('[email protected]');
    }

    /** @test */
    public function it_throws_an_exception_if_trying_to_unsubscribe_someone_fails()
    {
        $email = '[email protected]';

        $subscriberHash = 'abc123';

        $this->mailChimpApi->shouldReceive('success')->andReturn(false);
        $this->mailChimpApi->shouldReceive('subscriberHash')
            ->once()
            ->withArgs([$email])
            ->andReturn($subscriberHash);

        $this->mailChimpApi
            ->shouldReceive('patch')
            ->once()
            ->withArgs([
                "lists/123/members/{$subscriberHash}",
                [
                    'status' => 'unsubscribed',
                ],
            ])->andReturn('failure');

        try {
            $this->newsletter->unsubscribe('[email protected]');
        } catch (FailedResponse $e) {
            $this->assertEquals('failure', $e->response);
            return;
        }

        $this->fail('Expected FailedResponse exception to be thrown');
    }

    /** @test */
    public function it_can_unsubscribe_someone_from_a_specific_list()
    {
        $email = '[email protected]';

        $subscriberHash = 'abc123';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('subscriberHash')
            ->once()
            ->withArgs([$email])
            ->andReturn($subscriberHash);

        $this->mailChimpApi
            ->shouldReceive('patch')
            ->once()
            ->withArgs([
                "lists/456/members/{$subscriberHash}",
                [
                    'status' => 'unsubscribed',
                ],
            ]);

        $this->newsletter->unsubscribe('[email protected]', 'list2');
    }

    /** @test */
    public function it_can_delete_someone()

    {
        $email = '[email protected]';

        $subscriberHash = 'abc123';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('subscriberHash')
            ->once()
            ->withArgs([$email])
            ->andReturn($subscriberHash);

        $this->mailChimpApi
            ->shouldReceive('delete')
            ->once()
            ->withArgs(["lists/123/members/{$subscriberHash}"]);

        $this->newsletter->delete('[email protected]');
    }

    /** @test */
    public function it_can_delete_someone_from_a_specific_list()

    {
        $email = '[email protected]';

        $subscriberHash = 'abc123';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('subscriberHash')
            ->once()
            ->withArgs([$email])
            ->andReturn($subscriberHash);

        $this->mailChimpApi
            ->shouldReceive('delete')
            ->once()
            ->withArgs(["lists/456/members/{$subscriberHash}"]);

        $this->newsletter->delete('[email protected]', 'list2');
    }

    /** @test */
    public function it_exposes_the_api()
    {
        $api = $this->newsletter->getApi();

        $this->assertSame($this->mailChimpApi, $api);
    }

    /** @test */
    public function it_can_get_the_list_members()
    {
        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi
            ->shouldReceive('get')
            ->once()
            ->withArgs(['lists/123/members', []]);

        $this->newsletter->getMembers();
    }

    /** @test */
    public function it_can_get_the_member()

    {
        $email = '[email protected]';

        $subscriberHash = 'abc123';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('subscriberHash')
            ->once()
            ->withArgs([$email])
            ->andReturn($subscriberHash);

        $this->mailChimpApi
            ->shouldReceive('get')
            ->once()
            ->withArgs(["lists/123/members/{$subscriberHash}"]);

        $this->newsletter->getMember($email);
    }

    /** @test */
    public function it_can_get_the_member_activity()

    {
        $email = '[email protected]';

        $subscriberHash = 'abc123';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('subscriberHash')
            ->once()
            ->withArgs([$email])
            ->andReturn($subscriberHash);

        $this->mailChimpApi
            ->shouldReceive('get')
            ->once()
            ->withArgs(["lists/123/members/{$subscriberHash}/activity"]);

        $this->newsletter->getMemberActivity($email);
    }

    /** @test */
    public function it_can_get_the_member_from_a_specific_list()

    {
        $email = '[email protected]';

        $subscriberHash = 'abc123';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi->shouldReceive('subscriberHash')
            ->once()
            ->withArgs([$email])
            ->andReturn($subscriberHash);

        $this->mailChimpApi
            ->shouldReceive('get')
            ->once()
            ->withArgs(["lists/456/members/{$subscriberHash}"]);

        $this->newsletter->getMember($email, 'list2');
    }

    /** @test */
    public function is_can_create_a_campaign()
    {
        $fromName = 'Spatie';
        $replyTo = '[email protected]';
        $subject = 'This is a subject';
        $html = '<b>This is the content</b>';
        $listName = 'list1';
        $options = ['extraOption' => 'extraValue'];
        $contentOptions = ['plain text' => 'this is the plain text content'];

        $campaignId = 'newCampaignId';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true);
        $this->mailChimpApi
            ->shouldReceive('post')
            ->once()
            ->withArgs(
                [
                    'campaigns',
                    [
                        'type' => 'regular',
                        'recipients' => [
                            'list_id' => 123,
                        ],
                        'settings' => [
                            'subject_line' => $subject,
                            'from_name' => $fromName,
                            'reply_to' => $replyTo,
                        ],
                        'extraOption' => 'extraValue',
                    ],
                ]
            )
            ->andReturn(['id' => $campaignId]);

        $this->mailChimpApi
            ->shouldReceive('put')
            ->once()
            ->withArgs([
                "campaigns/{$campaignId}/content",
                [
                    'html' => $html,
                    'plain text' => 'this is the plain text content',
                ],
            ]);

        $this->newsletter->createCampaign($fromName, $replyTo, $subject, $html, $listName, $options, $contentOptions);
    }

    /** @test */
    public function it_throws_an_exception_if_creating_a_campaign_fails()
    {
        $fromName = 'Spatie';
        $replyTo = '[email protected]';
        $subject = 'This is a subject';
        $html = '<b>This is the content</b>';
        $listName = 'list1';
        $options = ['extraOption' => 'extraValue'];
        $contentOptions = ['plain text' => 'this is the plain text content'];

        $this->mailChimpApi->shouldReceive('success')->andReturn(false);
        $this->mailChimpApi
            ->shouldReceive('post')
            ->once()
            ->withArgs(
                [
                    'campaigns',
                    [
                        'type' => 'regular',
                        'recipients' => [
                            'list_id' => 123,
                        ],
                        'settings' => [
                            'subject_line' => $subject,
                            'from_name' => $fromName,
                            'reply_to' => $replyTo,
                        ],
                        'extraOption' => 'extraValue',
                    ],
                ]
            )
            ->andReturn('failure');

        try {
            $this->newsletter->createCampaign($fromName, $replyTo, $subject, $html, $listName, $options, $contentOptions);
        } catch (FailedResponse $e) {
            $this->assertEquals('failure', $e->response);
            return;
        }

        $this->fail('Expected FailedResponse exception to be thrown');
    }

    /** @test */
    public function it_throws_an_exception_if_updating_a_campaigns_content_fails()
    {
        $fromName = 'Spatie';
        $replyTo = '[email protected]';
        $subject = 'This is a subject';
        $html = '<b>This is the content</b>';
        $listName = 'list1';
        $options = ['extraOption' => 'extraValue'];
        $contentOptions = ['plain text' => 'this is the plain text content'];

        $campaignId = 'newCampaignId';

        $this->mailChimpApi->shouldReceive('success')->andReturn(true, false);
        $this->mailChimpApi
            ->shouldReceive('post')
            ->once()
            ->withArgs(
                [
                    'campaigns',
                    [
                        'type' => 'regular',
                        'recipients' => [
                            'list_id' => 123,
                        ],
                        'settings' => [
                            'subject_line' => $subject,
                            'from_name' => $fromName,
                            'reply_to' => $replyTo,
                        ],
                        'extraOption' => 'extraValue',
                    ],
                ]
            )
            ->andReturn(['id' => $campaignId]);

        $this->mailChimpApi
            ->shouldReceive('put')
            ->once()
            ->withArgs([
                "campaigns/{$campaignId}/content",
                [
                    'html' => $html,
                    'plain text' => 'this is the plain text content',
                ],
            ])->andReturn('failure');

        try {
            $this->newsletter->createCampaign($fromName, $replyTo, $subject, $html, $listName, $options, $contentOptions);
        } catch (FailedResponse $e) {
            $this->assertEquals('failure', $e->response);
            return;
        }

        $this->fail('Expected FailedResponse exception to be thrown');
    }
}

1			<?php
2
3			namespace Spatie\Newsletter\Test;
4
5			use DrewM\MailChimp\MailChimp;
6			use Mockery;
7			use PHPUnit\Framework\TestCase;
8			use Spatie\Newsletter\Exceptions\FailedResponse;
9			use Spatie\Newsletter\Newsletter;
10			use Spatie\Newsletter\NewsletterListCollection;
11
12			class NewsletterTest extends TestCase
13			{
14			/** @var Mockery\Mock */
15			protected $mailChimpApi;
16
17			/** @var \Spatie\Newsletter\Newsletter */
18			protected $newsletter;
19
20			public function setUp()
21			{
22			$this->mailChimpApi = Mockery::mock(MailChimp::class);
23
24			$newsletterLists = NewsletterListCollection::createFromConfig(
25			[
26			'lists' => [
27			'list1' => ['id' => 123],
28			'list2' => ['id' => 456],
29			],
30			'defaultListName' => 'list1',
31			]
32
33			);
34
35			$this->newsletter = new Newsletter($this->mailChimpApi, $newsletterLists);
36			}
37
38			public function tearDown()
39			{
40			parent::tearDown();
spatie / laravel-newsletter

Pull Request — master (#157)

NewsletterTest::setUp() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
