d2l_sdk 0.1.10 → 0.1.11

data/lib/d2l_sdk/logging.rb

@@ -19,7 +19,7 @@ def get_all_logs(date_range_start, date_range_end, search = '', log_level = '',
     path += "&loggerAssembly=#{logger_assembly}" if logger_assembly != ''
     path += "&userId=#{user_id}" if user_id != 0
     path += "&messageGroupId=#{message_group_id}" if message_group_id != 0
-    path += "&includeTraces=#{include_traces}" if include_traces != nil
+    path += "&includeTraces=#{include_traces}" unless include_traces.nil?
     path += "&orgUnitId=#{org_unit_id}" if org_unit_id != 0
     path += "&bookmark=#{bookmark}" if bookmark != ''
     ap path
@@ -51,7 +51,7 @@ end
 # retrieve identified log message
 def get_log_message(log_message_id, include_traces = nil)
   path = "/d2l/api/lp/#{$lp_ver}/logging/#{log_message_id}/"
-  path += "?includeTraces=#{include_traces}" if include_traces != nil
+  path += "?includeTraces=#{include_traces}" unless include_traces.nil?
   _get(path)
   # returns Message JSON block
 end

data/lib/d2l_sdk/lti.rb

@@ -5,30 +5,262 @@ require 'json-schema'
 ## ACTIONS: ######
 ##################
 
-# TODO: Remove an LTI link.
+# REVIEW: Remove an LTI link.
 # => DELETE /d2l/api/le/(version)/lti/link/(ltiLinkId)
-# TODO: Retrieve the information for all LTI links registered for an org unit.
+def delete_lti_link(lti_link_id)
+  path = "/d2l/api/le/#{$le_ver}/lti/link/#{lti_link_id}"
+  _delete(path)
+end
+
+# REVIEW: Retrieve the information for all LTI links registered for an org unit.
 # => GET /d2l/api/le/(version)/lti/link/(orgUnitId)/
-# TODO: Retrieve the information for a particular LTI link.
+def get_org_unit_lti_links(org_unit_id)
+  path = "/d2l/api/le/#{$le_ver}/lti/link/#{org_unit_id}/"
+  _get(path)
+end
+
+# REVIEW: Retrieve the information for a particular LTI link.
 # => GET /d2l/api/le/(version)/lti/link/(orgUnitId)/(ltiLinkId)
-# TODO: Register a new LTI link for an org unit.
+def get_lti_link_info(org_unit_id, lti_link_id)
+  path = "/d2l/api/le/#{$le_ver}/lti/link/#{org_unit_id}/#{lti_link_id}"
+  _get(path)
+end
+
+def check_create_lti_link_data_validity(create_lti_link_data)
+    schema = {
+        'type' => 'object',
+        'required' => %w(Title Url Description Key PlainSecret
+                         IsVisible SignMessage SignWithTc SendTcInfo
+                         SendContextInfo SendUserId SendUserName SendUserEmail
+                         SendLinkTitle SendLinkDescription SendD2LUserName
+                         SendD2LOrgDefinedId SendD2LOrgRoleId
+                         UseToolProviderSecuritySettings CustomParameters),
+        'properties' =>
+        {
+            'Title' => { 'type' => 'string' },
+            'Url' => { 'type' => 'string' },
+            'Description' => { 'type' => 'string' },
+            'Key' => { 'type' => 'string' },
+            'PlainSecret' => { 'type' => 'string' },
+            'IsVisible' => { 'type' => 'boolean' },
+            'SignMessage' => { 'type' => 'boolean' },
+            'SignWithTc' => { 'type' => 'boolean' },
+            'SendTcInfo' => { 'type' => 'boolean' },
+            'SendContextInfo' => { 'type' => 'boolean' },
+            'SendUserId' => { 'type' => 'boolean' },
+            'SendUserName' => { 'type' => 'boolean' },
+            'SendUserEmail' => { 'type' => 'boolean' },
+            'SendLinkTitle' => { 'type' => 'boolean' },
+            'SendLinkDescription' => { 'type' => 'boolean' },
+            'SendD2LUserName' => { 'type' => 'boolean' },
+            'SendD2LOrgDefinedId' => { 'type' => 'boolean' },
+            'SendD2LOrgRoleId' => { 'type' => 'boolean' },
+            'UseToolProviderSecuritySettings' => { 'type' => 'boolean' },
+            'CustomParameters' =>
+            { # define the CustomParameter array
+                # 'description' => 'The array of CustomParameters
+                'type' => %w(array null),
+                'items' =>
+                  {
+                      'type' => 'object',
+                      "properties" =>
+                      {
+                        "Name" => { 'type' => 'string' },
+                        "Value" => { 'type' => 'string' }
+                      }
+                  }
+            }
+        }
+    }
+    JSON::Validator.validate!(schema, create_lti_link_data, validate_schema: true)
+end
+
+# REVIEW: Register a new LTI link for an org unit.
 # => POST /d2l/api/le/(version)/lti/link/(orgUnitId)
-# TODO: Build a new quicklink around an existing LTI link.
+def register_lti_link(org_unit_id, create_lti_link_data)
+  path = "/d2l/api/le/#{$le_ver}/lti/link/#{org_unit_id}"
+  payload = {
+    'Title' => '',
+    'Url' => '',
+    'Description' => '',
+    'Key' => '',
+    'PlainSecret' => '',
+    'IsVisible' => false,
+    'SignMessage' => false,
+    'SignWithTc' => false,
+    'SendTcInfo' => false,
+    'SendContextInfo' => false,
+    'SendUserId' => false,
+    'SendUserName' => false,
+    'SendUserEmail' => false,
+    'SendLinkTitle' => false,
+    'SendLinkDescription' => false,
+    'SendD2LUserName' => false,
+    'SendD2LOrgDefinedId' => false,
+    'SendD2LOrgRoleId' => false,
+    'UseToolProviderSecuritySettings' => false,
+    'CustomParameters' => nil # or Array of CustomParameter
+    # e.g. [{"Name" => "", "Value" => ""},{"Name" => "", "Value" => ""}]
+  }.merge!(create_lti_link_data)
+  check_create_lti_link_data_validity(payload)
+  _post(path, payload)
+end
+
+
+# REVIEW: Build a new quicklink around an existing LTI link.
 # => POST /d2l/api/le/(version)/lti/quicklink/(orgUnitId)/(ltiLinkId)
-# TODO: Update the information associated with a registered LTI link.
+def create_lti_quicklink(org_unit_id, lti_link_id)
+  path = "/d2l/api/le/#{$le_ver}/lti/quicklink/#{org_unit_id}/#{lti_link_id}"
+  _post(path, {})
+end
+
+# REVIEW: Update the information associated with a registered LTI link.
 # => PUT /d2l/api/le/(version)/lti/link/(ltiLinkId)
+def update_lti_link(lti_link_id, create_lti_link_data)
+  path = "/d2l/api/le/#{$le_ver}/lti/link/#{lti_link_id}"
+  payload = {
+    'Title' => '',
+    'Url' => '',
+    'Description' => '',
+    'Key' => '',
+    'PlainSecret' => '',
+    'IsVisible' => false,
+    'SignMessage' => false,
+    'SignWithTc' => false,
+    'SendTcInfo' => false,
+    'SendContextInfo' => false,
+    'SendUserId' => false,
+    'SendUserName' => false,
+    'SendUserEmail' => false,
+    'SendLinkTitle' => false,
+    'SendLinkDescription' => false,
+    'SendD2LUserName' => false,
+    'SendD2LOrgDefinedId' => false,
+    'SendD2LOrgRoleId' => false,
+    'UseToolProviderSecuritySettings' => false,
+    'CustomParameters' => nil # or Array of CustomParameter
+    # e.g. [{"Name" => "", "Value" => ""},{"Name" => "", "Value" => ""}]
+  }.merge!(create_lti_link_data)
+  check_create_lti_link_data_validity(payload)
+  _put(path, payload)
+end
 
 #############################
 ## LTI TOOL PROVIDERS: ######
 #############################
 
-# TODO: Remove the registration for an LTI tool provider.
+# REVIEW: Remove the registration for an LTI tool provider.
 # => DELETE /d2l/api/le/(version)/lti/tp/(tpId)
-# TODO: Retrieve the information for all LTI tool providers registered for an org unit.
+def delete_LTI_tool_provider_registration(tp_id)
+  path = "/d2l/api/le/#{$le_ver}/lti/tp/#{tp_id}"
+  _delete(path)
+end
+
+# REVIEW: Retrieve the information for all LTI tool providers registered for an org unit.
 # => GET /d2l/api/le/(version)/lti/tp/(orgUnitId)/
-# TODO: Retrieve the information for a particular LTI tool provider.
+def get_org_unit_lti_tool_providers(org_unit_id)
+  path = "/d2l/api/le/#{$le_ver}/lti/tp/#{org_unit_id}/"
+  _get(path)
+end
+
+# REVIEW: Retrieve the information for a particular LTI tool provider.
 # => GET /d2l/api/le/(version)/lti/tp/(orgUnitId)/(tpId)
-# TODO: Register a new LTI tool provider for an org unit.
+def get_lti_tool_provider_information(org_unit_id, tp_id)
+  path = "/d2l/api/le/#{$le_ver}/lti/tp/#{org_unit_id}/#{tp_id}"
+  _get(path)
+end
+
+# Schema to check the CreateLtiProviderData JSON block validity.
+def check_create_lti_provider_data_validity(create_lti_provider_data)
+    schema = {
+        'type' => 'object',
+        'required' => %w(LaunchPoint Secret UseDefaultTcInfo Key Name
+                         Description ContactEmail SendTcInfo
+                         SendContextInfo SendUserId SendUserName SendUserEmail
+                         SendLinkTitle SendLinkDescription SendD2LUserName
+                         SendD2LOrgDefinedId SendD2LOrgRoleId),
+        'properties' =>
+        {
+            'LaunchPoint' => { 'type' => 'string' },
+            'Secret' => { 'type' => 'string' },
+            'UseDefaultTcInfo' => { 'type' => 'string' },
+            'Key' => { 'type' => 'string' },
+            'Name' => { 'type' => 'string' },
+            'Description' => { 'type' => 'string' },
+            'ContactEmail' => { 'type' => 'string' },
+            'IsVisible' => { 'type' => 'boolean' },
+            'SendTcInfo' => { 'type' => 'boolean' }, # LE's 1.12+
+            'SendContextInfo' => { 'type' => 'boolean' }, # LE's 1.12+
+            'SendUserId' => { 'type' => 'boolean' }, # LE's 1.12+
+            'SendUserName' => { 'type' => 'boolean' }, # LE's 1.12+
+            'SendUserEmail' => { 'type' => 'boolean' }, # LE's 1.12+
+            'SendLinkTitle' => { 'type' => 'boolean' }, # LE's 1.12+
+            'SendLinkDescription' => { 'type' => 'boolean' }, # LE's 1.12+
+            'SendD2LUserName' => { 'type' => 'boolean' }, # LE's 1.12+
+            'SendD2LOrgDefinedId' => { 'type' => 'boolean' }, # LE's 1.12+
+            'SendD2LOrgRoleId' => { 'type' => 'boolean' } # LE's 1.12+
+        }
+    }
+    JSON::Validator.validate!(schema, create_lti_provider_data, validate_schema: true)
+end
+
+# REVIEW: Register a new LTI tool provider for an org unit.
 # => POST /d2l/api/le/(version)/lti/tp/(orgUnitId)
-# TODO: Update the information associated with a registered LTI tool provider.
+# INPUT: LTI.CreateLtiProviderData
+def register_lti_tool_provider(org_unit_id, create_lti_provider_data)
+  path = "/d2l/api/le/#{$le_ver}/lti/tp/#{org_unit_id}"
+  payload = {
+    'LaunchPoint' => '',
+    'Secret' => '',
+    'UseDefaultTcInfo' => '',
+    'Key' => '',
+    'Name' => '',
+    'Description' => '',
+    'ContactEmail' => '',
+    'IsVisible' => false,
+    'SendTcInfo' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendContextInfo' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendUserId' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendUserName' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendUserEmail' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendLinkTitle' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendLinkDescription' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendD2LUserName' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendD2LOrgDefinedId' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendD2LOrgRoleId' => false # Appears in LE's 1.12+ contract as of LE v10.6.0
+  }.merge!(create_lti_provider_data)
+  check_create_lti_provider_data_validity(payload)
+  _post(path, payload)
+  # RETURNS: a LtiToolProviderData JSON block
+end
+
+
+# REVIEW: Update the information associated with a registered LTI tool provider.
 # => PUT /d2l/api/le/(version)/lti/tp/(tpId)
+# INPUT: LTI.CreateLtiProviderData
+def update_lti_tool_provider(tp_id, create_lti_provider_data)
+  path = "/d2l/api/le/#{$le_ver}/lti/tp/#{tp_id}" # tp_id = tool provider id
+  payload = {
+    'LaunchPoint' => '',
+    'Secret' => '',
+    'UseDefaultTcInfo' => '',
+    'Key' => '',
+    'Name' => '',
+    'Description' => '',
+    'ContactEmail' => '',
+    'IsVisible' => false,
+    'SendTcInfo' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendContextInfo' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendUserId' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendUserName' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendUserEmail' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendLinkTitle' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendLinkDescription' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendD2LUserName' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendD2LOrgDefinedId' => false, # Appears in LE's 1.12+ contract as of LE v10.6.0
+    'SendD2LOrgRoleId' => false # Appears in LE's 1.12+ contract as of LE v10.6.0
+  }.merge!(create_lti_provider_data)
+  check_create_lti_provider_data_validity(payload)
+  _put(path, payload)
+  # RETURNS: a LtiToolProviderData JSON block
+end

data/lib/d2l_sdk/news.rb

@@ -22,12 +22,12 @@ end
 # if since and until are specified, all items between these two dates are fetched
 # if since > until, an empty feed list is returned
 # purpose: fetch the feed for the current user context
-def get_current_user_feed(since = "", _until = "")
+def get_current_user_feed(since = "", until_ = "")
   path = "/d2l/api/lp/#{$lp_ver}/feed/"
   # if since is specified, then until can be. Until is not required though.
   if since != ""
     path += "?since=#{since}"
-    path += "&until=#{_until}" if _until != ""
+    path += "&until=#{until_}" if until_ != ""
   end
   _get(path)
 end

data/lib/d2l_sdk/org_unit.rb

@@ -34,7 +34,7 @@ def delete_relationship_of_parent_with_child(parent_ou_id, child_ou_id)
 end
 
 def get_properties_of_all_org_units(org_unit_type = '', org_unit_code = '', org_unit_name = '',
-                                bookmark = '')
+                                    bookmark = '')
     path = "/d2l/api/lp/#{$lp_ver}/orgstructure/"
     path += "?orgUnitType=#{org_unit_type}" if org_unit_type != ''
     path += "?orgUnitCode=#{org_unit_code}" if org_unit_code != ''
@@ -165,9 +165,10 @@ def check_org_unit_data_validity(org_unit_data)
             'Type' => { 'type' => 'integer' },
             'Name' => { 'type' => 'string' },
             'Code' => { 'type' => 'string' },
-            'Parents' => { 'type' => 'array',
-                           'items' => { 'type' => 'integer', 'minItems' => 1 }
-                         }
+            'Parents' => {
+              'type' => 'array',
+              'items' => { 'type' => 'integer', 'minItems' => 1 }
+            }
         }
     }
     JSON::Validator.validate!(schema, org_unit_data, validate_schema: true)
@@ -177,11 +178,12 @@ end
 def create_custom_org_unit(org_unit_data)
     # Requires the type to have the correct parent. This will work fine in this
     # sample, as the department (101) can have the parent Organiation (6606)
-    payload = { 'Type' => 101, # Number:D2LID
-                'Name' => 'custom_ou_name', # String
-                'Code' => 'custom_ou_code', # String
-                'Parents' => [6606], # Number:D2LID
-              }.merge!(org_unit_data)
+    payload = {
+      'Type' => 101, # Number:D2LID
+      'Name' => 'custom_ou_name', # String
+      'Code' => 'custom_ou_code', # String
+      'Parents' => [6606], # Number:D2LID
+    }.merge!(org_unit_data)
     check_org_unit_data_validity(payload)
     path = "/d2l/api/lp/#{$lp_ver}/orgstructure/"
     # Requires: OrgUnitCreateData JSON block
@@ -268,20 +270,20 @@ end
 # COLOUR SCHEMES:#######
 ########################
 
-# REVIEW: Retrieve the colour scheme for an org unit.
+# TODO: Retrieve the colour scheme for an org unit.
 # RETURNS: ColourScheme JSON data block containing the org unit’s current colour scheme.
-def get_org_unit_color_scheme(org_unit_id)
-  path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/colours"
+# def get_org_unit_color_scheme(org_unit_id)
+#  path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/colours"
   # RETURNS: ColourScheme JSON data block containing the org unit’s current colour scheme.
-end
+# end
 
 # TODO: Set a new colour scheme for an org unit.
 # INPUT: JSON PARAM of type +colourScheme+ (OrgUnitEditor.ColourScheme)
 # RETURNS: ColourScheme JSON data block containing the org unit’s new colour scheme.
-def set_new_org_unit_color_scheme(org_unit_id, colour_scheme)
+# def set_new_org_unit_color_scheme(org_unit_id, colour_scheme)
   # PUT /d2l/api/lp/(version)/orgstructure/(orgUnitId)/colours
   # RETURNS: ColourScheme JSON data block containing the org unit’s new colour scheme.
-end
+# end
 
 ########################
 # RECYCLE BIN:##########
@@ -368,7 +370,7 @@ def check_create_org_unit_type_data_validity(org_unit_type_data)
             'Code' => { 'type' => 'string' },
             'Name' => { 'type' => 'string' },
             'Description' => { 'type' => 'string' },
-            'SortOrder' => { 'type' => 'integer'}
+            'SortOrder' => { 'type' => 'integer' }
         }
     }
     JSON::Validator.validate!(schema, org_unit_type_data, validate_schema: true)
@@ -382,7 +384,7 @@ def create_custom_outype(create_org_unit_type_data)
     'Description' => '',
     'SortOrder' => 0
   }.merge!(create_org_unit_type_data)
-  #validate schema
+  # validate schema
   check_create_org_unit_type_data_validity(payload)
   path = "/d2l/api/lp/#{$lp_ver}/outypes/"
   _post(path, payload)
@@ -399,7 +401,7 @@ def update_outype(outype_id, create_org_unit_type_data)
     'Description' => '',
     'SortOrder' => 0
   }.merge!(create_org_unit_type_data)
-  #validate schema
+  # validate schema
   check_create_org_unit_type_data_validity(payload)
   path = "/d2l/api/lp/#{$lp_ver}/outypes/#{outype_id}"
   _post(path, payload)

data/lib/d2l_sdk/requests.rb

@@ -21,7 +21,7 @@ def _get(path, isD2l = true)
     ap uri_string if @debug
     RestClient.get(uri_string) do |response, _request, _result|
       begin
-        #ap _request
+        # ap _request
         case response.code
         when 200
             # ap JSON.parse(response) # Here is the JSON fmt'd response printed
@@ -30,7 +30,7 @@ def _get(path, isD2l = true)
             display_response_code(response.code)
             ap JSON.parse(response.body) if @debug
         end
-      rescue => e
+      rescue # => e
         display_response_code(response.code)
         ap JSON.parse(response.body) if @debug
         raise
@@ -51,7 +51,7 @@ def _get_raw(path, isD2l = true)
           display_response_code(response.code)
           ap response.body
       end
-    rescue => e
+    rescue # => e
       display_response_code(response.code)
       ap response.body
       raise
@@ -81,6 +81,36 @@ def _post(path, payload, isD2l = true)
     end
 end
 
+# performs a put request using the path and the payload arguments. After first
+# creating an authenticated uri, the put request is performed using the
+# authenticated uri, the payload argument, and specifying that the payload is
+# formatted in JSON.
+def _put(path, payload, isD2l = true)
+    auth_uri = path
+    auth_uri = create_authenticated_uri(path, 'PUT') if isD2l == true
+    # Perform the put action, updating the data; Provide feedback to client.
+    RestClient.put(auth_uri, payload.to_json, content_type: :json) do |response|
+      case response.code
+      when 200
+        return nil if response == ""
+        JSON.parse(response)
+        # ap JSON.parse(response.body)
+      else
+        display_response_code(response.code)
+        ap JSON.parse(response.body) if $debug
+      end
+    end
+end
+
+# Performs a delete request by creating an authenticated uri and using the
+# RestClient delete method and specifying the content_type as being JSON.
+def _delete(path, isD2l = true, headers = {})
+    headers[:content_type] = :json
+    auth_uri = path
+    auth_uri = create_authenticated_uri(path, 'DELETE') if isD2l == true
+    RestClient.delete(auth_uri, headers)
+end
+
 # NOTE: multipart code examples referrenced from danielwestendorf--
 # FTC 1867 and FTC 2388 implementations are based upon the following url:
 # => "https://coderwall.com/p/c-mu-a/http-posts-in-ruby"
@@ -95,12 +125,12 @@ def _learning_repository_upload(path, file, method)
     # file = the File's name in the directory.
     # method = POST or PUT
     # json = the json appended to the end of the request body
-    auth_uri = path
+    # auth_uri = path
     auth_uri = create_authenticated_uri(path, method)
     uri = URI.parse(auth_uri)
 
     boundary = "xxBOUNDARYxx"
-    header = {"Content-Type" => "multipart/form-data; boundary=#{boundary}"}
+    header = { "Content-Type" => "multipart/form-data; boundary=#{boundary}" }
     # setup the post body
     post_body = []
     post_body << "--#{boundary}\n"
@@ -119,19 +149,50 @@ def _learning_repository_upload(path, file, method)
     JSON.parse(response)
 end
 
-# REVIEW: profile image upload process
-def _profile_image_upload(path, file, method)
+# Upload a file to the learning repository.
+def _course_package_upload(path, file, method)
+    # name = the content name,
+    # e.g. "Resource", "profileImage", "name", "description", "file", "targetUsers"
+    # file = the File's name in the directory.
+    # method = POST or PUT
+    # json = the json appended to the end of the request body
+    # auth_uri = path
+    auth_uri = create_authenticated_uri(path, method)
+    uri = URI.parse(auth_uri)
+
+    boundary = "xxBOUNDARYxx"
+    header = { "Content-Type" => "multipart/form-data; boundary=#{boundary}" }
+    # setup the post body
+    post_body = []
+    post_body << "--#{boundary}\n"
+    post_body << "Content-Disposition: form-data; name = \"Resource\"; filename=\"#{File.basename(file)}\"\r\n"
+    post_body << "Content-Type: #{MIME::Types.type_for(file)}\r\n\r\n"
+    post_body << File.read(file)
+    post_body << "\r\n\r\n--#{boundary}--\r\n"
+
+    # Create the HTTP objects
+    http = Net::HTTP.new(uri.host, uri.port)
+    request = Net::HTTP::Post.new(uri.request_uri, header)
+    request.body = post_body.join
+
+    # Send the request
+    response = http.request(request)
+    JSON.parse(response)
+end
+
+# REVIEW: image upload process
+def _image_upload(path, file, method)
   # name = the content name,
   # e.g. "Resource", "profileImage", "name", "description", "file", "targetUsers"
   # file = the File's name in the directory.
   # method = POST or PUT
   # json = the json appended to the end of the request body
-  auth_uri = path
+  # auth_uri = path
   auth_uri = create_authenticated_uri(path, method)
   uri = URI.parse(auth_uri)
 
   boundary = "xxBOUNDARYxx"
-  header = {"Content-Type" => "multipart/form-data; boundary=#{boundary}"}
+  header = { "Content-Type" => "multipart/form-data; boundary=#{boundary}" }
   # setup the post body
   post_body = []
   post_body << "--#{boundary}\n"
@@ -156,12 +217,12 @@ def _ePortfolio_upload(path, file, method, description)
   # filename = the File's name in the directory.
   # method = POST or PUT
   # json = the json appended to the end of the request body
-  auth_uri = path
+  # auth_uri = path
   auth_uri = create_authenticated_uri(path, method)
   uri = URI.parse(auth_uri)
 
   boundary = "xxBOUNDARYxx"
-  header = {"Content-Type" => "multipart/form-data; boundary=#{boundary}"}
+  header = { "Content-Type" => "multipart/form-data; boundary=#{boundary}" }
   # setup the post body
   post_body = []
   post_body << "--#{boundary}\r\n"
@@ -196,12 +257,12 @@ def _course_content_upload(path, json, file, method)
   # filename = the File's name in the directory.
   # method = POST or PUT
   # json = the json appended to the end of the request body
-  auth_uri = path
+  # auth_uri = path
   auth_uri = create_authenticated_uri(path, method)
   uri = URI.parse(auth_uri)
 
   boundary = "xxBOUNDARYxx"
-  header = {"Content-Type" => "multipart/mixed; boundary=#{boundary}"}
+  header = { "Content-Type" => "multipart/mixed; boundary=#{boundary}" }
   # setup the post body
   post_body = []
   post_body << "--#{boundary}\r\n"
@@ -232,12 +293,12 @@ def _dropbox_upload(path, json, file, method)
   # filename = the File's name in the directory.
   # method = POST or PUT
   # json = the json appended to the end of the request body
-  auth_uri = path
+  # auth_uri = path
   auth_uri = create_authenticated_uri(path, method)
   uri = URI.parse(auth_uri)
 
   boundary = "xxBOUNDARYxx"
-  header = {"Content-Type" => "multipart/mixed; boundary=#{boundary}"}
+  header = { "Content-Type" => "multipart/mixed; boundary=#{boundary}" }
   # setup the post body
   post_body = []
   post_body << "--#{boundary}\r\n"
@@ -270,12 +331,12 @@ def _news_upload(path, json, files, method)
   # files = array of filenames
   # method = POST or PUT
   # json = the json appended to the end of the request body
-  auth_uri = path
+  # auth_uri = path
   auth_uri = create_authenticated_uri(path, method)
   uri = URI.parse(auth_uri)
 
   boundary = "xxBOUNDARYxx"
-  header = {"Content-Type" => "multipart/mixed; boundary=#{boundary}"}
+  header = { "Content-Type" => "multipart/mixed; boundary=#{boundary}" }
   # setup the post body
   post_body = []
   post_body << "--#{boundary}\r\n"
@@ -305,25 +366,12 @@ def _news_upload(path, json, files, method)
   response.body
 end
 
-# performs a put request using the path and the payload arguments. After first
-# creating an authenticated uri, the put request is performed using the
-# authenticated uri, the payload argument, and specifying that the payload is
-# formatted in JSON.
-def _put(path, payload, isD2l = true)
-    auth_uri = path
-    auth_uri = create_authenticated_uri(path, 'PUT') if isD2l == true
-    # Perform the put action, updating the data; Provide feedback to client.
-    RestClient.put(auth_uri, payload.to_json, content_type: :json)
+# bridge function ~~~
+def _upload_post_data(path, json, files, method)
+  _news_upload(path, json, files, method)
 end
 
-# Performs a delete request by creating an authenticated uri and using the
-# RestClient delete method and specifying the content_type as being JSON.
-def _delete(path, isD2l = true, headers = {})
-    headers[:content_type] = :json
-    auth_uri = path
-    auth_uri = create_authenticated_uri(path, 'DELETE') if isD2l == true
-    RestClient.delete(auth_uri, headers)
-end
+
 
 # based upon the specific code that is returned from the http method, this
 # displays the response, in the case that it is an error within the request
@@ -334,41 +382,29 @@ end
 # the docs.valence.desire2learn.com website.
 def display_response_code(code)
     case code
-    when 400
-        puts '[!] 400: Bad Request'
-    when 401
-        puts '[!] 401: Unauthorized'
-
-    when 403
-        print '[!] Error Code Forbidden 403: accessing the page or resource '\
-              'you were trying to reach is absolutely forbidden for some reason.'
-    when 404
-        puts '[!] 404: Not Found'
-    when 405
-        puts '[!] 405: Method Not Allowed'
-    when 406
-        puts 'Unacceptable Type'\
-    	    'Unable to provide content type matching the client\'s Accept header.'
-    when 412
-        puts '[!] 412: Precondition failed\n'\
-          'Unsupported or invalid parameters, or missing required parameters.'
-    when 415
-        puts '[!] 415: Unsupported Media Type'\
-          'A PUT or POST payload cannot be accepted.'
-    when 423
-        puts '[!] 423'
-    when 500
-        puts '[!] 500: General Service Error\n'\
-          'Empty response body. The service has encountered an unexpected'\
-            'state and cannot continue to handle your action request.'
-    when 504
-        puts '[!] 504: Service Error'
+    when 400 then puts '[!] 400: Bad Request'
+    when 401 then puts '[!] 401: Unauthorized'
+    when 403 then puts '[!] Error Code Forbidden 403: accessing the page or resource '\
+                       'you were trying to reach is absolutely forbidden for some reason.'
+    when 404 then puts '[!] 404: Not Found'
+    when 405 then puts '[!] 405: Method Not Allowed'
+    when 406 then puts 'Unacceptable Type'\
+    	                 'Unable to provide content type matching the client\'s Accept header.'
+    when 412 then puts '[!] 412: Precondition failed\n'\
+                       'Unsupported or invalid parameters, or missing required parameters.'
+    when 415 then puts '[!] 415: Unsupported Media Type'\
+                       'A PUT or POST payload cannot be accepted.'
+    when 423 then puts '[!] 423'
+    when 500 then puts '[!] 500: General Service Error\n'\
+                       'Empty response body. The service has encountered an unexpected'\
+                       'state and cannot continue to handle your action request.'
+    when 504 then puts '[!] 504: Service Error'
     end
 end
 
-#################
-###Versions######
-#################
+##################
+### Versions #####
+##################
 def get_all_products_supported_versions
   path = "/d2l/api/versions/"
   _get(path)
@@ -400,7 +436,7 @@ def get_versions
   # returns: SupportedVersion JSON block
 end
 
-#determine if a specific product component supports a particular API version
+# determine if a specific product component supports a particular API version
 def check_if_product_supports_api_version(product_code, version)
   path = "/d2l/api/#{product_code}/versions/#{version}"
   _get(path)
@@ -414,8 +450,8 @@ def check_supported_version_request_validity(supported_version_request)
             'type' => "object",
             "properties" =>
             {
-              "Productcode" => {'type'=>"string"},
-              "Version" => {'type'=>"string"}
+              "Productcode" => { 'type' => "string" },
+              "Version" => { 'type' => "string" }
             }
         }
     }