initial rss 2.0 support

Author: jmoiron

README.md

@@ -4,5 +4,7 @@ Usage:
 
 ```golang
 
+import "syndicate"
+
 ```
 

atom.go

@@ -11,55 +11,50 @@ import (
 
 const ns = "http://www.w3.org/2005/Atom"
 
-type atomSummary struct {
+type AtomSummary struct {
 	S    string `xml:",chardata"`
 	Type string `xml:"type,attr"`
 }
 
-type atomEntry struct {
+type AtomEntry struct {
 	XMLName xml.Name `xml:"entry"`
 	Title   string   `xml:"title"`
-	Link    *atomLink
+	Link    *AtomLink
 	Updated string       `xml:"updated"`
 	Id      string       `xml:"id"`
-	Summary *atomSummary `xml:"summary"`
+	Summary *AtomSummary `xml:"summary,omitempty"`
 }
 
-type atomLink struct {
+type AtomLink struct {
 	XMLName xml.Name `xml:"link"`
 	Href    string   `xml:"href,attr"`
-	Rel     string   `xml:"rel,attr"`
+	Rel     string   `xml:"rel,attr,omitempty"`
 }
 
-type atomFeed struct {
+type AtomFeed struct {
 	XMLName xml.Name `xml:"feed"`
 	Ns      string   `xml:"xmlns,attr"`
 	Title   string   `xml:"title"`
-	Link    *atomLink
-	Id      string `xml:"id"`
+	Link    *AtomLink
+	Id      string `xml:"id,omitempty"`
 	Updated string `xml:"updated"`
-	Entries []*atomEntry
+	Summary string `xml:"summary,omitempty"`
+	Entries []*AtomEntry
 }
 
 type Atom struct {
 	*Feed
 }
 
-func newAtomEntry(i *Item) *atomEntry {
+func newAtomEntry(i *Item) *AtomEntry {
 	id := i.Id
 	// assume the description is html
-	s := &atomSummary{i.Description, "html"}
+	s := &AtomSummary{i.Description, "html"}
 
-	// try to get a single timestamp, since we only have one  in atom 
-	ts := i.Updated
-	if ts.IsZero() {
-		ts = i.Created
-	}
-	// <id>tag:blog.kowalczyk.info,2012-09-11:/item/1.html</id>
 	if len(id) == 0 {
 		// if there's no id set, try to create one, either from data or just a uuid
 		if len(i.Link.Href) > 0 && (!i.Created.IsZero() || !i.Updated.IsZero()) {
-			dateStr := ts.Format("2006-01-02")
+			dateStr := anyTimeFormat("2006-01-02", i.Updated, i.Created)
 			host, path := i.Link.Href, "/invalid.html"
 			if url, err := url.Parse(i.Link.Href); err == nil {
 				host, path = url.Host, url.Path
@@ -69,29 +64,27 @@ func newAtomEntry(i *Item) *atomEntry {
 			id = "urn:uuid:" + NewUUID().String()
 		}
 	}
-	x := &atomEntry{
+	x := &AtomEntry{
 		Title:   i.Title,
-		Link:    &atomLink{Href: i.Link.Href, Rel: i.Link.Rel},
+		Link:    &AtomLink{Href: i.Link.Href, Rel: i.Link.Rel},
 		Summary: s,
 		Id:      id,
 		Updated: i.Updated.Format(time.RFC3339)}
 	return x
 }
 
 func (a *Atom) FeedXml() interface{} {
-	ts := a.Updated
-	if ts.IsZero() {
-		ts = a.Created
-	}
-	feed := &atomFeed{
+	updated := anyTimeFormat(time.RFC3339, a.Updated, a.Created)
+	feed := &AtomFeed{
 		Ns:      ns,
 		Title:   a.Title,
-		Link:    &atomLink{Href: a.Link.Href, Rel: a.Link.Rel},
+		Link:    &AtomLink{Href: a.Link.Href, Rel: a.Link.Rel},
+		Summary: a.Description,
 		Id:      a.Link.Href,
-		Updated: ts.Format(time.RFC3339)}
+		Updated: updated,
+	}
 	for _, e := range a.Items {
 		feed.Entries = append(feed.Entries, newAtomEntry(e))
 	}
-
 	return feed
 }

feed.go

@@ -2,18 +2,15 @@ package syndicate
 
 import (
 	"encoding/xml"
-	"fmt"
 	"time"
 )
 
 type Link struct {
-	Href string
-	Rel  string
+	Href, Rel string
 }
 
 type Author struct {
-	Name  string
-	Email string
+	Name, Email string
 }
 
 type Item struct {
@@ -42,6 +39,16 @@ func (f *Feed) Add(item *Item) {
 	f.Items = append(f.Items, item)
 }
 
+// returns the first non-zero time formatted as a string or "" 
+func anyTimeFormat(format string, times ...time.Time) string {
+	for _, t := range times {
+		if !t.IsZero() {
+			return t.Format(format)
+		}
+	}
+	return ""
+}
+
 type XmlFeed interface {
 	FeedXml() interface{}
 }
@@ -62,14 +69,7 @@ func (f *Feed) ToAtom() (string, error) {
 	return ToXML(a)
 }
 
-func (f *Feed) ToRss(version ...float64) (string, error) {
-	vers := 2.0
-	if len(version) > 0 {
-		vers = version[0]
-	}
-	/*
-		r := &RssFeed{f}
-		return ToXML(r)
-	*/
-	return fmt.Sprint(vers), nil
+func (f *Feed) ToRss() (string, error) {
+	r := &Rss{f}
+	return ToXML(r)
 }

feed_test.go

@@ -16,4 +16,5 @@ func TestFeed(t *testing.T) {
 	}
 
 	fmt.Println(feed.ToAtom())
+	fmt.Println(feed.ToRss())
 }

rss.go

@@ -1 +1,99 @@
 package syndicate
+
+import (
+	"encoding/xml"
+	"fmt"
+	//"net/url"
+	"time"
+)
+
+type RssFeed struct {
+	XMLName xml.Name `xml:"rss"`
+	Version string   `xml:"version,attr"`
+	Channel *RssChannel
+}
+
+type RssChannel struct {
+	XMLName        xml.Name `xml:"channel"`
+	Title          string   `xml:"title"`       // required
+	Link           string   `xml:"link"`        // required
+	Description    string   `xml:"description"` // required
+	Language       string   `xml:"language,omitempty"`
+	Copyright      string   `xml:"copyright,omitempty"`
+	ManagingEditor string   `xml:"managingEditor,omitempty"` // Author used
+	WebMaster      string   `xml:"webMaster,omitempty"`
+	PubDate        string   `xml:"pubDate,omitempty"`       // created or updated
+	LastBuildDate  string   `xml:"lastBuildDate,omitempty"` // updated used
+	Category       string   `xml:"category,omitempty"`
+	Generator      string   `xml:"generator,omitempty"`
+	Docs           string   `xml:"docs,omitempty"`
+	Cloud          string   `xml:"cloud,omitempty"`
+	Ttl            string   `xml:"ttl,omitempty"`
+	Image          string   `xml:"image,omitempty"`
+	Rating         string   `xml:"rating,omitempty"`
+	TextInput      string   `xml:"textInput,omitempty"`
+	SkipHours      string   `xml:"skipHours,omitempty"`
+	SkipDays       string   `xml:"skipDays,omitempty"`
+	Items          []*RssItem
+}
+
+type RssItem struct {
+	XMLName     xml.Name `xml:"item"`
+	Title       string   `xml:"title"`       // required
+	Link        string   `xml:"link"`        // required
+	Description string   `xml:"description"` // required
+	Author      string   `xml:"author,omitempty"`
+	Category    string   `xml:"category,omitempty"`
+	Comments    string   `xml:"comments,omitempty"`
+	Enclosure   *RssEnclosure
+	Guid        string `xml:"guid,omitempty"`    // Id used
+	PubDate     string `xml:"pubDate,omitempty"` // created or updated
+	Source      string `xml:"source,omitempty"`
+}
+
+type RssEnclosure struct {
+	XMLName xml.Name `xml:"enclosure"`
+	Url     string   `xml:"url,attr"`
+	Length  string   `xml:"length,attr"`
+	Type    string   `xml:"type,attr"`
+}
+
+type Rss struct {
+	*Feed
+}
+
+func newRssItem(i *Item) *RssItem {
+	item := &RssItem{
+		Title:       i.Title,
+		Link:        i.Link.Href,
+		Description: i.Description,
+		Guid:        i.Id,
+	}
+	return item
+}
+
+func (r *Rss) FeedXml() interface{} {
+	// only generate version 2.0 feeds for now
+	pub := anyTimeFormat(time.RFC3339, r.Created, r.Updated)
+	build := anyTimeFormat(time.RFC3339, r.Updated)
+	author := r.Author.Email
+	if len(r.Author.Name) > 0 {
+		author = fmt.Sprintf("%s (%s)", r.Author.Email, r.Author.Name)
+	}
+	feed := &RssFeed{
+		Version: "2.0",
+		Channel: &RssChannel{
+			Title:          r.Title,
+			Link:           r.Link.Href,
+			Description:    r.Description,
+			ManagingEditor: author,
+			PubDate:        pub,
+			LastBuildDate:  build,
+		},
+	}
+	for _, i := range r.Items {
+		feed.Channel.Items = append(feed.Channel.Items, newRssItem(i))
+	}
+	return feed
+
+}

uuid.go

@@ -9,6 +9,7 @@ import (
 
 type UUID [16]byte
 
+// create a new uuid v4
 func NewUUID() *UUID {
 	u := &UUID{}
 	_, err := rand.Read(u[:16])