t2-server 0.6.1 → 0.9.0

data/bin/t2-server-admin

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2010-2012 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 'rubygems'
+require 't2-server-cli'
+require 'hirb'
+
+include T2Server::CLI
+
+set = {}
+options = {}
+conn_params, creds = register_options("Usage: t2-server-admin [options] " +
+  "server-address [resource(s)]") do |opt|
+  opt.separator "  Where server-address is the full URI of the server to"
+  opt.separator "  connect to, e.g.: http://example.com:8080/taverna"
+  opt.separator "  and [options] can be:"
+  opt.on("-l", "--list", "List all administrative resources.") do
+    options[:list] = true
+  end
+  opt.on("-a", "--all",
+    "List all administrative resources and their current values.") do
+      options[:all] = true
+  end
+  opt.on("-s RESOURCE:VALUE", "--set=RESOURCE:VALUE",
+    "Set admin resource RESOURCE to VALUE.") do |val|
+      resource, value = val.chomp.split(':', 2)
+      set[resource.downcase] = value
+  end
+end
+
+# get runs and server address from the arguments
+resources = []
+address = ""
+for arg in ARGV
+  argc = arg.chomp
+  if argc.match(/https?:\/\//).nil?
+    resources << argc
+  else
+    address = argc
+  end
+end
+
+# read and check server address and credentials
+uri, creds = parse_address(address, creds)
+
+# pretty printer for resource access mode
+def access(write)
+  write ? "read/write" : "read only"
+end
+
+begin
+  server = T2Server::Server.new(uri, conn_params)
+
+  server.administrator(creds) do |admin|
+    # list and exit?
+    if options[:list]
+      puts (Hirb::Helpers::ObjectTable.render admin.resources.values,
+              :fields=>[:name, :writable?],
+              :headers=>{:name => 'Resource name', :writable? => 'Access'},
+              :filters=>{:writable? => :access},
+              :description=>false)
+      exit 0
+    end
+
+    # enumerate all resources?
+    resources = admin.resources.keys if options[:all]
+
+    # list given resources and their values
+    resources.each do |resource|
+      begin
+        res = admin[resource]
+        result = res.value
+        puts "#{res.name}\t#{result}"
+      rescue => e
+        puts "#{res.name}\tERROR! - #{e}"
+      end
+    end
+
+    # set resources as requested
+    admin.resources.each do |name, resource|
+      if set.include? name and resource.writable?
+        begin
+          resource.value = set[name]
+          puts "Resource #{resource.name} set to '#{set[name]}'"
+        rescue => e
+          puts "Failed to set resource #{resource.name} - #{e}"
+        end
+      end
+    end
+  end
+rescue T2Server::AccessForbiddenError => e
+  puts "You are not authorized to access the administrator interface of " +
+    "this server\n(#{uri})."
+  exit 1
+rescue RuntimeError => e
+  puts e
+  exit 1
+end

data/bin/t2-server-info

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# Copyright (c) 2010, 2011 The University of Manchester, UK.
+# Copyright (c) 2010-2012 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -15,7 +15,7 @@
 #
 #  * 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. 
+#    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
@@ -32,53 +32,40 @@
 # Author: Robert Haines
 
 require 'rubygems'
-require 't2-server'
-require 'optparse'
+require 't2-server-cli'
 require 'hirb'
 
-opts = OptionParser.new do |opt|
-  opt.banner = "Usage: t2-server-info [options] server-address"
-  opt.separator ""
+include T2Server::CLI
+
+conn_params, creds = register_options("Usage: t2-server-info [options] " +
+  "server-address") do |opt|
   opt.separator "  Where server-address is the full URI of the server to"
   opt.separator "  connect to, e.g.: http://example.com:8080/taverna"
   opt.separator "  and [options] can be:"
-  opt.on_tail("-h", "-?", "--help", "Show this message") do
-    puts opt
-    exit
-  end
-  opt.on_tail("-v", "--version", "Show the version") do
-    puts "Taverna 2 Server Ruby Gem version: #{T2Server::GEM_VERSION}"
-    puts "Taverna 2 Server REST API version: #{T2Server::API_VERSION}"
-    exit
-  end
 end
 
-# parse options
-opts.parse!
-
-# read and check server address
-uri = ARGV.shift
-if uri == nil
-  puts opts
-  exit 1
-end
+# read and check server address and credentials
+uri, creds = parse_address(ARGV.shift, creds)
 
 # connect to server and output information
 begin
-  server = T2Server::Server.connect(uri)
-  print "     Server: #{uri}\n"
-  print "  Run limit: #{server.run_limit}\n"
-  runs = server.runs
-  print "No. of runs: #{runs.length}\n"
-  if runs.length > 0
-    puts (Hirb::Helpers::ObjectTable.render runs,
-      :fields=>[:uuid, :status, :expiry],
-      :headers=>{:uuid=>'Run ID', :status=>'Status', :expiry=>'Expiry time (local)'},
-      :filters=>{:expiry=>[:strftime, "%H:%M:%S %d/%m/%Y"]},
-      :max_fields=>{:expiry=>19},
-      :description=>false)
+  T2Server::Server.new(uri, conn_params) do |server|
+    print "     Server: #{server.uri}\n"
+    print "    Version: #{server.version}\n"
+    print "  Run limit: #{server.run_limit(creds)}\n"
+    runs = server.runs(creds)
+    print "No. of runs: #{runs.length}\n"
+    if runs.length > 0
+      puts (Hirb::Helpers::ObjectTable.render runs,
+        :fields=>[:identifier, :status, :expiry],
+        :headers=>{:identifier=>'Run ID', :status=>'Status',
+          :expiry=>'Expiry time (local)'},
+        :filters=>{:expiry=>[:strftime, "%H:%M:%S %d/%m/%Y"]},
+        :max_fields=>{:expiry=>19},
+        :description=>false)
+    end
   end
-rescue T2Server::T2ServerError => e
+rescue RuntimeError => e
   puts e
   exit 1
 end

data/lib/t2-server-cli.rb

@@ -0,0 +1,116 @@
+# Copyright (c) 2010-2012 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 'optparse'
+require 't2-server'
+
+module T2Server
+  module CLI
+    @opts = nil
+
+    # set up common options and return creds if provided
+    def register_options(banner)
+      user = nil
+      pass = ""
+      conn_params = DefaultConnectionParameters.new
+
+      @opts = OptionParser.new do |opt|
+        opt.banner = banner
+        if block_given?
+          yield opt
+        end
+
+        # SSL options
+        opt.on("-E CERT_FILE:PASSWORD", "--cert=CERT_FILE:PASSWORD", "Use " +
+          "the specified certificate file for client authentication. If the " +
+          "optional password is not provided it will be asked for on the " +
+          "command line. Must be in PEM format.") do |val|
+            cert, cpass = val.chomp.split(":", 2)
+            conn_params[:client_certificate] = cert
+            conn_params[:client_password] = cpass if cpass
+        end
+        opt.on("--cacert=CERT_FILE", "Use the specified certificate file to " +
+          "verify the peer. Must be in PEM format.") do |val|
+            conn_params[:ca_file] = val.chomp
+        end
+        opt.on("--capath=CERTS_PATH", "Use the specified certificate " +
+          "directory to verify the peer. Certificates must be in PEM " +
+          "format") do |val|
+            conn_params[:ca_path] = val.chomp
+        end
+        opt.on("-k", "--insecure", "Allow insecure connections: no peer " +
+          "verification.") do
+            conn_params[:verify_peer] = false
+        end
+
+        # common options
+        opt.on_tail("-u", "--username=USERNAME", "The username to use for " +
+          "server operations.") do |val|
+            user = val.chomp
+        end
+        opt.on_tail("-p", "--password=PASSWORD", "The password to use for " +
+          "the supplied username.") do |val|
+            pass = val.chomp
+        end
+        opt.on_tail("-h", "-?", "--help", "Show this help message.") do
+          puts opt
+          exit
+        end
+        opt.on_tail("-v", "--version", "Show the version.") do
+          puts "Taverna 2 Server Ruby Gem version: #{T2Server::Version::STRING}"
+          exit
+        end
+      end
+
+      # parse options
+      @opts.parse!
+
+      creds = user.nil? ? nil : HttpBasic.new(user, pass)
+      [conn_params, creds]
+    end
+
+    # separate the creds if they are supplied in the uri
+    def parse_address(address, creds)
+      if address == nil or address == ""
+        puts @opts
+        exit 1
+      end
+
+      p_uri, p_creds = Util.strip_uri_credentials(address)
+      creds != nil ? [p_uri, creds] : [p_uri, p_creds]
+    end
+
+    def opts
+      @opts
+    end
+  end
+end

data/lib/t2-server.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010, 2011 The University of Manchester, UK.
+# Copyright (c) 2010-2012 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -14,7 +14,7 @@
 #
 #  * 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. 
+#    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
@@ -30,10 +30,17 @@
 #
 # Author: Robert Haines
 
-require 't2-server/xml'
+require 'yaml'
+require 't2-server/util'
+require 't2-server/xml/xml'
 require 't2-server/exceptions'
+require 't2-server/credentials'
+require 't2-server/connection'
+require 't2-server/connection-parameters'
+require 't2-server/port'
 require 't2-server/server'
 require 't2-server/run'
+require 't2-server/admin'
 
 # This is a Ruby library to interface with the Taverna 2 Server REST API.
 #
@@ -42,30 +49,12 @@ require 't2-server/run'
 # * T2Server::Server - Use this if you are providing a web interface to a
 #   Taverna 2 Server instance.
 module T2Server
-  # The version of this library
-  GEM_VERSION = "0.6.1"
-  # The version of the Taverna 2 Server API that this library can interface with
-  API_VERSION = "2.2a1"
-end
-
-# Add methods to the String class to operate on file paths.
-class String
-  # :call-seq:
-  #   str.strip_path -> string
-  #
-  # Returns a new String with one leading and one trailing slash
-  # removed from the ends of _str_ (if present).
-  def strip_path
-    self.gsub(/^\//, "").chomp("/")
-  end
+  module Version
+    # Version information in a Hash
+    INFO = YAML.load_file(File.join(File.dirname(__FILE__), "..",
+      "version.yml"))
 
-  # :call-seq:
-  #   str.strip_path! -> str or nil
-  #
-  # Modifies _str_ in place as described for String#strip_path,
-  # returning _str_, or returning +nil+ if no modifications were made. 
-  def strip_path!
-    g = self.gsub!(/^\//, "")
-    self.chomp!("/") || g
+    # Version number as a String
+    STRING = [:major, :minor, :patch].map {|d| INFO[d]}.compact.join('.')
   end
 end

data/lib/t2-server/admin.rb

@@ -0,0 +1,147 @@
+# Copyright (c) 2010-2012 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
+
+module T2Server
+
+  # This call provides access to the administrative interface of a Taverna
+  # Server instance.
+  #
+  # To get an instance of this class use the Server#administrator method.
+  # Special permissions will most likely be required above and beyond those
+  # assigned to most Taverna Server users.
+  class Administrator
+    include XML::Methods
+
+    # The resources held by this administrative interface. This is a Hash
+    # indexed by the name of the resource in lowercase.
+    attr_reader :resources
+
+    # :stopdoc:
+    def initialize(server, credentials = nil)
+      @server = server
+      @credentials = credentials
+
+      admin_description = xml_document(@server.get_admin_attribute("",
+        @credentials))
+      @resources = get_resources(admin_description)
+      #@resources.each {|key, value| puts "#{key}: #{value}"}
+
+      yield(self) if block_given?
+    end
+    # :startdoc:
+
+    # :call-seq:
+    #   [name] -> AdminResource
+    #
+    # Return the named AdminResource.
+    def [](name)
+      @resources[name.downcase]
+    end
+
+    # :stopdoc:
+    def get_resource_value(path)
+      @server.get_admin_attribute(path, @credentials)
+    end
+
+    def set_resource_value(path, val)
+      @server.set_admin_attribute(path, val.to_s, @credentials)
+    end
+    # :startdoc:
+
+    private
+    def get_resources(doc)
+      links = {}
+
+      xml_children(doc.root) do |res|
+        path = xml_node_attribute(res, 'href').split('/')[-1]
+        write = @server.admin_resource_writable?(path, @credentials)
+        links[res.name.downcase] = AdminResource.new(res.name, path,
+          write, self)
+      end
+
+      links
+    end
+
+    # This class represents a resource in the Taverna Server administrative
+    # interface. A resource can be read only or read/write.
+    #
+    # Resources are created when the parent Administrator class is created and
+    # are accessed via the [] method within that class.
+    class AdminResource
+      # The name of this resource.
+      attr_reader :name
+
+      # The path to this resource on the server.
+      attr_reader :path
+
+      # :stopdoc:
+      def initialize(name, path, writeable, parent)
+        @name = name
+        @path = path
+        @admin = parent
+        @writeable = writeable
+
+        make_writable if @writeable
+      end
+      # :startdoc:
+
+      # :call-seq:
+      #   value -> String
+      #   value=
+      #
+      # Get or set the value held by this resource. This call always queries
+      # the server as values can change without user intervention.
+      #
+      # The resource can only be set if it is writable.
+      def value
+        @admin.get_resource_value(@path)
+      end
+
+      # :call-seq:
+      #   writable? -> bool
+      #
+      # Is this resource writable?
+      def writable?
+        @writeable
+      end
+
+      private
+      def make_writable
+        (class << self; self; end).instance_eval do
+          define_method "value=" do |value|
+            @admin.set_resource_value(@path, value)
+          end
+        end
+      end
+    end
+  end
+end