test.js

/* istanbul ignore next */
describe('stingray', function () {
  'use strict';

  //
  // Introduce some globals as this library should run in browsers only unless
  // we polyfill/mock some browser things.
  //
  global.Image = require('beacons/image');
  global.navigator = {
    cookieEnabled: true,
    language: 'en-US',
    productSub: '20030107',
    product: 'Gecko',
    appCodeName: 'Mozilla',
    mimeTypes: { length: 0 },
    vendorSub: '',
    vendor: 'Apple Computer, Inc.',
    platform: 'MacIntel',
    appName: 'Netscape',
    appVersion: '5.0 (Macintosh; Intel Mac OS X) AppleWebKit/534.34 (KHTML, like Gecko) PhantomJS/1.9.8 Safari/534.34',
    userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X) AppleWebKit/534.34 (KHTML, like Gecko) PhantomJS/1.9.8 Safari/534.34',
    plugins: { length: 0 },
    onLine: false
  };

  global.document =  {
    charset: 'UTF-8',
    domain: 'localhost',
    inputEncoding: 'UTF-8',
    readyState: 'complete',
    referrer: '',
    URL: 'http://localhost:52091/?brout',
    visibility: undefined
  };

  var qs = require('querystringify')
    , parse = require('url-parse')
    , assume = require('assume')
    , Stingray = require('./')
    , server
    , stingray;

  beforeEach(function () {
    server = 'http://example.com';
    stingray = new Stingray(server);
  });

  afterEach(function () {
    stingray.destroy();
  });

  it('is exported a function', function () {
    assume(Stingray).is.a('function');
  });

  it('can be constructed without new', function () {
    assume(Stingray()).is.instanceof(Stingray);
  });

  describe('construction', function () {
    it('accepts a custom limit', function () {
      var u = new Stingray(server, { limit : 500 });

      assume(u.limit).does.not.equal(stingray.limit);
      assume(u.limit).equals(500);
    });
  });

  describe('#set', function () {
    it('sets items to the internal data set', function () {
      assume(stingray.dataset).is.a('object');
      assume(stingray.dataset.foo).equals(undefined);

      stingray.set('foo', 'bar');
      assume(stingray.dataset.foo).equals('bar');
    });

    it('overrides existing values', function () {
      stingray.set('foo', 'bar');
      assume(stingray.dataset.foo).equals('bar');

      stingray.set('foo', 'foo');
      assume(stingray.dataset.foo).equals('foo');
    });

    it('chains', function () {
      assume(stingray.set('foo', 'bar')).equals(stingray);
    });
  });

  describe('#remove', function () {
    it('can remove added keys', function () {
      stingray.set('foo', 'bar').set('bar', 'foo');

      assume(stingray.dataset.foo).equals('bar');
      assume(stingray.dataset.bar).equals('foo');

      stingray.remove('foo');
      assume(stingray.dataset.foo).equals(undefined);
      assume(stingray.dataset.bar).equals('foo');
    });

    it('can remove multiple keys', function () {
      stingray.set('foo', 'bar').set('bar', 'foo');

      assume(stingray.dataset.foo).equals('bar');
      assume(stingray.dataset.bar).equals('foo');

      stingray.remove('foo', 'bar');
      assume(stingray.dataset.foo).equals(undefined);
      assume(stingray.dataset.bar).equals(undefined);
    });

    it('can remove multiple keys if first arg is space/comma separated', function () {
      stingray.set('foo', 'bar').set('bar', 'foo');

      assume(stingray.dataset.foo).equals('bar');
      assume(stingray.dataset.bar).equals('foo');

      stingray.remove('foo, bar');
      assume(stingray.dataset.foo).equals(undefined);
      assume(stingray.dataset.bar).equals(undefined);
    });

    it('chains', function () {
      assume(stingray.remove('foo', 'bar')).equals(stingray);
    });
  });

  describe('#payload', function () {
    it('returns an object', function () {
      var data = stingray.payload();

      assume(data).is.a('object');
    });

    it('returns an object that can be transformed in to a querystring', function () {
      var data = stingray.payload()
        , string = qs.stringify(data);

      assume(string).is.a('string');
      assume(string.length).is.below(stingray.limit);
      assume(string).contains('=');
      assume(string).contains('&');

      //
      // Before we can compare we need to transform all the values in the object
      // to strings so we can have a fair chance at matching
      //
      for (var key in data) {
        if (data.hasOwnProperty(key)) {
          data[key] = data[key].toString();
        }
      }

      assume(qs.parse(string)).deep.equals(data);
    });

    it('merges data from the initally supplied dataset', function () {
      var u = new Stingray(server, { dataset: { foo: 'bar' }})
        , data = u.payload();

      assume(data.foo).equals('bar');
    });

    it('cannot override values that are previously set', function () {
      var u = new Stingray(server, { dataset: { domain: 'bar' }})
        , data = u.payload();

      assume(data.domain).equals('bar');
      assume(stingray.payload().domain).does.not.equal(data.domain);
    });

    it('setss the custom values from the .set command', function () {
      stingray.set('domain', 'bar');
      assume(stingray.payload().domain).equals('bar');

      stingray.set('foo', 'bar');
      assume(stingray.payload().foo).equals('bar');
    });

    it('includes performance information when available', function () {
      var perf = global.performance;
      global.performance = { timing: { shizzle: 'mynizzle' }, memory: { leak: 'it' }};

      var data = stingray.payload();

      assume(data.shizzle).equals('mynizzle');
      assume(data.leak).equals('it');

      global.performance = perf;
    });
  });

  describe('#write', function () {
    it('returns false when the generate url is to damn large', function () {
      var u = new Stingray(server, { limit: 500 })
        , url = u.server + qs.stringify(u.payload(), true);

      assume(url.length).is.above(500);
      assume(u.write()).is.false();
    });

    it('returns true if its successfully written', function () {
      assume(stingray.write()).is.true();
    });
  });

  describe('#destroy', function () {
    it('returns true on first destroy', function () {
      assume(stingray.destroy()).is.true();
    });

    it('returns false on second destroy', function () {
      assume(stingray.destroy()).is.true();
      assume(stingray.destroy()).is.false();
    });
  });
});