Proposal: Illustrate the API through an examples/ folder #711
Conversation
|
I just rebased from master. Should be fine now. |
|
@dannycoates r? |
|
Fixed commit for emailStatus, it was incomplete. |
|
Rebased again with latest master. |
This commit contains command-line tests to test: * `signup.js`: Sign up with preVerified address (for development/maintenance) * `login.js`: Test if login works * `requestVerifyEmail.js`: Ask to re-send verification email * `emailStatus.js`: Check whether the user has a verified email address
|
I appreciate you taking the time to improve the documentation. These examples do nicely demonstrate the interaction with the server, however, I think it would be better to add them to https://github.com/mozilla/fxa-js-client The test client included in this repo is only meant to be used by the test framework and I don't want to encourage anyone to depend on it's api or confuse anyone as to which client to use. A bit of history... The client code here was the first implementation. When fxa-content-server was created it was copied over and periodically synced as the api changed. That worked for a bit but we knew this was not how we wanted to continue so we created fxa-js-client. The intent was to replace this internal client with that one, but as the api stabilized and test cases grew it became less of a priority. We still may do it eventually though. So the preferred public client is fxa-js-client and we should definitely have some examples there. I think it could be useful to mention the remote tests like https://github.com/mozilla/fxa-auth-server/blob/master/test/remote/flow_tests.js as a quick reference point in the readme. |
|
Thanks @dannycoates for this explaination. You can drop the pull request, its all fine with me. I needed to make a migration script and i used that client code. But now that the first migration has been run on our users, I will only need it once again before the final switch in a week or two. I’ll come soon on the #fxa channel to talk a bit about rebasing your code under my forks. |
Nothing fancy, just an illustration on how authentication and account creation works in a bare-bone script.
It proven helpful to understand the in and out of the process.
Tell me if you like and I might give a shot and add other methods later down the road.