mirror of
https://github.com/usetrmnl/byos_laravel.git
synced 2026-01-13 15:07:49 +00:00
This commit is contained in:
parent
aa46dff00b
commit
4de32e9d47
3 changed files with 232 additions and 12 deletions
|
|
@ -14,6 +14,7 @@ use App\Liquid\Tags\TemplateTag;
|
|||
use Exception;
|
||||
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Http\Client\Response;
|
||||
use Illuminate\Support\Facades\App;
|
||||
use Illuminate\Support\Facades\Blade;
|
||||
use Illuminate\Support\Facades\Http;
|
||||
|
|
@ -22,6 +23,7 @@ use Illuminate\Support\Str;
|
|||
use Keepsuit\LaravelLiquid\LaravelLiquidExtension;
|
||||
use Keepsuit\Liquid\Exceptions\LiquidException;
|
||||
use Keepsuit\Liquid\Extensions\StandardExtension;
|
||||
use SimpleXMLElement;
|
||||
|
||||
class Plugin extends Model
|
||||
{
|
||||
|
|
@ -83,7 +85,7 @@ class Plugin extends Model
|
|||
$currentValue = $this->configuration[$fieldKey] ?? null;
|
||||
|
||||
// If the field has a default value and no current value is set, it's not missing
|
||||
if (($currentValue === null || $currentValue === '' || ($currentValue === [])) && ! isset($field['default'])) {
|
||||
if ((in_array($currentValue, [null, '', []], true)) && ! isset($field['default'])) {
|
||||
return true; // Found a required field that is not set and has no default
|
||||
}
|
||||
}
|
||||
|
|
@ -145,11 +147,9 @@ class Plugin extends Model
|
|||
|
||||
try {
|
||||
// Make the request based on the verb
|
||||
if ($this->polling_verb === 'post') {
|
||||
$response = $httpRequest->post($resolvedUrl)->json();
|
||||
} else {
|
||||
$response = $httpRequest->get($resolvedUrl)->json();
|
||||
}
|
||||
$httpResponse = $this->polling_verb === 'post' ? $httpRequest->post($resolvedUrl) : $httpRequest->get($resolvedUrl);
|
||||
|
||||
$response = $this->parseResponse($httpResponse);
|
||||
|
||||
$this->update([
|
||||
'data_payload' => $response,
|
||||
|
|
@ -183,14 +183,12 @@ class Plugin extends Model
|
|||
|
||||
try {
|
||||
// Make the request based on the verb
|
||||
if ($this->polling_verb === 'post') {
|
||||
$response = $httpRequest->post($resolvedUrl)->json();
|
||||
} else {
|
||||
$response = $httpRequest->get($resolvedUrl)->json();
|
||||
}
|
||||
$httpResponse = $this->polling_verb === 'post' ? $httpRequest->post($resolvedUrl) : $httpRequest->get($resolvedUrl);
|
||||
|
||||
$response = $this->parseResponse($httpResponse);
|
||||
|
||||
// Check if response is an array at root level
|
||||
if (is_array($response) && array_keys($response) === range(0, count($response) - 1)) {
|
||||
if (array_keys($response) === range(0, count($response) - 1)) {
|
||||
// Response is a sequential array, nest under .data
|
||||
$combinedResponse["IDX_{$index}"] = ['data' => $response];
|
||||
} else {
|
||||
|
|
@ -211,6 +209,56 @@ class Plugin extends Model
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse HTTP response, handling both JSON and XML content types
|
||||
*/
|
||||
private function parseResponse(Response $httpResponse): array
|
||||
{
|
||||
if ($httpResponse->header('Content-Type') && str_contains($httpResponse->header('Content-Type'), 'xml')) {
|
||||
try {
|
||||
// Convert XML to array and wrap under 'rss' key
|
||||
$xml = simplexml_load_string($httpResponse->body());
|
||||
if ($xml === false) {
|
||||
throw new Exception('Invalid XML content');
|
||||
}
|
||||
|
||||
// Convert SimpleXML directly to array
|
||||
$xmlArray = $this->xmlToArray($xml);
|
||||
|
||||
return ['rss' => $xmlArray];
|
||||
} catch (Exception $e) {
|
||||
Log::warning('Failed to parse XML response: '.$e->getMessage());
|
||||
|
||||
return ['error' => 'Failed to parse XML response'];
|
||||
}
|
||||
}
|
||||
|
||||
// Default to JSON parsing
|
||||
try {
|
||||
return $httpResponse->json() ?? [];
|
||||
} catch (Exception $e) {
|
||||
Log::warning('Failed to parse JSON response: '.$e->getMessage());
|
||||
|
||||
return ['error' => 'Failed to parse JSON response'];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert SimpleXML object to array recursively
|
||||
*/
|
||||
private function xmlToArray(SimpleXMLElement $xml): array
|
||||
{
|
||||
$array = (array) $xml;
|
||||
|
||||
foreach ($array as $key => $value) {
|
||||
if ($value instanceof SimpleXMLElement) {
|
||||
$array[$key] = $this->xmlToArray($value);
|
||||
}
|
||||
}
|
||||
|
||||
return $array;
|
||||
}
|
||||
|
||||
/**
|
||||
* Apply Liquid template replacements (converts 'with' syntax to comma syntax)
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -12,6 +12,7 @@
|
|||
"require": {
|
||||
"php": "^8.2",
|
||||
"ext-imagick": "*",
|
||||
"ext-simplexml": "*",
|
||||
"ext-zip": "*",
|
||||
"bnussbau/laravel-trmnl-blade": "2.0.*",
|
||||
"bnussbau/trmnl-pipeline-php": "^0.3.0",
|
||||
|
|
|
|||
171
tests/Feature/PluginXmlResponseTest.php
Normal file
171
tests/Feature/PluginXmlResponseTest.php
Normal file
|
|
@ -0,0 +1,171 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use App\Models\Plugin;
|
||||
use Illuminate\Support\Facades\Http;
|
||||
|
||||
test('plugin parses JSON responses correctly', function (): void {
|
||||
Http::fake([
|
||||
'example.com/api/data' => Http::response([
|
||||
'title' => 'Test Data',
|
||||
'items' => [
|
||||
['id' => 1, 'name' => 'Item 1'],
|
||||
['id' => 2, 'name' => 'Item 2'],
|
||||
],
|
||||
], 200, ['Content-Type' => 'application/json']),
|
||||
]);
|
||||
|
||||
$plugin = Plugin::factory()->create([
|
||||
'data_strategy' => 'polling',
|
||||
'polling_url' => 'https://example.com/api/data',
|
||||
'polling_verb' => 'get',
|
||||
]);
|
||||
|
||||
$plugin->updateDataPayload();
|
||||
|
||||
$plugin->refresh();
|
||||
|
||||
expect($plugin->data_payload)->toBe([
|
||||
'title' => 'Test Data',
|
||||
'items' => [
|
||||
['id' => 1, 'name' => 'Item 1'],
|
||||
['id' => 2, 'name' => 'Item 2'],
|
||||
],
|
||||
]);
|
||||
});
|
||||
|
||||
test('plugin parses XML responses and wraps under rss key', function (): void {
|
||||
$xmlContent = '<?xml version="1.0" encoding="UTF-8"?>
|
||||
<rss version="2.0">
|
||||
<channel>
|
||||
<title>Test RSS Feed</title>
|
||||
<item>
|
||||
<title>Test Item 1</title>
|
||||
<description>Description 1</description>
|
||||
</item>
|
||||
<item>
|
||||
<title>Test Item 2</title>
|
||||
<description>Description 2</description>
|
||||
</item>
|
||||
</channel>
|
||||
</rss>';
|
||||
|
||||
Http::fake([
|
||||
'example.com/feed.xml' => Http::response($xmlContent, 200, ['Content-Type' => 'application/xml']),
|
||||
]);
|
||||
|
||||
$plugin = Plugin::factory()->create([
|
||||
'data_strategy' => 'polling',
|
||||
'polling_url' => 'https://example.com/feed.xml',
|
||||
'polling_verb' => 'get',
|
||||
]);
|
||||
|
||||
$plugin->updateDataPayload();
|
||||
|
||||
$plugin->refresh();
|
||||
|
||||
expect($plugin->data_payload)->toHaveKey('rss');
|
||||
expect($plugin->data_payload['rss'])->toHaveKey('@attributes');
|
||||
expect($plugin->data_payload['rss'])->toHaveKey('channel');
|
||||
expect($plugin->data_payload['rss']['channel']['title'])->toBe('Test RSS Feed');
|
||||
expect($plugin->data_payload['rss']['channel']['item'])->toHaveCount(2);
|
||||
});
|
||||
|
||||
test('plugin handles non-XML content-type as JSON', function (): void {
|
||||
$jsonContent = '{"title": "Test Data", "items": [1, 2, 3]}';
|
||||
|
||||
Http::fake([
|
||||
'example.com/data' => Http::response($jsonContent, 200, ['Content-Type' => 'text/plain']),
|
||||
]);
|
||||
|
||||
$plugin = Plugin::factory()->create([
|
||||
'data_strategy' => 'polling',
|
||||
'polling_url' => 'https://example.com/data',
|
||||
'polling_verb' => 'get',
|
||||
]);
|
||||
|
||||
$plugin->updateDataPayload();
|
||||
|
||||
$plugin->refresh();
|
||||
|
||||
expect($plugin->data_payload)->toBe([
|
||||
'title' => 'Test Data',
|
||||
'items' => [1, 2, 3],
|
||||
]);
|
||||
});
|
||||
|
||||
test('plugin handles invalid XML gracefully', function (): void {
|
||||
$invalidXml = '<root><item>unclosed tag';
|
||||
|
||||
Http::fake([
|
||||
'example.com/invalid.xml' => Http::response($invalidXml, 200, ['Content-Type' => 'application/xml']),
|
||||
]);
|
||||
|
||||
$plugin = Plugin::factory()->create([
|
||||
'data_strategy' => 'polling',
|
||||
'polling_url' => 'https://example.com/invalid.xml',
|
||||
'polling_verb' => 'get',
|
||||
]);
|
||||
|
||||
$plugin->updateDataPayload();
|
||||
|
||||
$plugin->refresh();
|
||||
|
||||
expect($plugin->data_payload)->toBe(['error' => 'Failed to parse XML response']);
|
||||
});
|
||||
|
||||
test('plugin handles multiple URLs with mixed content types', function (): void {
|
||||
$jsonResponse = ['title' => 'JSON Data', 'items' => [1, 2, 3]];
|
||||
$xmlContent = '<root><item>XML Data</item></root>';
|
||||
|
||||
Http::fake([
|
||||
'example.com/json' => Http::response($jsonResponse, 200, ['Content-Type' => 'application/json']),
|
||||
'example.com/xml' => Http::response($xmlContent, 200, ['Content-Type' => 'application/xml']),
|
||||
]);
|
||||
|
||||
$plugin = Plugin::factory()->create([
|
||||
'data_strategy' => 'polling',
|
||||
'polling_url' => "https://example.com/json\nhttps://example.com/xml",
|
||||
'polling_verb' => 'get',
|
||||
]);
|
||||
|
||||
$plugin->updateDataPayload();
|
||||
|
||||
$plugin->refresh();
|
||||
|
||||
expect($plugin->data_payload)->toHaveKey('IDX_0');
|
||||
expect($plugin->data_payload)->toHaveKey('IDX_1');
|
||||
|
||||
// First URL should be JSON
|
||||
expect($plugin->data_payload['IDX_0'])->toBe($jsonResponse);
|
||||
|
||||
// Second URL should be XML wrapped under rss
|
||||
expect($plugin->data_payload['IDX_1'])->toHaveKey('rss');
|
||||
expect($plugin->data_payload['IDX_1']['rss']['item'])->toBe('XML Data');
|
||||
});
|
||||
|
||||
test('plugin handles POST requests with XML responses', function (): void {
|
||||
$xmlContent = '<response><status>success</status><data>test</data></response>';
|
||||
|
||||
Http::fake([
|
||||
'example.com/api' => Http::response($xmlContent, 200, ['Content-Type' => 'application/xml']),
|
||||
]);
|
||||
|
||||
$plugin = Plugin::factory()->create([
|
||||
'data_strategy' => 'polling',
|
||||
'polling_url' => 'https://example.com/api',
|
||||
'polling_verb' => 'post',
|
||||
'polling_body' => '{"query": "test"}',
|
||||
]);
|
||||
|
||||
$plugin->updateDataPayload();
|
||||
|
||||
$plugin->refresh();
|
||||
|
||||
expect($plugin->data_payload)->toHaveKey('rss');
|
||||
expect($plugin->data_payload['rss'])->toHaveKey('status');
|
||||
expect($plugin->data_payload['rss'])->toHaveKey('data');
|
||||
expect($plugin->data_payload['rss']['status'])->toBe('success');
|
||||
expect($plugin->data_payload['rss']['data'])->toBe('test');
|
||||
});
|
||||
Loading…
Add table
Add a link
Reference in a new issue