File: ../src/api/collections/aerisapicollection.js

define([
  'aeris/util',
  'aeris/collection',
  'aeris/api/mixins/aerisapibehavior',
  'aeris/jsonp'
], function(_, Collection, AerisApiBehavior, JSONP) {
  /**
   * A data collection which creates {aeris.Model} objects
   * from Aeris API response data.
   *
   * See http://www.hamweather.com/support/documentation/aeris/
   * for Aeris API documentation.
   *
   * @class aeris.api.collections.AerisApiCollection
   * @extends aeris.Collection
   * @uses aeris.api.mixins.AerisApiBehavior
   *
   *
   * @constructor
   * @param {Object=} opt_models
   *
   * @param {Object=} opt_options
   * @param {string=} opt_options.endpoint Aeris API endpoint.
   * @param {Object|Model=} opt_options.params Parameters with which to query the Aeris API.
   * @param {string=} opt_options.server The Aeris API server location.
   * @param {aeris.JSONP=} opt_options.JSONP object used for fetching batch data.
   */
  var AerisApiCollection = function(opt_models, opt_options) {
    var options = _.extend({
      endpoint: '',
      action: '',
      params: {},
      server: '//api.aerisapi.com',
      jsonp: JSONP
    }, opt_options);


    /**
     * Aeris API Endpoints from which
     * to request data.
     *
     * See http://www.hamweather.com/support/documentation/aeris/endpoints/
     * for available endpoints, actions, and parameters.
     *
     * @type {string}
     * @private
     * @property endpoint_
     */
    this.endpoint_ = options.endpoint;


    /**
     * Aeris API Action
     *
     * See http://www.hamweather.com/support/documentation/aeris/actions/
     *
     * @type {string}
     * @private
     * @property action_
     */
    this.action_ = options.action;


    /**
     * Location of the Aeris API server.
     *
     * @type {string}
     * @private
     * @property server_
     */
    this.server_ = options.server;


    /**
     * Parameters to include with the batch request.
     *
     * Note that parameters can also be attached
     * to individual endpoints defined in this.endpoints_.
     *
     * @type {aeris.api.params.models.Params|Object}
     *       Will be converted to Params instance, if passed in as a plain object.
     * @protected
     * @property params_
     */
    this.params_ = this.createParams_(options.params);


    /**
     * @type {aeris.JSONP}
     * @private
     * @property jsonp_
     */
    this.jsonp_ = options.jsonp;


    Collection.call(this, opt_models, options);
  };
  _.inherits(AerisApiCollection, Collection);
  _.extend(AerisApiCollection.prototype, AerisApiBehavior);


  /**
   * @method parse
   */
  AerisApiCollection.prototype.parse = function(data) {
    // This is a hack for dealing with nested id attributes.
    // Model data is not otherwise parsed (on fetch) before checking for
    // duplicates in a collection. This results in duplicate models in a collection.
    // See https://github.com/jashkenas/backbone/issues/3147#issuecomment-43108388
    // and http://jsfiddle.net/tT2D9/3/
    var rawModels = AerisApiBehavior.parse.call(this, data);
    var parsedModels = rawModels.map(this.model.prototype.parse);

    return parsedModels;
  };


  return _.expose(AerisApiCollection, 'aeris.api.AerisApiCollection');
});