send plugin version (#130)

* send plugin version

* update gitignore

Author: eredi93

.gitignore

@@ -1,4 +1,8 @@
 *.swo
 *.swp
 intercom-wordpress.zip
-.gitignore
+.idea
+.vscode
+.DS_Store
+.phpunit.result.cache
+.phpunit.cache

bootstrap.php

@@ -5,9 +5,11 @@
 Description: Official <a href="https://www.intercom.io">Intercom</a> support for WordPress.
 Author: Intercom
 Author URI: https://www.intercom.io
-Version: 3.0.0
+Version: 3.0.1
  */
 
+define('INTERCOM_PLUGIN_VERSION', '3.0.1');
+
 require_once __DIR__ . '/vendor/autoload.php';
 use Firebase\JWT\JWT;
 
@@ -404,6 +406,7 @@ private function getRawData()
     $settings = $messengerSecurityCalculator->messengerSecurityComponent();
     $result = $this->mergeConstants(apply_filters("intercom_settings", $settings));
     $result['installation_type'] = 'wordpress';
+    $result['integration_version'] = INTERCOM_PLUGIN_VERSION;
     return $result;
   }
 
@@ -586,9 +589,9 @@ function intercom_settings() {
 }
 
 if (getenv('INTERCOM_PLUGIN_TEST') != '1') {
-  //Add in priority to load the snippet last
-  add_action('wp_footer', 'add_intercom_snippet', 999);
   add_action('admin_menu', 'add_intercom_settings_page');
   add_action('network_admin_menu', 'add_intercom_settings_page');
   add_action('admin_init', 'intercom_settings');
+  // Add in priority to load the snippet last
+  add_action('wp_footer', 'add_intercom_snippet', 999);
 }

readme.txt

@@ -5,7 +5,7 @@ Requires at least: 4.7.0
 Tested up to: 6.7.2
 Requires PHP: 7.2
 License: Apache 2.0
-Stable tag: 3.0.0
+Stable tag: 3.0.1
 
 Official Intercom WordPress plugin: Engage visitors in real time, power growth with AI, and convert leads into loyal customers.
 
@@ -32,13 +32,25 @@ Note: This plugin injects a Javascript snippet on your website frontend containi
 2. Plugin settings successfully authenticated with Intercom settings_auth.png
 3. Intercom widget used by customers to communicate with the business widget.png
 == Changelog ==
+= 3.0.1 =
+
+https://github.com/intercom/intercom-wordpress/pull/130
+* Added version tracking to help Intercom provide better support by identifying which plugin version is in use.
+
+https://github.com/intercom/intercom-wordpress/pull/88
+* Loads Intercom messenger last to ensure JQuery is present. 
 
 = 3.0.0 =
+
+https://github.com/intercom/intercom-wordpress/pull/127
 * Replaced user_hash with intercom_user_jwt https://www.intercom.com/help/en/articles/10589769-authenticating-users-in-the-messenger-with-json-web-tokens-jwts.
 * Updated readme to follow guidelines.
 * Added missing tests.
 
 == Upgrade Notice ==
 
+= 3.0.1 =
+Help Intercom provide better support by sharing the plugin version is in use.
+
 = 3.0.0 =
 Upgrade the security of your messenger with the introduction of JWT - https://www.intercom.com/help/en/articles/10589769-authenticating-users-in-the-messenger-with-json-web-tokens-jwts

test/SnippetSettingsTest.php

@@ -26,7 +26,7 @@ protected function tearDown(): void
   public function testJSONRendering()
   {
     $snippet_settings = new IntercomSnippetSettings(array("app_id" => "bar"));
-    $this->assertEquals("{\"app_id\":\"bar\",\"installation_type\":\"wordpress\"}", $snippet_settings->json());
+    $this->assertEquals("{\"app_id\":\"bar\",\"installation_type\":\"wordpress\",\"integration_version\":\"" . INTERCOM_PLUGIN_VERSION . "\"}", $snippet_settings->json());
   }
   public function testJSONRenderingWithIdentityVerification()
   {
@@ -37,23 +37,23 @@ public function testJSONRenderingWithIdentityVerification()
       "exp" => TimeProvider::getCurrentTime() + 3600
     );
     $jwt = JWT::encode($jwt_data, "s3cre7", 'HS256'); 
-    $this->assertEquals('{"app_id":"bar","intercom_user_jwt":"'.$jwt.'","installation_type":"wordpress"}', $snippet_settings->json());
+    $this->assertEquals('{"app_id":"bar","intercom_user_jwt":"'.$jwt.'","installation_type":"wordpress","integration_version":"' . INTERCOM_PLUGIN_VERSION . '"}', $snippet_settings->json());
   }
   public function testJSONRenderingWithIdentityVerificationAndNoSecret()
   {
     $snippet_settings = new IntercomSnippetSettings(array("app_id" => "bar"), NULL, new FakeWordPressUserForSnippetTest());
-    $this->assertEquals("{\"app_id\":\"bar\",\"email\":\"foo@bar.com\",\"installation_type\":\"wordpress\"}", $snippet_settings->json());
+    $this->assertEquals("{\"app_id\":\"bar\",\"email\":\"foo@bar.com\",\"installation_type\":\"wordpress\",\"integration_version\":\"" . INTERCOM_PLUGIN_VERSION . "\"}", $snippet_settings->json());
   }
   public function testInstallationType()
   {
     $snippet_settings = new IntercomSnippetSettings(array("app_id" => "bar"));
-    $this->assertEquals("{\"app_id\":\"bar\",\"installation_type\":\"wordpress\"}", $snippet_settings->json());
+    $this->assertEquals("{\"app_id\":\"bar\",\"installation_type\":\"wordpress\",\"integration_version\":\"" . INTERCOM_PLUGIN_VERSION . "\"}", $snippet_settings->json());
   }
   public function testIclLanguageConstant()
   {
     define('ICL_LANGUAGE_CODE', 'fr');
     $snippet_settings = new IntercomSnippetSettings(array("app_id" => "bar"));
-    $this->assertEquals("{\"app_id\":\"bar\",\"language_override\":\"fr\",\"installation_type\":\"wordpress\"}", $snippet_settings->json());
+    $this->assertEquals("{\"app_id\":\"bar\",\"language_override\":\"fr\",\"installation_type\":\"wordpress\",\"integration_version\":\"" . INTERCOM_PLUGIN_VERSION . "\"}", $snippet_settings->json());
   }
 
   public function testAppId()

test/SnippetTest.php

@@ -24,7 +24,7 @@ public function testGeneratedHtml()
   };
 </script>
 <script data-cfasync="false">
-  window.intercomSettings = {"app_id":"foo","name":"Nikola Tesla","installation_type":"wordpress"};
+  window.intercomSettings = {"app_id":"foo","name":"Nikola Tesla","installation_type":"wordpress","integration_version":"3.0.1"};
 </script>
 <script data-cfasync="false">(function(){var w=window;var ic=w.Intercom;if(typeof ic==="function"){ic('reattach_activator');ic('update',w.intercomSettings);}else{var d=document;var i=function(){i.c(arguments);};i.q=[];i.c=function(args){i.q.push(args);};w.Intercom=i;var l=function(){var s=d.createElement('script');s.type='text/javascript';s.async=true;s.src='https://widget.intercom.io/widget/foo';var x=d.getElementsByTagName('script')[0];x.parentNode.insertBefore(s, x);};if(document.readyState==='complete'){l();}else if(w.attachEvent){w.attachEvent('onload',l);}else{w.addEventListener('load',l,false);}}})()</script>
 HTML;