Squashed commit of the following:

commit a01812b0d709e556af060a393168acc471aca774
Author: Jonny Barnes <jonny@jonnybarnes.uk>
Date:   Thu Apr 12 18:15:25 2018 +0100

    Improve JSON feed generation to better match the spec

commit 72ad2c629738ef73ccaf984ed3ad9b726956dd71
Author: Jonny Barnes <jonny@jonnybarnes.uk>
Date:   Sun Apr 8 13:07:48 2018 +0100

    Add a test for null title entries
This commit is contained in:
Jonny Barnes 2018-04-12 18:15:42 +01:00
parent 97a6b771f8
commit 3d1ae20afb
3 changed files with 56 additions and 2 deletions

View file

@ -121,9 +121,8 @@ class FeedsController extends Controller
foreach ($notes as $key => $note) { foreach ($notes as $key => $note) {
$data['items'][$key] = [ $data['items'][$key] = [
'id' => $note->longurl, 'id' => $note->longurl,
'title' => $note->getOriginal('note'),
'url' => $note->longurl, 'url' => $note->longurl,
'content_html' => $note->note, 'content_html' => $note->content,
'date_published' => $note->created_at->tz('UTC')->toRfc3339String(), 'date_published' => $note->created_at->tz('UTC')->toRfc3339String(),
'date_modified' => $note->updated_at->tz('UTC')->toRfc3339String(), 'date_modified' => $note->updated_at->tz('UTC')->toRfc3339String(),
'author' => [ 'author' => [

View file

@ -176,6 +176,37 @@ class Note extends Model
return $modified; return $modified;
} }
/**
* Provide the content_html for JSON feed.
*
* In particular we want to include media links such as images.
*
* @return string
*/
public function getContentAttribute(): string
{
$note = $this->note;
foreach ($this->media as $media) {
if ($media->type == 'image') {
$note .= '<img src="' . $media->url . '" alt="">';
}
if ($media->type == 'audio' ){
$note .= '<audio src="' . $media->url . '">';
}
if ($media->type == 'video') {
$note .= '<video src="' . $media->url . '">';
}
}
if ($note === null) {
// when would $note still be blank?
$note = 'A blank note';
}
return $note;
}
/** /**
* Generate the NewBase60 ID from primary ID. * Generate the NewBase60 ID from primary ID.
* *

View file

@ -71,4 +71,28 @@ class FeedsTest extends TestCase
$response = $this->get('/notes/feed.json'); $response = $this->get('/notes/feed.json');
$response->assertHeader('Content-Type', 'application/json'); $response->assertHeader('Content-Type', 'application/json');
} }
/**
* Each JSON feed item must have one of `content_text` or `content_html`,
* and whichever one they have cant be `null`.
*
* @return void
*/
public function test_json_feed_has_one_content_attribute_and_it_isnt_null()
{
$response = $this->get('/notes/feed.json');
$data = json_decode($response->content());
foreach ($data->items as $item) {
$this->assertTrue(
property_exists($item, 'content_text') ||
property_exists($item, 'content_html')
);
if (property_exists($item, 'content_text')) {
$this->assertNotNull($item->content_text);
}
if (property_exists($item, 'content_html')) {
$this->assertNotNull($item->content_html);
}
}
}
} }