myGrid/t2-server-gem

# Copyright (c) 2010-2013 The University of Manchester, UK.
#
# 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.
#
#  * Neither the names of The University of Manchester nor the names of its
#    contributors may be used to endorse or promote products derived from this
#    software without specific prior written permission.
#
# 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 OWNER 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.
#
# Author: Robert Haines

# :stopdoc:
# This comment is needed to stop the above licence from being included in the
# documentation multiple times. Sigh.
module T2Server
# :startdoc:

  # This module contains various utility methods that the library uses
  # internally.
  module Util

    # :call-seq:
    #   Util.strip_uri_credentials(uri) -> URI, HttpBasic
    #
    # Strip user credentials from an address in URI or String format and return
    # a tuple of the URI minus the credentials and a T2Server::HttpBasic
    # object.
    def self.strip_uri_credentials(uri)
      # we want to use URIs here but strings can be passed in
      uri = URI.parse(Util.strip_path_slashes(uri)) unless uri.is_a? URI

      creds = nil

      # strip username and password from the URI if present
      if uri.user != nil
        creds = T2Server::HttpBasic.new(uri.user, uri.password)

        uri = URI::HTTP.new(uri.scheme, nil, uri.host, uri.port, nil,
        uri.path, nil, nil, nil);
      end

      [uri, creds]
    end

    # :call-seq:
    #   Util.strip_path_slashes(path) -> string
    #
    # Returns a new String with one leading and one trailing slash
    # removed from the ends of _path_ (if present).
    def self.strip_path_slashes(path)
      path.gsub(/^\//, "").chomp("/")
    end

    # :call-seq:
    #   Util.append_to_uri_path(uri, path) -> URI
    #
    # Appends a path to the end of the path of the given URI.
    def self.append_to_uri_path(uri, path)
      return uri if path == ""

      new_uri = uri.clone
      new_uri.path = "#{uri.path}/#{path}"

      new_uri
    end

    # :call-seq:
    #   Util.replace_uri_path(uri, path) -> URI
    #
    # Replace the given URI's path with a new one. The new path must be an
    # absolute path (start with a slash).
    def self.replace_uri_path(uri, path)
      new_uri = uri.clone
      new_uri.path = path

      new_uri
    end

    # :call-seq:
    #   Util.get_path_leaf_from_uri(uri) -> string
    #
    # Get the final component from the path of a URI. This method returns the
    # empty string (not _nil_ ) if the URI does not have a path.
    def self.get_path_leaf_from_uri(uri)
      path = uri.path.split("/")[-1]

      path.nil? ? "" : path
    end

  end
end