d2l_sdk 0.1.10 → 0.1.11

data/lib/d2l_sdk/section.rb

@@ -56,10 +56,11 @@ end
 
 # Create a new section in a particular org unit.
 def create_org_unit_section(org_unit_id, section_data)
-  payload = { 'Name' => '', # String
-              'Code' => '', # String
-              'Description' => {}, # RichTextInput -- e.g. {'Content'=>'x', 'Type'=>'y'}
-            }.merge!(section_data)
+  payload = {
+    'Name' => '', # String
+    'Code' => '', # String
+    'Description' => {}, # RichTextInput -- e.g. {'Content'=>'x', 'Type'=>'y'}
+  }.merge!(section_data)
   # Check the validity of the SectionData that is passed as a payload
   check_section_data_validity(payload)
   path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/sections/"
@@ -82,9 +83,8 @@ def check_section_enrollment_validity(section_enrollment)
 end
 
 # Enroll a user in a section for a particular org unit.
-def enroll_user_in_org_unit_section(org_unit_id,section_id, section_data)
-  payload = { 'UserId' => 9999, # Number : D2LID
-            }.merge!(section_data)
+def enroll_user_in_org_unit_section(org_unit_id, section_id, section_data)
+  payload = { 'UserId' => 9999 }.merge!(section_data) # Number : D2LID
   # Check the validity of the SectionEnrollment that is passed as a payload
   check_section_enrollment_validity(payload)
   path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/sections/#{section_id}/enrollments/"
@@ -143,13 +143,14 @@ end
 
 # Update information for a section in a particular org unit.
 def update_org_unit_section_info(org_unit_id, section_id, section_data)
-    payload = { 'Name' => '', # String
-                'Code' => '', # String
-                'Description' => {}, # RichTextInput -- e.g. {'Content'=>'x', 'Type'=>'y'}
-              }.merge!(section_data)
+    payload = {
+        'Name' => '', # String
+        'Code' => '', # String
+        'Description' => {}, # RichTextInput -- e.g. {'Content'=>'x', 'Type'=>'y'}
+    }.merge!(section_data)
     # Check the validity of the SectionData that is passed as a payload
     check_section_data_validity(payload)
-    path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/sections/section_id"
+    path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/sections/#{section_id}"
     # JSON param: SectionData
     _put(path, payload)
     # returns the SectionData JSON block, in its Fetch form

data/lib/d2l_sdk/semester.rb

@@ -21,11 +21,12 @@ end
 # via executing a POST http method using a predefined path and the new payload.
 def create_semester_data(semester_data)
     # Define a valid, empty payload and merge! with the semester_data. Print it.
-    payload = { 'Type' => 5, # Number:D2LID
-                'Name' => 'Winter 2013 Semester', # String
-                'Code' => '201701', # String #YearNUM where NUM{sp:01,su:06,fl:08}
-                'Parents' => [6606], # ARR of Number:D2LID
-              }.merge!(semester_data)
+    payload = {
+      'Type' => 5, # Number:D2LID
+      'Name' => 'Winter 2013 Semester', # String
+      'Code' => '201701', # String #YearNUM where NUM{sp:01,su:06,fl:08}
+      'Parents' => [6606], # ARR of Number:D2LID
+    }.merge!(semester_data)
     # ap payload
     check_semester_data_validity(payload)
     path = "/d2l/api/lp/#{$lp_ver}/orgstructure/"

data/lib/d2l_sdk/setup_versions.rb

@@ -9,14 +9,14 @@ $bas_ver = get_latest_product_version('bas') # Award service
 $lti_ver = get_latest_product_version('lti') # learning tools interoperability
 # ext
 
-#lti, rp, LR, ext,
+# lti, rp, LR, ext,
 puts "versions set to:"
 versions = {
-  "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
+  '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

@@ -19,7 +19,7 @@ def check_user_data_validity(user_data)
         'properties' => {
             'OrgDefinedId' => { 'type' => 'string' },
             'FirstName' => { 'type' => 'string' },
-            'MiddleName' => { 'type' => 'string' },
+            'MiddleName' => { 'type' => %w(string null) },
             'LastName' => { 'type' => 'string' },
             'ExternalEmail' => { 'type' => %w(string null) },
             'UserName' => { 'type' => 'string' },
@@ -39,7 +39,9 @@ end
 # exists in your system.
 def create_user_data(user_data)
     # Define a valid, empty payload and merge! with the user_data. Print it.
-    payload = { 'OrgDefinedId' => '', # String
+    payload =
+              {
+                'OrgDefinedId' => '', # String
                 'FirstName' => 'TestUser', # String
                 'MiddleName' => 'Test', # String
                 'LastName' => 'Test', # String
@@ -108,11 +110,7 @@ end
 # Checks whether a username already exists
 # returns: true if the the user exists already
 def does_user_exist(username)
-    if !get_user_by_username(username.to_s).nil?
-        return true
-    else
-        return false
-    end
+    !get_user_by_username(username.to_s).nil?
 end
 
 # Initiates a multithreaded search to streamline the search of a user based upon
@@ -167,24 +165,24 @@ end
 # returns: array::matching_names
 def _get_user_by_string(parameter, search_string, range, regex = false)
     # puts "searching from #{range.min.to_s} to #{range.max.to_s}"
-    i = range.min
+    baseline = range.min
     matching_names = []
     # Average difference between each paged bookmarks beginnings is 109.6
-    while i.to_i < range.max
-        # path = "/d2l/api/lp/#{$lp_ver}/users/?bookmark=" + i.to_s
-        response = get_users_by_bookmark(i.to_s)
+    while baseline.to_i < range.max
+        # path = "/d2l/api/lp/#{$lp_ver}/users/?bookmark=" + baseline.to_s
+        response = get_users_by_bookmark(baseline.to_s)
         if response['PagingInfo']['HasMoreItems'] == false
             # ap 'response returned zero items, last page possible for this thread..'
             return matching_names
         end
         response['Items'].each do |user|
             if regex && !user[parameter].nil?
-                matching_names.push(user) if (user[parameter] =~ search_string) != nil
+                matching_names.push(user) unless (user[parameter] =~ search_string).nil?
             elsif !user[parameter].nil?
                 matching_names.push(user) if user[parameter].include? search_string
             end
         end
-        i = response['PagingInfo']['Bookmark']
+        baseline = response['PagingInfo']['Bookmark']
     end
     matching_names
 end
@@ -214,7 +212,7 @@ def check_updated_user_data_validity(user_data)
         'properties' => {
             'OrgDefinedId' => { 'type' => %w(string null) },
             'FirstName' => { 'type' => 'string' },
-            'MiddleName' => { 'type' => 'string' },
+            'MiddleName' => { 'type' => %w(string null) },
             'LastName' => { 'type' => 'string' },
             'ExternalEmail' => { 'type' => %w(string null) },
             'UserName' => { 'type' => 'string' },
@@ -254,7 +252,7 @@ def update_user_data(user_id, new_data)
     # Define a path referencing the user data using the user_id
     path = "/d2l/api/lp/#{$lp_ver}/users/" + user_id.to_s
     _put(path, payload)
-    puts '[+] User data updated successfully'.green
+    # puts '[+] User data updated successfully'.green
     # Returns a UserData JSON block of the updated user's data
 end
 
@@ -272,28 +270,25 @@ end
 # ACTIVATION:###########
 ########################
 # REVIEW: Retrieve a particular user’s activation settings.
-# RETURNS: a UserActivationData JSON block with the user’s current activation status.
+# RETURNS: a UserActivationData JSON block with the current activation status.
 def get_user_activation_settings(user_id)
   path = "/d2l/api/lp/#{$lp_ver}/users/#{user_id}/activation"
   _get(path)
-  # RETURNS: a UserActivationData JSON block with the user’s current activation status.
+  # RETURNS: a UserActivationData JSON block with the current activation status of the user.
 end
 
 # REVIEW: Update a particular user’s activation settings.
 # RETURNS: ?
 def update_user_activation_settings(user_id, is_active)
   # PUT /d2l/api/lp/(version)/users/(userId)/activation
-  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
+  raise ArgumentError, 'is_active is not a boolean' if is_active != true && is_active != false
+  path = "/d2l/api/lp/#{$lp_ver}/users/#{user_id}/activation"
+  payload =
+  {
+    "IsActive" => is_active
+  }
+  _put(path, payload)
+  # RETURNS: ?
 end
 
 ########################
@@ -307,7 +302,6 @@ def link_user_google_apps_account(google_apps_linking_item)
   # POST /d2l/api/gae/(version)/linkuser
 end
 
-
 ########################
 # NOTIFICATIONS:########
 ########################
@@ -360,17 +354,12 @@ end
 # REVIEW: Update a particular user’s password.
 # NOTE: 400 errors are implicitly invalid password
 def update_user_password(user_id, user_password_data)
-  if user_password_data.is_a? String
-    path = "/d2l/api/lp/#{$lp_ver}/users/#{user_id}/password"
-    payload = {"Password" => user_password_data}
-    _put(path, payload)
-  else
-    raise ArgumentError, "Argument 'user_password_data' is not a String"
-  end
+  raise ArgumentError, "Argument 'user_password_data' is not a String" unless user_password_data.is_a? String
+  path = "/d2l/api/lp/#{$lp_ver}/users/#{user_id}/password"
+  payload = { "Password" => user_password_data }
+  _put(path, payload)
 end
 
-
-
 ########################
 # ROLES:################
 ########################
@@ -406,7 +395,6 @@ def create_new_role_from_existing_role(deep_copy_role_id, role_copy_data)
   # POST /d2l/api/lp/(version)/roles/
 end
 
-
 ########################
 # PROFILES:#############
 ########################
@@ -478,7 +466,6 @@ def get_user_profile_by_user_id(user_id)
   # Returns UserProfile JSON data block
 end
 
-
 # Retrieve a particular profile image, by User ID.
 # RETURNS: This action returns a file stream containing the current user’s
 #          profile image. Note that the back-end service may return a
@@ -589,26 +576,26 @@ end
 # REVIEW: retrieve list of known LIS roles
 def get_lis_roles(lis_urn = "")
   path = "/d2l/api/lp/#{$lp_ver}/imsconfig/roles/"
-  path += "#{lis_urn}" if lis_urn != ""
+  path += lis_urn.to_s if lis_urn != ""
   _get(path)
   # returns array of LIS role data blocks
 end
 
 # NOTE: UNSTABLE
 # REVIEW: retrieve mappings between user roles and LIS roles
-def get_user_role_lis_mappings(lis_urn = "", d2lid = 0)
+def get_user_role_lis_mappings_by_urn(lis_urn = "", d2lid = 0)
   path = "/d2l/api/lp/#{$lp_ver}/imsconfig/map/roles/"
-  path += "#{lis_urn}" if lis_urn != ""
-  path += "#{d2lid}" if d2lid != 0
+  path += lis_urn.to_s if lis_urn != ""
+  path += d2lid.to_s if d2lid != 0
   _get(path)
   # returns JSON array of LIS role mapping data blocks
 end
 
 # NOTE: UNSTABLE
 # REVIEW: retrieve mapping between a user role and a LIS role
-def get_user_role_lis_mappings(role_id, d2lid = 0)
+def get_user_role_lis_mappings_by_role(role_id, d2lid = 0)
   path = "/d2l/api/lp/#{$lp_ver}/imsconfig/map/roles/#{role_id}"
-  path += "#{d2lid}" if d2lid != 0
+  path += d2lid.to_s if d2lid != 0
   _get(path)
   # returns JSON array of LIS role mapping data blocks
 end
@@ -620,7 +607,6 @@ def map_user_role_to_lis_roles(role_id, mappings)
   # PUT /d2l/api/lp/(version)/imsconfig/map/roles/(roleId)
 end
 
-
 ########################
 # SETTINGS:#############
 ########################
@@ -641,30 +627,34 @@ def get_locale_account_settings(user_id)
   # returns Locale JSON block
 end
 
-
-
-# TODO: Add schema check for update_locale conforming to the D2L update_locale
+# Add schema check for update_locale conforming to the D2L update_locale
 # JSON data block of form: { "LocaleId" : <D2LID>}.
-def is_valid_locale_id(locale_id)
-
+def valid_locale_id?(locale_id)
+  # check if its an integer OR if its a string comprised of only numbers.
+  locale_id.is_a?(Numeric) || locale_id.is_a?(String) && !!locale_id.match(/^(\d)+$/)
 end
 
 # REVIEW: Update the current user’s locale account settings.
-# TODO: Add schema check for update_locale
 # update_locale = { "LocaleId" : <D2LID>}
-def update_current_user_locale_account_settings(update_locale)
-  payload = {"LocaleId" => 0}.merge!(update_locale)
+def update_current_user_locale_account_settings(locale_id)
+  unless valid_locale_id?(locale_id)
+    raise ArgumentError, "Variable 'update_locale' is not a "
+  end
+  payload = { 'LocaleId' => locale_id }
   path = "/d2l/api/lp/#{$lp_ver}/accountSettings/mysettings/locale/"
+
   # requires UpdateSettings JSON data block
   # update_locale = { "LocaleId" : <D2LID>}
   _put(path, payload)
 end
 
 # REVIEW: Update the locale account settings for a particular user.
-# TODO: Add schema check for update_locale
 # update_locale = { "LocaleId" : <D2LID>}
-def update_user_locale_account_settings(user_id, update_locale)
-  payload = {"LocaleId" => 0}.merge!(update_locale)
+def update_user_locale_account_settings(user_id, locale_id)
+  unless valid_locale_id?(locale_id)
+    raise ArgumentError, "Variable 'update_locale' is not a "
+  end
+  payload = { 'LocaleId' => locale_id }
   path = "/d2l/api/lp/#{$lp_ver}/accountSettings/#{user_id}/locale/"
   # requires UpdateSettings JSON data block
   # update_locale = { "LocaleId" : <D2LID>}

data/lib/d2l_sdk/version.rb

@@ -1,3 +1,3 @@
 module D2lSdk
-  VERSION = "0.1.10"
+  VERSION = '0.1.11'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: d2l_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Andrew Kulpa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-31 00:00:00.000000000 Z
+date: 2017-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,9 +144,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".fasterer.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
+- ".vscode/settings.json"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -155,7 +159,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- change_lastname.rb
 - d2l_sdk.gemspec
 - example_scripts/adjusted_courses.txt
 - example_scripts/fix_201708_courses.rb
@@ -192,8 +195,6 @@ files:
 - lib/d2l_sdk/setup_versions.rb
 - lib/d2l_sdk/user.rb
 - lib/d2l_sdk/version.rb
-- lol.txt
-- test.rb
 - tests/All_Crud_test.rb
 - tests/ETL_listener.rb
 - tests/TestCourseCRUD.rb

data/change_lastname.rb

@@ -1,65 +0,0 @@
-require 'd2l_sdk'
-
-# Setup vars for username and last name
-# retrieved via rundeck args passed to this script.
-@username = ARGV[0]
-@new_lastname = ARGV[1]
-@debug = false
-
-# Check that the user exists.
-# If the username doesn't exist, then raise.
-# Why: You can't change a user's profile that you can't reference.
-if !does_user_exist(@username)
-        raise ArgumentError, "ARGV[0], '#{@username}', is not a username that exists."
-end
-
-# Already asserted that the user exists. Retrieve Hash of the user's profile.
-user_profile = get_user_by_username(@username)
-
-# debug code
-puts "Old User Data: \n" if @debug
-ap user_profile if @debug
-
-# Change the previous d2l user data and create a new json-formatted
-# payload. The payload is merged! with a skeleton payload, but it as
-# each parameter is defined, this will not affect its usage.
-old_lastname = user_profile["LastName"]
-user_profile["LastName"] = @new_lastname # update the user's lastname
-user_profile["UserName"].sub! old_lastname, @new_lastname # update the user's username
-unless user_profile["ExternalEmail"].nil?
-  user_profile["ExternalEmail"].sub! old_lastname, @new_lastname # update the user's email
-end
-
-# Check if there already is a user created with the +new username+
-if does_user_exist(user_profile["UserName"])
-        raise RuntimeError, "A user already exists with the new username, '#{user_profile["UserName"]}'."
-end
-
-# Pull in data only necessary for user_data in +update+ form.
-new_user_data =
-{
-        'OrgDefinedId' => user_profile["OrgDefinedId"],
-        'FirstName' => user_profile["FirstName"],
-        'MiddleName' => user_profile["MiddleName"],
-        'LastName' => user_profile["LastName"], # Changed previously
-        'ExternalEmail' => user_profile["ExternalEmail"],
-        'UserName' => user_profile["UserName"],
-        'Activation' =>
-        {
-            'IsActive' => user_profile["Activation"]["IsActive"]
-        }
-}
-
-# Debug code
-puts "New User Data: \n" if @debug
-ap new_user_data if @debug
-
-# Finally update the user's UserData
-update_user_data(user_profile["UserId"], new_user_data)
-
-# Check if the user was properly created.
-if !does_user_exist(user_profile["UserName"])
-        raise "The user's last name was unsuccessfully updated."
-else
-        puts "The username was successfully updated to: '#{user_profile["UserName"]}'."
-end