d2l_api 0.1.2

data/lib/d2l_api/user.rb

@@ -0,0 +1,172 @@
+require_relative 'requests'
+require 'thread'
+
+########################
+# USERS:################
+########################
+# Creates the user using user_data as an argument.
+# A Hash is merged with the user_data. The data types for each Hash key is
+# specified below. For the ExternalEmail, there must be either nil for the value
+# or a WELL FORMED email address. The username must be unique, meaning no other
+# user has that name. All of the rest can remain the same, assuming roleId 110
+# 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
+                'FirstName' => 'TestUser', # String
+                'MiddleName' => 'Test', # String
+                'LastName' => 'Test', # String
+                'ExternalEmail' => nil, # String (nil or well-formed email addr)
+                'UserName' => 'test12345a', # String
+                'RoleId' => 110, # number
+                'IsActive' => false, # bool
+                'SendCreationEmail' => false, # bool
+              }.merge!(user_data)
+    #ap payload
+    # Define a path referencing the course data using the course_id
+    path = "/d2l/api/lp/#{$version}/users/"
+    _post(path, payload)
+    puts '[+] User creation completed successfully'.green
+end
+
+#Retrieves the whoami of the user authenticated through the config file.
+#returns: JSON whoami response
+def get_whoami
+    path = "/d2l/api/lp/#{$version}/users/whoami"
+    _get(path)
+end
+
+# Retrieves a user based upon an explicitly defined username.
+# Returns: JSON response of this user.
+def get_user_by_username(username)
+    path = "/d2l/api/lp/#{$version}/users/?userName=#{username}"
+    _get(path)
+end
+
+# Uses a min and max to create a range.
+# returns: range obj
+def create_range(min, max)
+    (min..max)
+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
+end
+
+# Initiates a multithreaded search to streamline the search of a user based upon
+# a part of their search str. This calls +get_user_by_string+, which is actually
+# using a bookmarked search. This brings the search time down from 15+ minutes
+# to only ~10-13 seconds, depending upon the computer. This can be sped up MUCH
+# more by using a computer with more cores. Anyways, based upon the number of
+# threads used, iterations are performed, specifying certain ranges for each
+# thread to search by using +get_user_by_string+. Upon all of the threads
+# joining, the thread_results are returned (as they are all the matching names)
+#
+# returns: Array::param_values_with_string_included
+def multithreaded_user_search(parameter, search_string, num_of_threads)
+    # Assumed: there is only up to 60,000 users.
+    # Start from 1, go up to max number of users for this search...
+    max_users = 60_000
+    range_min = 1
+    # range max = the upper limit for the search for a thread
+    range_max = max_users / num_of_threads + 1
+    threads = []
+    thread_results = []
+    #ap "creating #{num_of_threads} threads..."
+    # from 0 up until max number of threads..
+    (0...num_of_threads - 1).each do |iteration|
+        # setup range limits for the specific thread
+        min = range_min + range_max * iteration
+        max = range_max + (range_max - 1) * iteration
+        range = create_range(min, max)
+        # push thread to threads arr and start thread search of specified range.
+        threads[iteration] = Thread.new do
+            get_user_by_string(parameter, search_string, range).each do |match|
+                thread_results.push(match)
+            end
+        end
+    end
+    # Join all of the threads
+    threads.each(&:join)
+    puts "returning search results for #{parameter}::#{search_string}"
+    # Return an array of users that exist with the search_string in the param.
+    thread_results
+end
+
+# get_user_by_string uses arguments search_string and range. To use these,
+# a range is created, an array of matching names is initialized, and then
+# the entire range is iterated to check for names that have the search_string
+# in them. Upon reaching a page that has an empty items JSON array, the search
+# ends. This is due to the fact that pages with zero items will not have any
+# more users past them. The array of matching names is then returned.
+#
+# returns: array::matching_names
+def get_user_by_string(parameter, search_string, range)
+    # puts "searching from #{range.min.to_s} to #{range.max.to_s}"
+    i = range.min
+    matching_names = []
+    # Average difference between each paged bookmarks beginnings is 109.6
+    while i.to_i < range.max
+        path = "/d2l/api/lp/#{$version}/users/?bookmark=" + i.to_s
+        response = _get(path)
+        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|
+            matching_names.push(user) if user[parameter].include? search_string
+        end
+        i = response['PagingInfo']['Bookmark']
+    end
+    matching_names
+end
+
+# Retrieves a user based upon an explicitly pre-defined user_id. This is also
+# known as the Identifier of this user object. Upon retrieving the user, it
+# is then returned.
+#
+# returns: JSON user object.
+def get_user_by_user_id(user_id)
+    path = "/d2l/api/lp/#{$version}/users/" + user_id.to_s
+    _get(path)
+end
+
+# Updates the user's data (identified by user_id)
+# By merging input, named new_data, with a payload, the user_data is guarenteed
+# to at least be formatted correctly. The data, itself, depends upon the api
+# user. Once this is merged, a put http method is utilized to update the user
+# data.
+def update_user_data(user_id, new_data)
+    # Define a valid, empty payload and merge! with the user_data. Print it.
+    payload = {
+        'OrgDefinedId' => '',
+        'FirstName' => '',
+        'MiddleName' => '',
+        'LastName' => '',
+        'ExternalEmail' => nil, # Predefines user data, in the case that
+        'UserName' => '',       # there is are variables left out in the JSON
+        'Activation' => {
+            'IsActive' => false
+        }
+    }.merge!(new_data)
+    # Define a path referencing the user data using the user_id
+    path = "/d2l/api/lp/#{$version}/users/" + user_id.to_s
+    _put(path, payload)
+    puts '[+] User data updated successfully'.green
+end
+
+# Deletes the user's data (identified by user_id). By forming a path that is
+# correctly referencing this user's data, a delete http method is executed and
+# effectively deleted the user that is referenced.
+def delete_user_data(user_id)
+    # Define a path referencing the user data using the user_id
+    path = "/d2l/api/lp/#{$version}/users/" + user_id.to_s # setup user path
+    _delete(path)
+    puts '[+] User data deleted successfully'.green
+end

data/lib/d2l_api/version.rb

@@ -0,0 +1,3 @@
+module D2lApi
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: d2l_api
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Andrew Kulpa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Simple Ruby Gem to utilize the Valence/D2L API; requires config file
+  to have variables declared.
+email:
+- AJ-Kulpa@wiu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/.DS_Store
+- bin/console
+- bin/setup
+- d2l_api.gemspec
+- lib/.DS_Store
+- lib/d2l_api.rb
+- lib/d2l_api/.DS_Store
+- lib/d2l_api/auth.rb
+- lib/d2l_api/config.rb
+- lib/d2l_api/course.rb
+- lib/d2l_api/course_template.rb
+- lib/d2l_api/org_unit.rb
+- lib/d2l_api/requests.rb
+- lib/d2l_api/semester.rb
+- lib/d2l_api/user.rb
+- lib/d2l_api/version.rb
+homepage: https://gitlab.wiu.edu/ajk142/valence_testing
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Simple Ruby Gem to utilize the Valence/D2L API
+test_files: []