panda_pal 5.18.2 → 5.19.0.beta1

data/spec/models/panda_pal/lti_registration_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+RSpec.describe PandaPal::LtiRegistration, :isolated_lti_config do
+  let(:organization) { create(:panda_pal_organization) }
+
+  before { PandaPal.define_tool(:translate) }
+
+  def register(**attrs)
+    organization.lti_registrations.create!(tool: 'translate', client_id: '10000000000001', **attrs)
+  end
+
+  describe '.for_launch' do
+    it 'prefers a deployment-specific registration' do
+      key_wide = register
+      dedicated = register(deployment_id: 'dep-1')
+
+      expect(described_class.for_launch('10000000000001', 'dep-1')).to eq(dedicated)
+      expect(described_class.for_launch('10000000000001', 'dep-2')).to eq(key_wide)
+    end
+
+    it 'matches a key-wide registration when the launch has no deployment_id' do
+      key_wide = register
+
+      expect(described_class.for_launch('10000000000001', nil)).to eq(key_wide)
+    end
+
+    it 'matches numeric client_ids' do
+      key_wide = register
+
+      expect(described_class.for_launch(10000000000001, nil)).to eq(key_wide)
+    end
+
+    it 'returns nil for unknown or blank client_ids' do
+      register
+
+      expect(described_class.for_launch('99', nil)).to be_nil
+      expect(described_class.for_launch(nil, 'dep-1')).to be_nil
+    end
+  end
+
+  describe 'validations' do
+    it 'rejects a tool that was never defined' do
+      registration = organization.lti_registrations.build(tool: 'nope', client_id: '1')
+
+      expect(registration).not_to be_valid
+      expect(registration.errors[:tool]).to be_present
+    end
+
+    it 'allows only one key-wide registration per client_id' do
+      register
+
+      expect { register }.to raise_error(ActiveRecord::RecordInvalid)
+    end
+
+    it 'allows only one registration per client_id and deployment' do
+      register(deployment_id: 'dep-1')
+
+      expect { register(deployment_id: 'dep-1') }.to raise_error(ActiveRecord::RecordInvalid)
+      expect { register(deployment_id: 'dep-2') }.not_to raise_error
+    end
+
+    it 'stores a blank deployment_id as nil' do
+      expect(register(deployment_id: '').deployment_id).to be_nil
+    end
+  end
+
+  it 'is destroyed with its organization' do
+    register
+
+    expect { organization.destroy }.to change(described_class, :count).by(-1)
+  end
+end

data/spec/models/panda_pal/platform/canvas_install_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+RSpec.describe 'PandaPal::Platform::Canvas::OrgExtension#install_lti', :isolated_lti_config do
+  let(:organization) { create(:panda_pal_organization, key: '10000000000001') }
+  let(:client) { double('Bearcat::Client') }
+  let(:host) { 'https://tool.example.com' }
+  let(:installed_tools) { [] }
+
+  before do
+    # _install_lti only checks that Bearcat exists; the client itself is stubbed.
+    stub_const('Bearcat', Module.new)
+    c = client
+    organization.define_singleton_method(:bearcat_client) { c }
+
+    PandaPal.lti_environments = { domain: 'tool.example.com' }
+    PandaPal.lti_options = { title: 'Shared Title' }
+    PandaPal.define_tool(:translate, title: 'Translate Title')
+    PandaPal.stage_placement(:editor_button, tool: :translate, url: :panda_pal)
+
+    allow(client).to receive(:account_external_tools).with('self').and_return(double(all_pages_each: installed_tools))
+  end
+
+  after { Apartment::Tenant.reset }
+
+  describe 'LTI 1.3' do
+    let(:developer_key) do
+      { id: 10000000000002, api_key: 'dev-key-secret', developer_key_account_binding: { workflow_state: 'on' } }
+    end
+
+    before do
+      allow(client).to receive(:get).and_return([])
+      allow(HTTParty).to receive(:get) do |url, **|
+        double(body: { target_link_uri: "#{host}/panda_pal/v1p3/resource_link_request", extensions: [] }.to_json, url: url)
+      end
+    end
+
+    it 'creates a Developer Key from the tool config, installs it, and registers it without touching the org key' do
+      expect(client).to receive(:post).with('api/lti/accounts/self/developer_keys/tool_configuration', hash_including(
+        developer_key: hash_including(name: 'Translate Title'),
+      )).and_return({ developer_key: developer_key })
+      expect(client).to receive(:create_account_external_tool).with('self', { client_id: 10000000000002 }).and_return({ id: 7, deployment_id: 'dep-9' })
+
+      organization.install_lti(host: host, tool: :translate)
+
+      expect(HTTParty).to have_received(:get).with(a_string_including('v1p3/config?tool=translate'), format: :plain)
+      expect(organization.reload.key).to eq('10000000000001')
+      expect(organization.lti_registrations.pluck(:tool, :client_id, :deployment_id)).to eq([['translate', '10000000000002', nil]])
+    end
+
+    it 'records the deployment_id for a dedicated deployment' do
+      allow(client).to receive(:post).and_return({ developer_key: developer_key })
+      allow(client).to receive(:create_account_external_tool).and_return({ id: 7, deployment_id: 'dep-9' })
+
+      organization.install_lti(host: host, tool: :translate, dedicated_deployment: true)
+
+      expect(organization.lti_registrations.pluck(:deployment_id)).to eq(['dep-9'])
+    end
+
+    context 'when the tool is already registered and installed' do
+      let(:installed_tools) { [{ id: 7, developer_key_id: 2, deployment_id: 'dep-9' }] }
+
+      before do
+        organization.lti_registrations.create!(tool: 'translate', client_id: '10000000000002')
+        allow(client).to receive(:get).and_return([developer_key])
+      end
+
+      it 'updates the registered Developer Key in place and reuses its install' do
+        expect(client).not_to receive(:post)
+        expect(client).not_to receive(:create_account_external_tool)
+        expect(client).to receive(:put).with('api/lti/developer_keys/10000000000002/tool_configuration', anything).and_return(developer_key)
+
+        organization.install_lti(host: host, tool: :translate, exists: :update)
+
+        expect(organization.lti_registrations.count).to eq(1)
+      end
+    end
+
+    it 'parses dotted versions (1.3 used to resolve to v1p1)' do
+      allow(client).to receive(:post).and_return({ developer_key: developer_key })
+      allow(client).to receive(:create_account_external_tool).and_return({ id: 7, deployment_id: 'dep-9' })
+
+      expect { organization.install_lti(host: host, tool: :translate, version: '1.3') }.not_to raise_error
+      expect(organization.lti_registrations.count).to eq(1)
+    end
+
+    it 'raises for a tool that was never defined' do
+      expect { organization.install_lti(host: host, tool: :nope) }.to raise_error(PandaPal::UnknownLtiTool)
+    end
+  end
+
+  describe 'LTI 1.0' do
+    let(:installed_tools) do
+      [
+        { id: 1, consumer_key: organization.key, custom_fields: {} },
+        { id: 2, consumer_key: organization.key, custom_fields: { PandaPal::TOOL_CUSTOM_FIELD => 'translate' } },
+      ]
+    end
+
+    it "updates only the matching tool's install, pointing it at that tool's config" do
+      expect(client).to receive(:edit_account_external_tool).with('self', 2, hash_including(
+        name: 'Translate Title',
+        consumer_key: organization.key,
+        config_url: a_string_including('v1p0/config?tool=translate'),
+      ))
+
+      organization.install_lti(host: host, tool: :translate, version: '1.0', exists: :update)
+    end
+
+    it 'still matches the default install by consumer key alone' do
+      expect(client).to receive(:edit_account_external_tool).with('self', 1, hash_including(name: 'Shared Title'))
+
+      organization.install_lti(host: host, version: 'v1p0', exists: :update)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -27,6 +27,7 @@ require "panda_pal/spec_helper"
 ActiveRecord::Schema.verbose = false
 
 Dir[File.dirname(__FILE__) + "/factories/**/*.rb"].each {|f| require f }
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f }
 
 RSpec.configure do |config|
   config.include PandaPal::SpecHelper

data/spec/support/isolated_lti_config.rb

@@ -0,0 +1,24 @@
+# PandaPal's LTI configuration (placements, tools, options, ...) lives in class
+# variables that host apps set once at boot. Specs that change it tag themselves
+# `:isolated_lti_config` so whatever they register is rolled back afterwards and
+# never leaks into later spec files.
+module IsolatedLtiConfig
+  VARS = %i[
+    @@lti_navigation
+    @@lti_tools
+    @@lti_options
+    @@lti_custom_params
+    @@lti_environments
+  ].freeze
+end
+
+RSpec.shared_context 'isolated LTI config', isolated_lti_config: true do
+  around do |example|
+    saved = IsolatedLtiConfig::VARS.to_h { |var| [var, PandaPal.class_variable_get(var).deep_dup] }
+    begin
+      example.run
+    ensure
+      saved.each { |var, value| PandaPal.class_variable_set(var, value) }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panda_pal
 version: !ruby/object:Gem::Version
-  version: 5.18.2
+  version: 5.19.0.beta1
 platform: ruby
 authors:
 - Instructure CustomDev
@@ -113,6 +113,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json-jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +172,7 @@ files:
 - app/lib/panda_pal/launch_url_helpers.rb
 - app/lib/panda_pal/lti_jwt_validator.rb
 - app/models/panda_pal/api_call.rb
+- app/models/panda_pal/lti_registration.rb
 - app/models/panda_pal/organization.rb
 - app/models/panda_pal/organization_concerns/multi_database_sharding.rb
 - app/models/panda_pal/organization_concerns/organization_builder.rb
@@ -183,6 +198,8 @@ files:
 - db/migrate/20171205194657_remove_old_organization_settings.rb
 - db/migrate/20220721095653_create_panda_pal_api_calls.rb
 - db/migrate/20250401214421_rename_session_session_key.rb
+- db/migrate/20261006000000_create_panda_pal_lti_registrations.rb
+- db/migrate/20261006000001_add_tool_to_panda_pal_sessions.rb
 - lib/panda_pal.rb
 - lib/panda_pal/concerns/ability_helper.rb
 - lib/panda_pal/engine.rb
@@ -202,6 +219,7 @@ files:
 - spec/controllers/panda_pal/api_call_controller_spec.rb
 - spec/controllers/panda_pal/lti_v1_p0_controller_spec.rb
 - spec/controllers/panda_pal/lti_v1_p3_controller_spec.rb
+- spec/controllers/panda_pal/lti_v1_p3_tools_spec.rb
 - spec/core/apartment_multidb_spec.rb
 - spec/factories/panda_pal_organizations.rb
 - spec/factories/panda_pal_sessions.rb
@@ -215,14 +233,18 @@ files:
 - spec/lib/panda_pal/ags_client_spec.rb
 - spec/lib/panda_pal/helpers/secure_headers_spec.rb
 - spec/lib/panda_pal/helpers/session_replacement_spec.rb
+- spec/lib/panda_pal/lti_tools_spec.rb
 - spec/models/panda_pal/api_call_spec.rb
+- spec/models/panda_pal/lti_registration_spec.rb
 - spec/models/panda_pal/organization/settings_validation_spec.rb
 - spec/models/panda_pal/organization/task_scheduling_spec.rb
 - spec/models/panda_pal/organization_spec.rb
+- spec/models/panda_pal/platform/canvas_install_spec.rb
 - spec/models/panda_pal/platform_spec.rb
 - spec/models/panda_pal/session_account_roles_spec.rb
 - spec/models/panda_pal/session_spec.rb
 - spec/spec_helper.rb
+- spec/support/isolated_lti_config.rb
 homepage: http://instructure.com
 licenses:
 - MIT
@@ -248,6 +270,7 @@ test_files:
 - spec/controllers/panda_pal/api_call_controller_spec.rb
 - spec/controllers/panda_pal/lti_v1_p0_controller_spec.rb
 - spec/controllers/panda_pal/lti_v1_p3_controller_spec.rb
+- spec/controllers/panda_pal/lti_v1_p3_tools_spec.rb
 - spec/core/apartment_multidb_spec.rb
 - spec/factories/panda_pal_organizations.rb
 - spec/factories/panda_pal_sessions.rb
@@ -261,11 +284,15 @@ test_files:
 - spec/lib/panda_pal/ags_client_spec.rb
 - spec/lib/panda_pal/helpers/secure_headers_spec.rb
 - spec/lib/panda_pal/helpers/session_replacement_spec.rb
+- spec/lib/panda_pal/lti_tools_spec.rb
 - spec/models/panda_pal/api_call_spec.rb
+- spec/models/panda_pal/lti_registration_spec.rb
 - spec/models/panda_pal/organization/settings_validation_spec.rb
 - spec/models/panda_pal/organization/task_scheduling_spec.rb
 - spec/models/panda_pal/organization_spec.rb
+- spec/models/panda_pal/platform/canvas_install_spec.rb
 - spec/models/panda_pal/platform_spec.rb
 - spec/models/panda_pal/session_account_roles_spec.rb
 - spec/models/panda_pal/session_spec.rb
 - spec/spec_helper.rb
+- spec/support/isolated_lti_config.rb