t2-server 0.1.1 → 0.2.0

data/README.rdoc

@@ -1,7 +1,7 @@
 = Taverna[http://www.taverna.org.uk/] 2 Server Interaction Gem
 
 Authors::     Robert Haines
-Gem Version:: 0.1.1
+Gem Version:: 0.2.0
 API Version:: 2.2a1
 Contact::     mailto:rhaines@manchester.ac.uk
 URL::         http://taverna.sourceforge.net/

data/lib/t2server/exceptions.rb

@@ -139,6 +139,17 @@ module T2Server
     end
   end
 
+  # Access to the server is denied to this username
+  class AuthorizationError < T2ServerError
+    attr_reader :username
+
+    # Create a new AuthorizationError with the rejected username
+    def initialize(username)
+      @username = username
+      super "The username '#{@username}' is not authorized to connect to this server"
+    end
+  end
+
   # Raised if an operation is performed on a run when it is in the wrong
   # state. Trying to start a run if it is the finished state would cause this
   # exception to be raised.

data/lib/t2server/server.rb

@@ -32,7 +32,7 @@
 
 require 'base64'
 require 'uri'
-require 'net/http'
+require 'net/https'
 require 'rexml/document'
 include REXML
 
@@ -50,19 +50,33 @@ module T2Server
     # Runs in any state (+Initialized+, +Running+ and +Finished+) are counted
     # against this maximum.
     attr_reader :run_limit
-    
+
     # list of servers we know about
     @@servers = []
     
     # :stopdoc:
     # New is private but rdoc does not get it right! Hence :stopdoc: section.
-    def initialize(uri)
+    def initialize(uri, username, password)
       @uri = uri.strip_path
       uri = URI.parse(@uri)
       @host = uri.host
       @port = uri.port
       @base_path = uri.path
       @rest_path = uri.path + "/rest"
+
+      # set up http connection
+      @http = Net::HTTP.new(@host, @port)
+
+      # use ssl?
+      @ssl = uri.scheme == "https"
+      if ssl?
+        @username = uri.user || username
+        @password = uri.password || password
+        
+        @http.use_ssl = true
+        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
       @links = parse_description(get_attribute(@rest_path))
       #@links.each {|key, val| puts "#{key}: #{val}"}
       
@@ -76,19 +90,20 @@ module T2Server
     # :startdoc:
 
     # :call-seq:
-    #   Server.connect(uri) -> server
+    #   Server.connect(uri, username="", password="") -> server
     #
     # Connect to the server specified by _uri_ which should be of the form:
-    # http://example.com:8888/blah
+    # http://example.com:8888/blah or https://user:pass@example.com:8888/blah
     #
+    # The username and password can also be passed in separately.
     # A Server instance is returned that represents the connection.
-    def Server.connect(uri)
+    def Server.connect(uri, username="", password="")
       # see if we've already got this server
       server = @@servers.find {|s| s.uri == uri}
 
       if !server
         # no, so create new one and return it
-        server = new(uri)
+        server = new(uri, username, password)
         @@servers << server
       end
       
@@ -112,10 +127,11 @@ module T2Server
     def initialize_run(workflow)
       request = Net::HTTP::Post.new("#{@links[:runs]}")
       request.content_type = "application/xml"
+      if ssl?
+        request.basic_auth @username, @password
+      end
       begin
-        response = Net::HTTP.new(@host, @port).start do |http|
-          http.request(request, Fragments::WORKFLOW % workflow)
-        end
+        response = @http.request(request, Fragments::WORKFLOW % workflow)
       rescue InternalHTTPError => e
         raise ConnectionError.new(e)
       end
@@ -127,11 +143,21 @@ module T2Server
         epr.path[-36..-1]
       when Net::HTTPForbidden
         raise ServerAtCapacityError.new(@run_limit)
+      when Net::HTTPUnauthorized
+        raise AuthorizationError.new(@username)
       else
         raise UnexpectedServerResponse.new(response)
       end
     end
 
+    # :call-seq:
+    #   server.ssl? -> bool
+    #
+    # Is this server using SSL?
+    def ssl?
+      @ssl
+    end
+
     # :call-seq:
     #   server.runs -> [runs]
     #
@@ -154,8 +180,11 @@ module T2Server
     # Delete the specified run from the server, discarding all of its state.
     def delete_run(uuid)
       request = Net::HTTP::Delete.new("#{@links[:runs]}/#{uuid}")
+      if ssl?
+        request.basic_auth @username, @password
+      end
       begin
-        response = Net::HTTP.new(@host, @port).start {|http| http.request(request)}
+        response = @http.request(request)
       rescue InternalHTTPError => e
         raise ConnectionError.new(e)
       end
@@ -169,6 +198,8 @@ module T2Server
         raise RunNotFoundError.new(uuid)
       when Net::HTTPForbidden
         raise AccessForbiddenError.new("run #{uuid}")
+      when Net::HTTPUnauthorized
+        raise AuthorizationError.new(@username)
       else
         raise UnexpectedServerResponse.new(response)
       end
@@ -223,10 +254,11 @@ module T2Server
       raise AccessForbiddenError.new("subdirectories (#{dir})") if dir.include? ?/
       request = Net::HTTP::Post.new("#{@links[:runs]}/#{uuid}/#{root}")
       request.content_type = "application/xml"
+      if ssl?
+        request.basic_auth @username, @password
+      end
       begin
-        response = Net::HTTP.new(@host, @port).start do |http|
-          http.request(request,  Fragments::MKDIR % dir)
-        end
+        response = @http.request(request, Fragments::MKDIR % dir)
       rescue InternalHTTPError => e
         raise ConnectionError.new(e)
       end
@@ -239,6 +271,8 @@ module T2Server
         raise RunNotFoundError.new(uuid)
       when Net::HTTPForbidden
         raise AccessForbiddenError.new("#{dir} on run #{uuid}")
+      when Net::HTTPUnauthorized
+        raise AuthorizationError.new(@username)
       else
         raise UnexpectedServerResponse.new(response)
       end
@@ -254,10 +288,11 @@ module T2Server
       rename = filename.split('/')[-1] if rename == ""
       request = Net::HTTP::Post.new("#{@links[:runs]}/#{uuid}/#{location}")
       request.content_type = "application/xml"
+      if ssl?
+        request.basic_auth @username, @password
+      end
       begin
-        response = Net::HTTP.new(@host, @port).start do |http|
-          http.request(request,  Fragments::UPLOAD % [rename, contents])
-        end
+        response = @http.request(request,  Fragments::UPLOAD % [rename, contents])
       rescue InternalHTTPError => e
         raise ConnectionError.new(e)
       end
@@ -270,6 +305,8 @@ module T2Server
         raise RunNotFoundError.new(uuid)
       when Net::HTTPForbidden
         raise AccessForbiddenError.new("run #{uuid}")
+      when Net::HTTPUnauthorized
+        raise AuthorizationError.new(@username)
       else
         raise UnexpectedServerResponse.new(response)
       end
@@ -306,8 +343,11 @@ module T2Server
     private
     def get_attribute(path)
       request = Net::HTTP::Get.new(path)
+      if ssl?
+        request.basic_auth @username, @password
+      end
       begin
-        response = Net::HTTP.new(@host, @port).start {|http| http.request(request)}
+        response = @http.request(request)
       rescue InternalHTTPError => e
         raise ConnectionError.new(e)
       end
@@ -319,6 +359,8 @@ module T2Server
         raise AttributeNotFoundError.new(path)
       when Net::HTTPForbidden
         raise AccessForbiddenError.new("attribute #{path}")
+      when Net::HTTPUnauthorized
+        raise AuthorizationError.new(@username)
       else
         raise UnexpectedServerResponse.new(response)
       end
@@ -327,8 +369,11 @@ module T2Server
     def set_attribute(path, value, type)
       request = Net::HTTP::Put.new(path)
       request.content_type = type
+      if ssl?
+        request.basic_auth @username, @password
+      end
       begin
-        response = Net::HTTP.new(@host, @port).start {|http| http.request(request, value)}
+        response = @http.request(request, value)
       rescue InternalHTTPError => e
         raise ConnectionError.new(e)
       end
@@ -341,6 +386,8 @@ module T2Server
         raise AttributeNotFoundError.new(path)
       when Net::HTTPForbidden
         raise AccessForbiddenError.new("attribute #{path}")
+      when Net::HTTPUnauthorized
+        raise AuthorizationError.new(@username)
       else
         raise UnexpectedServerResponse.new(response)
       end

data/test/tc_server.rb

@@ -40,10 +40,6 @@ class TestServer < Test::Unit::TestCase
       @server = T2Server::Server.connect($address)
     end
     assert_not_nil(@server)
-    assert_raise(T2Server::ConnectionError) do
-      uri = URI.parse($address)
-      T2Server::Server.connect("http://#{uri.host}:22")
-    end
 
     # run creation
     assert_nothing_raised(T2Server::T2ServerError) do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: t2-server
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Robert Haines
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-03 00:00:00 +01:00
+date: 2010-09-22 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency