panda_pal 5.6.9 → 5.6.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7746e5ec8e6a9422e44a880dda50b985b48706b727e48a02fc2918b75d904125
-  data.tar.gz: 3456caae1ed87a8accafcfa4145ca5ee403fe1bd8f9ac42c3796df8dc334a17c
+  metadata.gz: 5c795ed3f22dd6907af02906b115d21f5a3e0b178278ac94a6a54fd3e41a838a
+  data.tar.gz: d9e8d0152d0c58cf8473519cd5f92b8e5946c235f72c0f2448a9c22c646c9af1
 SHA512:
-  metadata.gz: 0616e5eddcefae83d73bb8da9cb246baef0b06417ae1bbeea2545a1dccebf1d7e1b681931a449e00cc14e5ec3cb0d07c03adc7676048c0e29111701601017171
-  data.tar.gz: 384c9d6bdab817b224670c9d6e5fa080e791f9c2ed0442a0e8fa242cb5572ade7ad696a115b58f4c181bec8e2bed2b4fe39169d3a0eb0d796987306986b38549
+  metadata.gz: 06ac4df41b5b2cc268e06dff1a98322445474947c30b88da4770ec532ea834c62a106368e5ea77c64289bd7b6af7b0a837e1de1d6c71786f45f30ba226face9f
+  data.tar.gz: def73050fcecfacb79c4956188b933f81abfd5cd6791c05143df984473b3cde9e149eccc0f0b36729085d58b781160d2a5eddd5bda8b8ef384d4c5b66476fcdd

data/README.md

@@ -28,6 +28,8 @@ org.install_lti(
   host: "https://your_lti.herokuapp.com",
   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)
 )
 ```
 

data/app/models/panda_pal/organization.rb

@@ -72,10 +72,6 @@ module PandaPal
       find_by_name(Apartment::Tenant.current)
     end
 
-    PandaPal.resolved_extensions_for(self).each do |ext|
-      include ext
-    end
-
     def create_api(logic, expiration: nil, uses: nil, host: nil)
       switch_tenant do
         logic = "current_organization.#{logic}" if logic.is_a?(Symbol)
@@ -102,6 +98,14 @@ 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
+    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)
@@ -109,6 +113,10 @@ module PandaPal
       end
     end
 
+    PandaPal.resolved_extensions_for(self).each do |ext|
+      include ext
+    end
+
     private
 
     def create_schema

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

@@ -28,54 +28,77 @@ module PandaPal
     module OrgExtension
       extend ActiveSupport::Concern
 
-      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)
+      included do
+        define_model_callbacks :lti_install
+      end
 
+      def _parse_lti_context(context)
         context = context.to_s
         context = 'account/self' if context == 'root_account'
         cid, ctype = context.split(/[\.\/]/).reverse
         ctype ||= 'account'
 
-        if version == 'v1p0'
-          existing_installs = _find_existing_installs(exists: exists) do |lti|
-            lti[:consumer_key] == self.key
-          end
+        [ctype, cid]
+      end
 
-          conf = {
-            name: PandaPal.lti_options[:title],
-            description: PandaPal.lti_options[:description],
-            consumer_key: self.key,
-            shared_secret: self.secret,
-            privacy_level: "public",
-            config_type: 'by_url',
-            config_url: PandaPal::LaunchUrlHelpers.resolve_route(:v1p0_config_url, host: host),
-          }
+      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)
 
-          bearcat_client.send(:"create_#{ctype}_external_tool", cid, conf)
-        elsif version == 'v1p3'
-          ekey = _ensure_lti_v1p3_key(exists: exists)
+        run_callbacks :lti_install do
+          ctype, cid = _parse_lti_context(context)
 
-          existing_installs = _find_existing_installs(exists: exists) do |lti|
-            lti[:developer_key_id] == (ekey[:id] % 10_000_000_000_000)
-          end
+          if version == 'v1p0'
+            existing_installs = _find_existing_installs(exists: exists) do |lti|
+              lti[:consumer_key] == self.key
+            end
 
-          scope_tool = bearcat_client.send(:"create_#{ctype}_external_tool", cid, {
-            client_id: ekey[:id],
-          })
+            conf = {
+              name: PandaPal.lti_options[:title],
+              description: PandaPal.lti_options[:description],
+              consumer_key: self.key,
+              shared_secret: self.secret,
+              privacy_level: "public",
+              config_type: 'by_url',
+              config_url: PandaPal::LaunchUrlHelpers.resolve_route(:v1p0_config_url, host: host),
+            }
+
+            api_result = existing_installs[0] ? bearcat_client.send(:"edit_#{ctype}_external_tool", cid, existing_installs[0][:id], conf) : bearcat_client.send(:"create_#{ctype}_external_tool", cid, conf)
+
+            @new_lti_installation = api_result
+          elsif version == 'v1p3'
+            ekey = _ensure_lti_v1p3_key(exists: exists, host: host)
+
+            existing_installs = _find_existing_installs(context, exists: exists) do |lti|
+              lti[:developer_key_id] == (ekey[:id] % 10_000_000_000_000)
+            end
 
-          new_client_id = "#{ekey[:id]}"
-          new_client_id += "/#{scope_tool[:deployment_id]}" if dedicated_deployment
+            scope_tool = existing_installs[0]
 
-          self.key = new_client_id
-          self.secret = ekey[:api_key]
+            # Don't need to do an update if it already exists - Settings are stored on the LTI Key instead of the installation
+            unless scope_tool
+              scope_tool = bearcat_client.send(:"create_#{ctype}_external_tool", cid, {
+                client_id: ekey[:id],
+              })
 
-          save! if changed!
-        else
-          raise "Unrecognized LTI Version #{version}"
+              new_client_id = "#{ekey[:id]}"
+              new_client_id += "/#{scope_tool[:deployment_id]}" if dedicated_deployment
+
+              self.key = new_client_id
+              self.secret = ekey[:api_key]
+
+              save! if changed?
+            end
+
+            @new_lti_installation = scope_tool
+          else
+            raise "Unrecognized LTI Version #{version}"
+          end
         end
+
+        save!
       end
 
-      def _ensure_lti_v1p3_key(exists:)
+      def _ensure_lti_v1p3_key(exists:, host:)
         current_client_id = self.key.split('/')[0]
 
         existing_keys = []
@@ -111,7 +134,10 @@ module PandaPal
           # Update Existing
           ekey = bearcat_client.put("api/lti/developer_keys/#{ekey[:id]}/tool_configuration", {
             developer_key: ekey[:developer_key],
-            tool_configuration: lti_json,
+            # tool_configuration: lti_json,
+            tool_configuration: {
+              settings: lti_json,
+            },
           })
         end
 
@@ -128,26 +154,32 @@ module PandaPal
         ekey
       end
 
-      def _find_existing_installs(exists:, &matcher)
+      def _find_existing_installs(context, exists: nil, &matcher)
+        ctype, cid = _parse_lti_context(context)
+
         existing_installs = bearcat_client.send(:"#{ctype}_external_tools", cid).all_pages_each.filter do |cet|
           matcher.call(cet)
         end
 
-        if existing_installs.present?
+        if exists.present? && existing_installs.present?
           case exists
           when :error
             raise "Tool with key #{self.key} already installed"
           when :duplicate
+            []
           when :replace
             existing_installs.each do |install|
               bearcat_client.send(:"delete_#{ctype}_external_tool", cid, install[:id])
             end
+            []
+          when :update
+            existing_installs
           else
             raise "exists: #{exists} is not supported"
           end
+        else
+          existing_installs
         end
-
-        existing_installs
       end
 
       def reinstall_lti!(*args, **kwargs)
@@ -199,6 +231,10 @@ module PandaPal
         end
       end
 
+      def lti_installations(context= :root_account)
+        _find_existing_installs(context)
+      end
+
       def canvas_url
         PandaPal::Platform.find_org_setting([
           "canvas.base_url",

data/app/models/panda_pal/platform.rb

@@ -72,14 +72,13 @@ module PandaPal
       raise "Unknown platform '#{platform}'"
     end
 
-    def self.materialize_extension(org)
+    def self.org_subclass
       return nil unless defined?(self::OrgExtension)
+      oext = self::OrgExtension
 
-      ext_mod = self::OrgExtension
-      org = org.dup
-      org.extend(ext_mod)
-
-      org
+      @org_subclass ||= Class.new(PandaPal::Organization) do
+        include oext
+      end
     end
 
     protected

data/lib/panda_pal/engine.rb

@@ -103,7 +103,7 @@ module PandaPal
 
     initializer "panda_pal.serialze_symbols" do |app|
       app.config.active_record.yaml_column_permitted_classes ||= []
-      app.config.active_record.yaml_column_permitted_classes |= [Symbol]
+      app.config.active_record.yaml_column_permitted_classes |= [Symbol, ActiveSupport::Duration]
     rescue
     end
 

data/lib/panda_pal/version.rb

@@ -1,3 +1,3 @@
 module PandaPal
-  VERSION = "5.6.9"
+  VERSION = "5.6.11"
 end

data/panda_pal.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'ros-apartment', '~> 2.2'
   s.add_dependency 'ims-lti', '~> 1.2.4'
   s.add_dependency 'browser', '2.5.0'
-  s.add_dependency 'attr_encrypted', '~> 3.0.0'
+  s.add_dependency 'attr_encrypted', '~> 4.0.0'
   s.add_dependency 'secure_headers', '~> 6.1'
   s.add_dependency 'json-jwt'
   s.add_dependency 'jwt'