shapewear 0.0.4 → 0.0.5

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## 0.0.5
+* Removed the dual-namespace option. Now there's only one.
+* Generating WSDL for SOAP 1.2;
+* Added an option on the DSL to change the service name;
+* Changed some conventions on the generated WSDL so Visual Studio .NET can understand it better.
+
+## 0.0.4
+* Fixed the samples;
+* Fixed some bugs that prevented the generated WSDL to be used with Visual Studio.
+
+## 0.0.3
+* Added support for WSDL documentation;
+* Added wasabi and WebMock to the specs;
+* Added support for complex types on parameters, in addition to return values;
+* Request handling for very simple cases.
+
+## 0.0.2
+* WSDL generation code extracted to its own module;
+* Added support for complex return types;
+* Fixed a bug on the String#camelize extension;
+* DateTime support on parameters and return values.
+
+## 0.0.1
+* Initial, experimental version

data/README.md

@@ -35,7 +35,6 @@ class MyFirstService
   include Shapewear
 
   wsdl_namespace 'http://services.example.com/v1'
-  schema_namespace 'http://schemas.example.com/v1'
 
   endpoint_url 'http://localhost:3000/my_first_service'
 

data/lib/shapewear/dsl.rb

@@ -6,7 +6,7 @@ module Shapewear::DSL
   private
 
   def options
-    @options ||= {}
+    @options ||= { :service_name => self.name }
   end
 
   def operations
@@ -17,21 +17,21 @@ module Shapewear::DSL
     options[:namespaces] ||=
       Hash.new { |_, k| raise "Namespace not defined: #{k}" } \
         .merge! 'tns' => "http://services.example.com/#{self.name}",
-                'xsd1' => "http://schema.example.com/#{self.name}",
                 'wsdl' => 'http://schemas.xmlsoap.org/wsdl/',
                 'soap' => 'http://schemas.xmlsoap.org/wsdl/soap/',
+                'soap12' => 'http://schemas.xmlsoap.org/wsdl/soap12/',
                 'xsd' => 'http://www.w3.org/2001/XMLSchema',
                 'env' => 'http://schemas.xmlsoap.org/soap/envelope/'
   end
 
   protected
 
-  def wsdl_namespace(ns)
-    namespaces['tns'] = ns
+  def service_name(sn)
+    options[:service_name] = sn
   end
 
-  def schema_namespace(ns)
-    namespaces['xsd1'] = ns
+  def wsdl_namespace(ns)
+    namespaces['tns'] = ns
   end
 
   def endpoint_url(url)

data/lib/shapewear/request.rb

@@ -55,7 +55,7 @@ module Shapewear::Request
 
     xb.Envelope :xmlns => namespaces['env'] do |xenv|
       xenv.Body do |xbody|
-        xbody.tag! "#{op_options[:public_name]}Response", :xmlns => namespaces['xsd1'] do |xres|
+        xbody.tag! "#{op_options[:public_name]}Response", :xmlns => namespaces['tns'] do |xres|
           xres.body r
         end
       end

data/lib/shapewear/version.rb

@@ -2,6 +2,6 @@
 
 module Shapewear
 
-  Version = "0.0.4"
+  Version = "0.0.5"
 
 end

data/lib/shapewear/wsdl.rb

@@ -12,12 +12,12 @@ module Shapewear::WSDL
     xm.definitions :name => self.name, 'targetNamespace' => namespaces['tns'],
                    'xmlns' => namespaces['wsdl'],
                    'xmlns:soap' => namespaces['soap'],
+                   'xmlns:soap12' => namespaces['soap12'],
                    'xmlns:xsd' => namespaces['xsd'],
-                   'xmlns:xsd1' => namespaces['xsd1'],
                    'xmlns:tns' => namespaces['tns'] do |xdef|
 
       xdef.types do |xtypes|
-        xtypes.schema 'xmlns' => namespaces['xsd'], 'targetNamespace' => namespaces['xsd1'] 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|
@@ -26,41 +26,47 @@ module Shapewear::WSDL
         end
       end
 
-      operations.each do |m, op_opts|
-        xdef.message :name => "#{op_opts[:public_name]}Input" do |xmsg|
-          xmsg.part :name => :body, :element => "xsd1:#{op_opts[:public_name]}Request"
-        end unless instance_method(m).arity == 0
-        xdef.message :name => "#{op_opts[:public_name]}Output" do |xmsg|
-          xmsg.part :name => :body, :element => "xsd1:#{op_opts[:public_name]}Response"
+      operations.each do |_, op_opts|
+        xdef.message :name => "#{op_opts[:public_name]}SoapIn" do |xmsg|
+          xmsg.part :name => :parameters, :element => "tns:#{op_opts[:public_name]}"
+        end
+        xdef.message :name => "#{op_opts[:public_name]}SoapOut" do |xmsg|
+          xmsg.part :name => :parameters, :element => "tns:#{op_opts[:public_name]}Response"
         end
       end
 
-      xdef.portType :name => "#{self.name}PortType" do |xpt|
-        operations.each do |m, op_opts|
+      xdef.portType :name => "#{options[:service_name]}Soap" do |xpt|
+        operations.each do |_, op_opts|
           xpt.operation :name => op_opts[:public_name] do |xop|
-            xop.input :message => "tns:#{op_opts[:public_name]}Input" unless instance_method(m).arity == 0
-            xop.output :message => "tns:#{op_opts[:public_name]}Output"
+            xop.input :message => "tns:#{op_opts[:public_name]}SoapIn"
+            xop.output :message => "tns:#{op_opts[:public_name]}SoapOut"
           end
         end
       end
 
-      xdef.binding :name => "#{self.name}Binding", :type => "tns:#{self.name}PortType" do |xbind|
-        xbind.tag! 'soap:binding', :style => 'rpc', :transport => 'http://schemas.xmlsoap.org/soap/http'
-        operations.each do |op, op_opts|
-          xbind.operation :name => op_opts[:public_name] do |xop|
-            doc = op_opts[:documentation] rescue nil
-            xop.documentation doc unless doc.nil?
-            xop.tag! 'soap:operation', :soapAction => "#{namespaces['tns']}/#{op_opts[:public_name]}"
-            xop.input { |xin| xin.tag! 'soap:body', :use => 'literal', :namespace => namespaces['tns'] } unless instance_method(op).arity == 0
-            xop.output { |xin| xin.tag! 'soap:body', :use => 'literal', :namespace => namespaces['tns'] }
+      # bindings for soap 1.1 and 1.2
+      ['', '12'].each do |sv|
+        xdef.binding :name => "#{options[:service_name]}Soap#{sv}", :type => "tns:#{options[:service_name]}Soap" do |xbind|
+          xbind.tag! "soap#{sv}:binding", :transport => 'http://schemas.xmlsoap.org/soap/http'
+          operations.each do |_, op_opts|
+            xbind.operation :name => op_opts[:public_name] do |xop|
+              doc = op_opts[:documentation] rescue nil
+              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' }
+            end
           end
         end
       end
 
-      xdef.service :name => self.name do |xsrv|
-        xsrv.documentation "WSDL auto-generated by shapewear."
-        xsrv.port :name => "#{self.name}Port", :binding => "#{self.name}Binding" do |xport|
-          xport.tag! 'soap:address', :location => options[:endpoint_url]
+      # 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."
+          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
         end
       end
     end
@@ -70,37 +76,37 @@ module Shapewear::WSDL
     # element for method arguments
     um = instance_method(m)
 
-    if um.arity > 0
-      xschema.element :name => "#{op_options[:public_name]}Request" do |xreq|
-        xreq.complexType do |xct|
-          xct.all do |xall|
-            params = op_options[:parameters] rescue nil
-            if params.nil?
-              if um.respond_to?(:parameters)
-                # with Ruby 1.9, we can create the parameters with the correct names
-                params = um.parameters.select { |p| p.first == :in }.map { |p| [p.first, Object] }
-              else
-                params = (0..um.arity).map { |i| ["arg#{i}", Object] }
-              end
+    xschema.element :name => "#{op_options[:public_name]}" do |xreq|
+      xreq.complexType do |xct|
+        xct.sequence do |xseq|
+          params = op_options[:parameters] rescue nil
+          if params.nil?
+            if um.respond_to?(:parameters)
+              # with Ruby 1.9, we can create the parameters with the correct names
+              params = um.parameters.select { |p| p.first == :in }.map { |p| [p.first, Object] }
+            else
+              params = (0..um.arity).map { |i| ["arg#{i}", Object] }
             end
+          end
 
-            params.each do |p|
-              t = p.last
-              if t.nil?
-                xall.element :name => p.first, :type => 'xsd:any'
-              elsif t.is_a?(Class)
-                xall.element :name => p.first, :type => to_xsd_type(t)
-              elsif t.is_a?(Hash)
-                xall.complexType do |xct2|
-                  xct2.all do |xall2|
-                    t.each do |name, type|
-                      xall2.element :name => name, :type => to_xsd_type(type)
-                    end
+          params.each do |p|
+            t = p.last
+            param_name = p.first
+            param_name = param_name.to_s.camelize if param_name.is_a?(Symbol)
+            if t.nil?
+              xseq.element :name => param_name, :minOccurs => 0, :maxOccurs => 1, :type => 'xsd:any'
+            elsif t.is_a?(Class)
+              xseq.element :name => param_name, :minOccurs => 0, :maxOccurs => 1, :type => to_xsd_type(t)
+            elsif t.is_a?(Hash)
+              xseq.complexType do |xct2|
+                xct2.sequence do |xseq2|
+                  t.each do |name, type|
+                    xseq2.element :name => name, :minOccurs => 0, :maxOccurs => 1, :type => to_xsd_type(type)
                   end
                 end
-              else
-                raise "Could not interpret #{t.inspect} as a return type definition"
               end
+            else
+              raise "Could not interpret #{t.inspect} as a return type definition"
             end
           end
         end
@@ -108,24 +114,34 @@ module Shapewear::WSDL
     end
 
     # element for method result
+    ret = op_options[:returns] rescue nil
+
     xschema.element :name => "#{op_options[:public_name]}Response" do |xreq|
       xreq.complexType do |xct|
-        xct.all do |xall|
-          ret = op_options[:returns] rescue nil
+        xct.sequence do |xseq|
           if ret.nil?
-            xall.element :name => 'result', :type => 'xsd:any'
+            xseq.element :name => "#{op_options[:public_name]}Result", :minOccurs => 0, :maxOccurs => 1, :type => 'xsd:any'
           elsif ret.is_a?(Class)
-            xall.element :name => 'result', :type => to_xsd_type(ret)
+            xseq.element :name => "#{op_options[:public_name]}Result", :minOccurs => 0, :maxOccurs => 1, :type => to_xsd_type(ret)
           elsif ret.is_a?(Hash)
-            ret.each do |name, type|
-              xall.element :name => name, :type => to_xsd_type(type)
-            end
+            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
         end
       end
     end
+
+    if ret.is_a?(Hash)
+      xschema.complexType :name => "#{op_options[:public_name]}Struct" do |xctr|
+        xctr.sequence do |xseqr|
+          ret.each do |name, type|
+            name = name.to_s.camelize if name.is_a?(Symbol)
+            xseqr.element :name => name, :minOccurs => 0, :maxOccurs => 1, :type => to_xsd_type(type)
+          end
+        end
+      end
+    end
   end
 
   # @param t [Class]

data/spec/shapewear/service_definitions/complete_service.rb

@@ -6,7 +6,6 @@ class CompleteService
   include Shapewear
 
   wsdl_namespace 'http://services.example.com/v1'
-  schema_namespace 'http://schemas.example.com/v1'
 
   endpoint_url 'http://services.example.com/complete/soap'
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shapewear
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - "F\xC3\xA1bio Batista"
@@ -150,6 +150,7 @@ files:
 - .rspec
 - .rvmrc
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE