Compare commits

..

2 Commits

Author SHA1 Message Date
gitea-actions[bot] 6817ac54af chore(version): auto-bump patch 01.08.11-dev [skip ci] 2026-06-27 19:51:38 +00:00
Jonathan Miller 374d3f001a feat(#159): add link shortening support (Bitly, Rebrandly, YOURLS) with {url_short} placeholder
Universal: Auto Version Bump / Version Bump (push) Successful in 8s
Authored-by: Moko Consulting
2026-06-27 14:50:44 -05:00
10 changed files with 228 additions and 378 deletions
+1 -15
View File
@@ -15,23 +15,9 @@
"php": ">=8.1"
},
"require-dev": {
"phpunit/phpunit": "^10.5",
"squizlabs/php_codesniffer": "^3.7",
"phpstan/phpstan": "^1.10",
"joomla/coding-standards": "dev-3.x-dev"
},
"autoload": {
"psr-4": {
"Joomla\\Component\\MokoSuiteCross\\Administrator\\": "source/packages/com_mokosuitecross/src/",
"Joomla\\Component\\MokoSuiteCross\\Site\\": "source/packages/com_mokosuitecross/site/src/",
"Joomla\\Plugin\\Content\\MokoSuiteCross\\": "source/packages/plg_content_mokosuitecross/src/",
"Joomla\\Plugin\\System\\MokoSuiteCross\\": "source/packages/plg_system_mokosuitecross/src/"
}
},
"autoload-dev": {
"psr-4": {
"MokoSuiteCross\\Tests\\": "tests/"
}
"joomla/coding-standards": "^4.0"
},
"config": {
"sort-packages": true
-22
View File
@@ -1,22 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
bootstrap="tests/bootstrap.php"
colors="true"
cacheDirectory=".phpunit.cache"
executionOrder="depends,defects"
failOnRisky="true"
failOnWarning="true">
<testsuites>
<testsuite name="Unit">
<directory>tests/Unit</directory>
</testsuite>
</testsuites>
<source>
<include>
<directory>source/packages/com_mokosuitecross/src</directory>
<directory>source/packages/plg_content_mokosuitecross/src</directory>
<directory>source/packages/plg_system_mokosuitecross/src</directory>
</include>
</source>
</phpunit>
@@ -120,6 +120,42 @@
/>
</fieldset>
<fieldset name="link_shortening" label="COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENING">
<field
name="link_shortener"
type="list"
label="COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER"
description="COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_DESC"
default="none">
<option value="none">COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_NONE</option>
<option value="bitly">COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_BITLY</option>
<option value="rebrandly">COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_REBRANDLY</option>
<option value="yourls">COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_YOURLS</option>
</field>
<field
name="link_shortener_api_key"
type="text"
label="COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_API_KEY"
description="COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_API_KEY_DESC"
showon="link_shortener:bitly,rebrandly"
/>
<field
name="link_shortener_yourls_url"
type="url"
label="COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_YOURLS_URL"
description="COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_YOURLS_URL_DESC"
hint="https://short.example.com/yourls-api.php"
showon="link_shortener:yourls"
/>
<field
name="link_shortener_yourls_token"
type="text"
label="COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_YOURLS_TOKEN"
description="COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_YOURLS_TOKEN_DESC"
showon="link_shortener:yourls"
/>
</fieldset>
<fieldset name="evergreen" label="COM_MOKOSUITECROSS_CONFIG_EVERGREEN">
<field
name="evergreen_enabled"
@@ -534,6 +534,21 @@ COM_MOKOSUITECROSS_DISPATCH_INVALID_SERVICES="service_ids must be a non-empty ar
COM_MOKOSUITECROSS_DISPATCH_ARTICLE_NOT_FOUND="Article not found."
COM_MOKOSUITECROSS_DISPATCH_NO_SERVICES="No enabled services found matching the request."
; Link Shortening
COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENING="Link Shortening"
COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER="Link Shortener"
COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_DESC="Select a link shortening service. Shortened URLs are available via the {url_short} placeholder in templates."
COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_NONE="None (disabled)"
COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_BITLY="Bitly"
COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_REBRANDLY="Rebrandly"
COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_YOURLS="YOURLS (self-hosted)"
COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_API_KEY="API Key"
COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_API_KEY_DESC="API key for Bitly or Rebrandly."
COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_YOURLS_URL="YOURLS API URL"
COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_YOURLS_URL_DESC="Full URL to your YOURLS API endpoint (e.g. https://short.example.com/yourls-api.php)."
COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_YOURLS_TOKEN="YOURLS Signature Token"
COM_MOKOSUITECROSS_CONFIG_LINK_SHORTENER_YOURLS_TOKEN_DESC="Secret signature token from your YOURLS installation."
; Category Rules
COM_MOKOSUITECROSS_CONFIG_CATEGORY_RULES="Category Rules"
COM_MOKOSUITECROSS_CONFIG_CATEGORY_RULES_NOTE="Category Routing"
@@ -477,12 +477,16 @@ class CrossPostDispatcher
$url = $url . $separator . http_build_query($utmParams);
}
// Link shortening (#159) — shorten the final URL (with UTM if enabled)
$urlShort = LinkShortenerHelper::shorten($url);
return [
'{title}' => $titleText,
'{introtext}' => $introStripped,
'{fulltext}' => strip_tags(mb_substr($article->fulltext ?? '', 0, 500)),
'{url}' => $url,
'{url_raw}' => $urlRaw,
'{url_short}' => $urlShort,
'{image}' => $introImage,
'{category}' => $categoryName,
'{author}' => $authorName,
@@ -0,0 +1,172 @@
<?php
/**
* @package MokoSuiteCross
* @subpackage com_mokosuitecross
* @author Moko Consulting <hello@mokoconsulting.tech>
* @copyright Copyright (C) 2026 Moko Consulting. All rights reserved.
* @license GNU General Public License version 3 or later; see LICENSE
* SPDX-License-Identifier: GPL-3.0-or-later
*/
namespace Joomla\Component\MokoSuiteCross\Administrator\Helper;
defined('_JEXEC') or die;
use Joomla\CMS\Component\ComponentHelper;
/**
* Shortens URLs via Bitly, Rebrandly, or YOURLS.
*
* Returns the original URL on any failure so cross-posts are never broken.
*/
class LinkShortenerHelper
{
/**
* Shorten a URL using the configured provider.
*
* @param string $url The URL to shorten
*
* @return string Shortened URL, or the original on failure/disabled
*/
public static function shorten(string $url): string
{
$params = ComponentHelper::getParams('com_mokosuitecross');
$provider = $params->get('link_shortener', 'none');
if ($provider === 'none' || empty($url)) {
return $url;
}
$apiKey = $params->get('link_shortener_api_key', '');
switch ($provider) {
case 'bitly':
return self::shortenWithBitly($url, $apiKey);
case 'rebrandly':
return self::shortenWithRebrandly($url, $apiKey);
case 'yourls':
$apiUrl = $params->get('link_shortener_yourls_url', '');
$token = $params->get('link_shortener_yourls_token', '');
return self::shortenWithYourls($url, $apiUrl, $token);
default:
return $url;
}
}
/**
* Shorten via Bitly API v4.
*/
public static function shortenWithBitly(string $url, string $apiKey): string
{
if (empty($apiKey)) {
return $url;
}
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => 'https://api-ssl.bitly.com/v4/shorten',
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => json_encode(['long_url' => $url]),
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $apiKey,
'Content-Type: application/json',
],
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 10,
]);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($response === false || $httpCode < 200 || $httpCode >= 300) {
return $url;
}
$data = json_decode($response, true);
return $data['link'] ?? $url;
}
/**
* Shorten via Rebrandly API.
*/
public static function shortenWithRebrandly(string $url, string $apiKey, string $workspace = ''): string
{
if (empty($apiKey)) {
return $url;
}
$headers = [
'apikey: ' . $apiKey,
'Content-Type: application/json',
];
if (!empty($workspace)) {
$headers[] = 'workspace: ' . $workspace;
}
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => 'https://api.rebrandly.com/v1/links',
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => json_encode(['destination' => $url]),
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 10,
]);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($response === false || $httpCode < 200 || $httpCode >= 300) {
return $url;
}
$data = json_decode($response, true);
$short = $data['shortUrl'] ?? '';
return !empty($short) ? 'https://' . ltrim($short, 'https://') : $url;
}
/**
* Shorten via YOURLS API (self-hosted).
*/
public static function shortenWithYourls(string $url, string $apiUrl, string $signatureToken): string
{
if (empty($apiUrl) || empty($signatureToken)) {
return $url;
}
$endpoint = rtrim($apiUrl, '/') . '?' . http_build_query([
'action' => 'shorturl',
'format' => 'json',
'signature' => $signatureToken,
'url' => $url,
]);
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => $endpoint,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 10,
]);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($response === false || $httpCode < 200 || $httpCode >= 300) {
return $url;
}
$data = json_decode($response, true);
return $data['shorturl'] ?? $url;
}
}
-128
View File
@@ -1,128 +0,0 @@
<?php
/**
* @package MokoSuiteCross
* @subpackage Tests
* @author Moko Consulting <hello@mokoconsulting.tech>
* @copyright Copyright (C) 2026 Moko Consulting. All rights reserved.
* @license GNU General Public License version 3 or later; see LICENSE
* SPDX-License-Identifier: GPL-3.0-or-later
*/
namespace MokoSuiteCross\Tests\Unit\Helper;
use Joomla\Component\MokoSuiteCross\Administrator\Helper\PreviewHelper;
use PHPUnit\Framework\Attributes\RequiresMethod;
use PHPUnit\Framework\TestCase;
#[RequiresMethod(PreviewHelper::class, 'render')]
class PreviewHelperTest extends TestCase
{
public function testRenderTwitterContainsCharCount(): void
{
$html = PreviewHelper::render('twitter', 'Test Title', 'Hello world', 'https://example.com', '', 'Author');
$this->assertStringContainsString('11/280', $html);
}
public function testRenderTwitterEscapesHtml(): void
{
$html = PreviewHelper::render('twitter', '<script>alert(1)</script>', 'text', 'https://example.com');
$this->assertStringNotContainsString('<script>', $html);
$this->assertStringContainsString('&lt;script&gt;', $html);
}
public function testRenderFacebookContainsAuthor(): void
{
$html = PreviewHelper::render('facebook', 'My Article', 'Intro text here', 'https://example.com', '', 'John Doe');
$this->assertStringContainsString('John Doe', $html);
$this->assertStringContainsString('My Article', $html);
}
public function testRenderMastodonContainsCharCount(): void
{
$html = PreviewHelper::render('mastodon', 'Title', 'Post text', 'https://example.com', '', 'Author');
$this->assertStringContainsString('9/500', $html);
}
public function testRenderBlueskyContainsCharCount(): void
{
$html = PreviewHelper::render('bluesky', 'Title', 'A bluesky post', 'https://example.com', '', 'Author');
$this->assertStringContainsString('14/300', $html);
}
public function testRenderLinkedInContainsAuthor(): void
{
$html = PreviewHelper::render('linkedin', 'Article', 'Text', 'https://example.com', '', 'Jane Smith');
$this->assertStringContainsString('Jane Smith', $html);
}
public function testRenderTelegramDoesNotShowAuthor(): void
{
$html = PreviewHelper::render('telegram', 'Article', 'Message text', 'https://example.com');
$this->assertStringContainsString('Message text', $html);
$this->assertStringContainsString('Article', $html);
}
public function testRenderWithImageIncludesImgTag(): void
{
$html = PreviewHelper::render('twitter', 'Title', 'Text', 'https://example.com', 'https://example.com/image.jpg', 'Author');
$this->assertStringContainsString('<img src="https://example.com/image.jpg"', $html);
}
public function testRenderWithoutImageOmitsImgTag(): void
{
$html = PreviewHelper::render('twitter', 'Title', 'Text', 'https://example.com', '', 'Author');
$this->assertStringNotContainsString('<img', $html);
}
public function testRenderGenericPlatform(): void
{
$html = PreviewHelper::render('pinterest', 'Title', 'Text', 'https://example.com');
$this->assertStringContainsString('PINTEREST', $html);
$this->assertStringContainsString('Title', $html);
}
public function testGetSupportedPlatformsReturnsSix(): void
{
$platforms = PreviewHelper::getSupportedPlatforms();
$this->assertCount(6, $platforms);
$this->assertContains('twitter', $platforms);
$this->assertContains('facebook', $platforms);
$this->assertContains('mastodon', $platforms);
$this->assertContains('linkedin', $platforms);
$this->assertContains('bluesky', $platforms);
$this->assertContains('telegram', $platforms);
}
public function testRenderUsesTextWhenProvided(): void
{
$html = PreviewHelper::render('facebook', 'My Title', 'Custom intro text', 'https://example.com');
$this->assertStringContainsString('Custom intro text', $html);
}
public function testRenderFallsBackToTitleWhenTextEmpty(): void
{
$html = PreviewHelper::render('facebook', 'Fallback Title', '', 'https://example.com');
$this->assertMatchesRegularExpression('/Fallback Title.*Fallback Title/s', $html);
}
public function testImageUrlIsEscaped(): void
{
$html = PreviewHelper::render('twitter', 'Title', 'Text', 'https://example.com', 'https://example.com/img?a=1&b=2', 'Author');
$this->assertStringContainsString('https://example.com/img?a=1&amp;b=2', $html);
}
}
@@ -1,69 +0,0 @@
<?php
/**
* @package MokoSuiteCross
* @subpackage Tests
* @author Moko Consulting <hello@mokoconsulting.tech>
* @copyright Copyright (C) 2026 Moko Consulting. All rights reserved.
* @license GNU General Public License version 3 or later; see LICENSE
* SPDX-License-Identifier: GPL-3.0-or-later
*/
namespace MokoSuiteCross\Tests\Unit\Helper;
use Joomla\Component\MokoSuiteCross\Administrator\Helper\ServiceIconHelper;
use PHPUnit\Framework\TestCase;
class ServiceIconHelperTest extends TestCase
{
/**
* @dataProvider knownServiceTypesProvider
*/
public function testGetIconReturnsKnownIcon(string $serviceType, string $expectedIcon): void
{
$this->assertSame($expectedIcon, ServiceIconHelper::getIcon($serviceType));
}
public static function knownServiceTypesProvider(): array
{
return [
'facebook' => ['facebook', 'icon-facebook'],
'twitter' => ['twitter', 'icon-twitter'],
'linkedin' => ['linkedin', 'icon-linkedin'],
'mastodon' => ['mastodon', 'icon-globe'],
'bluesky' => ['bluesky', 'icon-cloud'],
'telegram' => ['telegram', 'icon-paper-plane'],
'discord' => ['discord', 'icon-headset'],
'slack' => ['slack', 'icon-hashtag'],
'mailchimp' => ['mailchimp', 'icon-envelope'],
'medium' => ['medium', 'icon-book'],
];
}
public function testGetIconReturnsFallbackForUnknownType(): void
{
$this->assertSame('icon-share-alt', ServiceIconHelper::getIcon('unknown_platform'));
}
public function testRenderIconOutputsSpanElement(): void
{
$html = ServiceIconHelper::renderIcon('facebook');
$this->assertSame('<span class="icon-facebook" aria-hidden="true"></span>', $html);
}
public function testRenderIconWithExtraClass(): void
{
$html = ServiceIconHelper::renderIcon('twitter', 'me-1 text-info');
$this->assertSame('<span class="icon-twitter me-1 text-info" aria-hidden="true"></span>', $html);
}
public function testRenderIconEscapesExtraClass(): void
{
$html = ServiceIconHelper::renderIcon('facebook', '"><script>');
$this->assertStringNotContainsString('<script>', $html);
$this->assertStringContainsString('&quot;&gt;&lt;script&gt;', $html);
}
}
@@ -1,128 +0,0 @@
<?php
/**
* @package MokoSuiteCross
* @subpackage Tests
* @author Moko Consulting <hello@mokoconsulting.tech>
* @copyright Copyright (C) 2026 Moko Consulting. All rights reserved.
* @license GNU General Public License version 3 or later; see LICENSE
* SPDX-License-Identifier: GPL-3.0-or-later
*/
namespace MokoSuiteCross\Tests\Unit\Service;
use Joomla\Component\MokoSuiteCross\Administrator\Service\MokoSuiteCrossServiceInterface;
use PHPUnit\Framework\TestCase;
class ServiceInterfaceContractTest extends TestCase
{
public function testInterfaceExists(): void
{
$this->assertTrue(interface_exists(MokoSuiteCrossServiceInterface::class));
}
public function testInterfaceDefinesRequiredMethods(): void
{
$reflection = new \ReflectionClass(MokoSuiteCrossServiceInterface::class);
$expectedMethods = [
'getServiceType',
'getServiceName',
'publish',
'validateCredentials',
'getMaxLength',
'supportsMedia',
'getSupportedMediaTypes',
];
foreach ($expectedMethods as $method) {
$this->assertTrue(
$reflection->hasMethod($method),
"Interface missing method: {$method}"
);
}
}
public function testGetServiceTypeReturnsString(): void
{
$method = new \ReflectionMethod(MokoSuiteCrossServiceInterface::class, 'getServiceType');
$returnType = $method->getReturnType();
$this->assertNotNull($returnType);
$this->assertSame('string', $returnType->getName());
}
public function testPublishAcceptsCorrectParameters(): void
{
$method = new \ReflectionMethod(MokoSuiteCrossServiceInterface::class, 'publish');
$params = $method->getParameters();
$this->assertCount(4, $params);
$this->assertSame('message', $params[0]->getName());
$this->assertSame('media', $params[1]->getName());
$this->assertSame('credentials', $params[2]->getName());
$this->assertSame('params', $params[3]->getName());
}
public function testPublishReturnsArray(): void
{
$method = new \ReflectionMethod(MokoSuiteCrossServiceInterface::class, 'publish');
$returnType = $method->getReturnType();
$this->assertNotNull($returnType);
$this->assertSame('array', $returnType->getName());
}
public function testGetMaxLengthReturnsInt(): void
{
$method = new \ReflectionMethod(MokoSuiteCrossServiceInterface::class, 'getMaxLength');
$returnType = $method->getReturnType();
$this->assertNotNull($returnType);
$this->assertSame('int', $returnType->getName());
}
public function testSupportsMediaReturnsBool(): void
{
$method = new \ReflectionMethod(MokoSuiteCrossServiceInterface::class, 'supportsMedia');
$returnType = $method->getReturnType();
$this->assertNotNull($returnType);
$this->assertSame('bool', $returnType->getName());
}
/**
* @dataProvider servicePluginClassProvider
*/
public function testServicePluginImplementsInterface(string $className): void
{
if (!class_exists($className)) {
$this->markTestSkipped("Class {$className} not autoloadable (needs Joomla runtime)");
}
$this->assertTrue(
is_subclass_of($className, MokoSuiteCrossServiceInterface::class),
"{$className} does not implement MokoSuiteCrossServiceInterface"
);
}
public static function servicePluginClassProvider(): array
{
$plugins = [
'facebook', 'twitter', 'linkedin', 'mastodon', 'bluesky',
'telegram', 'discord', 'slack', 'mailchimp', 'medium',
'instagram', 'youtube', 'threads', 'pinterest', 'reddit',
];
$cases = [];
foreach ($plugins as $plugin) {
$class = ucfirst($plugin);
$cases[$plugin] = [
"Joomla\\Plugin\\MokoSuiteCross\\{$class}\\Extension\\{$class}Service",
];
}
return $cases;
}
}
-16
View File
@@ -1,16 +0,0 @@
<?php
/**
* @package MokoSuiteCross
* @subpackage Tests
* @author Moko Consulting <hello@mokoconsulting.tech>
* @copyright Copyright (C) 2026 Moko Consulting. All rights reserved.
* @license GNU General Public License version 3 or later; see LICENSE
* SPDX-License-Identifier: GPL-3.0-or-later
*/
require_once __DIR__ . '/../vendor/autoload.php';
if (!defined('_JEXEC')) {
define('_JEXEC', 1);
}