Unit tests, RSS Views, Item Revisions Trigger

.travis.yml

@@ -0,0 +1,27 @@
+# Programming language in concern, in this 
+# case python.
+language: python
+
+# Version of python used in the code
+python:
+  - "2.7"
+
+# command to install flask dependencies
+install:
+  - pip install -r requirements.txt
+
+# command to run tests
+script: nosetests -v
+
+# travis notification to irc
+notifications:
+  irc:
+    channels:
+      - "irc.freenode.net#wikidata-feed"
+    on_success: always # [always|never|change] # default: change
+    on_failure: always # [always|never|change] # default: always
+    template:
+      - "%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message}"
+      - "Change view : %{compare_url}"
+      - "Build details : %{build_url}"
+    use_notice: true

README.md

@@ -1,4 +1,4 @@
-# Wikipedia channel for IFTTT
+# Wikipedia and Wikidata channels for IFTTT
 
 An [IFTTT](https://ifttt.com/recipes) channel built for [Wikimedia Tool Labs](http://tools.wmflabs.org/).
 
@@ -13,6 +13,7 @@ It currently supports the following triggers:
  - Updates from user
  - Page added to category
  - Page updated in category
+ - Updates to an item
 
 # [WIP] Deploying to Wikimedia Labs
 
@@ -63,11 +64,11 @@ Disconnecting from madhuvishy@ifttt-staging.ifttt.eqiad.wmflabs... done.
 
 * To restart the service: `fab <staging|production> restart_ifttt`
 
-
 # License
 
 Copyright 2015 Ori Livneh <ori@wikimedia.org>,
-               Stephen LaPorte <stephen.laporte@gmail.com>
+               Stephen LaPorte <stephen.laporte@gmail.com>,
+               Alangi Derick <alangiderick@gmail.com>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

app.py

@@ -2,6 +2,6 @@
 
 from ifttt import app
 
-# if __name__ == '__main__':
-#     app.debug = True
-#     app.run(debug=True)
+if __name__ == '__main__':
+	app.debug = True
+	app.run(debug=True)

ifttt/__init__.py

@@ -4,7 +4,8 @@
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
   Copyright 2015 Ori Livneh <ori@wikimedia.org>,
-                 Stephen LaPorte <stephen.laporte@gmail.com>
+                 Stephen LaPorte <stephen.laporte@gmail.com>,
+                 Alangi Derick <alangiderick@gmail.com>
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -24,5 +25,5 @@
 reload(sys)
 sys.setdefaultencoding('utf-8')
 
-
 from .core import app
+from flask import Flask

ifttt/core.py

@@ -4,7 +4,8 @@
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
   Copyright 2015 Ori Livneh <ori@wikimedia.org>,
-                 Stephen LaPorte <stephen.laporte@gmail.com>
+                 Stephen LaPorte <stephen.laporte@gmail.com>,
+                 Alangi Derick <alangiderick@gmail.com>
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -21,7 +22,7 @@
 """
 
 import flask
-from flask import request
+from flask import request, render_template, g
 
 from .utils import snake_case
 from .triggers import (ArticleOfTheDay,
@@ -32,7 +33,8 @@
                        NewArticle,
                        NewHashtag,
                        NewCategoryMember,
-                       CategoryMemberRevisions)
+                       CategoryMemberRevisions,
+                       ItemRevisions)
 
 import logging
 LOG_FILE = 'ifttt.log'
@@ -50,11 +52,12 @@
                 NewArticle,
                 NewHashtag,
                 NewCategoryMember,
-                CategoryMemberRevisions]
+                CategoryMemberRevisions,
+                ItemRevisions]
 
 app = flask.Flask(__name__)
 # Load default config first
-app.config.from_pyfile('../default.cfg', silent=True)
+# app.config.from_pyfile('../default.cfg', silent=True)
 # Override defaults if ifttt.cfg is present
 app.config.from_pyfile('../ifttt.cfg', silent=True)
 
@@ -78,6 +81,8 @@ def force_content_type(response):
     """RFC 4627 stipulates that 'application/json' takes no charset parameter,
     but IFTTT expects one anyway. We have to twist Flask's arm to get it to
     break the spec."""
+    if g.get('skip_after_request'):
+        return response
     response.headers['Content-Type'] = 'application/json; charset=utf-8'
     return response
 
@@ -103,6 +108,20 @@ def test_setup():
     return flask.jsonify(data=ret)
 
 
+@app.route('/ifttt/v1/rss-feeds')
+def feeds():
+    """Returns a list of all feeds(triggers) for Wikipedia IFTTT."""
+    feeds = {'samples': {'feeds': {}}}
+    for feed in ALL_TRIGGERS:
+        feed_name = snake_case(feed.__name__)
+        feed_display_name = feed_name.replace("_", " ").capitalize()
+        if feed.default_fields:
+            feeds['samples']['feeds'][feed_display_name] = feed.default_fields
+
+    g.skip_after_request = True
+    return render_template('feeds.html', data=feeds)
+
+
 @app.route('/ifttt/v1/status')
 def status():
     """Return HTTP 200 and an empty body, as required by the IFTTT spec."""

ifttt/ifttt-tests.py

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+"""
+  Wikipedia channel for IFTTT
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+  Copyright 2015 Ori Livneh <ori@wikimedia.org>
+                 Stephen LaPorte <stephen.laporte@gmail.com>
+                 Alangi Derick <alangiderick@gmail.com>
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+"""
+
+import core, json, unittest
+
+from .utils import snake_case
+
+# Import all triggers in the app
+from .triggers import (ArticleOfTheDay,
+                       PictureOfTheDay,
+                       WordOfTheDay,
+                       ArticleRevisions,
+                       UserRevisions,
+                       NewArticle,
+                       NewHashtag,
+                       NewCategoryMember,
+                       CategoryMemberRevisions,
+                       ItemRevisions)
+
+# A list of triggers to be tested
+ALL_TRIGGERS = [ArticleOfTheDay,
+                PictureOfTheDay,
+                WordOfTheDay,
+                NewArticle,
+                ItemRevisions,
+                ArticleRevisions,
+                UserRevisions]
+
+app = core.app.test_client()
+
+def check_response(test_trigger):
+    """Checks the response to see if the data property of the trigger 
+    is greater than 3 after the request."""
+    RESP_TEST_VALUE = 3
+
+    resp = app.post('/ifttt/v1/triggers/%s' % test_trigger)
+
+    results = json.loads(resp.data)
+    assert len(results['data']) >= RESP_TEST_VALUE
+
+# Routine to test the triggers one after the other
+def test_for_triggers():
+    for trigger in ALL_TRIGGERS:
+        test_trigger = getattr(trigger, 'url_pattern', None)
+        if not test_trigger:
+            test_trigger = snake_case(trigger.__name__)
+        yield check_response, test_trigger

ifttt/templates/article_of_the_day.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0">
+    <channel>
+        <title>Article of the Day feeds</title>
+        <description>List of articles of the day for Wikipedia.</description>
+
+        <language>en-us</language>
+        {% for feeds in data %}
+            <item>
+                <pubDate>{{feeds.created_at}}</pubDate>
+                <guid>{{feeds.entry_id}}</guid>
+                <image>
+                    <url>{{feeds.media_url}}</url>
+                </image>
+                <description>{{feeds.summary}}</description>
+                <title>{{feeds.title}}</title>
+                <link>{{feeds.url}}</link>
+            </item>
+        {% endfor %}
+    </channel>
+</rss>

ifttt/templates/article_revisions.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0">
+    <channel>
+        <title>Article Revisions feeds</title>
+        <description>List of an article revisions for Wikipedia.</description>
+
+        <language>en-us</language>
+        {% for feeds in data %}
+            <item>
+                <comment>{{feeds.comment}}</comment>
+                <pubDate>{{feeds.created_at}}</pubDate>
+                <date>{{feeds.date}}</date>
+                <image>
+                    <url>{{feeds.media_url}}</url>
+                </image>
+                <size>{{feeds.size}}</size>
+                <title>{{feeds.title}}</title>
+                <link>{{feeds.url}}</link>
+                <user>{{feeds.user}}</user>
+            </item>
+        {% endfor %}
+    </channel>
+</rss>

ifttt/templates/feeds.html

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<title>Wikipedia Feeds</title>
+</head>
+<body>
+
+	<h1>Wikipedia RSS feeds for IFTTT</h1>
+	<ul>
+		{% for feed in data.samples.feeds %}
+			<li>{{ feed }}&nbsp;&nbsp;
+
+				{% if feed == "User revisions" %}
+					<a href="http://localhost:5000/ifttt/v1/triggers/{{feed.replace(" ","_").lower()}}?lang=en&user=Alangi_derick"><img src="{{url_for('static', filename='rss.png')}}" width="20px" height="20px"></a>
+
+				{% elif feed == "Article revisions" %}
+					<a href="http://localhost:5000/ifttt/v1/triggers/{{feed.replace(" ","_").lower()}}?lang=en&title=Coffee"><img src="{{url_for('static', filename='rss.png')}}" width="20px" height="20px"></a>
+
+				{% elif feed == "Item revisions" %}
+					<a href="http://localhost:5000/ifttt/v1/triggers/{{feed.replace(" ","_").lower()}}?lang=en&itemid=Q12345"><img src="{{url_for('static', filename='rss.png')}}" width="20px" height="20px"></a>
+
+				{% else %}
+					<a href="http://localhost:5000/ifttt/v1/triggers/{{feed.replace(" ","_").lower()}}?lang=en"><img src="{{url_for('static', filename='rss.png')}}" width="20px" height="20px"></a>
+				{% endif %}
+			</li><br />
+		{% endfor %}
+	</ul>
+
+</body>
+</html>

ifttt/templates/item_revisions.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0">
+    <channel>
+        <title>Wikidata Item revisions feed</title>
+        <description>List of a Wikidata item revisions.</description>
+
+        <language>en-us</language>
+        {% for feeds in data %}
+            <item>
+                <comment>{{feeds.comment}}</comment>
+                <pubDate>{{feeds.created_at}}</pubDate>
+                <date>{{feeds.date}}</date>
+                <image>
+                    <url>{{feeds.media_url}}</url>
+                </image>
+                <description>Size: {{feeds.size}}</description>
+                <url>{{feeds.url}}</url>
+                <title>{{feeds.item}}</title>
+                <guid>{{feeds.user}}</guid>
+            </item>
+        {% endfor %}
+    </channel>
+</rss>

ifttt/templates/new_article.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0">
+    <channel>
+        <title>New article feeds</title>
+        <description>List New articles for Wikipedia.</description>
+
+        <language>en-us</language>
+        {% for feeds in data %}
+            <item>
+                <comment>{{feeds.comment}}</comment>
+                <pubDate>{{feeds.created_at}}</pubDate>
+                <date>{{feeds.date}}</date>
+                <size>{{feeds.size}}</size>
+                <title>{{feeds.title}}</title>
+                <url>{{feeds.url}}</url>
+                <user>{{feeds.user}}</user>
+            </item>
+        {% endfor %}
+    </channel>
+</rss>

ifttt/templates/user_revisions.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0">
+    <channel>
+        <title>User revisions feed</title>
+        <description>List a user's revisions for Wikipedia.</description>
+
+        <language>en-us</language>
+        {% for feeds in data %}
+            <item>
+                <comment>{{feeds.comment}}</comment>
+                <pubDate>{{feeds.created_at}}</pubDate>
+                <date>{{feeds.date}}</date>
+                <image>
+                    <url>{{feeds.media_url}}</url>
+                </image>
+                <description>Size: {{feeds.size}}</description>
+                <url>{{feeds.url}}</url>
+                <title>{{feeds.title}}</title>
+                <guid>{{feeds.user}}</guid>
+            </item>
+        {% endfor %}
+    </channel>
+</rss>

ifttt/templates/word_of_the_day.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0">
+    <channel>
+        <title>Word of the Day feeds</title>
+        <description>List words of the day for Wikipedia.</description>
+
+        <language>en-us</language>
+        {% for feeds in data %}
+            <item>
+                <pubDate>{{feeds.created_at}}</pubDate>
+                <description>{{feeds.definition}}</description>
+                <guid>{{feeds.entry_id}}</guid>
+                <url>{{feeds.url}}</url>
+                <title>{{feeds.word}}</title>
+            </item>
+        {% endfor %}
+    </channel>
+</rss>