IVLE 0.0.1

data/lib/IVLE/api/poll.rb

@@ -0,0 +1,19 @@
+module IVLE
+  module Poll
+    def polls(course_id, poll_id, title_only=false)
+      api 'Polls', courseid: course_id, pollid: poll_id, titleonly: title_only
+    end
+
+    def poll_submit_vote(poll_id, poll_question_id, poll_question_option_id, other_text)
+      api_post 'Poll_SubmitVote_JSON', pollid: poll_id, pollquestionid: poll_question_id, pollquestionoptionid: poll_question_option_id, othertext: other_text
+    end
+
+    def poll_get_voted_user(poll_id, poll_question_id, poll_question_option_id)
+      api 'Poll_GetVotedUser', pollid: poll_id, pollquestionid: poll_question_id, pollquestionoptionid: poll_question_option_id
+    end
+
+    def poll_get_voted_user_other(poll_id, poll_question_id, poll_question_option_id)
+      api 'Poll_GetVotedUser_Other', pollid: poll_id, pollquestionid: poll_question_id, pollquestionoptionid: poll_question_option_id
+    end
+  end
+end

data/lib/IVLE/api/profile.rb

@@ -0,0 +1,7 @@
+module IVLE
+  module Profile
+    def profile_view
+      api 'Profile_View'
+    end
+  end
+end

data/lib/IVLE/api/rosters_and_groups.rb

@@ -0,0 +1,78 @@
+module IVLE
+  module RostersAndGroups
+    def class_roster(course_id)
+      api 'Class_Roster', courseid: course_id
+    end
+
+    def guest_roster(course_id)
+      api 'Guest_Roster', courseid: course_id
+    end
+
+    def groups_by_user_and_module(course_id=nil, acad_year=nil, semester=nil)
+      if course_id == nil && (acad_year == nil || semester == nil)
+        raise 'Missing arguments: acad_year and semester must not be nil if course_id is nil'
+      elsif course_id.nil?
+        params = {}
+      else
+        params = { courseid: course_id, acadyear: acad_year, semester: semester }
+      end
+
+      api 'GroupsByUserAndModule', params
+    end
+
+    def groups_by_user
+      api 'GroupsByUser'
+    end
+
+    def module_class_groups(course_id, flag)
+      api 'Module_ClassGroups', courseid: course_id, flag: flag
+    end
+
+    def module_class_group_users(class_group_id)
+      api 'Module_ClassGroups', classgroupid: class_group_id
+    end
+
+    def module_official_group_users(course_id, module_code, group_name, acad_year, semester, group_type)
+      api 'Module_OfficialGroupUsers', {
+        courseid: course_id,
+        modulecode: module_code,
+        groupname: group_name,
+        acadyear: acad_year,
+        semester: semester,
+        grouptype: group_type
+      }
+    end
+
+    def class_group_sign_up(course_id, group_id)
+      api_post 'ClassGroupSignUp_JSON', courseid: course_id, groupid: group_id
+    end
+
+    def class_group_sign_up_remove(course_id, group_id)
+      api_post 'ClassGroupSignUpRemove_JSON', courseid: course_id, groupid: group_id
+    end
+
+    def group_projects_by_user(course_id, include_groups, group_type)
+      api 'GroupProjectsByUser', courseid: course_id, includegroups: include_groups, grouptype: group_type
+    end
+
+    def project_self_enrol_groups(project_id)
+      api 'Project_SelfEnrolGroups', projectid: project_id
+    end
+
+    def project_group_users(project_group_id)
+      api 'ProjectGroupUsers', projectgroupid: project_group_id
+    end
+
+    def project_enrolled_groups
+      api 'Project_EnrolledGroups'
+    end
+
+    def project_group_sign_up(project_group_id)
+      api_post 'ProjectGroup_SignUp_JSON', projectgroupid: project_group_id
+    end
+
+    def project_group_remove_sign_up(project_group_id)
+      api_post 'ProjectGroup_RemoveSignUp_JSON', projectgroupid: project_group_id
+    end
+  end
+end

data/lib/IVLE/api/student_events.rb

@@ -0,0 +1,32 @@
+module IVLE
+  module StudentEvents
+    def student_events(title_only=false)
+      api 'StudentEvents', titleonly: title_only
+    end
+
+    def student_events_categories(include_events=true, title_only=false)
+      api 'StudentEvents_Categories', includeevents: include_events, titleonly: title_only
+    end
+
+    def student_events_committees(include_events=true, title_only=false)
+      api 'StudentEvents_Committees', includeevents: include_events, titleonly: title_only
+    end
+
+    def student_events_category(category_id, title_only=false)
+      api 'StudentEvents_Category', categoryid: category_id, titleonly: title_only
+    end
+
+    def student_events_committee(committee_id, title_only=false)
+      api 'StudentEvents_Committee', committeeid: committee_id, titleonly: title_only
+    end
+
+    def student_event_post_new_event(category_id, committee_id, evt_start_date, evt_end_date)
+      api_post 'StudentEvent_PostNewEvent_JSON', {
+        categoryid: category_id,
+        committeeid: committee_id,
+        evtstartdate: evt_start_date,
+        evtenddate: evt_end_date
+      }
+    end
+  end
+end

data/lib/IVLE/api/timetable.rb

@@ -0,0 +1,19 @@
+module IVLE
+  module Timetable
+    def timetable_student(acad_year, semester)
+      api 'Timetable_Student', acadyear: acad_year, semester: semester
+    end
+
+    def timetable_module(course_id)
+      api 'Timetable_Module', courseid: course_id
+    end
+
+    def timetable_student_module(course_id)
+      api 'Timetable_Student_Module', courseid: course_id
+    end
+
+    def timetable_module_exam(course_id)
+      api 'Timetable_ModuleExam', courseid: course_id
+    end
+  end
+end

data/lib/IVLE/api/webcast.rb

@@ -0,0 +1,13 @@
+module IVLE
+  module Webcast
+    def webcasts(course_id, duration=0, media_channel_id=nil)
+      optionals = media_channel_id.nil? ? {} : { mediachannelid: media_channel_id }
+      api 'Webcasts', { courseid: course_id, duration: duration }.merge(optionals)
+    end
+
+    def webcast_add_log(media_channel_id, media_channel_item_id)
+      # Docs are bad
+      api_post 'Webcast_AddLog_JSON', mediachannelid: media_channel_id, mediachannelitemid: media_channel_item_id
+    end
+  end
+end

data/lib/IVLE/api/workbin.rb

@@ -0,0 +1,11 @@
+module IVLE
+  module Workbin
+    def workbins(course_id, duration=0, workbin_id=nil, title_only=false)
+      api 'Workbins', courseid: course_id, duration: duration, workbinid: workbin_id, titleonly: title_only
+    end
+
+    def download_file(id)
+      api 'downloadfile', id: id
+    end
+  end
+end

data/lib/IVLE/version.rb

@@ -0,0 +1,3 @@
+module IVLE
+  VERSION = "0.0.1"
+end

data/spec/api/api_spec.rb

@@ -0,0 +1,34 @@
+require 'fakeweb'
+require 'IVLE'
+require 'fixtures/ivle'
+
+describe IVLE::API do
+  include Fixtures::IVLE
+
+  context 'API calls' do
+    before do
+      FakeWeb.register_uri(:get,
+        "https://ivle.nus.edu.sg/api/login?apikey=api_key&url=",
+        body: read_fixture('login.html'),
+        content_type: "text/html")
+
+      FakeWeb.register_uri(:post,
+        "https://ivle.nus.edu.sg/api/login?apikey",
+        body: "1111",
+        content_type: "text/html")
+
+      stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get('api/Lapi.svc/Modules') {[ 200, {}, read_fixture('modules.json') ]}
+      end
+
+      mock_client = Faraday.new(url: 'https://ivle.nus.edu.sg/') { |f| f.adapter :test, stubs }
+      IVLE::API.any_instance.stub(:client).and_return(mock_client)
+      @ivle = IVLE::API.new('api_key', 'login', 'pass')
+    end
+
+    it 'calls an API method' do
+      # This tests the entire API flow.
+      expect(@ivle.modules[:Results]).to have(4).items
+    end
+  end
+end

data/spec/fixtures/api/login.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+</head>
+<body>
+<form name="frm" onsubmit="javascript:return WebForm_OnSubmit();" action="?apikey" method="post">
+<input name="userid" type="password" maxlength="100" name="password">
+<input name="password" type="password" maxlength="100" name="password">
+</form>
+</body>
+</html>

data/spec/fixtures/api/modules.json

@@ -0,0 +1,201 @@
+{
+  "Results": [
+    {
+      "Announcements": [],
+      "Forums": [],
+      "Workbins": [],
+      "Webcasts": [],
+      "Gradebooks": [],
+      "Polls": [],
+      "ID": "3333333-0106-46c6-b488-5e6bf643df67",
+      "CourseLevel": "1",
+      "CourseCode": "NM3209",
+      "CourseName": "Creating Interactive Media",
+      "CourseDepartment": "",
+      "CourseSemester": "Semester 1",
+      "CourseAcadYear": "2013/2014",
+      "CourseOpenDate": "/Date(1369929600000+0800)/",
+      "CourseOpenDate_js": "2013-05-31T00:00:00",
+      "CourseCloseDate": "/Date(1386345540000+0800)/",
+      "CourseCloseDate_js": "2013-12-06T23:59:00",
+      "CourseMC": "4",
+      "isActive": "Y",
+      "Permission": "S",
+      "Creator": {
+        "UserID": "cnmmk",
+        "Name": "Kevin McGee",
+        "Email": null,
+        "Title": null,
+        "UserGuid": "333333-0795-4b24-8d31-ed00398f4180",
+        "AccountType": null
+      },
+      "hasGradebookItems": false,
+      "hasTimetableItems": true,
+      "hasGroupsItems": true,
+      "hasClassGroupsForSignUp": false,
+      "hasGuestRosterItems": false,
+      "hasClassRosterItems": true,
+      "hasWeblinkItems": true,
+      "hasLecturerItems": true,
+      "hasDescriptionItems": true,
+      "hasReadingItems": false,
+      "hasAnnouncementItems": false,
+      "hasProjectGroupItems": false,
+      "hasProjectGroupsForSignUp": false,
+      "hasConsultationItems": false,
+      "hasConsultationSlotsForSignUp": false,
+      "Badge": 0,
+      "BadgeAnnouncement": 0,
+      "WebLinks": [],
+      "Lecturers": [],
+      "Descriptions": [],
+      "ReadingFormatted": [],
+      "ReadingUnformatted": []
+    },
+    {
+      "Announcements": [],
+      "Forums": [],
+      "Workbins": [],
+      "Webcasts": [],
+      "Gradebooks": [],
+      "Polls": [],
+      "ID": "3333333-3456-4cf1-a6ee-bdc8afed01cb",
+      "CourseLevel": "1",
+      "CourseCode": "NM4227",
+      "CourseName": "PLAYABLE ART",
+      "CourseDepartment": "",
+      "CourseSemester": "Semester 1",
+      "CourseAcadYear": "2013/2014",
+      "CourseOpenDate": "/Date(1369152000000+0800)/",
+      "CourseOpenDate_js": "2013-05-22T00:00:00",
+      "CourseCloseDate": "/Date(1386345540000+0800)/",
+      "CourseCloseDate_js": "2013-12-06T23:59:00",
+      "CourseMC": "0",
+      "isActive": "Y",
+      "Permission": "S",
+      "Creator": {
+        "UserID": "cnmams",
+        "Name": "Anne Marie Schleiner",
+        "Email": null,
+        "Title": null,
+        "UserGuid": "3333333-2a80-4ed6-b44566-a221111a8e3",
+        "AccountType": null
+      },
+      "hasGradebookItems": false,
+      "hasTimetableItems": true,
+      "hasGroupsItems": true,
+      "hasClassGroupsForSignUp": false,
+      "hasGuestRosterItems": false,
+      "hasClassRosterItems": true,
+      "hasWeblinkItems": false,
+      "hasLecturerItems": true,
+      "hasDescriptionItems": true,
+      "hasReadingItems": false,
+      "hasAnnouncementItems": false,
+      "hasProjectGroupItems": false,
+      "hasProjectGroupsForSignUp": false,
+      "hasConsultationItems": false,
+      "hasConsultationSlotsForSignUp": false,
+      "Badge": 0,
+      "BadgeAnnouncement": 0,
+      "WebLinks": [],
+      "Lecturers": [],
+      "Descriptions": [],
+      "ReadingFormatted": [],
+      "ReadingUnformatted": []
+    },
+    {
+      "Announcements": [],
+      "Forums": [],
+      "Workbins": [],
+      "Webcasts": [],
+      "Gradebooks": [],
+      "Polls": [],
+      "ID": "00000000-0000-0000-0000-000000000000",
+      "CourseLevel": null,
+      "CourseCode": "CS4249",
+      "CourseName": "PHENOMENA AND THEORIES OF HUMAN-COMPUTER INTERACTION",
+      "CourseDepartment": null,
+      "CourseSemester": "1",
+      "CourseAcadYear": "2013/2014",
+      "CourseOpenDate": "/Date(1375452583402+0800)/",
+      "CourseOpenDate_js": "2013-08-02T22:09:43.4027946+08:00",
+      "CourseCloseDate": "/Date(1375452583402+0800)/",
+      "CourseCloseDate_js": "2013-08-02T22:09:43.4027946+08:00",
+      "CourseMC": null,
+      "isActive": "Y",
+      "Permission": "S",
+      "Creator": null,
+      "hasGradebookItems": false,
+      "hasTimetableItems": false,
+      "hasGroupsItems": false,
+      "hasClassGroupsForSignUp": false,
+      "hasGuestRosterItems": false,
+      "hasClassRosterItems": false,
+      "hasWeblinkItems": false,
+      "hasLecturerItems": false,
+      "hasDescriptionItems": false,
+      "hasReadingItems": false,
+      "hasAnnouncementItems": false,
+      "hasProjectGroupItems": false,
+      "hasProjectGroupsForSignUp": false,
+      "hasConsultationItems": false,
+      "hasConsultationSlotsForSignUp": false,
+      "Badge": 0,
+      "BadgeAnnouncement": 0,
+      "WebLinks": [],
+      "Lecturers": [],
+      "Descriptions": [],
+      "ReadingFormatted": [],
+      "ReadingUnformatted": []
+    },
+    {
+      "Announcements": [],
+      "Forums": [],
+      "Workbins": [],
+      "Webcasts": [],
+      "Gradebooks": [],
+      "Polls": [],
+      "ID": "00000000-0000-0000-0000-000000000000",
+      "CourseLevel": null,
+      "CourseCode": "CS4345",
+      "CourseName": "GENERAL-PURPOSE COMPUTATION ON GPU",
+      "CourseDepartment": null,
+      "CourseSemester": "1",
+      "CourseAcadYear": "2013/2014",
+      "CourseOpenDate": "/Date(1375452583402+0800)/",
+      "CourseOpenDate_js": "2013-08-02T22:09:43.4027946+08:00",
+      "CourseCloseDate": "/Date(1375452583402+0800)/",
+      "CourseCloseDate_js": "2013-08-02T22:09:43.4027946+08:00",
+      "CourseMC": null,
+      "isActive": "Y",
+      "Permission": "S",
+      "Creator": null,
+      "hasGradebookItems": false,
+      "hasTimetableItems": false,
+      "hasGroupsItems": false,
+      "hasClassGroupsForSignUp": false,
+      "hasGuestRosterItems": false,
+      "hasClassRosterItems": false,
+      "hasWeblinkItems": false,
+      "hasLecturerItems": false,
+      "hasDescriptionItems": false,
+      "hasReadingItems": false,
+      "hasAnnouncementItems": false,
+      "hasProjectGroupItems": false,
+      "hasProjectGroupsForSignUp": false,
+      "hasConsultationItems": false,
+      "hasConsultationSlotsForSignUp": false,
+      "Badge": 0,
+      "BadgeAnnouncement": 0,
+      "WebLinks": [],
+      "Lecturers": [],
+      "Descriptions": [],
+      "ReadingFormatted": [],
+      "ReadingUnformatted": []
+    }
+  ],
+  "Comments": "Valid login!",
+  "LastUpdate": "/Date(1375452581593+0800)/",
+  "LastUpdate_js": "2013-08-02T22:09:41.5931636+08:00"
+}

data/spec/fixtures/ivle.rb

@@ -0,0 +1,7 @@
+module Fixtures
+  module IVLE
+    def read_fixture(name)
+      File.read(File.dirname(__FILE__) + "/api/#{name}")
+    end
+  end
+end