How make a full implementation

[sebitaas96-ss]

Good morning ,

Has anyone managed to make a complete implementation of this Lti-1-3 package, we would be grateful if you could share the information with us.

thanks.

[dbhynds]

We're actively using this in our product. We use it for launches, AGS, and NRPS. We don't currently use deep linking, but others do. I haven't had time to mock up a full demo implementation, but if there are specific things you have questions about, I'm happy to answer them.

I'm assuming you've seen it already, but if not we have some information in the wiki: https://github.com/packbackbooks/lti-1-3-php-library/wiki If you have suggestions of how to improve it, I'd love to hear them.

[battis]

Digging into the documentation, and I see that the the example implementation in the documentation refers to App\Models\Issuer and App\Models\Deployment -- which I infer an implementation needs to define? Is there guidance on what these models need to include?

[battis]

FWIW, I've been poking at this, the missing piece is really the model migrations for Issuer and Deployment. I'm still futzing with getting this up and running on Google App Engine (it's own special problem), but my notes from getting this set up so far, which I include here rather than editing the wiki because I have limited confidence:

Working from the Laravel impelementation guide:

curl -s "https://laravel.build/<lti-tool-name>" | bash
cd <lti-tool-name>
composer require packbackbooks/lti-1p3-tool firebase/php-jwt
rm app/Models/User.php
php artisan make:model Issuer --all

In database/migrations/<timestamp>_create_issuer_table.php in up():

$table->string('auth_token_url');
$table->string('auth_login_url');
$table->string('client_id');
$table->string('key_set_url');
$table->string('kid');
$table->string('issuer');
$table->string('tool_private_key');

php artisan make:model Deployment --all

In database/migrations/<timestamp>_create_deployment_table.php in up():

$table->string('deployment_id');

Copy-paste app/Providers/AppServiceProvider.php from wiki then add:

use Packback\Lti1p3\LtiServiceConnector;

Copy-paste app/Lti13Cache.php from wiki, then add:

use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Config;

Copy-paste app/Lti13Cookie.php from wiki:

Copy-paste app/Lti13Database.php from wiki.

mkdir app/Services

Copy-paste app/Services/Lti13Service.php from wiki.

Throughout, add namespaces as appropriate.

[dbhynds]

You'll probably want a foreign key from the Deployment to the Issuer. That way you can query on that relation, since there is almost guaranteed to be a collision in deployment_id if you have more than one instance of the same type of LMS integrating with your tool. You'll need to be able to do

// This:
$issuer->deployments()->where('deployment_id', $deploymentId)->first();
// Not this:
Deployment::where('deployment_id', $deploymentId)->first();

[datavoyager]

You'll probably want a foreign key from the Deployment to the Issuer. That way you can query on that relation, since there is almost guaranteed to be a collision in deployment_id if you have more than one instance of the same type of LMS integrating with your tool. You'll need to be able to do

// This:
$issuer->deployments()->where('deployment_id', $deploymentId)->first();
// Not this:
Deployment::where('deployment_id', $deploymentId)->first();

Can you let me know where this code goes? Is it in the issuer migration file or is it already part of the code base in findDeployment?

[battis]

FWIW, I got to the point where I actually really needed this to be working (rather than knowing that I would likely need it at some point in the future) and I've pulled together a set of shims to get this implemented using the Slim framework (my preferred app framework) and running on Google App Engine.

It's not terribly well-documented at the moment (although, cavalierly, I think "it should be easy to follow!"), but I've also set up a few app skeletons that can be created from composer. For example:

composer create-project --stability dev groton-school/slim-lti-skeleton

which creates a new project that is a Slim app that is an LTI Tool… but that still needs implementations of packbackbooks' IDatabase and ICache interfaces (which should also implement groton-school/slim-lti-shim's DatabaseInterface and CacheInterface). Examples of how I implemented those to use Firestore in the Google Cloud are are in groton-school/slim-lti-infrastructure-gae.

The more useful (to me) app skeleton is this:

composer create-project --ask --stability dev --repository "{\"type\":\"vcs\",\"url\":\"https://github.com/groton-school/slim-skeleton\"}" groton-school/slim-skeleton "dev-lti/gae"

Which creates a Slim app that is an LTI Tool that is ready to run out-of-the-box on Google App Engine. (Although it is not perfect.)

(edited to update changed URLs as a result of summer projects)