Merge pull request #453 from macite/new/d2lintegration

New D2L Integration

Author: macite

Gemfile

@@ -103,6 +103,7 @@ gem 'tca_client', '1.0.4'
 # Async jobs
 gem 'sidekiq'
 gem 'sidekiq-cron'
+gem 'sidekiq-unique-jobs'
 
 # Redis for sidekiq, caching, and action cable (eventually)
 gem 'redis'
@@ -112,3 +113,6 @@ gem 'shellwords'
 
 # PDF reader for validating PDF file submissions
 gem 'pdf-reader'
+
+# oauth gem for OAuth2 authentication - D2L
+gem 'oauth2'

Gemfile.lock

@@ -190,6 +190,7 @@ GEM
       railties (>= 6.0.6.1)
     hashdiff (1.1.0)
     hashery (2.1.2)
+    hashie (5.0.0)
     hirb (0.7.3)
     http-accept (1.7.0)
     http-cookie (1.0.6)
@@ -212,6 +213,8 @@ GEM
       bindata
       faraday (~> 2.0)
       faraday-follow_redirects
+    jwt (2.9.3)
+      base64
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -243,6 +246,8 @@ GEM
       tcp_timeout (~> 0.1.1)
     msgpack (1.7.2)
     multi_json (1.15.0)
+    multi_xml (0.7.1)
+      bigdecimal (~> 3.1)
     mustermann (3.0.0)
       ruby2_keywords (~> 0.0.1)
     mustermann-grape (1.1.0)
@@ -267,6 +272,13 @@ GEM
       racc (~> 1.4)
     nokogiri (1.16.6-x86_64-linux)
       racc (~> 1.4)
+    oauth2 (2.0.9)
+      faraday (>= 0.17.3, < 3.0)
+      jwt (>= 1.0, < 3.0)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 4)
+      snaky_hash (~> 2.0)
+      version_gem (~> 1.1)
     observer (0.1.2)
     orm_adapter (0.5.0)
     parallel (1.25.1)
@@ -431,12 +443,19 @@ GEM
       fugit (~> 1.8)
       globalid (>= 1.0.1)
       sidekiq (>= 6)
+    sidekiq-unique-jobs (8.0.10)
+      concurrent-ruby (~> 1.0, >= 1.0.5)
+      sidekiq (>= 7.0.0, < 8.0.0)
+      thor (>= 1.0, < 3.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    snaky_hash (2.0.1)
+      hashie
+      version_gem (~> 1.1, >= 1.1.1)
     solargraph (0.50.0)
       backport (~> 1.2)
       benchmark
@@ -483,6 +502,7 @@ GEM
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
     uri (0.13.0)
+    version_gem (1.1.4)
     warden (1.2.9)
       rack (>= 2.0.9)
     webmock (3.23.1)
@@ -528,6 +548,7 @@ DEPENDENCIES
   moss_ruby (>= 1.1.4)
   mysql2
   net-smtp
+  oauth2
   pdf-reader
   puma
   rack-cors
@@ -553,6 +574,7 @@ DEPENDENCIES
   shellwords
   sidekiq
   sidekiq-cron
+  sidekiq-unique-jobs
   simplecov
   solargraph
   sprockets-rails

README.md

@@ -91,6 +91,10 @@ class ApiRoot < Grape::API
   mount TutorialEnrolmentsApi
   mount UnitRolesApi
   mount UnitsApi
+
+  mount D2lIntegrationApi::D2lApi
+  mount D2lIntegrationApi::OauthPublicApi
+
   mount UsersApi
   mount WebcalApi
   mount WebcalPublicApi
@@ -134,6 +138,8 @@ class ApiRoot < Grape::API
   AuthenticationHelpers.add_auth_to ScormApi
   AuthenticationHelpers.add_auth_to TestAttemptsApi
 
+  AuthenticationHelpers.add_auth_to D2lIntegrationApi::D2lApi
+
   add_swagger_documentation \
     base_path: nil,
     api_version: 'v1',

app/api/api_root.rb

@@ -147,7 +147,7 @@ class AuthenticationApi < Grape::API
         protocol = Rails.env.development? ? 'http' : 'https'
         host = "#{protocol}://#{host}"
       end
-      redirect "#{host}/#/sign_in?authToken=#{onetime_token.authentication_token}&username=#{user.username}"
+      redirect "#{host}/sign_in?authToken=#{onetime_token.authentication_token}&username=#{user.username}"
     end
   end
 
@@ -224,7 +224,7 @@ class AuthenticationApi < Grape::API
         protocol = Rails.env.development? ? 'http' : 'https'
         host = "#{protocol}://#{host}"
       end
-      redirect "#{host}/#/sign_in?authToken=#{onetime_token.authentication_token}&username=#{user.username}"
+      redirect "#{host}/sign_in?authToken=#{onetime_token.authentication_token}&username=#{user.username}"
     end
   end
 

app/api/authentication_api.rb

@@ -0,0 +1,184 @@
+require 'grape'
+
+module D2lIntegrationApi
+  # The D2l API provides the frontend with the ability to register
+  # integration details to connect units with D2L. This will allow
+  # grade book items to be copied from portfolio results to D2L.
+  class D2lApi < Grape::API
+    helpers AuthenticationHelpers
+    helpers AuthorisationHelpers
+    helpers FileStreamHelper
+    include LogHelper
+
+    before do
+      authenticated?
+    end
+
+    desc 'Get the D2L assessment mapping for a unit'
+    get '/units/:unit_id/d2l' do
+      unit = Unit.find(params[:unit_id])
+
+      unless authorise?(current_user, unit, :update)
+        error!({ error: 'Not authorised to view D2L details' }, 403)
+      end
+
+      present unit.d2l_assessment_mapping, with: D2lIntegrationApi::Entities::D2lEntity
+    end
+
+    desc 'Create a D2L assessment mapping for a unit'
+    params do
+      requires :org_unit_id, type: String, desc: 'The org unit id for the D2L unit'
+      optional :grade_object_id, type: Numeric, desc: 'The grade object id for the D2L unit'
+    end
+    post '/units/:unit_id/d2l' do
+      unit = Unit.find(params[:unit_id])
+
+      unless authorise?(current_user, unit, :update)
+        error!({ error: 'Not authorised to add D2L details' }, 403)
+      end
+
+      accepted_params = ActionController::Parameters.new(params).permit(:unit_id, :org_unit_id, :grade_object_id)
+
+      d2l = D2lAssessmentMapping.create!(accepted_params)
+      present d2l, with: D2lIntegrationApi::Entities::D2lEntity
+    end
+
+    desc 'Delete a D2L assessment mapping for a unit'
+    delete '/units/:unit_id/d2l/:id' do
+      unit = Unit.find(params[:unit_id])
+
+      unless authorise?(current_user, unit, :update)
+        error!({ error: 'Not authorised to delete D2L details' }, 403)
+      end
+
+      d2l = unit.d2l_assessment_mapping
+
+      if d2l.id != params[:id].to_i
+        error!({ error: 'D2L details not found' }, 404)
+      end
+
+      d2l.destroy if d2l.present?
+      status 204
+    end
+
+    desc 'Update a D2L assessment mapping for a unit'
+    params do
+      optional :org_unit_id, type: String, desc: 'The org unit id for the D2L unit'
+      optional :grade_object_id, type: Numeric, desc: 'The grade object id for the D2L unit'
+    end
+    put '/units/:unit_id/d2l/:id' do
+      unit = Unit.find(params[:unit_id])
+
+      unless authorise?(current_user, unit, :update)
+        error!({ error: 'Not authorised to update D2L details' }, 403)
+      end
+
+      d2l = unit.d2l_assessment_mapping
+
+      if d2l.id != params[:id].to_i
+        error!({ error: 'D2L details not found' }, 404)
+      end
+
+      accepted_params = ActionController::Parameters.new(params).permit(:org_unit_id, :grade_object_id)
+
+      d2l.update!(accepted_params)
+      present d2l, with: D2lIntegrationApi::Entities::D2lEntity
+    end
+
+    desc 'Initiate a login to D2L as a convenor or admin'
+    post '/d2l/login_url' do
+      unless authorise? current_user, User, :convene_units
+        error!({ error: 'Not authorised to login to D2L' }, 403)
+      end
+
+      begin
+        response = D2lIntegration.login_url(current_user)
+      rescue StandardError => e
+        error!({ error: e.message }, 500)
+      end
+
+      present response, with: Grape::Presenters::Presenter
+    end
+
+    desc 'Trigger the posting of grades to D2L'
+    post '/units/:unit_id/d2l/grades' do
+      unit = Unit.find(params[:unit_id])
+
+      unless authorise?(current_user, unit, :update)
+        error!({ error: 'Not authorised to post grades to D2L' }, 403)
+      end
+
+      if unit.d2l_assessment_mapping.blank?
+        error!({ error: 'Configure D2L details for unit before starting transfer' }, 403)
+      end
+
+      token = current_user.user_oauth_tokens.where(provider: :d2l).last
+      if token.blank? || token.expires_at < 10.minutes.from_now
+        error!({ error: 'Login to D2L before transferring results' }, 403)
+      end
+
+      D2lPostGradesJob.perform_async(unit.id, current_user.id)
+
+      status 202
+    end
+
+    desc 'Get the result of a grade transfer to D2L'
+    get '/units/:unit_id/d2l/grades' do
+      unit = Unit.find(params[:unit_id])
+
+      unless authorise?(current_user, unit, :update)
+        error!({ error: 'Not authorised to view grade transfer results' }, 403)
+      end
+
+      file_path = D2lIntegration.result_file_path(unit)
+      unless File.exist?(file_path)
+        error!({ error: 'No grade transfer result found' }, 404)
+      end
+
+      content_type 'text/csv'
+
+      stream_file(file_path)
+    end
+
+    desc 'Determing if grade results are available for a unit'
+    get '/units/:unit_id/d2l/grades/available' do
+      unit = Unit.find(params[:unit_id])
+
+      unless authorise?(current_user, unit, :update)
+        error!({ error: 'Not authorised to view grade transfer results' }, 403)
+      end
+
+      file_path = D2lIntegration.result_file_path(unit)
+      response = {
+        available: File.exist?(file_path),
+        running: D2lIntegration.d2l_grade_job_present?(unit)
+      }
+
+      present response, with: Grape::Presenters::Presenter
+    end
+
+    desc 'Determing if unit is weighted'
+    get '/units/:unit_id/d2l/grades/weighted' do
+      unit = Unit.find(params[:unit_id])
+
+      unless authorise?(current_user, unit, :update)
+        error!({ error: 'Not authorised to view unit details' }, 403)
+      end
+
+      d2l = unit.d2l_assessment_mapping
+
+      return false unless d2l.present? && d2l.org_unit_id.present?
+
+      present D2lIntegration.grade_weighted?(d2l, current_user), with: Grape::Presenters::Presenter
+    end
+
+    desc 'Get D2L api endpoint'
+    get '/d2l/endpoint' do
+      unless authorise? current_user, User, :convene_units
+        error!({ error: 'Not authorised to view D2L endpoint' }, 403)
+      end
+
+      present D2lIntegration.d2l_api_host, with: Grape::Presenters::Presenter
+    end
+  end
+end

app/api/d2l_integration_api/d2l_api.rb

@@ -0,0 +1,9 @@
+module D2lIntegrationApi
+  module Entities
+    class D2lEntity < Grape::Entity
+      expose :id
+      expose :org_unit_id
+      expose :grade_object_id
+    end
+  end
+end

app/api/d2l_integration_api/entities/d2l_entity.rb

@@ -0,0 +1,22 @@
+require 'grape'
+
+module D2lIntegrationApi
+  # Public api for oauth callback
+  class OauthPublicApi < Grape::API
+    include LogHelper
+
+    desc 'Callback for oauth login'
+    params do
+      requires :code, type: String, desc: 'The code returned from the OAuth login'
+      requires :state, type: String, desc: 'The state returned from the OAuth login'
+    end
+    get '/d2l/callback' do
+      D2lIntegration.process_callback(params[:code], params[:state])
+
+      host = Doubtfire::Application.config.institution[:host]
+      redirect "#{host}/success-close"
+    rescue StandardError => e
+      error!({ error: "Error processing oauth callback: #{e.message}" }, 500)
+    end
+  end
+end

app/api/d2l_integration_api/oauth_public_api.rb

@@ -9,7 +9,8 @@ class SettingsApi < Grape::API
     response = {
       externalName: Doubtfire::Application.config.institution[:product_name],
       overseerEnabled: Doubtfire::Application.config.overseer_enabled,
-      tiiEnabled: TurnItIn.enabled?
+      tiiEnabled: TurnItIn.enabled?,
+      d2lEnabled: D2lIntegration.enabled?
     }
 
     present response, with: Grape::Presenters::Presenter