mcgill-minerva-api

    0.1.0 • Public • Published

    mcgill-minerva-api

    A javascript abstraction layer over McGill's awful minerva. It can:

    • return your unofficial transcript as json
    • search for courses (by dep, number and semester)
    • add/drop courses

    Getting Started

    Install the module with: npm install mcgill-minerva-api

    var Minerva = require('mcgill-minerva-api');
     
    var minerva = new Minerva(username, password); // or store 'em in environment MG_USER & MG_PASS
    minerva.getCourses({
        dep: 'COMP',
        number: '250',
        season: 'w',
        year: '2015'
      }).then(function(courses) {
        console.log(courses);
          // => [{
          //  is_full false,
          //  crn: '709',
          //  department: 'COMP',
          //  course_number: '250',
          //  type: 'Lecture',
          //  days: ['MWF'],
          //  time: ['09:35 AM-10:25 AM'],
          //  instructor: 'Martin Robillard',
          //  status: 'Active'
          //  },{
          //    ...
          //  }]
      });

    Documentation

    Minerva's functions are promises, see Kris Kowal's very excellent Q module. Therefore, to use the results of the function you need to chain chain a then with a callback.

    • getTranscript(): returns a promise for an array of courses. Course example:
    {
      "RW": " " || "RW", // Web registered or not
      "department": "COMP",
      "course_number": "208",
      "section": "001",
      "credit": "2",
      "grade": "A",
      "class_avg": "A"
    }
    • getCourses(options): returns a promise for an array of courses searched on minerva (for regitration). options takes :
      • dep:, e.g. "MATH",
      • number, e.g. "280",
      • season, takes w, s, or f.
      • year, takes XXXX, Return value example:
    {
      "isFull": true || false,
      "crn": '709',
      "department": 'COMP',
      "course_number": '250',
      "type": 'Lecture',
      "days": ['MWF'],
      "time": ['09:35 AM-10:25 AM'],
      "instructor": 'Martin Robillard',
      "status": 'Active'
    }
    • addCourses(options): returns a promise for registration of courses by crn. options takes:
      • season, w, s, or f;
      • year, e.g. 2015;
      • crn, crn string or array of crns (course reference numbers)
    • dropCourses(options): returns a promise for the opposite of add courses.

    Contributing

    In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

    Release History

    (Nothing yet)

    License

    Copyright (c) 2014 Charles P Clermont. Licensed under the MIT license.

    Keywords

    none

    Install

    npm i mcgill-minerva-api

    DownloadsWeekly Downloads

    16

    Version

    0.1.0

    License

    MIT

    Last publish

    Collaborators

    • avatar