-
Notifications
You must be signed in to change notification settings - Fork 16
/
api_v1.py
179 lines (135 loc) · 6.77 KB
/
api_v1.py
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
from flask import Blueprint, url_for, redirect
from portality.api.current import Api400Error
from portality.core import app
from portality.decorators import api_key_required, api_key_optional, write_required
from portality.lib import plausible
from portality.view import api_v3
blueprint = Blueprint('api_v1', __name__)
API_VERSION_NUMBER = '1.0.0'
# Google Analytics category for API events
GA_CATEGORY = app.config.get('GA_CATEGORY_API', 'API Hit')
GA_ACTIONS = app.config.get('GA_ACTIONS_API', {})
API_UNSUPPORTED_ERROR = "Version 1 is no longer supported."
# the API v1 is not supported anymore, this file handles api v2 requests:
# requests to articles are redirected to v2
# other requests raise the 400 Error
#######################################
# ARTICLES
@blueprint.route('/')
def api_v1_root():
return redirect(url_for('api_v3.api_spec'))
@blueprint.route('/docs')
def docs():
return redirect(url_for('doaj.docs'))
@blueprint.route('/search/articles/<path:search_query>')
def search_articles(search_query):
# Redirects are disabled https://github.com/DOAJ/doajPM/issues/2664
# return redirect(url_for('api_v3.search_articles', search_query=search_query))
return api_v3.search_articles(search_query)
@blueprint.route("/articles", methods=["POST"])
@api_key_required
@write_required(api=True)
@plausible.pa_event(GA_CATEGORY, action=GA_ACTIONS.get('create_article', 'Create article'))
def create_article():
# Redirects are disabled https://github.com/DOAJ/doajPM/issues/2664
# return redirect(url_for('api_v3.create_article', **request.args), code=301)
return api_v3.create_article()
@blueprint.route("/articles/<article_id>", methods=["GET"])
@api_key_optional
@plausible.pa_event(GA_CATEGORY, action=GA_ACTIONS.get('retrieve_article', 'Retrieve article'),
record_value_of_which_arg='article_id')
def retrieve_article(article_id):
# Redirects are disabled https://github.com/DOAJ/doajPM/issues/2664
# return redirect(url_for('api_v3.retrieve_article', article_id=article_id, **request.args), code=301)
return api_v3.retrieve_article(article_id)
@blueprint.route("/articles/<article_id>", methods=["PUT"])
@api_key_required
@write_required(api=True)
@plausible.pa_event(GA_CATEGORY, action=GA_ACTIONS.get('update_article', 'Update article'),
record_value_of_which_arg='article_id')
def update_article(article_id):
# Redirects are disabled https://github.com/DOAJ/doajPM/issues/2664
# return redirect(url_for('api_v3.update_article', article_id=article_id, **request.args), code=301)
return api_v3.update_article(article_id)
@blueprint.route("/articles/<article_id>", methods=["DELETE"])
@api_key_required
@write_required(api=True)
@plausible.pa_event(GA_CATEGORY, action=GA_ACTIONS.get('delete_article', 'Delete article'),
record_value_of_which_arg='article_id')
def delete_article(article_id):
# Redirects are disabled https://github.com/DOAJ/doajPM/issues/2664
# return redirect(url_for('api_v3.delete_article', article_id=article_id, **request.args), code=301)
return api_v3.delete_article(article_id)
@blueprint.route("/bulk/articles", methods=["POST"])
@api_key_required
@write_required(api=True)
@plausible.pa_event(GA_CATEGORY, action=GA_ACTIONS.get('bulk_article_create', 'Bulk article create'))
def bulk_article_create():
# Redirects are disabled https://github.com/DOAJ/doajPM/issues/2664
# return redirect(url_for('api_v3.bulk_article_create', **request.args), code=301)
return api_v3.bulk_article_create()
@blueprint.route("/bulk/articles", methods=["DELETE"])
@api_key_required
@write_required(api=True)
@plausible.pa_event(GA_CATEGORY, action=GA_ACTIONS.get('bulk_article_delete', 'Bulk article delete'))
def bulk_article_delete():
# Redirects are disabled https://github.com/DOAJ/doajPM/issues/2664
# return redirect(url_for('api_v3.bulk_article_delete', **request.args), code=301)
return api_v3.bulk_article_delete()
#######################################
# OTHER
@blueprint.route('/journals/<journal_id>', methods=['GET'])
@api_key_optional
@plausible.pa_event(GA_CATEGORY, action=GA_ACTIONS.get('retrieve_journal', 'Retrieve journal'),
record_value_of_which_arg='journal_id')
def retrieve_journal(journal_id):
raise Api400Error(API_UNSUPPORTED_ERROR)
@blueprint.route("/bulk/applications", methods=["POST"])
@api_key_required
@write_required(api=True)
@plausible.pa_event(GA_CATEGORY, action=GA_ACTIONS.get('bulk_application_create', 'Bulk application create'))
def bulk_application_create():
raise Api400Error(API_UNSUPPORTED_ERROR)
@blueprint.route("/bulk/applications", methods=["DELETE"])
@api_key_required
@write_required(api=True)
@plausible.pa_event(GA_CATEGORY, action=GA_ACTIONS.get('bulk_application_delete', 'Bulk application delete'))
def bulk_application_delete():
raise Api400Error(API_UNSUPPORTED_ERROR)
@blueprint.route("/applications", methods=["POST"])
@api_key_required
@write_required(api=True)
@plausible.pa_event(GA_CATEGORY, action=GA_ACTIONS.get('create_application', 'Create application'))
def create_application():
raise Api400Error(API_UNSUPPORTED_ERROR)
@blueprint.route("/applications/<application_id>", methods=["GET"])
@api_key_required
@plausible.pa_event(GA_CATEGORY, action=GA_ACTIONS.get('retrieve_application', 'Retrieve application'),
record_value_of_which_arg='application_id')
def retrieve_application(application_id):
raise Api400Error(API_UNSUPPORTED_ERROR)
@blueprint.route("/applications/<application_id>", methods=["PUT"])
@api_key_required
@write_required(api=True)
@plausible.pa_event(GA_CATEGORY, action=GA_ACTIONS.get('update_application', 'Update application'),
record_value_of_which_arg='application_id')
def update_application(application_id):
raise Api400Error(API_UNSUPPORTED_ERROR)
@blueprint.route("/applications/<application_id>", methods=["DELETE"])
@api_key_required
@write_required(api=True)
@plausible.pa_event(GA_CATEGORY, action=GA_ACTIONS.get('delete_application', 'Delete application'),
record_value_of_which_arg='application_id')
def delete_application(application_id):
raise Api400Error(API_UNSUPPORTED_ERROR)
@blueprint.route("/search/applications/<path:search_query>")
@api_key_required
@plausible.pa_event(GA_CATEGORY, action=GA_ACTIONS.get('search_applications', 'Search applications'),
record_value_of_which_arg='search_query')
def search_applications(search_query):
raise Api400Error(API_UNSUPPORTED_ERROR)
@blueprint.route('/search/journals/<path:search_query>')
@plausible.pa_event(GA_CATEGORY, action=GA_ACTIONS.get('search_journals', 'Search journals'),
record_value_of_which_arg='search_query')
def search_journals(search_query):
raise Api400Error(API_UNSUPPORTED_ERROR)