retreaverjs-rails 0.0.12

data/README.md

@@ -0,0 +1,90 @@
+# jsdocs
+
+https://retreaver.com/documentation/javascript/v1/Retreaver.Number.html
+
+
+# Usage
+
+Include the retreaver.js script on the page.
+
+```
+<script src="/path/to/retreaver.js" type="text/javascript"></script>
+```
+
+
+# Examples
+
+### Campaign
+
+Initialize a campaign that will return numbers matching home_value:50000
+
+```javascript
+var campaign = new Retreaver.Campaign({ campaign_key: 'the_key_example' });
+```
+
+Request a number from the campaign matching tags, and use jQuery to display it on the page.
+
+```javascript
+var tags = { 
+  home_value: '50000' 
+};
+campaign.request_number(tags, function (number) {
+  $('#number_on_page').html( number.get('formatted_number') );
+});
+```
+
+
+### Number
+
+##### Tags
+
+Display the tags currently attached to this number.
+
+```javascript
+number.get('tag_values');
+```
+ 
+Add / Remove / Clear Tags
+
+```javascript
+number.add_tags({'date_of_birth': '1980/01/01'});
+number.remove_tags({'date_of_birth': '1980/01/01'});
+number.clear_tags();
+```
+
+##### Release
+
+When you are finished with a number you can release it back to the campaign.
+
+```javascript
+number.release();
+```
+
+##### Initiate Call
+
+You can initiate a call with the user.
+
+```javascript
+number.initiate_call('1112224444', {}, function(call){
+  // Call initiated
+});
+```
+
+##### Attributes
+
+Numbers have attributes that can be retrieved.
+
+```javascript
+number.get('campaign_key');
+```
+
+| Attribute         | Type            | Description                                                         |
+| ----------------- |:---------------:|:-------------------------------------------------------------------:|
+| id                | numeric         | number id                                                           |
+| campaign_key      | alpha-numeric   | campaign key                                                        |
+| formatted_number  | string          | formatted number according to national style `(866) 898-7878`       |
+| number            | string          | E.164 formatted number `+18668987878`                               |
+| plain_number      | string          | unformatted phone number digits `8668987878`                        |
+| target_open       | boolean         | does this number have targets that are available to take calls?     |
+| is_per_visitor    | boolean         | does this number track unique visitors?                             |
+| tag_values        | object          | the tags currently assigned to this number                          |

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require 'fileutils'
+require_relative 'lib/retreaverjs/compile.rb'
+
+namespace :retreaverjs do
+  desc "compile retreaverjs"
+  task :compile do
+    Retreaver::Compile.perform
+  end
+end
+
+task :before_build do
+  Rake::Task["retreaverjs:compile"].execute
+end
+
+task :build => :before_build

data/config/README

@@ -0,0 +1 @@
+See our <a href="http://support.retreaver.com/retreaver-js/">knowledge base article</a> for more information.

data/config/jsdocs.json

@@ -0,0 +1,26 @@
+{
+    "tags": {
+        "allowUnknownTags": true
+    },
+    "source": {
+        "include": [
+            "config/README",
+            "src/retreaver/number.js",
+            "src/retreaver/campaign.js"
+        ],
+        "exclude": [],
+        "includePattern": ".+\\.js(doc)?$",
+        "excludePattern": "(^|\\/|\\\\)_"
+    },
+    "opts": {
+        "destination": "./vendor/documentation/javascript/v1/"
+    },
+    "plugins": [],
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false,
+        "default": {
+            "outputSourceFiles": true
+        }
+    }
+}

data/lib/retreaverjs/compile.rb

@@ -0,0 +1,32 @@
+module Retreaver
+  class Compile
+    
+    class << self
+      def perform
+        Dir.chdir(root) do |f|
+          run("npm install") unless Dir.exist?('./node_modules')
+          # compile src
+          run("grunt")
+          output = 'vendor/assets/javascripts/'
+          FileUtils.rm_rf(output)
+          FileUtils.mkdir_p(output)
+          Dir.glob('dist/*.js'){|f| FileUtils.cp( f, output ) }
+          # generate jsdocs
+          output = 'vendor/documentation/javascripts/'
+          FileUtils.rm_rf(output)
+          run("./node_modules/.bin/jsdoc -c config/jsdocs.json")
+        end
+      end
+      
+      def run(command)
+        puts(command)
+        system(command)
+      end
+      
+      def root
+        File.expand_path(File.join(__FILE__, '../../../'))
+      end
+    end
+    
+  end
+end

data/lib/retreaverjs/rails/version.rb

@@ -0,0 +1,5 @@
+module Retreaver
+  module Rails
+    VERSION = '0.0.12'
+  end
+end

data/lib/retreaverjs/rails.rb

@@ -0,0 +1,8 @@
+require "retreaverjs/rails/version"
+
+module Retreaver
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "retreaver",
+  "description": "Retreaver Javascript API",
+  "version": "0.1.0",
+  "homepage": "https://github.com/retreaver/retreaverjs",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/retreaver/retreaverjs.git"
+  },
+  "bugs": {
+    "url": "https://github.com/retreaver/retreaverjs/issues"
+  },
+  "author": {
+    "name": "Blake Hilscher",
+    "email": "blake@retreaver.com",
+    "url": "http://retreaver.com/"
+  },
+  "contributors": [
+    {
+      "name": "Blake Hilscher",
+      "email": "blake@hilscher.ca",
+      "url": "http://blake.hilscher.ca/"
+    }
+  ],
+  "licenses": [
+    {
+      "type": "GPLv3",
+      "url": "http://github.com/retreaver/retreaverjs/blob/master/LICENSE"
+    }
+  ],
+  "main": "src/package.js",
+  "engines": {
+    "node": ">= 0.6.x"
+  },
+  "dependencies": {
+  },
+  "devDependencies": {
+    "grunt": "~0.4.5",
+    "jsdoc": "~3.2.2",
+    "grunt-contrib-jshint": "~0.10.0",
+    "grunt-contrib-nodeunit": "~0.4.1",
+    "grunt-contrib-uglify": "~0.5.0",
+    "grunt-contrib-watch": "~0.6.1",
+    "grunt-contrib-concat": "~0.4.0"
+  }
+}

data/src/retreaver/base/base64.js

@@ -0,0 +1,126 @@
+// http://www.webtoolkit.info/javascript-base64.html#.U-qwzYBdUwQ
+(function () {
+    var Base64 = {
+        _keyStr: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/="
+    };
+    // public method for encoding
+    Base64.encode = function (input) {
+        var output = "";
+        var chr1, chr2, chr3, enc1, enc2, enc3, enc4;
+        var i = 0;
+
+        input = Base64._utf8_encode(input);
+
+        while (i < input.length) {
+
+            chr1 = input.charCodeAt(i++);
+            chr2 = input.charCodeAt(i++);
+            chr3 = input.charCodeAt(i++);
+
+            enc1 = chr1 >> 2;
+            enc2 = ((chr1 & 3) << 4) | (chr2 >> 4);
+            enc3 = ((chr2 & 15) << 2) | (chr3 >> 6);
+            enc4 = chr3 & 63;
+
+            if (isNaN(chr2)) {
+                enc3 = enc4 = 64;
+            } else if (isNaN(chr3)) {
+                enc4 = 64;
+            }
+            output = output +
+                Base64._keyStr.charAt(enc1) + Base64._keyStr.charAt(enc2) +
+                Base64._keyStr.charAt(enc3) + Base64._keyStr.charAt(enc4);
+
+        }
+        return output;
+    };
+    Base64.decode = function (input) {
+        var output = "";
+        var chr1, chr2, chr3;
+        var enc1, enc2, enc3, enc4;
+        var i = 0;
+
+        input = input.replace(/[^A-Za-z0-9\+\/\=]/g, "");
+
+        while (i < input.length) {
+
+            enc1 = Base64._keyStr.indexOf(input.charAt(i++));
+            enc2 = Base64._keyStr.indexOf(input.charAt(i++));
+            enc3 = Base64._keyStr.indexOf(input.charAt(i++));
+            enc4 = Base64._keyStr.indexOf(input.charAt(i++));
+
+            chr1 = (enc1 << 2) | (enc2 >> 4);
+            chr2 = ((enc2 & 15) << 4) | (enc3 >> 2);
+            chr3 = ((enc3 & 3) << 6) | enc4;
+
+            output = output + String.fromCharCode(chr1);
+
+            if (enc3 != 64) {
+                output = output + String.fromCharCode(chr2);
+            }
+            if (enc4 != 64) {
+                output = output + String.fromCharCode(chr3);
+            }
+
+        }
+
+        output = Base64._utf8_decode(output);
+
+        return output;
+    };
+    Base64._utf8_encode = function (string) {
+        //REGEX_2: /\r\n/g NEWLINE: "\n"
+        string = string.replace(eval("/\\r\\n/g"),eval("String('\\n')"));
+        var utftext = "";
+
+        for (var n = 0; n < string.length; n++) {
+
+            var c = string.charCodeAt(n);
+
+            if (c < 128) {
+                utftext += String.fromCharCode(c);
+            }
+            else if ((c > 127) && (c < 2048)) {
+                utftext += String.fromCharCode((c >> 6) | 192);
+                utftext += String.fromCharCode((c & 63) | 128);
+            }
+            else {
+                utftext += String.fromCharCode((c >> 12) | 224);
+                utftext += String.fromCharCode(((c >> 6) & 63) | 128);
+                utftext += String.fromCharCode((c & 63) | 128);
+            }
+
+        }
+
+        return utftext;
+    };
+    Base64._utf8_decode = function (utftext) {
+        var string = "";
+        var i = 0;
+        var c = c1 = c2 = 0;
+
+        while (i < utftext.length) {
+
+            c = utftext.charCodeAt(i);
+
+            if (c < 128) {
+                string += String.fromCharCode(c);
+                i++;
+            }
+            else if ((c > 191) && (c < 224)) {
+                c2 = utftext.charCodeAt(i + 1);
+                string += String.fromCharCode(((c & 31) << 6) | (c2 & 63));
+                i += 2;
+            }
+            else {
+                c2 = utftext.charCodeAt(i + 1);
+                c3 = utftext.charCodeAt(i + 2);
+                string += String.fromCharCode(((c & 15) << 12) | ((c2 & 63) << 6) | (c3 & 63));
+                i += 3;
+            }
+
+        }
+        return string;
+    };
+    Retreaver.Base.Base64 = Base64;
+})();

data/src/retreaver/base/cookies.js

@@ -0,0 +1,59 @@
+// https://github.com/evertton/cookiejs
+(function (f) {
+    var a = function (b, c, d) {
+        return 1 === arguments.length ? a.get(b) : a.set(b, c, d)
+    };
+    a._document = document;
+    a._navigator = navigator;
+    a.defaults = {path: "/"};
+    a.get = function (b) {
+        a._cachedDocumentCookie !== a._document.cookie && a._renewCache();
+        return a._cache[b]
+    };
+    a.set = function (b, c, d) {
+        d = a._getExtendedOptions(d);
+        a._document.cookie = a._generateCookieString(b, c, d);
+        return a
+    };
+    a._getExtendedOptions = function (b) {
+        return{path: b && b.path || a.defaults.path, domain: b && b.domain || a.defaults.domain, secure: b && b.secure !== f ? b.secure :
+            a.defaults.secure}
+    };
+    a._isValidDate = function (a) {
+        return"[object Date]" === Object.prototype.toString.call(a) && !isNaN(a.getTime())
+    };
+    a._generateCookieString = function (a, c, d) {
+        a = encodeURIComponent(a);
+        c = (c + "").replace(/[^!#$&-+\--:<-\[\]-~]/g, encodeURIComponent);
+        d = d || {};
+        a = a + "=" + c + (d.path ? ";path=" + d.path : "");
+        a += d.domain ? ";domain=" + d.domain : "";
+        return a += d.secure ? ";secure" : ""
+    };
+    a._getCookieObjectFromString = function (b) {
+        var c = {};
+        b = b ? b.split("; ") : [];
+        for (var d = 0; d < b.length; d++) {
+            var e = a._getKeyValuePairFromCookieString(b[d]);
+            c[e.key] === f && (c[e.key] = e.value)
+        }
+        return c
+    };
+    a._getKeyValuePairFromCookieString = function (a) {
+        var c = a.indexOf("="), c = 0 > c ? a.length : c;
+        return{key: decodeURIComponent(a.substr(0, c)), value: decodeURIComponent(a.substr(c + 1))}
+    };
+    a._renewCache = function () {
+        a._cache = a._getCookieObjectFromString(a._document.cookie);
+        a._cachedDocumentCookie = a._document.cookie
+    };
+    a._areEnabled = function () {
+        return a._navigator.cookieEnabled || "1" === a.set("cookies.js", 1).get("cookies.js")
+    };
+    a.enabled = a._areEnabled();
+    "function" === typeof define &&
+    define.amd ? define(function () {
+        return a
+    }) : "undefined" !== typeof exports ? ("undefined" !== typeof module && module.exports && (exports = module.exports = a), exports.Cookies = a) : a;
+    Retreaver.Base.Cookies = a;
+})();

data/src/retreaver/base/data.js

@@ -0,0 +1,81 @@
+(function () {
+    // Dependencies
+    var Base = Retreaver.Base;
+    /**
+     * @constructor
+     * @memberof Retreaver.Base
+     * @param {Object}  config - Configuration hash
+     * @param {String}  config.type - The data type
+     * @param {Numeric}  config.primary_key - The primary_key
+     */
+    var Data = function (config) {
+
+        function initialize() {
+            Base.assert_required_keys(config, 'type', 'primary_key');
+            if (typeof Retreaver.Base.Data._store[config.type] === 'undefined') {
+                Retreaver.Base.Data._store[config.type] = {};
+            }
+            if (typeof Retreaver.Base.Data._store[config.type][config.primary_key] === 'undefined') {
+                Retreaver.Base.Data._store[config.type][config.primary_key] = {};
+            }
+        }
+
+        var self = this;
+
+        /**
+         * Request data from the host
+         * @memberOf Retreaver.Base.Data
+         * @function get
+         * @instance
+         * @param {String} key - The key to retrieve
+         * @returns {*}
+         */
+        self.get = function () {
+            var output = {};
+            if (typeof arguments[0] === 'undefined') {
+                output = Retreaver.Base.Data._store[config.type][config.primary_key];
+            } else if (arguments.length === 1) {
+                output = Retreaver.Base.Data._store[config.type][config.primary_key][arguments[0]];
+            } else {
+                for (var i = 0; i < arguments.length; i++) {
+                    var key = arguments[i];
+                    output[key] = Retreaver.Base.Data._store[config.type][config.primary_key][key];
+                }
+            }
+            return output;
+        };
+
+        /**
+         * Request data from the host
+         * @memberOf Retreaver.Base.Data
+         * @function set
+         * @instance
+         * @param {String} key - The key to retrieve
+         * @param {String} value - The value to assign
+         * @returns {*}
+         */
+        self.set = function (key, value) {
+            Retreaver.Base.Data._store[config.type][config.primary_key][key] = value;
+            return value;
+        };
+
+        /**
+         * Merge data
+         * @memberOf Retreaver.Base.Data
+         * @function set
+         * @instance
+         * @param {String} object - The object to merge
+         * @returns {*}
+         */
+        self.merge = function (object) {
+            for (var key in object) {
+                Retreaver.Base.Data._store[config.type][config.primary_key][key] = object[key];
+            }
+            return object;
+        };
+
+        initialize();
+    };
+    Data._store = {};
+    Retreaver.Base.Data = Data;
+})();

data/src/retreaver/base/helpers.js

@@ -0,0 +1,55 @@
+(function () {
+    // ensure namespace is present
+    if (typeof window.Retreaver === 'undefined') window.Retreaver = {};
+    var Base = {};
+    // define helpers
+    Base.assert_required_keys = function () {
+        var args = Array.prototype.slice.call(arguments);
+        var object = args.shift();
+        for (var i = 0; i < args.length; i++) {
+            var key = args[i];
+            if (typeof object === 'undefined' || typeof object[key] === 'undefined') {
+                throw  "ArgumentError: Required keys are not defined: " + args.join(', ');
+            }
+        }
+        return object;
+    };
+    Base.merge = function (obj1, obj2) {
+        for (var p in obj2) {
+            try {
+                if (obj2[p].constructor == Object) {
+                    obj1[p] = Base.merge(obj1[p], obj2[p]);
+                } else {
+                    obj1[p] = obj2[p];
+                }
+            } catch (e) {
+                obj1[p] = obj2[p];
+            }
+        }
+        return obj1;
+    };
+    Base.isArray = function (arg) {
+        return Object.prototype.toString.call(arg) === '[object Array]';
+    };
+    Base.ieVersion = function () {
+        if (Base._ieVersion == null) {
+            Base._ieVersion = (function () {
+                var v = 3,
+                    div = document.createElement('div'),
+                    all = div.getElementsByTagName('i');
+
+                while (
+                    div.innerHTML = '<!--[if gt IE ' + (++v) + ']><i></i><![endif]-->',
+                        all[0]
+                    ) {
+                }
+                return v > 4 ? v : false;
+            }());
+        }
+        if (Base._ieVersion == 6 || Base._ieVersion == 7) {
+            if (Retreaver['easyxdm_loaded'] == null) Retreaver['easyxdm_loaded'] = false;
+        }
+        return Base._ieVersion;
+    };
+    Retreaver.Base = Base;
+})();

data/src/retreaver/base/model.js

@@ -0,0 +1,113 @@
+(function () {
+    // Dependencies
+    var Base = Retreaver.Base;
+    var Data = Retreaver.Base.Data;
+
+    /**
+     * @constructor
+     * @memberof Retreaver.Base
+     */
+    var Model = function () {
+
+        this.api_host_uri = '/api/v1/';
+        this.type = 'model';
+
+        this.primary_key = function (primary_key) {
+            return Model.primary_key(this.type, primary_key);
+        };
+
+        this.store = function (data) {
+            // do we have data to store?
+            if (typeof(data) !== 'undefined') {
+                // does the data contain the required primary_key?
+                var key = this.primary_key();
+                if (typeof(data[key]) === 'undefined') {
+                    throw("ArgumentError: Expected to receive primary_key " + key);
+                }
+                // has a store been initialized?
+                else if (typeof(this._store) === 'undefined') {
+                    this._store = new Retreaver.Base.Data({type: this.type, primary_key: data[key] });
+                }
+                // merge the data
+                this._store.merge(data);
+                // update visitor is token present
+                Model.update_visitor_id(data);
+            }
+            return this._store;
+        };
+
+        this.get_data = function (path, callback) {
+            return this.connection().getJSON(this.api_host_uri + path, null, [Model.update, callback], this);
+        };
+
+        this.post_data = function (path, data, callback) {
+            return this.connection().postJSON(this.api_host_uri + path, data, [Model.update, callback], this);
+        };
+
+        this.set = function () {
+            if (typeof(this["set_" + arguments[0]]) === 'function') {
+                arguments[1] = this["set_" + arguments[0]].apply(this, [arguments[1]]);
+            }
+            return this._store.set.apply(this, arguments);
+        };
+        this.get = function () {
+            return this._store.get.apply(this, arguments);
+        };
+        this.connection = function () {
+            return Retreaver.Base.Request.connection();
+        };
+    };
+    Model.inflections = {
+        'number': 'numbers',
+        'campaign': 'campaigns'
+    };
+    Model.update = function (data) {
+        for (var key in data) {
+            var type = key;
+            var value = data[key];
+            if (typeof Model.inflections[key] !== 'undefined') {
+                type = Model.inflections[key];
+            }
+            if (typeof Data._store[type] !== 'undefined') {
+                if (Base.isArray(value)) {
+                    for (var i = 0; i < value.length; i++) {
+                        Model.update_record(type, value[i]);
+                    }
+                } else {
+                    Model.update_record(type, value[i]);
+                }
+            }
+        }
+        return data;
+    };
+    Model.update_record = function (type, record) {
+        // update visitor is token present
+        Model.update_visitor_id(record);
+        // update data store
+        if (typeof record.id !== 'undefined') {
+            var primary_key = Model.primary_key(type);
+            for (var key in record) {
+                Retreaver.Base.Data._store[type][record[primary_key]][key] = record[key];
+            }
+            return true
+        } else {
+            return false
+        }
+        return record;
+    };
+    Model.update_visitor_id = function (record) {
+        if (typeof(record) !== 'undefined' && typeof(record.visitor_id) !== 'undefined') {
+            Retreaver.Base.Cookies.set('CallPixels-vid', record.visitor_id);
+        }
+    };
+    Model.primary_key = function (type, primary_key) {
+        if (typeof(Model.primary_keys) === 'undefined') Model.primary_keys = {};
+        // default key
+        if (typeof(Model.primary_keys[type]) === 'undefined') Model.primary_keys[type] = 'id';
+        // assign key if passed
+        if (typeof(primary_key) !== 'undefined') Model.primary_keys[type] = primary_key;
+        // return value
+        return Model.primary_keys[type];
+    }
+    Retreaver.Base.Model = Model;
+})();