RubyGems - retreaverjs-rails - Versions diffs - 0.2.18 → 0.2.19 - Mend

retreaverjs-rails 0.2.18 → 0.2.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

data/vendor/documentation/javascript/dev/Retreaver.html ADDED Viewed

@@ -0,0 +1,330 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Namespace: Retreaver</title>
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+<body>
+<div id="main">
+    <h1 class="page-title">Namespace: Retreaver</h1>
+<section>
+<header>
+    <h2>
+    Retreaver
+    </h2>
+</header>
+<article>
+    <div class="container-overview">
+<dl class="details">
+    <dt class="tag-version">Version:</dt>
+    <dd class="tag-version"><ul class="dummy"><li>dev</li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="retreaver.js.html">retreaver.js</a>, <a href="retreaver.js.html#line2">line 2</a>
+    </li></ul></dd>
+</dl>
+    </div>
+        <h3 class="subsection-title">Classes</h3>
+        <dl>
+            <dt><a href="Retreaver.Campaign.html">Campaign</a></dt>
+            <dd></dd>
+            <dt><a href="Retreaver.Number.html">Number</a></dt>
+            <dd></dd>
+        </dl>
+        <h3 class="subsection-title">Methods</h3>
+        <dl>
+<dt>
+    <h4 class="name" id="configure"><span class="type-signature">&lt;static> </span>configure<span class="signature">(options)</span><span class="type-signature"></span></h4>
+</dt>
+<dd>
+    <div class="description">
+        Configure the retreaver client library.
+    </div>
+        <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>options</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">
+                <h6>Properties</h6>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>host</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+            <td class="description last">Retreaver API Host</td>
+        </tr>
+        <tr>
+                <td class="name"><code>prefix</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+            <td class="description last">http or https</td>
+        </tr>
+	</tbody>
+</table>
+            </td>
+        </tr>
+	</tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="retreaver.js.html">retreaver.js</a>, <a href="retreaver.js.html#line8">line 8</a>
+    </li></ul></dd>
+</dl>
+        <h5>Example</h5>
+    <pre class="prettyprint"><code>Retreaver.configure({host: 'api.rtvrapi.com', prefix: 'https'});</code></pre>
+</dd>
+        </dl>
+</article>
+</section>
+</div>
+<nav>
+    <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Retreaver.Campaign.html">Campaign</a></li><li><a href="Retreaver.Number.html">Number</a></li></ul><h3>Namespaces</h3><ul><li><a href="Retreaver.html">Retreaver</a></li></ul><h3><a href="global.html">Global</a></h3>
+</nav>
+<br clear="both">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Mon Jun 17 2024 14:31:16 GMT+0300 (EEST)
+</footer>
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

data/vendor/documentation/javascript/dev/campaign.js.html ADDED Viewed

@@ -0,0 +1,270 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: retreaver/campaign.js</title>
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+<body>
+<div id="main">
+    <h1 class="page-title">Source: retreaver/campaign.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source"><code>(function() {
+    // Dependencies
+    var RequestNumber = Retreaver.Base.RequestNumber;
+    /**
+     * @constructor
+     * @memberOf Retreaver
+     * @param {Object} options
+     * @param {String} options.campaign_key - Campaign key
+     * @example
+     * var campaign = new Retreaver.Campaign({ campaign_key: '67d9fb1917ae8f4eaff36831b41788c3' });
+     */
+    var Campaign = function(options) {
+        function initialize(data) {
+            // initialize data store
+            self.store(data);
+        }
+        function find_and_replace_number(replacement_numbers) {
+            for (var i = 0; i &lt; replacement_numbers.length; i++) {
+                var rn = replacement_numbers[i];
+                Retreaver.Vendor.findAndReplaceDOMText(document.getElementsByTagName('body')[0], {
+                    find: rn['find'],
+                    replace: rn['replace_with']
+                });
+                var links = document.getElementsByTagName('a');
+                for (var j = 0; j &lt; links.length; j++) {
+                    var link = links[j];
+                    var href = link.getAttribute('href');
+                    if (href !== null) {
+                        var match = href.match(/^(tel:|clk[a-z]\/tel\/)(.*)/);
+                        if (match && match[2] === rn['find']) {
+                            link.setAttribute('href', match[1] + rn['replace_with']);
+                        }
+                    }
+                }
+            }
+        }
+        var self = this;
+        self.type = 'campaigns';
+        self.primary_key('campaign_key');
+        self.numbers = [];
+        self.handle_true_call_integration = function(number) {
+            const trueCallConfig = number.get("integrations")["truecall.com"];
+            // debugger
+            if (typeof(trueCallConfig) == 'undefined') {
+                return;
+            }
+            // Load the trueCall script into the page it it's missing
+            if(!document.getElementById("__tc_script") || !window.TrueCall) {
+                (function () {
+                    const trueCallScriptTag = document.createElement('script');
+                    trueCallScriptTag.type = 'text/javascript';
+                    trueCallScriptTag.async = true;
+                    trueCallScriptTag.defer = true;
+                    trueCallScriptTag.dataset.tc_campaign_id = trueCallConfig["tcCampaignId"];
+                    trueCallScriptTag.id = "__tc_script"
+                    trueCallScriptTag.src = 'https://static.truecall.com/tc-retreaver.js';
+                    (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(trueCallScriptTag);
+                })();
+            }
+            const obtainTrueCallId = new Promise(function(resolve) {
+                const trueCallInterval = setInterval(function() {
+                    if (window.TrueCall && window.TrueCall.getId()) {
+                        resolve(window.TrueCall.getId())
+                        clearInterval(trueCallInterval);
+                    }
+                }, trueCallConfig["checkIntervalMs"]); // Try to get the trueCallId every X milliseconds
+            })
+            obtainTrueCallId.then(function (trueCallId) {
+                const tags = {};
+                tags[trueCallConfig["tagName"]] = trueCallId;
+                number.replace_tags(tags);
+            });
+        }
+        /**
+         * Fetch a campaign number.
+         * @memberOf Retreaver.Campaign
+         * @function request_number
+         * @instance
+         * @param {Object} [tags] - A collection of tags as key-value pairs. The number returned will match these tags.
+         * @param {getNumberCallback} callback - Callback fired if the request completes successfully.
+         * @param {Function} error_callback - Callback fired if the request raises an error.
+         * @example
+         * campaign.request_number({calling_about: 'support'}, function (number) {
+         *   alert(number.get('number'))
+         * }, function(response){
+         *   alert('something went wrong: ' + response);
+         * };
+         */
+        self.request_number = function(tags, callback, error_callback) {
+            // if the first argument is a function, the user has decided to skip passing tags
+            // therefore cascade the arguments upwards so that everything works as expected
+            if (typeof(tags) === 'function') {
+                // argument 3 becomes argument 2
+                error_callback = callback;
+                // argument 2 becomes argument 1
+                callback = tags;
+                // argument 1 becomes an empty tags object
+                tags = {};
+            }
+            if (typeof callback === 'undefined') {
+                callback = function () {
+                };
+            }
+            if (typeof tags === 'undefined') {
+                tags = {};
+            }
+            // assign the tags (this is important since it runs it through set_number_matching_tags)
+            self.set('number_matching_tags', tags);
+            // request the number
+            new RequestNumber(self.get('campaign_key', 'number_matching_tags')).perform(function(data) {
+                // did retreaver return a valid number?
+                if (typeof(data) !== 'undefined' && typeof(data.number) !== 'undefined' && data.number !== '') {
+                    var number = new Retreaver.Number(data.number);
+                    number.add_tags({"gosho": "123"}, function(data){
+                        console.log("tagged");
+                    })
+                    // initialize number
+                    try {
+                        self.handle_true_call_integration(number);
+                    } catch (e) {
+                        console.error("Could not integrate with truecall.com, ", e);
+                    }
+                    // if there is a replacement in the response, replace all occurrences
+                    // of that number on the page with the retreaver number
+                    if (typeof(data.number.replacement_numbers) !== 'undefined') {
+                        find_and_replace_number(data.number.replacement_numbers);
+                    }
+                    // call callback
+                    callback.apply(self, [number]);
+                }
+                // otherwise fire the error callback
+                else if (typeof(error_callback) === 'function') {
+                    error_callback.apply(self, [data]);
+                }
+            });
+        };
+        /**
+         * Auto replace all numbers on page according to campaign settings
+         * Calls campaign.request_number
+         * @memberOf Retreaver.Campaign
+         * @function auto_replace_numbers
+         * @instance
+         * @param {Object} [tags] - A collection of tags as key-value pairs. The number returned will match these tags.
+         * @param {getNumberCallback} callback - Callback fired if the request completes successfully.
+         * @param {Function} error_callback - Callback fired if the request raises an error.
+         * @example
+         * campaign.auto_replace_numbers({calling_about: 'support'}, function (number) {
+         *   alert(number.get('number'))
+         * }, function(response){
+         *   alert('something went wrong: ' + response);
+         * };
+         */
+        self.auto_replace_numbers = function(tags, callback, error_callback) {
+            if (typeof callback === 'undefined') {
+                callback = function() {};
+            }
+            if (typeof error_callback === 'undefined') {
+                error_callback = function() {};
+            }
+            self.request_number(tags, callback, error_callback);
+        };
+        /**
+         * Retreaver.Campaign#request_number callback fired after the request completes.
+         * @callback getNumberCallback
+         * @param {Retreaver.Number} - The number that was returned
+         */
+        self.numbers = function() {
+            var output = [];
+            if (typeof(Retreaver.Base.Data._store) !== 'undefined') {
+                // get numbers
+                var numbers = Retreaver.Base.Data._store['numbers'];
+                // present?
+                if (typeof(numbers) !== 'undefined') {
+                    // collect numbers matching this campaign
+                    for (var primary_key in numbers) {
+                        var number = numbers[primary_key];
+                        if (self.get('campaign_key') == number.campaign_key) {
+                            output.push(new Retreaver.Number(number));
+                        }
+                    }
+                }
+            }
+            return output;
+        };
+        self.set_number_matching_tags = function(tags) {
+            if (typeof(tags) === 'string') {
+                tags = Retreaver.Number.extract_tags_from_string(tags);
+            }
+            if (tags && (typeof tags === "object") && !(tags instanceof Array)) {
+                return tags
+            } else {
+                throw "ArgumentError: Expected number_matching_tags to be an object. eg: {tag: 'value'}";
+            }
+        };
+        initialize(options);
+    };
+    Campaign.prototype = new Retreaver.Base.Model();
+    Retreaver.Campaign = Campaign;
+})();
+</code></pre>
+        </article>
+    </section>
+</div>
+<nav>
+    <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Retreaver.Campaign.html">Campaign</a></li><li><a href="Retreaver.Number.html">Number</a></li></ul><h3>Namespaces</h3><ul><li><a href="Retreaver.html">Retreaver</a></li></ul><h3><a href="global.html">Global</a></h3>
+</nav>
+<br clear="both">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Mon Jun 17 2024 14:31:15 GMT+0300 (EEST)
+</footer>
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>