IVLE 0.0.1

data/lib/IVLE/api/announcement.rb

@@ -0,0 +1,19 @@
+module IVLE
+  module Announcement
+    def announcements(course_id, duration=0, title_only=false)
+      api 'Announcements', courseid: course_id, duration: duration, titleonly: title_only
+    end
+
+    def announcements_unread(title_only=false)
+      api 'Announcements_Unread'
+    end
+
+    def announcement_add_log(ann_event_id)
+      api_post 'Announcement_AddLog_JSON', anneventid: ann_event_id
+    end
+
+    def announcement_add(course_id, ann_title, ann_message, send_email)
+      api_post 'Announcement_Add_JSON', courseid: course_id, anntitle: ann_title, annmessage: ann_message, sendemail: send_email
+    end
+  end
+end

data/lib/IVLE/api/community.rb

@@ -0,0 +1,174 @@
+module IVLE
+  module Community
+    def communities(duration=0)
+      api 'Communities', duration: duration
+    end
+
+    def community_search(search_type, keyword, active_only=false, title_only=false)
+      api 'Community_Search', searchtype: search_type, keyword: keyword, activeonly: active_only, titleonly: title_only
+    end
+
+    def community_categories(active_only=false)
+      # Just look at this snake_CamelCase consistency!
+      api 'CommunityCategories', activeonly: active_only
+    end
+
+    def community_tags(active_only=false)
+      api 'CommunityTags', activeonly: active_only
+    end
+
+    def community(com_id, duration=0)
+      api 'Community', comid: com_id, duration: duration
+    end
+
+    def community_members(com_id)
+      api 'CommunityMembers', comid: com_id
+    end
+
+    def community_announcements(com_id, duration=0)
+      api 'CommunityAnnouncements', comid: com_id, duration: duration
+    end
+
+    def community_workbin_folders(com_id, including_files=true, duration=0)
+      api 'CommunityWorkbinFolders', comid: com_id, includingfiles: including_files, duration: duration
+    end
+
+    def community_workbin_files(folder_id, duration=0)
+      api 'CommunityWorkbinFiles', folderid: folder_id, duration: duration
+    end
+
+    def community_forum_headings(com_id, including_posts=true, duration=0)
+      api 'CommunityForumHeadings', comid: com_id, includingposts: including_posts, duration: duration
+    end
+
+    def community_forum_posts(heading_id, duration=0)
+      api 'CommunityForumPosts', headingid: heading_id, duration: duration
+    end
+
+    def community_forum_add_log_by_post(post_id)
+      api_post 'CommunityForum_AddLogByPost_JSON', postid: post_id
+    end
+
+    def community_forum_new_topic(heading_id, title, message)
+      api_post 'CommunityForum_NewTopic_JSON', headingid: heading_id, message: message
+    end
+
+    def community_forum_reply_post(post_id, title, message)
+      api_post 'CommunityForum_ReplyPost_JSON', postid: post_id, title: title, message: message
+    end
+
+    def community_weblinks(com_id)
+      api 'CommunityWeblinks', comid: com_id
+    end
+
+    def community_join(com_id)
+      api_post 'Community_Join_JSON', comid: com_id
+    end
+
+    def community_quit(com_id)
+      api_post 'Community_Quit_JSON', comid: com_id
+    end
+
+    def community_add_member(com_id, member_id, member_type)
+      api_post 'Community_AddMember_JSON', comid: com_id, memberid: member_id, membertype: member_type
+    end
+
+    def community_delete_member(com_id, member_id)
+      api_post 'Community_DeleteMember_JSON', comid: com_id, memberid: member_id
+    end
+    def community_update_member(com_id, member_id, member_type)
+      api_post 'Community_UpdateMember_JSON', comid: com_id, memberid: member_id, membertype: member_type
+    end
+
+    def community_create(title, description, access_type, default_forum, default_workbin, category_id, tags)
+      api_post 'Community_Create_JSON', {
+        title: title,
+        accesstype: access_type,
+        defaultforum: default_forum,
+        defaultworkbin: default_workbin,
+        categoryid: category_id,
+        tags: tags
+      }
+    end
+
+    def community_update(com_id, title, description, access_type, default_forum, default_workbin, category_id, tags, display_members_to, opening_date, expiry_date)
+      api_post 'Community_Update_JSON', {
+        comid: com_id,
+        title: title,
+        description: description,
+        accesstype: access_type,
+        defaultforum: default_forum,
+        defaultworkbin: default_workbin,
+        categoryid: category_id,
+        tags: tags,
+        displaymembersto: display_members_to,
+        openingdate: opening_date,
+        expirydate: expiry_date
+      }
+    end
+
+    def download_file(id)
+      api 'downloadfile', id: id
+    end
+
+    def community_get_task(task_id)
+      api 'Community_GetTask', taskid: task_id
+    end
+
+    def community_get_all_tasks(com_id)
+      api 'Community_GetAllTasks', comid: com_id
+    end
+
+    def community_get_sub_task(task_id)
+      api 'Community_GetSubTask', taskid: task_id
+    end
+
+    def community_create_task(com_id, task_name, task_description, parent_task_id, task_status, task_priority, task_due_date)
+      api_post 'Community_CreateTask_JSON', {
+        comid: com_id,
+        taskname: task_name,
+        taskdescription: task_description,
+        parenttaskid: parent_task_id,
+        taskstatus: task_status,
+        taskpriority: task_priority,
+        taskduedate: task_due_date
+      }
+    end
+
+    def community_update_task(task_id, task_name, task_description, parent_task_id, task_status, task_priority, task_due_date)
+      api_post 'Community_UpdateTask_JSON', {
+        taskid: com_id,
+        taskname: task_name,
+        taskdescription: task_description,
+        parenttaskid: parent_task_id,
+        taskstatus: task_status,
+        taskpriority: task_priority,
+        taskduedate: task_due_date
+      }
+    end
+
+    def community_delete_task(task_id)
+      api_post 'Community_DeleteTask_JSON', taskid: task_id
+    end
+
+    def community_create_comment(task_id, comment)
+      api_post 'Community_CreateComment_JSON', taskid: task_id, comment: comment
+    end
+
+    def community_update_comment(comment_id, comment)
+      api_post 'Commmunity_UpdateComment_JSON', commentid: comment_id, comment: comment
+    end
+
+    def community_delete_comment(comment_id)
+      api_post 'Community_DeleteComment_JSON', commentid: comment_id
+    end
+
+    def community_get_comment(comment_id)
+      api 'Community_GetComment', commentid: comment_id
+    end
+
+    def community_get_all_comments(task_id)
+      api 'Community_GetAllComments', taskid: task_id
+    end
+  end
+end

data/lib/IVLE/api/consultation.rb

@@ -0,0 +1,24 @@
+module IVLE
+  module Consultation
+    def consultation_module_facilitators_with_slots(course_id, include_slots, slot_type)
+      api 'Consultation_ModuleFacilitatorsWithSlots', courseid: course_id, includeslots: include_slots, slottype: slot_type
+    end
+
+    def consultation_slots(lec_id, slot_type)
+      api 'ConsultationSlots', lecid: lec_id, slottype: slot_type
+    end
+
+    def consultation_signed_up_slots
+      api 'Consultation_SignedUpSlots'
+    end
+
+    def consultation_sign_up(consultation_id)
+      # WTF is this? Gosh, just pass in an additional format parameter!
+      api_post 'Consultation_SignUp_JSON', consultationid: consultation_id
+    end
+
+    def consultation_cancel_slot(consultation_id)
+      api_post 'Consultation_CancelSlot_JSON', consultationid: consultation_id
+    end
+  end
+end

data/lib/IVLE/api/delta_datasets.rb

@@ -0,0 +1,7 @@
+module IVLE
+  module DeltaDatasets
+    def delta_module_timetable(last_modified, module_code=nil)
+      api 'Delta_ModuleTimeTable', lastmodified: last_modified, modulecode: module_code
+    end
+  end
+end

data/lib/IVLE/api/forum.rb

@@ -0,0 +1,47 @@
+module IVLE
+  module Forum
+    def forums(course_id, duration=0, include_threads=true, title_only=false)
+      api 'Forums', courseid: course_id, duration: duration, includethreads: include_threads, titleonly: title_only
+    end
+
+    def forum(forum_id, duration=0, include_threads=true)
+      api 'Forum', forumid: forum_id, duration: duration, includethreads: include_threads
+    end
+
+    def forum_headings(forum_id, duration=0, include_threads=true)
+      api 'Announcement_AddLog', forumid: forum_id, duration: duration, includethreads: include_threads
+    end
+
+    def forum_heading_threads(heading_id, duration=0, get_main_topics_only=false)
+      api 'Forum_HeadingThreads', headingid: heading_id, duration: duration, getmaintopicsonly: get_main_topics_only
+    end
+
+    def forum_threads(forum_id, duration=0, get_sub_threads=true)
+      api 'Forum_Threads', threadid: thread_id, duration: duration, getsubthreads: get_sub_threads
+    end
+
+    def forum_thread(thread_id)
+      api 'Forum_Thread', threadid: thread_id
+    end
+
+    def forum_post_new_thread(heading_id, title, reply)
+      api_post 'Forum_PostNewThread_JSON', headingid: heading_id, title: title, reply: reply
+    end
+
+    def forum_reply_thread(thread_id, title, reply)
+      api_post 'Forum_ReplyThread_JSON', threadid: thread_id, title: title, reply: reply
+    end
+
+    def forum_thread_add_log(thread_id)
+      api_post 'Forum_Thread_AddLog_JSON', threadid: thread_id
+    end
+
+    def forum_sale_of_used_textbooks(duration=0, include_threads=true)
+      api 'Forum_SaleOfUsedTextbooks', includethreads: include_threads, duration: duration
+    end
+
+    def forum_student_feedback(duration=0, include_threads=true)
+      api 'Forum_StudentFeedback', includethreads: include_threads, duration: duration
+    end
+  end
+end

data/lib/IVLE/api/gradebook.rb

@@ -0,0 +1,7 @@
+module IVLE
+  module Gradebook
+    def workbins(course_id)
+      api 'Gradebook_ViewItems', courseid: course_id
+    end
+  end
+end

data/lib/IVLE/api/ivle_news.rb

@@ -0,0 +1,7 @@
+module IVLE
+  module IVLENews
+    def public_news(title_only=false)
+      api 'PublicNews', titleonly: title_only
+    end
+  end
+end

data/lib/IVLE/api/library_ereserves.rb

@@ -0,0 +1,11 @@
+module IVLE
+  module LibraryEReserves
+    def lib_ereserves(course_id, title_only=false)
+      api 'LibEreserves', courseid: course_id, titleonly: title_only
+    end
+
+    def lib_ereserve_files(folder_id)
+      api 'LibEreserveFiles', folderid: folder_id
+    end
+  end
+end

data/lib/IVLE/api/login.rb

@@ -0,0 +1,19 @@
+module IVLE
+  module Login
+    def validate(api_key, token)
+      api 'Validate', apikey: api_key, token: token
+    end
+
+    def username_get(api_key, token)
+      api 'UserName_Get', apikey: api_key, token: token
+    end
+
+    def userid_get(api_key, token)
+      api 'UserID_Get', apikey: api_key, token: token
+    end
+
+    def useremail_get(api_key, token)
+      api 'UserEmail_Get', apikey: api_key, token: token
+    end
+  end
+end

data/lib/IVLE/api/module.rb

@@ -0,0 +1,53 @@
+module IVLE
+  module IVLEModule
+    def modules(duration=0, include_all_info=true)
+      api 'Modules', duration: duration, includeallinfo: include_all_info
+    end
+
+    def modules_staff(duration=0, include_all_info=true)
+      api 'Modules_Staff', duration: duration, includeallinfo: include_all_info
+    end
+
+    def modules_student(duration=0, include_all_info=true)
+      api 'Modules_Student', duration: duration, includeallinfo: include_all_info
+    end
+
+    def module(course_id, title_only=false, duration=0, include_all_info=true)
+      api 'Module', courseid: course_id, titleonly: title_only, duration: duration, includeallinfo: include_all_info
+    end
+
+    def modules_search(search_parameters={}, duration=0, include_all_info=true)
+      # Verbatim from API docs: AuthToken, ModuleCode, ModuleTitle, LecturerName, Department, Semester, AcadYear, ModNameExact,
+      # LecNameExact, tag are optional fields. But at least one must be supplied.
+      api 'Modules_Search', search_parameters.merge({ duration: duration, includeallinfo: include_all_info })
+    end
+
+    def module_lecturers(course_id, duration=0)
+      api 'Module_Lecturers', courseid: course_id, duration: duration
+    end
+
+    def module_information(course_id, duration=0)
+      api 'Module_Information', courseid: course_id, duration: duration
+    end
+
+    def module_weblinks(course_id)
+      api 'Module_Weblinks', courseid: course_id
+    end
+
+    def module_reading_formatted(course_id, duration=0)
+      api 'Module_ReadingFormatted', courseid: course_id, duration: duration
+    end
+
+    def module_reading_unformatted(course_id, duration=0)
+      api 'Module_ReadingUnformatted', courseid: course_id, duration: duration
+    end
+
+    def module_reading(course_id, duration=0)
+      api 'Module_Reading', courseid: course_id, duration: duration
+    end
+
+    def modules_taken(student_id)
+      api 'Modules_Taken', studentid: student_id
+    end
+  end
+end

data/lib/IVLE/api/my_organizer.rb

@@ -0,0 +1,62 @@
+module IVLE
+  module MyOrganizer
+    def my_organizer_personal(start_date=nil, end_date=nil)
+      api 'MyOrganizer_Personal', startdate: start_date, enddate: end_date
+    end
+
+    def my_organizer_ivle(start_date=nil, end_date=nil)
+      api 'MyOrganizer_IVLE', startdate: start_date, enddate: end_date
+    end
+
+    def my_organizer_events(start_date=nil, end_date=nil)
+      api 'MyOrganizer_Events', startdate: start_date, enddate: end_date
+    end
+
+    def my_organizer_add_personal_event(event_title, venue, event_date_time, description, recur_type, str_days, recur_till_date)
+      api_post 'MyOrganizer_AddPersonalEvent_JSON', {
+        eventtitle: event_title,
+        venue: venue,
+        eventdatetime: event_date_time,
+        description: description,
+        recurtype: recur_type,
+        recurtilldate: recur_till_date
+      }
+    end
+
+    def my_organizer_update_personal_event(event_id, event_title, venue, event_date_time, description, recur_type, weekly_recur_every, str_days, recur_from_date, recur_till_date, update_recurrence_event)
+      api_post 'MyOrganizer_UpdatePersonalEvent_JSON', {
+        eventid: event_id,
+        eventtitle: event_title,
+        venue: venue,
+        eventdatetime: event_date_time,
+        description: description,
+        recurtype: recur_type,
+        weeklyrecurevery: weekly_recur_every,
+        strdays: str_days,
+        recurfromdate: recur_from_date,
+        recurtilldate: recur_till_date,
+        updaterecurrenceevent: update_recurrence_event
+      }
+    end
+
+    def my_organizer_delete_personal_event(event_id, delete_all_recurrence=true)
+      api_post 'MyOrganizer_DeletePersonalEvent_JSON', eventid: event_id, deleteallrecurrence: delete_all_recurrence
+    end
+
+    def my_organizer_special_days(start_date=nil, end_date=nil)
+      api 'MyOrganizer_SpecialDays', startdate: start_date, enddate: end_date
+    end
+
+    def my_organizer_acad_semester_info(acad_year, semester)
+      api 'MyOrganizer_AcadSemesterInfo', acadyear: acad_year, semester: semester
+    end
+
+    def timetable_student(acad_year, semester)
+      api 'Timetable_Student', acadyear: acad_year, semester: semester
+    end
+
+    def code_table_week_types
+      api 'CodeTable_WeekTypes'
+    end
+  end
+end

data/lib/IVLE/api/open_webcast_lectures.rb

@@ -0,0 +1,13 @@
+module IVLE
+  module OpenWebcastLectures
+    def open_webcasts(acad_year, semester, title_only=false, media_channel_id=nil)
+      params = { acadyear: acad_year, semester: semester, titleonly: title_only }
+      params.merge!({ mediachannelid: media_channel_id }) unless media_channel_id.nil?
+      api 'OpenWebcasts', params
+    end
+
+    def open_webcast_add_log(media_channel_id, media_channel_item_id)
+      api_post 'OpenWebcast_AddLog_JSON', mediachannelid: media_channel_id, mediachannelitemid: media_channel_item_id
+    end
+  end
+end