@windward/integrations 0.0.5 → 0.0.7

package/components/Content/Blocks/ExternalIntegration/LtiConsumer.vue

@@ -0,0 +1,205 @@
+<template>
+    <div>
+        <div v-if="!missing && consumer">
+            <h1>{{ consumer.name }}</h1>
+            <TextViewer v-model="consumer.description"></TextViewer>
+
+            <v-btn
+                v-if="consumer.enabled"
+                color="primary"
+                block
+                @click="onLaunch"
+            >
+                <v-icon>mdi-launch</v-icon>
+                {{
+                    $t(
+                        'windward.integrations.components.content.blocks.external_integration.lti_consumer.launch',
+                        [block.metadata.config.tool_id]
+                    )
+                }}
+            </v-btn>
+
+            <v-alert v-if="!consumer.enabled" type="error">
+                {{
+                    $t(
+                        'windward.integrations.components.content.blocks.external_integration.lti_consumer.link_disabled'
+                    )
+                }}
+            </v-alert>
+
+            <v-form
+                ref="ltiForm"
+                name="ltiForm"
+                :target="target"
+                :action="launchData.target || ''"
+                :method="launchData.method || 'POST'"
+            >
+                <input
+                    v-for="(value, key) of launchData.payload"
+                    :key="key"
+                    type="hidden"
+                    :name="key"
+                    :value="value"
+                />
+            </v-form>
+            <iframe
+                v-if="
+                    block.metadata.config.launch_type === 'inline' &&
+                    !!launchData.target
+                "
+                :name="frameId"
+                class="launch-frame"
+            ></iframe>
+        </div>
+
+        <v-alert v-if="missing" type="error">
+            {{
+                $t(
+                    'windward.integrations.components.content.blocks.external_integration.lti_consumer.missing_tool',
+                    [block.metadata.config.tool_id]
+                )
+            }}
+        </v-alert>
+        <v-alert v-else-if="consumer === null" type="warning">
+            {{
+                $t(
+                    'windward.integrations.components.content.blocks.external_integration.lti_consumer.configure_warning'
+                )
+            }}
+        </v-alert>
+    </div>
+</template>
+
+<script>
+import _ from 'lodash'
+import { mapGetters } from 'vuex'
+import Crypto from '~/helpers/Crypto'
+import TextViewer from '~/components/Text/TextViewer.vue'
+import BaseContentBlock from '~/components/Content/Blocks/BaseContentBlock'
+import Course from '~/models/Course'
+import Organization from '~/models/Organization'
+import Enrollment from '~/models/Enrollment'
+import Lti1p1Consumer from '../../../../models/ExternalIntegration/Lti1p1Consumer'
+
+export default {
+    name: 'ContentBlockExternalIntegrationLti1p1Consumer',
+    components: { TextViewer },
+    extends: BaseContentBlock,
+    data() {
+        return {
+            consumer: null,
+            launchData: {},
+            saveState: false, // Override the base block to disable state saving
+            target: '_blank',
+            frameId: Crypto.id() + '_frame',
+            missing: false,
+            launched: false,
+        }
+    },
+    async fetch() {
+        this.target = this.frameId
+        await this.loadConsumer()
+    },
+    computed: {
+        ...mapGetters({
+            organization: 'organization/get',
+            course: 'course/get',
+            enrollment: 'enrollment/get',
+        }),
+    },
+    watch: {
+        'block.metadata.config.tool_id': {
+            deep: true,
+            handler(newVal, oldVal) {
+                // We changed the consumer tool id, reload
+                if (newVal !== oldVal) {
+                    this.loadConsumer()
+                }
+            },
+        },
+    },
+    beforeMount() {
+        if (_.isEmpty(this.block.metadata.config)) {
+            this.block.metadata.config = {}
+        }
+        if (_.isEmpty(this.block.metadata.config.tool_id)) {
+            this.block.metadata.config.tool_id = null
+        }
+    },
+    mounted() {},
+    methods: {
+        async loadConsumer() {
+            try {
+                if (!_.isEmpty(this.block.metadata.config.tool_id)) {
+                    this.consumer = await new Lti1p1Consumer()
+                        .for(
+                            new Organization({ id: this.organization.id }),
+                            new Course({ id: this.course.id })
+                        )
+                        .find(this.block.metadata.config.tool_id)
+                } else {
+                    this.consumer = null
+                }
+                this.missing = false
+            } catch (e) {
+                // Data conflict error
+                if (e.response.status === 404) {
+                    this.missing = true
+                }
+            }
+        },
+        async onLaunch() {
+            try {
+                // Clear the launch data in-case we're in inline mode
+                // If the iframe isn't destroyed subsequent launches will be new windows instead of the target iframe
+                this.launchData = {}
+
+                this.launchData = await Lti1p1Consumer.custom(
+                    new Enrollment({ id: this.enrollment.id }),
+                    this.consumer,
+                    '/launch'
+                ).first()
+
+                switch (this.block.metadata.config.launch_type) {
+                    case 'new_window':
+                        this.target = '_blank'
+                        break
+                    case 'inline':
+                        this.target = this.frameId
+                        break
+                    default:
+                        this.target = '_blank'
+                }
+
+                // Do a forceUpdate so the hidden fields are ready and available for the post below
+                await this.$forceUpdate()
+
+                if (!_.isEmpty(this.launchData)) {
+                    this.$refs.ltiForm.$el.submit()
+                    this.launched = true
+                } else {
+                    this.$dialog.error(
+                        this.$t(
+                            'windward.integrations.components.content.blocks.external_integration.lti_consumer.unknown_error'
+                        )
+                    )
+                }
+            } catch (e) {
+                // eslint-disable-next-line no-console
+                console.error('LTI Link Launch Fail', e)
+            }
+        },
+        onBeforeSave() {
+            // Set a generic body since we don't use this field
+            this.block.body = 'lti-' + this.consumer.version + '-consumer'
+        },
+    },
+}
+</script>
+
+<style scoped>
+.launch-frame {
+    aspect-ratio: 16/9;
+    width: 100%;
+}
+</style>

package/components/ExternalIntegration/Driver/Lti1p1/ManageConsumer.vue

@@ -1,13 +1,294 @@
 <template>
-    <div>LTI 1.1 Consumers Not Implemented yet</div>
+    <div>
+        <div v-if="!render" class="integration-loading">
+            <v-progress-circular size="128" indeterminate />
+        </div>
+        <div v-if="render">
+            <v-form v-model="formValid" @submit.prevent>
+                <v-row justify="center" align="center" class="mt-5">
+                    <v-col cols="12">
+                        <v-text-field
+                            v-model="consumer.target"
+                            :label="
+                                $t(
+                                    'windward.integrations.components.external_integration.driver.lti1p1.target_url'
+                                )
+                            "
+                            :hint="
+                                $t(
+                                    'windward.integrations.components.external_integration.driver.lti1p1.target_url'
+                                )
+                            "
+                        ></v-text-field>
+                        <v-text-field
+                            v-model="consumer.name"
+                            :placeholder="$t('shared.forms.name')"
+                            :label="$t('shared.forms.name')"
+                            :hint="$t('shared.forms.name')"
+                        ></v-text-field>
+
+                        <label for="description">{{
+                            $t('shared.forms.description')
+                        }}</label>
+                        <TextEditor
+                            id="description"
+                            v-model="consumer.description"
+                            :height="200"
+                        ></TextEditor>
+
+                        <v-switch
+                            v-model="consumer.enabled"
+                            :label="
+                                $t(
+                                    'windward.integrations.components.external_integration.driver.lti1p1.enabled'
+                                )
+                            "
+                        />
+
+                        <v-text-field
+                            v-model="consumer.metadata.key"
+                            :placeholder="
+                                $t(
+                                    'windward.integrations.components.external_integration.driver.lti1p1.' +
+                                        (consumer.id ? 'new_key' : 'key')
+                                )
+                            "
+                            :label="
+                                $t(
+                                    'windward.integrations.components.external_integration.driver.lti1p1.' +
+                                        (consumer.id ? 'change_key' : 'key')
+                                )
+                            "
+                        ></v-text-field>
+
+                        <v-text-field
+                            v-model="consumer.metadata.secret"
+                            :placeholder="
+                                $t(
+                                    'windward.integrations.components.external_integration.driver.lti1p1.' +
+                                        (consumer.id ? 'new_secret' : 'secret')
+                                )
+                            "
+                            :label="
+                                $t(
+                                    'windward.integrations.components.external_integration.driver.lti1p1.' +
+                                        (consumer.id
+                                            ? 'change_secret'
+                                            : 'secret')
+                                )
+                            "
+                        >
+                        </v-text-field>
+
+                        <v-data-table
+                            :headers="customParameterHeaders"
+                            :items="consumer.metadata.custom"
+                            hide-default-footer
+                            class="elevation-1"
+                        >
+                            <template #[`item.key`]="{ index }">
+                                <v-text-field
+                                    v-model="
+                                        consumer.metadata.custom[index].key
+                                    "
+                                    :label="
+                                        $t(
+                                            'windward.integrations.components.external_integration.driver.lti1p1.parameter_name'
+                                        )
+                                    "
+                                />
+                            </template>
+                            <template #[`item.value`]="{ index }">
+                                <v-text-field
+                                    v-model="
+                                        consumer.metadata.custom[index].value
+                                    "
+                                    :label="
+                                        $t(
+                                            'windward.integrations.components.external_integration.driver.lti1p1.value'
+                                        )
+                                    "
+                                />
+                            </template>
+                            <template #[`item.actions`]="{ index }">
+                                <v-btn
+                                    text
+                                    color="primary"
+                                    @click="deleteCustomParameter(index)"
+                                >
+                                    <v-icon small> mdi-delete </v-icon>
+                                    <span class="sr-only">{{
+                                        $t('shared.forms.delete')
+                                    }}</span>
+                                </v-btn>
+                            </template>
+                            <template #footer>
+                                <div class="text-center">
+                                    <v-btn
+                                        color="primary"
+                                        class="mb-3"
+                                        @click="addCustomParameter"
+                                        >{{ $t('shared.forms.add') }}</v-btn
+                                    >
+                                </div>
+                            </template>
+                        </v-data-table>
+                        <br />
+                        <v-select
+                            v-model="consumer.metadata.security_level"
+                            :items="securityLevels"
+                            item-text="name"
+                            item-value="value"
+                            label="Security Level"
+                            outlined
+                        ></v-select>
+                    </v-col>
+                </v-row>
+            </v-form>
+        </div>
+    </div>
 </template>
 
 <script>
+import _ from 'lodash'
+import { mapGetters } from 'vuex'
+import Organization from '~/models/Organization'
+import Course from '~/models/Course'
+import TextEditor from '~/components/Text/TextEditor.vue'
+import Lti1p1Consumer from '../../../../models/ExternalIntegration/Lti1p1Consumer'
+import FormVue from '~/components/Form'
+
 export default {
     name: 'ManageLti1p1ConsumerDriver',
+    components: { TextEditor },
+    extends: FormVue,
+    props: {
+        value: {
+            type: [Lti1p1Consumer, null],
+            required: false,
+            default: null,
+        },
+    },
+    emits: ['update:consumer'],
+    meta: {
+        privilege: {
+            '': {
+                writable: true,
+            },
+        },
+    },
     data() {
-        return {}
+        return {
+            render: false,
+            consumer: {
+                metadata: {
+                    custom: [],
+                    security_level: '',
+                    security: [],
+                },
+            },
+            customParameterHeaders: [
+                {
+                    text: this.$t(
+                        'windward.integrations.components.external_integration.driver.lti1p1.parameter_name'
+                    ),
+                    value: 'key',
+                },
+                {
+                    text: this.$t(
+                        'windward.integrations.components.external_integration.driver.lti1p1.value'
+                    ),
+                    value: 'value',
+                },
+                {
+                    text: this.$t('shared.forms.actions'),
+                    value: 'actions',
+                    sortable: false,
+                },
+            ],
+            securityLevels: [
+                { name: 'Full Access', value: 'full' },
+                { name: 'Email Only', value: 'email' },
+                { name: 'Name Only', value: 'name' },
+                { name: 'Anonymous', value: 'anonymous' },
+                // { name: 'Custom', value: 'custom' }, // TODO: When this is selected provide direct access to check off LTI fields
+            ],
+        }
+    },
+    computed: {
+        ...mapGetters({
+            organization: 'organization/get',
+            course: 'course/get',
+        }),
+    },
+    created() {
+        if (_.isEmpty(this.value)) {
+            this.consumer = new Lti1p1Consumer(this.consumer)
+        } else {
+            this.consumer = new Lti1p1Consumer(_.cloneDeep(this.value))
+        }
+    },
+    mounted() {
+        if (
+            !this.$PermissionService.userHasAccessTo(
+                'plugin.windward.integrations.course.externalIntegration',
+                'writable'
+            )
+        ) {
+            // Display an angry error that they can't view this driver
+            this.$dialog.error(this.$t('shared.error.description_401'), {
+                duration: null,
+                action: {
+                    text: this.$t('shared.forms.close'),
+                    onClick: (_e, toastObject) => {
+                        toastObject.goAway(0)
+                    },
+                },
+            })
+
+            // eslint-disable-next-line no-console
+            console.error('You do not have access to this consumer!')
+
+            // Return so we don't even attempt loading
+            return false
+        }
+
+        this.render = true
+    },
+    methods: {
+        addCustomParameter() {
+            this.consumer.metadata.custom.push({ key: '', value: '' })
+        },
+        deleteCustomParameter(index) {
+            this.consumer.metadata.custom.splice(index, 1)
+        },
+        async save() {
+            let consumer = new Lti1p1Consumer(this.consumer).for(
+                new Organization({ id: this.organization.id }),
+                new Course({ id: this.course.id })
+            )
+
+            try {
+                consumer = await consumer.save()
+                this.consumer = consumer
+
+                // Clone and delete the metadata since we don't need to share that around
+                // Also include the vendor going back for easier mapping
+                const consumerEvent = _.cloneDeep(consumer)
+
+                this.$dialog.success(this.$t('shared.forms.saved'))
+                this.$emit('update:consumer', consumerEvent)
+            } catch (e) {
+                this.$dialog.error(
+                    this.$t('windward.integrations.shared.error.save_failed')
+                )
+            }
+        },
+        async onSave() {
+            if (this.formValid) {
+                await this.save()
+            }
+        },
     },
-    methods: {},
 }
 </script>