simplews 1.7.2 → 1.7.3

data/bin/start_ws

@@ -36,9 +36,7 @@ server = SimpleWS.new(options[:name], options[:description], options[:host], opt
   eval actions
 end
 
-if options[:wsdl]
-  File.open(options[:wsdl], 'w') do |f| f.write server.wsdl end
-end
+server.wsdl(options[:wsdl]) if options[:wsdl]
 
 trap('INT'){
   puts "Stopping server"

data/lib/simplews.rb

@@ -49,7 +49,7 @@ class SimpleWS <  SOAP::RPC::StandaloneServer
   VERSION = "1.3.6"
 
   # Saves method defined in the class to be served by the instances
-  METHODS = {}
+  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
@@ -102,17 +102,27 @@ class SimpleWS <  SOAP::RPC::StandaloneServer
     @messages    = []
     @operations  = []
     @bindings    = []
+    @method_descriptions = {}
+    @method_order        = []
 
     if block_given?
       instance_eval &block
     end
 
     puts "Server #{ name } at #{ host }:#{ port }"
-
+    
+ 
     desc "Return the WSDL describing the web server"
     param_desc :return => "WSDL description"
     serve :wsdl, %w(),  :return => :string
-    METHODS.each{|name, info|
+
+    desc "Return HMLT table with documentation for the web service"
+    param_desc :return => "HTML table with documentation"
+    serve :documentation, %w(),  :return => :string
+
+    INHERITED_METHODS.each{|name, info|
+      @@last_description = info[:description]
+      @@last_param_description = info[:param_descriptions]
       serve name, info[:args], info[:types], &info[:block]
     }
   end
@@ -126,8 +136,6 @@ class SimpleWS <  SOAP::RPC::StandaloneServer
   # Add a description for the next method served.
   @@last_description = nil
   @@last_param_description = nil
-  STEP_DESCRIPTIONS = {}
-  PARAMETER_DESCRIPTIONS = {}
   def desc(text = "")
     @@last_description = text
   end
@@ -164,10 +172,14 @@ class SimpleWS <  SOAP::RPC::StandaloneServer
   # method is taken to return no value. Other than that, if a parameter
   # type is omitted it is taken to be :string.
   def serve(name, args=[], types={}, &block)
-    STEP_DESCRIPTIONS[name] ||= @@last_description 
-    PARAMETER_DESCRIPTIONS[name] ||= @@last_param_description 
+
+    @method_descriptions[name] = {:args => args, :types => types, :block => block, 
+      :description => @@last_description, :param_descriptions => @@last_param_description}
+    
     @@last_description = nil
     @@last_param_description = nil
+
+    @method_order << name
     if block
       inline_name = "_inline_" + name.to_s
       add_to_ruby(inline_name, &block)
@@ -185,11 +197,10 @@ class SimpleWS <  SOAP::RPC::StandaloneServer
   # instance check if there where any methods declared to be served in the class
   # and add them.
   def self.serve(name, args=[], types={}, &block)
-    STEP_DESCRIPTIONS[name] ||= @@last_description 
-    PARAMETER_DESCRIPTIONS[name] ||= @@last_param_description 
+    INHERITED_METHODS[name] = {:args => args, :types => types, :block => block, 
+      :description => @@last_description, :param_descriptions => @@last_param_description}
     @@last_description = nil
     @@last_param_description = nil
-    METHODS[name] = {:args => args, :types => types, :block => block}
   end
 
   # If +filename+ is specified it saves the +WSDL+ file in that file. If
@@ -215,6 +226,47 @@ class SimpleWS <  SOAP::RPC::StandaloneServer
     end
   end
 
+  def documentation(filename = nil)
+    html_table =  Builder::XmlMarkup.new(:indent => 2).table :class => "WS_documentation" do |xml|
+      xml.thead do 
+        xml.tr do
+          xml.th "Operation", :class => "WS_operation" 
+          xml.th "Parameters", :class => "WS_parameters"
+          xml.th "Documentation", :class => "WS_documentation" 
+        end
+      end
+      xml.tbody do
+        @method_order.each do |method|
+          xml.tr 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
+              if method_parameters.any?
+                xml.dl :class => "WS_parameter_documentation" do
+                  method_parameters.each do |param|
+                    xml.dt param
+                    if description[:param_descriptions]
+                      xml.dd description[:param_descriptions][param.to_s] || "" 
+                    else
+                      xml.dd
+                    end
+                  end
+                end
+              end
+            end
+            
+            xml.td description[:description] || "", :class => "WS_documentation" 
+          end
+        end
+      end
+    end
+
+    html_table
+  end
+
   private
 
   def add_to_ruby(name, &block)
@@ -222,16 +274,22 @@ class SimpleWS <  SOAP::RPC::StandaloneServer
   end
 
   def add_to_wsdl(name, args, types)
+    description = @method_descriptions[name]
     message =  Builder::XmlMarkup.new(:indent => 2).message :name => "#{ name }Request" do |xml|
-      args.each{|param|
+      
+      args.each do |param|
         type = types[param.to_s] || types[param.to_sym] || :string
         type = type.to_sym
+
         xml.part :name => param, :type => TYPES2WSDL[type] do
-          if PARAMETER_DESCRIPTIONS[name] && PARAMETER_DESCRIPTIONS[name][param.to_s]
-            xml.documentation PARAMETER_DESCRIPTIONS[name][param.to_s]
+          param_descriptions = description[:param_descriptions]
+
+          if param_descriptions && param_descriptions[param.to_s]
+            xml.documentation  param_descriptions[param.to_s]
           end
         end
-      }
+
+      end
     end
     @messages << message
 
@@ -240,17 +298,21 @@ class SimpleWS <  SOAP::RPC::StandaloneServer
       type = :string if type.nil? 
       if type
         type = type.to_sym
+
         xml.part :name => 'return', :type => TYPES2WSDL[type] do
-          if PARAMETER_DESCRIPTIONS[name] && PARAMETER_DESCRIPTIONS[name]['return']
-            xml.documentation PARAMETER_DESCRIPTIONS[name]['return'] 
+          param_descriptions = description[:param_descriptions]
+
+          if param_descriptions && param_descriptions['return']
+            xml.documentation  param_descriptions['return']
           end
         end
+
       end
     end
     @messages << message
 
     operation = Builder::XmlMarkup.new(:indent => 2).operation :name => "#{ name }" do |xml|
-      xml.documentation STEP_DESCRIPTIONS[name]  if STEP_DESCRIPTIONS[name]
+      xml.documentation description[:description]  if description[:description]
       xml.input :message => "tns:#{ name }Request"
       xml.output :message => "tns:#{ name }Response"
     end
@@ -268,9 +330,8 @@ class SimpleWS <  SOAP::RPC::StandaloneServer
     end
 
     @bindings << binding
-
   end
-  
+
 
   WSDL_STUB =<<EOT
 <?xml version="1.0"?>

data/lib/simplews/jobs.rb

@@ -18,6 +18,8 @@ class SimpleWS::Jobs < SimpleWS
     :job_info => 1,
     :monitor => 2,
   }
+  
+  INHERITED_TASKS = {}
 
   
   #{{{ Scheduler
@@ -366,12 +368,8 @@ class SimpleWS::Jobs < SimpleWS
   end
 
   def task(name, params=[], types={}, results = [], &block)
-    STEP_DESCRIPTIONS[name.to_s] ||= @@last_description 
-    PARAMETER_DESCRIPTIONS[name.to_s] ||= @@last_param_description 
-    @@last_description = nil
-    @@last_param_description = nil
-    PARAMETER_DESCRIPTIONS[name.to_s]['return'] ||= 'Job identifier' if PARAMETER_DESCRIPTIONS[name.to_s]
-
+    @@last_param_description['return'] ||= 'Job identifier' 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|
       Scheduler.run name, *args
@@ -380,17 +378,11 @@ class SimpleWS::Jobs < SimpleWS
 
   @@tasks = {}
   def self.task(name, params=[], types={}, results =[], &block)
-    STEP_DESCRIPTIONS[name.to_s] ||= @@last_description 
-    PARAMETER_DESCRIPTIONS[name.to_s] ||= @@last_param_description 
+    INHERITED_TASKS[name] = {:params => params, :types => types, :results => results, :block => block,
+    :description => @@last_description, :param_description => @@last_param_description};
+
     @@last_description = nil
     @@last_param_description = nil
-    if PARAMETER_DESCRIPTIONS[name.to_s]
-      PARAMETER_DESCRIPTIONS[name.to_s]['return'] ||= 'Job identifier' 
-      PARAMETER_DESCRIPTIONS[name.to_s]['suggested_name'] ||= 'Suggested name for the job' 
-    end
-
-    Scheduler.task name, results, block
-    @@tasks[name] = {:params => params, :types => types};
   end
 
   def abort_jobs
@@ -408,10 +400,10 @@ class SimpleWS::Jobs < SimpleWS
     @workdir = workdir || "/tmp/#{ name }"
     Scheduler.workdir = @workdir
     @results = {}
-    @@tasks.each{|task, values|
-      serve task.to_s, values[:params] + ['suggested_name'], values[:types].merge(:suggested_name => 'string', :return => :string) do |*args|
-        Scheduler.run task, *args
-      end
+    INHERITED_TASKS.each{|task,info|
+      @@last_description = info[:description]
+      @@last_param_description = info[:param_description]
+      task(task, info[:params], info[:types], info[:results], &info[:block])
     }
 
 

data/lib/simplews/rake.rb

@@ -46,6 +46,8 @@ 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplews
 version: !ruby/object:Gem::Version 
-  version: 1.7.2
+  version: 1.7.3
 platform: ruby
 authors: 
 - Miguel Vazquez