splitting and refactoring the Restful api part

4 files changed, 344 insertions, 0 deletions

diff --git a/pyaggr3g470r/views/api/__init__.py b/pyaggr3g470r/views/api/__init__.py
new file mode 100644
index 00000000..e11cdd95
--- /dev/null
+++ b/pyaggr3g470r/views/api/__init__.py
@@ -0,0 +1,31 @@
+#! /usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# pyAggr3g470r - A Web based news aggregator.
+# Copyright (C) 2010-2015  Cédric Bonhomme - http://cedricbonhomme.org/
+#
+# For more information : https://bitbucket.org/cedricbonhomme/pyaggr3g470r/
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+__author__ = "Cedric Bonhomme"
+__version__ = "$Revision: 0.2 $"
+__date__ = "$Date: 2014/06/18 $"
+__revision__ = "$Date: 2014/07/05 $"
+__copyright__ = "Copyright (c) Cedric Bonhomme"
+__license__ = "AGPLv3"
+
+from pyaggr3g470r.views.api import article, feed
+
+__all__ = ['article', 'feed']
diff --git a/pyaggr3g470r/views/api/article.py b/pyaggr3g470r/views/api/article.py
new file mode 100644
index 00000000..c509b0a8
--- /dev/null
+++ b/pyaggr3g470r/views/api/article.py
@@ -0,0 +1,125 @@
+import re
+import dateutil.parser
+
+import conf
+if not conf.ON_HEROKU:
+    import pyaggr3g470r.search as fastsearch
+
+from flask import request, g
+from flask.ext.restful import Resource, reqparse
+
+from pyaggr3g470r import api, db
+from pyaggr3g470r.models import Article, Feed
+from pyaggr3g470r.views.api.common import authenticate, to_response, \
+                                          PyAggResource
+
+
+class ArticleListAPI(Resource):
+    """
+    Defines a RESTful API for Article elements.
+    """
+    method_decorators = [authenticate, to_response]
+
+    def __init__(self):
+        self.reqparse = reqparse.RequestParser()
+        self.reqparse.add_argument('title', type=unicode, location='json')
+        self.reqparse.add_argument('content', type=unicode, location='json')
+        self.reqparse.add_argument('link', type=unicode, location='json')
+        self.reqparse.add_argument('date', type=str, location='json')
+        self.reqparse.add_argument('feed_id', type=int, location='json')
+        super(ArticleListAPI, self).__init__()
+
+    def get(self):
+        """
+        Returns a list of articles.
+        """
+        feeds = {feed.id: feed.title for feed in g.user.feeds if feed.enabled}
+        articles = Article.query.filter(Article.feed_id.in_(feeds.keys()),
+                                        Article.user_id == g.user.id)
+        filter_ = request.args.get('filter_', 'unread')
+        feed_id = int(request.args.get('feed', 0))
+        limit = request.args.get('limit', 1000)
+        if filter_ != 'all':
+            articles = articles.filter(Article.readed == (filter_ == 'read'))
+        if feed_id:
+            articles = articles.filter(Article.feed_id == feed_id)
+
+        articles = articles.order_by(Article.date.desc())
+        if limit != 'all':
+            limit = int(limit)
+            articles = articles.limit(limit)
+
+        return {'result': [article.dump() for article in articles]}
+
+    def post(self):
+        """
+        POST method - Create a new article.
+        """
+        args = self.reqparse.parse_args()
+        article_dict = {}
+        for k, v in args.iteritems():
+            if v != None:
+                article_dict[k] = v
+            else:
+                return {"message": "Missing argument: %s." % (k,)}, 400
+        article_date = None
+        try:
+            article_date = dateutil.parser.parse(article_dict["date"], dayfirst=True)
+        except:
+            try:  # trying to clean date field from letters
+                article_date = dateutil.parser.parse(re.sub('[A-z]', '', article_dict["date"], dayfirst=True))
+            except:
+                return {"message": "Bad format for the date."}, 400
+        article = Article(link=article_dict["link"], title=article_dict["title"],
+                                content=article_dict["content"], readed=False, like=False,
+                                date=article_date, user_id=g.user.id,
+                                feed_id=article_dict["feed_id"])
+        feed = Feed.query.filter(Feed.id == article_dict["feed_id"], Feed.user_id == g.user.id).first()
+        feed.articles.append(article)
+        try:
+            db.session.commit()
+            return {"message": "ok"}, 201
+        except:
+            return {"message": "Impossible to create the article."}, 500
+
+
+class ArticleAPI(PyAggResource):
+    "Defines a RESTful API for Article elements."
+    method_decorators = [authenticate, to_response]
+    db_cls = Article
+
+    def __init__(self):
+        self.reqparse = reqparse.RequestParser()
+        self.reqparse.add_argument('like', type=bool, location='json')
+        self.reqparse.add_argument('readed', type=bool, location= 'json')
+        super(ArticleAPI, self).__init__()
+
+    def get(self, id):
+        article = self._get_or_raise(id)
+        if not article.readed:
+            article.readed = True
+            db.session.commit()
+        return {'result': [article.dump()]}
+
+    def put(self, id):
+        """ Update an article. It is only possible to update the status
+        ('like' and 'readed') of an article."""
+        args = self.reqparse.parse_args()
+        article = self._get_or_raise(id)
+        if 'like' in args:
+            article.like = args['like']
+        if 'readed' in args:
+            article.readed = args['readed']
+        db.session.commit()
+
+        try:
+            fastsearch.delete_article(g.user.id, article.feed_id, article.id)
+        except:
+            pass
+        return {"message": "ok"}
+
+
+api.add_resource(ArticleListAPI, '/api/v1.0/articles',
+                 endpoint='articles.json')
+api.add_resource(ArticleAPI, '/api/v1.0/articles/<int:id>',
+                 endpoint='article.json')
diff --git a/pyaggr3g470r/views/api/common.py b/pyaggr3g470r/views/api/common.py
new file mode 100644
index 00000000..872c4ae1
--- /dev/null
+++ b/pyaggr3g470r/views/api/common.py
@@ -0,0 +1,79 @@
+from functools import wraps
+from flask import request, g, session, Response, jsonify
+from flask.ext.restful import Resource
+
+from pyaggr3g470r import db
+from pyaggr3g470r.models import User
+
+
+class HttpError(Exception):
+    pass
+
+
+def authenticate(func):
+    """
+    Decorator for the authentication to the web services.
+    """
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        if not getattr(func, 'authenticated', True):
+            return func(*args, **kwargs)
+
+        # authentication based on the session (already logged on the site)
+        if 'email' in session or g.user.is_authenticated():
+            return func(*args, **kwargs)
+
+        # authentication via HTTP only
+        auth = request.authorization
+        try:
+            email = auth.username
+            user = User.query.filter(User.email == email).first()
+            if user and user.check_password(auth.password) and user.activation_key == "":
+                g.user = user
+                return func(*args, **kwargs)
+        except AttributeError:
+            pass
+
+        return Response('<Authentication required>', 401,
+                        {'WWWAuthenticate':'Basic realm="Login Required"'})
+    return wrapper
+
+
+def to_response(func):
+    def wrapper(*args, **kwargs):
+        try:
+            res = func(*args, **kwargs)
+        except HttpError, error:
+            return Response(*error.args)
+        if isinstance(res, tuple):
+            response = jsonify(**res[0])
+            if len(res) > 1:
+                response.status_code = res[1]
+            return response
+        return res
+    return wrapper
+
+
+class PyAggResource(Resource):
+    db_cls = None
+
+    def _get_or_raise(self, obj_id=None):
+        if obj_id is None:
+            raise HttpError({'message': 'No id given'}, 400)
+        obj = self.db_cls.query.filter(self.db_cls.id == obj_id).first()
+        if obj is None:
+            raise HttpError({'message': 'Article not found'}, 404)
+        if obj.user_id != g.user.id:
+            raise HttpError({'message': "Unauthorized for %s."
+                                    % self.db_cls.__class__.__name__}, 403)
+        return obj
+
+    def get(self, id=None):
+        return {'result': [self._get_or_raise(id).dump()]}
+
+    def delete(self, id):
+        """Delete a feed."""
+        feed = self._get_or_raise(id)
+        db.session.delete(feed)
+        db.session.commit()
+        return {"message": "ok"}, 204
diff --git a/pyaggr3g470r/views/api/feed.py b/pyaggr3g470r/views/api/feed.py
new file mode 100644
index 00000000..e5937128
--- /dev/null
+++ b/pyaggr3g470r/views/api/feed.py
@@ -0,0 +1,109 @@
+from flask import g
+from flask.ext.restful import Resource, reqparse
+
+from pyaggr3g470r import api, db
+from pyaggr3g470r.models import Feed
+
+from pyaggr3g470r.views.api.common import authenticate, to_response, \
+                                          PyAggResource
+
+
+class FeedListAPI(Resource):
+    """
+    Defines a RESTful API for Feed elements.
+    """
+    method_decorators = [authenticate, to_response]
+
+    def __init__(self):
+        self.reqparse = reqparse.RequestParser()
+        self.reqparse.add_argument('title',
+                                   type=unicode, default="", location='json')
+        self.reqparse.add_argument('description',
+                                   type=unicode, default="", location='json')
+        self.reqparse.add_argument('link', type=unicode, location='json')
+        self.reqparse.add_argument('site_link',
+                                   type=unicode, default="", location='json')
+        self.reqparse.add_argument('email_notification',
+                                   type=bool, default=False, location='json')
+        self.reqparse.add_argument('enabled',
+                                   type=bool, default=True, location='json')
+        super(FeedListAPI, self).__init__()
+
+    def get(self):
+        """
+        Returns a list of feeds.
+        """
+        return {'result': [{"id": feed.id,
+                            "title": feed.title,
+                            "description": feed.description,
+                            "link": feed.link,
+                            "site_link": feed.site_link,
+                            "email_notification": feed.email_notification,
+                            "enabled": feed.enabled,
+                            "created_date": feed.created_date,
+                           } for feed in g.user.feeds]}
+
+    def post(self):
+        """
+        POST method - Create a new feed.
+        """
+        args = self.reqparse.parse_args()
+        feed_dict = {}
+        for k, v in args.iteritems():
+            if v != None:
+                feed_dict[k] = v
+            else:
+                return {'message': 'missing argument: %s' % (k,)}, 400
+        new_feed = Feed(title=feed_dict["title"],
+                        description=feed_dict["description"],
+                        link=feed_dict["link"],
+                        site_link=feed_dict["site_link"],
+                        email_notification=feed_dict["email_notification"],
+                        enabled=feed_dict["enabled"])
+        g.user.feeds.append(new_feed)
+        try:
+            db.session.commit()
+            return {"message": "ok"}
+        except:
+            return {'message': 'Impossible to create the feed.'}, 500
+
+
+class FeedAPI(PyAggResource):
+    "Defines a RESTful API for Feed elements."
+    method_decorators = [authenticate, to_response]
+    db_cls = Feed
+
+    def __init__(self):
+        self.reqparse = reqparse.RequestParser()
+        self.reqparse.add_argument('title', type=unicode, location='json')
+        self.reqparse.add_argument('description',
+                                   type=unicode, location='json')
+        self.reqparse.add_argument('link', type=unicode, location='json')
+        self.reqparse.add_argument('site_link', type=unicode, location='json')
+        self.reqparse.add_argument('email_notification',
+                                   type=bool, location='json')
+        self.reqparse.add_argument('enabled', type=bool ,location='json')
+        super(FeedAPI, self).__init__()
+
+    def put(self, id):
+        "Update a feed"
+        args = self.reqparse.parse_args()
+        feed = self.get_feed_or_raise(id)
+        if 'title' in args:
+            feed.title = args['title']
+        if 'description' in args:
+            feed.description = args['description']
+        if 'link' in args:
+            feed.link = args['link']
+        if 'site_link' in args:
+            feed.site_link = args['site_link']
+        if 'email_notification' in args:
+            feed.email_notification = args['email_notification']
+        if 'enabled' in args:
+            feed.enabled = args['enabled']
+        db.session.commit()
+        return {"message": "ok"}
+
+
+api.add_resource(FeedListAPI, '/api/v1.0/feeds', endpoint = 'feeds.json')
+api.add_resource(FeedAPI, '/api/v1.0/feeds/<int:id>', endpoint = 'feed.json')