panda_pal 4.1.0.beta2 → 5.0.0.beta.4

data/spec/models/panda_pal/organization_spec.rb

@@ -2,6 +2,35 @@ require 'rails_helper'
 
 module PandaPal
   RSpec.describe Organization, type: :model do
+
+    def set_test_settings_structure
+      PandaPal.lti_options = {
+        title: 'Test App',
+        settings_structure: YAML.load("
+          canvas:
+            is_required: true
+            data_type: Hash
+            api_token:
+              is_required: true
+              data_type: String
+            base_url:
+              is_required: true
+              data_type: String
+          reports:
+            is_required: true
+            data_type: Hash
+            active_term_allowance:
+            submissions_report_time_length:
+              is_required: true
+              data_type: ActiveSupport::Duration
+            recheck_wait:
+              data_type: ActiveSupport::Duration
+            max_recheck_time:
+              is_required: true
+        ").deep_symbolize_keys
+      }
+    end
+
     it 'creates a schema upon creation' do
       expect(Apartment::Tenant).to receive(:create)
       create :panda_pal_organization
@@ -30,5 +59,65 @@ module PandaPal
       org2 = build :panda_pal_organization, salesforce_id: 'salesforce'
       expect(org2.valid?).to be_falsey
     end
+
+    context 'settings validation' do
+      let!(:org) { create :panda_pal_organization }
+
+      it 'does not perform any validations if settings is not defined' do
+        PandaPal.lti_options = {}
+        expect_any_instance_of(PandaPal::Organization).not_to receive(:validate_level)
+        expect(org.valid?).to be_truthy
+      end
+
+      it 'does not perform any validations if options is not defined' do
+        PandaPal.lti_options = nil
+        expect_any_instance_of(PandaPal::Organization).not_to receive(:validate_level)
+        expect(org.valid?).to be_truthy
+      end
+
+      it 'does perform validations if settings_structure is defined' do
+        set_test_settings_structure
+        org.valid?
+        expect(org.valid?).to be_falsey
+      end
+
+      it 'will fail if a required setting is not present' do
+        set_test_settings_structure
+        expect(org.valid?).to be_falsey
+        errors = org.errors.messages[:settings]
+        expect(errors[0]).to eq("PandaPal::Organization.settings requires key [:canvas].  It was not found.")
+      end
+
+      it 'will fail if a setting is supplied but data_type is wrong' do
+        set_test_settings_structure
+        org.settings = {canvas: "Dog"}
+        expect(org.valid?).to be_falsey
+        errors = org.errors.messages[:settings]
+        expect(errors[0]).to eq("PandaPal::Organization.settings expected key [:canvas] to be Hash but it was instead String.")
+      end
+
+      it 'will fail if a required subsetting is missing' do
+        set_test_settings_structure
+        org.settings = {canvas: {base_url: 'http://'}, reports: {}}
+        expect(org.valid?).to be_falsey
+        errors = org.errors.messages[:settings]
+        expect(errors[0]).to eq("PandaPal::Organization.settings requires key [:canvas][:api_token].  It was not found.")
+      end
+
+      it 'will fail if extra options are specified' do
+        set_test_settings_structure
+        org.settings = {canvas: {base_url: 'http://'}, reports: {}, unknown_option: "WHAT IS THIS?"}
+        expect(org.valid?).to be_falsey
+        errors = org.errors.messages[:settings]
+        expect(errors[0]).to eq("PandaPal::Organization.settings had unexpected key: unknown_option.  If settings have expanded please update your lti_options accordingly.")
+      end
+
+      it 'will pass if all structure is maintained' do
+        set_test_settings_structure
+        org.settings = {canvas: {base_url: 'http://', api_token: 'TEST'}, reports: {submissions_report_time_length: 30.minutes, max_recheck_time: 10.hours}}
+        expect(org.valid?).to be_truthy
+      end
+
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,8 +1,4 @@
 ENV["RAILS_ENV"] ||= 'test'
-
-require 'sidekiq/testing'
-require 'sidekiq-scheduler'
-
 require File.expand_path("../dummy/config/environment.rb", __FILE__)
 require 'rspec/rails'
 require 'rspec/autorun'
@@ -44,10 +40,6 @@ RSpec.configure do |config|
       title: 'Test App',
       settings_structure: {}
     }
-
-    allow_any_instance_of(PandaPal::Organization).to receive(:switch_tenant) do |inst, &block|
-      block.call if block.present?
-    end
   end
 
 # The settings below are suggested to provide a good initial experience

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panda_pal
 version: !ruby/object:Gem::Version
-  version: 4.1.0.beta2
+  version: 5.0.0.beta.4
 platform: ruby
 authors:
 - Instructure ProServe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -114,34 +114,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 6.1.2
-- !ruby/object:Gem::Dependency
-  name: sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sidekiq-scheduler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -191,14 +163,15 @@ files:
 - app/lib/lti_xml/bridge_platform.rb
 - app/lib/lti_xml/canvas_platform.rb
 - app/models/panda_pal/organization.rb
-- app/models/panda_pal/organization/settings_validation.rb
-- app/models/panda_pal/organization/task_scheduling.rb
 - app/models/panda_pal/session.rb
 - app/views/layouts/panda_pal/application.html.erb
-- app/views/panda_pal/lti/iframe_cookie_fix.html.erb
 - app/views/panda_pal/lti/launch.html.erb
 - config/initializers/apartment.rb
 - config/routes.rb
+- db/618eef7c0380ba654ad16f867a919e72.sqlite3
+- db/9ff93d4f7e0e9dc80a43f68997caf4a1.sqlite3
+- db/a3fda4044a7215bc2c9eb01a4b9e517a.sqlite3
+- db/daa0e6378a5ec76fcce83b7070dad219.sqlite3
 - db/migrate/20160412205931_create_panda_pal_organizations.rb
 - db/migrate/20160413135653_create_panda_pal_sessions.rb
 - db/migrate/20160425130344_add_panda_pal_organization_to_session.rb
@@ -233,6 +206,7 @@ files:
 - spec/dummy/config/environments/development.rb
 - spec/dummy/config/environments/production.rb
 - spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/assets.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
 - spec/dummy/config/initializers/cookies_serializer.rb
 - spec/dummy/config/initializers/filter_parameter_logging.rb
@@ -243,15 +217,17 @@ files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
+- spec/dummy/db/development.sqlite3
 - spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/factories/panda_pal_organizations.rb
 - spec/factories/panda_pal_sessions.rb
-- spec/models/panda_pal/organization/settings_validation_spec.rb
-- spec/models/panda_pal/organization/task_scheduling_spec.rb
 - spec/models/panda_pal/organization_spec.rb
 - spec/models/panda_pal/session_spec.rb
 - spec/rails_helper.rb
@@ -275,8 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: LTI mountable engine
@@ -306,6 +281,7 @@ test_files:
 - spec/dummy/config/initializers/filter_parameter_logging.rb
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/initializers/assets.rb
 - spec/dummy/config/initializers/cookies_serializer.rb
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config.ru
@@ -315,9 +291,11 @@ test_files:
 - spec/dummy/public/500.html
 - spec/dummy/public/404.html
 - spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/db/development.sqlite3
+- spec/dummy/log/test.log
+- spec/dummy/log/development.log
 - spec/dummy/README.rdoc
-- spec/models/panda_pal/organization/settings_validation_spec.rb
-- spec/models/panda_pal/organization/task_scheduling_spec.rb
 - spec/models/panda_pal/session_spec.rb
 - spec/models/panda_pal/organization_spec.rb
 - spec/factories/panda_pal_sessions.rb

data/app/models/panda_pal/organization/settings_validation.rb

@@ -1,115 +0,0 @@
-module PandaPal
-  module OrganizationConcerns
-    module SettingsValidation
-      extend ActiveSupport::Concern
-
-      included do
-        validate :validate_settings
-      end
-
-      class_methods do
-        def settings_structure
-          if PandaPal.lti_options&.[](:settings_structure).present?
-            normalize_settings_structure(PandaPal.lti_options[:settings_structure])
-          else
-            {
-              type: Hash,
-              allow_additional: true,
-              properties: {},
-            }
-          end
-        end
-
-        def normalize_settings_structure(struc)
-          return {} unless struc.present?
-          return struc if struc[:properties] || struc[:type] || struc.key?(:required)
-
-          struc = struc.dup
-          nstruc = {}
-
-          nstruc[:type] = struc.delete(:data_type) if struc.key?(:data_type)
-          nstruc[:required] = struc.delete(:is_required) if struc.key?(:is_required)
-          nstruc[:properties] = struc.map { |k, sub| [k, normalize_settings_structure(sub)] }.to_h if struc.present?
-
-          nstruc
-        end
-      end
-
-      def settings_structure
-        self.class.settings_structure
-      end
-
-      def validate_settings
-        switch_tenant do
-          validate_settings_level(settings || {}, settings_structure).each do |err|
-            errors[:settings] << err
-          end
-        end
-      end
-
-      private
-
-      def validate_settings_level(settings, spec, path: [], errors: [])
-        human_path = "[:#{path.join('][:')}]"
-
-        if settings.nil?
-          errors << "Entry #{human_path} is required" if spec[:required]
-          return
-        end
-
-        if spec[:type]
-          resolved_type = spec[:type]
-          resolved_type = resolved_type.constantize if resolved_type.is_a?(String)
-          unless settings.is_a?(resolved_type)
-            errors << "Expected #{human_path} to be a #{spec[:type]}. Was a #{settings.class.to_s}"
-            return
-          end
-        end
-
-        if spec[:validate].present?
-          val_errors = []
-          if spec[:validate].is_a?(Symbol)
-            proc_result = send(spec[:validate], settings, spec, path: path, errors: val_errors)
-          elsif spec[:validate].is_a?(String)
-            split_val = spec[:validate].split?('.')
-            split_val << 'validate_settings' if split_val.count == 1
-            resolved_module = split_val[0].constantize
-            proc_result = resolved_module.send(split_val[1].to_sym, settings, spec, path: path, errors: val_errors)
-          elsif spec[:validate].is_a?(Proc)
-            proc_result = instance_eval do
-              spec[:validate].call(settings, spec, path: path, errors: val_errors)
-            end
-          end
-          val_errors << proc_result unless val_errors.present? || proc_result == val_errors
-          val_errors = val_errors.flatten.uniq.compact.map do |ve|
-            ve.gsub('<path>', human_path)
-          end
-          errors.concat(val_errors)
-        end
-
-        if settings.is_a?(Hash)
-          if spec[:properties] != nil
-            spec[:properties].each do |key, pspec|
-              validate_settings_level(settings[key], pspec, path: [*path, key], errors: errors)
-            end
-          end
-
-          if spec[:properties] != nil || spec[:allow_additional] != nil
-            extra_keys = settings.keys - (spec[:properties]&.keys || [])
-            if extra_keys.present?
-              if spec[:allow_additional].is_a?(Hash)
-                extra_keys.each do |key|
-                  validate_settings_level(settings[key], spec[:allow_additional], path: [*path, key], errors: errors)
-                end
-              elsif !spec[:allow_additional]
-                errors << "Did not expect #{human_path} to contain [#{extra_keys.join(', ')}]"
-              end
-            end
-          end
-        end
-
-        errors
-      end
-    end
-  end
-end

data/app/models/panda_pal/organization/task_scheduling.rb

@@ -1,164 +0,0 @@
-return unless defined?(Sidekiq.schedule)
-
-require_relative 'settings_validation'
-
-module PandaPal
-  module OrganizationConcerns
-    module TaskScheduling
-      extend ActiveSupport::Concern
-      include OrganizationConcerns::SettingsValidation
-
-      included do
-        after_commit :sync_schedule, on: [:create, :update]
-        after_commit :unschedule_tasks, on: :destroy
-      end
-
-      class_methods do
-        def _schedule_descriptors
-          @_schedule_descriptors ||= {}
-        end
-
-        def settings_structure
-          return super unless _schedule_descriptors.present?
-
-          super.tap do |struc|
-            struc[:properties] ||= {}
-
-            struc[:properties][:task_schedules] = {
-              type: 'Hash',
-              required: false,
-              properties: _schedule_descriptors.keys.reduce({}) do |hash, k|
-                hash.tap do |hash|
-                  hash[k.to_sym] = hash[k.to_s] = {
-                    required: false,
-                    validate: ->(value, *args, errors:, **kwargs) {
-                      begin
-                        Rufus::Scheduler.parse(value) if value
-                        nil
-                      rescue ArgumentError
-                        errors << "<path> must be false or a Crontab string"
-                      end
-                    }
-                  }
-                end
-              end,
-            }
-          end
-        end
-
-        def scheduled_task(cron_time, name_or_method = nil, worker: nil, queue: nil, &block)
-          task_key = (name_or_method.presence || "scheduled_task_#{caller_locations[0].lineno}").to_s
-          raise "Task key '#{task_key}' already taken!" if _schedule_descriptors.key?(task_key)
-
-          _schedule_descriptors[task_key] = {
-            key: task_key,
-            schedule: cron_time,
-            worker: worker || block || name_or_method.to_sym,
-            queue: queue || 'default',
-          }
-        end
-
-        def sync_schedules
-          # Ensure deleted Orgs are removed
-          existing_orgs = pluck(:name)
-          old_schedules = Sidekiq.get_schedule.select do |k, v|
-            m = k.match(/^org:([a-z0-9_]+)\-/i)
-            m.present? && !existing_orgs.include?(m[1])
-          end
-          old_schedules.keys.each do |k|
-            Sidekiq.remove_schedule(k)
-          end
-
-          find_each(&:sync_schedule)
-        end
-      end
-
-      def generate_schedule
-        schedule = {}
-        self.class._schedule_descriptors.values.each do |desc|
-          cron_time = schedule_task_cron_time(desc)
-          next unless cron_time.present?
-
-          schedule["org:#{name}-#{desc[:key]}"] = {
-            'cron' => cron_time,
-            'queue' => desc[:queue],
-            'class' => ScheduledTaskExecutor.to_s,
-            'args' => [name, desc[:key]],
-          }
-        end
-        schedule
-      end
-
-      def sync_schedule
-        new_schedules = generate_schedule
-        unschedule_tasks(new_schedules.keys)
-        new_schedules.each do |k, v|
-          Sidekiq.set_schedule(k, v)
-        end
-      end
-
-      private
-
-      def unschedule_tasks(new_task_keys = nil)
-        current_schedules = Sidekiq.get_schedule.select { |k,v| k.starts_with?("org:#{name}-") }
-        del_tasks = current_schedules.keys
-        del_tasks -= new_task_keys if new_task_keys
-        del_tasks.each do |k|
-          Sidekiq.remove_schedule(k)
-        end
-      end
-
-      def schedule_task_cron_time(desc)
-        cron_time = nil
-        cron_time = settings&.dig(:task_schedules, desc[:key].to_s) if cron_time.nil?
-        cron_time = settings&.dig(:task_schedules, desc[:key].to_sym) if cron_time.nil?
-        cron_time = desc[:schedule] if cron_time.nil?
-
-        return nil unless cron_time.present?
-
-        cron_time = instance_eval(&cron_time) if cron_time.is_a?(Proc)
-        if !Rufus::Scheduler.parse(cron_time).zone.present? && settings && settings[:timezone]
-          cron_time += " #{settings[:timezone]}"
-        end
-
-        cron_time
-      end
-
-      class ScheduledTaskExecutor
-        include Sidekiq::Worker
-
-        def perform(org_name, task_key)
-          org = Organization.find_by!(name: org_name)
-          task = Organization._schedule_descriptors[task_key]
-          worker = task[:worker]
-
-          Apartment::Tenant.switch(org.name) do
-            if worker.is_a?(Proc)
-              org.instance_eval(&worker)
-            elsif worker.is_a?(Symbol)
-              org.send(worker)
-            elsif worker.is_a?(String)
-              worker.constantize.perform_async
-            elsif worker.is_a?(Class)
-              worker.perform_async
-            end
-          end
-        end
-      end
-    end
-  end
-end
-
-SidekiqScheduler::Scheduler.instance.dynamic = true
-
-module SidekiqScheduler
-  module Schedule
-    original_schedule_setter = instance_method(:schedule=)
-
-    define_method :schedule= do |sched|
-      original_schedule_setter.bind(self).(sched).tap do
-        PandaPal::Organization.sync_schedules
-      end
-    end
-  end
-end