panda_pal 5.8.5 → 5.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b99a6e3fecfa610524f2b960b7f45ea9b2a337493662a8e6bde4894670c8ded1
-  data.tar.gz: 6362fd1bd34723195353ddd9a5288ea98d13acf1ddc390291e16f35715a1e2da
+  metadata.gz: a3cef6069ef4d4c36af2ff4d665e9ae08d712198ea8422b1f60353e117753aec
+  data.tar.gz: 4cce12d864ebbab515d5f496dc2371550dd986b920f9fbb6763b9c77db527e95
 SHA512:
-  metadata.gz: 82513c2b4a82fce30288b38b9e1edc9f2071c1d174a9b5eedc337b8f18c4c72214b4731f0df91ab6ce3ab83a52b47bed1e753c1454c81bbe1bd4a68d7c14db34
-  data.tar.gz: 8bdc013083dfd97b5e3cbfce9b62c111ac31f1018fb773a9fef091e1ba7d94a22284930b231d2a8b4803436aae7b1ca0ee44ca49d75fad6ebd059d08dfb7b148
+  metadata.gz: 0102ced164298cd5c56d9bd62bfbad019301fbc78d150eca69c0b90c142c038febe13a04c7d801a3d357a91cef3533110af26f537fba61725a0033bf5a42b9bd
+  data.tar.gz: d188c8bfcbe5cfc73b3d5570c8a5252c0589f4443e3dd364e182f7252a09495c5888d87b515e00e5cd6907f392dda15e10ef14e346c5f7507cefedeff1812bfc

data/README.md

@@ -275,11 +275,38 @@ and a custom implementation can be supplemented.
 
 ### Session cleanup
 Over time, the sessions table will become bloated with sessions that are no longer active.
-As such, `rake panda_pal:clean_sessions` should be run periodically to clean up sessions that haven't been updated in over a week.
+If `sidekiq-scheduler` and `TaskScheduling` are enabled, cleanup will be performed automatically. Otherwise you should schedule, `rake panda_pal:clean_sessions` to run periodically (recommend weekly).
 
 ## Organizations and `current_organization`
 Similar to `current_session`, `current_organization` can be returned with a number of methods, shown below
 
+## Rake Tasks
+
+### `panda_pal:org:new`
+Opens `$EDITOR` and creates a new `Organization`. The opened editor is prefilled with all of the available Settings with optional settings pre-commented.
+
+### `panda_pal:org:dev`
+Similar to `panda_pal:org:new`, but is somewhat preconfigured for development environments.
+
+You can create a `~/pandapalrc.yml` file to specify additional defaults:
+```yml
+lti_host: http://localhost:5000
+settings:
+  canvas:
+    base_url: http://localhost:3000
+    api_token: Uo5yckRQuPl96qVxgt2IVxDAa5oSUo1dqbb2dBVOnpId18aTmjSXdYkn4BN9JF2k
+```
+NB: `settings` entries present in `~/pandapalrc.yml` that are not defined in the `settings_structure` will be ignored.
+
+### `panda_pal:org:edit[name]`
+Similar to `panda_pal:org:new` but for editing an existing Organization.
+
+### `panda_pal:org:install[orgname, http://url.of.lti]`
+Install the LTI into Canvas. Must specify the Organization and the host of the LTI
+
+### `panda_pal:org:reinstall[orgname, http://url.of.lti]`
+Same as `panda_pal:org:install`, but first deletes an existing installation
+
 ## Security
 
 ### Tool Launches

data/app/models/panda_pal/organization.rb

@@ -38,6 +38,7 @@ module PandaPal
     include SkipSymmetricEncAttrEncrypted if defined?(SkipSymmetricEncAttrEncrypted)
 
     include OrganizationConcerns::SettingsValidation
+    include OrganizationConcerns::OrganizationBuilder if $stdin&.tty?
     include OrganizationConcerns::TaskScheduling if defined?(Sidekiq.schedule)
 
     attr_encrypted :settings, marshal: true, key: :encryption_key, marshaler: SettingsMarshaler

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

@@ -0,0 +1,163 @@
+module PandaPal
+  module OrganizationConcerns
+    module OrganizationBuilder
+      extend ActiveSupport::Concern
+      include OrganizationConcerns::SettingsValidation
+
+      class InteractiveSessionError < StandardError
+        attr_reader :source_code
+
+        def initialize(message, source_code)
+          super(message)
+          @source_code = source_code
+        end
+
+        def print
+          puts cause&.message, cause&.backtrace
+          puts ""
+          puts message
+          puts "Code is below for tweaking and/or using it in a Rails console"
+          puts ""
+          puts source_code
+          puts ""
+        end
+      end
+
+      class_methods do
+        def _interactive_save!(org)
+          code = org.generate_orgbuilder_ruby
+
+          tries = 0
+          result = nil
+
+          loop do
+            begin
+              code = ConsoleHelpers.open_string_editor(code, name: "organization.rb", require_save: tries == 0)
+            rescue => ex
+              raise InteractiveSessionError.new("Failed to open interactive editor", code)
+            end
+
+            if code == :aborted
+              puts "Aborted"
+              return
+            end
+
+            begin
+              result = eval(code, TOPLEVEL_BINDING)
+              break
+            rescue => ex
+              puts "Failed to save Organization: #{ex}"
+              if !ConsoleHelpers.prompt_yes_no("Retry?")
+                raise InteractiveSessionError.new("Failed to save Organization", code)
+              end
+              tries += 1
+            end
+          end
+
+          result
+        end
+
+        def interactive_create!(org = PandaPal::Organization.new)
+          result = _interactive_save!(org)
+
+          if result&.persisted? && ConsoleHelpers.prompt_yes_no("Organization created. Install in Canvas?", default: false)
+            result.interactive_install!
+          end
+
+          result
+        end
+
+        if Rails.env.development?
+          def development_create!
+            if PandaPal::Organization.count > 0
+              return unless ConsoleHelpers.prompt_yes_no("An Organization is already set up. Continue?")
+            end
+
+            org = PandaPal::Organization.new(
+              name: "local",
+              canvas_account_id: "1",
+              key: "#{_panda_pal_console_app_name}-local",
+              secret: "#{_panda_pal_console_app_name}-local",
+              salesforce_id: "1",
+            )
+
+            rcsettings = ConsoleHelpers.pandapalrc["settings"] || {}
+            cleaned_settings = PandaPal::Organization.remove_undeclared_settings(rcsettings)
+            org.settings = cleaned_settings
+
+            result = interactive_create!(org)
+
+            return unless result
+
+            puts "Created Development Organization: #{result.name}"
+
+            result.switch_tenant
+          end
+        end
+      end
+
+      def interactive_update!
+        saved = self.class._interactive_save!(self)
+        puts "Organization Updated" if saved
+        saved
+      end
+
+      def interactive_install!(host: nil, exists: :error)
+        first = true
+        loop do
+          # If a host is explicitly passed, don't prompt for it on the first try
+          unless first && host.present?
+            if Rails.env.development?
+              host ||= ConsoleHelpers.pandapalrc["lti_host"].presence || "http://localhost:5000"
+            end
+            host = ConsoleHelpers.prompt("Specify LTI host:", default: host)
+          end
+
+          begin
+            install_lti(host: host, exists: exists)
+            break
+          rescue => ex
+            puts "Failed to install in Canvas: #{ex}"
+            raise ex unless ConsoleHelpers.prompt_pry_retry
+            first = false
+          end
+        end
+      end
+
+      def generate_orgbuilder_ruby
+        code = ConsoleHelpers::CodeBuilder.new
+
+        columns = %w[
+          canvas_account_id
+          key
+          secret
+          salesforce_id
+        ]
+
+        if self.persisted?
+          code << "PandaPal::Organization.find_by(name: \"#{self.name}\").update!("
+        else
+          code << "PandaPal::Organization.create!("
+          columns.unshift("name")
+        end
+
+        code << "\n"
+
+        code.block do
+          columns.each do |col|
+            code << "#{col}: \"#{self.send(col)}\","
+            code << "\n"
+          end
+
+          code << "settings: "
+          code << PandaPal::Organization.generate_settings_ruby(value: settings)
+          code << ",\n"
+        end
+
+        code << ")"
+
+        code.to_s
+      end
+    end
+  end
+end

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

@@ -65,8 +65,76 @@ module PandaPal
           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[:type] = "Hash" if !nstruc[:type] && nstruc.key?(:properties)
+
           nstruc
         end
+
+        def remove_undeclared_settings(value, setting: settings_structure)
+          if setting[:type] == "Hash"
+            value.dup.tap do |value|
+              value.keys.each do |key|
+                if setting[:properties].key?(key.to_sym)
+                  value[key] = remove_undeclared_settings(value[key], setting: setting[:properties][key.to_sym])
+                elsif !setting[:allow_additional]
+                  value.delete(key)
+                end
+              end
+            end
+          else
+            value
+          end
+        end
+
+        def generate_settings_ruby(indent: 0, setting: settings_structure, value: { }, exclude_extra: false)
+          builder = ConsoleHelpers::CodeBuilder.new(indent: indent)
+
+          value = setting[:default] || setting.dig(:json_schema, :default) if value == :not_given
+
+          if setting[:type] == "Hash"
+            builder << "{"
+            builder << "\n"
+            builder.indent!
+            setting[:properties].each do |key, sub|
+              if sub[:description]
+                builder << sub[:description].lines.map{|l| "# #{l}"}
+                builder.ensure_line
+              end
+
+              sub_val = value&.key?(key) ? value[key] : :not_given
+              commented = sub_val == :not_given && !sub[:required]
+
+              builder.indent!("# ") if commented
+              builder << "#{key}: "
+              builder << generate_settings_ruby(setting: sub, value: sub_val)
+              builder << ",\n"
+              builder.dedent! if commented
+            end
+
+            # If we're editing an existing org, we may have extra keys that aren't in the schema
+            # But if we're creating a new org, we don't want to include undocumented entries from pandapalrc.yml
+            unless exclude_extra
+              extra_keys = (value&.keys || []) - setting[:properties].keys.map(&:to_s)
+              extra_keys.each do |key|
+                builder << "# Undocumented\n" unless setting[:allow_additional]
+                builder << "#{key}: #{value[key].inspect},\n"
+              end
+            end
+
+            builder.dedent!
+            builder << "}"
+          elsif setting[:type] == "Array"
+            builder << "#{value&.inspect || '[]'}"
+          elsif setting[:type] == "Integer"
+            builder << "#{value || 0}"
+          elsif setting[:type] == "Numeric"
+            builder << "#{value || 1.0}"
+          else setting[:type] == "String"
+            builder << "\"#{value}\""
+          end
+
+          builder.to_s
+        end
       end
 
       def settings_structure

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

@@ -74,7 +74,7 @@ module PandaPal
         [ctype, cid]
       end
 
-      def install_lti(host: nil, context: :root_account, version: nil, exists: :error, dedicated_deployment: false)
+      def _install_lti(host: nil, context: :root_account, version: nil, exists: :error, dedicated_deployment: false)
         raise "Automatically installing this LTI requires Bearcat." unless defined?(Bearcat)
 
         version = version || PandaPal.lti_options[:lti_spec_version] || 'v1p0'
@@ -138,6 +138,12 @@ module PandaPal
         save!
       end
 
+      def install_lti(*args, **kwargs)
+        switch_tenant do
+          _install_lti(*args, **kwargs)
+        end
+      end
+
       def _ensure_lti_v1p3_key(exists:, host:)
         current_client_id = self.key.split('/')[0]
 

data/lib/panda_pal/helpers/console_helpers.rb

@@ -23,5 +23,134 @@ module PandaPal
         "\033[1;#{30 + value}m#{text}\033[0m"
       end
     end
+
+    def pandapalrc
+      # TODO Consider searching app and parent dirs before ~/
+      @pandapalrc ||= YAML.load(File.read(File.expand_path("~/pandapalrc.yml"))) rescue {}
+    end
+
+    def prompt(prompt = "", default: nil)
+      prompt = prompt + " (#{default})" if default.present?
+      puts prompt
+      print "> "
+      v = gets.chomp.downcase
+      return default if v == ""
+      v
+    end
+
+    def prompt_options(options, prompt = "", default: nil)
+      options = options.map(&:to_s)
+      prompt = prompt + " (" + options.map { |o| o == default ? o.capitalize : o }.join("/") + ")"
+      i = 0
+      loop do
+        puts prompt
+        print "> "
+        i += 1
+        v = gets.chomp.downcase
+        return v if options.include?(v)
+        return default if v == ""
+        return nil if i > 3
+        puts "Invalid Input."
+      end
+    end
+
+    def prompt_yes_no(prompt = "", default: true)
+      result = prompt_options(["y", "n"], prompt, default: default ? "y" : "n")
+      return true if result == "y"
+      return false if result == "n"
+      result
+    end
+
+    def prompt_pry_retry(prompt = "Retry?", default: false)
+      default = default ? "y" : "n" unless default.is_a?(String)
+      result = prompt_options(["y", "n", "pry"], prompt, default: default ? "y" : "n")
+      if result == "pry"
+        binding.pry
+        return true
+      end
+      return true if result == "y"
+      return false if result == "n"
+      result
+    end
+
+    def open_editor(file_path)
+      raise "EDITOR environment variable not set" unless ENV["EDITOR"].present?
+
+      args = Shellwords.shellwords(ENV['EDITOR'])
+      args << file_path
+      Kernel::system(*args)
+    end
+
+    def open_string_editor(string, file: nil, name: nil, require_save: true)
+      file_obj = file.present? ? File.new(file) : Tempfile.new([File.basename(name, File.extname(name)), File.extname(name)])
+      File.open(file_obj.path, 'w') { |f| f.write(string) }
+
+      mtime = File.stat(file_obj.path).mtime
+
+      path = file_obj.path
+      file_obj.close rescue nil
+      open_editor(path)
+
+      return :aborted unless !require_save || mtime < File.stat(file_obj.path).mtime
+
+      File.read(path)
+    end
+
+    class CodeBuilder
+      def initialize(indent: 0)
+        @code = ""
+        @line_prefix = ["  "] * indent
+      end
+
+      def <<(line)
+        if line.is_a?(Array)
+          line.each do |l|
+            self << l
+          end
+        else
+          bits = line.split("\n", -1)
+
+          push_bit(bits.shift)
+
+          bits.each do |bit|
+            @code << "\n"
+            push_bit(bit)
+          end
+        end
+      end
+
+      def ensure_line
+        return if @code.ends_with?("\n")
+        @code << "\n"
+      end
+
+      def block(char = nil)
+        indent!(char)
+        yield
+      ensure
+        dedent!
+      end
+
+      def indent!(char = nil)
+        @line_prefix << (char || "  ")
+      end
+
+      def dedent!
+        @line_prefix.pop
+      end
+
+      def to_s
+        @code
+      end
+
+      protected
+
+      def push_bit(bit)
+        return unless bit.present?
+
+        @code << @line_prefix.join if @code.ends_with?("\n")
+        @code << bit
+      end
+    end
   end
 end

data/lib/panda_pal/version.rb

@@ -1,3 +1,3 @@
 module PandaPal
-  VERSION = "5.8.5"
+  VERSION = "5.9.0"
 end

data/lib/tasks/panda_pal_tasks.rake

@@ -3,4 +3,41 @@ namespace :panda_pal do
   task clean_sessions: :environment do
     PandaPal::Session.where('updated_at < ?', 1.week.ago).delete_all
   end
+
+  namespace :org do
+    desc "Interactively Create a new PandaPal::Organization"
+    task :new, [:name] => :environment do |t, args|
+      org = PandaPal::Organization.new(name: args[:name])
+      PandaPal::Organization.interactive_create!(org)
+    rescue PandaPal::OrganizationConcerns::OrganizationBuilder::InteractiveSessionError => ex
+      ex.print
+    end
+
+    desc "Interactively Update a PandaPal::Organization"
+    task :edit, [:name] => :environment do |t, args|
+      org = PandaPal::Organization.find_by!(name: args[:name])
+      org.interactive_update!
+    rescue PandaPal::OrganizationConcerns::OrganizationBuilder::InteractiveSessionError => ex
+      ex.print
+    end
+
+    desc "Install/update the LTI in Canvas for the given Organization"
+    task :install, [:name, :host] => :environment do |t, args|
+      org = PandaPal::Organization.find_by!(name: args[:name])
+      org.interactive_install!(host: args[:host], exists: :update)
+    end
+
+    desc "Reinstall the LTI in Canvas for the given Organization"
+    task :reinstall, [:name, :host] => :environment do |t, args|
+      org = PandaPal::Organization.find_by!(name: args[:name])
+      org.interactive_install!(host: args[:host], exists: :replace)
+    end
+
+    if Rails.env.development?
+      desc "Creates a new PandaPal::Organization for development"
+      task dev: :environment do
+        PandaPal::Organization.development_create!
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panda_pal
 version: !ruby/object:Gem::Version
-  version: 5.8.5
+  version: 5.9.0
 platform: ruby
 authors:
 - Instructure CustomDev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-27 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -311,6 +311,7 @@ files:
 - app/lib/panda_pal/lti_jwt_validator.rb
 - app/models/panda_pal/api_call.rb
 - app/models/panda_pal/organization.rb
+- app/models/panda_pal/organization_concerns/organization_builder.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