d2l_sdk 0.1.10 → 0.1.11

data/lib/d2l_sdk/course_content.rb

@@ -51,7 +51,7 @@ def get_topic_file(org_unit_id, topic_id, stream = false) # GET
   _get(query_string)
 end
 
-# TODO Add a child +module+ or +topic+ to a specific module’s structure.
+# TODO: Add a child +module+ or +topic+ to a specific module’s structure.
 # Can be used in multiple ways. D2L categorizes it into 3 different ways:
 # --Module: add child module to parent module
 # --Link Topic: add child topic to parent module structure consisting of a LINK
@@ -66,10 +66,11 @@ end
 #               1. +ContentObjectData+ JSON data block of type Topic
 #               2. File attachment data itself you want to store in OU content area
 # Returns (if successful) a JSON data block containing properties of the newly created object
-def add_child_to_module(org_unit_id, module_id, child ={}) # POST
+def add_child_to_module(org_unit_id, module_id, child = {}) # POST
   path = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/content/modules/#{module_id}/structure/"
   payload = {}
-  if child.key?("module") # TODO: modules
+  # TODO: Add child module to a module
+  if child.key?("module")
     payload = {
       "Title" => "title_string", # String
       "ShortTitle" => "title_short_string", # String
@@ -83,22 +84,23 @@ def add_child_to_module(org_unit_id, module_id, child ={}) # POST
         "Text" => "blank",
         "HTML" => ""
       },
-      "Duration" => nil, #nil, number
+      "Duration" => nil, # nil, number
     }.merge!(child["module"])
     _post(path, payload)
-  elsif child.key?("link") # TODO: link-type topics
+  # TODO: Add child link-type topics to a module
+  elsif child.key?("link")
     payload = {
       "Title" => "title_string", # String
       "ShortTitle" => "title_short_string", # String
       "Type" => 1,
-      "TopicType" => 3, #<number:TOPIC_T>
+      "TopicType" => 3, # <number:TOPIC_T>
       "Url" => "URL", # the URL you want to fetch when the user opens the link-type topic.
       "StartDate" => nil, # nil || string:UTCDateTime
       "EndDate" => nil, # nil || string:UTCDateTime
       "DueDate" => nil, # nil || string:UTCDateTime
       "IsHidden" => false,
       "IsLocked" => false,
-      "OpenAsExternalResource" => nil, #or boolean
+      "OpenAsExternalResource" => nil, # or boolean
       "description" => {
         "Text" => "",
         "HTML" => nil # -or- HTML formatted string
@@ -106,10 +108,11 @@ def add_child_to_module(org_unit_id, module_id, child ={}) # POST
       "MajorUpdate" => nil, # or bool
       "MajorUpdateText" => "MajorUpdateText",
       "ResetCompletionTracking" => nil, # or bool
-      "Duration" => nil, #nil, number
+      "Duration" => nil, # nil, number
     }.merge!(child["module"])
     _post(path, payload)
-  elsif child.key?("file") # TODO: file-type topics
+  # TODO: Add child file-type topics to a module
+  elsif child.key?("file")
     _course_content_upload(query_string, payload, file, "POST")
   end
 end
@@ -131,13 +134,13 @@ def check_content_module_validity(content_module)
             'IsLocked' => { 'type' => 'boolean' },
             'Description' => {
               'type' => 'object',
-              'properties'=>
+              'properties' =>
               {
                 "Content" => "string",
-                "Type" => "string" #"Text|HTML"
+                "Type" => "string" # "Text|HTML"
               }
             }, # Added with LE v1.10 API
-            'Duration' => { 'type' => %w(integer null) } #Added in LE's unstable contract as of LE v10.6.8
+            'Duration' => { 'type' => %w(integer null) } # Added in LE's unstable contract as of LE v10.6.8
         }
     }
     JSON::Validator.validate!(schema, content_module, validate_schema: true)
@@ -146,7 +149,7 @@ end
 def check_content_topic_validity(content_topic)
     schema = {
         'type' => 'object',
-        'required' => %w(Title ShortTitle Type  TopicType Url StartDate
+        'required' => %w(Title ShortTitle Type TopicType Url StartDate
                          EndDate DueDate IsHidden IsLocked OpenAsExternalResource
                          Description MajoyUpdate MajorUpdateText ResetCompletionTracking),
         'properties' => {
@@ -162,15 +165,15 @@ def check_content_topic_validity(content_topic)
             'OpenAsExternalResource' => { 'type' => %w(boolean null) }, # Added with LE v1.6 API
             'Description' => { # Added with LE v1.10 API
               'type' => 'object',
-              'properties'=>
+              'properties' =>
               {
                 "Content" => "string",
-                "Type" => "string" #"Text|HTML"
+                "Type" => "string" # "Text|HTML"
               }
             },
             'MajorUpdate' => { 'type' => %w(boolean null) }, # Added with LE v1.12 API
-            'MajorUpdateText' => { 'type' => 'string' }, #Added with LE v1.12 API
-            'ResetCompletionTracking' => { 'type' => %w(boolean null) } #Added with LE v1.12 API
+            'MajorUpdateText' => { 'type' => 'string' }, # Added with LE v1.12 API
+            'ResetCompletionTracking' => { 'type' => %w(boolean null) } # Added with LE v1.12 API
         }
     }
     JSON::Validator.validate!(schema, content_topic, validate_schema: true)
@@ -185,12 +188,12 @@ def create_root_module(org_unit_id, content_module) # GET
     "Title" => "",
     "ShortTitle" => "",
     "Type" => 0,
-    "ModuleStartDate" => nil, #<string:UTCDateTime>|null
-    "ModuleEndDate" => nil, #<string:UTCDateTime>|null
-    "ModuleDueDate" => nil, #<string:UTCDateTime>|null
+    "ModuleStartDate" => nil, # <string:UTCDateTime>|null
+    "ModuleEndDate" => nil, # <string:UTCDateTime>|null
+    "ModuleDueDate" => nil, # <string:UTCDateTime>|null
     "IsHidden" => false,
     "IsLocked" => false,
-    "Description" => nil, #{ <composite:RichTextInput> }|null --Added with LE v1.10 API
+    "Description" => nil, # { <composite:RichTextInput> }|null --Added with LE v1.10 API
     "Duration" => nil #  <number>|null --Added in LE's +unstable+ contract as of LE v10.6.8
   }.merge!(content_module)
   check_content_module_validity(payload)
@@ -200,18 +203,18 @@ end
 # Update a particular module for an org unit.
 # INPUT: ContentObjectData of type Module
 # NOTE: Cannot use this action to affect a module’s existing Structure property.
-def update_module(org_unit_id, module_id) # PUT
+def update_module(org_unit_id, module_id, content_module) # PUT
   query_string = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/content/modules/#{module_id}"
   payload = {
     "Title" => "",
     "ShortTitle" => "",
     "Type" => 0,
-    "ModuleStartDate" => nil, #<string:UTCDateTime>|null
-    "ModuleEndDate" => nil, #<string:UTCDateTime>|null
-    "ModuleDueDate" => nil, #<string:UTCDateTime>|null
+    "ModuleStartDate" => nil, # <string:UTCDateTime>|null
+    "ModuleEndDate" => nil, # <string:UTCDateTime>|null
+    "ModuleDueDate" => nil, # <string:UTCDateTime>|null
     "IsHidden" => false,
     "IsLocked" => false,
-    "Description" => nil, #{ <composite:RichTextInput> }|null --Added with LE v1.10 API
+    "Description" => nil, # { <composite:RichTextInput> }|null --Added with LE v1.10 API
     "Duration" => nil #  <number>|null --Added in LE's +unstable+ contract as of LE v10.6.8
   }.merge!(content_module)
   check_content_module_validity(payload)
@@ -236,8 +239,8 @@ def update_topic(org_unit_id, topic_id, content_topic) # GET
       'OpenAsExternalResource' => nil, # Added with LE v1.6 API
       'Description' => nil,
       'MajorUpdate' => nil, # Added with LE v1.12 API
-      'MajorUpdateText' => "", #Added with LE v1.12 API
-      'ResetCompletionTracking' => nil #Added with LE v1.12 API
+      'MajorUpdateText' => "", # Added with LE v1.12 API
+      'ResetCompletionTracking' => nil # Added with LE v1.12 API
   }.merge!(content_topic)
   check_content_topic_validity(content_topic)
   _put(query_string, payload)
@@ -304,7 +307,7 @@ def validate_isbn_association_data(isbn_association_data)
       'properties' => {
           'OrgUnitId' => { 'type' => 'integer' },
           'Isbn' => { 'type' => 'string' },
-          'IsRequired' => { 'type' => 'boolean' },
+          'IsRequired' => { 'type' => 'boolean' }
       }
   }
   JSON::Validator.validate!(schema, isbn_association_data, validate_schema: true)
@@ -316,7 +319,7 @@ def create_isbn_org_unit_association(org_unit_id, isbn_association_data) # GET
   payload = {
     "OrgUnitId" => 0,
     "Isbn" => ""
-    #"IsRequired" => false ## optional
+    # "IsRequired" => false ## optional
   }.merge!(isbn_association_data)
   _post(query_string, payload)
   # Returns: a IsbnAssociation JSON data block specifying
@@ -327,9 +330,9 @@ end
 ### SCHEDULED ITEMS######
 #########################
 
-# REVIEW: Retrieve the calling user’s scheduled items.
-def get_user_overdue_items(org_unit_ids_CSV, completion = nil,
-                           start_date_time = '', end_date_time = '') # GET
+# REVIEW: Retrieve the calling user scheduled items.
+def get_calling_user_scheduled_items(org_unit_ids_CSV, completion = nil,
+                                     start_date_time = '', end_date_time = '') # GET
   query_string = "/d2l/api/le/#{$le_ver}/content/myItems/?"
   query_string += "orgUnitIdsCSV=#{org_unit_ids_CSV}&"
   query_string += "completion=#{completion}&" unless completion.nil?
@@ -339,9 +342,9 @@ def get_user_overdue_items(org_unit_ids_CSV, completion = nil,
   # Returns: An ObjectListPage JSON block containing a list of ScheduledItem blocks
 end
 
-# REVIEW: Retrieve the calling user’s scheduled items still due.
-def get_current_user_still_due_items(org_unit_ids_CSV, completion = nil,
-                                     start_date_time = '', end_date_time = '')
+# REVIEW: Retrieve the calling user scheduled items still due.
+def get_current_user_scheduled_items_still_due(org_unit_ids_CSV, completion = nil,
+                                               start_date_time = '', end_date_time = '')
   query_string = "/d2l/api/le/#{$le_ver}/content/myItems/due/?"
   query_string += "orgUnitIdsCSV=#{org_unit_ids_CSV}&"
   query_string += "completion=#{completion}&" unless completion.nil?
@@ -351,7 +354,7 @@ def get_current_user_still_due_items(org_unit_ids_CSV, completion = nil,
   # Returns: An ObjectListPage JSON block containing a list of ScheduledItem blocks
 end
 
-# REVIEW: Retrieve the quantities of the calling user’s scheduled items, organized by org unit.
+# REVIEW: Retrieve the quantities of the calling user scheduled items, organized by org unit.
 # GET /d2l/api/le/(version)/content/myItems/itemCounts/
 def get_current_user_organized_scheduled_items(org_unit_ids_CSV,
                                                completion = nil,
@@ -379,7 +382,7 @@ def get_current_user_scheduled_item_count(org_unit_ids_CSV, completion = nil,
   # Returns: An ObjectListPage JSON block containing a list of ScheduledItem blocks
 end
 
-# REVIEW: Retrieve the calling user’s completed scheduled items.
+# REVIEW: Retrieve the calling user completed scheduled items.
 # GET /d2l/api/le/(version)/content/myItems/completions/
 def get_current_user_completed_scheduled_items(org_unit_ids_CSV,
                                                completion_from_date_time = '',
@@ -405,8 +408,8 @@ def get_current_user_completed_scheduled_items_with_due_date(org_unit_ids_CSV,
   # Returns: An ObjectListPage JSON block containing a list of ScheduledItem blocks
 end
 
-# REVIEW: Retrieve the calling user’s scheduled items for a particular org unit.
-# GET /d2l/api/le/(version)/(orgUnitId)/content/myItems/
+# REVIEW: Retrieve the calling user scheduled items for a particular org unit.
+# GET /d2l/api/le/(version)/#{org_unit_id}/content/myItems/
 def get_current_user_scheduled_items_by_org_unit(org_unit_id, completion = nil,
                                                  start_date_time = '',
                                                  end_date_time = '')
@@ -419,10 +422,10 @@ def get_current_user_scheduled_items_by_org_unit(org_unit_id, completion = nil,
 end
 
 # REVIEW: Retrieve the calling user’s scheduled items still due for a particular org unit.
-# GET /d2l/api/le/(version)/(orgUnitId)/content/myItems/due/
-def get_current_user_org_unit_scheduled_item_count(org_unit_id, completion = nil,
-                                                   start_date_time = '',
-                                                   end_date_time = '') # GET
+# GET /d2l/api/le/(version)/#{org_unit_id}/content/myItems/due/
+def get_current_user_org_unit_scheduled_items(org_unit_id, completion = nil,
+                                              start_date_time = '',
+                                              end_date_time = '') # GET
   query_string = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/content/myItems/due/?"
   query_string += "completion=#{completion}&" unless completion.nil?
   query_string += "startDateTime=#{start_date_time}&" unless start_date_time == ''
@@ -431,10 +434,10 @@ def get_current_user_org_unit_scheduled_item_count(org_unit_id, completion = nil
   # Returns: An ObjectListPage JSON block containing a list of ScheduledItem blocks
 end
 
-# REVIEW: Retrieve the quantity of the calling user’s scheduled items for provided org unit.
-# GET /d2l/api/le/(version)/(orgUnitId)/content/myItems/itemCount
-def get_user_overdue_items(org_unit_id, completion = nil, start_date_time = '',
-                           end_date_time = '') # GET
+# REVIEW: Retrieve the quantity of the calling user scheduled items for provided org unit.
+# GET /d2l/api/le/(version)/#{org_unit_id}/content/myItems/itemCount
+def get_calling_user_overdue_items_count(org_unit_id, completion = nil, start_date_time = '',
+                                         end_date_time = '') # GET
   query_string = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/content/myItems/itemCount?"
   query_string += "completion=#{completion}&" unless completion.nil?
   query_string += "startDateTime=#{start_date_time}&" unless start_date_time == ''
@@ -444,9 +447,9 @@ def get_user_overdue_items(org_unit_id, completion = nil, start_date_time = '',
 end
 
 # REVIEW: Retrieve quantity of the calling user’s scheduled items still due for a particular org unit.
-# GET /d2l/api/le/(version)/(orgUnitId)/content/myItems/due/itemCount
-def get_user_overdue_items(org_unit_id, completion = nil, start_date_time = '',
-                           end_date_time = '') # GET
+# GET /d2l/api/le/(version)/#{org_unit_id}/content/myItems/due/itemCount
+def get_calling_user_due_items_count(org_unit_id, completion = nil, start_date_time = '',
+                                     end_date_time = '') # GET
   query_string = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/content/myItems/due/itemCount?"
   query_string += "completion=#{completion}&" unless completion.nil?
   query_string += "startDateTime=#{start_date_time}&" unless start_date_time == ''
@@ -501,7 +504,7 @@ end
 # Retrieve the table of course content for an org unit.
 def get_org_unit_toc(org_unit_id, ignore_module_data_restrictions = false) # GET
   query_string = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/content/toc"
-  query_string += "?ignoreModuleDateRestrictions=true" if ignore_module_data_restrictions
+  query_string += '?ignoreModuleDateRestrictions=true' if ignore_module_data_restrictions
   _get(query_string)
   # Returns: a TableOfContents JSON block.
 end
@@ -510,7 +513,8 @@ end
 ### USER PROGRESS
 #################
 
-# Retrieves the aggregate count of completed and required content topics in an org unit for the calling user.
+# Retrieves the aggregate count of completed and required content topics
+# in an org unit for the calling user.
 # levels: 1=OrgUnit, 2=RootModule, 3=Topic
 def get_current_user_progress(org_unit_id, level) # GET
   query_string = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/content/completions/mycount/"
@@ -520,13 +524,15 @@ def get_current_user_progress(org_unit_id, level) # GET
   # a list of ContentAggregateCompletion items.
 end
 
-
 # TODO: --UNSTABLE-- Retrieve the user progress items in an org unit, for specific users or content topics.
 # _get "/d2l/api/le/#{$le_ver}/#{org_unit_id}/content/userprogress/"
+def get_progress_of_users; end
 
 # TODO: --UNSTABLE-- Retrieve one user’s progress within an org unit for a particular content topic.
 # _get "/d2l/api/le/#{$le_ver}/#{org_unit_id}/content/userprogress/#{topic_id}"
+def get_user_progress; end
 
 # TODO: --UNSTABLE-- Update a user progress item.
 # _post "/d2l/api/le/#{$le_ver}/#{org_unit_id}/content/userprogress/"
 # payload: UserProgressData
+def update_user_progress; end

data/lib/d2l_sdk/course_template.rb

@@ -50,9 +50,10 @@ def check_course_template_data_validity(course_template_data)
             'Name' => { 'type' => 'string' },
             'Code' => { 'type' => 'string' },
             'Path' => { 'type' => 'string' },
-            'ParentOrgUnitIds' => { 'type' => 'array',
-                                    'items' => { 'type' => 'integer', 'minItems' => 1 }
-                         }
+            'ParentOrgUnitIds' => {
+                'type' => 'array',
+                'items' => { 'type' => 'integer', 'minItems' => 1 }
+            }
         }
     }
     JSON::Validator.validate!(schema, course_template_data, validate_schema: true)
@@ -65,15 +66,18 @@ end
 # Required: "Name", "Code"
 # /d2l/api/lp/(version)/coursetemplates/ [POST]
 def create_course_template(course_template_data)
+    # TODO: make a bridge function that allows this to be done with 4 arguments, rather than
+    #      just a JSON.
     # 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.
-    payload = { 'Name' => '', # String
-                'Code' => 'off_SEMESTERCODE_STARNUM', # String
-                'Path' => '', # String
-                'ParentOrgUnitIds' => [99_989], # number: D2L_ID
-              }.merge!(course_template_data)
+    payload = {
+      'Name' => '', # String
+      'Code' => 'off_SEMESTERCODE_STARNUM', # String
+      'Path' => '', # String
+      'ParentOrgUnitIds' => [99_989], # number: D2L_ID
+    }.merge!(course_template_data)
     check_course_template_data_validity(payload)
     puts 'Creating Course Template:'
     ap payload
@@ -89,6 +93,7 @@ end
 # course template 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.
+# TODO: get rid of this, and make the template update only require 2 more args.
 def check_course_template_updated_data_validity(course_template_data)
     schema = {
         'type' => 'object',
@@ -108,9 +113,10 @@ end
 # /d2l/api/lp/(version)/coursetemplates/(orgUnitId) [PUT]
 def update_course_template(org_unit_id, new_data)
     # Define a valid, empty payload and merge! with the new data.
-    payload = { 'Name' => '', # String
-                'Code' => 'off_SEMESTERCODE_STARNUM', # String
-              }.merge!(new_data)
+    payload = {
+      'Name' => '', # String
+      'Code' => 'off_SEMESTERCODE_STARNUM', # String
+    }.merge!(new_data)
     puts "Updating course template #{org_unit_id}"
     check_course_template_updated_data_validity(payload)
     # ap payload
@@ -183,6 +189,5 @@ def delete_all_course_templates_with_name(name)
     end
 end
 
-# TODO: Delete course templates by using regular expressions to filter them.
-def delete_course_templates_by_regex(regex)
-end
+# TODO: (HOMEBREW) Delete course templates by using regular expressions to filter them.
+def delete_course_templates_by_regex(regex); end

data/lib/d2l_sdk/datahub.rb

@@ -52,14 +52,14 @@ def validate_create_export_job_data(create_export_job_data)
                   {
                       'type' => "object",
                       "properties" => {
-                        "Name" => {'type'=>"string"},
-                        "Value" => {'type'=>"string"}
+                        "Name" => { 'type' => "string" },
+                        "Value" => { 'type' => "string" }
                       }
                   }
             }
         }
     }
-    #ap schema
+    # ap schema
     JSON::Validator.validate!(schema, create_export_job_data, validate_schema: true)
     # returns true if the CreateExportJobData JSON block is valid
 end
@@ -93,7 +93,7 @@ def get_data_export_job(export_job_id)
 end
 
 def get_job_status_code(export_job_id)
-  get_data_export_job(export_job_id)["Status"] #if 2 is OKAY/COMPLETED
+  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
@@ -107,7 +107,7 @@ def download_job_csv(export_job_id)
       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}"))
+        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
@@ -121,14 +121,14 @@ def download_job_csv(export_job_id)
         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
+        if status.zero?
           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
+        attempt += 1
       end
       # returns: ZIP file containing a CSV file of data from the export job
     end
@@ -139,22 +139,22 @@ end
 def unzip(file_path, csv_filter = //)
   puts "Unzipping file: #{file_path}"
   # Unzip the file
-  Zip::File.open(file_path) { |zip_file|
+  Zip::File.open(file_path) do |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
-   }
-  }
+    zip_file.each do |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
+  end
 end
 
 # Get all 'current' courses, assuming all instr courses are current
@@ -163,7 +163,7 @@ end
 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|
+  CSV.foreach(csv_fname, headers: true) do |row|
     star_number = row[0]
     course_term = row[10]
     instr_courses.add("#{course_term}_#{star_number}")
@@ -174,9 +174,9 @@ 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)
+def filter_formatted_enrollments(csv_fname, instr_fname, regex_filter = //)
   # Create csv with 'filtered' pre-appended to '.csv' substring
-  filtered_csv = csv_fname.gsub(/\.csv/,"filtered.csv")
+  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
@@ -190,7 +190,7 @@ def filter_formatted_enrollments(csv_fname, regex_filter = //, instr_fname)
         # 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])
+      if row[3].nil? || row_num > 0 && (row[3] !~ regex_filter) || (!current.include? row[3][4..-1])
         row_num += 1
         next
       end
@@ -200,8 +200,8 @@ def filter_formatted_enrollments(csv_fname, regex_filter = //, instr_fname)
         # 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.
+        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