panda_pal 5.6.12 → 5.7.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29034766a62fed97c43d0e3ef2754e1f04a4d925b8a467bd78dda5a2f5d87f1e
-  data.tar.gz: d4c3c29aa255a8311bbe00d1dbe0358f247425fa8ed1f7eddfca1ec7315897d5
+  metadata.gz: c17abc690e56e5bedffa292170eee88041e9d3214200a9bcf75571fc18b10a69
+  data.tar.gz: 40c41edfe6b016d6f9c8db8316fa44f1d7c9e7cff03ab9eb88fda74e6d695712
 SHA512:
-  metadata.gz: e4ca709472f506cb84cfc9020b254e3ddafdf756f6dd83325f314910914878adfc1ea3363c8bca938f3933a27852205ccb9e1832df7a67a501bc442d4e3e3b80
-  data.tar.gz: 72fe59902312a2da78350ab1a095808e8c1e902ca02e208474413fa06989f6bbb0f8c1174e929555b501674754b21f4ebdbfce7d73404f7ffe0d27595b7546ad
+  metadata.gz: 48ea51186371b9941434937ed23cfcf8b44f0726fd8d89cf280e7e65edc132702ccaec6e98917194c0c29d320f77f1218287906d9a3489b4efcf8fc8546d0332
+  data.tar.gz: 2005bc3182ffdf509da90ae5e29363a6bc79964e71a558386fb8c9ab0de8bf16a33f071ea0e40d7ab44bf5c9eb1f74549491b37eb12010bf6d0820b1acffe4eb

data/README.md

@@ -29,7 +29,7 @@ org.install_lti(
   context: "account/self", # (Optional) Or "account/3", "course/1", etc
   exists: :error, # (Optional) Action to take if an LTI with the same Key already exists. Options are :error, :replace, :duplicate
   version: "v1p3", # (Optional, default `v1p3`) LTI Version. Accepts `v1p0` or `v1p3`.
-  dedicated_deployment: false, # (Optional) If true, the Organization will be updated to link to a single deployment rather then to the general LTI Key. (experimental)
+  dedicated_deployment: false, # (Optional) If true, the Organization will be updated to link to a single deployment rather then to the general LTI Key. (experimental, LTI 1.3 only)
 )
 ```
 

data/app/models/panda_pal/api_call.rb

@@ -1,7 +1,7 @@
 require 'jwt'
 
 module PandaPal
-  class ApiCall < ActiveRecord::Base
+  class ApiCall < PandaPalRecord
     # TODO Add Rate Limiting?
 
     def self.decode_jwt(jwt)

data/app/models/panda_pal/organization.rb

@@ -1,7 +1,7 @@
 module PandaPal
   module OrganizationConcerns; end
 
-  # Nwer versions of SymmetricEncryption introduced it's own version of attr_encrypted
+  # Newer versions of SymmetricEncryption introduced it's own version of attr_encrypted
   # that is completely incompatible with the attr_encrypted Gem that PandaPal uses.
   if defined?(::SymmetricEncryption::ActiveRecord::AttrEncrypted)
     module SkipSymmetricEncAttrEncrypted
@@ -21,16 +21,34 @@ module PandaPal
     end
   end
 
-  class Organization < ActiveRecord::Base
+  class SettingsMarshaler
+    def self.load(data)
+      return nil unless data.present?
+      loaded = Marshal.load(data)
+      loaded = loaded.with_indifferent_access if loaded.is_a?(Hash) && !loaded.is_a?(HashWithIndifferentAccess)
+      loaded
+    end
+
+    def self.dump(obj)
+      Marshal.dump(obj)
+    end
+  end
+
+  class Organization < PandaPalRecord
     include SkipSymmetricEncAttrEncrypted if defined?(SkipSymmetricEncAttrEncrypted)
 
     include OrganizationConcerns::SettingsValidation
     include OrganizationConcerns::TaskScheduling if defined?(Sidekiq.schedule)
 
-    serialize :settings, Hash
-    attr_encrypted :settings, marshal: true, key: :encryption_key
+    attr_encrypted :settings, marshal: true, key: :encryption_key, marshaler: SettingsMarshaler
     before_save {|a| a.settings = a.settings} # this is a hacky work-around to a bug where attr_encrypted is not saving settings in place
 
+    alias_method "settings_panda_pal_super=", "settings="
+    def settings=(settings)
+      settings = settings.with_indifferent_access if settings.is_a?(Hash) && !settings.is_a?(HashWithIndifferentAccess)
+      self.settings_panda_pal_super = settings
+    end
+
     validates :key, uniqueness: { case_sensitive: false }, presence: true
     validates :secret, presence: true
     validates :name, uniqueness: { case_sensitive: false }, presence: true, format: { with: /\A[a-z0-9_]+\z/i }
@@ -84,10 +102,6 @@ module PandaPal
       end
     end
 
-    def self.resolve_platform(hint)
-      iss = hint["iss"]
-    end
-
     def rename!(new_name)
       do_switch = Apartment::Tenant.current == name
       ActiveRecord::Base.connection.execute(
@@ -98,23 +112,56 @@ module PandaPal
       switch_tenant if do_switch
     end
 
-    def platform_extensions(platform_type)
-      return self unless defined?(platform_type::OrgExtension)
-      return self if self.class < platform_type::OrgExtension
-
-      scl = platform_type.org_subclass
-      scl ? becomes(scl) : self
+    if !PandaPal.lti_options[:platform].present? || PandaPal.lti_options[:platform].is_a?(String)
+      CONST_PLATFORM_TYPE = Platform.resolve_platform_class(nil) rescue nil
+    else
+      CONST_PLATFORM_TYPE = nil
     end
 
-    if !PandaPal.lti_options[:platform].present? || PandaPal.lti_options[:platform].is_a?(String)
-      platform_cls = Platform.resolve_platform_class(nil) rescue nil
-      if platform_cls && defined?(platform_cls::OrgExtension)
-        include platform_cls::OrgExtension
+    # Include the Platform API...
+    if CONST_PLATFORM_TYPE
+      # ... directly if this is a single-platform tool
+      include CONST_PLATFORM_TYPE::OrgExtension if defined?(CONST_PLATFORM_TYPE::OrgExtension)
+    else
+      # ... via method_missing/delegation if this is a multi-platform tool
+      def respond_to_missing?(name, include_private = false)
+        if (self.class == PandaPal::Organization) && (plat_api = platform_api).present?
+          plat_api.respond_to?(name, include_private)
+        else
+          super
+        end
+      end
+
+      def method_missing(method, *args, **kwargs, &block)
+        if (self.class == PandaPal::Organization) && (plat_api = platform_api).present?
+          plat_api.send(method, *args, **kwargs, &block)
+        else
+          super
+        end
       end
     end
 
-    PandaPal.resolved_extensions_for(self).each do |ext|
-      include ext
+    # Extend a particular type of Platform API.
+    def self.extend_platform_api(platform_type = CONST_PLATFORM_TYPE, &blk)
+      scl = platform_type.organization_api
+      scl.class_eval(&blk)
+    end
+
+    # Retrieve the specified Platform API for this Organization.
+    # If only a single Platform is used (when lti_options[:platform] is a constant string or nil), passing the platform_type is unnecessary
+    #
+    # The API is currently an Organization subclass (using `becomes()`), but such may change.
+    def platform_api(platform_type = primary_platform)
+      scl = platform_type.organization_api
+      return self if scl == self.class
+      becomes(scl)
+    end
+
+    protected
+
+    # OrgExtension-Overridable method to allow multi-platform tool Orgs to implicitly include a Platform API
+    def primary_platform
+      CONST_PLATFORM_TYPE
     end
 
     private
@@ -126,5 +173,11 @@ module PandaPal
     def destroy_schema
       Apartment::Tenant.drop name
     end
+
+    public
+
+    PandaPal.resolved_extensions_for(self).each do |ext|
+      include ext
+    end
   end
 end

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

@@ -155,7 +155,12 @@ module PandaPal
           end
 
           if spec[:properties] != nil || spec[:allow_additional] != nil
-            extra_keys = settings.keys - (spec[:properties]&.keys || [])
+            set_keys = settings.keys
+            expected_keys = spec[:properties]&.keys || []
+            expected_keys = expected_keys.map(&:to_s) if settings.is_a?(HashWithIndifferentAccess)
+
+            extra_keys = set_keys - expected_keys
+
             if extra_keys.present?
               if spec[:allow_additional].is_a?(Hash)
                 extra_keys.each do |key|

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

@@ -42,7 +42,7 @@ module PandaPal
 
               hash.tap do |hash|
                 kl = ' ' * (k.to_s.length - 4)
-                hash[k.to_sym] = hash[k.to_s] = PandaPal::OrganizationConcerns::TaskScheduling.build_settings_entry(desc)
+                hash[k.to_sym] = PandaPal::OrganizationConcerns::TaskScheduling.build_settings_entry(desc)
               end
             end,
           }

data/app/models/panda_pal/panda_pal_record.rb

@@ -0,0 +1,5 @@
+module PandaPal
+  class PandaPalRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/panda_pal/platform/canvas.rb

@@ -44,13 +44,11 @@ module PandaPal
       def install_lti(host: nil, context: :root_account, version: 'v1p3', exists: :error, dedicated_deployment: false)
         raise "Automatically installing this LTI requires Bearcat." unless defined?(Bearcat)
 
-        version = version.to_s
-
         run_callbacks :lti_install do
           ctype, cid = _parse_lti_context(context)
 
           if version == 'v1p0'
-            existing_installs = _find_existing_installs(context, exists: exists) do |lti|
+            existing_installs = _find_existing_installs(exists: exists) do |lti|
               lti[:consumer_key] == self.key
             end
 
@@ -112,9 +110,6 @@ module PandaPal
         end
 
         ekey = existing_keys[0]
-        # if ekey && exists == :error
-        #   raise "Tool with key #{self.key} already installed"
-        # end
 
         lti_json_url = PandaPal::LaunchUrlHelpers.resolve_route(:v1p3_config_url, host: host)
         lti_json = JSON.parse(HTTParty.get(lti_json_url, format: :plain).body)
@@ -268,6 +263,7 @@ module PandaPal
 
       if defined?(Bearcat)
         def bearcat_client
+          # Less than ideal, but `canvas_sync_client` has been the long-adopted tradition so we check for it so that we can continue to drop-in new versions of PandaPal
           return canvas_sync_client if defined?(canvas_sync_client)
 
           Bearcat::Client.new(

data/app/models/panda_pal/platform.rb

@@ -72,11 +72,13 @@ module PandaPal
       raise "Unknown platform '#{platform}'"
     end
 
-    def self.org_subclass
-      return nil unless defined?(self::OrgExtension)
+    def self.organization_api
+      return PandaPal::Organization unless defined?(self::OrgExtension)
+      return PandaPal::Organization if PandaPal::Organization < self::OrgExtension
+
       oext = self::OrgExtension
 
-      @org_subclass ||= Class.new(PandaPal::Organization) do
+      @organization_api ||= self::OrganizationApi ||= Class.new(PandaPal::Organization) do
         include oext
       end
     end

data/app/models/panda_pal/session.rb

@@ -1,5 +1,5 @@
 module PandaPal
-  class Session < ActiveRecord::Base
+  class Session < PandaPalRecord
     belongs_to :panda_pal_organization, class_name: 'PandaPal::Organization', optional: true
 
     after_initialize do

data/lib/panda_pal/engine.rb

@@ -69,41 +69,105 @@ module PandaPal
       end
     end
 
-    initializer "panda_pal.autoswitch" do |app|
+    initializer "panda_pal.prompts" do |app|
       class ::Object
-        def _panda_pal_console_autoswitch_tenant
-          org = nil
-          if Rails.env.development?
-            org = PandaPal::Organization.find_by(name: 'local') || PandaPal::Organization.first
-          elsif PandaPal::Organization.count == 1
-            org = PandaPal::Organization.first
+        def _panda_pal_console_app_name
+          app_class = Rails.application.class
+          app_name = app_class.respond_to?(:parent) ? app_class.parent : app_class.module_parent
+        end
+      end
+
+      if defined? IRB
+        module PandaPalIrbTimePrompt
+          def prompt(prompt, ltype, indent, line_no)
+            formatted = super(prompt, ltype, indent, line_no)
+            app_bit = Pry::Helpers::Text.cyan("#{_panda_pal_console_app_name}-#{Apartment::Tenant.current}")
+            "[#{app_bit}] #{formatted}"
           end
+        end
 
-          if org
-            org.switch_tenant
-            puts "PandaPal: Auto Switched to tenant '#{org.name}'"
+        module ::IRB
+          class Irb
+            prepend PandaPalIrbTimePrompt
           end
-        rescue => err
-          puts "PadaPal: Error occurred auto-switching tenant: #{err}"
         end
       end
 
-      module Rails::ConsoleMethods
-        def self.included(base)
-          _panda_pal_console_autoswitch_tenant
+      if defined?(Pry)
+        default_prompt = Pry::Prompt[:default]
+        env = Pry::Helpers::Text.red(Rails.env.upcase)
+
+        app_name = _panda_pal_console_app_name
+
+        Pry.config.prompt = Pry::Prompt.new(
+          'custom',
+          'my custom prompt',
+          [
+            ->(*args) {
+              app_bit = Pry::Helpers::Text.cyan("#{app_name}-#{Apartment::Tenant.current}")
+              "#{app_bit}#{default_prompt.wait_proc.call(*args)}"
+            },
+            ->(*args) {
+              app_bit = Pry::Helpers::Text.cyan("#{app_name}-#{Apartment::Tenant.current}")
+              "#{app_bit}#{default_prompt.incomplete_proc.call(*args)}"
+            },
+          ],
+        )
+      end
+
+      if defined? Rails::Console
+        module PandaPal::ConsoleExtPrefix
+          extend ActiveSupport::Concern
+
+          def start(*args)
+            print "\033];#{_panda_pal_console_app_name} Rails Console\007"
+            super
+          end
         end
+
+        Rails::Console.prepend(PandaPal::ConsoleExtPrefix)
       end
+    end
 
-      if defined?(Pry)
-        Pry.hooks.add_hook(:before_session, "switch PandaPal tenant") do |output, binding, pry|
-          _panda_pal_console_autoswitch_tenant
+    initializer "panda_pal.autoswitch" do |app|
+      if defined? Rails::Console
+        module PandaPal::ConsoleExtAutoSwitch
+          extend ActiveSupport::Concern
+
+          def start(*args)
+            begin
+              org = nil
+              if Rails.env.development?
+                org = PandaPal::Organization.find_by(name: 'local') || PandaPal::Organization.first
+              elsif PandaPal::Organization.count == 1
+                org = PandaPal::Organization.first
+              end
+
+              if org
+                org.switch_tenant
+                puts "PandaPal: Auto Switched to tenant '#{org.name}'"
+              end
+            rescue => err
+              puts "PandaPal: Error occurred auto-switching tenant: #{err}"
+            end
+
+            super
+          end
         end
+
+        Rails::Console.prepend(PandaPal::ConsoleExtAutoSwitch)
       end
     end
 
     initializer "panda_pal.serialze_symbols" do |app|
       app.config.active_record.yaml_column_permitted_classes ||= []
-      app.config.active_record.yaml_column_permitted_classes |= [Symbol, ActiveSupport::Duration]
+      app.config.active_record.yaml_column_permitted_classes |= [
+        Symbol,
+        ActiveSupport::Duration,
+        ActiveSupport::TimeWithZone,
+        ActiveSupport::TimeZone,
+        Time,
+      ]
     rescue
     end
 

data/lib/panda_pal/version.rb

@@ -1,3 +1,3 @@
 module PandaPal
-  VERSION = "5.6.12"
+  VERSION = "5.7.0.beta1"
 end

data/spec/models/panda_pal/organization_spec.rb

@@ -30,5 +30,21 @@ module PandaPal
       org2 = build :panda_pal_organization, salesforce_id: 'salesforce'
       expect(org2.valid?).to be_falsey
     end
+
+    it 'stores setting as an indifferent Hash' do
+      org = create :panda_pal_organization
+      org.update!(settings: { a: 1 })
+
+      expect(Organization.last.settings).to be_a (ActiveSupport::HashWithIndifferentAccess)
+
+      org.settings = {}
+      expect(org.settings).to be_a (ActiveSupport::HashWithIndifferentAccess)
+    end
+
+    it 'stores settings' do
+      org = create :panda_pal_organization
+      org.update!(settings: { a: 1 })
+      expect(Organization.last.settings[:a]).to eql(1)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panda_pal
 version: !ruby/object:Gem::Version
-  version: 5.6.12
+  version: 5.7.0.beta1
 platform: ruby
 authors:
 - Instructure ProServe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -313,6 +313,7 @@ files:
 - app/models/panda_pal/organization.rb
 - app/models/panda_pal/organization_concerns/settings_validation.rb
 - app/models/panda_pal/organization_concerns/task_scheduling.rb
+- app/models/panda_pal/panda_pal_record.rb
 - app/models/panda_pal/platform.rb
 - app/models/panda_pal/platform/canvas.rb
 - app/models/panda_pal/session.rb
@@ -403,9 +404,9 @@ 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: []
 rubygems_version: 3.1.6
 signing_key: