d2l_sdk 0.1.7

data/example_scripts/fix_201708_courses.rb

@@ -0,0 +1,13 @@
+require_relative "lib/d2l_sdk"
+
+# ap get_all_semesters.reject{|semester| !semester["Code"].include?(201708.to_s)}
+semester_201708_id = "111723" # Fall '17 semester recieved through line of code above
+courses = get_courses_by_code(201708) # get all courses coded as 201708
+courses_done = 0
+courses.each do |course| # for each of these 201708 courses
+  # print out progress thus far
+  puts "Progress: #{courses_done}/#{courses.length} (#{(courses_done/courses.length).to_i})" if courses_done % 10 == 0
+  course_id = course["Identifier"] # get their identifier
+  add_parent_to_org_unit(semester_201708_id, course_id) # add the semester as the parent
+  courses_done += 1
+end

data/example_scripts/update_enddates.rb

@@ -0,0 +1,88 @@
+require_relative "lib/d2l_sdk"
+require "set"
+
+@debug = false
+@testing = false
+start = Time.now
+puts "Getting all courses"
+all_courses = get_all_courses
+duration  = Time.now - start
+puts "#{all_courses.size} courses retrieved. Time taken: #{Time.at(duration).strftime "%M:%S"}"
+iteration = 0 #if @testing
+max_iterations = 10 if @testing
+start = Time.now
+
+def get_adjusted_courses(file_path)
+  # If there isnt already a file containing all adjusted courses, create one
+  File.write(file_path, '') {} unless File.exist?(file_path)
+  puts "Grabbing adjusted courses from file at: #{file_path}"
+  adjusted_courses = Set.new [] # assures unique student ids // none processed >1 times
+  File.open(file_path, 'r') do |file_handle|
+    file_handle.each_line do |line|
+      adjusted_courses.add(line.gsub(/\n/,''))
+    end
+  end
+  puts "adjusted courses pulled from file and stored in array 'adjusted_courses'"
+  adjusted_courses # Returns set of adjusted course OU IDs (would ruin time complexity with an array)
+end
+file_path = "adjusted_courses.txt"
+adjusted_courses = get_adjusted_courses(file_path)
+year_ago = Time.new(2016)
+all_courses.each do |course_arr_item|
+
+    # testing constraints to limit number of iterations.
+    iteration += 1
+    if @testing
+      break if iteration >= max_iterations
+    end
+
+    # append to a file (asserted that its already created as get_adjusted_courses handles this.)
+    course_id = course_arr_item["Identifier"]
+    if adjusted_courses.include?(course_id)
+      puts "Course [#{course_id}] already has been adjusted." if @debug
+      next
+    end
+    if course_arr_item["Identifier"].nil?
+      ap course_arr_item
+      next
+    end
+    # Retrieve course data by ID
+    course = get_course_by_id(course_id)
+    puts "Original course information returned by its id:" if @debug
+    File.open(file_path, 'a'){ |f| f << "#{course_id}\n"}
+    puts "Course [#{course["Name"]} (#{course_id})] has been added to #{file_path}" if @debug
+
+    ap course if @debug
+    new_end_date = course["EndDate"]
+    # if course endDate is nil, print a message and skip it
+    if new_end_date.nil?
+      puts "Course [#{course["Name"]} (#{course_id})] does not have a valid endDate (reason: nil)" if @debug
+      next
+    end
+    puts "[#{iteration}/#{all_courses.size}]Course [#{course["Name"]} (#{course_id})] original end date: #{new_end_date}"# if @debug
+    new_end_date = Time.parse(new_end_date) + (60 * 60 * 24 * 7) # Seconds * Minutes * Hours * Days
+    if new_end_date < year_ago # if before 2016...
+      puts "Course [#{course["Name"]} (#{course_id})] is not within the filtered set of classes (reason: before 2016)" if @debug
+      next
+    end
+    new_end_date = new_end_date.iso8601(3)
+
+    update_payload = {
+      'Name' => course["Name"], # String
+      'Code' => course["Code"], # String
+      'StartDate' => course["StartDate"], # String: UTCDateTime | nil
+      'EndDate' => "#{new_end_date}", # String: UTCDateTime | nil
+      'IsActive' => course["IsActive"] # bool
+    }
+    ap update_payload if @debug
+    update_course_data(course_id, update_payload)
+    updated_course = get_course_by_id(course_id)
+    puts "Course [#{updated_course["Name"]} (#{course_id})] adjusted end date: #{updated_course["EndDate"]}"
+
+    puts "Updated course information returned by its id:" if @debug
+    ap get_course_by_id(course_id) if @debug
+end
+#ap adjusted_courses.to_a
+#print "[!] duration of 5000 iterations, where 3000 have already been completed: "
+duration  = Time.now - start
+puts Time.at(duration).strftime "%M:%S"

data/lib/d2l_sdk.rb

@@ -0,0 +1,16 @@
+require_relative 'd2l_sdk/course_template'
+require_relative 'd2l_sdk/course'
+require_relative 'd2l_sdk/datahub'
+require_relative 'd2l_sdk/enroll'
+require_relative 'd2l_sdk/group'
+require_relative 'd2l_sdk/org_unit'
+require_relative 'd2l_sdk/section'
+require_relative 'd2l_sdk/semester'
+require_relative 'd2l_sdk/user'
+require_relative 'd2l_sdk/config_variables'
+require_relative 'd2l_sdk/demographics'
+require_relative 'd2l_sdk/logging'
+require_relative 'd2l_sdk/course_content'
+
+
+puts "d2l_sdk loaded"

data/lib/d2l_sdk/auth.rb

@@ -0,0 +1,95 @@
+require 'rubygems' # useful
+require 'awesome_print' # useful for debugging
+require 'base64' # NEEDED
+require 'json' # NEEDED
+require 'restclient' # NEEDED
+require 'openssl' # NEEDED
+require 'open-uri' # NEEDED
+require 'colorize' # useful
+require_relative 'config'
+
+# Global variables initialized through require_relative 'D2L_Config'
+
+# requests input from the user, cuts off any new line and downcases it.
+#
+# returns: String::downcased_user_input
+def prompt(*args)
+    print(*args)
+    gets.chomp.downcase
+    # returns: String::downcased_user_input
+end
+
+# Creates an authenticated uniform resource identifier that works with Valence
+# by calling +URI.parse+ using the path downcased, then creating a query string
+# by calling +_get_string+ with the parsed_url and the http_method. These are
+# used as the Variables and then returned as the finished uri.
+#
+# Input that is required is:
+#  * path: The path to the resource you are trying to accessing
+#  * http_method: The method utilized to access/modify the resource
+#
+# returns: String::uri
+def create_authenticated_uri(path, http_method)
+    parsed_url = URI.parse(path.downcase)
+    uri_scheme = 'https'
+    query_string = _get_string(parsed_url.path, http_method)
+    uri = uri_scheme + '://' + $hostname + parsed_url.path + query_string
+    uri << '&' + parsed_url.query if parsed_url.query
+    uri
+    # returns: String::uri
+end
+
+# Builds an authenticated uniform resource identifier query string that
+# works properly with the Valence API.
+#
+# Required Variables:
+# * app_id, user_id, app_key, user_key
+#
+# returns: String::'authenticated_uri'
+def build_authenticated_uri_query_string(signature, timestamp)
+    "?x_a=#{$app_id}"\
+    "&x_b=#{$user_id}"\
+    "&x_c=#{get_base64_hash_string($app_key, signature)}"\
+    "&x_d=#{get_base64_hash_string($user_key, signature)}"\
+    "&x_t=#{timestamp}"
+    # returns: String::'authenticated_uri'
+end
+
+# uses the path, http_method, and timestamp arguments to create a properly
+# formatted signature. Then, this is returned.
+#
+# returns: String::signature
+def format_signature(path, http_method, timestamp)
+    http_method.upcase + '&' + path.encode('UTF-8') + '&' + timestamp.to_s
+    # returns: String::signature
+end
+
+# uses the key and signature as arguments to create a hash using
+# +OpenSSL::HMAC.digest+ with an additional argument denoting the hashing
+# algorithm as 'sha256'. The hash is then encoded properly and all "="
+# are deleted to officially create a base64 hash string.
+#
+# returns: String::base64_hash_string
+def get_base64_hash_string(key, signature)
+    hash = OpenSSL::HMAC.digest('sha256', key, signature)
+    Base64.urlsafe_encode64(hash).delete('=')
+    # returns: String::base64_hash_string
+end
+
+# Used as a helper method for create_authenticated_uri in order to properly
+# create a query string that will (hopefully) work with the Valence API.
+# the arguments path and http_method are used as arguments with the current time
+# for +format_signature+ and +build_authenticated_uri_query_string+.
+#
+# returns: String::query_string
+def _get_string(path, http_method)
+    timestamp = Time.now.to_i
+    signature = format_signature(path, http_method, timestamp)
+    unless path.include? "/auth/api/token"
+      build_authenticated_uri_query_string(signature, timestamp)
+    else
+      # build authenticated query string not using typical schema
+      build_authenticated_token_uri_query_string(signature, timestamp)
+    end
+    # returns: String::query_string
+end

data/lib/d2l_sdk/config.rb

@@ -0,0 +1,56 @@
+#Is this the production environment?
+require 'json'
+@production = true
+@debug = true
+# Conditional on whether this is production or test server
+config_file_name = 'd2l_config.json'
+# If a configuration file already exists...
+if File.exist?(config_file_name)
+  config_file = File.read(config_file_name)
+  config = JSON.parse(config_file)
+  puts "[+] Configuration Variables:" if @debug
+  puts "[-] hostname: #{config["hostname"]}" if @debug
+  $hostname = config["hostname"]
+  puts "[-] user_id: #{config["user_id"]}" if @debug
+  $user_id = config["user_id"]
+  puts "[-] user_key: #{config["user_key"]}" if @debug
+  $user_key = config["user_key"]
+  puts "[-] app_id: #{config["app_id"]}" if @debug
+  $app_id = config["app_id"]
+  puts "[-] app_key: #{config["app_key"]}" if @debug
+  $app_key = config["app_key"]
+# else if a configuration file doesnt exist, create one and load the config vars!
+else
+  puts "[!] No file by the name 'd2l_config.json' found!"
+  puts "[-] Initializing 'd2l_config.json' in current directory..\n"\
+       "    Please enter the following information..."
+  # host of D2L server
+  print "hostname: "
+  $hostname = gets.chomp.gsub(/'|\"|https:\/\/|http:\/\/|/,'').strip
+  # api-user id
+  print "user_id: "
+  $user_id = gets.chomp.gsub(/'|\"/,'').strip
+  # api-user key
+  print "user_key: "
+  $user_key = gets.chomp.gsub(/'|\"/,'').strip
+  # app id (received from apitesttool)
+  print "app_id: "
+  $app_id = gets.chomp.gsub(/'|\"/,'').strip
+  # app key (same as app id retrieval)
+  print "app_key: "
+  $app_key = gets.chomp.gsub(/'|\"/,'').strip
+
+  config_hash = {
+    "hostname" => $hostname,
+    "user_id" => $user_id,
+    "user_key" => $user_key,
+    "app_id" => $app_id,
+    "app_key" => $app_key
+  }
+  json = JSON.pretty_generate(config_hash)
+  puts json if @debug
+  #puts JSON.parse(json)["hostname"] if @debug
+  config = File.new("d2l_config.json","w")
+  config.puts(json)
+  config.close
+end

data/lib/d2l_sdk/config_variables.rb

@@ -0,0 +1,81 @@
+require_relative 'auth'
+
+########################
+# CONFIG VARIABLES:#####
+########################
+@debug = false
+
+#Retrieve the definitions for all the configuration variables the user has access to view.
+def get_all_config_var_definitions(search='', bookmark='')
+  path = "/d2l/api/lp/#{$lp_ver}/configVariables/definitions/"
+  path += "?search=#{search}" if search != ''
+  path += "?bookmark=#{bookmark}" if bookmark != ''
+  _get(path)
+  #returns paged result set of Definition JSON data blocks
+end
+
+#Retrieve the definitions for a configuration variable.
+def get_config_var_definitions(variable_id)
+  path = "/d2l/api/lp/#{$lp_ver}/configVariables/(#{variable_id}/definition"
+  _get(path)
+  # returns Definition JSON data block
+end
+
+#Retrieve the value summary for a configuration variable.
+def get_config_var_values(variable_id)
+  path = "/d2l/api/lp/#{$lp_ver}/configVariables/#{variable_id}/values"
+  _get(path)
+  # returns Values JSON data block
+end
+
+#Retrieve the current org value for a configuration variable.
+def get_config_var_current_org_value(variable_id)
+  path = "/d2l/api/lp/#{$lp_ver}/configVariables/#{variable_id}/values/org"
+  _get(path)
+  # returns OrgValue JSON data block
+end
+
+# Retrieve all the org unit override values for a configuration variable.
+def get_all_config_var_org_unit_override_values(variable_id, bookmark='')
+  path = "/d2l/api/lp/#{$lp_ver}/configVariables/#{variable_id}/values/orgUnits/"
+  path += "?bookmark=#{bookmark}" if bookmark != ''
+  _get(path)
+  # returns paged result set of OrgUnitValue data blocks
+end
+
+# Retrieve an org unit override value for a configuration variable.
+def get_config_var_org_unit_override_value(variable_id, org_unit_id)
+  path = "/d2l/api/lp/#{$lp_ver}/configVariables/#{variable_id}/values/orgUnits/#{org_unit_id}"
+  _get(path)
+  # returns OrgUnitValue JSON block
+end
+
+# Retrieve the effective value for a configuration variable within an org unit.
+def get_config_var_org_unit_effective_value(variable_id, org_unit_id)
+  path = "/d2l/api/lp/#{$lp_ver}/configVariables/#{variable_id}/effectiveValues/orgUnits/#{org_unit_id}"
+  _get(path)
+  # returns OrgUnitValue JSON block
+end
+
+# Retrieve all the role override values for a configuration variable.
+def get_all_config_var_org_unit_role_override_values(variable_id, bookmark='')
+  path = "/d2l/api/lp/#{$lp_ver}/configVariables/#{variable_id}/values/roles/"
+  path += "?bookmark=#{bookmark}" if bookmark != ''
+  _get(path)
+  # returns paged result set with RoleValue JSON data blocks
+end
+
+def get_config_var_role_override_value(variable_id, role_id)
+  path = "/d2l/api/lp/#{$lp_ver}/configVariables/#{variable_id}/values/roles/#{role_id}"
+  _get(path)
+end
+
+def get_config_var_system_value(variable_id)
+  path = "/d2l/api/lp/#{$lp_ver}/configVariables/#{variable_id}/values/system"
+  _get(path)
+end
+
+def get_config_var_resolver(variable_id)
+  path = "/d2l/api/lp/#{lp_ver}/configVariables/#{variable_id}/resolver"
+  _get(path)
+end

data/lib/d2l_sdk/course.rb

@@ -0,0 +1,311 @@
+require_relative 'requests'
+require 'json-schema'
+########################
+# COURSES:##############
+########################
+
+# Checks whether the created course data conforms to the valence api for the
+# course data JSON object. If it does conform, then nothing happens and it
+# simply returns true. If it does not conform, then the JSON validator raises
+# an exception.
+def check_course_data_validity(course_data)
+    schema = {
+        'type' => 'object',
+        'required' => %w(Name Code CourseTemplateId SemesterId
+                         StartDate EndDate LocaleId ForceLocale
+                         ShowAddressBook),
+        'properties' => {
+            'Name' => { 'type' => 'string' },
+            'Code' => { 'type' => 'string' },
+            'CourseTemplateId' => { 'type' => 'integer' },
+            'SemesterId' => { 'type' => %w(integer null) },
+            'StartDate' => { 'type' => %w(string null) },
+            'EndDate' => { 'type' => %w(string null) },
+            'LocaleId' => { 'type' => %w(integer null) },
+            'ForceLocale' => { 'type' => 'boolean' },
+            'ShowAddressBook' => { 'type' => 'boolean' }
+        }
+    }
+    JSON::Validator.validate!(schema, course_data, validate_schema: true)
+end
+
+
+# Creates the course based upon a merged result of the argument course_data
+# and a preformatted payload. This is then passed as a new payload in the
+# +_post+ method in order to create the defined course.
+# Required: "Name", "Code"
+# Creates the course offering
+def create_course_data(course_data)
+    # ForceLocale- course override the user’s locale preference
+    # Path- root path to use for this course offering’s course content
+    #       if your back-end service has path enforcement set on for
+    #       new org units, leave this property as an empty string
+    # Define a valid, empty payload and merge! with the user_data. Print it.
+    # can be an issue if more than one course template associated with
+    # a course and the last course template parent to a course cannot be deleted
+    payload = { 'Name' => '', # String
+                'Code' => 'off_SEMESTERCODE_STARNUM', # String
+                'Path' => '', # String
+                'CourseTemplateId' => 99_989, # number: D2L_ID
+                'SemesterId' => nil, # number: D2L_ID  | nil
+                'StartDate' => nil, # String: UTCDateTime | nil
+                'EndDate' => nil, # String: UTCDateTime | nil
+                'LocaleId' => nil, # number: D2L_ID | nil
+                'ForceLocale' => false, # bool
+                'ShowAddressBook' => false # bool
+              }.merge!(course_data)
+    check_course_data_validity(payload)
+    # ap payload
+    # requires: CreateCourseOffering JSON block
+    path = "/d2l/api/lp/#{$lp_ver}/courses/"
+    _post(path, payload)
+    puts '[+] Course creation completed successfully'.green
+end
+
+# In order to retrieve an entire department's class list, this method uses a
+# predefined org_unit identifier. This identifier is then appended to a path
+# and all classes withiin the department are returned as JSON objects in an arr.
+#
+# returns: JSON array of classes.
+def get_org_department_classes(org_unit_id)
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}"
+    _get(path)
+    # returns: JSON array of classes.
+end
+
+# Performs a get request to retrieve a particular course using the org_unit_id
+# of this particular course. If the course does not exist, as specified by the
+# org_unit_id, the response is typically a 404 error.
+#
+# returns: JSON object of the course
+def get_course_by_id(org_unit_id)
+    path = "/d2l/api/lp/#{$lp_ver}/courses/#{org_unit_id}"
+    _get(path)
+    # returns: JSON object of the course
+end
+
+def get_all_courses
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/6606/descendants/?ouTypeId=3"
+    _get(path)
+end
+
+# much slower means of getting courses if less than 100 courses
+def get_courses_by_code(org_unit_code)
+  all_courses = get_all_courses
+  courses = []
+  all_courses.each do |course|
+    courses.push(course) if course["Code"].downcase.include? "#{org_unit_code}".downcase
+  end
+  courses
+end
+# Retrieves all courses that have a particular string (org_unit_name) within
+# their names. This is done by first defining that none are found yet and then
+# searching through all course  for ones that do have a particular string within
+# their name, the matches are pushed into the previously empty array of matches.
+# This array is subsequently returned; if none were found, a message is returned
+#
+# returns: JSON array of matching course  data objects
+def get_courses_by_name(org_unit_name)
+    get_courses_by_property_by_string('Name', org_unit_name)
+end
+
+# Retrieves all matching courses that are found using a property and a search
+# string. First, it is considered that the class is not found. Then, all courses
+# are retrieved and stored as a JSON array in the varaible +results+. After this
+# each of the +results+ is iterated, downcased, and checked for their matching
+# of the particular search string. If there is a match, they are pushed to
+# an array called +courses_results+. This is returned at the end of this op.
+#
+# returns: array of JSON course objects (that match the search string/property)
+def get_courses_by_property_by_string(property, search_string)
+    puts "[+] Searching for courses using search string: #{search_string}".yellow +
+         + " -- And property: #{property}"
+    courses_results = []
+    results = get_all_courses
+    results.each do |x|
+        if x[property].downcase.include? search_string.downcase
+            courses_results.push(x)
+        end
+    end
+    courses_results
+    # returns array of all matching courses in JSON format.
+end
+
+# Retrieves all courses that have the specified prop match a regular expression.
+# This is done by iterating through all courses and returning an array of all
+# that match a regular expression.
+#
+# returns: array of JSON course objects (with property that matches regex)
+def get_courses_by_property_by_regex(property, regex)
+    puts "[+] Searching for courses using regex: #{regex}".yellow +
+         + " -- And property: #{property}"
+    courses_results = []
+    results = get_all_courses
+    results.each do |x|
+        courses_results.push(x) if (x[property] =~ regex) != nil
+    end
+    courses_results
+    # returns array of all matching courses in JSON format.
+end
+
+# Checks whether the updated course data conforms to the valence api for the
+# update data JSON object. If it does conform, then nothing happens and it
+# simply returns true. If it does not conform, then the JSON validator raises
+# an exception.
+def check_updated_course_data_validity(course_data)
+    schema = {
+        'type' => 'object',
+        'required' => %w(Name Code StartDate EndDate IsActive),
+        'properties' => {
+            'Name' => { 'type' => 'string' },
+            'Code' => { 'type' => 'string' },
+            'StartDate' => { 'type' => ['string', "null"] },
+            'EndDate' => { 'type' => ['string', "null"] },
+            'IsActive' => { 'type' => "boolean" },
+        }
+    }
+    JSON::Validator.validate!(schema, course_data, validate_schema: true)
+end
+
+# Update the course based upon the first argument. This course object is first
+# referenced via the first argument and its data formatted via merging it with
+# a predefined payload. Then, a PUT http method is executed using the new
+# payload.
+# Utilize the second argument and perform a PUT action to replace the old data
+def update_course_data(course_id, new_data)
+    # Define a valid, empty payload and merge! with the new data.
+    payload = { 'Name' => '', # String
+                'Code' => 'off_SEMESTERCODE_STARNUM', # String
+                'StartDate' => nil, # String: UTCDateTime | nil
+                'EndDate' => nil, # String: UTCDateTime | nil
+                'IsActive' => false # bool
+              }.merge!(new_data)
+    check_updated_course_data_validity(payload)
+    # ap payload
+    # Define a path referencing the courses path
+    path = "/d2l/api/lp/#{$lp_ver}/courses/" + course_id.to_s
+    _put(path, payload)
+    # requires: CourseOfferingInfo JSON block
+    puts '[+] Course update completed successfully'.green
+    # Define a path referencing the course data using the course_id
+    # Perform the put action that replaces the old data
+    # Provide feedback that the update was successful
+end
+
+def is_course_component(key)
+  valid_components = %w(AttendanceRegisters Glossary News Checklists
+                        Grades QuestionLibrary Competencies GradesSettings
+                        Quizzes Content Groups ReleaseConditions CourseFiles
+                        Homepages Rubrics Discussions IntelligentAgents
+                        Schedule DisplaySettings Links SelfAssessments
+                        Dropbox LtiLink Surveys Faq LtiTP ToolNames Forms
+                        Navbars Widgets)
+  valid_components.include?(key)
+  # returns whether the key is actually a course component
+end
+
+def check_create_copy_job_request_validity(create_copy_job_request)
+    schema = {
+        'type' => 'object',
+        'required' => %w(SourceOrgUnitId Components CallbackUrl),
+        'properties' => {
+            'SourceOrgUnitId' => { 'type' => 'integer' },
+            'Components' => {
+                'type' => ['array', "null"],
+                'items' =>
+                  {
+                      'type' => "string"
+                  }
+            },
+            'CallbackUrl' => { 'type' => ['string', 'null'] }
+        }
+    }
+    JSON::Validator.validate!(schema, create_copy_job_request, validate_schema: true)
+end
+
+
+def create_new_copy_job_request(org_unit_id, create_copy_job_request)
+  payload =
+  {
+    'SourceOrgUnitId' => 0, # int
+    'Components' => nil, # [Str,...] || nil
+    'CallbackUrl' => nil # str | nil
+  }.merge!(create_copy_job_request)
+  # Check that the payload conforms to the JSON Schema of CreateCopyJobRequest
+  check_create_copy_job_request_validity(payload)
+  # Check each one of the components to see if they are valid Component types
+  payload["Components"].each do |component|
+    # If one of the components is not valid, cancel the CopyJobRequest operation
+    if(!is_course_component(key))
+      puts "'#{component}' specified is not a valid Copy Job Request component"
+      puts "Please retry with a valid course component such as 'Dropbox' or 'Grades'"
+      break
+    end
+  end
+  path = "/d2l/api/le/#{$le_ver}/import/#{org_unit_id}/copy/"
+  _post(path, payload)
+  # Returns CreateCopyJobResponse JSON block
+end
+
+def get_copy_job_request_status(org_unit_id, job_token)
+    path = "/d2l/api/le/#{le_ver}/import/#{org_unit_id}/copy/#{job_token}"
+    _get(path)
+    # returns GetCopyJobResponse JSON block
+    # GetImportJobResponse:
+    # {"JobToken" => <string:COPYJOBSTATUS_T>,
+    #  "TargetOrgUnitID" => <number:D2LID>,
+    #  "Status" => <string:IMPORTJOBTSTATUS_T>}
+    # States of getImport: UPLOADING, PROCESSING, PROCESSED, IMPORTING,
+    #                      IMPORTFAILED, COMPLETED
+end
+#########
+=begin
+def create_course_import_request(org_unit_id, callback_url = '')
+    path = "/d2l/le/#{le_ver}/import/#{org_unit_id}/imports/"
+    path += "?callbackUrl=#{callback_url}" if callback_url != ''
+    #_post(path, payload)
+    #_upload(path, json, file, 'POST', 'file', filename)
+
+end
+=end
+def get_course_import_job_request_status(org_unit_id, job_token)
+  path = "/d2l/api/le/#{le_ver}/import/#{org_unit_id}/imports/#{job_token}"
+  _get(path)
+  # returns GetImportJobResponse JSON block
+  # example:
+  # {"JobToken" => <string:COPYJOBSTATUS_T>}
+  # States: PENDING, PROCESSING, COMPLETE, FAILED, CANCELLED
+end
+
+def get_course_import_job_request_logs(org_unit_id, job_token, bookmark = '')
+  path = "/d2l/api/le/#{le_ver}/import/#{org_unit_id}/imports/#{job_token}/logs"
+  path += "?bookmark=#{bookmark}" if bookmark != ''
+  _get(path)
+  # returns PAGED RESULT of ImportCourseLog JSON blocks following bookmark param
+end
+
+# Deletes a course based, referencing it via its org_unit_id
+# This reference is created through a formatted path appended with the id.
+# Then, a delete http method is executed using this path, deleting the course.
+def delete_course_by_id(org_unit_id)
+    path = "/d2l/api/lp/#{$lp_ver}/courses/#{org_unit_id}" # setup user path
+    #ap path
+    _delete(path)
+    puts '[+] Course data deleted successfully'.green
+end
+
+# retrieve the list of parent org unit type constraints for course offerings
+def get_parent_outypes_courses_schema_constraints
+  path = "/d2l/api/lp/#{$lp_ver}/courses/schema"
+  _get(path)
+  # returns a JSON array of SchemaElement blocks
+end
+
+def get_course_image(org_unit_id, width = 0, height = 0)
+  path = "/d2l/api/lp/#{lp_ver}/courses/#{org_unit_id}/image"
+  if width > 0 && height > 0
+    path += "?width=#{width}"
+    path += "&height=#{height}"
+  end
+  _get(path)
+end