openproject/frontend/app/api/hal-api-resource.js

//-- copyright
// OpenProject is a project management system.
// Copyright (C) 2012-2015 the OpenProject Foundation (OPF)
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License version 3.
//
// OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
// Copyright (C) 2006-2013 Jean-Philippe Lang
// Copyright (C) 2010-2013 the ChiliProject Team
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//
// See doc/COPYRIGHT.rdoc for more details.
//++

/* globals Hyperagent */
require('hyperagent');

module.exports = function HALAPIResource($timeout, $q, PathHelper) {
  'use strict';
  var configure = function() {
    Hyperagent.configure('ajax', function(settings) {
      var deferred = $q.defer(),
          resolve = settings.success,
          reject = settings.error;

      settings.success = deferred.resolve;
      settings.reject = deferred.reject;

      deferred.promise.then(function(response) {
        $timeout(function() { resolve(response); });
      }, function(reason) {
        $timeout(function() { reject(reason); });
      });

      return jQuery.ajax(settings);
    });
    Hyperagent.configure('defer', $q.defer);
    // keep this if you want null values to not be overwritten by
    // Hyperagent.js miniscore
    // this weird line replaces HA miniscore with normal underscore
    // Freud would be happy with what ('_', _) reminds me of
    Hyperagent.configure('_', _);
  };
  return {
    setup: function(uri, params) {
      if (!params) {
        params = {};
      }
      configure();
      var url = PathHelper.appBasePath + PathHelper.apiV3 + '/' + uri;
      var link = new Hyperagent.Resource(_.extend({
        url: url
      }, params));
      if (params.method) {
        link.props.href = url;
        link.props.method = params.method;
      }
      return link;
    }
  };
};