shapewear 0.1.2 → 0.1.4

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.1.4
+* Parameters are now read in the correct order, as specified in the metadata;
+* Complex return types are now working correctly;
+* DRYed some code;
+* Added more logs.
+
+## 0.1.3
+* More fixes for .NET interoperability.
+
 ## 0.1.2
 * Fixed a bug when returning SOAP:Faults.
 

data/lib/shapewear/dsl.rb

@@ -21,6 +21,7 @@ module Shapewear::DSL
                 'soap' => 'http://schemas.xmlsoap.org/wsdl/soap/',
                 'soap12' => 'http://schemas.xmlsoap.org/wsdl/soap12/',
                 'xsd' => 'http://www.w3.org/2001/XMLSchema',
+                'xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
                 'env' => 'http://schemas.xmlsoap.org/soap/envelope/',
                 'env12' => 'http://www.w3.org/2001/12/soap-envelope'
   end

data/lib/shapewear/request.rb

@@ -49,7 +49,7 @@ module Shapewear::Request
       operations.each do |k, v|
         if v[:public_name] == op_node.name
           logger.debug "Extracting parameters from operation node..."
-          params = extract_parameters(@op_node)
+          params = extract_parameters(v, op_node)
           logger.debug "Creating new instance of #{clazz}..."
           obj = clazz.new
           logger.debug "Calling #{k} with args: #{params.map(&:inspect) * ', '}"
@@ -67,9 +67,25 @@ module Shapewear::Request
       raise "Operation not found: #{@op_node.name}"
     end
 
-    def extract_parameters(node)
-      # TODO: use the metadata collected from the DSL to reoder the parameters and perform the appropriate conversions
-      node.children.map { |n| n.text }
+    def extract_parameters(op_options, node)
+      logger.debug "Operation node: #{node.inspect}"
+      r = []
+      op_options[:parameters].each do |p|
+        logger.debug "  Looking for: tns:#{p.first.to_s.camelize}"
+        v = node.xpath("tns:#{p.first.to_s.camelize}", namespaces).first
+        if v.nil?
+          # does nothing
+        elsif p.last == Fixnum
+          v = v.text.to_i
+        elsif p.last == DateTime
+          v = DateTime.parse(v.text) # TODO: add tests
+        else
+          v = v.text
+        end
+        logger.debug "    Found: #{v.inspect}"
+        r << v
+      end
+      r
     end
 
     #noinspection RubyArgCount
@@ -77,15 +93,48 @@ module Shapewear::Request
       xb = Builder::XmlMarkup.new
       xb.instruct!
 
-      xb.Envelope :xmlns => soap_env_ns do |xenv|
+      xb.Envelope :xmlns => soap_env_ns, 'xmlns:xsi' => namespaces['xsi'] do |xenv|
         xenv.Body do |xbody|
-          xbody.tag! "#{op_options[:public_name]}Response", :xmlns => namespaces['tns'] do |xres|
-            xres.body r
+          xbody.tag! "#{op_options[:public_name]}Response", :xmlns => namespaces['tns'] do |xresp|
+
+            if r.nil?
+              xresp.tag! "#{op_options[:public_name]}Result", 'xsi:nil' => 'true'
+            else
+              ret = op_options[:returns] rescue nil
+              case ret
+                when NilClass, Class
+                  xresp.tag! "#{op_options[:public_name]}Result", r
+                when Hash
+                  xresp.tag! "#{op_options[:public_name]}Result" do |xres|
+                    ret.each do |k, v|
+                      extract_and_serialize_value(xres, r, k, v)
+                    end
+                  end
+                else
+                  raise "Unsupported return type: #{ret.inspect}"
+              end
+            end
           end
         end
       end
     end
 
+    def extract_and_serialize_value(builder, obj, field, type)
+      v = if obj.is_a?(Hash)
+        obj[field]
+      elsif obj.respond_to?(field)
+        obj.send(field)
+      else
+        raise "Could not extract #{field.inspect} from object: #{obj.inspect}"
+      end
+
+      if v.nil?
+        builder.tag! field.to_s.camelize, 'xsi:nil' => 'true'
+      else
+        builder.tag! field.to_s.camelize, v
+      end
+    end
+
     #noinspection RubyArgCount
     def serialize_soap_fault(ex)
       logger.debug "Serializing SOAP Fault: #{ex.inspect}"

data/lib/shapewear/version.rb

@@ -2,6 +2,6 @@
 
 module Shapewear
 
-  Version = "0.1.2"
+  Version = "0.1.4"
 
 end

data/lib/shapewear/wsdl.rb

@@ -2,7 +2,7 @@
 
 require 'builder'
 
-#noinspection RubyArgCount,RubyResolve
+#noinspection RubyArgCount,RubyResolve,RubyLiteralArrayInspection
 module Shapewear::WSDL
   # reference: http://www.w3.org/TR/wsdl
   def to_wsdl
@@ -17,7 +17,7 @@ module Shapewear::WSDL
                    'xmlns:tns' => namespaces['tns'] do |xdef|
 
       xdef.types do |xtypes|
-        xtypes.schema 'xmlns' => namespaces['xsd'], :elementFormDefault => 'qualified', 'targetNamespace' => namespaces['tns'] do |xschema|
+        xtypes.schema 'xmlns' => namespaces['xsd'], :elementFormDefault => 'qualified', :targetNamespace => namespaces['tns'] do |xschema|
 
           # define elements for each defined method
           operations.each do |m, op_opts|
@@ -54,16 +54,16 @@ module Shapewear::WSDL
               xop.documentation doc unless doc.nil?
               xop.tag! "soap#{sv}:operation", :soapAction => "#{namespaces['tns']}/#{op_opts[:public_name]}", :style => 'document'
               xop.input { |xin| xin.tag! "soap#{sv}:body", :use => 'literal' }
-              xop.output { |xin| xin.tag! "soap#{sv}:body", :use => 'literal' }
+              xop.output { |xout| xout.tag! "soap#{sv}:body", :use => 'literal' }
             end
           end
         end
       end
 
       # service definition for soap 1.1 and 1.2
-      ['', '12'].each do |sv|
-        xdef.service :name => "#{options[:service_name]}#{sv}" do |xsrv|
-          xsrv.documentation "WSDL auto-generated by shapewear."
+      xdef.service :name => "#{options[:service_name]}" do |xsrv|
+        xsrv.documentation "WSDL auto-generated by shapewear."
+        ['', '12'].each do |sv|
           xsrv.port :name => "#{options[:service_name]}Soap#{sv}", :binding => "tns:#{options[:service_name]}Soap#{sv}" do |xport|
             xport.tag! "soap#{sv}:address", :location => options[:endpoint_url]
           end
@@ -119,15 +119,14 @@ module Shapewear::WSDL
     xschema.element :name => "#{op_options[:public_name]}Response" do |xreq|
       xreq.complexType do |xct|
         xct.sequence do |xseq|
-          if ret.nil?
-            xseq.element :name => "#{op_options[:public_name]}Result", :minOccurs => 0, :maxOccurs => 1, :type => 'xsd:any'
-          elsif ret.is_a?(Class)
-            xseq.element :name => "#{op_options[:public_name]}Result", :minOccurs => 0, :maxOccurs => 1, :type => to_xsd_type(ret)
-          elsif ret.is_a?(Hash)
-            xseq.element :name => "#{op_options[:public_name]}Result", :minOccurs => 0, :maxOccurs => 1, :type => "tns:#{op_options[:public_name]}Struct"
-          else
-            raise "Could not interpret #{ret.inspect} as a return type definition"
-          end
+          xseq.element :name => "#{op_options[:public_name]}Result", :minOccurs => 0, :maxOccurs => 1,
+                       :type => case ret
+                         when NilClass then 'xsd:any'
+                         when Class then to_xsd_type(ret)
+                         when Hash then "tns:#{op_options[:public_name]}Struct"
+                         else
+                           raise "Could not interpret #{ret.inspect} as a return type definition"
+                       end
         end
       end
     end

data/spec/shapewear/savon_usage_spec.rb

@@ -16,13 +16,35 @@ describe Shapewear do
       it "should work for simple requests" do
         client = Savon::Client.new 'http://services.example.com/complete/soap/wsdl'
         response = client.request :echo_in_uppercase, :xmlns => 'http://services.example.com/v1' do
-          soap.body = { :text => 'uppercase text' }
+          soap.body = { 'Text' => 'uppercase text' }
         end
 
         puts response.inspect
         puts response.body.inspect
 
-        response.body[:echo_in_uppercase_response][:body].should == 'UPPERCASE TEXT'
+        response.body[:echo_in_uppercase_response][:echo_in_uppercase_result].should == 'UPPERCASE TEXT'
+      end
+
+      it "should work for structured responses from objects" do
+        client = Savon::Client.new 'http://services.example.com/complete/soap/wsdl'
+        response = client.request :get_structured_data, :xmlns => 'http://services.example.com/v1' do
+          soap.body = { 'Id' => 0 }
+        end
+
+        r = response.body[:get_structured_data_response][:get_structured_data_result]
+        r.should be_a Hash
+        r.should include :text => 'text from the struct'
+      end
+
+      it "should work for structured responses from hashes" do
+        client = Savon::Client.new 'http://services.example.com/complete/soap/wsdl'
+        response = client.request :get_structured_data, :xmlns => 'http://services.example.com/v1' do
+          soap.body = { 'Id' => 1 }
+        end
+
+        r = response.body[:get_structured_data_response][:get_structured_data_result]
+        r.should be_a Hash
+        r.should include :text => 'text from a hash'
       end
 
       it "should raise SOAP 1.1 Faults" do
@@ -30,7 +52,7 @@ describe Shapewear do
 
         expect {
           client.request :get_structured_data, :xmlns => 'http://services.example.com/v1' do
-            soap.body = { :id => 55 }
+            soap.body = { 'Id' => 55 }
           end
         }.to raise_error Savon::SOAP::Fault, "(e:Server.RuntimeError) ID must be 0 or 1"
       end
@@ -41,7 +63,7 @@ describe Shapewear do
         expect {
           client.request :get_structured_data, :xmlns => 'http://services.example.com/v1' do
             soap.version = 2
-            soap.body = { :id => 55 }
+            soap.body = { 'Id' => 55 }
           end
         }.to raise_error Savon::SOAP::Fault, "(e:Server.RuntimeError) ID must be 0 or 1"
       end

data/spec/shapewear/service_definitions/complete_service.rb

@@ -21,7 +21,7 @@ class CompleteService
             :returns => {:text => String, :random_value => Fixnum, :created_at => DateTime}
 
   def echo_in_uppercase(text)
-    text.upcase
+    text.upcase unless text.nil?
   end
 
   def sum(x, y)
@@ -39,7 +39,9 @@ class CompleteService
     end
   end
 
-  class Structured < Struct.new(:text, :random_value, :created_at)
+  class Structured
+    attr_reader :text, :random_value, :created_at
+
     def initialize(text)
       @text = text
       @random_value = rand(999)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shapewear
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - "F\xC3\xA1bio Batista"