dce_lti 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 537eafe1ddf43015784d36ac3d0b75b29636d274
-  data.tar.gz: b1b6c42e830086952c486bb6ef33030b2e1bd9b4
+  metadata.gz: 0943e97f6d2613ad998906f27e159dcc604171d8
+  data.tar.gz: b7b5e43868381971bb4977435a029306d5352db1
 SHA512:
-  metadata.gz: 3507c09883950f002947a628e0fec151c6b046633575d739d3318c9dd67931ac32fd74a143027bce9d4c56f30d97bb1b9cf56268d0d78fddefe9a60bad03a1c3
-  data.tar.gz: 30f1ae5dbd4e394ba1f9eb3f31104a161666585fbb4998ff59193b17dc56c5e96348689650701bf1484975ec4dfcd3f8296b50a00923d0818892f159d45e33a9
+  metadata.gz: f811c1fd2ddebd80675ee7f57dae0207363e8ec4e3c3d979e4496ad60dc403f9abb265025ff3f18d2e4e9049aca11e1a71c4afcc714991b46025ffff1c1a72d3
+  data.tar.gz: de233030855e214740d63d92b742802156d9821685bb92aeadc0ff3d5c36cea3592d818d86dafbf7cb91ff364b56402d32242b9bc730db9644063d240e1cb6be

data/README.md

@@ -55,6 +55,10 @@ The generated config looks something like (commented defaults omitted):
 Most basic attributes are configured via ENV. See the generated
 `config/initializers/dce_lti_config.rb` file.
 
+`lti.copy_launch_attributes_to_session` is an array of symbols that allows you
+to define attributes to copy to the rails session from the tool provider after
+a successful launch. See `config/initializers/dce_lti_config.rb` for more info.
+
 ### X-Frame Options
 
 We install a config file that removes `X-Frame-Options` by default to allow
@@ -143,7 +147,8 @@ can also just invoke `DceLti::Nonce.clean` on your own.
 
 ## Contributors
 
-* Dan Collis-Puro - @djcp
+* Dan Collis-Puro - [djcp](https://github.com/djcp)
+* Rebecca Nesson - [rebeccanesson](https://github.com/rebeccanesson)
 
 ## License
 

data/app/concerns/dce_lti/session_helpers.rb

@@ -1,14 +1,5 @@
 module DceLti
   module SessionHelpers
-    ATTRIBUTES_TO_EXTRACT_FOR_SESSION = %i|
-context_id
-context_label
-context_title
-resource_link_id
-resource_link_title
-tool_consumer_instance_guid
-    |
-
     def valid_lti_request?(request)
       tool_provider.valid_request?(request) &&
         Nonce.valid?(tool_provider.oauth_nonce) &&
@@ -47,7 +38,7 @@ tool_consumer_instance_guid
     end
 
     def captured_attributes_from(tool_provider)
-      ATTRIBUTES_TO_EXTRACT_FOR_SESSION.inject({}) do |attributes, att|
+      Engine.config.copy_launch_attributes_to_session.inject({}) do |attributes, att|
         attributes.merge(att => tool_provider.send(att))
       end
     end

data/lib/dce_lti/engine.rb

@@ -4,6 +4,16 @@ require 'pg'
 module DceLti
   class Engine < ::Rails::Engine
     def self.setup
+      config.copy_launch_attributes_to_session = %i|
+context_id
+context_label
+context_title
+resource_link_id
+resource_link_title
+tool_consumer_instance_guid
+launch_presentation_return_url
+    |
+
       config.provider_title = (ENV['LTI_PROVIDER_TITLE'] || 'DCE LTI Provider')
       config.provider_description = (ENV['LTI_PROVIDER_DESCRIPTION'] || 'A description of this')
 

data/lib/dce_lti/version.rb

@@ -1,3 +1,3 @@
 module DceLti
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/controllers/dce_lti/configs_controller_spec.rb

@@ -33,13 +33,15 @@ module DceLti
       end
 
       it 'evaluates custom lambdas with controller context correctly' do
+        allow(controller).to receive(:awesome_method)
+
         tool_config_extensions = ->(controller, tool_config) {
           tool_config.extend ::IMS::LTI::Extensions::Canvas::ToolConfig
-          tool_config.canvas_domain!(controller.request.host)
+          tool_config.canvas_domain!(controller.awesome_method)
         }
         with_overridden_lti_config_of({tool_config_extensions: tool_config_extensions}) do
           get :index, { format: :xml, use_route: :dce_lti }
-          expect(response.body).to include 'test.host'
+          expect(controller).to have_received(:awesome_method)
         end
       end
 

data/spec/controllers/dce_lti/sessions_controller_spec.rb

@@ -29,6 +29,20 @@ module DceLti
         expect(Nonce).to have_received(:valid?).with(nonce)
       end
 
+      it 'has configurable captured session attributes' do
+        attributes_to_capture = [:foobar]
+        tool_provider = stub_successful_tool_provider
+
+        with_overridden_lti_config_of(
+          lti_config.merge(copy_launch_attributes_to_session: attributes_to_capture)
+        ) do
+
+          post_to_create_with_params
+
+          expect(tool_provider).to have_received(:foobar)
+        end
+      end
+
       it 'uses a proc for consumer_key and consumer_secret if configured' do
         tool_provider = stub_successful_tool_provider
         consumer_key = 'a key'

data/spec/dummy/config/initializers/dce_lti_config.rb

@@ -10,6 +10,20 @@ DceLti::Engine.setup do |lti|
   lti.consumer_secret = (ENV['LTI_CONSUMER_SECRET'] || 'consumer_secret')
   lti.consumer_key = (ENV['LTI_CONSUMER_KEY'] || 'consumer_key')
 
+  # `lti.copy_launch_attributes_to_session` is an array of attributes to copy
+  # to the default rails session from the IMS::LTI::ToolProvider instance after
+  # a successful launch. The default attributes are defined in
+  # `DceLti::Engine.setup`, and the possible canvas-lms attributes are defined
+  # in:
+  #
+  # https://github.com/instructure/ims-lti/blob/master/lib/ims/lti/launch_params.rb#L9
+  # https://github.com/instructure/ims-lti/blob/master/lib/ims/lti/tool_provider.rb
+  #
+  # and in the spec as well:
+  # http://www.imsglobal.org/LTI/v1p1p1/ltiIMGv1p1p1.html#_Toc330273026
+  #
+  # lti.copy_launch_attributes_to_session.push(:additional_attribute_to_capture)
+
   # The consumer_secret and consumer_key should be a lambda that will be
   # evaluated in the context of your application. You might use a service
   # object or model proper to find key and secret pairs. Example:

data/spec/dummy/log/development.log

@@ -2873,3 +2873,58 @@ Completed 200 OK in 3ms (Views: 0.4ms | ActiveRecord: 0.6ms)
    (0.2ms)  SELECT version FROM "schema_migrations"
    (3.2ms)  INSERT INTO "schema_migrations" (version) VALUES ('20141008172001')
    (3.3ms)  INSERT INTO "schema_migrations" (version) VALUES ('20141003180140')
+   (106.9ms)  DROP DATABASE IF EXISTS "dce_lti_dummy_test"
+   (330.2ms)  CREATE DATABASE "dce_lti_dummy_test" ENCODING = 'utf8'
+  SQL (0.2ms)  CREATE EXTENSION IF NOT EXISTS "plpgsql"
+   (7.2ms)  CREATE TABLE "dce_lti_nonces" ("id" serial primary key, "nonce" character varying(255), "created_at" timestamp, "updated_at" timestamp) 
+   (3.3ms)  CREATE UNIQUE INDEX  "index_dce_lti_nonces_on_nonce" ON "dce_lti_nonces" USING btree ("nonce")
+   (6.7ms)  CREATE TABLE "dce_lti_users" ("id" serial primary key, "lti_user_id" character varying(255), "lis_person_contact_email_primary" character varying(255), "lis_person_name_family" character varying(255), "lis_person_name_full" character varying(255), "lis_person_name_given" character varying(255), "lis_person_sourcedid" character varying(255), "user_image" character varying(255), "roles" character varying(255)[] DEFAULT '{}', "created_at" timestamp, "updated_at" timestamp) 
+   (1.3ms)  CREATE TABLE "schema_migrations" ("version" character varying(255) NOT NULL) 
+   (5.7ms)  CREATE UNIQUE INDEX  "unique_schema_migrations" ON "schema_migrations"  ("version")
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (2.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('20141008172001')
+   (2.3ms)  INSERT INTO "schema_migrations" (version) VALUES ('20141003180140')
+   (106.2ms)  DROP DATABASE IF EXISTS "dce_lti_dummy_test"
+   (233.4ms)  CREATE DATABASE "dce_lti_dummy_test" ENCODING = 'utf8'
+  SQL (0.2ms)  CREATE EXTENSION IF NOT EXISTS "plpgsql"
+   (10.1ms)  CREATE TABLE "dce_lti_nonces" ("id" serial primary key, "nonce" character varying(255), "created_at" timestamp, "updated_at" timestamp) 
+   (7.2ms)  CREATE UNIQUE INDEX  "index_dce_lti_nonces_on_nonce" ON "dce_lti_nonces" USING btree ("nonce")
+   (13.2ms)  CREATE TABLE "dce_lti_users" ("id" serial primary key, "lti_user_id" character varying(255), "lis_person_contact_email_primary" character varying(255), "lis_person_name_family" character varying(255), "lis_person_name_full" character varying(255), "lis_person_name_given" character varying(255), "lis_person_sourcedid" character varying(255), "user_image" character varying(255), "roles" character varying(255)[] DEFAULT '{}', "created_at" timestamp, "updated_at" timestamp) 
+   (2.8ms)  CREATE TABLE "schema_migrations" ("version" character varying(255) NOT NULL) 
+   (7.3ms)  CREATE UNIQUE INDEX  "unique_schema_migrations" ON "schema_migrations"  ("version")
+   (0.3ms)  SELECT version FROM "schema_migrations"
+   (2.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('20141008172001')
+   (2.5ms)  INSERT INTO "schema_migrations" (version) VALUES ('20141003180140')
+   (104.7ms)  DROP DATABASE IF EXISTS "dce_lti_dummy_test"
+   (239.6ms)  CREATE DATABASE "dce_lti_dummy_test" ENCODING = 'utf8'
+  SQL (0.2ms)  CREATE EXTENSION IF NOT EXISTS "plpgsql"
+   (9.8ms)  CREATE TABLE "dce_lti_nonces" ("id" serial primary key, "nonce" character varying(255), "created_at" timestamp, "updated_at" timestamp) 
+   (5.8ms)  CREATE UNIQUE INDEX  "index_dce_lti_nonces_on_nonce" ON "dce_lti_nonces" USING btree ("nonce")
+   (6.8ms)  CREATE TABLE "dce_lti_users" ("id" serial primary key, "lti_user_id" character varying(255), "lis_person_contact_email_primary" character varying(255), "lis_person_name_family" character varying(255), "lis_person_name_full" character varying(255), "lis_person_name_given" character varying(255), "lis_person_sourcedid" character varying(255), "user_image" character varying(255), "roles" character varying(255)[] DEFAULT '{}', "created_at" timestamp, "updated_at" timestamp) 
+   (1.5ms)  CREATE TABLE "schema_migrations" ("version" character varying(255) NOT NULL) 
+   (3.4ms)  CREATE UNIQUE INDEX  "unique_schema_migrations" ON "schema_migrations"  ("version")
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (1.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('20141008172001')
+   (1.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('20141003180140')
+   (106.0ms)  DROP DATABASE IF EXISTS "dce_lti_dummy_test"
+   (227.1ms)  CREATE DATABASE "dce_lti_dummy_test" ENCODING = 'utf8'
+  SQL (0.2ms)  CREATE EXTENSION IF NOT EXISTS "plpgsql"
+   (10.0ms)  CREATE TABLE "dce_lti_nonces" ("id" serial primary key, "nonce" character varying(255), "created_at" timestamp, "updated_at" timestamp) 
+   (7.1ms)  CREATE UNIQUE INDEX  "index_dce_lti_nonces_on_nonce" ON "dce_lti_nonces" USING btree ("nonce")
+   (13.2ms)  CREATE TABLE "dce_lti_users" ("id" serial primary key, "lti_user_id" character varying(255), "lis_person_contact_email_primary" character varying(255), "lis_person_name_family" character varying(255), "lis_person_name_full" character varying(255), "lis_person_name_given" character varying(255), "lis_person_sourcedid" character varying(255), "user_image" character varying(255), "roles" character varying(255)[] DEFAULT '{}', "created_at" timestamp, "updated_at" timestamp) 
+   (2.8ms)  CREATE TABLE "schema_migrations" ("version" character varying(255) NOT NULL) 
+   (7.2ms)  CREATE UNIQUE INDEX  "unique_schema_migrations" ON "schema_migrations"  ("version")
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (2.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('20141008172001')
+   (2.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('20141003180140')
+   (105.4ms)  DROP DATABASE IF EXISTS "dce_lti_dummy_test"
+   (340.1ms)  CREATE DATABASE "dce_lti_dummy_test" ENCODING = 'utf8'
+  SQL (0.4ms)  CREATE EXTENSION IF NOT EXISTS "plpgsql"
+   (17.6ms)  CREATE TABLE "dce_lti_nonces" ("id" serial primary key, "nonce" character varying(255), "created_at" timestamp, "updated_at" timestamp) 
+   (3.4ms)  CREATE UNIQUE INDEX  "index_dce_lti_nonces_on_nonce" ON "dce_lti_nonces" USING btree ("nonce")
+   (6.7ms)  CREATE TABLE "dce_lti_users" ("id" serial primary key, "lti_user_id" character varying(255), "lis_person_contact_email_primary" character varying(255), "lis_person_name_family" character varying(255), "lis_person_name_full" character varying(255), "lis_person_name_given" character varying(255), "lis_person_sourcedid" character varying(255), "user_image" character varying(255), "roles" character varying(255)[] DEFAULT '{}', "created_at" timestamp, "updated_at" timestamp) 
+   (1.4ms)  CREATE TABLE "schema_migrations" ("version" character varying(255) NOT NULL) 
+   (3.4ms)  CREATE UNIQUE INDEX  "unique_schema_migrations" ON "schema_migrations"  ("version")
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (1.0ms)  INSERT INTO "schema_migrations" (version) VALUES ('20141008172001')
+   (1.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('20141003180140')