shapewear 0.1.0 → 0.1.1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.1.1
+* Added support for SOAP 1.2 Faults;
+* Refactored the request handling into its own class.
+
 ## 0.1.0
 * Added specs and fixed basic support for SOAP:Fault.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shapewear (0.1.0)
+    shapewear (0.1.1)
       builder (>= 2.1.2)
       nokogiri (>= 1.5.0)
 

data/lib/shapewear/dsl.rb

@@ -21,7 +21,8 @@ module Shapewear::DSL
                 '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/'
+                'env' => 'http://schemas.xmlsoap.org/soap/envelope/',
+                'env12' => 'http://www.w3.org/2001/12/soap-envelope'
   end
 
   protected

data/lib/shapewear/request.rb

@@ -1,81 +1,130 @@
 # encoding: UTF-8
 
+require 'forwardable'
+
 module Shapewear::Request
   # @param request [Rack::Request, Hash]
   def serve(request)
-    op_node = find_soap_operation_node(request)
-
-    begin
-      call_soap_operation(op_node)
-    rescue => e
-      serialize_soap_fault e
-    end
+    RequestHandler.new(self, request).serve
   end
 
-  private
+  class RequestHandler
+    extend Forwardable
 
-  def find_soap_operation_node(request)
-    body ||= request.body if request.respond_to? :body
-    body ||= request[:body] if request.is_a?(Hash)
-    body ||= request.to_s
+    attr_reader :soap_version, :op_node, :clazz
+    def_delegators :@clazz, :namespaces, :operations, :logger
 
-    raise "Request body could not be found" if body.nil?
+    def initialize(clazz, request)
+      @clazz = clazz
 
-    doc = Nokogiri::XML(body) { |c| c.strict } rescue raise("Request body is not a valid XML")
+      body ||= request.body if request.respond_to? :body
+      body ||= request[:body] if request.is_a?(Hash)
+      body ||= request.to_s
 
-    raise "Request is not a SOAP::Envelope: #{body}" if doc.at('/env:Envelope', namespaces).nil?
+      raise "Request body could not be found" if body.nil?
 
-    # find the operation element, or raise if not found
-    doc.at("/env:Envelope/env:Body/tns:*", namespaces) or raise "Operation not found"
-  end
+      doc = Nokogiri::XML(body) { |c| c.strict } rescue raise("Request body is not a valid XML")
 
-  def call_soap_operation(node)
-    operations.each do |k, v|
-      if v[:public_name] == node.name
-        params = extract_parameters(node)
-        logger.debug "Calling #{k} with args: #{params.map(&:inspect) * ', '}"
-        r = self.new.send(k, *params)
-        logger.debug "Result: #{r.inspect}"
-        return serialize_soap_result v, r
+      # detect the SOAP version from the envelope, and find the operation element, or raise if not found
+      if doc.at('/env:Envelope', namespaces)
+        @soap_version = :soap11
+        @op_node = doc.at("/env:Envelope/env:Body/tns:*", namespaces)
+      elsif doc.at('/env12:Envelope', namespaces)
+        @soap_version = :soap12
+        @op_node = doc.at("/env12:Envelope/env12:Body/tns:*", namespaces)
+      else
+        raise "Request is not a SOAP 1.1 nor SOAP 1.2 Envelope: #{body}"
       end
     end
 
-    raise "Operation not found: #{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 }
-  end
-
-  #noinspection RubyArgCount
-  def serialize_soap_result(op_options, r)
-    xb = Builder::XmlMarkup.new
-    xb.instruct!
+    def serve
+      call_soap_operation
+    end
 
-    xb.Envelope :xmlns => namespaces['env'] do |xenv|
-      xenv.Body do |xbody|
-        xbody.tag! "#{op_options[:public_name]}Response", :xmlns => namespaces['tns'] do |xres|
-          xres.body r
+    private
+
+    def call_soap_operation
+      raise "Operation node not found" if op_node.nil?
+
+      operations.each do |k, v|
+        if v[:public_name] == op_node.name
+          logger.debug "Extracting parameters from operation node..."
+          params = extract_parameters(@op_node)
+          logger.debug "Creating new instance of #{clazz}..."
+          obj = clazz.new
+          logger.debug "Calling #{k} with args: #{params.map(&:inspect) * ', '}"
+          begin
+            r = obj.send(k, *params)
+            logger.debug "Result: #{r.inspect}"
+            return serialize_soap_result v, r
+          rescue => e
+            logger.debug "Exception: #{e.inspect}"
+            return serialize_soap_fault e
+          end
         end
       end
+
+      raise "Operation not found: #{@op_node.name}"
     end
-  end
 
-  #noinspection RubyArgCount
-  def serialize_soap_fault(ex)
-    logger.debug "Serializing SOAP Fault: #{ex.inspect}"
+    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 }
+    end
 
-    xb = Builder::XmlMarkup.new
-    xb.instruct!
+    #noinspection RubyArgCount
+    def serialize_soap_result(op_options, r)
+      xb = Builder::XmlMarkup.new
+      xb.instruct!
 
-    xb.Envelope :xmlns => namespaces['env'] do |xenv|
-      xenv.Body do |xbody|
-        xbody.Fault do |xf|
-          xf.faultcode ex.class.name
-          xf.faultstring ex.message
+      xb.Envelope :xmlns => soap_env_ns do |xenv|
+        xenv.Body do |xbody|
+          xbody.tag! "#{op_options[:public_name]}Response", :xmlns => namespaces['tns'] do |xres|
+            xres.body r
+          end
         end
       end
     end
+
+    #noinspection RubyArgCount
+    def serialize_soap_fault(ex)
+      logger.debug "Serializing SOAP Fault: #{ex.inspect}"
+
+      xb = Builder::XmlMarkup.new
+      xb.instruct!
+
+      xb.Envelope 'xmlns:e' => soap_env_ns do |xenv|
+        xenv.tag! 'e:Body' do |xbody|
+          xbody.tag! 'e:Fault' do |xf|
+            case soap_version
+              when :soap11
+                xf.faultcode "e:Server.#{ex.class.name}"
+                xf.faultstring ex.message
+              when :soap12
+                xf.tag! 'e:Code' do |xcode|
+                  xcode.tag! 'e:Value', 'e:Receiver'
+                  xcode.tag! 'e:Subcode' do |xsubcode|
+                    xsubcode.tag! 'e:Value', ex.class.name
+                  end
+                end
+                xf.tag! 'e:Reason', ex.message
+              else
+                raise "Unsupported SOAP version: #{soap_version}"
+            end
+          end
+        end
+      end
+    end
+
+    def soap_env_ns
+      case soap_version
+        when :soap11
+          namespaces['env']
+        when :soap12
+          namespaces['env12']
+        else
+          raise "Unrecognized SOAP version: #{soap_version}"
+      end
+    end
   end
 end

data/lib/shapewear/version.rb

@@ -2,6 +2,6 @@
 
 module Shapewear
 
-  Version = "0.1.0"
+  Version = "0.1.1"
 
 end

data/spec/shapewear/savon_usage_spec.rb

@@ -25,14 +25,25 @@ describe Shapewear do
         response.body[:echo_in_uppercase_response][:body].should == 'UPPERCASE TEXT'
       end
 
-      it "should raise SOAP:Faults" do
+      it "should raise SOAP 1.1 Faults" do
         client = Savon::Client.new 'http://services.example.com/complete/soap/wsdl'
 
         expect {
           client.request :get_structured_data, :xmlns => 'http://services.example.com/v1' do
             soap.body = { :id => 55 }
           end
-        }.to raise_error Savon::SOAP::Fault, "(RuntimeError) ID must be 0 or 1"
+        }.to raise_error Savon::SOAP::Fault, "(e:Server.RuntimeError) ID must be 0 or 1"
+      end
+
+      it "should raise SOAP 1.2 Faults" do
+        client = Savon::Client.new 'http://services.example.com/complete/soap/wsdl'
+
+        expect {
+          client.request :get_structured_data, :xmlns => 'http://services.example.com/v1' do
+            soap.version = 2
+            soap.body = { :id => 55 }
+          end
+        }.to raise_error Savon::SOAP::Fault, "(e:Server.RuntimeError) ID must be 0 or 1"
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shapewear
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - "F\xC3\xA1bio Batista"