t2-server 1.0.0 → 1.1.0

data/lib/t2-server/server.rb

@@ -148,8 +148,7 @@ module T2Server
       create(links[:runs], workflow, "application/vnd.taverna.t2flow+xml",
         credentials)
     rescue AccessForbiddenError => afe
-      (major, minor, patch) = version_components
-      if minor == 4 && patch >= 2
+      if version >= "2.4.2"
         # Need to re-raise as it's a real error for later versions.
         raise afe
       else
@@ -159,26 +158,22 @@ module T2Server
     # :startdoc:
 
     # :call-seq:
-    #   version -> string
+    #   version -> Server::Version
     #
-    # The version string of the remote Taverna Server.
+    # An object representing the version of the remote Taverna Server.
     def version
       @version ||= _get_version
     end
 
-    # :call-seq:
-    #   version_components -> array
-    #
-    # An array of the major, minor and patch version components of the remote
-    # Taverna Server.
+    # :stopdoc:
     def version_components
-      if @version_components.nil?
-        comps = version.split(".")
-        @version_components = comps.map { |v| v.to_i }
-      end
+      warn "[DEPRECATED] Server#version_components is deprecated and will "\
+        "be removed in the next major release. Please use "\
+        "Server#version.to_a instead."
 
-      @version_components
+      version.to_a
     end
+    # :startdoc:
 
     # :call-seq:
     #   uri -> URI
@@ -233,12 +228,10 @@ module T2Server
     end
 
     def upload_file(filename, uri, remote_name, credentials = nil)
-      # Different Server versions support different upload methods
-      (major, minor, patch) = version_components
-
       remote_name = filename.split('/')[-1] if remote_name == ""
 
-      if minor == 4 && patch >= 1
+      # Different Server versions support different upload methods
+      if version >= "2.4.1"
         File.open(filename, "rb") do |file|
           upload_data(file, remote_name, uri, credentials)
         end
@@ -250,9 +243,7 @@ module T2Server
 
     def upload_data(data, remote_name, uri, credentials = nil)
       # Different Server versions support different upload methods
-      (major, minor, patch) = version_components
-
-      if minor == 4 && patch >= 1
+      if version >= "2.4.1"
         put_uri = Util.append_to_uri_path(uri, remote_name)
         @connection.PUT(put_uri, data, "application/octet-stream", credentials)
       else
@@ -357,21 +348,13 @@ module T2Server
     def _get_version
       doc = _get_server_description
       version = xpath_attr(doc, @@xpaths[:server], "serverVersion")
-      if version == nil
+
+      if version.nil?
         raise RuntimeError.new("Taverna Servers prior to version 2.3 " +
           "are no longer supported.")
-      else
-        # Remove extra version tags if present.
-        version.gsub!("-SNAPSHOT", "")
-        version.gsub!(/alpha[0-9]*/, "")
-
-        # Add .0 if we only have a major and minor component.
-        if version.split(".").length == 2
-          version += ".0"
-        end
-
-        return version
       end
+
+      Version.new(version)
     end
 
     def _get_server_links
@@ -400,5 +383,84 @@ module T2Server
       @run_cache.refresh_all!(run_list, credentials)
     end
 
+    # Represents a Taverna Server version number in a way that can be compared
+    # to other version numbers or strings.
+    #
+    # This class mixes in Comparable so all the usual comparison operators
+    # work as expected.
+    class Version
+      include Comparable
+
+      # :call-seq:
+      #   new(version_string) -> Version
+      #
+      # Create a new Version object from the supplied version string.
+      def initialize(version)
+        @string = parse_version(version)
+        @array = []
+      end
+
+      # :call-seq:
+      #   to_s -> String
+      #
+      # Convert this Version object back into a String.
+      def to_s
+        @string
+      end
+
+      # :call-seq:
+      #   to_a -> Array
+      #
+      # Convert this Version object into an array of numbers representing the
+      # components of the version number. The order of the components is:
+      # * Major
+      # * Minor
+      # * Patch
+      #
+      # For example:
+      #   Version.new("2.5.1").to_a == [2, 5, 1]
+      def to_a
+        if @array.empty?
+          comps = @string.split(".")
+          @array = comps.map { |v| v.to_i }
+        end
+
+        @array
+      end
+
+      # :call-seq:
+      #   version <=> other -> -1, 0 or +1
+      #
+      # Returns -1, 0 or +1 depending of whether +version+ is less than,
+      # equal to or greater than +other+.
+      #
+      # This is the basis for the tests in Comparable.
+      def <=>(other)
+        other = Version.new(other) if other.instance_of?(String)
+        self.to_a.zip(other.to_a).each do |c|
+          comp = c[0] <=> c[1]
+          return comp unless comp == 0
+        end
+
+        # If we get here then we know we have equal version numbers.
+        0
+      end
+
+      private
+
+      def parse_version(version)
+        # Remove extra version tags if present.
+        version.gsub!("-SNAPSHOT", "")
+        version.gsub!(/alpha[0-9]*/, "")
+
+        # Add .0 if we only have a major and minor component.
+        if version.split(".").length == 2
+          version += ".0"
+        end
+
+        version
+      end
+    end
+
   end
 end

data/lib/t2-server/{xml/rexml.rb → version.rb}

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2013 The University of Manchester, UK.
+# Copyright (c) 2010-2014 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,57 +30,17 @@
 #
 # Author: Robert Haines
 
-require 'rexml/document'
-require 'rexml/text'
+require 'yaml'
 
 module T2Server
-  module XML
 
-    module Methods
-      def xml_document(string)
-        REXML::Document.new(string)
-      end
+  # Library version information.
+  module Version
+    # Version information in a Hash
+    INFO = YAML.load_file(File.join(File.dirname(__FILE__), "..", "..",
+      "version.yml"))
 
-      def xml_text_node(text)
-        REXML::Text.new(text).to_s
-      end
-
-      def xml_first_child(node)
-        node.first
-      end
-
-      def xml_children(doc, &block)
-        doc.each { |node| yield node }
-      end
-
-      def xml_node_name(node)
-        node.name
-      end
-
-      def xml_node_content(node)
-        node.text
-      end
-
-      def xml_node_attribute(node, attribute)
-        node.attributes[attribute]
-      end
-
-      def xpath_compile(xpath)
-        xpath
-      end
-
-      def xpath_find(doc, expr)
-        REXML::XPath.each(doc, expr, Namespaces::MAP)
-      end
-
-      def xpath_first(doc, expr)
-        REXML::XPath.first(doc, expr, Namespaces::MAP)
-      end
-
-      def xpath_attr(doc, expr, attribute)
-        node = xpath_first(doc, expr)
-        node.nil? ? nil : node.attributes[attribute]
-      end
-    end
+    # Version number as a String
+    STRING = [:major, :minor, :patch].map {|d| INFO[d]}.compact.join('.')
   end
 end

data/lib/t2-server/xml.rb

@@ -0,0 +1,36 @@
+# Copyright (c) 2010-2014 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
+
+require_relative 'xml/namespaces'
+require_relative 'xml/fragments'
+require_relative 'xml/methods'
+require_relative 'xml/xpath_cache'

data/lib/t2-server/xml/{xml.rb → fragments.rb}

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2013 The University of Manchester, UK.
+# Copyright (c) 2010-2014 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,34 +30,8 @@
 #
 # Author: Robert Haines
 
-begin
-  require 't2-server/xml/libxml'
-rescue LoadError
-  begin
-    require 't2-server/xml/nokogiri'
-  rescue LoadError
-    require 't2-server/xml/rexml'
-  end
-end
-require 't2-server/xml/xpath_cache'
-
 module T2Server
   module XML
-
-    module Namespaces
-      SERVER = "http://ns.taverna.org.uk/2010/xml/server/"
-      REST   = SERVER + "rest/"
-      ADMIN  = SERVER + "admin/"
-      PORT   = "http://ns.taverna.org.uk/2010/port/"
-
-      MAP    = {
-        "nss"  => Namespaces::SERVER,
-        "nsr"  => Namespaces::REST,
-        "nsa"  => Namespaces::ADMIN,
-        "port" => Namespaces::PORT
-      }
-    end
-
     module Fragments
       WORKFLOW      = "<t2s:workflow xmlns:t2s=\"#{Namespaces::SERVER}\">\n"\
                         "  %s\n</t2s:workflow>"
@@ -100,23 +74,5 @@ module T2Server
                         "  <t2s:fileType>%s</t2s:fileType>\n"\
                         "</t2s:trustedIdentity>"
     end
-
-    module Methods
-      # Most methods in this module are provided by the particular XML
-      # library selected above.
-
-      # Given a list of xpath keys, extract the href URIs from those elements.
-      def get_uris_from_doc(doc, keys)
-        cache = XPathCache.instance
-        uris = {}
-
-        keys.each do |key|
-          uri = xpath_attr(doc, cache[key], "href")
-          uris[key] = uri.nil? ? nil : URI.parse(uri)
-        end
-
-        uris
-      end
-    end
   end
 end

data/lib/t2-server/xml/{libxml.rb → methods.rb}

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2013 The University of Manchester, UK.
+# Copyright (c) 2010-2014 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,7 +30,6 @@
 #
 # Author: Robert Haines
 
-require 'rubygems'
 require 'libxml'
 
 module T2Server
@@ -83,6 +82,19 @@ module T2Server
         node = xpath_first(doc, expr)
         node.nil? ? nil : node.attributes[attribute]
       end
+
+      # Given a list of xpath keys, extract the href URIs from those elements.
+      def get_uris_from_doc(doc, keys)
+        cache = XPathCache.instance
+        uris = {}
+
+        keys.each do |key|
+          uri = xpath_attr(doc, cache[key], "href")
+          uris[key] = uri.nil? ? nil : URI.parse(uri)
+        end
+
+        uris
+      end
     end
   end
 end

data/lib/t2-server/xml/{nokogiri.rb → namespaces.rb}

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2013 The University of Manchester, UK.
+# Copyright (c) 2010-2014 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,57 +30,20 @@
 #
 # Author: Robert Haines
 
-require 'rubygems'
-require 'nokogiri'
-
 module T2Server
   module XML
-
-    module Methods
-      def xml_document(string)
-        Nokogiri::XML(string)
-      end
-
-      def xml_text_node(text)
-        Nokogiri::XML::Text.new(text, Nokogiri::XML::Document.new).to_s
-      end
-
-      def xml_first_child(node)
-        node.first_element_child
-      end
-
-      def xml_children(doc, &block)
-        doc.children.each(&block)
-      end
-
-      def xml_node_name(node)
-        node.node_name
-      end
-
-      def xml_node_content(node)
-        node.content
-      end
-
-      def xml_node_attribute(node, attribute)
-        node[attribute]
-      end
-
-      def xpath_compile(xpath)
-        xpath
-      end
-
-      def xpath_find(doc, expr)
-        doc.xpath(expr, Namespaces::MAP)
-      end
-
-      def xpath_first(doc, expr)
-        doc.at_xpath(expr, Namespaces::MAP)
-      end
-
-      def xpath_attr(doc, expr, attribute)
-        node = xpath_first(doc, expr)
-        node.nil? ? nil : node[attribute]
-      end
+    module Namespaces
+      SERVER = "http://ns.taverna.org.uk/2010/xml/server/"
+      REST   = SERVER + "rest/"
+      ADMIN  = SERVER + "admin/"
+      PORT   = "http://ns.taverna.org.uk/2010/port/"
+
+      MAP    = {
+        "nss"  => Namespaces::SERVER,
+        "nsr"  => Namespaces::REST,
+        "nsa"  => Namespaces::ADMIN,
+        "port" => Namespaces::PORT
+      }
     end
   end
 end