Skip to content

Commit d519522

Browse files
alexander-schranzalexander-schranz
authored
Fix update existing contact via sending blue (#348)
* Fix update existing contact via sending blue * Add update of sendin blue contact * Add some test cases
1 parent 7de5d2a commit d519522

File tree

4 files changed

+296
-18
lines changed

4 files changed

+296
-18
lines changed

‎Entity/FormField.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ class FormField
3232
/**
3333
* @var string
3434
*/
35-
private $width;
35+
private $width = 'full';
3636

3737
/**
3838
* @var bool
3939
*/
40-
private $required;
40+
private $required = false;
4141

4242
/**
4343
* @var null|int

‎Event/SendinblueListSubscriber.php

+64-15
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,12 @@
1111

1212
namespace Sulu\Bundle\FormBundle\Event;
1313

14+
use GuzzleHttp\ClientInterface;
1415
use SendinBlue\Client\Api\ContactsApi;
16+
use SendinBlue\Client\ApiException;
1517
use SendinBlue\Client\Configuration;
1618
use SendinBlue\Client\Model\CreateDoiContact;
19+
use SendinBlue\Client\Model\UpdateContact;
1720
use Sulu\Bundle\FormBundle\Entity\Dynamic;
1821
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
1922
use Symfony\Component\HttpFoundation\RequestStack;
@@ -35,8 +38,11 @@ class SendinblueListSubscriber implements EventSubscriberInterface
3538
*/
3639
private $contactsApi;
3740

38-
public function __construct(RequestStack $requestStack, ?string $apiKey)
39-
{
41+
public function __construct(
42+
RequestStack $requestStack,
43+
?string $apiKey,
44+
?ClientInterface $client = null
45+
) {
4046
$this->requestStack = $requestStack;
4147

4248
if (!$apiKey) {
@@ -46,7 +52,7 @@ public function __construct(RequestStack $requestStack, ?string $apiKey)
4652
$config = new Configuration();
4753
$config->setApiKey('api-key', $apiKey);
4854

49-
$this->contactsApi = new ContactsApi(null, $config);
55+
$this->contactsApi = new ContactsApi($client, $config);
5056
}
5157

5258
public static function getSubscribedEvents()
@@ -89,7 +95,9 @@ public function listSubscribe(FormSavePostEvent $event): void
8995
} elseif ('email' === $field['type'] && !$email) {
9096
$email = $field['value'];
9197
} elseif ('sendinblue' == $field['type'] && $field['value']) {
98+
/** @var string|int|null $listId */
9299
$mailTemplateId = $field['options']['mailTemplateId'] ?? null;
100+
/** @var int|null $listId */
93101
$listId = $field['options']['listId'] ?? null;
94102

95103
if (!$mailTemplateId || !$listId) {
@@ -100,21 +108,62 @@ public function listSubscribe(FormSavePostEvent $event): void
100108
}
101109
}
102110

103-
if ($email && \count($listIdsByMailTemplate) > 0) {
104-
foreach ($listIdsByMailTemplate as $mailTemplateId => $listIds) {
105-
$createDoiContact = new CreateDoiContact([
106-
'email' => $email,
107-
'templateId' => $mailTemplateId,
108-
'includeListIds' => $listIds,
109-
'redirectionUrl' => $redirectionUrl,
110-
'attributes' => [
111+
/** @var string $email */
112+
if (!$email || 0 === \count($listIdsByMailTemplate)) {
113+
return;
114+
}
115+
116+
$contact = null;
117+
try {
118+
$contact = $this->contactsApi->getContactInfo($email);
119+
} catch (ApiException $e) {
120+
if (404 !== $e->getCode()) {
121+
throw $e;
122+
}
123+
// Contact does not exist, ignore the exception
124+
}
125+
126+
if (null !== $contact) {
127+
$updateContact = new UpdateContact();
128+
129+
$updateContact->setAttributes(
130+
(object) \array_replace(
131+
(array) $contact->getAttributes(),
132+
[
111133
'FIRST_NAME' => $firstName,
112-
'LAST_NAME' => $firstName,
113-
],
114-
]);
134+
'LAST_NAME' => $lastName,
135+
]
136+
)
137+
);
115138

116-
$this->contactsApi->createDoiContact($createDoiContact);
139+
/** @var int[] $collectedListIds */
140+
$collectedListIds = $contact->getListIds();
141+
foreach ($listIdsByMailTemplate as $mailTemplateId => $listIds) {
142+
$collectedListIds = \array_merge($collectedListIds, $listIds);
117143
}
144+
145+
$collectedListIds = \array_unique($collectedListIds);
146+
147+
$updateContact->setListIds($collectedListIds);
148+
149+
$this->contactsApi->updateContact($email, $updateContact);
150+
151+
return;
152+
}
153+
154+
foreach ($listIdsByMailTemplate as $mailTemplateId => $listIds) {
155+
$createDoiContact = new CreateDoiContact([
156+
'email' => $email,
157+
'templateId' => $mailTemplateId,
158+
'includeListIds' => $listIds,
159+
'redirectionUrl' => $redirectionUrl,
160+
'attributes' => [
161+
'FIRST_NAME' => $firstName,
162+
'LAST_NAME' => $lastName,
163+
],
164+
]);
165+
166+
$this->contactsApi->createDoiContact($createDoiContact);
118167
}
119168
}
120169
}

‎Tests/Unit/Event/SendinblueListSubscriberTest.php

+228
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,228 @@
1+
<?php
2+
3+
/*
4+
* This file is part of Sulu.
5+
*
6+
* (c) Sulu GmbH
7+
*
8+
* This source file is subject to the MIT license that is bundled
9+
* with this source code in the file LICENSE.
10+
*/
11+
12+
namespace Sulu\Bundle\FormBundle\Tests\Unit\Event;
13+
14+
use GuzzleHttp\ClientInterface;
15+
use GuzzleHttp\Psr7\Response;
16+
use PHPUnit\Framework\TestCase;
17+
use Prophecy\Argument;
18+
use Prophecy\Prophecy\ObjectProphecy;
19+
use Psr\Http\Message\RequestInterface;
20+
use SendinBlue\Client\ApiException;
21+
use Sulu\Bundle\FormBundle\Configuration\FormConfiguration;
22+
use Sulu\Bundle\FormBundle\Entity\Dynamic;
23+
use Sulu\Bundle\FormBundle\Entity\Form;
24+
use Sulu\Bundle\FormBundle\Entity\FormField;
25+
use Sulu\Bundle\FormBundle\Entity\FormTranslation;
26+
use Sulu\Bundle\FormBundle\Event\FormSavePostEvent;
27+
use Sulu\Bundle\FormBundle\Event\SendinblueListSubscriber;
28+
use Symfony\Component\Form\FormInterface;
29+
use Symfony\Component\HttpFoundation\Request;
30+
use Symfony\Component\HttpFoundation\RequestStack;
31+
32+
class SendinblueListSubscriberTest extends TestCase
33+
{
34+
/**
35+
* @var RequestStack
36+
*/
37+
private $requestStack;
38+
39+
/**
40+
* @var ObjectProphecy<ClientInterface>
41+
*/
42+
private $client;
43+
44+
/**
45+
* @var SendinblueListSubscriber
46+
*/
47+
private $sendinblueListSubscriber;
48+
49+
public function setUp(): void
50+
{
51+
$this->requestStack = new RequestStack();
52+
$this->client = $this->prophesize(ClientInterface::class);
53+
54+
$this->sendinblueListSubscriber = new SendinblueListSubscriber(
55+
$this->requestStack,
56+
'SOME_KEY',
57+
$this->client->reveal()
58+
);
59+
}
60+
61+
public function testGetSubscribedEvents(): void
62+
{
63+
$this->assertSame(
64+
[
65+
'sulu_form.handler.saved' => 'listSubscribe',
66+
],
67+
SendinblueListSubscriber::getSubscribedEvents()
68+
);
69+
}
70+
71+
public function testlistSubscribeNotExist(): void
72+
{
73+
$this->requestStack->push(Request::create('http://localhost/', 'POST'));
74+
$event = $this->createFormSavePostEvent();
75+
76+
$self = $this;
77+
$this->client->send(Argument::cetera())->will(function($args) use ($self) {
78+
/** @var RequestInterface $request */
79+
$request = $args[0];
80+
81+
if ('https://api.sendinblue.com/v3/contacts/john.doe%40example.org' === $request->getUri()->__toString()) {
82+
$self->assertSame('GET', $request->getMethod());
83+
84+
throw new ApiException('', 404);
85+
}
86+
87+
if ('https://api.sendinblue.com/v3/contacts/doubleOptinConfirmation' === $request->getUri()->__toString()) {
88+
$self->assertSame('POST', $request->getMethod());
89+
90+
$json = \json_decode($request->getBody()->getContents(), true);
91+
92+
$self->assertSame([
93+
'email' => '[email protected]',
94+
'attributes' => [
95+
'FIRST_NAME' => 'John',
96+
'LAST_NAME' => 'Doe',
97+
],
98+
'includeListIds' => ['789'],
99+
'templateId' => 456,
100+
'redirectionUrl' => 'http://localhost?subscribe=true',
101+
], $json);
102+
103+
return new Response();
104+
}
105+
106+
throw new \RuntimeException('Unexpected request: ' . $request->getUri()->__toString());
107+
})
108+
->shouldBeCalledTimes(2);
109+
110+
// act
111+
$this->sendinblueListSubscriber->listSubscribe($event);
112+
113+
$this->assertTrue(true);
114+
}
115+
116+
public function testlistSubscribeAlreadyExist(): void
117+
{
118+
$this->requestStack->push(Request::create('http://localhost/', 'POST'));
119+
$event = $this->createFormSavePostEvent();
120+
121+
$self = $this;
122+
$this->client->send(Argument::cetera())->will(function($args) use ($self) {
123+
/** @var RequestInterface $request */
124+
$request = $args[0];
125+
126+
if ('https://api.sendinblue.com/v3/contacts/john.doe%40example.org' === $request->getUri()->__toString()
127+
&& 'GET' === $request->getMethod()
128+
) {
129+
return new Response(200, ['Content-Type' => 'application/json'], \json_encode([
130+
'id' => 123,
131+
'email' => '[email protected]',
132+
'attributes' => [],
133+
'listIds' => [],
134+
]));
135+
}
136+
137+
if ('https://api.sendinblue.com/v3/contacts/john.doe%40example.org' === $request->getUri()->__toString()
138+
&& 'PUT' === $request->getMethod()
139+
) {
140+
$json = \json_decode($request->getBody()->getContents(), true);
141+
142+
$self->assertSame([
143+
'attributes' => [
144+
'FIRST_NAME' => 'John',
145+
'LAST_NAME' => 'Doe',
146+
],
147+
'listIds' => ['789'],
148+
], $json);
149+
150+
return new Response();
151+
}
152+
153+
throw new \RuntimeException('Unexpected request (' . $request->getMethod() . '): ' . $request->getUri()->__toString());
154+
})
155+
->shouldBeCalledTimes(2);
156+
157+
// act
158+
$this->sendinblueListSubscriber->listSubscribe($event);
159+
160+
$this->assertTrue(true);
161+
}
162+
163+
private function createFormSavePostEvent(): FormSavePostEvent
164+
{
165+
$symfonyForm = $this->prophesize(FormInterface::class);
166+
$formConfiguration = new FormConfiguration('en');
167+
$form = new Form();
168+
$form->setDefaultLocale('en');
169+
$formTranslation = new FormTranslation();
170+
$formTranslation->setLocale('en');
171+
$formTranslation->setTitle('Form');
172+
$form->addTranslation($formTranslation);
173+
174+
$fields = [
175+
[
176+
'type' => 'firstName',
177+
'required' => true,
178+
],
179+
[
180+
'type' => 'lastName',
181+
'required' => true,
182+
],
183+
[
184+
'type' => 'email',
185+
'required' => true,
186+
],
187+
[
188+
'type' => 'sendinblue',
189+
'options' => [
190+
'mailTemplateId' => '456',
191+
'listId' => '789',
192+
],
193+
],
194+
];
195+
196+
foreach ($fields as $key => $field) {
197+
$formField = new FormField();
198+
$formField->setForm($form);
199+
$formField->setDefaultLocale('en');
200+
$formField->setType($field['type']);
201+
$formField->setOrder($key);
202+
$formField->setKey($field['type']);
203+
204+
$formFieldTranslation = $formField->getTranslation('en', true);
205+
$formFieldTranslation->setTitle(\ucfirst($field['type']));
206+
$formFieldTranslation->setOptions($field['options'] ?? []);
207+
208+
$form->addField($formField);
209+
}
210+
211+
$dynamic = new Dynamic(
212+
'page',
213+
'123',
214+
'en',
215+
$form,
216+
[
217+
'firstName' => 'John',
218+
'lastName' => 'Doe',
219+
'email' => '[email protected]',
220+
'sendinblue' => true,
221+
]
222+
);
223+
224+
$symfonyForm->getData()->willReturn($dynamic);
225+
226+
return new FormSavePostEvent($symfonyForm->reveal(), $formConfiguration);
227+
}
228+
}

‎composer.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,8 @@
130130
},
131131
"sort-packages": true,
132132
"allow-plugins": {
133-
"composer/package-versions-deprecated": true
133+
"composer/package-versions-deprecated": true,
134+
"php-http/discovery": true
134135
}
135136
}
136137
}

0 commit comments

Comments
 (0)