simplews 1.7.3 → 1.8.1

data/README.rdoc

@@ -4,6 +4,8 @@ This library simplifies the creation of SOAP web services. It is based on
 soap4r, and adds a DSL for serving methods that create automatically the WSDL.
 Additionally, it offers support for asynchronous jobs.
 
+Documentation and detailed examples available at http://bioinfovm05.dacya.ucm.es/simplews/index.html
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/bin/start_jobs_ws

@@ -0,0 +1,53 @@
+#!/usr/bin/ruby
+require 'rubygems'
+require 'simplews'
+require "optparse"
+require 'simplews/rake'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{ $_ } [options] <config_file>"
+
+  opts.on("-h", "--host HOST", String, "Select host interface, localhost by default") do |host|
+    options[:host] = host
+  end
+
+  opts.on("-p", "--port PORT", Integer, "Select interface port, 1984 by default") do |port|
+    options[:port] = port
+  end
+
+  opts.on("-n", "--name NAME", String, "Select the name of the web server interface, SimpleWS by default") do |name|
+    options[:name] = name
+  end
+
+  opts.on("-d", "--description DESCRIPTION", String, "Description of the service") do |description|
+    options[:description] = description
+  end
+
+  opts.on("-w", "--wsdl FILENAME", String, "Save the WSDL file") do |filename|
+    options[:wsdl] = filename
+  end
+   
+  opts.on("-d", "--directory PATH", String, "Work directory for the WS") do |filename|
+    options[:wsdl] = filename
+  end
+  
+end.parse!
+
+filename = ARGV[0]
+
+server = SimpleWS::Jobs.new(options[:name], options[:description], options[:host], options[:port], options[:directory]) do
+  actions = File.open(filename)do |f| f.read end
+  eval actions
+end
+
+server.wsdl(options[:wsdl]) if options[:wsdl]
+
+trap('INT'){
+  puts "Stopping server"
+  server.shutdown
+}
+
+server.start
+
+

data/lib/simplews/jobs.rb

@@ -124,7 +124,7 @@ class SimpleWS::Jobs < SimpleWS
       name = @@pids.select{|name, p| p == pid}.first
       return if name.nil?
       name = name.first
-      puts "Process #{ name } with pid #{ pid } finished with exitstatus #{$?.exitstatus}"
+      puts "Job #{ name } with pid #{ pid } finished with exitstatus #{$?.exitstatus}"
       state = Job.job_info(name)
       if ![:error, :done, :aborted].include?(state[:status])
         state[:status] = :error
@@ -268,6 +268,8 @@ class SimpleWS::Jobs < SimpleWS
 
       def write(file, contents)
         path = Job.path(file, @name)
+        directory = File.dirname(File.expand_path(path))
+        FileUtils.mkdir_p directory unless File.exists? directory
         File.open(path,'w') do |fout|
           fout.write contents
         end
@@ -369,6 +371,7 @@ class SimpleWS::Jobs < SimpleWS
 
   def task(name, params=[], types={}, results = [], &block)
     @@last_param_description['return'] ||= 'Job identifier' if @@last_param_description
+    @@last_param_description['suggested_name'] ||= 'Suggested job id' if @@last_param_description
     
     Scheduler.task name, results, block
     serve name.to_s, params + ['suggested_name'], types.merge(:suggested_name => 'string', :return => :string) do |*args|
@@ -464,7 +467,7 @@ class SimpleWS::Jobs < SimpleWS
       results.collect{|p| p[0]}
     end
 
-    desc "Job management: Return the content of the result specified by the result identifier. These identifiers are retrieve using the 'results' operation"
+    desc "Job management: Return the content of the result specified by the result identifier. These identifiers are retrieve using the 'results' operation. Results are Base64 encoded to allow binary data"
     param_desc :result => "Result identifier", :return => "Content of the result file, in Base64 encoding for compatibility"
     serve :result, %w(result), :return => :binary do |result|
       path = @results[result]

data/lib/simplews/rake.rb

@@ -46,8 +46,6 @@ class SimpleWS::Jobs::Scheduler::Job
     EOC
 
     load rakefile
-    p workdir
-    p @@steps
     @@steps.each{|step|
       step_dirname = File.join(workdir, step.to_s)
       FileUtils.mkdir_p step_dirname unless File.exists? step_dirname

data/lib/simplews.rb

@@ -46,10 +46,8 @@ require 'builder'
 
 
 class SimpleWS <  SOAP::RPC::StandaloneServer
-  VERSION = "1.3.6"
-
   # Saves method defined in the class to be served by the instances
-  INHERITED_METHODS    = {}
+  INHERITED_METHODS    = {} unless defined? INHERITED_METHODS
 
   # This is a helper function for clients. Given the +url+ where the
   # server is listening, as well as the name of the server, it can
@@ -216,10 +214,9 @@ class SimpleWS <  SOAP::RPC::StandaloneServer
     wsdl.gsub!(/\$\{NAME\}/,@name)
     wsdl.gsub!(/\$\{DESCRIPTION\}/,@description)
     wsdl.gsub!(/\$\{LOCATION\}/,"http://#{ @host }:#{ @port }")
+    
     if filename
-      fwsdl = File.open(filename,'w')
-      fwsdl.write(wsdl)
-      fwsdl.close
+      File.open(filename,'w') {|f| f.write wsdl }
       nil
     else
       wsdl
@@ -237,17 +234,33 @@ class SimpleWS <  SOAP::RPC::StandaloneServer
       end
       xml.tbody do
         @method_order.each do |method|
-          xml.tr do
+          desc = @method_descriptions[method][:description] || ""
+          case
+          when method.to_s == 'wsdl' || method.to_s == 'documentation'
+            type = 'WS_documentation'
+          when desc =~ /^Job management:/
+            type = 'WS_job_management'
+          when @method_descriptions[method][:args].include?( :sugested_name )
+            type = 'WS_task'
+          else
+            type = 'WS_normal'
+          end
+          xml.tr :class => type, :id => "WS_method_#{method}" do
             xml.td method.to_s, :class => "WS_operation" 
 
             xml.td :class => "WS_parameters" do
               description = @method_descriptions[method]
               method_parameters = description[:args]
-              method_parameters.push 'return' unless  description[:types][:return] == false || description[:types]['return'] == false
+              method_parameters += ['return'] unless  description[:types][:return] == false || description[:types]['return'] == false
               if method_parameters.any?
                 xml.dl :class => "WS_parameter_documentation" do
                   method_parameters.each do |param|
-                    xml.dt param
+                    if param.to_s == 'return'
+                      xml.dt param, :class => 'WS_return' 
+                    else
+                      xml.dt param
+                    end
+                    
                     if description[:param_descriptions]
                       xml.dd description[:param_descriptions][param.to_s] || "" 
                     else
@@ -257,14 +270,18 @@ class SimpleWS <  SOAP::RPC::StandaloneServer
                 end
               end
             end
-            
-            xml.td description[:description] || "", :class => "WS_documentation" 
+            xml.td desc, :class => "WS_documentation" 
           end
         end
       end
     end
 
-    html_table
+    if filename
+      File.open(filename,'w') {|f| f.write html_table }
+      nil
+    else
+      html_table
+    end
   end
 
   private
@@ -298,7 +315,6 @@ class SimpleWS <  SOAP::RPC::StandaloneServer
       type = :string if type.nil? 
       if type
         type = type.to_sym
-
         xml.part :name => 'return', :type => TYPES2WSDL[type] do
           param_descriptions = description[:param_descriptions]
 
@@ -306,7 +322,6 @@ class SimpleWS <  SOAP::RPC::StandaloneServer
             xml.documentation  param_descriptions['return']
           end
         end
-
       end
     end
     @messages << message
@@ -333,6 +348,7 @@ class SimpleWS <  SOAP::RPC::StandaloneServer
   end
 
 
+  if ! defined? WSDL_STUB
   WSDL_STUB =<<EOT
 <?xml version="1.0"?>
 <definitions xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
@@ -382,15 +398,18 @@ ${BINDINGS}
 
 </definitions>
 EOT
+  end
 
-  TYPES2WSDL = {
-    :boolean => 'xsd:boolean',
-    :string  => 'xsd:string',
-    :integer => 'xsd:integer',
-    :float   => 'xsd:float',
-    :array   => 'tns:ArrayOfString',
-    :binary  => 'xsd:base64Binary',
-  }
+  if ! defined? TYPES2WSDL
+    TYPES2WSDL = {
+      :boolean => 'xsd:boolean',
+      :string  => 'xsd:string',
+      :integer => 'xsd:integer',
+      :float   => 'xsd:float',
+      :array   => 'tns:ArrayOfString',
+      :binary  => 'xsd:base64Binary',
+    }
+  end
 
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplews
 version: !ruby/object:Gem::Version 
-  version: 1.7.3
+  version: 1.8.1
 platform: ruby
 authors: 
 - Miguel Vazquez
@@ -9,8 +9,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-01 00:00:00 +01:00
-default_executable: start_ws
+date: 2010-01-02 00:00:00 +01:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: soap4r
@@ -45,6 +45,7 @@ dependencies:
 description: Generates WSDL automatically. It manages jobs as asynchronous processes
 email: miguel.vazquez@fdi.ucm.es
 executables: 
+- start_jobs_ws
 - start_ws
 extensions: []