Support JSONP (by monkey-patching flask.jsonify).
ClosedPublic
Actions

Authored by ralph on Jun 4 2014, 9:31 PM.

Details

Reviewers

tflink
jskladan

Maniphest Tasks

T207: Support JSONP

Commits

rRSDB15fc32e2857b: Support JSONP (by monkey-patching flask.jsonify).

Summary

Monkey-patch flask.jsonify so that if a user specifies
?callback=callback in any URLs, then the results are returned as JSONP with
content type application/javascript.

This is needed by other web applications like Bodhi2 that want to query
resultsdb results from the clients' UI.

Fixes T207.

Test Plan

$ sudo yum install httpie

Start up resultsdb and then in another terminal run:

$ http get http://0.0.0.0:5000/api/v1.0
HTTP/1.0 404 NOT FOUND
Content-Length: 28
Content-Type: application/json
Date: Wed, 04 Jun 2014 21:30:19 GMT
Server: Werkzeug/0.9.4 Python/2.7.5

{
    "message": "Not found"
}

$ http get http://0.0.0.0:5000/api/v1.0\?callback\=wat
HTTP/1.0 404 NOT FOUND
Content-Length: 34
Content-Type: application/javascript
Date: Wed, 04 Jun 2014 21:30:26 GMT
Server: Werkzeug/0.9.4 Python/2.7.5

wat({
  "message": "Not found"
});

Diff Detail

Repository

rRSDB resultsdb

Branch

feature/jsonp

Lint

No Linters Available

Unit

No Unit Test Coverage

ralph retitled this revision from to Support JSONP (by monkey-patching flask.jsonify)..Jun 4 2014, 9:31 PM

ralph updated this object.

ralph edited the test plan for this revision. (Show Details)

ralph added reviewers: jskladan, tflink.

ralph added a task: T207: Support JSONP.

Herald added a subscriber: tflink. · View Herald TranscriptJun 4 2014, 9:31 PM

No objections here.

This revision is now accepted and ready to land.Jun 6 2014, 6:24 AM

I can't seem to get 'arc land' to work.. :/

Can someone else merge this one?

ralph closed this revision.Jun 9 2014, 3:09 PM

Nevermind -- got it. Thanks!

Revision Contents

			Path	Packages
M			resultsdb/__init__.py (16 lines)

Commit	Tree	Parents	Author	Summary	Date
73d2e524fcd5	a8ca4aa28089	1b0519529ae9	Ralph Bean	Support JSONP (by monkey-patching flask.jsonify). (Show More…)	Jun 4 2014, 9:23 PM

Diff 349

View Options

resultsdb/init.py

Show All 12 Lines
13	# You should have received a copy of the GNU General Public License along	13	# You should have received a copy of the GNU General Public License along
14	# with this program; if not, write to the Free Software Foundation, Inc.,	14	# with this program; if not, write to the Free Software Foundation, Inc.,
15	# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.	15	# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16	#	16	#
17	# Authors:	17	# Authors:
18	# Josef Skladanka <jskladan@redhat.com>	18	# Josef Skladanka <jskladan@redhat.com>
19	# Ralph Bean <rbean@redhat.com>	19	# Ralph Bean <rbean@redhat.com>
20		20
		21	import flask
21	from flask import Flask	22	from flask import Flask
22	from flask.ext.login import LoginManager	23	from flask.ext.login import LoginManager
23	from flask.ext.sqlalchemy import SQLAlchemy	24	from flask.ext.sqlalchemy import SQLAlchemy
24		25
25	import logging	26	import logging
26	import os	27	import os
27		28
28		29
29	# the version as used in setup.py	30	# the version as used in setup.py
30	__version__ = "1.1.0"	31	__version__ = "1.1.0"
31		32
32		33
33	# Flask App	34	# Flask App
34	app = Flask(__name__)	35	app = Flask(__name__)
35	app.secret_key = 'not-really-a-secret'	36	app.secret_key = 'not-really-a-secret'
36		37
		38	# Monkey patch Flask's "jsonify" to also handle JSONP
		39	original_jsonify = flask.jsonify
		40
		41	def jsonify_with_jsonp(args, *kwargs):
		42	response = original_jsonify(args, *kwargs)
		43	callback = flask.request.args.get('callback')
		44
		45	if callback:
		46	response.mimetype = 'application/javascript'
		47	response.set_data('%s(%s);' % (callback, response.get_data()))
		48
		49	return response
		50
		51	flask.jsonify = jsonify_with_jsonp
		52
37	# Load default config, then override that with a config file	53	# Load default config, then override that with a config file
38	if os.getenv('PROD') == 'true':	54	if os.getenv('PROD') == 'true':
39	default_config_obj = 'resultsdb.config.ProductionConfig'	55	default_config_obj = 'resultsdb.config.ProductionConfig'
40	default_config_file = '/etc/resultsdb/settings.py'	56	default_config_file = '/etc/resultsdb/settings.py'
41	elif os.getenv('TEST') == 'true':	57	elif os.getenv('TEST') == 'true':
42	default_config_obj = 'resultsdb.config.TestingConfig'	58	default_config_obj = 'resultsdb.config.TestingConfig'
43	default_config_file = os.getcwd() + '/conf/settings.py'	59	default_config_file = os.getcwd() + '/conf/settings.py'
44	else:	60	else:
▲ Show 20 Lines • Show All 76 Lines • Show Last 20 Lines

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	349	1b05195		Jun 4 2014, 9:31 PM	★	★