aboutsummaryrefslogtreecommitdiff
path: root/pyaggr3g470r/rest.py
blob: e2cb92e54cf6f567f80362e1a729220febeae54c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
#! /usr/bin/env python
# -*- coding: utf-8 -*-

# pyAggr3g470r - A Web based news aggregator.
# Copyright (C) 2010-2014  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.1 $"
__date__ = "$Date: 2014/06/18 $"
__revision__ = "$Date: 2014/06/18 $"
__copyright__ = "Copyright (c) Cedric Bonhomme"
__license__ = "AGPLv3"

import re
import dateutil.parser
from functools import wraps
from flask import g, Response, request, session, jsonify
from flask.ext.restful import Resource, reqparse
#from flask.ext.restful.inputs import boolean

import conf
if not conf.ON_HEROKU:
    import search as fastsearch
from pyaggr3g470r import api, db
from pyaggr3g470r.models import User, Article, Feed

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

class ArticleListAPI(Resource):
    """
    Defines a RESTful API for Article elements.
    """
    method_decorators = [authenticate]

    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 jsonify(result= [{
                                    "id": article.id,
                                    "title": article.title,
                                    "link": article.link,
                                    "content": article.content,
                                    "readed": article.readed,
                                    "like": article.like,
                                    "date": article.date,
                                    "retrieved_date": article.retrieved_date,
                                    "feed_id": article.source.id,
                                    "feed_name": article.source.title
                                }
                                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,)}
        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"}
        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)
        db.session.commit()
        return {"message":"ok"}

class ArticleAPI(Resource):
    """
    Defines a RESTful API for Article elements.
    """
    method_decorators = [authenticate]

    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=None):
        """
        Returns an article.
        """
        result = []
        if id is not None:
            article = Article.query.filter(Article.user_id == g.user.id, Article.id == id).first()
            if article is not None:
                if not article.readed:
                    article.readed = True
                    db.session.commit()
                result.append(article)

        return jsonify(result= [{
                                    "id": article.id,
                                    "title": article.title,
                                    "link": article.link,
                                    "content": article.content,
                                    "readed": article.readed,
                                    "like": article.like,
                                    "date": article.date,
                                    "retrieved_date": article.retrieved_date,
                                    "feed_id": article.source.id,
                                    "feed_name": article.source.title
                                }
                                for article in result]
                        )

    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 = Article.query.filter(Article.id == id).first()
        if article is not None and article.source.subscriber.id == g.user.id:
            if None is not args.get('like', None):
                article.like = args['like']
            if None is not args.get('readed', None):
                article.readed = args['readed']
            db.session.commit()

            try:
                fastsearch.delete_article(g.user.id, article.feed_id, article.id)
            except:
                pass

            return {"message":"ok"}
        else:
            response = jsonify({'code': 404, 'message': 'Article not found'})
            response.status_code = 404
            return response

    def delete(self, id):
        """
        Delete an article.
        """
        article = Article.query.filter(Article.id == id).first()
        if article is not None and article.source.subscriber.id == g.user.id:
            db.session.delete(article)
            db.session.commit()
            return {"message":"ok"}
        else:
            response = jsonify({'code': 404, 'message': 'Article not found'})
            response.status_code = 404
            return response

api.add_resource(ArticleListAPI, '/api/v1.0/articles', endpoint = 'articles.json')
api.add_resource(ArticleAPI, '/api/v1.0/articles/<int:id>', endpoint = 'article.json')

class FeedListAPI(Resource):
    """
    Defines a RESTful API for Feed elements.
    """
    method_decorators = [authenticate]

    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(FeedListAPI, self).__init__()

    def get(self):
        """
        Returns a list of feeds.
        """
        return jsonify(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,
                                    "nb_articles": feed.articles.count()
                                }
                                for feed in g.user.feeds]
                        )

    def post(self):
        """
        POST method - Create a new feed.
        """
        pass

class FeedAPI(Resource):
    """
    Defines a RESTful API for Feed elements.
    """
    method_decorators = [authenticate]

    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(FeedAPI, self).__init__()

    def get(self, id=None):
        """
        Returns a feed.
        """
        result = []
        if id is not None:
            feed = Feed.query.filter(Feed.id == id, Feed.user_id == g.user.id).first()
            if feed is not None:
                result.append(feed)

        return jsonify(result= [{
                                    "id": feed.id,
                                    "title": feed.title,
                                    "description": feed.description,
                                    "link": feed.link,
                                    "site_link": feed.site_link
                                }
                                for feed in result]
                        )

    def put(self, id):
        """
        Update a feed.
        """
        pass

    def delete(self, id):
        """
        Delete a feed.
        """
        feed = Feed.query.filter(Feed.id == id, Feed.user_id == g.user.id).first()
        if feed is not None:
            db.session.delete(feed)
            db.session.commit()
            return {"message":"ok"}
        else:
            response = jsonify({'code': 404, 'message': 'Feed not found'})
            response.status_code = 404
            return response

api.add_resource(FeedListAPI, '/api/v1.0/feeds', endpoint = 'feeds.json')
api.add_resource(FeedAPI, '/api/v1.0/feeds/<int:id>', endpoint = 'feed.json')
bgstack15