Basic RSS support (#103)

Author: jbrooksuk

resources/lang/en.json

@@ -1,5 +1,6 @@
 {
     ":count Incident": ":count Incident|:count Incidents",
+    ":name RSS Feed": ":name RSS Feed",
     "Admin": "Admin",
     "Always Hidden": "Always Hidden",
     "Always collapsed": "Always collapsed",

resources/views/rss.blade.php

@@ -0,0 +1,24 @@
+<?=
+'<?xml version="1.0" encoding="UTF-8"?>'.PHP_EOL
+?>
+<rss version="2.0">
+    <channel>
+        <title><![CDATA[ {{ __(':name RSS Feed', ['name' => $statusPageName]) }} ]]></title>
+        <link><![CDATA[ {{ route('cachet.rss') }} ]]></link>
+        @if($statusAbout)
+        <description><![CDATA[ {{ $statusAbout  }} ]]></description>
+        @endif
+        <language>{{ config('app.locale') }}</language>
+        <pubDate>{{ now()->toRssString() }}</pubDate>
+
+        @foreach($incidents as $incident)
+        <item>
+            <title>{{ $incident->name }}</title>
+            <link>{{ route('cachet.status-page.incident', $incident) }}</link>
+            <description><![CDATA[{!! $incident->message !!}]]></description>
+            <guid>{{ $incident->guid }}</guid>
+            <pubDate>{{ $incident->created_at->toRssString() }}</pubDate>
+        </item>
+        @endforeach
+    </channel>
+</rss>

src/Http/Controllers/RssController.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Cachet\Http\Controllers;
+
+use Cachet\Models\Incident;
+use Cachet\Settings\AppSettings;
+use Illuminate\Http\Response;
+
+class RssController
+{
+    /**
+     * Returns the RSS feed of all incidents.
+     */
+    public function __invoke(AppSettings $appSettings): Response
+    {
+        return response()->view('cachet::rss', [
+            'statusPageName' => $appSettings->name,
+            'statusAbout' => $appSettings->about,
+            'incidents' => Incident::query()
+                ->guests()
+                ->with('incidentUpdates')
+                ->orderByDesc('created_at')
+                ->get(),
+        ])->header('Content-Type', 'application/rss+xml');
+    }
+}

src/PendingRouteRegistration.php

@@ -3,6 +3,7 @@
 namespace Cachet;
 
 use Cachet\Http\Controllers\HealthController;
+use Cachet\Http\Controllers\RssController;
 use Cachet\Http\Controllers\Setup\SetupController;
 use Cachet\Http\Controllers\StatusPage\StatusPageController;
 use Illuminate\Routing\Router;
@@ -37,6 +38,8 @@ public function register(): void
                 // @todo subscription routes... subscribe, manage subscriptions, unsubscribe
 
                 $router->get('/health', HealthController::class)->name('health');
+
+                $router->get('/rss', RssController::class)->name('rss');
             });
     }
 

tests/Feature/RssTest.php

@@ -0,0 +1,11 @@
+<?php
+
+use Cachet\Models\Incident;
+
+it('can get the rss feed', function () {
+    $incident = Incident::factory()->create();
+
+    $this->get('/status/rss')
+        ->assertOk()
+        ->assertSee($incident->name);
+});