@windward/integrations 0.0.1

package/components/Integration/TestConnection.vue

@@ -0,0 +1,45 @@
+<template>
+    <div>
+        <v-btn
+            :disabled="disabled"
+            :loading="loading"
+            outlined
+            color="primary"
+            @click="$emit('click')"
+            >{{
+                $t(
+                    'windward.integrations.components.integration.driver.test_connection'
+                )
+            }}
+        </v-btn>
+
+        <v-alert v-if="errors" class="mt-5" color="error" icon="mdi-connection">
+            <p>
+                <strong>
+                    {{
+                        $t(
+                            'windward.integrations.components.integration.driver.connection_error'
+                        )
+                    }}
+                </strong>
+            </p>
+            <p>
+                <code>
+                    {{ errors }}
+                </code>
+            </p>
+        </v-alert>
+    </div>
+</template>
+
+<script>
+export default {
+    name: 'IntegrationTestConnection',
+    props: {
+        loading: { type: Boolean, required: false, default: false },
+        disabled: { type: Boolean, required: false, default: false },
+        errors: { type: String, required: false, default: '' },
+    },
+    emits: ['click'],
+}
+</script>

package/config/integration.config.js

@@ -0,0 +1,13 @@
+import Atutor from '../helpers/Driver/Atutor'
+
+export default {
+    /**
+     * Enabled Integrations
+     *
+     * Formatted {key}: DriverImport
+     * {key} is the question type name as it appears in the database's integration_vendors.product_code
+     */
+    integrationDrivers: {
+        atutor: { driver: Atutor },
+    },
+}

package/helpers/Driver/Atutor.ts

@@ -0,0 +1,12 @@
+// @ts-ignore
+import Manage from '../../components/Integration/Driver/ManageAtutor.vue'
+import DriverInterface, { IntegrationComponents } from './DriverInterface'
+import BaseDriver from './BaseDriver'
+
+export default class Atutor extends BaseDriver implements DriverInterface {
+    public components(): IntegrationComponents {
+        return {
+            Manage,
+        }
+    }
+}

package/helpers/Driver/BaseDriver.ts

@@ -0,0 +1,25 @@
+import DriverInterface, { IntegrationComponents } from './DriverInterface'
+
+export default class BaseDriver implements DriverInterface {
+    /**
+     * An object containing references to the various vue templates.
+     * This returns the typescript type IntegrationComponents { Manage }
+     *
+     * Manage: The template used by an editor to setup the integration
+     *
+     * @returns Object {Manage}
+     */
+    public components(): IntegrationComponents {
+        return {
+            Manage: {},
+        }
+    }
+
+    /**
+     * Helper function to get the manage component
+     * @returns Object The manage component
+     */
+    public getManageComponent(): any {
+        return this.components().Manage
+    }
+}

package/helpers/Driver/DriverInterface.ts

@@ -0,0 +1,7 @@
+export type IntegrationComponents = {
+    Manage: object
+}
+
+export default interface DriverInterface {
+    components(): IntegrationComponents
+}

package/helpers/IntegrationHelper.ts

@@ -0,0 +1,150 @@
+import _ from 'lodash'
+import Echo from 'laravel-echo'
+import Pusher from 'pusher-js'
+
+import Settings from '../config/integration.config'
+import Vendor from '../models/Vendor'
+
+export default class IntegrationHelper {
+    private _app: any
+    private _loaded: boolean
+    private _vendors: any = []
+    private _Pusher?: any
+    private _Echo?: Echo
+
+    constructor(app: any) {
+        this._app = app
+        this._loaded = false
+    }
+
+    /**
+     * Get the Laravel Echo socket
+     * This also initalizes a socket if not already connected and stores it as a singleton
+     *
+     * @returns {Echo} Singleton Laravel echo socket connection
+     */
+    public getSocket(): Echo {
+        // Only define _.Echo once
+        if (typeof this._Echo === 'undefined') {
+            this._Pusher = Pusher
+            // Set the API endpoint since laravel echo will attempt to use the current url aka ui for requests
+            // Also include the bearer token for auth
+            this._Echo = new Echo({
+                authEndpoint: process.env.BASE_URL + '/broadcasting/auth',
+                auth: {
+                    headers: {
+                        Authorization: this._app.$auth.strategy.token.get(),
+                    },
+                },
+                broadcaster: process.env.BROADCAST_DRIVER,
+                key: process.env.BROADCAST_KEY,
+                cluster: process.env.BROADCAST_CLUSTER,
+                wsHost: process.env.BROADCAST_HOST,
+                wsPort: process.env.BROADCAST_PORT,
+                wssPort: process.env.BROADCAST_PORT,
+                forceTLS:
+                    _.get(
+                        process.env,
+                        'BROADCAST_FORCE_TLS',
+                        ''
+                    ).toLowerCase() === 'true',
+                disableStats: true,
+            })
+        }
+
+        return this._Echo
+    }
+
+    /**
+     * Load the vendors from the database
+     *
+     * @return {Promise<void>}
+     */
+    public async load(): Promise<void> {
+        if (!this._loaded) {
+            // Be sure to only make the below await request once
+            this._loaded = true
+
+            // @ts-ignore
+            const vendors = await Vendor.where('enabled', true).get()
+
+            // Only add question types that exist both in the DB and in the assessment.config.js
+            Object.keys(Settings.integrationDrivers).forEach((driverName) => {
+                const vendor = vendors.find(
+                    (v: any) => v.product_code === driverName
+                )
+
+                if (vendor) {
+                    this._vendors.push(vendor)
+                }
+            })
+        }
+    }
+
+    /**
+     * Get all the enabled system vendors
+     *
+     * @returns {array} An array of the vendors
+     */
+    public getVendors() {
+        return _.cloneDeep(this._vendors)
+    }
+
+    /**
+     * The the vendor specific driver
+     *
+     * @param {string} _vendorId The vendor id from the Vendor model
+     * @returns {DriverInterface} Vendor specific instance of the DriverInterface
+     */
+    public getVendorDriver(_vendorId: String) {
+        const settings = this.getVendorConfig(_vendorId)
+
+        const Driver: any = settings.driver
+
+        if (Driver) {
+            return new Driver()
+        } else {
+            throw new TypeError(
+                `Could not determine assessment question driver for question type '${settings.vendor.product_code}' of id '${_vendorId}'`
+            )
+        }
+    }
+
+    /**
+     * Get the integration.config values for a specific vendor id
+     *
+     * @param {string} _vendorId The vendor id from the Vendor model
+     * @returns {object} The vendor configuration or TypeError if not found
+     */
+    public getVendorConfig(_vendorId: String) {
+        const vendorModel = this.getVendors().find(
+            (v: any) => v.id === _vendorId
+        )
+
+        const settings: any = _.get(
+            Settings.integrationDrivers,
+            vendorModel.product_code,
+            null
+        )
+
+        if (settings) {
+            settings.vendor = vendorModel
+            return settings
+        } else {
+            throw new TypeError(
+                `Could not determine vendor driver for question type '${vendorModel.product_code}' of id '${_vendorId}'`
+            )
+        }
+    }
+
+    /**
+     * Get the manage vue component for a specific vendor
+     *
+     * @param {string} _vendorId The vendor id from the Vendor model
+     * @returns {VueComponent} The drivers component
+     */
+    public getVendorManageComponent(_vendorId: String): any {
+        const driver = this.getVendorDriver(_vendorId)
+        return driver.getManageComponent()
+    }
+}

package/i18n/en-US/components/index.ts

@@ -0,0 +1,7 @@
+import navigation from './navigation'
+import integration from './integration'
+
+export default {
+    navigation,
+    integration,
+}

package/i18n/en-US/components/integration/driver.ts

@@ -0,0 +1,18 @@
+export default {
+    atutor: {
+        manage_dialog_title: 'Manage ATutor Driver',
+        url: 'ATutor API Url',
+        url_hint: 'Eg: https://atutor.mindedgecollege.com',
+        username: 'Username',
+        password: 'Password',
+        aws_secure_url: 'AWS CDN Url',
+        aws_secure_url_hint: 'Eg: https://cdn-d.mindedgecollege.com',
+    },
+    enabled: 'Integration Enabled',
+    disabled: 'Integration Disabled',
+    ssl_enabled: 'SSL Enabled (Should be enabled for production)',
+    connection_error: 'Connection Error',
+    test_connection: 'Test Connection',
+    id: 'Id',
+    base_url: 'Base Url',
+}

package/i18n/en-US/components/integration/index.ts

@@ -0,0 +1,7 @@
+import driver from './driver'
+import job from './job'
+
+export default {
+    driver,
+    job,
+}

package/i18n/en-US/components/integration/job.ts

@@ -0,0 +1,22 @@
+export default {
+    recent_jobs_title: 'Recent Import Jobs',
+    job_completed: 'Job Completed',
+    no_recent_jobs: 'No recent jobs',
+    job_id: 'Job Id',
+    vendor_name: 'Vendor Name',
+    status: 'Status',
+    progress: 'Progress',
+    created: 'Created',
+    details: 'Details',
+    job_details: {
+        none: 'No details available',
+        import_course: "Importing Course Id {0} '{1}'",
+    },
+    job_status: {
+        not_started: 'Not Started',
+        started: 'Started',
+        in_progress: 'In Progress',
+        failed: 'Failed',
+        completed: 'Completed',
+    },
+}

package/i18n/en-US/components/navigation/index.ts

@@ -0,0 +1,5 @@
+import integrations from './integrations'
+
+export default {
+    integrations,
+}

package/i18n/en-US/components/navigation/integrations.ts

@@ -0,0 +1,8 @@
+export default {
+    title: 'Integrations',
+    manage_integrations: 'Manage Integration Vendors',
+    import_course: 'Import Courses',
+    import_content: 'Import Content & Files',
+    manage_lti: 'Manage LTI Connections',
+    manage_lti_links: 'Manage LTI Links',
+}

package/i18n/en-US/index.ts

@@ -0,0 +1,16 @@
+import pages from './pages/index'
+import components from './components/index'
+import shared from './shared/index'
+import modules from './modules/index'
+
+export default {
+    windward: {
+        integrations: {
+            name: 'Windward Plugin Integrations',
+            pages,
+            components,
+            shared,
+            modules,
+        },
+    },
+}

package/i18n/en-US/modules/index.ts

@@ -0,0 +1,5 @@
+// import example from './example'
+
+export default {
+    // example,
+}

package/i18n/en-US/pages/importContent.ts

@@ -0,0 +1,3 @@
+export default {
+    title: 'Import Content',
+}

package/i18n/en-US/pages/importCourse.ts

@@ -0,0 +1,13 @@
+export default {
+    title: 'Import Course',
+    recent_import_title: 'Recent Imports',
+    select_vendor: 'Select a vendor',
+    select_remote_organization: 'Select a remote organization',
+    select_remote_course: 'Select a remote course',
+    select_remote_content: 'Select individual content pages',
+    start_import: 'Start Import',
+    import_started: 'Import Started',
+    notify: 'Notify me when completed',
+    no_vendors:
+        'There are no configured vendors. Please go back and configure an integration vendor',
+}

package/i18n/en-US/pages/index.ts

@@ -0,0 +1,9 @@
+import vendor from './vendor'
+import importCourse from './importCourse'
+import importContent from './importContent'
+
+export default {
+    vendor,
+    import_course: importCourse,
+    import_content: importContent,
+}

package/i18n/en-US/pages/vendor.ts

@@ -0,0 +1,11 @@
+export default {
+    title: 'Integrations',
+    vendor_disabled: 'This vendor is not available for integrations',
+    vendor_not_configured: 'This integration vendor is not configured',
+    organization_integration_disabled:
+        'This organization integration is disabled',
+    vendor_name: 'Vendor Name',
+    configured: 'Integration Configured',
+    enabled: 'Integration Enabled',
+    manage: 'Manage Integration',
+}

package/i18n/en-US/shared/error.ts

@@ -0,0 +1,8 @@
+export default {
+    save_failed: 'Could not save this configuration',
+    load_remote_organization_failed: 'Could not load remote organizations',
+    load_remote_course_failed: 'Could not load remote courses',
+    load_remote_content_failed: 'Could not load remote content',
+    connect_success: 'Successfully connected',
+    connect_fail: 'Failed to connect',
+}

package/i18n/en-US/shared/index.ts

@@ -0,0 +1,11 @@
+import settings from './settings'
+import menu from './menu'
+import permission from './permission'
+import error from './error'
+
+export default {
+    settings,
+    menu,
+    permission,
+    error,
+}

package/i18n/en-US/shared/menu.ts

@@ -0,0 +1,3 @@
+export default {
+    integrations: 'Integrations',
+}

package/i18n/en-US/shared/permission.ts

@@ -0,0 +1,26 @@
+export default {
+    type_title: {
+        'plugin->windward->integrations->vendor': 'Integration Vendors',
+        'plugin->windward->integrations->jobs': 'Integration Jobs',
+        'plugin->windward->integrations->organization->jobs':
+            'Organization Integration Jobs',
+        'plugin->windward->integrations->organization->integration':
+            'Organization Integrations',
+        'plugin->windward->integrations->course': 'Course Integrations',
+        'plugin->windward->integrations->content': 'Content Integrations',
+    },
+
+    type_description: {
+        'plugin->windward->integrations->vendor':
+            'Access all integration vendors across the whole system',
+        'plugin->windward->integrations->jobs': 'Access integration jobs',
+        'plugin->windward->integrations->organization->jobs':
+            'Access integration jobs in the current organization',
+        'plugin->windward->integrations->organization->integration':
+            'Access and manage integrations in the current organization',
+        'plugin->windward->integrations->course':
+            'Access and manage course imports',
+        'plugin->windward->integrations->content':
+            'Access and manage content imports',
+    },
+}

package/i18n/en-US/shared/settings.ts

@@ -0,0 +1 @@
+export default {}

package/jest.config.js

@@ -0,0 +1,17 @@
+module.exports = {
+    moduleNameMapper: {
+        '^@/(.*)$': '<rootDir>/$1',
+        '^vue$': 'vue/dist/vue.common.js',
+        '\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$':
+            '<rootDir>/node_modules/@windward/core/test/__mocks__/fileMock.js',
+        '\\.(css|less)$':
+            '<rootDir>/node_modules/@windward/core/test/__mocks__/styleMock.js',
+    },
+    moduleFileExtensions: ['ts', 'js', 'vue', 'json'],
+    transformIgnorePatterns: ['node_modules/(?!@ngrx|(?!deck.gl)|ng-dynamic)'],
+    transform: {
+        '^.+\\.ts$': 'ts-jest',
+        '^.+\\.js$': 'babel-jest',
+        '.*\\.(vue)$': 'vue-jest',
+    },
+}

package/models/CourseSectionIntegration.ts

@@ -0,0 +1,12 @@
+import Model from '~/models/Model'
+
+export default class CourseSectionIntegration extends Model {
+    get required(): string[] {
+        return []
+    }
+
+    // Set the resource route of the model
+    resource() {
+        return 'section-integrations'
+    }
+}

package/models/IntegrationJob.ts

@@ -0,0 +1,12 @@
+import Model from '~/models/Model'
+
+export default class IntegrationJob extends Model {
+    get required(): string[] {
+        return []
+    }
+
+    // Set the resource route of the model
+    resource() {
+        return 'integration-jobs'
+    }
+}

package/models/Organization.ts

@@ -0,0 +1,14 @@
+import Model from '~/models/Model'
+import BaseOrganization from '~/models/Organization'
+import IntegrationJob from './IntegrationJob'
+import OrganizationIntegration from './OrganizationIntegration'
+
+export default class Organization extends BaseOrganization {
+    integrations() {
+        return this.hasMany(OrganizationIntegration)
+    }
+
+    integrationJobs() {
+        return this.hasMany(IntegrationJob)
+    }
+}

package/models/OrganizationIntegration.ts

@@ -0,0 +1,17 @@
+import Model from '~/models/Model'
+import RemoteOrganization from './RemoteOrganization'
+
+export default class OrganizationIntegration extends Model {
+    get required(): string[] {
+        return []
+    }
+
+    // Set the resource route of the model
+    resource() {
+        return 'organization-integrations'
+    }
+
+    remoteOrganizations() {
+        return this.hasMany(RemoteOrganization)
+    }
+}

package/models/RemoteContent.ts

@@ -0,0 +1,12 @@
+import Model from '~/models/Model'
+
+export default class RemoteContent extends Model {
+    get required(): string[] {
+        return []
+    }
+
+    // Set the resource route of the model
+    resource() {
+        return 'remote-content'
+    }
+}

package/models/RemoteCourse.ts

@@ -0,0 +1,17 @@
+import Model from '~/models/Model'
+import RemoteContent from './RemoteContent'
+
+export default class RemoteCourse extends Model {
+    get required(): string[] {
+        return []
+    }
+
+    // Set the resource route of the model
+    resource() {
+        return 'remote-courses'
+    }
+
+    remoteContent() {
+        return this.hasMany(RemoteContent)
+    }
+}

package/models/RemoteOrganization.ts

@@ -0,0 +1,17 @@
+import Model from '~/models/Model'
+import RemoteCourse from './RemoteCourse'
+
+export default class RemoteOrganization extends Model {
+    get required(): string[] {
+        return []
+    }
+
+    // Set the resource route of the model
+    resource() {
+        return 'remote-organizations'
+    }
+
+    remoteCourses() {
+        return this.hasMany(RemoteCourse)
+    }
+}

package/models/Vendor.ts

@@ -0,0 +1,12 @@
+import Model from '~/models/Model'
+
+export default class Vendor extends Model {
+    get required(): string[] {
+        return []
+    }
+
+    // Set the resource route of the model
+    resource() {
+        return 'integration-vendors'
+    }
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+    "name": "@windward/integrations",
+    "version": "0.0.1",
+    "description": "Windward UI Plugin Integrations for 3rd Party Systems",
+    "main": "plugin.js",
+    "scripts": {
+        "test": "jest",
+        "lint:js": "eslint --ext \".js,.vue\" --ignore-path .gitignore .",
+        "build": "tsc"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+ssh://git@bitbucket.org:mindedge/windward-ui-plugin-integrations.git"
+    },
+    "author": "Jacob Rogaishio",
+    "license": "MIT",
+    "homepage": "https://bitbucket.org/mindedge/windward-ui-plugin-integrations#readme",
+    "dependencies": {
+        "@windward/core": "^0.0.2",
+        "canvas-confetti": "^1.6.0",
+        "eslint": "^8.11.0",
+        "laravel-echo": "^1.15.0",
+        "prettier": "^2.6.0",
+        "pusher-js": "^8.0.1"
+    },
+    "devDependencies": {
+        "@babel/preset-env": "^7.16.11",
+        "@nuxtjs/axios": "^5.13.6",
+        "@nuxtjs/eslint-config-typescript": "^12.0.0",
+        "@types/lodash": "^4.14.180",
+        "@vue/test-utils": "^1.1.3",
+        "babel-core": "^7.0.0-bridge.0",
+        "babel-jest": "^26.6.3",
+        "eslint-config-prettier": "^8.5.0",
+        "eslint-plugin-nuxt": "^3.2.0",
+        "eslint-plugin-prettier": "^4.0.0",
+        "jest": "^26.6.3",
+        "ts-jest": "^26.5.6",
+        "typescript": "^4.6.3",
+        "vue-api-query": "^1.11.0",
+        "vue-jest": "^3.0.7",
+        "vuetify": "^2.6.4"
+    }
+}