gecko-dev/browser/components/loop/content/shared/js/feedbackApiClient.js

/* 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:true */

var loop = loop || {};
loop.FeedbackAPIClient = (function($) {
  "use strict";

  /**
   * Feedback API client. Sends feedback data to an input.mozilla.com compatible
   * API.
   *
   * Available settings:
   * - {String} baseUrl Base API url (required)
   * - {String} product Product name (required)
   *
   * @param {Object} settings Settings.
   * @link  http://fjord.readthedocs.org/en/latest/api.html
   */
  function FeedbackAPIClient(settings) {
    settings = settings || {};
    if (!settings.hasOwnProperty("baseUrl")) {
      throw new Error("Missing required baseUrl setting.");
    }
    this._baseUrl = settings.baseUrl;
    if (!settings.hasOwnProperty("product")) {
      throw new Error("Missing required product setting.");
    }
    this._product = settings.product;
  }

  FeedbackAPIClient.prototype = {
    /**
     * Formats Feedback data to match the API spec.
     *
     * @param  {Object} fields Feedback form data.
     * @return {Object}        Formatted data.
     */
    _formatData: function(fields) {
      var formatted = {};

      if (typeof fields !== "object") {
        throw new Error("Invalid feedback data provided.");
      }

      formatted.product = this._product;
      formatted.happy = fields.happy;
      formatted.category = fields.category;

      // Default description field value
      if (!fields.description) {
        formatted.description = (fields.happy ? "Happy" : "Sad") + " User";
      } else {
        formatted.description = fields.description;
      }

      return formatted;
    },

    /**
     * Sends feedback data.
     *
     * @param  {Object}   fields Feedback form data.
     * @param  {Function} cb     Callback(err, result)
     */
    send: function(fields, cb) {
      var req = $.ajax({
        url:         this._baseUrl,
        method:      "POST",
        contentType: "application/json",
        dataType:    "json",
        data: JSON.stringify(this._formatData(fields))
      });

      req.done(function(result) {
        console.info("User feedback data have been submitted", result);
        cb(null, result);
      });

      req.fail(function(jqXHR, textStatus, errorThrown) {
        var message = "Error posting user feedback data";
        var httpError = jqXHR.status + " " + errorThrown;
        console.error(message, httpError, JSON.stringify(jqXHR.responseJSON));
        cb(new Error(message + ": " + httpError));
      });
    }
  };

  return FeedbackAPIClient;
})(jQuery);