panda_pal 5.0.0.beta.2 → 5.2.0

data/lib/panda_pal/version.rb

@@ -1,3 +1,3 @@
 module PandaPal
-  VERSION = "5.0.0.beta.2"
+  VERSION = "5.2.0"
 end

data/panda_pal.gemspec

@@ -15,13 +15,17 @@ Gem::Specification.new do |s|
   s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md", "panda_pal.gemspec"]
   s.test_files = Dir["spec/**/*"]
 
-  s.add_dependency "rails", ">= 5.1.0"
+  s.add_dependency "rails", ">= 4.2"
   s.add_dependency 'pg', '>= 0.20', '< 1.0.0'
   s.add_dependency 'apartment', '~> 2.2.0'
   s.add_dependency 'ims-lti', '~> 2.2.3'
   s.add_dependency 'browser', '2.5.0'
   s.add_dependency 'attr_encrypted', '~> 3.0.0'
-  s.add_dependency 'secure_headers', '~> 6.1.2'
+  s.add_dependency 'secure_headers', '~> 6.1'
+  s.add_dependency 'json-jwt'
+
+  s.add_development_dependency 'sidekiq'
+  s.add_development_dependency 'sidekiq-scheduler'
   s.add_development_dependency 'rspec-rails'
   s.add_development_dependency 'factory_girl_rails'
 end

data/spec/dummy/config/application.rb

@@ -1,6 +1,12 @@
 require File.expand_path('../boot', __FILE__)
 
-require 'rails/all'
+require "active_model/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
 
 Bundler.require(*Rails.groups)
 require "panda_pal"

data/spec/dummy/config/environments/development.rb

@@ -22,20 +22,6 @@ Rails.application.configure do
   # Raise an error on page load if there are pending migrations.
   config.active_record.migration_error = :page_load
 
-  # Debug mode disables concatenation and preprocessing of assets.
-  # This option may cause significant delays in view rendering with a large
-  # number of complex assets.
-  config.assets.debug = true
-
-  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
-  # yet still be able to expire them through the digest params.
-  config.assets.digest = true
-
-  # Adds additional error checking when serving assets at runtime.
-  # Checks for improperly declared sprockets dependencies.
-  # Raises helpful error messages.
-  config.assets.raise_runtime_errors = true
-
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
 end

data/spec/dummy/config/environments/production.rb

@@ -24,17 +24,6 @@ Rails.application.configure do
   # Apache or NGINX already handles this.
   config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
 
-  # Compress JavaScripts and CSS.
-  config.assets.js_compressor = :uglifier
-  # config.assets.css_compressor = :sass
-
-  # Do not fallback to assets pipeline if a precompiled asset is missed.
-  config.assets.compile = false
-
-  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
-  # yet still be able to expire them through the digest params.
-  config.assets.digest = true
-
   # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
 
   # Specifies the header that your server uses for sending files.

data/spec/models/panda_pal/organization/settings_validation_spec.rb

@@ -0,0 +1,175 @@
+require 'rails_helper'
+
+module PandaPal
+  PandaPal::Organization
+  RSpec.describe OrganizationConcerns::SettingsValidation, type: :model do
+    let!(:org) { create :panda_pal_organization }
+
+    def set_test_settings_structure
+      PandaPal.lti_options = {
+        title: 'Test App',
+        settings_structure: structure,
+      }
+    end
+
+    RSpec.shared_examples "shared stuff" do
+      it 'does not perform any validations if settings is not defined' do
+        PandaPal.lti_options = {}
+        expect(org.valid?).to be_truthy
+      end
+
+      it 'does not perform any validations if options is not defined' do
+        PandaPal.lti_options = nil
+        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("Entry [:canvas] is required")
+      end
+
+      it 'will fail if a setting is supplied but data_type is wrong' do
+        set_test_settings_structure
+        org.settings = {canvas: "Dog", reports: {}}
+        expect(org.valid?).to be_falsey
+        errors = org.errors.messages[:settings]
+        expect(errors[0]).to eq("Expected [:canvas] to be a Hash. Was a 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("Entry [:canvas][:api_token] is required")
+      end
+
+      it 'will fail if extra options are specified' do
+        set_test_settings_structure
+        org.settings = {canvas: {base_url: 'http://', api_token: 'TEST'}, reports: {}, unknown_option: "WHAT IS THIS?"}
+        expect(org.valid?).to be_falsey
+        errors = org.errors.messages[:settings]
+        expect(errors[0]).to eq("Did not expect [:] to contain [unknown_option]")
+      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
+
+    context 'new settings_structure' do
+      let!(:properties) do
+        {
+          canvas: {
+            required: true,
+            type: 'Hash',
+            properties: {
+              api_token: { type: 'String', required: true },
+              base_url: { type: 'String', required: true },
+            },
+          },
+          reports: {
+            required: true,
+            type: 'Hash',
+            allow_additional: true,
+          }
+        }
+      end
+
+      let!(:structure) do
+        {
+          properties: properties,
+        }
+      end
+
+      it_behaves_like("shared stuff")
+
+      describe ':allow_additional' do
+        it 'passes extra properties if allow_additional is a matching Hash' do
+          structure[:allow_additional] = { type: 'String' }
+          set_test_settings_structure
+          org.settings = {canvas: {base_url: 'http://', api_token: 'TEST'}, reports: {}, unknown_option: "WHAT IS THIS?"}
+          expect(org).to be_valid
+        end
+
+        it 'fails extra properties if allow_additional is an unmatching Hash' do
+          structure[:allow_additional] = { type: 'Hash' }
+          set_test_settings_structure
+          org.settings = {canvas: {base_url: 'http://', api_token: 'TEST'}, reports: {}, unknown_option: "WHAT IS THIS?"}
+          expect(org).not_to be_valid
+        end
+
+        it 'passes extra properties if allow_additional is a blank Hash' do
+          structure[:allow_additional] = { }
+          set_test_settings_structure
+          org.settings = {canvas: {base_url: 'http://', api_token: 'TEST'}, reports: {}, unknown_option: "WHAT IS THIS?"}
+          expect(org).to be_valid
+        end
+      end
+
+      describe ':validate' do
+        let!(:properties) do
+          {
+            blah: {
+              type: 'String',
+              validate: -> (v, *args) { v == 'blah' ? nil : '<path> failed validation' },
+            }
+          }
+        end
+
+        it 'supports a custom validation proc' do
+          set_test_settings_structure
+          org.settings = { blah: 'blah' }
+          expect(org).to be_valid
+        end
+
+        it 'replaces <path> with the human readable path' do
+          set_test_settings_structure
+          org.settings = { blah: '' }
+          expect(org.valid?).to be_falsey
+          errors = org.errors.messages[:settings]
+          expect(errors[0]).to eq("[:blah] failed validation")
+        end
+      end
+    end
+
+    context 'old settings_structure' do
+      let!(:structure) do
+        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: false
+              data_type: ActiveSupport::Duration
+            recheck_wait:
+              data_type: ActiveSupport::Duration
+            max_recheck_time:
+              is_required: false
+        ").deep_symbolize_keys
+      end
+
+      it_behaves_like("shared stuff")
+    end
+  end
+end

data/spec/models/panda_pal/organization/task_scheduling_spec.rb

@@ -0,0 +1,144 @@
+require 'rails_helper'
+
+module PandaPal
+  PandaPal::Organization
+
+  RSpec.describe OrganizationConcerns::TaskScheduling, type: :model do
+    let!(:organization) { create(:panda_pal_organization) }
+    let(:schedules) { {} }
+
+    before :each do
+      Organization.instance_variable_set(:@_schedule_descriptors, nil)
+      Organization.scheduled_task('0 0 0 * * *', :ident) { }
+
+      allow(Sidekiq).to receive(:remove_schedule)
+      allow(Sidekiq).to receive(:get_schedule) { schedules }
+    end
+
+    def descriptors
+      Organization.instance_variable_get(:@_schedule_descriptors)
+    end
+
+    def descriptor
+      descriptors[descriptors.keys[0]]
+    end
+
+    describe '.scheduled_task' do
+      it 'adds to the set of descriptors' do
+        expect(descriptors).to match(
+          'ident' => {
+            :key=>"ident",
+            :schedule=>"0 0 0 * * *",
+            :worker=>Proc,
+            :queue=>"default",
+          }
+        )
+      end
+    end
+
+    describe '.sync_schedules' do
+      it 'adds new schedules' do
+        expect(Sidekiq).to receive(:set_schedule).with(/org:\w+-ident/, anything)
+        Organization.sync_schedules
+      end
+
+      it 'removes schedules for deleted Orgs' do
+        schedules['org:deleted_org-schedule'] = {}
+        expect(Sidekiq).to receive(:remove_schedule).with('org:deleted_org-schedule')
+        Organization.sync_schedules
+      end
+
+      it 'keeps schedules created from other sources' do
+        schedules['other-schedule'] = {}
+        expect(Sidekiq).not_to receive(:remove_schedule).with('other-schedule')
+        Organization.sync_schedules
+      end
+    end
+
+    describe '#generate_schedule' do
+      it 'generates the expected schedule' do
+        expect(organization.generate_schedule).to eq({
+          "org:#{organization.name}-ident" => {
+            "cron"=>"0 0 0 * * *",
+            "queue"=>"default",
+            "class"=>"PandaPal::OrganizationConcerns::TaskScheduling::ScheduledTaskExecutor",
+            "args"=>[organization.name, "ident"],
+          }
+        })
+      end
+    end
+
+    describe '#schedule_task_cron_time' do
+      before :each do
+        organization.settings = { timezone: 'America/Denver' }
+      end
+
+      it 'includes timezone if in settings' do
+        expect(organization.send(:schedule_task_cron_time, descriptor)).to eq '0 0 0 * * * America/Denver'
+      end
+
+      it 'does not re-append timezone if already present' do
+        descriptor[:schedule] = '1 1 1 * * * America/Chicago'
+        expect(organization.send(:schedule_task_cron_time, descriptor)).to eq '1 1 1 * * * America/Chicago'
+      end
+    end
+
+    describe '#sync_schedule' do
+      it 'adds new schedules' do
+        expect(Sidekiq).to receive(:set_schedule).with(/org:\w+-ident/, anything)
+        organization.sync_schedule
+      end
+
+      it 'removes old jobs' do
+        schedules["org:#{organization.name}-old_schedule"] = {}
+        expect(Sidekiq).to receive(:remove_schedule).with("org:#{organization.name}-old_schedule")
+        organization.sync_schedule
+      end
+    end
+
+    describe 'SettingsValidation' do
+      before :each do
+        organization.settings = {}
+      end
+
+      it 'passes a valid timezone' do
+        organization.settings[:timezone] = 'America/Denver'
+        expect(organization).to be_valid
+      end
+
+      it 'fails an invalid timezone' do
+        organization.settings[:timezone] = 'Timezone/Blorg'
+        expect(organization).not_to be_valid
+      end
+
+      it 'allows [:task_schedules] entry to be missing' do
+        expect(organization).to be_valid
+      end
+
+      it 'does not require [:task_schedules] sub-entries' do
+        organization.settings[:task_schedules] = {}
+        expect(organization).to be_valid
+      end
+
+      it 'allows task entry to be false' do
+        organization.settings[:task_schedules] = { ident: false }
+        expect(organization).to be_valid
+      end
+
+      it 'allows task entry to be a valid cron string' do
+        organization.settings[:task_schedules] = { ident: '0 0 0 * * * America/Denver' }
+        expect(organization).to be_valid
+      end
+
+      it 'does not allow task entry to be an invalid cron string' do
+        organization.settings[:task_schedules] = { ident: 'blort' }
+        expect(organization).not_to be_valid
+      end
+
+      it 'does not allow sub-entries for unknown tasks' do
+        organization.settings[:task_schedules] = { missing_ident: '0 0 0 * * * America/Denver' }
+        expect(organization).not_to be_valid
+      end
+    end
+  end
+end

data/spec/models/panda_pal/organization_spec.rb

@@ -2,35 +2,6 @@ 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
@@ -59,65 +30,5 @@ 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