d2l_sdk 0.1.9 → 0.1.10

data/lib/d2l_sdk/lockers.rb

@@ -0,0 +1,40 @@
+require_relative 'requests'
+require 'json-schema'
+
+##################
+## ACTIONS: ######
+##################
+
+# TODO: Delete a file or folder from the current user’s locker.
+# => DELETE /d2l/api/le/(version)/locker/myLocker/(path)
+# TODO: Delete a file or folder from the provided user’s locker.
+# => DELETE /d2l/api/le/(version)/locker/user/(userId)/(path)
+# TODO: Retrieve a specific object from the current user’s locker.
+# => GET /d2l/api/le/(version)/locker/myLocker/(path)
+# TODO: Retrieve a specific object from a provided user’s locker.
+# => GET /d2l/api/le/(version)/locker/user/(userId)/(path)
+# TODO: Add a new file or folder to the current user’s locker.
+# => POST /d2l/api/le/(version)/locker/myLocker/(path)
+# TODO: Add a new file or folder to the provided user’s locker.
+# => POST /d2l/api/le/(version)/locker/user/(userId)/(path)
+# TODO: Rename a folder in the current user’s locker.
+# => PUT /d2l/api/le/(version)/locker/myLocker/(path)
+# TODO: Rename a folder in the provided user’s locker.
+# => PUT /d2l/api/le/(version)/locker/user/(userId)/(path)
+
+##################
+## LOCKERS: ######
+##################
+
+# TODO: Delete a file or folder from the locker of a group in the provided org unit.
+# => DELETE /d2l/api/le/(version)/(orgUnitId)/locker/group/(groupId)/(path)
+# TODO: Determine if a locker has been set up for a group category within an org unit.
+# => GET /d2l/api/lp/(version)/(orgUnitId)/groupcategories/(groupCategoryId)/locker
+# TODO: Retrieve a specific object from a provided group’s locker.
+# => GET /d2l/api/le/(version)/(orgUnitId)/locker/group/(groupId)/(path)
+# TODO: Set up the locker for a group category within an org unit.
+# => POST /d2l/api/lp/(version)/(orgUnitId)/groupcategories/(groupCategoryId)/locker
+# TODO: Add a new file or folder to the locker for a group in the provided org unit.
+# => POST /d2l/api/le/(version)/(orgUnitId)/locker/group/(groupId)/(path)
+# TODO: Rename a folder in the locker for a group in the provided org unit.
+# => PUT /d2l/api/le/(version)/(orgUnitId)/locker/group/(groupId)/(path)

data/lib/d2l_sdk/lti.rb

@@ -0,0 +1,34 @@
+require_relative 'requests'
+require 'json-schema'
+
+##################
+## ACTIONS: ######
+##################
+
+# TODO: 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.
+# => GET /d2l/api/le/(version)/lti/link/(orgUnitId)/
+# TODO: 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.
+# => POST /d2l/api/le/(version)/lti/link/(orgUnitId)
+# TODO: 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.
+# => PUT /d2l/api/le/(version)/lti/link/(ltiLinkId)
+
+#############################
+## LTI TOOL PROVIDERS: ######
+#############################
+
+# TODO: 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.
+# => GET /d2l/api/le/(version)/lti/tp/(orgUnitId)/
+# TODO: 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.
+# => POST /d2l/api/le/(version)/lti/tp/(orgUnitId)
+# TODO: Update the information associated with a registered LTI tool provider.
+# => PUT /d2l/api/le/(version)/lti/tp/(tpId)

data/lib/d2l_sdk/news.rb

@@ -67,6 +67,26 @@ end
 #   part 2: attachments
 def create_news_item(org_unit_id, news_item_data, attachments = [])
   # POST /d2l/api/le/(version)/(orgUnitId)/news/
+  path = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/news/"
+  json =
+  {
+    "Title" => "Placeholder_title",
+    "Body" =>
+    { # Composite: RichText
+      "Text" => "plaintext_text_here",
+      "HTML" => nil # OR the HTML_Formatted_version_of_text
+    },
+    "StartDate" => "UTCDateTime",
+    "EndDate" => nil, # nil or UTCDateTime -- e.g. 2017-03-28T18:54:56.000Z
+    "IsGlobal" => false,
+    "IsPublished" => false, # sets it as a draft
+    "ShowOnlyInCourseOfferings" => false
+  }.merge!(news_item_data)
+  files = attachments
+  method = "POST"
+  ap json
+  ap _news_upload(path, json, files, method)
+  # RETURNS a NewsItem JSON data block
 end
 
 # NOTE: UNSTABLE!!!

data/lib/d2l_sdk/permissions.rb

@@ -0,0 +1,27 @@
+require_relative 'requests'
+require 'json-schema'
+
+########################
+# ACTIONS:##############
+########################
+
+# TODO: --UNSTABLE-- Remove the specified capability.
+# => DELETE /d2l/api/lp/(version)/permissions/tools/(toolId)/capabilities/(capabilityId)
+# TODO: --UNSTABLE-- Reset a permission grant to “not allowed”.
+# => DELETE /d2l/api/lp/(version)/permissions/tools/(toolId)/claims/allowed/(grantId)
+# TODO: --UNSTABLE-- Retrieve all the capability grants for a tool.
+# => GET /d2l/api/lp/(version)/permissions/tools/(toolId)/capabilities/
+# TODO: --UNSTABLE-- Retrieve all the permission grants for a tool’s permissions claims.
+# => GET /d2l/api/lp/(version)/permissions/tools/(toolId)/claims/
+# TODO: --UNSTABLE-- Retrieve all the allowed permission grants for a tool for a tool’s permissions claims.
+# => GET /d2l/api/lp/(version)/permissions/tools/(toolId)/claims/allowed/
+# TODO: --UNSTABLE-- Determine the allowance state of a permission grant.
+# => GET /d2l/api/lp/(version)/permissions/tools/(toolId)/claims/allowed/(grantId)
+# TODO: --UNSTABLE-- Retrieve the meta-data for all of a tool’s permission claims.
+# => GET /d2l/api/lp/(version)/permissions/tools/(toolId)/claims/metadata/
+# TODO: --UNSTABLE-- Retrieve the meta-data for one of a tool’s permission claims.
+# => GET /d2l/api/lp/(version)/permissions/tools/(toolId)/claims/metadata/(claimId)
+# TODO: --UNSTABLE-- Grant a tool capability.
+# => POST /d2l/api/lp/(version)/permissions/tools/(toolId)/capabilities/
+# TODO: --UNSTABLE-- Set a permission grant to “allowed”.
+# => PUT /d2l/api/lp/(version)/permissions/tools/(toolId)/claims/allowed/(grantId)

data/lib/d2l_sdk/requests.rb

@@ -1,4 +1,8 @@
 require_relative 'auth'
+require 'net/http'
+require 'uri'
+require 'mime/types'
+require 'json'
 
 ########################
 # QUERIES/RESPONSE:#####
@@ -76,25 +80,231 @@ def _post(path, payload, isD2l = true)
       end
     end
 end
-=begin
-# in compliance with FTC1867 HTTP file upload
-def _upload(path, json, file, method, name, filename)
+
+# 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"
+# The code has obviously been modified for usage with basic D2L POST/PUT api methods
+# in compliance with FTC 1867 & FTC 2388 HTTP file upload and according to examples
+# shown on: "http://docs.valence.desire2learn.com/basic/fileupload.html"
+
+# Upload a file to the learning repository.
+def _learning_repository_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"
-    http_req = "Content-Type: multipart/form-data; boundary=#{boundary}\n"\
-               "Content-Length: {#{method} #{file.bytesize}}\n\n"\
-               "#{boundary}\n"\
-               "Content-Type: #{content-type}\n"
-               "Content-Disposition: form-data; name = '#{name}'; filename='#{filename}'\n"\
-    # Requires Content-Type and boundary specification on line 1
-    # Requires Content-Length with specification of method on line 2
-    # Requires boundary before the content
-    # Requires Content-Disposition, name, and filename line 1 of content
-    # Requires Content-Type as line 2 of content
-    # Requires boundary after the content
-    # url, payload, {:multipart => true}, req
-    # if sending a file, multipart is autodetected
-end
-=end
+    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: application/zip\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: profile image upload process
+def _profile_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 = 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 = \"profileImage\"; filename=\"#{File.basename(file)}\"\r\n"
+  post_body << "Content-Type: image/png\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
+
+def _ePortfolio_upload(path, file, method, description)
+  # name = the content name,
+  # e.g. "Resource", "profileImage", "name", "description", "file", "targetUsers"
+  # 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 = 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}\r\n"
+  post_body << "Content-Type: text/plain\r\n"
+  post_body << "Content-Disposition: form-data; name = \"name\"\r\n\r\n"
+  post_body << "#{File.basename(file)}\r\n"
+
+  post_body << "--#{boundary}\r\n"
+  post_body << "Content-Type: text/plain\r\n"
+  post_body << "Content-Disposition: form-data; name = \"description\"\r\n\r\n"
+  post_body << "#{description}\r\n"
+
+  post_body << "--#{boundary}\r\n"
+  post_body << "Content-Type: text/plain\r\n"
+  post_body << "Content-Disposition: form-data; name = \"file\"; filename=\"#{File.basename(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
+
+def _course_content_upload(path, json, file, method)
+  # name = the content name,
+  # e.g. "Resource", "profileImage", "name", "description", "file", "targetUsers"
+  # 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 = create_authenticated_uri(path, method)
+  uri = URI.parse(auth_uri)
+
+  boundary = "xxBOUNDARYxx"
+  header = {"Content-Type" => "multipart/mixed; boundary=#{boundary}"}
+  # setup the post body
+  post_body = []
+  post_body << "--#{boundary}\r\n"
+  post_body << "Content-Type: application/json\r\n\r\n"
+
+  post_body << json.to_json
+  post_body << "\r\n"
+
+  post_body << "--#{boundary}\r\n"
+  post_body << "Content-Disposition: form-data; name = \"\"; filename=\"#{File.basename(file)}\"\r\n\r\n"
+  post_body << "Content-Type: text/plain\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
+
+def _dropbox_upload(path, json, file, method)
+  # name = the content name,
+  # e.g. "Resource", "profileImage", "name", "description", "file", "targetUsers"
+  # 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 = create_authenticated_uri(path, method)
+  uri = URI.parse(auth_uri)
+
+  boundary = "xxBOUNDARYxx"
+  header = {"Content-Type" => "multipart/mixed; boundary=#{boundary}"}
+  # setup the post body
+  post_body = []
+  post_body << "--#{boundary}\r\n"
+  post_body << "Content-Type: application/json\r\n\r\n"
+
+  post_body << json.to_json # e.g. {"Text" => "Here you go", "Html" => null}
+  post_body << "\r\n"
+  post_body << "--#{boundary}\r\n"
+  post_body << "Content-Disposition: form-data; name = \"\"; 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
+
+# function to upload 1+ files to a news event.
+# e.g. uploading 2 attachments to a news event (a text file; a png)
+def _news_upload(path, json, files, method)
+  # name = the content name,
+  # e.g. "Resource", "profileImage", "name", "description", "file", "targetUsers"
+  # files = array of filenames
+  # 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/mixed; boundary=#{boundary}"}
+  # setup the post body
+  post_body = []
+  post_body << "--#{boundary}\r\n"
+  post_body << "Content-Type: application/json\r\n\r\n"
+
+  post_body << json.to_json # e.g. {"Text" => "Here you go", "Html" => null}
+
+  file_iteration = 0
+  files.each do |file|
+    post_body << "\r\n--#{boundary}\r\n"
+    post_body << "Content-Disposition: form-data; name = \"file #{file_iteration}\"; filename=\"#{File.basename(file)}\"\r\n"
+    post_body << "Content-Type: text/plain\r\n\r\n"
+    post_body << File.read(file)
+    file_iteration += 1
+  end
+  post_body << "\r\n\r\n--#{boundary}--\r\n"
+
+  # Create the HTTP objects
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.set_debug_output($stdout)
+  http.use_ssl = true
+  request = Net::HTTP::Post.new(uri.request_uri, header)
+  request.body = post_body.join
+  puts request.body
+  # Send the request
+  response = http.request(request)
+  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

data/lib/d2l_sdk/setup_versions.rb

@@ -1,14 +1,22 @@
 require_relative "requests"
 
 # init products to newest versions.
-$le_ver = get_latest_product_version('le')
-$lp_ver = get_latest_product_version('lp')
-$ep_ver = get_latest_product_version('ep')
+$le_ver = get_latest_product_version('le') # learning environment
+$lp_ver = get_latest_product_version('lp') # learning platform
+$ep_ver = get_latest_product_version('ep') # Eportfolio
+$LR_ver = get_latest_product_version('LR') # Learning repository
+$bas_ver = get_latest_product_version('bas') # Award service
+$lti_ver = get_latest_product_version('lti') # learning tools interoperability
+# ext
+
 #lti, rp, LR, ext,
 puts "versions set to:"
 versions = {
-  "le_ver" => $le_ver,
-  "lp_ver" => $lp_ver,
-  "ep_ver" => $ep_ver
+  "Learning Environment" => $le_ver,
+  "Learning Platform" => $lp_ver,
+  "Eportfolio" => $ep_ver,
+  "Learning Object Repository" => $LR_ver,
+  "Award Service" => $bas_ver,
+  "Learning Tools Interoperability" => $lti_ver
 }
 ap versions

data/lib/d2l_sdk/user.rb

@@ -212,7 +212,7 @@ def check_updated_user_data_validity(user_data)
                          LastName ExternalEmail UserName
                          Activation),
         'properties' => {
-            'OrgDefinedId' => { 'type' => 'string' },
+            'OrgDefinedId' => { 'type' => %w(string null) },
             'FirstName' => { 'type' => 'string' },
             'MiddleName' => { 'type' => 'string' },
             'LastName' => { 'type' => 'string' },
@@ -279,11 +279,21 @@ def get_user_activation_settings(user_id)
   # RETURNS: a UserActivationData JSON block with the user’s current activation status.
 end
 
-# TODO: Update a particular user’s activation settings.
+# REVIEW: Update a particular user’s activation settings.
 # RETURNS: ?
-def update_user_activation_settings(user_id, user_activation_data)
+def update_user_activation_settings(user_id, is_active)
   # PUT /d2l/api/lp/(version)/users/(userId)/activation
-  # RETURNS: ?
+  if is_active != true && is_active != false
+    raise ArgumentError, 'is_active is not a boolean'
+  else
+    path = "/d2l/api/lp/#{$lp_ver}/users/#{user_id}/activation"
+    payload =
+    {
+      "IsActive" => is_active
+    }
+    _put(path, payload)
+    # RETURNS: ?
+  end
 end
 
 ########################
@@ -291,7 +301,7 @@ end
 ########################
 
 # NOTE: UNSTABLE!
-# TODO: Link a user to a Google Apps user account.
+# TODO: UNSTABLE!--Link a user to a Google Apps user account.
 # RETURNS: ?
 def link_user_google_apps_account(google_apps_linking_item)
   # POST /d2l/api/gae/(version)/linkuser