[FEATURE] Author API support with valid JSON passed as content in shortcode [lrn-author]<pre>JSON</pre></lrn-author]

Author: Dmitry Kochnev

classes/Learnosity/Plugin.php

@@ -32,6 +32,7 @@ public function enqueue_scripts()
 	{
 		$lrn_items_api_url = get_option('lrn_items_api_url','https://items-va.learnosity.com/?v1');
 		$lrn_reports_api_url = get_option('lrn_reports_api_url','https://reports-va.learnosity.com/?v1');
+		$lrn_author_api_url = get_option('lrn_author_api_url','https://authorapi-or.learnosity.com/?v1');
 		wp_enqueue_script(
 			'learnosity-items',
 			$lrn_items_api_url,
@@ -46,12 +47,20 @@ public function enqueue_scripts()
 			null,
 			false
 		);
+        wp_enqueue_script(
+            'learnosity-author',
+            $lrn_author_api_url,
+            array(),
+            null,
+            false
+        );
 	}
 
 	public function init_settings()
 	{
 		register_setting('lrn_api_group', 'lrn_consumer_key');
 		register_setting('lrn_api_group', 'lrn_consumer_secret');
+		register_setting('lrn_api_group', 'lrn_author_api_url');
 		register_setting('lrn_api_group', 'lrn_items_api_url');
 		register_setting('lrn_api_group', 'lrn_reports_api_url');
         register_setting('lrn_api_group', 'lrn_default_type');

classes/Learnosity/Shortcodes/AuthorEmbed.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace Learnosity\Shortcodes;
+
+require_once __DIR__ . '/../../../vendor/learnosity-utils/RequestHelper.php';
+
+class AuthorEmbed
+{
+    private $config;
+    private $security;
+
+    public function __construct($options, $content)
+    {
+        $this->security = array(
+            'consumer_key' => get_option('lrn_consumer_key'),
+            'domain' => $_SERVER['SERVER_NAME'],
+            'timestamp' => gmdate('Ymd-Hi')
+        );
+
+        $defaults = array(
+            'mode' => 'item_list',
+            'user' => [
+                'id' => 'www-site',
+                'firstname' => 'WWW Firstname',
+                'lastname' => 'WWW Lastname',
+                'email' => 'www@learnosity.com'
+            ]
+        );
+
+        //supporting $content to be passed inside short code
+        //[lrn-author]<pre>{JSON}</pre>[/lrn-author]
+        //using preformatted text <pre> to avoid replacing " for “
+        if ($content != '') {
+            $content = json_decode(sanitize_text_field($content), TRUE);
+            if (is_null($content)) {
+                $this->render_error("Invalid JSON for Learnosity Author API provided.");
+            } else {
+                $this->config = $content;
+            }
+        } else {
+            $this->config = array_merge($defaults, $options);
+        }
+    }
+
+    public function render()
+    {
+        ob_start();
+        $this->render_init_js();
+        $this->render_author();
+        return ob_get_clean();
+    }
+
+    private function generate_signed_request()
+    {
+        $request = $this->config;
+        $request_helper = new \RequestHelper(
+            'author',
+            $this->security,
+            get_option('lrn_consumer_secret'),
+            $request
+        );
+        $signed_request = $request_helper->generateRequest();
+        return $signed_request;
+    }
+
+    private function render_init_js()
+    {
+        $signed_request = $this->generate_signed_request($this->config);
+        include(__DIR__ . '/../../../templates/init-author-js.php');
+    }
+
+    private function render_author()
+    {
+        include(__DIR__ . '/../../../templates/author.php');
+    }
+
+    private function render_error($msg)
+    {
+        include(__DIR__ . '/../../../templates/author_error.php');
+    }
+}

classes/Learnosity/Shortcodes/Generator.php

@@ -6,11 +6,13 @@
 require_once 'ItemsEmbed.php';
 require_once 'SubmitEmbed.php';
 require_once 'ReportEmbed.php';
+require_once 'AuthorEmbed.php';
 
 use Learnosity\Shortcodes\ItemEmbed as ItemEmbed;
 use Learnosity\Shortcodes\ItemsEmbed as ItemsEmbed;
 use Learnosity\Shortcodes\SubmitEmbed as SubmitEmbed;
 use Learnosity\Shortcodes\ReportEmbed as ReportEmbed;
+use Learnosity\Shortcodes\AuthorEmbed as AuthorEmbed;
 
 class Generator
 {
@@ -22,6 +24,7 @@ public function __construct()
         add_shortcode('lrn-submit', array(&$this, 'render_submit'));
         add_shortcode('lrn-assess', array(&$this, 'render_assess'));
         add_shortcode('lrn-report', array(&$this, 'render_report'));
+        add_shortcode('lrn-author', array(&$this, 'render_author'));
     }
 
     public function render_item($attrs)
@@ -53,4 +56,10 @@ public function render_report($attrs, $content)
         $report_embed = new ReportEmbed($attrs, $content);
         return $report_embed->render();
     }
+
+    public function render_author($attrs, $content)
+    {
+        $author_embed = new AuthorEmbed($attrs, $content);
+        return $author_embed->render();
+    }
 }

learnosity-api.php

@@ -3,10 +3,10 @@
  * Plugin Name: Learnosity API
  * Plugin URI: https://docs.learnosity.com/developers/developerguide/integration
  * Description: Simple Learnosity API integration in WordPress.
- * Version: 1.7.0
+ * Version: 1.8.0
  * Author: Learnosity
  * Author URI: http://www.learnosity.com
- * License: Copyright 2014-2017, Learnosity
+ * License: Copyright 2014-2020, Learnosity
  */
 
 require_once 'classes/Learnosity/Plugin.php';

templates/author.php

@@ -0,0 +1 @@
+<span class="learnosity-author" id="learnosity-author"></span>

templates/author_error.php

@@ -0,0 +1 @@
+<span><?php echo htmlspecialchars($msg) ?></span>

templates/init-author-js.php

@@ -0,0 +1,13 @@
+<script>
+    // WP can add "defer" flag to <script> inside "wp_enqueue_script" function
+    // it might lead to the error that "LearnosityAuthor" below in undefined
+    // to protect against it, we will use "load" global event to secure that all JS assets are loaded before calling any JS code
+    window.addEventListener("load", function () {
+        window.learnosityCollection = window.learnosityCollection || [];
+        window.learnosityCollection.push(LearnosityAuthor.init(<?php echo $signed_request; ?>, {
+            errorListener: function (e) {
+                console.log(e);
+            }
+        }));
+    });
+</script>

templates/settings.php

@@ -13,6 +13,10 @@
 				<th scope="row"><label for="lrn_consumer_secret">Consumer Secret (required)</label></th>
 				<td><input type="text" name="lrn_consumer_secret" id="lrn_consumer_secret" value="<?php echo get_option('lrn_consumer_secret'); ?>" class="regular-text ltr"/></td>
 			</tr>
+            <tr valign="top">
+                <th scope="row"><label for="lrn_author_api_url">Author API URL</label></th>
+                <td><input type="text" name="lrn_author_api_url" id="lrn_author_api_url" value="<?php echo get_option('lrn_author_api_url'); ?>" class="regular-text ltr"/><p><i>Use this to select region and version to use.  Default: https://authorapi-or.learnosity.com/?v1</i></p></td>
+            </tr>
 			<tr valign="top">
 				<th scope="row"><label for="lrn_items_api_url">Items API URL</label></th>
 				<td><input type="text" name="lrn_items_api_url" id="lrn_items_api_url" value="<?php echo get_option('lrn_items_api_url'); ?>" class="regular-text ltr"/><p><i>Use this to select region and version to use.  Default: https://items-va.learnosity.com/?v1</i></p></td>

vendor/learnosity-utils/RequestHelper.php

@@ -256,7 +256,6 @@ private function setServiceOptions($service)
     {
         switch ($service) {
             case 'assess':
-            case 'author':
             case 'questions':
                 $this->doSignRequestData = false;
                 break;