RubyGems - retreaverjs-rails - Versions diffs - 0.2.10 → 0.2.11 - Mend

retreaverjs-rails 0.2.10 → 0.2.11

Files changed (35) hide show

data/vendor/documentation/javascript/v1/fonts/OpenSans-Regular-webfont.woff ADDED Viewed

Binary file

data/vendor/documentation/javascript/v1/global.html CHANGED Viewed

@@ -3,7 +3,7 @@
 <head>
     <meta charset="utf-8">
     <title>JSDoc: Global</title>
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
     <!--[if lt IE 9]>
@@ -16,124 +16,135 @@
 <body>
 <div id="main">
     <h1 class="page-title">Global</h1>
 <section>
 <header>
-    <h2>
-    </h2>
+        <h2></h2>
-</header>
+</header>
 <article>
     <div class="container-overview">
 <dl class="details">
 </dl>
     </div>
         <h3 class="subsection-title">Type Definitions</h3>
-        <dl>
-<dt>
-    <h4 class="name" id="getNumberCallback"><span class="type-signature"></span>getNumberCallback<span class="signature">()</span><span class="type-signature"></span></h4>
-</dt>
-<dd>
-    <div class="description">
-        Retreaver.Campaign#request_number callback fired after the request completes.
-    </div>
+    <h4 class="name" id="getNumberCallback"><span class="type-signature"></span>getNumberCallback<span class="signature">()</span><span class="type-signature"></span></h4>
+<div class="description">
+    Retreaver.Campaign#request_number callback fired after the request completes.
+</div>
+    <h5>Parameters:</h5>
-        <h5>Parameters:</h5>
 <table class="params">
     <thead>
-	<tr>
-		<th>Type</th>
-		<th class="last">Description</th>
-	</tr>
-	</thead>
-	<tbody>
+    <tr>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
         <tr>
             <td class="type">
@@ -142,74 +153,85 @@
             </td>
             <td class="description last">The number that was returned</td>
         </tr>
-	</tbody>
-</table>
+    </tbody>
+</table>
 <dl class="details">
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="campaign.js.html">retreaver/campaign.js</a>, <a href="campaign.js.html#line123">line 123</a>
+        <a href="retreaver_campaign.js.html">retreaver/campaign.js</a>, <a href="retreaver_campaign.js.html#line135">line 135</a>
     </li></ul></dd>
 </dl>
-</dd>
-            </dl>
 </article>
-</section>
+</section>
@@ -217,13 +239,13 @@
 </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>
+    <h2><a href="index.html">Home</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">
+<br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Thu Oct 27 2016 22:04:38 GMT-0400 (EDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Feb 16 2017 17:35:24 GMT-0500 (EST)
 </footer>
 <script> prettyPrint(); </script>

data/vendor/documentation/javascript/v1/index.html CHANGED Viewed

@@ -2,8 +2,8 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Index</title>
+    <title>JSDoc: Home</title>
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
     <!--[if lt IE 9]>
@@ -16,12 +16,13 @@
 <body>
 <div id="main">
-    <h1 class="page-title">Index</h1>
+    <h1 class="page-title">Home</h1>
@@ -35,6 +36,7 @@
@@ -52,13 +54,13 @@
 </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>
+    <h2><a href="index.html">Home</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">
+<br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Thu Oct 27 2016 22:04:38 GMT-0400 (EDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Feb 16 2017 17:35:24 GMT-0500 (EST)
 </footer>
 <script> prettyPrint(); </script>

data/vendor/documentation/javascript/v1/retreaver.js.html CHANGED Viewed

@@ -3,7 +3,7 @@
 <head>
     <meta charset="utf-8">
     <title>JSDoc: Source: retreaver.js</title>
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
     <!--[if lt IE 9]>
@@ -16,16 +16,17 @@
 <body>
 <div id="main">
     <h1 class="page-title">Source: retreaver.js</h1>
     <section>
         <article>
-            <pre class="prettyprint source"><code>(function (context) {
+            <pre class="prettyprint source linenums"><code>(function (context) {
     /**
      * @namespace Retreaver
      */
@@ -68,13 +69,13 @@
 </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>
+    <h2><a href="index.html">Home</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">
+<br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Thu Oct 27 2016 22:04:38 GMT-0400 (EDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Feb 16 2017 17:35:24 GMT-0500 (EST)
 </footer>
 <script> prettyPrint(); </script>

data/vendor/documentation/javascript/v1/{campaign.js.html → retreaver_campaign.js.html} RENAMED Viewed

@@ -3,7 +3,7 @@
 <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]>
@@ -16,16 +16,17 @@
 <body>
 <div id="main">
     <h1 class="page-title">Source: retreaver/campaign.js</h1>
     <section>
         <article>
-            <pre class="prettyprint source"><code>(function () {
+            <pre class="prettyprint source linenums"><code>(function() {
     // Dependencies
     var RequestNumber = Retreaver.Base.RequestNumber;
     /**
@@ -36,7 +37,7 @@
      * @example
      * var campaign = new Retreaver.Campaign({ campaign_key: '67d9fb1917ae8f4eaff36831b41788c3' });
      */
-    var Campaign = function (options) {
+    var Campaign = function(options) {
         function initialize(data) {
             // initialize data store
@@ -56,9 +57,12 @@
                 for (j = 0; j &lt; links.length; j++) {
                     link = links[j];
                     href = link.getAttribute('href');
-                    match = href.match(/tel:(.*)/);
-                    if (match && match[1] === rn['find']) {
-                        link.setAttribute('href', 'tel:' + rn['replace_with']);
+                    if (href !== null) {
+                        match = href.match(/tel:(.*)/);
+                        if (match &amp;&amp; match[1] === rn['find']) {
+                            link.setAttribute('href', 'tel:' + rn['replace_with']);
+                        }
                     }
                 }
             }
@@ -74,7 +78,7 @@
          * @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 {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
@@ -84,7 +88,7 @@
          *   alert('something went wrong: ' + response);
          * };
          */
-        self.request_number = function (tags, callback, error_callback) {
+        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') {
@@ -95,12 +99,22 @@
                 // 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) {
+            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 !== '') {
+                if (typeof(data) !== 'undefined' &amp;&amp; typeof(data.number) !== 'undefined' &amp;&amp; data.number !== '') {
                     // initialize number
                     var number = new Retreaver.Number(data.number);
@@ -123,28 +137,27 @@
          * Auto replace all numbers on page according to campaign settings
          * Calls campaign.request_number
          * @memberOf Retreaver.Campaign
-         * @function auto_replace_number
+         * @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_number({calling_about: 'support'}, function (number) {
+         * 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 (callback, error_callback) {
+        self.auto_replace_numbers = function(tags, callback, error_callback) {
             if (typeof callback === 'undefined') {
-                callback = function () {
-                };
+                callback = function() {};
             }
             if (typeof error_callback === 'undefined') {
-                error_callback = function () {
-                };
+                error_callback = function() {};
             }
-            self.request_number({}, callback, error_callback);
+            self.request_number(tags, callback, error_callback);
         };
         /**
@@ -153,7 +166,7 @@
          * @param {Retreaver.Number} - The number that was returned
          */
-        self.numbers = function () {
+        self.numbers = function() {
             var output = [];
             if (typeof(Retreaver.Base.Data._store) !== 'undefined') {
                 // get numbers
@@ -172,11 +185,11 @@
             return output;
         };
-        self.set_number_matching_tags = function (tags) {
+        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)) {
+            if (tags &amp;&amp; (typeof tags === "object") &amp;&amp; !(tags instanceof Array)) {
                 return tags
             } else {
                 throw "ArgumentError: Expected number_matching_tags to be an object. eg: {tag: 'value'}";
@@ -198,13 +211,13 @@
 </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>
+    <h2><a href="index.html">Home</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">
+<br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Thu Oct 27 2016 22:04:38 GMT-0400 (EDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Feb 16 2017 17:35:24 GMT-0500 (EST)
 </footer>
 <script> prettyPrint(); </script>