canvas_shim 0.1.6 → 0.1.7rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 609839eafaec6666e51e55d0cc8d6edbf03fe6b3
-  data.tar.gz: 3bbd30dc0a3a84a7b71b41d699dfea5d94368e94
+SHA256:
+  metadata.gz: b5d833c2d89b8226175ffb44f45af903d1ec442e841449b8fe98c113b4c0e411
+  data.tar.gz: 26de1db9614e6743aff4a6ecdeaae65c434cbca86c5084ab0acfe63419c1533e
 SHA512:
-  metadata.gz: 589f68146ae0b4b3cc2d087d3ae09de8174abc5af2619fd0cd736859001aaf0b09514be2a180dc8a1cab277cb25df15f11c5785a3ad83ef16b6de460e59c0a24
-  data.tar.gz: 9cec254fdf2b4050229c08839c29fd52bc579e30c0ed575c66849148011bef387db8ba699aaabc59f24df0617183bc6e7d758c745224d71add04d650432d8aa0
+  metadata.gz: 9d0eec50ee26d4e9a2ebbc20552f5417079054bf43f2a42c3f3d97d67fd9716077d2897d82b6c93ac5fe29af5e8187cc49ab8cc7ea1592abf5036d7f6c946d9f
+  data.tar.gz: 6bafe2b3171ff7018c5c390619fc36bfa8cf5eeb77f25783dc68dcff31bd6a7647c6a764d418a30c81cd644de83264c839415aa831102ee1e6d9806ac2b2a132

data/app/services/pipeline_service/commands/publish.rb

@@ -35,9 +35,7 @@ module PipelineService
       end
 
       def post_to_pipeline
-        client.new(
-          @args.merge(object: object)
-        ).call
+        client.new(@args.merge(object: object)).call
       end
     end
   end

data/app/services/pipeline_service/endpoints/pipeline/message_builder.rb

@@ -46,7 +46,6 @@ module PipelineService
         end
 
         def configure_dependencies
-          @message_class = @args[:message_class] || PipelinePublisher::Message
           @fetcher       = @args[:fetcher] || Serializers::Fetcher
           @logger        = @args[:logger] || PipelineService::Logger
           @canvas_domain = ENV['CANVAS_DOMAIN']
@@ -58,11 +57,11 @@ module PipelineService
         end
 
         def build
-          message_class.new(payload.to_hash)
+          payload.to_hash
         end
 
         def noun
-          object.class.to_s.underscore
+          object.class.to_s.split('::').last.underscore
         end
 
         def id

data/app/services/pipeline_service/events/emitter.rb

@@ -1,16 +1,13 @@
 module PipelineService
   module Events
     class Emitter
-      def initialize(args={})
+      def initialize args={}
         @object = args[:object]
         @args = args
-        @responder  = @args[:responder] || Events::Responders::SIS
-        @event = Events::GradedOutEvent
+        @responder = @args[:responder] || Events::Responders::SIS
       end
 
       def call
-        return unless object.is_a?(Enrollment)
-        fetch_serializer
         build_message
         build_responder
         build_subscriptions
@@ -19,26 +16,49 @@ module PipelineService
 
       private
 
-      attr_reader :subscriptions, :object, :responder, :message, :serializer, :event
+      attr_reader :subscriptions, :object, :responder, :message
+
+      def events
+        {
+          graded_out: Events::GradedOutEvent,
+          grade_changed: Events::GradeChangedEvent
+        }
+      end
 
       def build_subscriptions
-        @subscriptions = [
-          Events::Subscription.new(
-            event: :graded_out,
-            responder: responder
+        @subscriptions = []
+
+        @subscriptions << Events::Subscription.new(
+          event: :graded_out,
+          responder: Events::Responders::SIS.new(
+            object: object,
+            message: message
+          )
+        )
+
+        @subscriptions << Events::Subscription.new(
+          event: :grade_changed,
+          responder: Events::Responders::SISUnitGrade.new(
+            object: object,
+            message: message
           )
-        ]
+        )
       end
 
       def build_responder
-        @responder = responder.new(
+        @responder = Events::Responders::SIS.new(
           object: object,
           message: message
         )
       end
 
-      def fetch_serializer
-        @serializer = Serializers::CanvasAPIEnrollment
+      def serializer
+        case object
+        when PipelineService::Nouns::UnitGrades
+          Serializers::UnitGrades
+        when Enrollment
+          Serializers::CanvasAPIEnrollment
+        end
       end
 
       def build_message
@@ -47,8 +67,10 @@ module PipelineService
 
       def emit
         subscriptions.each do |subscription|
-          next if subscription.event != :graded_out
-          event.new(@args.merge(subscription: subscription)).emit
+          next unless events[subscription.event]
+          events[subscription.event].new(
+            @args.merge(subscription: subscription)
+          ).emit
         end
       end
     end

data/app/services/pipeline_service/events/grade_changed_event.rb

@@ -0,0 +1,24 @@
+module PipelineService
+  module Events
+    class GradeChangedEvent
+      def initialize args
+        @args = args
+        @subscription = args[:subscription]
+        @object = args[:object]
+        @changes = args[:changes]
+      end
+
+      def emit
+        return unless should_trigger?
+        @subscription.responder.call
+      end
+
+      private
+
+      def should_trigger?
+        return false unless @changes['score']
+        @object.is_a?(PipelineService::Nouns::UnitGrades)
+      end
+    end
+  end
+end

data/app/services/pipeline_service/events/responders/sis_unit_grade.rb

@@ -0,0 +1,61 @@
+module PipelineService
+  module Events
+    module Responders
+      class SISUnitGrade
+        HEADERS = { 'Content-Type' => 'application/json' }
+
+        def initialize(object:, message:, args: {})
+          @message = message
+          @args = args
+          configure_dependencies
+        end
+
+        def call
+          raise 'Missing config' if missing_config?
+          queue.enqueue(self)
+        end
+
+        def perform
+          post
+          log
+        end
+
+        private
+
+        attr_reader :message, :api_key, :endpoint, :args, :queue
+
+        def configure_dependencies
+          @api_key  = ENV['SIS_UNIT_GRADE_ENDPOINT_API_KEY']
+          @endpoint = ENV['SIS_UNIT_GRADE_ENDPOINT']
+          @queue    = args[:queue] || Delayed::Job
+        end
+
+        def missing_config?
+          [@api_key, @endpoint].any?(&:nil?)
+        end
+
+        def log
+          PipelineService::Logger.new(
+              source: 'pipeline_event::grade_changed',
+              message: message,
+              enpdoint: build_endpoint
+          ).call
+        end
+
+        def build_endpoint
+          endpoint + '?apiKey=' + api_key
+        end
+
+        def post
+          return unless message
+
+          PipelineService::Events::HTTPClient.post(
+            build_endpoint,
+            body:    message.to_json,
+            headers: HEADERS
+          )
+        end
+      end
+    end
+  end
+end

data/app/services/pipeline_service/http_client.rb

@@ -11,7 +11,8 @@ module PipelineService
     end
 
     def post(args)
-      PipelinePublisher::MessagesApi.new.messages_post(*args)
+      message = PipelinePublisher::Message.new(*args)
+      PipelinePublisher::MessagesApi.new.messages_post(message)
     end
 
     def get(endpoint, args)

data/app/services/pipeline_service/nouns/unit_grades.rb

@@ -0,0 +1,13 @@
+module PipelineService
+  module Nouns
+    class UnitGrades
+      attr_reader :course, :student, :id, :changes
+      def initialize(submission)
+        @course = submission.assignment.course
+        @student = submission.user
+        @id = submission.id
+        @changes = submission.changes
+      end
+    end
+  end
+end

data/app/services/pipeline_service/serializers/fetcher.rb

@@ -6,6 +6,8 @@ module PipelineService
       # Maps any object with a class containing 'enrollment' to the enrollment serializer
       def self.fetch(object:)
         case object.class.to_s
+        when /PipelineService::Nouns::UnitGrades/
+          PipelineService::Serializers::UnitGrades
         when /Enrollment/
           PipelineService::Serializers::Enrollment
         else

data/app/services/pipeline_service/serializers/unit_grades.rb

@@ -0,0 +1,17 @@
+module PipelineService
+  module Serializers
+    class UnitGrades
+      def initialize(object:)
+        @course = object.course
+        @student = object.student
+      end
+
+      def call
+        UnitsService::Commands::GetUnitGrades.new(
+          course: @course,
+          student: @student
+        ).call
+      end
+    end
+  end
+end

data/app/services/units_service/commands/get_unit_grades.rb

@@ -0,0 +1,43 @@
+module UnitsService
+  module Commands
+    class GetUnitGrades
+      def initialize(course:, student:)
+        @course = course
+        @student = student
+      end
+
+      def call
+        get_submissions
+        calculate_grades
+        payload
+      end
+
+      private
+
+      def get_submissions
+        @unit_submissions = UnitsService::Queries::GetSubmissions.new(
+          course: @course,
+          student: @student
+        ).query
+      end
+
+      def payload
+        {
+          school_domain: ENV['CANVAS_DOMAIN'],
+          course_id: @course.id,
+          student_id: @student.id,
+          units: @grades.map {|unit, score| {
+            id: unit.id,
+            position: unit.position,
+            created_at: unit.created_at,
+            score: score
+          }}
+        }
+      end
+
+      def calculate_grades
+        @grades = UnitsService::GradesCalculator.new(@unit_submissions, @course).call
+      end
+    end
+  end
+end

data/app/services/units_service/grades_calculator.rb

@@ -0,0 +1,39 @@
+module UnitsService
+  class GradesCalculator
+    def initialize unit_submissions, course
+      @unit_submissions = unit_submissions
+      @course = course
+    end
+
+    def call
+      result = {}
+
+      @unit_submissions.each do |unit, submissions|
+        next if submissions.count == 0
+        result[unit] = weighted_average(submissions)
+      end
+
+      result
+    end
+
+    private
+
+    def weighted_average(submissions)
+      result = {}
+      submissions.group_by do |submission|
+        submission.assignment.assignment_group
+      end.each do |group, submissions|
+        result[group.name] = [] unless result[group]
+        average = submissions.sum(&:score).to_f / submissions.count
+        weight  = category_weights[group.name] / category_weights.values.sum
+        result[group.name] << average * weight
+      end
+
+      result.sum { |r, weighted| weighted.sum }
+    end
+
+    def category_weights
+      Queries::GetCategoryWeights.new(@course).query
+    end
+  end
+end

data/app/services/units_service/queries/get_category_weights.rb

@@ -0,0 +1,13 @@
+module UnitsService
+  module Queries
+    class GetCategoryWeights
+      def initialize(course)
+        @course = course
+      end
+
+      def query
+        @course.assignment_groups.map{|ag| [ag.name, ag.group_weight]}.to_h
+      end
+    end
+  end
+end

data/app/services/units_service/queries/get_items.rb

@@ -0,0 +1,24 @@
+module UnitsService
+  module Queries
+    class GetItems
+      def initialize(course:)
+        @course = course
+        @context_modules = @course.context_modules
+      end
+
+      def query
+        result = {}
+
+        @context_modules.each do |context_module|
+          result[context_module] =
+            context_module.content_tags.select do |ct|
+              ct.content.present? &&
+              ct.content.respond_to?(:submissions) &&
+              ct.content.workflow_state == 'published'
+            end
+        end
+        result
+      end
+    end
+  end
+end

data/app/services/units_service/queries/get_submissions.rb

@@ -0,0 +1,25 @@
+module UnitsService
+  module Queries
+    class GetSubmissions
+      def initialize(course:, student:)
+        @student = student
+        @course = course
+      end
+
+      def query
+        result = {}
+        units.each do |unit, items|
+          items.each do |item|
+            result[unit] = item.content.submissions.where(user_id: @student.id).where("excused is not true")
+          end
+        end
+
+        result
+      end
+
+      def units
+        GetItems.new(course: @course).query
+      end
+    end
+  end
+end

data/lib/canvas_shim/engine.rb

@@ -1,16 +1,15 @@
 require 'csv'
-require "rails"
 require 'grape'
 require 'grape-swagger'
 require 'grape-swagger-ui'
 require 'aws-sdk-dynamodb'
-require "pipeline_publisher_ruby"
 require "business"
 require 'httparty'
 require 'aws-sdk-core'
 require 'aws-sdk-s3'
-require 'inst-jobs'
 require 'pg'
+require "pipeline_publisher_ruby"
+
 
 module CanvasShim
   class Engine < ::Rails::Engine

data/lib/canvas_shim/version.rb

@@ -1,3 +1,3 @@
 module CanvasShim
-  VERSION = '0.1.6'
+  VERSION = '0.1.7rc'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: canvas_shim
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7rc
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2018-11-16 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.0.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.0.4
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
@@ -123,61 +109,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk-core
+  name: loofah
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.27.0
+        version: 2.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.27.0
-- !ruby/object:Gem::Dependency
-  name: aws-sdk-s3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: inst-jobs
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.3
 description: A rails engine to be integrated with Canvas
 email:
 - ''
@@ -215,12 +159,15 @@ files:
 - app/services/pipeline_service/endpoints/pipeline.rb
 - app/services/pipeline_service/endpoints/pipeline/message_builder.rb
 - app/services/pipeline_service/events/emitter.rb
+- app/services/pipeline_service/events/grade_changed_event.rb
 - app/services/pipeline_service/events/graded_out_event.rb
 - app/services/pipeline_service/events/http_client.rb
 - app/services/pipeline_service/events/responders/sis.rb
+- app/services/pipeline_service/events/responders/sis_unit_grade.rb
 - app/services/pipeline_service/events/subscription.rb
 - app/services/pipeline_service/http_client.rb
 - app/services/pipeline_service/logger.rb
+- app/services/pipeline_service/nouns/unit_grades.rb
 - app/services/pipeline_service/pipeline_client.rb
 - app/services/pipeline_service/serializers/assignment.rb
 - app/services/pipeline_service/serializers/base_methods.rb
@@ -228,6 +175,7 @@ files:
 - app/services/pipeline_service/serializers/enrollment.rb
 - app/services/pipeline_service/serializers/fetcher.rb
 - app/services/pipeline_service/serializers/submission.rb
+- app/services/pipeline_service/serializers/unit_grades.rb
 - app/services/pipeline_service/serializers/user.rb
 - app/services/settings_service.rb
 - app/services/settings_service/api_docs.yml
@@ -250,6 +198,11 @@ files:
 - app/services/settings_service/student_assignment_repository.rb
 - app/services/settings_service/submission.rb
 - app/services/settings_service/user.rb
+- app/services/units_service/commands/get_unit_grades.rb
+- app/services/units_service/grades_calculator.rb
+- app/services/units_service/queries/get_category_weights.rb
+- app/services/units_service/queries/get_items.rb
+- app/services/units_service/queries/get_submissions.rb
 - app/views/layouts/canvas_shim/application.html.erb
 - config/initializers/hash.rb
 - config/initializers/string.rb
@@ -273,12 +226,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A tool to make it easy to write code that plugs into canvas