panda_pal 3.0.1 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d38f3ee39fd2a646758d9c6e47e9c0fdb496ed5
-  data.tar.gz: d15a3f38b606c3705ee397e1e8ff7446c518006b
+  metadata.gz: 142d69b7f513a07ebace023bd229a780b099f17d
+  data.tar.gz: 60bd6a9784c2e2a9265b2e7c6582759560892c66
 SHA512:
-  metadata.gz: c0524f269d6725c879f19bb6b304f8e83fe94d551935b7e6d7b424e8f1aac2dd1b2022ee06607d73180f6017f43a9c55dfa160f8c77613e97d06062d1bd9be57
-  data.tar.gz: 7d8437a68bdb6611df7375b1f4a2fd8e7e17eb03075bf4af379fb7222293e7d9ffd7195525aa38ccde8fdab9032348b6bbdb1d65743594f98d7b59a520c9a3e2
+  metadata.gz: c95b68006a09db2e5cb559bc653f93219d6fc3f2aff350e5c2daa942a2d85c6a4490c1a10020cd0b8b8901f91ce3d299977d9334b677014c8c1c5bda14389083
+  data.tar.gz: d7ddd1733b129b550d69b736f9201115e0667f06cb1b8e116115b890e108963597fecb05d9b962fe2926e030e4557682cdd49b09d4106bfd4239d66b90bdedab

data/Rakefile

@@ -14,7 +14,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
 

data/app/models/panda_pal/organization.rb

@@ -1,4 +1,5 @@
 module PandaPal
+
   class Organization < ActiveRecord::Base
     attribute :settings
     attr_encrypted :settings, marshal: true, key: :encryption_key
@@ -8,7 +9,7 @@ module PandaPal
     validates :name, uniqueness: { case_sensitive: false }, presence: true, format: { with: /\A[a-z0-9_]+\z/i }
     validates :canvas_account_id, presence: true
     validates :salesforce_id, presence: true, uniqueness: true
-
+    validate :validate_settings
     after_create :create_schema
     after_commit :destroy_schema, on: :destroy
 
@@ -37,5 +38,48 @@ module PandaPal
     def destroy_schema
       Apartment::Tenant.drop name
     end
+
+    def validate_settings
+      record = self
+      if PandaPal.lti_options && PandaPal.lti_options[:settings_structure]
+        validate_level(record, PandaPal.lti_options[:settings_structure], record.settings, [])
+      end
+    end
+    def validate_level(record, expectation, reality, previous_keys)
+      # Verify that the data elements at this level conform to requirements.
+      if expectation
+        expectation.each do |key, value|
+          is_required = expectation[key].try(:delete, :is_required)
+          data_type = expectation[key].try(:delete, :data_type)
+          value = reality.is_a?(Hash) ? reality.dig(key) : reality
+
+          if is_required && !value
+            record.errors[:settings] << "PandaPal::Organization.settings requires key [:#{previous_keys.push(key).join("][:")}].  It was not found."
+          end
+          if data_type && value
+            if value.class.to_s != data_type
+              record.errors[:settings] << "PandaPal::Organization.settings expected key [:#{previous_keys.push(key).join("][:")}] to be #{data_type} but it was instead #{value.class}."
+            end
+          end
+        end
+      end
+      # Verify that anything that is in the real settings has an expectation.
+      if reality
+        if reality.is_a? Hash
+          reality.each do |key, value|
+            was_expected = expectation.has_key?(key)
+            if !was_expected
+              record.errors[:settings] << "PandaPal::Organization.settings had unexpected key: #{key}.  If settings have expanded please update your lti_options accordingly."
+            end
+          end
+        end
+      end
+      # Recursively check out any children settings as well.
+      if expectation
+        expectation.each do |key, value|
+          validate_level(record, expectation[key], (reality.is_a?(Hash) ? reality.dig(key) : nil), previous_keys.deep_dup.push(key))
+        end
+      end
+    end
   end
 end

data/db/migrate/30171205194657_remove_old_organization_settings.rb

@@ -1,4 +1,8 @@
 class RemoveOldOrganizationSettings < ActiveRecord::Migration[5.1]
+  def current_tenant
+    @current_tenant ||= PandaPal::Organization.find_by_name(Apartment::Tenant.current)
+  end
+
   def up
     # migrations run for public and local tenants.  However, PandaPal::Organization
     # is going to always go to public tenant.  So don't do this active record

data/lib/panda_pal/version.rb

@@ -1,3 +1,3 @@
 module PandaPal
-  VERSION = "3.0.1"
+  VERSION = "3.0.3"
 end

data/panda_pal.gemspec

@@ -21,8 +21,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'ims-lti', '~> 2.1.0'
   s.add_dependency 'browser', '2.5.0'
   s.add_dependency 'attr_encrypted', '~> 3.0.0'
-
   s.add_development_dependency 'rspec-rails'
   s.add_development_dependency 'factory_girl_rails'
-  s.add_development_dependency 'test_after_commit'
 end

data/spec/dummy/config/application.rb

@@ -19,8 +19,5 @@ module Dummy
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
 
-    # Do not swallow errors in after_commit/after_rollback callbacks.
-    config.active_record.raise_in_transactional_callbacks = true
   end
 end
-

data/spec/dummy/config/database.yml

@@ -5,20 +5,20 @@
 #   gem 'sqlite3'
 #
 default: &default
-  adapter: sqlite3
+  adapter: postgresql
   pool: 5
   timeout: 5000
 
 development:
   <<: *default
-  database: db/development.sqlite3
+  database: panda_pal_development
 
 # Warning: The database defined as "test" will be erased and
 # re-generated from your development database when you run "rake".
 # Do not set this db to the same as development or production.
 test:
   <<: *default
-  database: db/test.sqlite3
+  database: panda_pal_test
 
 production:
   <<: *default

data/spec/dummy/db/schema.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
@@ -11,45 +10,30 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20160415162154) do
-
-  create_table "delayed_jobs", force: :cascade do |t|
-    t.integer  "priority",   default: 0, null: false
-    t.integer  "attempts",   default: 0, null: false
-    t.text     "handler",                null: false
-    t.text     "last_error"
-    t.datetime "run_at"
-    t.datetime "locked_at"
-    t.datetime "failed_at"
-    t.string   "locked_by"
-    t.string   "queue"
-    t.string   "tenant"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-
-  add_index "delayed_jobs", ["priority", "run_at"], name: "delayed_jobs_priority"
+ActiveRecord::Schema.define(version: 30171205194657) do
 
   create_table "panda_pal_organizations", force: :cascade do |t|
-    t.string   "name"
-    t.string   "key"
-    t.string   "secret"
-    t.string   "canvas_account_id"
-    t.text     "settings"
-    t.datetime "created_at",        null: false
-    t.datetime "updated_at",        null: false
+    t.string "name"
+    t.string "key"
+    t.string "secret"
+    t.string "canvas_account_id"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.string "salesforce_id"
+    t.text "encrypted_settings"
+    t.string "encrypted_settings_iv"
+    t.index ["key"], name: "index_panda_pal_organizations_on_key", unique: true
+    t.index ["name"], name: "index_panda_pal_organizations_on_name", unique: true
   end
 
-  add_index "panda_pal_organizations", ["key"], name: "index_panda_pal_organizations_on_key", unique: true
-  add_index "panda_pal_organizations", ["name"], name: "index_panda_pal_organizations_on_name", unique: true
-
   create_table "panda_pal_sessions", force: :cascade do |t|
-    t.string   "session_key"
-    t.text     "data"
-    t.datetime "created_at",  null: false
-    t.datetime "updated_at",  null: false
+    t.string "session_key"
+    t.text "data"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.integer "panda_pal_organization_id"
+    t.index ["panda_pal_organization_id"], name: "index_panda_pal_sessions_on_panda_pal_organization_id"
+    t.index ["session_key"], name: "index_panda_pal_sessions_on_session_key", unique: true
   end
 
-  add_index "panda_pal_sessions", ["session_key"], name: "index_panda_pal_sessions_on_session_key", unique: true
-
 end

data/spec/models/panda_pal/organization_spec.rb

@@ -3,18 +3,44 @@ 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
     end
 
     it 'deletes a schema upon deletion' do
-      TestAfterCommit.with_commits(true) do
-        expect(Apartment::Tenant).to receive(:create)
-        expect(Apartment::Tenant).to receive(:drop)
-        org = create :panda_pal_organization
-        org.destroy
-      end
+      expect(Apartment::Tenant).to receive(:create)
+      expect(Apartment::Tenant).to receive(:drop)
+      org = create :panda_pal_organization
+      org.destroy
     end
 
     it 'does not allow the name to be changed after creation' do
@@ -33,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

@@ -3,13 +3,17 @@ require File.expand_path("../dummy/config/environment.rb", __FILE__)
 require 'rspec/rails'
 require 'rspec/autorun'
 require 'nokogiri'
-require 'delayed_job_active_record'
 require 'factory_girl_rails'
-require 'test_after_commit'
 
-Delayed::Worker.delay_jobs = false
+ActiveRecord::Migration.maintain_test_schema!
+ActiveRecord::Schema.verbose = false
+load 'dummy/db/schema.rb' # db agnostic
+
 RSpec.configure do |config|
   config.include FactoryGirl::Syntax::Methods
+  FactoryGirl.definition_file_paths = [File.expand_path('../factories', __FILE__)]
+  FactoryGirl.find_definitions
+
   # rspec-expectations config goes here. You can use an alternate
   # assertion/expectation library such as wrong or the stdlib/minitest
   # assertions if you prefer.
@@ -33,6 +37,13 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
+  config.before(:each) do
+    PandaPal.lti_options = {
+      title: 'Test App',
+      settings_structure: {}
+    }
+  end
+
 # The settings below are suggested to provide a good initial experience
 # with RSpec, but feel free to customize to your heart's content.
 =begin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panda_pal
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.3
 platform: ruby
 authors:
 - Ben Young
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2018-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -123,20 +123,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: test_after_commit
-  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'
 description: 
 email:
 - byoung@instructure.com
@@ -206,9 +192,6 @@ files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
-- spec/dummy/db/migrate/20160415162152_create_panda_pal_organizations.panda_pal.rb
-- spec/dummy/db/migrate/20160415162153_create_delayed_jobs.panda_pal.rb
-- spec/dummy/db/migrate/20160415162154_create_panda_pal_sessions.panda_pal.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -240,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: LTI mountable engine
@@ -273,9 +256,6 @@ test_files:
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
 - spec/dummy/config.ru
-- spec/dummy/db/migrate/20160415162152_create_panda_pal_organizations.panda_pal.rb
-- spec/dummy/db/migrate/20160415162153_create_delayed_jobs.panda_pal.rb
-- spec/dummy/db/migrate/20160415162154_create_panda_pal_sessions.panda_pal.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -289,3 +269,4 @@ test_files:
 - spec/models/panda_pal/session_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/spec/dummy/db/migrate/20160415162152_create_panda_pal_organizations.panda_pal.rb

@@ -1,16 +0,0 @@
-# This migration comes from panda_pal (originally 20160412205931)
-class CreatePandaPalOrganizations < ActiveRecord::Migration
-  def change
-    create_table :panda_pal_organizations do |t|
-      t.string :name
-      t.string :key
-      t.string :secret
-      t.string :canvas_account_id
-      t.text :settings
-
-      t.timestamps null: false
-    end
-    add_index :panda_pal_organizations, :name, unique: true
-    add_index :panda_pal_organizations, :key, unique: true
-  end
-end

data/spec/dummy/db/migrate/20160415162153_create_delayed_jobs.panda_pal.rb

@@ -1,24 +0,0 @@
-# This migration comes from panda_pal (originally 20160413132229)
-class CreateDelayedJobs < ActiveRecord::Migration
-  def self.up
-    create_table :delayed_jobs, force: true do |table|
-      table.integer :priority, default: 0, null: false # Allows some jobs to jump to the front of the queue
-      table.integer :attempts, default: 0, null: false # Provides for retries, but still fail eventually.
-      table.text :handler,                 null: false # YAML-encoded string of the object that will do work
-      table.text :last_error                           # reason for last failure (See Note below)
-      table.datetime :run_at                           # When to run. Could be Time.zone.now for immediately, or sometime in the future.
-      table.datetime :locked_at                        # Set when a client is working on this object
-      table.datetime :failed_at                        # Set when all retries have failed (actually, by default, the record is deleted instead)
-      table.string :locked_by                          # Who is working on this object (if locked)
-      table.string :queue                              # The name of the queue this job is in
-      table.string :tenant
-      table.timestamps null: true
-    end
-
-    add_index :delayed_jobs, [:priority, :run_at], name: "delayed_jobs_priority"
-  end
-
-  def self.down
-    drop_table :delayed_jobs
-  end
-end

data/spec/dummy/db/migrate/20160415162154_create_panda_pal_sessions.panda_pal.rb

@@ -1,12 +0,0 @@
-# This migration comes from panda_pal (originally 20160413135653)
-class CreatePandaPalSessions < ActiveRecord::Migration
-  def change
-    create_table :panda_pal_sessions do |t|
-      t.string :session_key
-      t.text :data
-
-      t.timestamps null: false
-    end
-    add_index :panda_pal_sessions, :session_key, unique: true
-  end
-end