canvas_sync 0.17.43 → 0.18.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d7516d1ed3059c0c62d1f1ac058841dd289aca1ff8007576be2b0d823def9b7
-  data.tar.gz: 39fc2b3ade4599edaec6282b1db7b45f8cb81817573d7f35e7de1377624b1474
+  metadata.gz: de4a872d4a40555407e9dd9e2ab4e10aabfe61a68e06be46caaface500d89358
+  data.tar.gz: a79a7d11bdf1565662aab1832cc9cd664cc7e41b52e8586c57f579ef0b2f9f6a
 SHA512:
-  metadata.gz: '0978316cfc1c66f2411d1fe00b3c9375a4032b8b6be49d63807fb596bc07f25367fe013e3e5bbba32085e0ebf9a4bfcd977c19c5e20a11c41bf02de0da40bd2a'
-  data.tar.gz: 7496829655356548947c2782a024c76370f9d1f74ac6b96b17d2df2c4afd177f5e43be6d0b60b1cee79955e15ba5a387e002c784bcc0dde2ee48b3bae7f61783
+  metadata.gz: 0b50db7fb0d71fc8e707793e4ba3275407e2a8e3e00d6991d5e233c1aeb479859e9d6a36206b77e7d52797f4dd422ae1ab0a4c8d249767d885587b2616368eba
+  data.tar.gz: 61bb66d592d83b9e263d443328a05d32a1bd17e551a87cbd59c68821820bf471c80fa708719edc35dbbbe6530fa0496d2e4c99ee70ddb7836195412b3e8687d2

data/lib/canvas_sync/concerns/ability_helper.rb

@@ -0,0 +1,103 @@
+module CanvasSync::Concerns
+  module AbilityHelper
+    extend ActiveSupport::Concern
+
+    # PandaPal Domain
+
+    def panda_pal_session
+      @panda_pal_session ||= @controller.current_session&.data || {}
+    end
+
+    def rails_session
+      @rails_session ||= @controller.session
+    end
+
+    def is_lti_launch?
+      panda_pal_session.present?
+    end
+
+    def launch_params
+      @launch_params ||= panda_pal_session[:launch_params] || {}
+    end
+
+    def canvas_role_labels
+      labels = launch_params['custom_canvas_role']
+      labels.is_a?(String) ? labels.split(',') : []
+    end
+
+    def lti_roles
+      @lti_roles ||= LTIRoles::RoleManager.new(launch_params['ext_roles'] || '')
+    end
+
+    def canvas_site_admin?
+      lti_roles.system_roles.include?("sys_admin")
+    end
+
+    # Middle Domain
+
+    def launch_context
+      @launch_context ||= begin
+        if launch_params['launch_type'] == "global_navigation"
+          :global
+        elsif launch_params['custom_canvas_course_id'].present?
+          ::Course.find_by(canvas_id: launch_params['custom_canvas_course_id'])
+        else
+          ::Account.find_by(canvas_id: launch_params['custom_canvas_account_id'])
+        end
+      end
+    end
+
+    def launch_account
+      @launch_account ||= launch_context.respond_to?(:account) ? launch_context.account : ::Account.find_by(canvas_id: launch_params['custom_canvas_account_id'])
+    end
+
+    # CanvasSync Domain
+
+    def canvas_permissions
+      panda_pal_session[:canvas_permissions] ||= ::Role.role_permissions(canvas_roles)
+    end
+
+    def canvas_roles
+      @canvas_roles ||= Role.for_labels(canvas_role_labels, launch_account)
+    end
+
+    def canvas_root_account_roles
+      role_labels = if "::Admin".safe_constantize && ::Admin < ::ActiveRecord::Base
+        adm_query = ::Admin.where(canvas_account_id: current_organization.canvas_account_id, workflow_state: "active")
+        adm_query.pluck(:role_name)
+      else
+        Rails.cache.fetch([self.class.name, "RootAccountAdminLinks", canvas_user_id], expires_in: 1.hour) do
+          admin_entries = canvas_sync_client.account_admins('self', user_id: [canvas_user_id])
+          admin_entries = admin_entries.select{|ent| ent[:workflow_state] == 'active' }
+          admin_entries.map{|ent| ent[:role] }
+        end
+      end
+      ::Role.for_labels(role_labels, ::Account.find_by(canvas_parent_account_id: nil))
+    end
+
+    def canvas_account_roles
+      canvas_roles.where(base_role_type: 'AccountMembership')
+    end
+
+    def canvas_course_roles
+      canvas_roles.where.not(base_role_type: 'AccountMembership')
+    end
+
+    def canvas_super_user?
+      cache_on_session(:canvas_super_user?) do
+        canvas_site_admin? || canvas_root_account_roles.map(&:label).include?("Account Admin")
+      end
+    end
+
+    def canvas_user_id
+      user.canvas_id
+    end
+
+    private
+
+    def cache_on_session(key, &blk)
+      panda_pal_session[:ability_cache] ||= {}
+      panda_pal_session[:ability_cache][key] ||= blk.call
+    end
+  end
+end

data/lib/canvas_sync/concerns/account/ancestry.rb

@@ -11,6 +11,8 @@ module CanvasSync::Concerns
       extend ActiveSupport::Concern
       include CanvasSync::Record
 
+      CanvasSync::Record.define_feature self, default: ->{ column_names.include?("ancestry") }
+
       included do
         has_ancestry
         before_save :relink_ancestry, if: :canvas_parent_account_id_changed?

data/lib/canvas_sync/concerns/role/base.rb

@@ -0,0 +1,57 @@
+module CanvasSync::Concerns
+  module Role
+    module Base
+      extend ActiveSupport::Concern
+
+      DEFAULT_ROLE_LABELS = %w[TeacherEnrollment TaEnrollment StudentEnrollment DesignerEnrollment ObserverEnrollment].freeze
+
+      CanvasSync::Record.define_feature self, default: true
+
+      class_methods do
+        def for_labels(labels, account)
+          built_ins = []
+          labels = labels.split(',') if labels.is_a?(String)
+          custom_labels = Array(labels).reject do |l|
+            if DEFAULT_ROLE_LABELS.include?(l)
+              built_ins << l
+            elsif l == 'Account Admin' || l == 'AccountAdmin'
+              built_ins << 'AccountMembership'
+            else
+              next
+            end
+            true
+          end
+
+          account_ids = Rails.cache.fetch([self.class.name, "AccountAncestry", account.canvas_id], expires_in: 6.hours) do
+            if account.respond_to?(:path_ids)
+              account.path.pluck(:canvas_id)
+            else
+              [].tap do |pids|
+                acc = account
+                loop do
+                  break unless acc
+                  pids.unshift(acc.canvas_id)
+                  acc = acc.canvas_parent
+                end
+              end
+            end
+          end
+
+          where(workflow_state: 'built_in', base_role_type: built_ins)
+            .or(where.not(workflow_state: 'built_in').where(label: custom_labels, canvas_account_id: account_ids))
+        end
+
+        def joined_permissions(roles)
+          final = {}
+          roles.each do |role|
+            role.permissions.each do |perm_name, perm|
+              final[perm_name] = false if final[perm_name].nil?
+              final[perm_name] = true if perm['enabled'] == true
+            end
+          end
+          final
+        end
+      end
+    end
+  end
+end

data/lib/canvas_sync/generators/templates/models/account.rb

@@ -5,6 +5,8 @@ class Account < ApplicationRecord
   include CanvasSync::Concerns::ApiSyncable
   # include CanvasSync::Concerns::Account::Ancestry # Add support for the ancestry Gem
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
 
   has_many :admins, primary_key: :canvas_id, foreign_key: :canvas_account_id

data/lib/canvas_sync/generators/templates/models/admin.rb

@@ -4,6 +4,8 @@ class Admin < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :account, primary_key: :canvas_id, foreign_key: :canvas_account_id, optional: true
   belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true

data/lib/canvas_sync/generators/templates/models/assignment.rb

@@ -4,6 +4,8 @@ class Assignment < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type
   belongs_to :assignment_group, optional: true, primary_key: :canvas_id, foreign_key: :canvas_assignment_group_id

data/lib/canvas_sync/generators/templates/models/assignment_group.rb

@@ -4,6 +4,8 @@ class AssignmentGroup < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true
   has_many :assignments, primary_key: :canvas_id, foreign_key: :canvas_assignment_group_id

data/lib/canvas_sync/generators/templates/models/content_migration.rb

@@ -4,6 +4,8 @@ class ContentMigration < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type
 

data/lib/canvas_sync/generators/templates/models/context_module.rb

@@ -7,6 +7,8 @@ class ContextModule < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type
   has_many :context_module_items, primary_key: :canvas_id, foreign_key: :canvas_context_module_id
   has_many :assignments, through: :context_module_items

data/lib/canvas_sync/generators/templates/models/context_module_item.rb

@@ -4,6 +4,8 @@ class ContextModuleItem < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   belongs_to :context_module, primary_key: :canvas_id, foreign_key: :canvas_context_module_id, optional: true
   belongs_to :content, polymorphic: true, optional: true, primary_key: :canvas_id, foreign_key: :canvas_content_id, foreign_type: :canvas_content_type
   belongs_to :assignment, foreign_key: :canvas_assignment_id, primary_key: :canvas_id

data/lib/canvas_sync/generators/templates/models/course.rb

@@ -4,6 +4,8 @@ class Course < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :term, foreign_key: :canvas_term_id, primary_key: :canvas_id, optional: true
   has_many :enrollments, primary_key: :canvas_id, foreign_key: :canvas_course_id

data/lib/canvas_sync/generators/templates/models/enrollment.rb

@@ -4,6 +4,8 @@ class Enrollment < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true
   belongs_to :role, primary_key: :canvas_id, foreign_key: :canvas_role_id, optional: true

data/lib/canvas_sync/generators/templates/models/grading_period.rb

@@ -3,6 +3,8 @@
 class GradingPeriod < ApplicationRecord
   include CanvasSync::Record
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :grading_period_group, primary_key: :canvas_id, foreign_key: :canvas_grading_period_group_id, optional: true
 end

data/lib/canvas_sync/generators/templates/models/grading_period_group.rb

@@ -3,5 +3,7 @@
 class GradingPeriodGroup < ApplicationRecord
   include CanvasSync::Record
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
 end

data/lib/canvas_sync/generators/templates/models/group.rb

@@ -4,6 +4,8 @@ class Group < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true
   belongs_to :account, primary_key: :canvas_id, foreign_key: :canvas_account_id, optional: true

data/lib/canvas_sync/generators/templates/models/group_membership.rb

@@ -4,6 +4,8 @@ class GroupMembership < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :group, primary_key: :canvas_id, foreign_key: :canvas_group_id
   belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id

data/lib/canvas_sync/generators/templates/models/learning_outcome.rb

@@ -6,6 +6,8 @@ class LearningOutcome < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type
 
   api_syncable({

data/lib/canvas_sync/generators/templates/models/pseudonym.rb

@@ -3,6 +3,8 @@
 class Pseudonym < ApplicationRecord
   include CanvasSync::Record
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id
 end

data/lib/canvas_sync/generators/templates/models/role.rb

@@ -4,6 +4,8 @@ class Role < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   has_many :admins, foreign_key: :canvas_role_id, primary_key: :canvas_id
 

data/lib/canvas_sync/generators/templates/models/section.rb

@@ -4,6 +4,8 @@ class Section < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true
   has_many :enrollments, primary_key: :canvas_id, foreign_key: :canvas_section_id

data/lib/canvas_sync/generators/templates/models/submission.rb

@@ -4,6 +4,8 @@ class Submission < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :assignment, primary_key: :canvas_id, foreign_key: :canvas_assignment_id, optional: true
   belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true

data/lib/canvas_sync/generators/templates/models/term.rb

@@ -4,6 +4,8 @@ class Term < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   has_many :courses, foreign_key: :canvas_term_id, primary_key: :canvas_id
   belongs_to :grading_period_group, primary_key: :canvas_id, foreign_key: :grading_period_group_id, optional: true

data/lib/canvas_sync/generators/templates/models/user.rb

@@ -4,6 +4,8 @@ class User < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   has_many :pseudonyms, primary_key: :canvas_id, foreign_key: :canvas_user_id
   has_many :enrollments, primary_key: :canvas_id, foreign_key: :canvas_user_id

data/lib/canvas_sync/generators/templates/models/user_observer.rb

@@ -4,6 +4,8 @@ class UserObserver < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
 
   belongs_to :observing_user, primary_key: :canvas_id, foreign_key: :observing_user_id, class_name: 'User', optional: true

data/lib/canvas_sync/record.rb

@@ -6,6 +6,98 @@ module CanvasSync
     extend ActiveSupport::Concern
     include CanvasSync::Concerns::SyncMapping
 
+    def self.registered_features
+      @canvas_sync_features ||= {}
+    end
+
+    def self.define_feature(modul, feature_ident = nil, models: nil, default: false, &blk)
+      feature_ident = modul.name.demodulize.underscore if feature_ident.nil?
+      if models == nil
+        pmod = _get_module_parent(modul)
+        models = pmod.name.demodulize if pmod && _get_module_parent(pmod) == CanvasSync::Concerns
+      end
+
+      @canvas_sync_features ||= {}
+      @canvas_sync_features[feature_ident] = {
+        name: feature_ident,
+        module: modul,
+        default: default,
+        models: Array.wrap(models).map(&:to_s),
+        setup: blk || ->{ include modul },
+      }
+    end
+
+    def self._get_module_parent(modul)
+      modul.respond_to?(:parent) ? modul.parent : modul.module_parent
+    end
+
+    class_methods do
+      def applicable_canvas_sync_features
+        @applicable_canvas_sync_features ||= begin
+          relev_feats = {}
+          CanvasSync::Record.registered_features.each do |k, cfg|
+            next if cfg[:models].present? && !cfg[:models].include?(self.name.demodulize)
+            relev_feats[k] = cfg
+          end
+          relev_feats
+        end
+      end
+
+      def canvas_sync_feature(feature, config = nil)
+        feat = applicable_canvas_sync_features[feature]
+
+        if !feat
+          raise "Unkown feature :#{feature} for model #{self}"
+        end
+
+        setup = feat[:setup]
+        if setup.arity != 0
+          instance_exec(config, &setup)
+        elsif config.present?
+          raise ArgumentError, "Feature #{feature} does not accept configuration"
+        else
+          instance_exec(&setup)
+        end
+      end
+
+      def canvas_sync_features(*args, skip: [], **kwargs)
+        features = {}
+
+        include_defaults = args.length == 0 || args.include?(:defaults)
+        if include_defaults
+          applicable_canvas_sync_features.each do |key, cfg|
+            next if skip.include?(key)
+
+            case cfg[:default]
+            when true
+              features[key] = {}
+            when Proc
+              features[key] = {} if instance_exec(&cfg[:default])
+            end
+          end
+        end
+
+        args.each do |a|
+          next if a == :defaults
+          features[a] ||= {}
+        end
+
+        kwargs.each do |key, opts|
+          if opts == false
+            features.delete(key)
+          elsif opts == true
+            features[key] ||= {}
+          else
+            features[key] = opts
+          end
+        end
+
+        features.each do |key, opts|
+          canvas_sync_feature(key, opts)
+        end
+      end
+    end
+
     included do
       define_model_callbacks :sync_import
     end

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.17.43".freeze
+  VERSION = "0.18.0.beta1".freeze
 end