openproject/frontend/app/components/api/api-paths/api-paths.service.ts

// -- 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.
// ++

/**
 * Replaces the PathHelper service in its function, providing a way to generate safe paths
 * without having to store them directly in a service.
 */

export class ApiPathsService {
  public basePath:string;
  
  protected paths:{[name:string]:string};

  public get appBasePath():string {
    if (this.basePath === '') return this.basePath;

    return this.basePath =
      (this.basePath || this.$document.find('meta[name=app_base_path]').attr('content') || '')
        .replace(/\/$/, '');
  }

  constructor(protected $document) {
    this.paths = {
      v3: 'api/v3/',
      v2: 'api/v2/',
      experimental: 'api/experimental/'
    };
  }

  public path(name:string):string {
    return this.appBasePath + '/' + this.paths[name];
  }

  public get v3():string {
    return this.path('v3');
  }

  public get v2():string {
    return this.path('v2');
  }

  public get experimental():string {
    return this.path('experimental');
  }
}

angular
  .module('openproject.api')
  .service('apiPaths', ApiPathsService);