Add support for news panel (#419)

* Add support for news panel

* Fix linting

Author: JamesGibo

CHANGELOG.rst

@@ -12,6 +12,7 @@ x.x.x (TBD)
 * Added StateTimeline panel which was added in Grafana v8
 * Added support for timeseries panel added in Grafana v8
 * Added MinMetricAgg and PercentilesMetricAgg to Elasticsearch
+* Added support for News panel
 * Added support for Pie Chart v2 from Grafana v8
 
 Changes

grafanalib/core.py

@@ -95,6 +95,7 @@ def to_json_data(self):
 PIE_CHART_V2_TYPE = 'piechart'
 TIMESERIES_TYPE = 'timeseries'
 WORLD_MAP_TYPE = 'grafana-worldmap-panel'
+NEWS_TYPE = 'news'
 
 DEFAULT_FILL = 1
 DEFAULT_REFRESH = '10s'
@@ -3397,3 +3398,29 @@ def to_json_data(self):
                 'type': STATE_TIMELINE_TYPE,
             }
         )
+
+
+@attr.s
+class News(Panel):
+    """Generates News panel json structure
+    Grafana docs on State Timeline panel: https://grafana.com/docs/grafana/next/visualizations/news-panel/
+
+    :param feedUrl: URL to query, only RSS feed formats are supported (not Atom).
+    :param showImage: Controls if the news item social (og:image) image is shown above text content
+    :param useProxy: If the feed is unable to connect, consider a CORS proxy
+    """
+    feedUrl = attr.ib(default='', validator=instance_of(str))
+    showImage = attr.ib(default=True, validator=instance_of(bool))
+    useProxy = attr.ib(default=False, validator=instance_of(bool))
+
+    def to_json_data(self):
+        return self.panel_json(
+            {
+                'options': {
+                    'feedUrl': self.feedUrl,
+                    'showImage': self.showImage,
+                    'useProxy': self.useProxy
+                },
+                'type': NEWS_TYPE,
+            }
+        )

grafanalib/tests/test_core.py

@@ -504,6 +504,15 @@ def test_timeseries():
     assert data['title'] == title
 
 
+def test_news():
+    title = 'dummy title'
+    feedUrl = "www.example.com"
+    news = G.News(title=title, feedUrl=feedUrl)
+    data = news.to_json_data()
+    assert data['options']['feedUrl'] == feedUrl
+    assert data['title'] == title
+
+
 def test_pieChartv2():
     data_source = 'dummy data source'
     targets = ['dummy_prom_query']