canvas_shim 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b606c1272841be003a1dfe4aa88c27cae616b9ef
+  data.tar.gz: d62427955584f06d749baa4e4993213c965f51a5
+SHA512:
+  metadata.gz: ec4dd1a8f2e4c13bcbc208861f1b6f9e91373687fda73a37099a1fa4b21e287d6508fd5e164392af6c7df1ba1544a2e63c4682ae3465f8000593dae03c0d6182
+  data.tar.gz: 82fdab6766369d97b297560143d348a639762be5fd53d5375c13a70f93a1d9cde64037d4f8892c9617bc10ba3381ebd0fb83a30ceb301f7802dd4ff7f39fbc37

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 
+
+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,28 @@
+# CanvasShim
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'canvas_shim'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install canvas_shim
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CanvasShim'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/test_app/Rakefile", __FILE__)
+task :default => ['app:spec:services']
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+require 'bundler/gem_tasks'

data/app/assets/config/canvas_shim_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/canvas_shim .js
+//= link_directory ../stylesheets/canvas_shim .css

data/app/assets/javascripts/canvas_shim/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/canvas_shim/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/canvas_shim/application_controller.rb

@@ -0,0 +1,12 @@
+module CanvasShim
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+
+    def validate_key
+      token = SettingsService::AuthToken.authenticate(
+        request.headers['HTTP_AUTHORIZATION'].try(:gsub, 'Bearer ', '')
+      )
+      render(json: {status: 'error'}, status: 401) and return unless token
+    end
+  end
+end

data/app/controllers/canvas_shim/settings_api/swagger_controller.rb

@@ -0,0 +1,11 @@
+module CanvasShim
+  module SettingsApi
+    class SwaggerController < ApplicationController
+      def show
+        render json: YAML.load_file(
+          Engine.root.to_s + "/app/services/settings_service/api_docs.yml"
+        ).to_json
+      end
+    end
+  end
+end

data/app/controllers/canvas_shim/settings_api/v1/users_controller.rb

@@ -0,0 +1,27 @@
+module CanvasShim
+  module SettingsApi
+    module V1
+      class UsersController < CanvasShim::ApplicationController
+        skip_before_action :verify_authenticity_token
+        before_action :validate_key
+
+        def update
+          settings.each do |key, value|
+            SettingsService.update_user_setting(
+              id: params[:id],
+              setting: key,
+              value: value
+            )
+          end
+          render json: { status: 'ok' }
+        end
+
+        private
+
+        def settings
+          params[:user]
+        end
+      end
+    end
+  end
+end

data/app/deploy/canvas_shim_asset_uploader.rb

@@ -0,0 +1,19 @@
+require 'aws-sdk-s3'
+class CanvasShimAssetUploader < Canvas::Cdn::S3Uploader
+  BUCKET_NAME = ENV['ASSET_OBJECT_STORE'] || ''
+  REGION = ENV['AWS_REGION'] || 'us-west-2'
+  ACCESS_KEY_ID = ENV['S3_ACCESS_KEY_ID'] || ''
+  SECRET_ACCESS_KEY = ENV['S3_ACCESS_KEY'] || ''
+
+  def initialize(folder='dist')
+    require 'aws-sdk-s3'
+    @folder = folder
+    @s3 = Aws::S3::Resource.new(
+      access_key_id: ACCESS_KEY_ID,
+      secret_access_key: SECRET_ACCESS_KEY,
+      region: REGION
+    )
+    @bucket = @s3.bucket(BUCKET_NAME)
+    @mutex = Mutex.new
+  end
+end

data/app/helpers/canvas_shim/application_helper.rb

@@ -0,0 +1,4 @@
+module CanvasShim
+  module ApplicationHelper
+  end
+end

data/app/jobs/canvas_shim/application_job.rb

@@ -0,0 +1,4 @@
+module CanvasShim
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/canvas_shim/application_mailer.rb

@@ -0,0 +1,6 @@
+module CanvasShim
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/canvas_shim/application_record.rb

@@ -0,0 +1,5 @@
+module CanvasShim
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/services/courses_service.rb

@@ -0,0 +1,5 @@
+module CoursesService
+  def self.distribute_due_dates(course:)
+    Commands::DistributeDueDates.new(course: course).call
+  end
+end

data/app/services/courses_service/commands/distribute_due_dates.rb

@@ -0,0 +1,50 @@
+module CoursesService
+  module Commands
+    class DistributeDueDates
+      def initialize(args)
+        @args = args
+        @course = args[:course]
+        @modules = ContextModule
+                    .where(
+                      'context_modules.context_id = ? AND context_modules.context_type = \'Course\' AND context_modules.name IS NOT NULL',
+                      @course.id)
+                    .order(:position)
+      end
+
+      def call
+        return unless SettingsService.get_settings(object: :school, id: 1)['auto_due_dates'] == 'on'
+        return unless course.start_at && course.end_at
+        course_assignments = assignments
+        scheduler.course_dates.each do |date, count|
+          update_assignments(course_assignments.slice!(0..count - 1), date)
+        end
+      end
+
+      private
+
+      attr_reader :course, :assignments_per_day
+
+      def scheduler
+        @scheduler ||= Scheduler.new(@args.merge(assignment_count: assignments.count))
+      end
+
+      def update_assignments(assignments_for_day, date)
+        assignments_for_day.each do |assignment|
+          next if assignment.nil?
+          assignment.update(due_at: date)
+        end
+      end
+
+      def assignments
+        assignment_list = []
+        @modules.each do |context_module|
+          context_module.content_tags
+            .where(:content_type => ['Assignment', 'DiscussionTopic'])
+            .order(:position)
+            .map { |tag| assignment_list.push(tag.assignment) }
+        end
+        assignment_list
+      end
+    end
+  end
+end

data/app/services/courses_service/commands/distribute_due_dates/scheduler.rb

@@ -0,0 +1,70 @@
+module CoursesService
+  module Commands
+    class DistributeDueDates
+      class Scheduler
+        WORKING_DAYS = %w( mon tue wed thu fri )
+
+        def initialize(args = {})
+          @args = args
+          @startdate = first_due_date
+          @enddate = args[:course].end_at
+          @assignment_count = args[:assignment_count]
+        end
+
+        def assignments_per_day
+          (assignment_count / business_days_count)
+        end
+
+        def course_dates
+          get_days
+          populate_assignment_counts
+        end
+
+        def business_days_count
+          calendar.business_days_between(startdate, enddate)
+        end
+
+        def course_days_count
+          enddate.to_date.mjd - startdate.to_date.mjd
+        end
+
+        private
+
+        attr_reader :assignment_count, :startdate, :enddate, :days
+
+        def first_due_date
+          @args[:course].start_at.in_time_zone(@args[:course].time_zone).at_end_of_day + 1.day
+        end
+
+        def calendar
+          if ENV['HOLIDAYS']
+            Business::Calendar.new(working_days: WORKING_DAYS, holidays: ENV['HOLIDAYS'].split(','))
+          else
+            Business::Calendar.new(working_days: WORKING_DAYS)
+          end
+
+        end
+
+        def get_days
+          @days ||= course_days_count.times.map do |count|
+            day = startdate + (count).days
+            day if calendar.business_day?(day)
+          end.compact
+        end
+
+        def populate_assignment_counts
+          result = {}
+          days.each do |day|
+            result[day] = assignments_per_day
+          end
+
+          (assignment_count % business_days_count).times.each do |num|
+            result[days[num]] = result[days[num]] + 1
+          end
+
+          result
+        end
+      end
+    end
+  end
+end

data/app/services/grades_service.rb

@@ -0,0 +1,33 @@
+require 'fileutils'
+
+module GradesService
+  def self.zero_out_grades!(options={})
+    return unless SettingsService.get_settings(object: :school, id: 1)['zero_out_past_due'] == 'on'
+
+    options[:log_file] = 'zero_grader_audit_' + Time.now.strftime('%Y%m%d%H%M') + '.csv'
+    FileUtils.touch('/tmp/' + options[:log_file])
+
+    submissions.find_each do |submission|
+      Commands::ZeroOutAssignmentGrades.new(submission).call!(options)
+    end
+    save_audit(options)
+  end
+
+  def self.submissions
+    Submission
+      .joins(assignment: :course)
+      .where('submissions.workflow_state = ?', 'unsubmitted')
+      .where(score: nil)
+      .where(grade: nil)
+      .where('assignments.due_at < ?', 1.hour.ago)
+      .where('courses.conclude_at > ?', Time.now)
+      .where('assignments.workflow_state = ?', 'published')
+  end
+
+  def self.save_audit(options)
+    return if options[:dry_run]
+    s3 = Aws::S3::Resource.new(region: ENV['AWS_REGION'], access_key_id: ENV['S3_ACCESS_KEY_ID'], secret_access_key: ENV['S3_ACCESS_KEY'])
+    obj = s3.bucket(ENV['S3_BUCKET_NAME']).object('zero_grader/' + options[:log_file])
+    obj.upload_file('/tmp/' + options[:log_file])
+  end
+end

data/app/services/grades_service/account.rb

@@ -0,0 +1,13 @@
+module GradesService
+  module Account
+    def self.account_admin
+      account = ::Account.default.account_users.find do |account_user|
+        account_user.role.name == 'AccountAdmin'
+      end.try(:user)
+    end
+
+    def self.strongmind_grader
+      User.new(id: -1001)
+    end
+  end
+end

data/app/services/grades_service/commands/zero_out_assignment_grades.rb

@@ -0,0 +1,73 @@
+module GradesService
+  module Commands
+    class ZeroOutAssignmentGrades
+      def initialize(submission)
+        @previous_score = submission.score
+        @submission = submission
+        @assignment = @submission.assignment
+        @student = @submission.user
+        @course = @assignment.context
+        @grader = GradesService::Account.account_admin
+      end
+
+      def call!(options={})
+        return unless options[:log_file]
+        return unless SettingsService.get_settings(object: :school, id: 1)['zero_out_past_due'] == 'on'
+        @options = options
+        return unless should_grade?
+
+        if options[:dry_run]
+          log_execution_plan
+          return
+        end
+
+        log_operation
+        @assignment.grade_student(@student, score: 0, grader: @grader)
+      end
+
+      private
+
+      def log_execution_plan
+        file = File.open('dry_run.log', 'a+')
+        file.write("Changing submission #{@submission.id} from #{@previous_score || 'nil'} to 0\n")
+        file.close
+      end
+
+      def log_operation
+        return unless @options[:log_file]
+
+        begin
+          csv = CSV.open('/tmp/' + @options[:log_file], 'a+')
+          csv << [@submission.id, @previous_score]
+          csv.close
+        rescue => e
+          raise e, 'error opening log file'
+        end
+      end
+
+      def late?
+        return @assignment.due_at.present? && 1.hour.ago > @assignment.due_at
+      end
+
+      def unscored?
+        @submission.score.nil? && @submission.grade.nil?
+      end
+
+      def unsubmitted?
+        @submission.workflow_state == 'unsubmitted'
+      end
+
+      def published?
+        @assignment.published?
+      end
+
+      def enrolled?
+        @course.includes_user?(@student, @course.admin_visible_student_enrollments)
+      end
+
+      def should_grade?
+        unsubmitted? && unscored? && late? && published? && enrolled?
+      end
+    end
+  end
+end