Merge pull request #69 from anpolimus/telemetry

Virtual tracking

.phpcs.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <ruleset name="openy_gated_content">
-  <description>PHP Code Sniffer configuration for Open Y Gated Content.</description>
+  <description>PHP Code Sniffer configuration for Open Y Virtual Y Content.</description>
   <arg name="colors" />
   <arg value="s" />
   <rule ref="Drupal">

README.md

@@ -1,4 +1,4 @@
-# Open Y Gated content
+# Open Y Virtual Y content
 
 ## Development
 

SUMMARY.md

@@ -1,11 +1,11 @@
 # Table of contents
 
-* [Open Y Gated content](README.md)
+* [Open Y Virtual Y content](README.md)
 * [modules](modules/README.md)
   * [openy\_gc\_auth](modules/openy_gc_auth/README.md)
     * [modules](modules/openy_gc_auth/modules/README.md)
       * [README](modules/openy_gc_auth/modules/openy_gc_auth_custom.md)
-      * [Open Y Gated Content Personify SSO Auth.][1]
+      * [Open Y Virtual Y Content Personify SSO Auth.][1]
       * [README](modules/openy_gc_auth/modules/openy_gc_auth_daxko_sso.md)
 * [js](js/README.md)
   * [gated-content](js/gated-content.md)

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "ymcatwincities/openy_gated_content",
-    "description": "Open Y Gated Content",
+    "description": "Open Y Virtual Y Content",
     "type": "drupal-module",
     "require": {
         "drupal/recurring_events": "*",

config/install/field.field.paragraph.gated_content_login.field_link_to_gated_content_app.yml

@@ -15,7 +15,7 @@ id: paragraph.gated_content_login.field_link_to_gated_content_app
 field_name: field_link_to_gated_content_app
 entity_type: paragraph
 bundle: gated_content_login
-label: 'Link to Gated Content App'
+label: 'Link to Virtual Y Content App'
 description: 'The page user sent after signed in.'
 required: true
 translatable: false

config/install/paragraphs.paragraphs_type.gated_content.yml

@@ -2,7 +2,7 @@ langcode: en
 status: true
 dependencies: {  }
 id: gated_content
-label: 'Gated Content'
+label: 'Virtual Y Content'
 icon_uuid: null
-description: 'Open Y Gated content'
+description: 'Open Y Virtual Y content'
 behavior_plugins: {  }

config/install/paragraphs.paragraphs_type.gated_content_login.yml

@@ -2,7 +2,7 @@ langcode: en
 status: true
 dependencies: {  }
 id: gated_content_login
-label: 'Gated Content Login'
+label: 'Virtual Y Content Login'
 icon_uuid: null
 description: ''
 behavior_plugins: {  }

js/gated-content/src/main.js

@@ -3,6 +3,9 @@ import App from './GatedContent.vue';
 import router from './router';
 import store from './store';
 import filters from './filters';
+import Log from './plugins/log';
+
+Vue.use(Log);
 
 Vue.config.productionTip = false;
 

js/gated-content/src/plugins/log.js

@@ -0,0 +1,34 @@
+import store from '@/store';
+
+const Log = {
+  // eslint-disable-next-line no-unused-vars
+  install(Vue, options) {
+    // eslint-disable-next-line no-param-reassign
+    Vue.prototype.$log = {
+      trackEventLoggedIn(user) {
+        const event = new CustomEvent('virtual-y-log', {
+          detail: {
+            event_type: 'userLoggedIn',
+            email: 'email' in user ? user.email : 'dummy',
+          },
+        });
+        document.body.dispatchEvent(event);
+      },
+      trackEventEntityView(entityType, entityBundle, entityId) {
+        const user = store.getters.getUser;
+        const event = new CustomEvent('virtual-y-log', {
+          detail: {
+            email: 'email' in user ? user.email : 'dummy',
+            event_type: 'entityView',
+            entity_type: entityType,
+            entity_bundle: entityBundle,
+            entity_id: entityId,
+          },
+        });
+        document.body.dispatchEvent(event);
+      },
+    };
+  },
+};
+
+export default Log;

js/gated-content/src/store/modules/auth.js

@@ -1,3 +1,5 @@
+import Vue from 'vue';
+
 export default {
   state: {
     authPlugin: 'dummy',
@@ -10,6 +12,7 @@ export default {
   actions: {
     authorize(context, user) {
       context.commit('setUser', user);
+      Vue.prototype.$log.trackEventLoggedIn(user);
     },
     logout(context) {
       context.commit('unsetUser');
@@ -41,5 +44,6 @@ export default {
     isLoggedIn: (state) => state.loggedIn,
     authPlugin: (state) => state.authPlugin,
     getAppUrl: (state) => state.appUrl,
+    getUser: (state) => state.user,
   },
 };

js/gated-content/src/views/BlogPage.vue

@@ -89,6 +89,8 @@ export default {
         .then((response) => {
           this.blog = this.combine(response.data.data, response.data.included, this.params);
           this.loading = false;
+        }).then(() => {
+          this.$log.trackEventEntityView('node', 'vy_blog_post', this.blog.attributes.drupal_internal__nid);
         })
         .catch((error) => {
           this.error = true;

js/gated-content/src/views/LiveStreamPage.vue

@@ -152,6 +152,8 @@ export default {
             });
           }
           this.loading = false;
+        }).then(() => {
+          this.$log.trackEventEntityView('series', 'live_stream', this.video.attributes.drupal_internal__id);
         })
         .catch((error) => {
           this.error = true;

js/gated-content/src/views/VideoPage.vue

@@ -125,6 +125,8 @@ export default {
         .then((response) => {
           this.video = this.combine(response.data.data, response.data.included, this.params);
           this.loading = false;
+        }).then(() => {
+          this.$log.trackEventEntityView('node', 'gc_video', this.video.attributes.drupal_internal__nid);
         })
         .catch((error) => {
           this.error = true;

js/gated-content/src/views/VirtualMeetingPage.vue

@@ -178,6 +178,8 @@ export default {
             });
           }
           this.loading = false;
+        }).then(() => {
+          this.$log.trackEventEntityView('series', 'virtual_meeting', this.video.attributes.drupal_internal__id);
         })
         .catch((error) => {
           this.error = true;

modules/openy_gc_auth/modules/openy_gc_auth_custom/README.md

@@ -79,11 +79,11 @@ drush mim gc_auth_custom_users --sync=TRUE
 
 ### How to upload source file
 
-You can upload source file directly t0 private://gc_auth/import
-File name should be gc_auth_custom_users.csv
+You can upload source file directly to `private://gc_auth/import/gc_auth_custom_users.csv`.
 
-Or you can upload file from UI in migration group settings, for example:
-- /admin/structure/migrate/manage/gc_auth
+OR
+
+You can upload file from the Drupal UI in Migration Group settings at `/admin/structure/migrate/manage/gc_auth`.
 
 ## Notes:
 

modules/openy_gc_auth/modules/openy_gc_auth_custom/openy_gc_auth_custom.info.yml

@@ -4,6 +4,7 @@ description: 'Provides Open Y Virtual YMCA custom authentication provider based
 package: Open Y Virtual YMCA
 version: 0.1
 core: 8.x
+core_version_requirement: ^8 || ^9
 dependencies:
   - drupal:migrate
   - drupal:migrate_source_csv

modules/openy_gc_auth/modules/openy_gc_auth_daxko_sso.md

@@ -25,7 +25,7 @@ It consists of Daxko SSO plugin and requires
 
 5. Set Daxko SSO as your main authorization plugin
 
-   at the Gated Content settings: /admin/openy/openy-gc-auth/settings
+   at the Virtual Y Content settings: /admin/openy/openy-gc-auth/settings
 
 ## I need help.
 

modules/openy_gc_auth/modules/openy_gc_auth_daxko_sso/openy_gc_auth_daxko_sso.info.yml

@@ -4,6 +4,7 @@ description: 'Daxko integration for Virtual YMCA'
 package: Open Y Virtual YMCA
 version: 0.1
 core: 8.x
+core_version_requirement: ^8 || ^9
 dependencies:
   - drupal:daxko_sso
   - drupal:openy_gc_auth

modules/openy_gc_auth/modules/openy_gc_auth_example/openy_gc_auth_example.info.yml

@@ -4,5 +4,6 @@ description: 'Provides Open Y Virtual YMCA dummy authentication provider.'
 package: Open Y Virtual YMCA
 version: 0.1
 core: 8.x
+core_version_requirement: ^8 || ^9
 dependencies:
   - drupal:openy_gc_auth

modules/openy_gc_auth/modules/openy_gc_auth_personify.md

@@ -1,6 +1,6 @@
-# Open Y Gated Content Personify SSO Auth.
+# Open Y Virtual Y Content Personify SSO Auth.
 
-Provides Open Y Gated Content Personify SSO authentication provider
+Provides Open Y Virtual Y Content Personify SSO authentication provider
 based on Personify module.
 
 ## Integration with Personify

modules/openy_gc_auth/modules/openy_gc_auth_personify/openy_gc_auth_personify.info.yml

@@ -4,6 +4,7 @@ description: 'Provides Open Y Virtual YMCA Personify SSO authentication provider
 package: Open Y Virtual YMCA
 version: 0.1
 core: 8.x
+core_version_requirement: ^8 || ^9
 dependencies:
   - drupal:openy_gc_auth
   - drupal:personify

modules/openy_gc_auth/openy_gc_auth.info.yml

@@ -4,3 +4,4 @@ description: 'Provides Open Y Virtual YMCA authentication provider.'
 package: Open Y Virtual YMCA
 version: 0.1
 core: 8.x
+core_version_requirement: ^8 || ^9

modules/openy_gc_demo/openy_gc_demo.info.yml

@@ -4,6 +4,7 @@ description: 'Provides a Landing page node for development purposes.'
 package: Open Y Virtual YMCA
 version: 0.1
 core: 8.x
+core_version_requirement: ^8 || ^9
 dependencies:
   - drupal:migrate
   - drupal:openy_migrate