Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v4 API: Tests: Get Tag Subscriptions #53

Merged
merged 4 commits into from
Apr 23, 2024
Merged

v4 API: Tests: Get Tag Subscriptions #53

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fc659aa
Added tests
n7studios Apr 22, 2024
7275414
Merge remote-tracking branch 'origin/v4-api' into v4-api-tests-tags-g…
n7studios Apr 22, 2024
5a39322
Merge remote-tracking branch 'origin/v4-api-tags' into v4-api-tests-t…
n7studios Apr 23, 2024
4a62119
Coding standards
n7studios Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
287 changes: 287 additions & 0 deletions tests/wpunit/APITest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1970,6 +1970,293 @@ public function testRemoveTagFromSubscriberByEmailWithInvalidEmailAddress()
$this->assertEquals($result->get_error_code(), $this->errorCode);
}

/**
* Test that get_tag_subscriptions() returns the expected data
* when a valid Tag ID is specified.
*
* @since 1.0.0
*
* @return void
*/
public function testGetTagSubscriptions()
{
$result = $this->api->get_tag_subscriptions( (int) $_ENV['CONVERTKIT_API_TAG_ID']);

// Assert subscribers and pagination exist.
$this->assertDataExists($result, 'subscribers');
$this->assertPaginationExists($result);
}

/**
* Test that get_tag_subscriptions() returns the expected data
* when the total count is included.
*
* @since 2.0.0
*
* @return void
*/
public function testGetTagSubscriptionsWithTotalCount()
{
$result = $this->api->get_tag_subscriptions(
(int) $_ENV['CONVERTKIT_API_TAG_ID'], // Tag ID.
'active', // Subscriber state.
null, // Created after.
null, // Created before.
null, // Tagged after.
null, // Tagged before.
true // Include total count.
);

// Assert subscribers and pagination exist.
$this->assertDataExists($result, 'subscribers');
$this->assertPaginationExists($result);

// Assert total count is included.
$this->assertArrayHasKey('total_count', $result['pagination']);
$this->assertGreaterThan(0, $result['pagination']['total_count']);
}

/**
* Test that get_tag_subscriptions() returns the expected data
* when a valid Tag ID is specified and the subscription status
* is bounced.
*
* @since 1.0.0
*
* @return void
*/
public function testGetTagSubscriptionsWithBouncedSubscriberState()
{
$result = $this->api->get_tag_subscriptions(
(int) $_ENV['CONVERTKIT_API_TAG_ID'], // Tag ID.
'bounced' // Subscriber state.
);

// Assert subscribers and pagination exist.
$this->assertDataExists($result, 'subscribers');
$this->assertPaginationExists($result);

// Check the correct subscribers were returned.
$this->assertEquals($result['subscribers'][0]['state'], 'bounced');
}


/**
* Test that get_tag_subscriptions() returns the expected data
* when a valid Tag ID is specified and the added_after parameter
* is used.
*
* @since 2.0.0
*
* @return void
*/
public function testGetTagSubscriptionsWithTaggedAfterParam()
{
$date = new \DateTime('2024-01-01');
$result = $this->api->get_tag_subscriptions(
(int) $_ENV['CONVERTKIT_API_TAG_ID'], // Tag ID.
'active', // Subscriber state.
null, // Created after.
null, // Created before.
$date // Tagged after.
);

// Assert subscribers and pagination exist.
$this->assertDataExists($result, 'subscribers');
$this->assertPaginationExists($result);

// Check the correct subscribers were returned.
$this->assertGreaterThanOrEqual(
$date->format('Y-m-d'),
date('Y-m-d', strtotime($result['subscribers'][0]['tagged_at']))
);
}

/**
* Test that get_tag_subscriptions() returns the expected data
* when a valid Tag ID is specified and the tagged_before parameter
* is used.
*
* @since 2.0.0
*
* @return void
*/
public function testGetTagSubscriptionsWithTaggedBeforeParam()
{
$date = new \DateTime('2024-01-01');
$result = $this->api->get_tag_subscriptions(
(int) $_ENV['CONVERTKIT_API_TAG_ID'], // Tag ID.
'active', // Subscriber state.
null, // Created after.
null, // Created before.
null, // Tagged after.
$date // Tagged before.
);

// Assert subscribers and pagination exist.
$this->assertDataExists($result, 'subscribers');
$this->assertPaginationExists($result);

// Check the correct subscribers were returned.
$this->assertLessThanOrEqual(
$date->format('Y-m-d'),
date('Y-m-d', strtotime($result['subscribers'][0]['tagged_at']))
);
}

/**
* Test that get_tag_subscriptions() returns the expected data
* when a valid Tag ID is specified and the created_after parameter
* is used.
*
* @since 2.0.0
*
* @return void
*/
public function testGetTagSubscriptionsWithCreatedAfterParam()
{
$date = new \DateTime('2024-01-01');
$result = $this->api->get_tag_subscriptions(
(int) $_ENV['CONVERTKIT_API_TAG_ID'], // Tag ID.
'active', // Subscriber state.
$date // Created after.
);

// Assert subscribers and pagination exist.
$this->assertDataExists($result, 'subscribers');
$this->assertPaginationExists($result);

// Check the correct subscribers were returned.
$this->assertGreaterThanOrEqual(
$date->format('Y-m-d'),
date('Y-m-d', strtotime($result['subscribers'][0]['created_at']))
);
}

/**
* Test that get_tag_subscriptions() returns the expected data
* when a valid Tag ID is specified and the created_before parameter
* is used.
*
* @since 2.0.0
*
* @return void
*/
public function testGetTagSubscriptionsWithCreatedBeforeParam()
{
$date = new \DateTime('2024-01-01');
$result = $this->api->get_tag_subscriptions(
(int) $_ENV['CONVERTKIT_API_TAG_ID'], // Tag ID.
'active', // Subscriber state.
null, // Created after.
$date // Created before.
);

// Assert subscribers and pagination exist.
$this->assertDataExists($result, 'subscribers');
$this->assertPaginationExists($result);

// Check the correct subscribers were returned.
$this->assertLessThanOrEqual(
$date->format('Y-m-d'),
date('Y-m-d', strtotime($result['subscribers'][0]['created_at']))
);
}

/**
* Test that get_tag_subscriptions() returns the expected data
* when a valid Tag ID is specified and pagination parameters
* and per_page limits are specified.
*
* @since 1.0.0
*
* @return void
*/
public function testGetTagSubscriptionsPagination()
{
$result = $this->api->get_tag_subscriptions(
(int) $_ENV['CONVERTKIT_API_TAG_ID'], // Tag ID.
'active', // Subscriber state.
null, // Created after.
null, // Created before.
null, // Tagged after.
null, // Tagged before.
false, // Include total count.
'', // After cursor.
'', // Before cursor.
1 // Per page.
);

// Assert subscribers and pagination exist.
$this->assertDataExists($result, 'subscribers');
$this->assertPaginationExists($result);

// Assert a single subscriber was returned.
$this->assertCount(1, $result['subscribers']);

// Assert has_previous_page and has_next_page are correct.
$this->assertFalse($result['pagination']['has_previous_page']);
$this->assertTrue($result['pagination']['has_next_page']);

// Use pagination to fetch next page.
$result = $this->api->get_tag_subscriptions(
(int) $_ENV['CONVERTKIT_API_TAG_ID'], // Tag ID.
'active', // Subscriber state.
null, // Created after.
null, // Created before.
null, // Tagged after.
null, // Tagged before.
false, // Include total count.
$result['pagination']['end_cursor'], // After cursor.
'', // Before cursor.
1 // Per page.
);

// Assert subscribers and pagination exist.
$this->assertDataExists($result, 'subscribers');
$this->assertPaginationExists($result);

// Assert a single subscriber was returned.
$this->assertCount(1, $result['subscribers']);

// Assert has_previous_page and has_next_page are correct.
$this->assertTrue($result['pagination']['has_previous_page']);
$this->assertTrue($result['pagination']['has_next_page']);

// Use pagination to fetch previous page.
$result = $this->api->get_tag_subscriptions(
(int) $_ENV['CONVERTKIT_API_TAG_ID'], // Tag ID.
'active', // Subscriber state.
null, // Created after.
null, // Created before.
null, // Tagged after.
null, // Tagged before.
false, // Include total count.
'', // After cursor.
$result['pagination']['start_cursor'], // Before cursor.
1 // Per page.
);

// Assert subscribers and pagination exist.
$this->assertDataExists($result, 'subscribers');
$this->assertPaginationExists($result);
}

/**
* Test that get_tag_subscriptions() returns a WP_Error when
* an invalid Tag ID is specified.
*
* @since 1.0.0
*
* @return void
*/
public function testGetTagSubscriptionsWithInvalidTagID()
{
$result = $this->api->get_tag_subscriptions(12345);
$this->assertInstanceOf(WP_Error::class, $result);
$this->assertEquals($result->get_error_code(), $this->errorCode);
}

/**
* Test that get_subscribers() returns the expected data.
*
Expand Down
Loading