iet-ou / moodle-auth_ouopenid Goto Github PK

...

• ~ Ability to embed BOS surveys,
• ~ Re-factor Javascript into smaller, manageable chunks using — Browserify, #7,
• ~ OU-Redirector front PHP page (OU-SAMS authentication),
• ~ Pipe return-code (x1) parameter into, and out of BOS surveys,
• ~ Function. to modify length of countdown timer for TeSLA voice-recognition (and FR?) [iet:10247186];

[iet:9702401]

The current plugin does too much, and its purpose is fuzzy.

To increase flexibility and maintainability, I propose dividing it in two:

1. moodle-auth_ouopenid

Purpose ~~ a minimal Moodle authentication plugin extending moodle-auth_openid. This is the current repository, and the minimal version (v 2.x) would be developed on a branch.

1. ./README.md
2. ./.gitignore
3. ./.travis.yml
4. ./composer.json
5. ./version.php
6. ./lang/en/auth_ouopenid.php
7. ./auth.php
8. ./index.php — login page
9. ./login/form.php — class for login page?
10. ./js/login.js
11. ./style/login.css

2. moodle-local_oupilot

Purpose ~~ local plugin to facilitate pilot studies as part of research projects in Moodle.

1. ./README.md
2. ./.gitignore
3. ./.travis.yml
4. ./composer.json
5. ./version.php
6. ./lang/en/local_oupilot.php
7. ./classes/user_event_observer.php
8. ...
9. ./cli/csv-example.php
10. ./cli/csv-import.php
11. ./db/events.php
12. ./db/install.xml
13. ./db/User.php
14. ...
15. ./js/ouop-local-fixes.js
16. ./js/*
17. ./style/ouop-styles.less
18. ...?

• Relates to: #6;

..

• https://github.com/IET-OU/moodle-auth_ouopenid/blob/master/user/ouop-local-fixes.js

..

• https://packagist.org/packages/moodlerooms/moodle-plugin-ci
• (OR? https://github.com/moodlehq/moodle-local_codechecker )
• https://github.com/catalyst/moodle-auth_basic/blob/master/.travis.yml#L53
• https://moodle.org/plugins/pluginversion.php?id=12864

• — Integrate moodle-plugin-ci;
• — Fix coding standard issues;
• — Unit tests for csv-import ??
• — rename bin/ directory to cli/ — Moodle convention;
• — think about how to split the plugin;

• https://docs.moodle.org/dev/YUI/Shifter
• https://github.com/CSSLint/csslint/wiki/Disallow-unqualified-attribute-selectors
• http://behat.org/en/latest/quick_start.html

• — Basic requirements (see below);
• — composer.json;
• — php-lint;
• — PHP_CodeSniffer;
• — basic "get user" Ajax service ??
• — eslint or jshint;
• — Travis-CI (see ~ https://github.com/travis-ci/travis-ci/issues/4090#issuecomment-184811689}
• ...?

Basic requirements for a Moodle auth plugin:

1. version.php
2. auth.php — class auth_plugin_ouopenid extends auth_plugin_base { .. }
3. lang/en/auth_ouopenid.php

Files affected — backend:

• db/install.xml
• db/upgrade.php — add,
• db/User.php — User::InsertFromCsv()
• version.php,

Files affected — frontend:

• user/ajax.php
• user/ouop-local-fixes.js
• .. debugging, eg. User::getDummyUser(),

Files affected — parent project/repo.:

• config-TEMPLATE.php

..

..

February - March 2018.

• — "Complete" a survey embedded via <IFRAME> in a "mod/assign" Moodle conditional activity;
• — ... ?

[iet:10306790]