d2l_api 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1de2bfe9ffb6a22f36b4ab86aa45e0244d38e10d
+  data.tar.gz: eb4bddaade69d7b4ef357affabf8629e4c8275ca
+SHA512:
+  metadata.gz: b842d840a58a867170cdad938172d13f54f6f8e08a2478c009c27ccf49bd79e5099894c866e533724d8d4aab225139bff2a9c597fb07824947f6264280afd59f
+  data.tar.gz: 2a83647632c0e11a5f08f1b5a0b8a8ae4fdd313a8f83c3bb438c8715535eeea9972b24d03047f4f17c621123f0f36a67e7283c88b6c4d57c00c65d2b9f2dcd33

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at AJ-Kulpa@wiu.edu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in d2l_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Andrew Kulpa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# D2lApi
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/d2l_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'd2l_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install d2l_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/d2l_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "d2l_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/d2l_api.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'd2l_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "d2l_api"
+  spec.version       = D2lApi::VERSION
+  spec.authors       = ["Andrew Kulpa"]
+  spec.email         = ["AJ-Kulpa@wiu.edu"]
+
+  spec.summary       = %q{Simple Ruby Gem to utilize the Valence/D2L API}
+  spec.description   = %q{Simple Ruby Gem to utilize the Valence/D2L API; requires config file to have variables declared.}
+  spec.homepage      = "https://gitlab.wiu.edu/ajk142/valence_testing"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+#    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+#  else
+#    raise "RubyGems 2.0 or newer is required to protect against " \
+#      "public gem pushes."
+#  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "awesome_print", "~> 0.1"
+  spec.add_development_dependency "rest-client", "~> 2.0"
+  spec.add_development_dependency "json", "~> 1.8"
+  spec.add_development_dependency "colorize", "~> 0.8"
+  spec.add_development_dependency "test-unit", "~> 3.1"
+end

data/lib/d2l_api.rb

@@ -0,0 +1,11 @@
+require "d2l_api/version"
+require_relative 'd2l_api/course_template'
+require_relative 'd2l_api/course'
+require_relative 'd2l_api/org_unit'
+require_relative 'd2l_api/semester'
+require_relative 'd2l_api/user'
+
+
+module D2lApi
+  puts "d2l_api loaded"
+end

data/lib/d2l_api/auth.rb

@@ -0,0 +1,84 @@
+require 'rubygems' # useful
+require 'awesome_print' # useful for debugging
+require 'base64' # NEEDED
+require 'json' # NEEDED
+require 'restclient' # NEEDED
+require 'openssl' # NEEDED
+require 'open-uri' # NEEDED
+require 'colorize' # useful
+require_relative 'config'
+
+# Global variables initialized through require_relative 'D2L_Config'
+
+# requests input from the user, cuts off any new line and downcases it.
+#
+# returns: String::downcased_user_input
+def prompt(*args)
+    print(*args)
+    gets.chomp.downcase
+end
+
+# Creates an authenticated uniform resource identifier that works with Valence
+# by calling +URI.parse+ using the path downcased, then creating a query string
+# by calling +_get_string+ with the parsed_url and the http_method. These are
+# used as the Variables and then returned as the finished uri.
+#
+# Input that is required is:
+#  * path: The path to the resource you are trying to accessing
+#  * http_method: The method utilized to access/modify the resource
+#
+# returns: String::uri
+def create_authenticated_uri(path, http_method)
+    parsed_url = URI.parse(path.downcase)
+    uri_scheme = 'https'
+    query_string = _get_string(parsed_url.path, http_method)
+    uri = uri_scheme + '://' + $hostname + parsed_url.path + query_string
+    uri << '&' + parsed_url.query if parsed_url.query
+    uri
+end
+
+# Builds an authenticated uniform resource identifier query string that
+# works properly with the Valence API.
+#
+# Required Variables:
+# * app_id, user_id, app_key, user_key
+#
+# returns: String::'authenticated_uri'
+def build_authenticated_uri_query_string(signature, timestamp)
+    "?x_a=#{$app_id}"\
+    "&x_b=#{$user_id}"\
+    "&x_c=#{get_base64_hash_string($app_key, signature)}"\
+    "&x_d=#{get_base64_hash_string($user_key, signature)}"\
+    "&x_t=#{timestamp}"
+end
+
+# uses the path, http_method, and timestamp arguments to create a properly
+# formatted signature. Then, this is returned.
+#
+# returns: String::signature
+def format_signature(path, http_method, timestamp)
+    http_method.upcase + '&' + path.encode('UTF-8') + '&' + timestamp.to_s
+end
+
+# uses the key and signature as arguments to create a hash using
+# +OpenSSL::HMAC.digest+ with an additional argument denoting the hashing
+# algorithm as 'sha256'. The hash is then encoded properly and all "="
+# are deleted to officially create a base64 hash string.
+#
+# returns: String::base64_hash_string
+def get_base64_hash_string(key, signature)
+    hash = OpenSSL::HMAC.digest('sha256', key, signature)
+    Base64.urlsafe_encode64(hash).delete('=')
+end
+
+# Used as a helper method for create_authenticated_uri in order to properly
+# create a query string that will (hopefully) work with the Valence API.
+# the arguments path and http_method are used as arguments with the current time
+# for +format_signature+ and +build_authenticated_uri_query_string+.
+#
+# returns: String::query_string
+def _get_string(path, http_method)
+    timestamp = Time.now.to_i
+    signature = format_signature(path, http_method, timestamp)
+    build_authenticated_uri_query_string(signature, timestamp)
+end

data/lib/d2l_api/config.rb

@@ -0,0 +1,11 @@
+
+#This is the host address to the test / production server
+$hostname = '' # set hostname to the test server
+# user_id and user_key are used to recognize this specific user account
+$user_id = ''
+$user_key = ''
+# #App_id and App_key are two other required variables for this to work
+$app_id = ''
+$app_key = ''
+# The version is specific to your environment. This ruby api was created for 1.4
+$version = 1.4

data/lib/d2l_api/course.rb

@@ -0,0 +1,109 @@
+require_relative 'requests'
+########################
+# COURSES:##############
+########################
+
+# Creates the course based upon a merged result of the argument course_data
+# and a preformatted payload. This is then passed as a new payload in the
+# +_post+ method in order to create the defined course.
+# Required: "Name", "Code"
+# Creates the course offering
+def create_course_data(course_data)
+    # ForceLocale- course override the user’s locale preference
+    # 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
+                'CourseTemplateId' => 99_989, # number: D2L_ID
+                'SemesterId' => nil, # number: D2L_ID  | nil
+                'StartDate' => nil, # String: UTCDateTime | nil
+                'EndDate' => nil, # String: UTCDateTime | nil
+                'LocaleId' => nil, # number: D2L_ID | nil
+                'ForceLocale' => false, # bool
+                'ShowAddressBook' => false # bool
+              }.merge!(course_data)
+    #ap payload
+    path = "/d2l/api/lp/#{$version}/courses/"
+    _post(path, payload)
+    puts '[+] Course creation completed successfully'.green
+end
+
+# In order to retrieve an entire department's class list, this method uses a
+# predefined org_unit identifier. This identifier is then appended to a path
+# and all classes withiin the department are returned as JSON objects in an arr.
+#
+# returns: JSON array of classes.
+def get_org_department_classes(org_unit_id)
+    path = "/d2l/api/lp/#{$version}/orgstructure/" + org_unit_id
+    _get(path)
+end
+
+def get_course_by_id(org_unit_id)
+    path = "/d2l/api/lp/#{$version}/courses/#{org_unit_id}"
+    _get(path)
+end
+# Retrieves all courses that have a particular string (org_unit_name) within
+# their names. This is done by first defining that none are found yet and then
+# searching through all course  for ones that do have a particular string within
+# their name, the matches are pushed into the previously empty array of matches.
+# This array is subsequently returned; if none were found, a message is returned
+#
+# returns: JSON array of matching course  data objects
+def get_courses_by_name(org_unit_name)
+    get_courses_by_property_by_string("Name", org_unit_name)
+end
+
+def get_courses_by_property_by_string(property, search_string)
+  class_not_found = true
+  puts "[+] Searching for courses using search string: #{search_string}".yellow +
+        + " -- And property: #{property}"
+  courses_results = []
+  path = "/d2l/api/lp/#{$version}/orgstructure/6606/descendants/?ouTypeId=3"
+  results = _get(path)
+  results.each do |x|
+      if x[property].downcase.include? search_string.downcase
+          class_not_found = false
+          courses_results.push(x)
+      end
+  end
+  if class_not_found
+      puts '[-] No courses could be found based upon the search string.'.yellow
+  end
+  courses_results
+end
+
+# Update the course based upon the first argument. This course object is first
+# referenced via the first argument and its data formatted via merging it with
+# a predefined payload. Then, a PUT http method is executed using the new
+# payload.
+# Utilize the second argument and perform a PUT action to replace the old data
+def update_course_data(course_id, new_data)
+    # Define a valid, empty payload and merge! with the new data.
+    payload = { 'Name' => '', # String
+                'Code' => 'off_SEMESTERCODE_STARNUM', # String
+                'StartDate' => nil, # String: UTCDateTime | nil
+                'EndDate' => nil, # String: UTCDateTime | nil
+                'IsActive' => false # bool
+              }.merge!(new_data)
+    #ap payload
+    # Define a path referencing the courses path
+    path = "/d2l/api/lp/#{$version}/courses/" + course_id.to_s
+    _put(path, payload)
+    puts '[+] Course update completed successfully'.green
+    # Define a path referencing the course data using the course_id
+    # Perform the put action that replaces the old data
+    # Provide feedback that the update was successful
+end
+
+# Deletes a course based, referencing it via its org_unit_id
+# This reference is created through a formatted path appended with the id.
+# Then, a delete http method is executed using this path, deleting the course.
+def delete_course_by_id(org_unit_id)
+    path = "/d2l/api/lp/#{$version}/courses/#{org_unit_id}" # setup user path
+    ap path
+    _delete(path)
+    puts '[+] Course data deleted successfully'.green
+end