/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this file, * You can obtain one at http://mozilla.org/MPL/2.0/. */ /*global loop, sinon, it, beforeEach, afterEach, describe */ var expect = chai.expect; describe("loop.FeedbackAPIClient", function() { "use strict"; var sandbox, fakeXHR, requests = []; beforeEach(function() { sandbox = sinon.sandbox.create(); fakeXHR = sandbox.useFakeXMLHttpRequest(); requests = []; // https://github.com/cjohansen/Sinon.JS/issues/393 fakeXHR.xhr.onCreate = function (xhr) { requests.push(xhr); }; }); afterEach(function() { sandbox.restore(); }); describe("#constructor", function() { it("should require a baseUrl setting", function() { expect(function() { return new loop.FeedbackAPIClient(); }).to.Throw(/required 'baseUrl'/); }); it("should require a product setting", function() { expect(function() { return new loop.FeedbackAPIClient("http://fake", {}); }).to.Throw(/required 'product'/); }); }); describe("constructed", function() { var client; beforeEach(function() { client = new loop.FeedbackAPIClient("http://fake/feedback", { product: "Hello", version: "42b1" }); }); describe("#send", function() { it("should send happy feedback data", function() { var feedbackData = { happy: true, description: "Happy User" }; client.send(feedbackData, function(){}); expect(requests).to.have.length.of(1); expect(requests[0].url).to.be.equal("http://fake/feedback"); expect(requests[0].method).to.be.equal("POST"); var parsed = JSON.parse(requests[0].requestBody); expect(parsed.happy).eql(true); expect(parsed.description).eql("Happy User"); }); it("should send sad feedback data", function() { var feedbackData = { happy: false, category: "confusing" }; client.send(feedbackData, function(){}); expect(requests).to.have.length.of(1); expect(requests[0].url).to.be.equal("http://fake/feedback"); expect(requests[0].method).to.be.equal("POST"); var parsed = JSON.parse(requests[0].requestBody); expect(parsed.happy).eql(false); expect(parsed.product).eql("Hello"); expect(parsed.category).eql("confusing"); expect(parsed.description).eql("Sad User"); }); it("should send formatted feedback data", function() { client.send({ happy: false, category: "other", description: "it's far too awesome!" }, function(){}); expect(requests).to.have.length.of(1); expect(requests[0].url).eql("http://fake/feedback"); expect(requests[0].method).eql("POST"); var parsed = JSON.parse(requests[0].requestBody); expect(parsed.happy).eql(false); expect(parsed.product).eql("Hello"); expect(parsed.category).eql("other"); expect(parsed.description).eql("it's far too awesome!"); }); it("should send product information", function() { client.send({product: "Hello"}, function(){}); var parsed = JSON.parse(requests[0].requestBody); expect(parsed.product).eql("Hello"); }); it("should send platform information when provided", function() { client.send({platform: "Windows 8"}, function(){}); var parsed = JSON.parse(requests[0].requestBody); expect(parsed.platform).eql("Windows 8"); }); it("should send channel information when provided", function() { client.send({channel: "beta"}, function(){}); var parsed = JSON.parse(requests[0].requestBody); expect(parsed.channel).eql("beta"); }); it("should send version information when provided", function() { client.send({version: "42b1"}, function(){}); var parsed = JSON.parse(requests[0].requestBody); expect(parsed.version).eql("42b1"); }); it("should send user_agent information when provided", function() { client.send({user_agent: "MOZAGENT"}, function(){}); var parsed = JSON.parse(requests[0].requestBody); expect(parsed.user_agent).eql("MOZAGENT"); }); it("should send url information when provided", function() { client.send({url: "http://fake.invalid"}, function(){}); var parsed = JSON.parse(requests[0].requestBody); expect(parsed.url).eql("http://fake.invalid"); }); it("should throw on invalid feedback data", function() { expect(function() { client.send("invalid data", function(){}); }).to.Throw(/Invalid/); }); it("should throw on unsupported field name", function() { expect(function() { client.send({bleh: "bah"}, function(){}); }).to.Throw(/Unsupported/); }); it("should call passed callback on success", function() { var cb = sandbox.spy(); var fakeResponseData = {description: "confusing"}; client.send({category: "confusing"}, cb); requests[0].respond(200, {"Content-Type": "application/json"}, JSON.stringify(fakeResponseData)); sinon.assert.calledOnce(cb); sinon.assert.calledWithExactly(cb, null, fakeResponseData); }); it("should call passed callback on error", function() { var cb = sandbox.spy(); var fakeErrorData = {error: true}; client.send({category: "confusing"}, cb); requests[0].respond(400, {"Content-Type": "application/json"}, JSON.stringify(fakeErrorData)); sinon.assert.calledOnce(cb); sinon.assert.calledWithExactly(cb, sinon.match(function(err) { return /Bad Request/.test(err); })); }); }); }); });