Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create the RSS 2.0 feed #326

Open
wants to merge 13 commits into
base: trunk
Choose a base branch
from
Open

Create the RSS 2.0 feed #326

wants to merge 13 commits into from

Conversation

amieiro
Copy link
Collaborator

@amieiro amieiro commented Jun 19, 2024 •
edited
Loading

This PR adds:

  • A new class to generate an RSS 2.0 feed.
  • Two routes (/events/feed and /events/rss) to get the RSS feed.
  • A new method (get_current_and_upcoming_events) in the event repository to get all events that are currently active or happening in the future, in order by the start date.

The:

  • The pubDate element defines the last publication date for an item.
    • In the main file, the pubDate is the date of the last update of all events in the RSS file.
    • In the event (item), the pubDate is the last update of this event.
  • The lastBuildDate element defines the last-modified date of the content of the feed, so it is the same value that the pubDate in the main file.

I have used the http://purl.org/rss/1.0/modules/event/ namespace to be able to add the ev:startdate and ev:enddate elements to each event.

Date format:

  • The pubDate has the DATE_RSS format: 'D, d M Y H:i:s O'.
  • the ev:startdate and ev:enddate have the DateTimeInterface::ATOM format: 'Y-m-d\TH:i:sP'.

You can validate the RSS feed using the W3C Feed Validation Service, coping and pasting the generated content. You will get some warning like this, because the local URL is not accessible from this tool:

image

One example with the generated RSS feed:

<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:atom="http://www.w3.org/2005/Atom" xmlns:ev="http://purl.org/rss/1.0/modules/event/" version="2.0">
   <channel>
      <title>WordPress.org Global Translation Events</title>
      <link>https://glotpress.test/glotpress/events/</link>
      <description>WordPress.org Global Translation Events</description>
      <language>en-us</language>
      <pubDate>Sat, 29 Jun 2024 10:13:45 +0000</pubDate>
      <lastBuildDate>Sat, 29 Jun 2024 10:13:45 +0000</lastBuildDate>
      <docs>https://www.rssboard.org/rss-specification</docs>
      <generator>Translation Events</generator>
      <atom:link href="https://glotpress.test/glotpress/events/rss/" rel="self" type="application/rss+xml" />
      <item>
         <title>July event</title>
         <link>https://glotpress.test/glotpress/events/july-event__trashed/</link>
         <description>Lorem ipsum</description>
         <enclosure url="https://glotpress.test/glotpress/events/image/366/" type="image/png" length="1200" />
         <pubDate>Wed, 10 Apr 2024 23:26:18 +0000</pubDate>
         <ev:startdate>2024-07-01T12:01:00+00:00</ev:startdate>
         <ev:enddate>2024-08-01T11:59:00+00:00</ev:enddate>
         <guid>https://glotpress.test/glotpress/events/july-event__trashed/</guid>
      </item>
      <item>
         <title>August event</title>
         <link>https://glotpress.test/glotpress/events/august-event__trashed/</link>
         <description />
         <enclosure url="https://glotpress.test/glotpress/events/image/365/" type="image/png" length="1200" />
         <pubDate>Thu, 21 Mar 2024 12:17:19 +0000</pubDate>
         <ev:startdate>2024-07-31T22:00:00+00:00</ev:startdate>
         <ev:enddate>2024-08-31T01:09:09+00:00</ev:enddate>
         <guid>https://glotpress.test/glotpress/events/august-event__trashed/</guid>
      </item>
      <item>
         <title>September event</title>
         <link>https://glotpress.test/glotpress/events/september-event/</link>
         <description>Lorem ipsum</description>
         <enclosure url="https://glotpress.test/glotpress/events/image/532/" type="image/png" length="1200" />
         <pubDate>Thu, 09 May 2024 10:15:59 +0000</pubDate>
         <ev:startdate>2024-08-31T22:01:00+00:00</ev:startdate>
         <ev:enddate>2024-09-30T21:59:00+00:00</ev:enddate>
         <guid>https://glotpress.test/glotpress/events/september-event/</guid>
      </item>
   </channel>
</rss>

Fixes #217.

@amieiro
Add a new class to create the RSS 2.0 feed
9556e9e
@amieiro
Add the RSS class to the autoload
d11f365
@amieiro
Ad two routes to get the RSS feed
a896bef
@amieiro
Add a new method to the event repository to get all the events
d852812
@amieiro
Add the pub_date calculation for the RSS feed
7a010fa
@amieiro
Add the lsat_build_date calculation for the RSS feed
3afdaeb
@amieiro
Add the atom:link in the header
8752469
@amieiro
Add the image, the pubDate and update the guid to each item
36558f3
@amieiro
Solve small problems with the W3C validation
b0b0a41
@amieiro
Add some escaping functions
d0043af
@amieiro
Change the get_all_events method to get_current_and_upcoming_events
59985f3 
We only need the events that are currently active or happening in the future.
@amieiro
Add the http://purl.org/rss/1.0/modules/event/ namespace to be able t…
0a7cdd2 
…o have startdate and enddate in each event
@amieiro
Merge the pubDate and lastBuildDate methods
0d74768 
As we use the same date (last time we update some event), I merge both
methods in one.
@amieiro amieiro marked this pull request as ready for review July 5, 2024 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@psrpinto psrpinto Awaiting requested review from psrpinto

@trymebytes trymebytes Awaiting requested review from trymebytes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create an RSS Feed of events
1 participant
@amieiro