Cavemanon/piratepoet
7
Fork 0
Code Pull Requests Actions Releases 16 Activity

Collect subscriber IPs for 3rd party API subscriptions [MAILPOET-2575]

Browse Source
This commit is contained in:
wxa
2019-12-16 18:04:11 +03:00
committed by Jack Kitterhing
parent 3d465d2546
commit ac9c250b55
2 changed files with 19 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
lib/API/MP/v1/API.php
View File

@ -13,6 +13,7 @@ use MailPoet\Subscribers\NewSubscriberNotificationMailer;
use MailPoet\Subscribers\RequiredCustomFieldValidator; use MailPoet\Subscribers\RequiredCustomFieldValidator;
use MailPoet\Subscribers\Source; use MailPoet\Subscribers\Source;
use MailPoet\Tasks\Sending; use MailPoet\Tasks\Sending;
use MailPoet\Util\Helpers;
use MailPoet\WP\Functions as WPFunctions; use MailPoet\WP\Functions as WPFunctions;
class API { class API {
@ -262,11 +263,15 @@ class API {
); );
} }
if (empty($subscriber['subscribed_ip'])) {
$subscriber['subscribed_ip'] = Helpers::getIP();
}
// separate data into default and custom fields // separate data into default and custom fields
list($default_fields, $custom_fields) = Subscriber::extractCustomFieldsFromFromObject($subscriber); list($default_fields, $custom_fields) = Subscriber::extractCustomFieldsFromFromObject($subscriber);
// filter out all incoming data that we don't want to change, like status, ip address, ... // filter out all incoming data that we don't want to change, like status ...
$default_fields = array_intersect_key($default_fields, array_flip(['email', 'first_name', 'last_name'])); $default_fields = array_intersect_key($default_fields, array_flip(['email', 'first_name', 'last_name', 'subscribed_ip']));
// if some required default fields are missing, set their values // if some required default fields are missing, set their values
$default_fields = Subscriber::setRequiredFieldsDefaultValues($default_fields); $default_fields = Subscriber::setRequiredFieldsDefaultValues($default_fields);

12
tests/integration/API/MP/APITest.php
View File

@ -471,14 +471,26 @@ class APITest extends \MailPoetTest {
'cf_' . $custom_field->id => 'test', 'cf_' . $custom_field->id => 'test',
]; ];
$_SERVER['REMOTE_ADDR'] = '127.0.0.1';
$result = $this->getApi()->addSubscriber($subscriber); $result = $this->getApi()->addSubscriber($subscriber);
expect($result['id'])->greaterThan(0); expect($result['id'])->greaterThan(0);
expect($result['email'])->equals($subscriber['email']); expect($result['email'])->equals($subscriber['email']);
expect($result['cf_' . $custom_field->id])->equals('test'); expect($result['cf_' . $custom_field->id])->equals('test');
expect($result['source'])->equals('api'); expect($result['source'])->equals('api');
expect($result['subscribed_ip'])->equals($_SERVER['REMOTE_ADDR']);
expect(strlen($result['unsubscribe_token']))->equals(15); expect(strlen($result['unsubscribe_token']))->equals(15);
} }
function testItAllowsToOverrideSubscriberIPAddress() {
$subscriber = [
'email' => 'test-ip-2@example.com',
'subscribed_ip' => '1.2.3.4',
];
$result = $this->getApi()->addSubscriber($subscriber);
expect($result['subscribed_ip'])->equals($subscriber['subscribed_ip']);
}
function testItChecksForMandatoryCustomFields() { function testItChecksForMandatoryCustomFields() {
CustomField::createOrUpdate([ CustomField::createOrUpdate([
'name' => 'custom field', 'name' => 'custom field',