PretendYoureXyzzy/WebContent/js/cah.ajax.builder.js

/*
 * Copyright (c) 2012, Andy Janata
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are permitted
 * provided that the following conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright notice, this list of conditions
 *   and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice, this list of
 *   conditions and the following disclaimer in the documentation and/or other materials provided
 *   with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * Builder for ajax requests. This contains methods to add every possible parameter to an ajax
 * request, even if it doesn't make sense for the operation code.
 * 
 * @author Andy Janata (ajanata@socialgamer.net)
 * @param {string}
 *          op The operation code for the ajax request.
 * @returns {cah.ajax.Builder}
 * @constructor
 */
cah.ajax.Builder = function(op) {
  /**
   * The data for this request.
   * 
   * @type {object}
   */
  this.data = {};

  this.data[cah.$.AjaxRequest.OP] = op;

  /**
   * Whether this request has been run or not.
   * 
   * @type {boolean}
   * @private
   */
  this.run_ = false;

  /**
   * Error callback for this request. This is for communication-level errors. If this is not
   * specified, the default handler of logging the error to the user will occur.
   * 
   * @type {?function(jqXHR,textStatus,errorThrown)}
   */
  this.errback = undefined;
};

/**
 * Serial counter for ajax requests.
 * 
 * @type {number}
 */
cah.ajax.Builder.serial = 0;

/**
 * Set an error callback for the request.
 * 
 * @param {Function}
 *          opt_errback Optional error callback. (jqXHR,textStatus,errorThrown)
 * @returns {cah.ajax.Builder}
 */
cah.ajax.Builder.prototype.withErrback = function(opt_errback) {
  this.assertNotExecuted_();
  this.errback = errback;
  return this;
};

/**
 * Run the ajax request.
 */
cah.ajax.Builder.prototype.run = function() {
  this.assertNotExecuted_();
  this.run_ = true;

  this.data[cah.$.AjaxRequest.SERIAL] = cah.ajax.Builder.serial++;
  cah.Ajax.instance.requestWithBuilder(this);
};

/**
 * @param {string}
 *          nickname Nickname field to use in the request.
 * @returns {cah.ajax.Builder} This object.
 */
cah.ajax.Builder.prototype.withNickname = function(nickname) {
  this.assertNotExecuted_();
  this.data[cah.$.AjaxRequest.NICKNAME] = nickname;
  return this;
};

/**
 * @param {string}
 *          message Message field to use in the request.
 * @returns {cah.ajax.Builder} This object.
 */
cah.ajax.Builder.prototype.withMessage = function(message) {
  this.assertNotExecuted_();
  this.data[cah.$.AjaxRequest.MESSAGE] = message;
  return this;
};

/**
 * @param {number}
 *          gameId Game id field to use in the request.
 * @returns {cah.ajax.Builder} This object.
 */
cah.ajax.Builder.prototype.withGameId = function(gameId) {
  this.assertNotExecuted_();
  this.data[cah.$.AjaxRequest.GAME_ID] = gameId;
  return this;
};

/**
 * @param {number}
 *          cardId Card id field to use in the request.
 * @returns {cah.ajax.Builder} This object.
 */
cah.ajax.Builder.prototype.withCardId = function(cardId) {
  this.assertNotExecuted_();
  this.data[cah.$.AjaxRequest.CARD_ID] = cardId;
  return this;
};

/**
 * @param {Array}
 *          cardSets List of card set ids to use in the request.
 * @returns {cah.ajax.Builder} This object.
 */
cah.ajax.Builder.prototype.withCardSets = function(cardSets) {
  this.assertNotExecuted_();
  this.data[cah.$.AjaxRequest.CARD_SETS] = cardSets.join(',');
  return this;
};

/**
 * @param {number}
 *          playerLimit Player limit field to use in the request.
 * @returns {cah.ajax.Builder} This object.
 */
cah.ajax.Builder.prototype.withPlayerLimit = function(playerLimit) {
  this.assertNotExecuted_();
  this.data[cah.$.AjaxRequest.PLAYER_LIMIT] = playerLimit;
  return this;
};

/**
 * @param {number}
 *          scoreLimit Score limit field to use in the request.
 * @returns {cah.ajax.Builder} This object.
 */
cah.ajax.Builder.prototype.withScoreLimit = function(scoreLimit) {
  this.assertNotExecuted_();
  this.data[cah.$.AjaxRequest.SCORE_LIMIT] = scoreLimit;
  return this;
};

/**
 * @param {string}
 *          password Password field to use in the request.
 * @returns {cah.ajax.Builder} This object.
 */
cah.ajax.Builder.prototype.withPassword = function(password) {
  this.assertNotExecuted_();
  this.data[cah.$.AjaxRequest.PASSWORD] = password;
  return this;
};

/**
 * @param {boolean}
 *          useTimer Whether or not the game should use the idle timer.
 * @returns {cah.ajax.Builder} This object.
 */
cah.ajax.Builder.prototype.withUseTimer = function(useTimer) {
  this.assertNotExecuted_();
  this.data[cah.$.AjaxRequest.USE_TIMER] = useTimer;
  return this;
};

/**
 * @param {boolean}
 *          wall Whether or not this is a warn-all ("wall").
 * @returns {cah.ajax.Builder} This object.
 */
cah.ajax.Builder.prototype.withWall = function(wall) {
  this.assertNotExecuted_();
  this.data[cah.$.AjaxRequest.WALL] = wall;
  return this;
};

/**
 * Assert that the request from this builder has not already run. Throws an exception if it has.
 * 
 * @private
 */
cah.ajax.Builder.prototype.assertNotExecuted_ = function() {
  if (this.run_) {
    throw "Request already executed.";
  }
};

/**
 * Assert that the request from this builder has already run. Throws an exception if it has not.
 * 
 * @private
 */
cah.ajax.Builder.prototype.assertExecuted_ = function() {
  if (!this.run_) {
    throw "Request not yet executed.";
  }
};

/**
 * @returns {string} The operation code of the request this builder built.
 */
cah.ajax.Builder.prototype.getOp = function() {
  this.assertExecuted_();
  return this.data[cah.$.AjaxRequest.OP];
};

/**
 * @returns {number} The serial id of the request this builder built.
 */
cah.ajax.Builder.prototype.getSerial = function() {
  this.assertExecuted_();
  return this.data[cah.$.AjaxRequest.SERIAL];
};