Merge pull request savonrb#559 from apenney/add-attributes

Introduce convert_attributes_to global option.

Author: tjarratt

lib/savon/options.rb

@@ -54,6 +54,7 @@ def initialize(options = {})
         :raise_errors              => true,
         :strip_namespaces          => true,
         :convert_response_tags_to  => lambda { |tag| tag.snakecase.to_sym},
+        :convert_attributes_to     => lambda { |k,v| [k,v] },
         :multipart                 => false,
       }
 
@@ -253,6 +254,13 @@ def convert_response_tags_to(converter = nil, &block)
       @options[:convert_response_tags_to] = block || converter
     end
 
+    # Tell Nori how to convert XML attributes on tags from the SOAP response into Hash keys.
+    # Accepts a lambda or a block which receives an XML tag and returns a Hash key.
+    # Defaults to doing nothing
+    def convert_attributes_to(converter = nil, &block)
+      @options[:convert_attributes_to] = block || converter
+    end
+
     # Instruct Savon to create a multipart response if available.
     def multipart(multipart)
       @options[:multipart] = multipart

lib/savon/response.rb

@@ -98,10 +98,11 @@ def nori
       return @nori if @nori
 
       nori_options = {
-        :strip_namespaces     => @globals[:strip_namespaces],
-        :convert_tags_to      => @globals[:convert_response_tags_to],
-        :advanced_typecasting => @locals[:advanced_typecasting],
-        :parser               => @locals[:response_parser]
+        :strip_namespaces      => @globals[:strip_namespaces],
+        :convert_tags_to       => @globals[:convert_response_tags_to],
+        :convert_attributes_to => @globals[:convert_attributes_to],
+        :advanced_typecasting  => @locals[:advanced_typecasting],
+        :parser                => @locals[:response_parser]
       }
 
       non_nil_nori_options = nori_options.reject { |_, value| value.nil? }

spec/fixtures/response/f5.xml

@@ -0,0 +1,39 @@
+<E:Envelope
+        xmlns:E="http://schemas.xmlsoap.org/soap/envelope/"
+        xmlns:A="http://schemas.xmlsoap.org/soap/encoding/"
+        xmlns:s="http://www.w3.org/2001/XMLSchema-instance"
+        xmlns:y="http://www.w3.org/2001/XMLSchema"
+        xmlns:iControl="urn:iControl"
+        E:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+<E:Body>
+<m:get_agent_listen_addressResponse
+        xmlns:m="urn:iControl:Management/SNMPConfiguration">
+<return
+        s:type="A:Array"
+        A:arrayType="iControl:Management.SNMPConfiguration.AgentListenAddressPort[2]">
+<item>
+<transport
+        s:type="iControl:Management.SNMPConfiguration.TransportType">TRANSPORT_TCP6</transport>
+<ipport
+        s:type="iControl:Common.IPPortDefinition">
+<address
+        s:type="y:string"></address>
+<port
+        s:type="y:long">161</port>
+</ipport>
+</item>
+<item>
+<transport
+        s:type="iControl:Management.SNMPConfiguration.TransportType">TRANSPORT_UDP6</transport>
+<ipport
+        s:type="iControl:Common.IPPortDefinition">
+<address
+        s:type="y:string"></address>
+<port
+        s:type="y:long">161</port>
+</ipport>
+</item>
+</return>
+</m:get_agent_listen_addressResponse>
+</E:Body>
+</E:Envelope>

spec/savon/options_spec.rb

@@ -592,6 +592,35 @@ def to_s
     end
   end
 
+  context "global :convert_attributes_to" do
+    it "changes how XML tag attributes from the SOAP response are translated into Hash keys" do
+      client = new_client(:endpoint => @server.url(:repeat), :convert_attributes_to => lambda {|k,v| [k,v]})
+      response = client.call(:authenticate, :xml => Fixture.response(:f5))
+      expect(response.body[:get_agent_listen_address_response][:return][:item].first[:ipport][:address]).to eq({:"@s:type"=>"y:string"})
+    end
+
+    it "strips the attributes if an appropriate lambda is set" do
+      client = new_client(:endpoint => @server.url(:repeat), :convert_attributes_to => lambda {|k,v| []})
+      response = client.call(:authenticate, :xml => Fixture.response(:f5))
+      expect(response.body[:get_agent_listen_address_response][:return][:item].first[:ipport][:address]).to eq(nil)
+    end
+
+    it "accepts a block in the block-based interface" do
+      client = Savon.client do |globals|
+        globals.log                      false
+        globals.wsdl                     Fixture.wsdl(:authentication)
+        globals.endpoint                 @server.url(:repeat)
+        globals.convert_attributes_to    {|k,v| [k,v]}
+      end
+
+      response = client.call(:authenticate) do |locals|
+        locals.xml Fixture.response(:f5)
+      end
+
+      expect(response.body[:get_agent_listen_address_response][:return][:item].first[:ipport][:address]).to eq({:"@s:type"=>"y:string"})
+    end
+  end
+
   context "global and request :soap_header" do
     it "merges the headers if both were provided as Hashes" do
       global_soap_header = {

spec/savon/response_spec.rb

@@ -118,6 +118,16 @@
       expect(header.keys).to include('SESSIONNUMBER')
     end
 
+    it 'respects the global :convert_attributes_to option' do
+      globals[:convert_attributes_to] = lambda { |k,v| [] }
+
+      response_with_header = soap_response(:body => Fixture.response(:header))
+      header = response_with_header.header
+
+      expect(header).to be_a(Hash)
+      expect(header.keys).to include(:session_number)
+    end
+
     it "should throw an exception when the response header isn't parsable" do
       lambda { invalid_soap_response.header }.should raise_error Savon::InvalidResponseError
     end