Add support for flipboard and conform to RSS 2.0 (fixes spatie#19) (spatie#92)

nikhiltri · freekmurze · commit f41e27aee886 · 2019-08-22T09:09:46.000+02:00
* Add description to Feeds

* Add language to Feeds

* Correct PHPDoc

* Add enclosure to FeedItems

* Add category to FeedItems

* Update date formats to conform to RSS 2.0 spec

* Make enclosure property optional in view
diff --git a/resources/views/feed.blade.php b/resources/views/feed.blade.php
@@ -23,7 +23,13 @@
             <summary type="html">
                 <![CDATA[{!! $item->summary !!}]]>
             </summary>
-            <updated>{{ $item->updated->toAtomString() }}</updated>
+            @if($item->__isset('enclosure'))
+              <enclosure url="{{ url($item->enclosure) }}" length="{{ $item->enclosureLength }}" type="{{ $item->enclosureType }}" />
+            @endif
+            <category type="html">
+                <![CDATA[{!! $item->category ?? '' !!}]]>
+            </category>
+            <updated>{{ $item->updated->toRssString() }}</updated>
         </entry>
     @endforeach
 </feed>
diff --git a/src/Feed.php b/src/Feed.php
@@ -13,6 +13,12 @@ class Feed implements Responsable
     /** @var string */
     protected $title;
 
+    /** @var string */
+    protected $description;
+
+    /** @var string */
+    protected $language;
+
     /** @var string */
     protected $url;
 
@@ -22,9 +28,11 @@ class Feed implements Responsable
     /** @var \Illuminate\Support\Collection */
     protected $items;
 
-    public function __construct($title, $url, $resolver, $view)
+    public function __construct($title, $url, $resolver, $view, $description, $language)
     {
         $this->title = $title;
+        $this->description = $description;
+        $this->language = $language;
         $this->url = $url;
         $this->view = $view;
 
@@ -37,6 +45,8 @@ public function toResponse($request): Response
             'id' => url($this->url),
             'link' => url($this->url),
             'title' => $this->title,
+            'description' => $this->description,
+            'language' => $this->language,
             'updated' => $this->lastUpdated(),
         ];
 
@@ -98,6 +108,6 @@ protected function lastUpdated(): string
 
         return $this->items->sortBy(function ($feedItem) {
             return $feedItem->updated;
-        })->last()->updated->toAtomString();
+        })->last()->updated->toRssString();
     }
 }
diff --git a/src/FeedItem.php b/src/FeedItem.php
@@ -20,12 +20,24 @@ class FeedItem
     /** @var string */
     protected $summary;
 
-    /** @var @var string */
+    /** @var string */
     protected $link;
 
+    /** @var string */
+    protected $enclosure;
+
+    /** @var int */
+    protected $enclosureLength;
+
+    /** @var string */
+    protected $enclosureType;
+
     /** @var string */
     protected $author;
 
+    /** @var string */
+    protected $category;
+
     public function __construct(array $data = [])
     {
         foreach ($data as $key => $value) {
@@ -73,13 +85,41 @@ public function link(string $link)
         return $this;
     }
 
+    public function enclosure(string $enclosure)
+    {
+        $this->enclosure = $enclosure;
+
+        return $this;
+    }
+
+    public function enclosureLength(int $enclosureLength)
+    {
+        $this->enclosureLength = $enclosureLength;
+
+        return $this;
+    }
+
+    public function enclosureType(string $enclosureType)
+    {
+        $this->enclosureType = $enclosureType;
+
+        return $this;
+    }
+
     public function author(string $author)
     {
         $this->author = $author;
 
         return $this;
     }
 
+    public function category(string $category)
+    {
+        $this->category = $category;
+
+        return $this;
+    }
+
     public function validate()
     {
         $requiredFields = ['id', 'title', 'updated', 'summary', 'link', 'author'];
@@ -99,4 +139,9 @@ public function __get($key)
 
         return $this->$key;
     }
+
+    public function __isset($key)
+    {
+        return isset($this->$key);
+    }
 }
diff --git a/src/Http/FeedController.php b/src/Http/FeedController.php
@@ -17,6 +17,6 @@ public function __invoke()
 
         abort_unless($feed, 404);
 
-        return new Feed($feed['title'], request()->url(), $feed['items'], $feed['view'] ?? 'feed::feed');
+        return new Feed($feed['title'], request()->url(), $feed['items'], $feed['view'] ?? 'feed::feed', $feed['description'] ?? '', $feed['language'] ?? '');
     }
 }
diff --git a/tests/DummyItem.php b/tests/DummyItem.php
@@ -14,9 +14,13 @@ public function toFeedItem()
             'id' => 1,
             'title' => 'feedItemTitle',
             'summary' => 'feedItemSummary',
+            'enclosure' => 'http://localhost/image1.jpg',
+            'enclosureLength' => 31300,
+            'enclosureType' => 'image/jpeg',
             'updated' => Carbon::now(),
             'link' => 'https://localhost/news/testItem1',
             'author' => 'feedItemAuthor',
+            'category' => 'feedItemCategory',
         ]);
     }
 }
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -37,24 +37,28 @@ protected function getEnvironmentSetUp($app)
                 'url' => '/feed1',
                 'title' => 'Feed 1',
                 'description' => 'This is feed 1 from the unit tests',
+                'language' => 'en-US',
             ],
             [
                 'items' => 'Spatie\Feed\Test\DummyRepository@getAll',
                 'url' => '/feed2',
                 'title' => 'Feed 2',
                 'description' => 'This is feed 2 from the unit tests',
+                'language' => 'en-US',
             ],
             [
                 'items' => ['Spatie\Feed\Test\DummyRepository@getAllWithArguments', 'first'],
                 'url' => '/feed3',
                 'title' => 'Feed 3',
                 'description' => 'This is feed 3 from the unit tests',
+                'language' => 'en-US',
             ],
             [
                 'items' => 'Spatie\Feed\Test\DummyRepository@getAll',
                 'url' => '/feed-with-custom-view',
                 'title' => 'Feed with Custom View',
                 'description' => 'This is a feed that uses custom views from the unit tests',
+                'language' => 'en-US',
                 'view' => 'feed::links',
             ],
         ];
diff --git a/tests/__snapshots__/FeedTest__all_feed_items_have_expected_data__1.php b/tests/__snapshots__/FeedTest__all_feed_items_have_expected_data__1.php
@@ -3,7 +3,9 @@
                         <id>http://localhost/feedBaseUrl/feed1</id>
                                 <link href="http://localhost/feedBaseUrl/feed1"></link>
                                 <title><![CDATA[Feed 1]]></title>
-                                <updated>2016-01-01T00:00:00+01:00</updated>
+                                <description>This is feed 1 from the unit tests</description>
+                                <language>en-US</language>
+                                <updated>Fri, 01 Jan 2016 00:00:00 +0100</updated>
                         <entry>
             <title><![CDATA[feedItemTitle]]></title>
             <link rel="alternate" href="https://localhost/news/testItem1" />
@@ -14,7 +16,11 @@
             <summary type="html">
                 <![CDATA[feedItemSummary]]>
             </summary>
-            <updated>2016-01-01T00:00:00+01:00</updated>
+                          <enclosure url="http://localhost/image1.jpg" length="31300" type="image/jpeg" />
+                        <category type="html">
+                <![CDATA[feedItemCategory]]>
+            </category>
+            <updated>Fri, 01 Jan 2016 00:00:00 +0100</updated>
         </entry>
             <entry>
             <title><![CDATA[feedItemTitle]]></title>
@@ -26,7 +32,11 @@
             <summary type="html">
                 <![CDATA[feedItemSummary]]>
             </summary>
-            <updated>2016-01-01T00:00:00+01:00</updated>
+                          <enclosure url="http://localhost/image1.jpg" length="31300" type="image/jpeg" />
+                        <category type="html">
+                <![CDATA[feedItemCategory]]>
+            </category>
+            <updated>Fri, 01 Jan 2016 00:00:00 +0100</updated>
         </entry>
             <entry>
             <title><![CDATA[feedItemTitle]]></title>
@@ -38,7 +48,11 @@
             <summary type="html">
                 <![CDATA[feedItemSummary]]>
             </summary>
-            <updated>2016-01-01T00:00:00+01:00</updated>
+                          <enclosure url="http://localhost/image1.jpg" length="31300" type="image/jpeg" />
+                        <category type="html">
+                <![CDATA[feedItemCategory]]>
+            </category>
+            <updated>Fri, 01 Jan 2016 00:00:00 +0100</updated>
         </entry>
             <entry>
             <title><![CDATA[feedItemTitle]]></title>
@@ -50,7 +64,11 @@
             <summary type="html">
                 <![CDATA[feedItemSummary]]>
             </summary>
-            <updated>2016-01-01T00:00:00+01:00</updated>
+                          <enclosure url="http://localhost/image1.jpg" length="31300" type="image/jpeg" />
+                        <category type="html">
+                <![CDATA[feedItemCategory]]>
+            </category>
+            <updated>Fri, 01 Jan 2016 00:00:00 +0100</updated>
         </entry>
             <entry>
             <title><![CDATA[feedItemTitle]]></title>
@@ -62,7 +80,11 @@
             <summary type="html">
                 <![CDATA[feedItemSummary]]>
             </summary>
-            <updated>2016-01-01T00:00:00+01:00</updated>
+                          <enclosure url="http://localhost/image1.jpg" length="31300" type="image/jpeg" />
+                        <category type="html">
+                <![CDATA[feedItemCategory]]>
+            </category>
+            <updated>Fri, 01 Jan 2016 00:00:00 +0100</updated>
         </entry>
     </feed>
 ';
diff --git a/tests/__snapshots__/FeedTest__all_feed_items_have_expected_data__2.php b/tests/__snapshots__/FeedTest__all_feed_items_have_expected_data__2.php
@@ -3,7 +3,9 @@
                         <id>http://localhost/feedBaseUrl/feed2</id>
                                 <link href="http://localhost/feedBaseUrl/feed2"></link>
                                 <title><![CDATA[Feed 2]]></title>
-                                <updated>2016-01-01T00:00:00+01:00</updated>
+                                <description>This is feed 2 from the unit tests</description>
+                                <language>en-US</language>
+                                <updated>Fri, 01 Jan 2016 00:00:00 +0100</updated>
                         <entry>
             <title><![CDATA[feedItemTitle]]></title>
             <link rel="alternate" href="https://localhost/news/testItem1" />
@@ -14,7 +16,11 @@
             <summary type="html">
                 <![CDATA[feedItemSummary]]>
             </summary>
-            <updated>2016-01-01T00:00:00+01:00</updated>
+                          <enclosure url="http://localhost/image1.jpg" length="31300" type="image/jpeg" />
+                        <category type="html">
+                <![CDATA[feedItemCategory]]>
+            </category>
+            <updated>Fri, 01 Jan 2016 00:00:00 +0100</updated>
         </entry>
             <entry>
             <title><![CDATA[feedItemTitle]]></title>
@@ -26,7 +32,11 @@
             <summary type="html">
                 <![CDATA[feedItemSummary]]>
             </summary>
-            <updated>2016-01-01T00:00:00+01:00</updated>
+                          <enclosure url="http://localhost/image1.jpg" length="31300" type="image/jpeg" />
+                        <category type="html">
+                <![CDATA[feedItemCategory]]>
+            </category>
+            <updated>Fri, 01 Jan 2016 00:00:00 +0100</updated>
         </entry>
             <entry>
             <title><![CDATA[feedItemTitle]]></title>
@@ -38,7 +48,11 @@
             <summary type="html">
                 <![CDATA[feedItemSummary]]>
             </summary>
-            <updated>2016-01-01T00:00:00+01:00</updated>
+                          <enclosure url="http://localhost/image1.jpg" length="31300" type="image/jpeg" />
+                        <category type="html">
+                <![CDATA[feedItemCategory]]>
+            </category>
+            <updated>Fri, 01 Jan 2016 00:00:00 +0100</updated>
         </entry>
             <entry>
             <title><![CDATA[feedItemTitle]]></title>
@@ -50,7 +64,11 @@
             <summary type="html">
                 <![CDATA[feedItemSummary]]>
             </summary>
-            <updated>2016-01-01T00:00:00+01:00</updated>
+                          <enclosure url="http://localhost/image1.jpg" length="31300" type="image/jpeg" />
+                        <category type="html">
+                <![CDATA[feedItemCategory]]>
+            </category>
+            <updated>Fri, 01 Jan 2016 00:00:00 +0100</updated>
         </entry>
             <entry>
             <title><![CDATA[feedItemTitle]]></title>
@@ -62,7 +80,11 @@
             <summary type="html">
                 <![CDATA[feedItemSummary]]>
             </summary>
-            <updated>2016-01-01T00:00:00+01:00</updated>
+                          <enclosure url="http://localhost/image1.jpg" length="31300" type="image/jpeg" />
+                        <category type="html">
+                <![CDATA[feedItemCategory]]>
+            </category>
+            <updated>Fri, 01 Jan 2016 00:00:00 +0100</updated>
         </entry>
     </feed>
 ';
diff --git a/tests/__snapshots__/FeedTest__all_feed_items_have_expected_data__3.php b/tests/__snapshots__/FeedTest__all_feed_items_have_expected_data__3.php

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,6 @@ public function __invoke()`
`17`	`17`
`18`	`18`	`abort_unless($feed, 404);`
`19`	`19`
`20`		`- return new Feed($feed['title'], request()->url(), $feed['items'], $feed['view'] ?? 'feed::feed');`
	`20`	`+ return new Feed($feed['title'], request()->url(), $feed['items'], $feed['view'] ?? 'feed::feed', $feed['description'] ?? '', $feed['language'] ?? '');`
`21`	`21`	`}`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,9 +14,13 @@ public function toFeedItem()`
`14`	`14`	`'id' => 1,`
`15`	`15`	`'title' => 'feedItemTitle',`
`16`	`16`	`'summary' => 'feedItemSummary',`
	`17`	`+ 'enclosure' => 'http://localhost/image1.jpg',`
	`18`	`+ 'enclosureLength' => 31300,`
	`19`	`+ 'enclosureType' => 'image/jpeg',`
`17`	`20`	`'updated' => Carbon::now(),`
`18`	`21`	`'link' => 'https://localhost/news/testItem1',`
`19`	`22`	`'author' => 'feedItemAuthor',`
	`23`	`+ 'category' => 'feedItemCategory',`
`20`	`24`	`]);`
`21`	`25`	`}`
`22`	`26`	`}`