Merge branch 'bobbrez/add-simple-georss' of https://github.com/bobbrez/python-feedgen

feedgen/ext/geo.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+'''
+    feedgen.ext.geo
+    ~~~~~~~~~~~~~~~~~~~
+
+    Extends the FeedGenerator to produce Simple GeoRSS feeds.
+
+    :copyright: 2017, Bob Breznak <bob.breznak@gmail.com>
+
+    :license: FreeBSD and LGPL, see license.* for more details.
+'''
+
+from feedgen.ext.base import BaseExtension
+
+class GeoExtension(BaseExtension):
+    '''FeedGenerator extension for Simple GeoRSS.
+    '''
+
+    def extend_ns(self):
+        return { 'georss' : 'http://www.georss.org/georss' }

feedgen/ext/geo_entry.py

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+'''
+    feedgen.ext.geo_entry
+    ~~~~~~~~~~~~~~~~~~~
+
+    Extends the FeedGenerator to produce Simple GeoRSS feeds.
+
+    :copyright: 2017, Bob Breznak <bob.breznak@gmail.com>
+
+    :license: FreeBSD and LGPL, see license.* for more details.
+'''
+
+from lxml import etree
+from feedgen.ext.base import BaseEntryExtension
+
+class GeoEntryExtension(BaseEntryExtension):
+    '''FeedEntry extension for Simple GeoRSS.
+    '''
+
+    def __init__(self):
+        # Simple GeoRSS tag
+        self.__point = None
+
+    def extend_file(self, entry):
+        '''Add additional fields to an RSS item.
+
+        :param feed: The RSS item XML element to use.
+        '''
+
+        GEO_NS = 'http://www.georss.org/georss'
+
+        if self.__point:
+            point = etree.SubElement(entry, '{%s}point' % GEO_NS)
+            point.text = self.__point
+
+        return entry
+
+    def extend_rss(self, entry):
+        return self.extend_file(entry)
+
+    def extend_atom(self, entry):
+        return self.extend_file(entry)
+
+    def point(self, point=None):
+        '''Get or set the georss:point of the entry.
+
+        :param point: The GeoRSS formatted point (i.e. "42.36 -71.05")
+        :returns: The author of the podcast.
+        '''
+
+        if point is not None:
+            self.__point = point
+
+        return self.__point

tests/test_extension.py

@@ -136,6 +136,29 @@ class TestExtensionPodcast(unittest.TestCase):
                             namespaces=ns)
         assert author == ['Lars Kiesow']
 
+class TestExtensionGeo(unittest.TestCase):
+
+    def setUp(self):
+        self.fg = FeedGenerator()
+        self.fg.load_extension('geo')
+        self.fg.title('title')
+        self.fg.link(href='http://example.com', rel='self')
+        self.fg.description('description')
+
+    def test_geoEntryItems(self):
+        fe = self.fg.add_item()
+        fe.title('y')
+        fe.geo.point('42.36 -71.05')
+
+        assert fe.geo.point() == '42.36 -71.05'
+
+        # Check that we have the item in the resulting XML
+        ns = {'georss': 'http://www.georss.org/georss'}
+        root = etree.fromstring(self.fg.rss_str())
+        point = root.xpath('/rss/channel/item/georss:point/text()',
+                            namespaces=ns)
+        assert point == ['42.36 -71.05']
+
 
 class TestExtensionDc(unittest.TestCase):