d2l_sdk 0.1.7

data/lib/d2l_sdk/datahub.rb

@@ -0,0 +1,213 @@
+require_relative 'requests'
+require 'json-schema'
+require 'zip'
+require 'csv'
+##########################
+# DATA HUB Import/Export##
+##########################
+
+# Requirements to work properly:
+# !!! 1. Custom Reporting Framework must be on
+# --- Organization Tools > Custom Reporting Framework > Click "Availability" Slider
+# --- This should have enabled it, otherwise you may need further permissions
+# !!! 2. Next, the API user must have the permissions
+# --- Roles and Permissions > ROLE > Filter by 'Custom Reporting Framework' >
+# --- Enable all reports you need.
+# !!! 3. EACH data set has its own permissions. These must be enabled.
+# --- The Insights tool must be on, this can be checked at:
+# ----- "Config variable browser" > tools > insights > ETL > isEnabled
+# ----- If the value is 0, then you must contact support to enable it
+# ----- If the value is 1, then move onto the next sub-step
+# --- Roles and Permissions > ROLES> Filter by 'Insights' > Enable "Can Export
+# --- Data Warehouse Reports" permission
+
+# Lists all available data sets
+def get_all_data_sets
+    _get("/d2l/api/lp/#{$lp_ver}/dataExport/list")
+    # returns a JSON array of DataSetData blocks
+end
+
+# Retrieve a data set
+def get_data_set(data_set_id)
+    _get("/d2l/api/lp/#{$lp_ver}/dataExport/list/#{data_set_id}")
+    # returns a DataSetData JSON block
+end
+
+# assures that the CreateExportJobData JSON block is valid based off of a
+# specified JSON schema.
+# filter names: startDate, endDate, roles, and parentOrgUnitId
+# --- startDate and EndDate must be UTC dates
+# --- parentOrgUnitId and roles are integers corresponding to an ou_id & role_id
+def validate_create_export_job_data(create_export_job_data)
+    schema = {
+        'type' => 'object',
+        # 'title'=>'the CreateExportJobData JSON block',
+        'required' => %w(DataSetId Filters),
+        'properties' => {
+            'DataSetId' => { 'type' => 'string' },
+            'Filters' => { # define the filter array
+                # 'description' => 'The array of filters for CreateExportJobData',
+                'type' => 'array',
+                'items' =>
+                  {
+                      'type' => "object",
+                      "properties" => {
+                        "Name" => {'type'=>"string"},
+                        "Value" => {'type'=>"string"}
+                      }
+                  }
+            }
+        }
+    }
+    #ap schema
+    JSON::Validator.validate!(schema, create_export_job_data, validate_schema: true)
+    # returns true if the CreateExportJobData JSON block is valid
+end
+
+# Create an export job for the requested data set
+def create_export_job(create_export_job_data)
+    # init payload and merge with export job data
+    payload = {
+        'DataSetId' => '',
+        'Filters' => [] # {"Name"=> "startDate", "Value" => UTCDATETIME STRING}
+    }.merge!(create_export_job_data)
+    validate_create_export_job_data(payload)
+    # Requires: CreateExportJobData JSON parameter
+    path = "/d2l/api/lp/#{$lp_ver}/dataExport/create"
+    _post(path, payload)
+    # returns ExportJobData JSON block
+end
+
+# List all available export jobs that you have previously submitted
+def get_all_export_jobs(bookmark = '') # optional parameter page -- integer
+    path = "/d2l/api/lp/#{$lp_ver}/dataExport/jobs"
+    path += "?bookmark=#{bookmark}" if bookmark != ''
+    _get(path)
+    # returns: JSON array of paged ExportJobData blocks, sorted by SubmitDate
+end
+
+# Retrieves information about a data export job that you have previously submitted.
+def get_data_export_job(export_job_id)
+    _get("/d2l/api/lp/#{$lp_ver}/dataExport/jobs/#{export_job_id}")
+    # returns: ExportJobData JSON block
+end
+
+def get_job_status_code(export_job_id)
+  get_data_export_job(export_job_id)["Status"] #if 2 is OKAY/COMPLETED
+end
+
+# Downloads the identified job and stores the zip within the working directory
+# Extracts zipped job contents in "export_jobs" folder of working directory
+def download_job_csv(export_job_id)
+    attempt = 0
+    puts "Attempting to download job: #{export_job_id}"
+    while attempt < 20 # Attempts 20 times (~3 mins) unless job failed.
+      status = get_job_status_code(export_job_id)
+      case status
+      when 2 # If the status was okay, break loop + return download of job
+        zip_fname = 'export1.zip'
+        puts "Job complete, writing to zip: #{zip_fname}"
+        File.write(zip_fname,_get_raw("/d2l/api/lp/#{$lp_ver}/dataExport/download/#{export_job_id}"))
+        unzip(zip_fname, /sec_|off_/) # unzip file; filter if Enrollments + CSV
+        puts "file downloaded and unzipped"
+        break
+      when /3|4/
+        puts "Job download failed due to status: #{status}"
+        if status == 3
+          puts "Status description: Error - An error occurred when processing the export"
+        else
+          puts "Status description: Deleted - File was deleted from file system"
+        end
+        break
+      else # else, print out the status and wait 10 seconds before next attempt
+        puts "The job is not currently ready to download\n Status Code: #{status}"
+        if status == 0
+          puts "Status description: Queued -  Export job has been received for processing."
+        else
+          puts "Status description: Processing - Currently in process of exporting data set."
+        end
+        puts "Sleeping for 10 seconds.."
+        sleep 10
+        attempt = attempt + 1
+      end
+      # returns: ZIP file containing a CSV file of data from the export job
+    end
+end
+
+# Unzip the file, applying a regex filter to the CSV if
+# the file is Enrollments data.
+def unzip(file_path, csv_filter = //)
+  puts "Unzipping file: #{file_path}"
+  # Unzip the file
+  Zip::File.open(file_path) { |zip_file|
+    # for each file in the zip file
+     zip_file.each { |f|
+     # create file path of export_jobs/#{f.name}
+     f_path=File.join("export_jobs", f.name)
+     # make the directory if not already made
+     FileUtils.mkdir_p(File.dirname(f_path))
+     # extract the file unless the file already exists
+     zip_file.extract(f, f_path) unless File.exist?(f_path)
+     # if the file is CSV and Enrollments, apply filters and proper
+     # CSV formatting to the file, writing it as base f.name  + filtered.csv
+     if (f.name.include? ".csv") && (f.name.include? "Enrollments")
+       filter_formatted_enrollments("export_jobs/#{f.name}", csv_filter, "export_jobs/instr.csv")
+     end
+   }
+  }
+end
+
+# Get all 'current' courses, assuming all instr courses are current
+# and add their sec/off course_term_star_num codes to a set.
+# return: set of current classes formatted as "#{course_term}_#{star_number}"
+def get_current_courses(csv_fname)
+  puts "Retrieving current courses from #{csv_fname}"
+  instr_courses = Set.new
+  CSV.foreach(csv_fname, :headers => true) do |row|
+    star_number = row[0]
+    course_term = row[10]
+    instr_courses.add("#{course_term}_#{star_number}")
+  end
+  instr_courses
+end
+
+# Filter all enrollments and withdrawals in a csv file, excluding data
+# that is not properly formatted (based on ou code), not a current or
+# future course, or nil for their ou code.
+def filter_formatted_enrollments(csv_fname, regex_filter = //, instr_fname)
+  # Create csv with 'filtered' pre-appended to '.csv' substring
+  filtered_csv = csv_fname.gsub(/\.csv/,"filtered.csv")
+  File.open(filtered_csv, 'w') do |file|
+    # set row num to 0 to keep track of headers
+    row_num = 0
+    current = get_current_courses(instr_fname)
+    # for each row
+    puts "Filtering #{csv_fname}"
+    CSV.foreach(csv_fname) do |row|
+      # the line is initialized as an empty string
+      line = ""
+      # Skip the row if not a valid
+        # or skip in-filter OU_code,
+        # or skip if the header
+        # or skip if not within the INSTR SET of current/future courses
+      if row[3] == nil || row_num > 0 && !(row[3] =~ regex_filter) || (!current.include? row[3][4..-1])
+        row_num += 1
+        next
+      end
+      # for values not filtered from above ^
+      # for all of these values
+      row[0..-1].each do |value|
+        # If it a UTC date time value, then parse as Time.
+        if value =~ /\b[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]*Z\b/ # if the value is UTC formatted
+          line << "\"#{Time.parse(value)}\""
+        elsif value == row[-1]# if its the last value in the row
+          line <<"\"#{value}\"" #  then dont put a comma at the end.
+        else # not the last value in the row,
+          line << "\"#{value}\"," # throw a comma after the value
+        end
+      end
+      file.write(line + "\n") # append this line to the csv
+      row_num += 1 # increment the row number
+    end
+  end
+end

data/lib/d2l_sdk/demographics.rb

@@ -0,0 +1,89 @@
+require_relative 'requests'
+require 'json-schema'
+
+########################
+# DEMOGRPAHICS:#########
+########################
+
+###### Actions
+
+# Delete one or more of a particular user's associated demographics entries.
+# if no entries specified, it DELETES ALL.
+# entry_ids are added as additional variables
+# entry_ids is a CSV formatted string
+def delete_user_demographics(user_id, entry_ids = '')
+  path = "/d2l/api/lp/#{$lp_ver}/demographics/users/#{user_id}"
+  path += "?entryIds=" + entry_ids if entry_ids != ''
+  _delete(path)
+end
+
+# optional params: fieldIds, roleIds, and userIds are CSV formatted Strings
+#                  search and bookmark are Strings
+# retrieve all the demographics entries for all users enrolled in an OU
+def get_all_demographics_by_org_unit(org_unit_id, field_ids = '', role_ids = '',
+                                     user_ids = '', search = '', bookmark = '')
+    path = "/d2l/api/lp/#{$lp_ver}/demographics/orgUnits/#{org_unit_id}/users/"
+    path += "?fieldIds=" + field_ids if field_ids != ''
+    path += "?roleIds=" + role_ids if role_ids != ''
+    path += "?userIds=" + user_ids if user_ids != ''
+    path += "?search=" + search if search != ''
+    path += "?bookmark=" + bookmark if bookmark != ''
+    _get(path)
+    # returns paged result set of DemographicsUserEntryData JSON blocks
+end
+
+# retrieve all the demographics entries for a specific user within an OU
+def get_all_demographics_by_org_unit_by_user(org_unit_id, user_id, field_ids = '')
+  path = "/d2l/api/lp/#{$lp_ver}/demographics/orgUnits/#{org_unit_id}/users/(#{user_id})"
+  path += "#{field_ids}" if field_ids != ''
+  _get(path)
+  # returns DemographicsUserEntryData JSON block
+end
+
+# retrieve all demographics entries for all users with specified filters
+def get_all_demographics(field_ids = '', role_ids = '', user_ids = '',
+                         search = '', bookmark = '')
+  path = "/d2l/api/lp/#{$lp_ver}/demographics/users/"
+  path += "#{field_ids}" if field_ids != ''
+  path += "#{role_ids}" if role_ids != ''
+  path += "#{user_ids}" if user_ids != ''
+  path += "#{search}" if search != ''
+  path += "#{bookmark}" if bookmark != ''
+  _get(path)
+  # returns paged result set of DemographicsUserEntryData JSON blocks
+end
+
+
+###### FIELDS
+# retrieve list of all demographics fields
+def get_all_demographic_fields(bookmark = '')
+  path = "/d2l/api/lp/#{$lp_ver}/demographics/fields/"
+  path += "#{bookmark}" if bookmark != ''
+  _get(path)
+  # returns paged result set of DemographicsField JSON blocks
+end
+
+# retrieve a single demographic field
+def get_demographic_field(field_id)
+  path = "/d2l/api/lp/#{$lp_ver}/demographics/fields/#{field_id}"
+  _get(path)
+  # returns fetch form of DemographicsField JSON block
+end
+
+###### DATA TYPES
+
+# retrieve the list of all demographics data types
+# uses DataTypeId's as a paging control value
+def get_all_demographic_types(bookmark = '')
+  path = "/d2l/api/lp/#{$lp_ver}/demographics/dataTypes/"
+  path += "#{bookmark}" if bookmark != ''
+  _get(path)
+  # returns paged result set of DemographicsDataType JSON blocks
+end
+
+# retrieve a single demographic data type
+def get_demographic_type(data_type_id)
+  path = "/d2l/api/lp/#{$lp_ver}/demographics/dataTypes/#{data_type_id}"
+  _get(path)
+  # returns DemographicsDataType JSON block
+end

data/lib/d2l_sdk/enroll.rb

@@ -0,0 +1,133 @@
+require_relative 'requests'
+require 'json-schema'
+########################
+# Enrollments:##########
+########################
+
+# Check the validity of the CreateEnrollmentData that is passed as a payload
+def check_create_enrollment_data_validity(enrollment_data)
+    schema = {
+        'type' => 'object',
+        'required' => %w(OrgUnitId UserId RoleId),
+        'properties' => {
+            'OrgUnitId' => { 'type' => 'integer' },
+            'UserId' => { 'type' => 'integer' },
+            'RoleId' => { 'type' => 'integer' },
+        }
+    }
+    JSON::Validator.validate!(schema, enrollment_data, validate_schema: true)
+end
+
+# Create a new enrollment for a user.
+def create_user_enrollment(course_enrollment_data)
+    payload = { 'OrgUnitId' => '', # String
+                'UserId' => '', # String
+                'RoleId' => '', # String
+              }.merge!(course_enrollment_data)
+    # ap payload
+    # requires: CreateEnrollmentData JSON block
+    path = "/d2l/api/lp/#{$lp_ver}/enrollments/"
+    _post(path, payload)
+    puts '[+] User successfully enrolled'.green
+    # Returns: EnrollmentData JSON block for the newly enrolled user.
+end
+
+# Retrieve enrollment details in an org unit for the provided user.
+# Same as +get_org_unit_enrollment_data_by_user+
+def get_user_enrollment_data_by_org_unit(user_id, org_unit_id)
+    path = "/d2l/api/lp/#{$lp_ver}/enrollments/users/#{user_id}/orgUnits/#{org_unit_id}"
+    _get(path)
+    # Returns: EnrollmentData JSON block.
+end
+
+# Retrieve a list of all enrollments for the provided user.
+# Optional params:
+# --orgUnitTypeId (CSV of D2LIDs)
+# --roleId: D2LIDs
+# --bookmark: string
+def get_all_enrollments_of_user(user_id, org_unit_type_id = 0, role_id = 0,
+                                bookmark = '')
+    path = "/d2l/api/lp/1.3/enrollments/users/#{user_id}/orgUnits/"
+    path += "?orgUnitTypeId=#{org_unit_type_id}" if org_unit_type_id != 0
+    path += "?roleId=#{role_id}" if role_id != 0
+    path += "?bookmark=#{bookmark}" if bookmark != ''
+    _get(path)
+    # Returns: paged result set w/ the resulting UserOrgUnit data blocks
+end
+
+# Retrieve enrollment details for a user in the provided org unit.
+# Note:
+# Same as +get_user_enrollment_data_by_org_unit+
+# This call is equivalent to the route that fetches by specifying the user first,
+# and then the org unit.
+def get_org_unit_enrollment_data_by_user(org_unit_id, user_id)
+    path = "/d2l/api/lp/#{$lp_ver}/orgUnits/#{org_unit_id}/users/#{user_id}"
+    _get(path)
+    # Returns: EnrollmentData JSON block.
+end
+
+# Retrieve the collection of users enrolled in the identified org unit.
+# Optional params:
+# --roleId: D2LID
+# --bookmark: String
+def get_org_unit_enrollments(org_unit_id, role_id = 0, bookmark = '')
+    path = "/d2l/api/lp/#{$lp_ver}/enrollments/orgUnits/#{org_unit_id}/users/"
+    path += "?roleId=#{role_id}" if role_id != 0
+    path += "?bookmark=#{bookmark}" if bookmark != ''
+    _get(path)
+    # Returns: paged result set containing the resulting OrgUnitUser data blocks
+end
+
+# Retrieve the enrollment details for the current user in the provided org unit.
+def get_enrollments_details_of_current_user
+    path = "/d2l/api/lp/#{$lp_ver}/enrollments/myenrollments/org_unit_id/"
+    _get(path)
+    # Returns: MyOrgUnitInfo JSON block.
+end
+
+# Retrieve the list of all enrollments for the current user
+# Optional params:
+# --orgUnitTypeId: CSV of D2LIDs
+# --bookmark: String
+# --sortBy: string
+# --isActive: bool
+# --startDateTime: UTCDateTime
+# --endDateTime: UTCDateTime
+# --canAccess: bool
+def get_all_enrollments_of_current_user(bookmark = '', sort_by = '', is_active = nil,
+                                        start_date_time = '', end_date_time = '',
+                                        can_access = nil)
+    path = "/d2l/api/lp/#{$lp_ver}/enrollments/myenrollments/"
+    path += "?bookmark=#{bookmark}" if bookmark != ''
+    path += "?sortBy=#{sort_by}" if sort_by != ''
+    path += "?isActive=#{is_active}" if is_active != nil
+    path += "?startDateTime=#{start_date_time}" if start_date_time != ''
+    path += "?endDateTime=#{end_date_time}" if end_date_time != ''
+    path += "?canAccess=#{can_access}" if can_access != nil
+    _get(path)
+    # Returns: paged result set containing the resulting MyOrgUnitInfo data blocks
+end
+
+# Retrieve the enrolled users in the classlist for an org unit
+def get_enrolled_users_in_classlist(org_unit_id)
+    path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/classlist/"
+    _get(path)
+    # Returns: JSON array of ClasslistUser data blocks.
+end
+
+# Delete a user’s enrollment in a provided org unit.
+def delete_user_enrollment(user_id, org_unit_id)
+    path = "/d2l/api/lp/#{$lp_ver}/users/#{user_id}/orgUnits/#{org_unit_id}"
+    _delete(path)
+    # Returns: EnrollmentData JSON block showing the enrollment status
+    #          just before this action deleted the enrollment of the user
+end
+
+
+# Delete a user’s enrollment in a provided org unit.
+def delete_user_enrollment_alternative(user_id, org_unit_id)
+    path = "/d2l/api/lp/#{$lp_ver}/enrollments/orgUnits/#{org_unit_id}/users/#{user_id}"
+    _delete(path)
+    # Returns: EnrollmentData JSON block showing the enrollment status
+    #          just before this action deleted the enrollment of the user
+end

data/lib/d2l_sdk/group.rb

@@ -0,0 +1,232 @@
+require_relative 'requests'
+require 'json-schema'
+####################################
+# Groups/Group Categories:##########
+####################################
+# Delete a particular group category from an org unit.
+def delete_group_category(org_unit_id, group_category_id)
+   path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/groupcategories/#{group_category_id}"
+   _delete(path)
+end
+
+# Delete a particular group from an org unit.
+def delete_group(org_unit_id, group_category_id, group_id)
+  path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/groupcategories/#{group_category_id}/groups/(groupId)"
+  _delete(path)
+end
+
+# Remove a particular user from a group.
+def remove_user_from_group(org_unit_id, group_category_id, group_id, user_id)
+  path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/groupcategories/#{group_category_id}/groups/#{group_id}/enrollments/#{user_id}"
+  _delete(path)
+end
+
+# Retrieve a list of all the group categories for the provided org unit.
+def get_all_org_unit_group_categories(org_unit_id)
+  path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/groupcategories/"
+  _get(path)
+end
+
+# Retrieve a particular group category for an org unit.
+def get_org_unit_group_category(org_unit_id, group_category_id)
+  path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/groupcategories/#{group_category_id}"
+  _get(path)
+end
+
+# Retrieve a list of all the groups in a specific group category for an OrgUnit
+def get_all_group_category_groups(org_unit_id, group_category_id)
+  path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/groupcategories/#{group_category_id}/groups/"
+  _get(path)
+end
+
+# Retrieve a particular group in an org unit.
+def get_org_unit_group(org_unit_id, group_category_id, group_id)
+  path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/groupcategories/#{group_category_id}/groups/#{group_id}"
+  _get(path)
+end
+
+######
+######
+
+def validate_create_group_category_data(group_category_data)
+  schema = {
+      'type' => 'object',
+      'required' => %w(Name Description EnrollmentStyle
+                      EnrollmentQuality AutoEnroll RandomizeEnrollments
+                      NumberOfGroups MaxUsersPerGroup AllocateAfterExpiry
+                      SelfEnrollmentExpiryDate GroupPrefix),
+      'properties' => {
+          'Name' => { 'type' => 'string' },
+          'Description' =>
+          {
+            'type' => 'object',
+            'properties'=>{
+              "Content" => "string",
+              "Type" => "string" #"Text|HTML"
+            }
+          }, #RichTextInput
+          # if set to SingleUserMemberSpecificGroup, values set for NumberOfGroups
+          # and MaxUsersPerGroup are IGNORED
+          # ----------------------------------
+          # GPRENROLL_T integer value meanings
+          # 0 = NumberOfGrupsNoEnrollment ^
+          # 1 = PeoplePerGroupAutoEnrollment
+          # 2 = NumerOfGroupsAutoEnrollment
+          # 3 = PeoplePerGroupSelfEnrollment
+          # 4 = SelfEnrollmentNumberOfGroups
+          # 5 = PeoplePerNumberOfGroupsSelfEnrollment
+          # ----------------------------------
+          'EnrollmentStyle' => { 'type' => 'integer' }, #num GRPENROLL_T
+           # if non-nil, values for NumberOfGroups and MaxUsersPerGroup are IGNORED
+          'EnrollmentQuantity' => { 'type' => %w(integer null) },
+          'AutoEnroll' => { 'type' => 'boolean'},
+          'RandomizeEnrollments' => { 'type' => 'boolean' },
+          'NumberOfGroups' => { 'type' => %w(integer null) }, #nil, 0, 1, 3, 5
+          'MaxUsersPerGroup' => { 'type' => %w(integer null) }, #1, 3, 5
+          # if MaxUsersPerGroup has a value, then set this to true.
+          'AllocateAfterExpiry' => { 'type' => 'boolean' },
+          'SelfEnrollmentExpiryDate' => { 'type' => %w(string null) }, #UTCDATETIME
+          # Prepends group prefix to GroupName and GroupCode
+          'GroupPrefix' => { 'type' => %w(string null) }
+      }
+  }
+  JSON::Validator.validate!(schema, group_category_data, validate_schema: true)
+end
+
+####
+#### See +validate_create_group_category_data+ for details on schema formal
+#### requirements of values
+# Create a new group category for an org unit.
+def create_org_unit_group_category(org_unit_id, group_category_data)
+  payload = { 'Name' => '', # String
+              'Description' => {}, # RichTextInput
+              'EnrollmentStyle' => 0, # number : group_enroll
+              'EnrollmentQuantity' => nil, # number | null
+              'AutoEnroll' => false, # bool
+              'RandomizeEnrollments' => false, # bool
+              'NumberOfGroups' => nil, # number | nil
+              'MaxUsersPerGroup' => nil, # number | nil
+              'AllocateAfterExpiry' => false, # bool
+              'SelfEnrollmentExpiryDate' => nil, # string: UTCDateTime | nil
+              'GroupPrefix' => nil, # String | nil
+            }.merge!(group_category_data)
+  # Requires: JSON block of GroupCategoryData
+  path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/groupcategories/"
+  _post(path, payload)
+  # returns a GroupCategoryData JSON block, in the Fetch form, of the new categ.
+end
+
+def validate_group_data(group_data)
+  schema =
+  {
+      'type' => 'object',
+      'required' => %w(Name Code Description),
+      'properties' =>
+      {
+          'Name' => { 'type' => 'string' },
+          "Code" => {'type' => 'string'},
+          'Description' =>
+          {
+            'type' => 'object',
+            'properties'=>
+            {
+              "Content" => "string",
+              "Type" => "string" #"Text|HTML"
+            }
+          }
+      }
+  }
+  JSON::Validator.validate!(schema, group_data, validate_schema: true)
+end
+
+# Create a new group for an org unit.
+def create_org_unit_group(org_unit_id, group_category_id, group_data)
+  payload =
+  {
+    "Name" => "string",
+    "Code" => "string",
+    "Description" => {}
+  }.merge!(group_data)
+  # Requires: JSON block of GroupData
+  path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/groupcategories/#{group_category_id}/groups/"
+  _post(path, payload)
+  # returns a GroupData JSON block, in the Fetch form, of the new group
+end
+
+# Update a particular group for an org unit
+def update_org_unit_group(org_unit_id, group_category_id, group_id, group_data)
+  payload = {
+    "Name" => "string",
+    "Code" => "string",
+    "Description" => {}
+  }.merge!(group_data)
+  # Requires: JSON block of GroupData
+  validate_group_data(payload)
+  path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/groupcategories/#{group_category_id}/groups/#{group_id}"
+  # returns a GroupData JSON block, in the Fetch form, of the updated group.
+  _put(path, payload)
+end
+
+def validate_group_enrollment_data(group_enrollment_data)
+  schema = {
+      'type' => 'object',
+      'required' => %w(UserId),
+      'properties' => {
+          'UserId' => { 'type' => 'integer' }
+      }
+  }
+  JSON::Validator.validate!(schema, course_data, validate_schema: true)
+end
+
+# Enroll a user in a group
+def enroll_user_in_group(org_unit_id, group_category_id, group_id, user_id)
+  payload = {
+    "UserId" => user_id
+  }
+  # Requires: JSON block of GroupEnrollment
+  path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/groupcategories/#{group_category_id}/groups/#{group_id}/enrollments/"
+  validate_group_enrollment_data(payload)
+  _post(path, payload)
+end
+
+def validate_update_group_category_data(group_category_data)
+  schema = {
+      'type' => 'object',
+      'required' => %w(Name Description AutoEnroll RandomizeEnrollments),
+      'properties' => {
+          'Name' => { 'type' => 'string' },
+          'Description' =>
+          {
+            'type' => 'object',
+            'properties'=>{
+              "Content" => "string",
+              "Type" => "string" #"Text|HTML"
+            }
+          },
+          'AutoEnroll' => { 'type' => 'boolean'},
+          'RandomizeEnrollments' => { 'type' => 'boolean' }
+      }
+  }
+  JSON::Validator.validate!(schema, group_category_data, validate_schema: true)
+end
+
+# update a particular group category for an org unit
+def update_org_unit_group_category(org_unit_id, group_category_id, group_category_data)
+
+  payload = { 'Name' => '', # String
+              'Description' => {}, # RichTextInput
+              'AutoEnroll' => false, # bool
+              'RandomizeEnrollments' => false, # bool
+            }.merge!(group_category_data)
+  # Requires: JSON block of GroupCategoryData
+  validate_update_group_category_data(payload)
+  path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/groupcategories/#{group_category_data}"
+  _put(path, payload)
+  # Returns a GroupCategoryData JSON block, in the Fetch form, of updated grp. cat.
+end
+
+def is_group_category_locker_set_up(org_unit_id, group_category_id)
+    path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/groupcategories/#{group_category_id}/locker"
+    _get(path)["HasLocker"]
+    #returns true if the group cat. locker has been setup already
+end