1063165 - [Compat Data] Add authentication to compat data API

Status: RESOLVED FIXED

(developer.mozilla.org Graveyard :: General, enhancement)

Description

[John Whitlock [:jwhitlock]]

What problems would this solve?
===============================
All changes to compat data should be linked to the user that made the change.  Some changes (such as adding, changing, or deleting a browser) should be restricted to a subset of users.  Some users may want to use scripts to update data, and their changes should be associated with their user account.

Who would use this?
===================
Contributors and editors that want to change data

What would users see?
=====================
Most data will be readable by unauthenticated users.  After authentication, a user will be able to create, update, and change data.  Changes will be linked to particular users.

What would users do? What would happen as a result?
===================================================
Users will create accounts, log into those accounts, and be able to make changes.  They will be able to generate access keys as needed by headless scripts.

Is there anything else we should know?
======================================
Draft API docs at http://web-platform-compat.readthedocs.org/en/latest/draft/services.html#authentication.  There is a stretch goal that MDN users will not have to repeat authentication, but the first version will require a new account.

Comment 1

[John Whitlock [:jwhitlock]]

Proposed fix in branch:

https://github.com/jwhitlock/web-platform-compat/tree/1063165_add_authentication
https://github.com/mozilla/web-platform-compat/pull/21

Authentication is via username and password or by Firefox Accounts (FxA).  This means non-web auth (command line tools, server integration, etc.) is via username and password.  OAuth2-based authentication can be added, but is delayed until needed.

Also, MDN users will currently need to sign up again for an API account.  It would be possible to add the same auth methods (Persona and GitHub), but linking identities is not implemented.

Comment 2

[MDN Team (:mdn-dev)]

Commits pushed to master at https://github.com/mozilla/web-platform-compat

https://github.com/mozilla/web-platform-compat/commit/29da4fc17e925e94863cea89e584924ca3882879
bug 1063165 - Add autoenv sample config

With django-allauth, configuration is about to get more complicated

https://github.com/mozilla/web-platform-compat/commit/81232f45b0cc3b0b84d7f8a206adaf520e753b2b
bug 1063165 - Add django-allauth, FxA plugin

https://github.com/mozilla/web-platform-compat/commit/03da1e30058b9cd1fc4d02950963a100f8287756
bug 1063165 - First pass at account styling

- Add toolbar for logged in status
- Add about page
- Convert login/logout to jinja2, Sync style
- Add profile placeholder
- Update copyright for 2015

https://github.com/mozilla/web-platform-compat/commit/82df8b6c495e393a9e05348e00f9d97eaecd53e0
bug 1063165 - Create bcauth app

Hold django-allauth overrides, customizations, and Jinja2 variants of
templates.  Still requires work, including loading override variables
from the environment and conversion of more templates.

https://github.com/mozilla/web-platform-compat/commit/818c7f83029d09d19379155e8172c6c527f49ec0
bug 1063165 - Convert remaining templates

Some templates have not been tested, because they require features that
aren't enabled.  Email and messages templates have not been converted
either, because they don't need to be based on the common base template.
They are all included for ease of future development.

https://github.com/mozilla/web-platform-compat/commit/1f399bf028c208a23820701ddb608e37233d57fe
bug 1063165 - Move configuration to environment

https://github.com/mozilla/web-platform-compat/commit/415d50bf92dd6a6affa6f44c7ba73a895f2e02fd
bug 1063165 - Add test coverage for bcauth

https://github.com/mozilla/web-platform-compat/commit/3d327078bf5ae5cf877d254798d67996fd98d42e
bug 1063165 - Update source dist for bcauth

https://github.com/mozilla/web-platform-compat/commit/516f0082886b2a6267389c2c55a18c571313505c
bug 1063165 - Add navigation to browsable API

https://github.com/mozilla/web-platform-compat/commit/ce5f366698f45c7b64734e418761e649f78d6178
fix bug 1063165 - Finish profile pages

https://github.com/mozilla/web-platform-compat/commit/0e9b30d61b3067e830be70debbd6404e66b8b44c
fix bug 1063165 - Redirect anon users to login

https://github.com/mozilla/web-platform-compat/commit/4d2beb6981b06e16466452b2b4874403c20fee5a
Merge pull request #21 from jwhitlock/1063165_add_authentication

Fix bug 1063165 - add authentication