savon 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e067f76bf98355ac8d45b7794066761b478669e
-  data.tar.gz: db9c6381959313f8c173b9abfcb24e360e892580
+  metadata.gz: 50130e634559c3c2470b09405d608fb86887e1d5
+  data.tar.gz: 80f641ad66bf740cd6d90beda49830c544e988b0
 SHA512:
-  metadata.gz: bcfab18096e9beaf971fe837bd4af924ce6d04dc7d63458046aad1498f20781606528e8eeeb3f0d6990175cccfdfde3197c719ce34185a5d37a73e47bc84bdcb
-  data.tar.gz: dbc7b384908c2a1f2bbaac0daf1ba07702aab0fb206a834d7b797e88601b8a264703d8cfbc1273f002e33fa7ddf11ba73a0a97546f9de3505ce1d34de8146602
+  metadata.gz: 4a791ac4059d5372ba758b334d066fd18af294ff42776b3f752e0e3ba0ee880d69ccf8cbeb5e9a7a9ce702d22dc45b20f1f34fc32143cc87fd59ca6af0d65e82
+  data.tar.gz: a81490063101948bee370664696ef1b61192992ef98477959fd04c2b73e0f7b1ffb5794cade623a0c7e483506a772be3c64175396fb17a8986308ff61da1ef55

data/.travis.yml

@@ -9,3 +9,6 @@ rvm:
   - rbx
 notifications:
   irc: "irc.freenode.org#savon"
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode

data/CHANGELOG.md

@@ -1,10 +1,18 @@
+# 2.5.0 (2014-05-03)
+
+* Feature: [#566](https://github.com/savonrb/savon/pull/566) Allow specifying HTTPI adapter per client.
+
+```ruby
+    curb_client = Savon.client(wsdl: "http://example.com/service.wsdl", adapter: :curb)
+    http_client = Savon.client(wsdl: "http://example.com/service.wsdl", adapter: :httpclient)
+```
+
 ## 2.4.0 (2014-03-31)
 
 * Logging is off by default. To enable this behavior, set the :log option to true
 
     ``` ruby
-    client = Savon.client(wsdl: "http://example.com/service.wsdl")
-    client.options[:log] = true
+    client = Savon.client(wsdl: "http://example.com/service.wsdl", log: true)
     ```
 
 ### 2.3.2 (2013-12-09)

data/README.md

@@ -25,22 +25,6 @@ or add it to your Gemfile like this:
 gem 'savon', '~> 2.3.0'
 ```
 
-
-## Maintainer needed
-
-So I've been maintaining Savon and its dependant projects for the last four years and it's become quite  
-apparent now with my schedule I do not have the time to keep this project going single-handed.
-
-Luckily there are numerous people helping out from time to time, but maintaining this project is pretty  
-much a full-time job and it keeps me from working on the next major version.
-
-I'll be able to contribute on a small scale going forward, and will do my best in the meantime to catch  
-up with everything I am behind on.
-
-If you are interested, please email me at [me at rubiii dot com].  
-I'll do everything I can to help you get started.
-
-
 ## Usage example
 
 ``` ruby
@@ -66,16 +50,16 @@ For more examples, you should check out the
 ## Give back
 
 If you're using Savon and you or your company is making money from it, then please consider
-donating via [Gittip](https://www.gittip.com/rubiii/) so that I can continue to improve it.
+donating via [Gittip](https://www.gittip.com/tjarratt/) so that I can continue to improve it.
 
-[![donate](donate.png)](https://www.gittip.com/rubiii/)
+[![donate](donate.png)](https://www.gittip.com/tjarratt/)
 
 
 ## Documentation
 
 Please make sure to [read the documentation](http://savonrb.com/version2/).
 
-And if you find any problems with it or if you think something's missing,  
+And if you find any problems with it or if you think something's missing,
 feel free to [help out and improve the documentation](https://github.com/savonrb/savonrb.com).
 
 Donate icon from the [Noun Project](http://thenounproject.com/noun/donate/#icon-No285).

data/lib/savon/client.rb

@@ -57,6 +57,7 @@ module Savon
       @wsdl.endpoint    = @globals[:endpoint]    if @globals.include? :endpoint
       @wsdl.namespace   = @globals[:namespace]   if @globals.include? :namespace
       @wsdl.servicename = @globals[:servicename] if @globals.include? :servicename
+      @wsdl.adapter     = @globals[:adapter]     if @globals.include? :adapter
 
       @wsdl.request = WSDLRequest.new(@globals).build
     end

data/lib/savon/operation.rb

@@ -83,7 +83,7 @@ module Savon
     end
 
     def call_with_logging(request)
-      @logger.log(request) { HTTPI.post(request) }
+      @logger.log(request) { HTTPI.post(request, @globals[:adapter]) }
     end
 
     def build_request(builder)

data/lib/savon/options.rb

@@ -54,7 +54,9 @@ module Savon
         :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,
+        :adapter                   => nil,
       }
 
       options = defaults.merge(options)
@@ -253,10 +255,22 @@ module Savon
       @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
     end
+
+    # Instruct Savon what HTTPI adapter it should use instead of default
+    def adapter(adapter)
+      @options[:adapter] = adapter
+    end
   end
 
   class LocalOptions < Options

data/lib/savon/response.rb

@@ -98,10 +98,11 @@ module Savon
       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? }

data/lib/savon/version.rb

@@ -1,3 +1,3 @@
 module Savon
-  VERSION = '2.4.0'
+  VERSION = '2.5.0'
 end

data/savon.gemspec

@@ -16,9 +16,9 @@ Gem::Specification.new do |s|
   s.rubyforge_project = s.name
   s.license = 'MIT'
 
-  s.add_dependency "nori",     "~> 2.3.0"
+  s.add_dependency "nori",     "~> 2.4.0"
   s.add_dependency "httpi",    "~> 2.1.0"
-  s.add_dependency "wasabi",   "~> 3.2.2"
+  s.add_dependency "wasabi",   "~> 3.3.0"
   s.add_dependency "akami",    "~> 1.2.0"
   s.add_dependency "gyoku",    "~> 1.1.0"
 

data/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>

data/spec/integration/centra_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+module LogInterceptor
+  @@intercepted_request = ""
+  def self.debug(message)
+    # save only the first XMLly message
+    if message.include? "xml version"
+      @@intercepted_request = message if @@intercepted_request == ""
+    end
+  end
+
+  def self.info(message)
+  end
+
+  def self.get_intercepted_request
+    @@intercepted_request
+  end
+
+  def self.reset_intercepted_request
+    @@intercepted_request = ""
+  end
+end
+
+describe 'Correct translation of attributes to XML' do
+  it "new :@attr syntax: correctly maps a Ruby Hash to XML attributes" do
+    LogInterceptor.reset_intercepted_request
+
+    client = Savon.client(
+      :wsdl => "http://mt205.sabameeting.com/CWS/CWS.asmx?WSDL",
+      :logger => LogInterceptor
+    )
+
+    response = nil
+    begin
+      response = call_and_fail_gracefully(client, :add_new_user, :message => { :user => { :@userID => "test" } })
+    rescue
+    end
+
+    xml_doc = Nokogiri::XML(LogInterceptor.get_intercepted_request)
+    xml_doc.remove_namespaces!
+
+    attributes_element_not_present = xml_doc.xpath("//AddNewUser/attributes").blank?
+
+    puts "new syntax: attributes element not present: " + attributes_element_not_present.to_s
+
+    expect(attributes_element_not_present).to eq true
+  end
+  
+  it "old :attributes! syntax: correctly maps a Ruby Hash to XML attributes" do
+    LogInterceptor.reset_intercepted_request
+
+    client = Savon.client(
+      :wsdl => "http://mt205.sabameeting.com/CWS/CWS.asmx?WSDL",
+      :logger => LogInterceptor
+    )
+
+    response = nil
+    begin
+      response = call_and_fail_gracefully(client, :add_new_user, :message => { :user => {}, :attributes! => { :user => { :userID => "test" } } })
+    rescue
+    end
+
+    xml_doc = Nokogiri::XML(LogInterceptor.get_intercepted_request)
+    xml_doc.remove_namespaces!
+
+    attributes_element_not_present = xml_doc.xpath("//AddNewUser/attributes").blank?
+
+    puts "new syntax: attributes element not present: " + attributes_element_not_present.to_s
+
+    expect(attributes_element_not_present).to eq true
+  end
+end

data/spec/savon/options_spec.rb

@@ -84,7 +84,9 @@ describe "Options" do
       client = new_client(:endpoint => non_routable_ip, :open_timeout => 0.1)
 
       expect { client.call(:authenticate) }.to raise_error { |error|
-        if error.kind_of? Errno::EHOSTUNREACH
+        host_unreachable = error.kind_of? Errno::EHOSTUNREACH
+        net_unreachable = error.kind_of? Errno::ENETUNREACH
+        if host_unreachable || net_unreachable
           warn "Warning: looks like your network may be down?!\n" +
                "-> skipping spec at #{__FILE__}:#{__LINE__}"
         else
@@ -495,7 +497,7 @@ describe "Options" do
       expect(request).to include("<wsse:Username>lea</wsse:Username>")
 
       # the nonce node
-      expect(request).to match(/<wsse:Nonce>.+<\/wsse:Nonce>/)
+      expect(request).to match(/<wsse:Nonce.*>.+\n<\/wsse:Nonce>/)
 
       # the created node with a timestamp
       expect(request).to match(/<wsu:Created>\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.*<\/wsu:Created>/)
@@ -590,6 +592,68 @@ describe "Options" do
     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: :adapter' do
+    it 'passes option to Wasabi initializer for WSDL fetching' do
+      ## I want to use there something similar to the next mock expectation, but I can't
+      ## as due to how Savon sets up Wasabi::Document and Wasabi::Document initialize itself
+      ## adapter= method is called first time with nil and second time with adapter. [Envek, 2014-05-03]
+      # Wasabi::Document.any_instance.expects(:adapter=).with(:fake_adapter_for_test)
+      client = Savon.client(
+          :log => false,
+          :wsdl => @server.url(:authentication),
+          :adapter => :fake_adapter_for_test,
+      )
+      operations = client.operations
+      expect(operations).to eq([:authenticate])
+      expect(FakeAdapterForTest.class_variable_get(:@@requests).size).to eq(1)
+      expect(FakeAdapterForTest.class_variable_get(:@@requests).first.url).to eq(URI.parse(@server.url(:authentication)))
+      expect(FakeAdapterForTest.class_variable_get(:@@methods)).to eq([:get])
+    end
+
+    it 'instructs HTTPI to use provided adapter for performing SOAP requests' do
+      client = new_client_without_wsdl(
+          :endpoint => @server.url(:repeat),
+          :namespace => "http://v1.example.com",
+          :adapter => :adapter_for_test,
+      )
+      response = client.call(:authenticate)
+      expect(response.http.body).to include('xmlns:wsdl="http://v1.example.com"')
+      expect(response.http.body).to include('<wsdl:authenticate>')
+      expect(AdapterForTest.class_variable_get(:@@requests).size).to eq(1)
+      expect(AdapterForTest.class_variable_get(:@@requests).first.url).to eq(URI.parse(@server.url(:repeat)))
+      expect(AdapterForTest.class_variable_get(:@@methods)).to eq([:post])
+    end
+  end
+
   context "global and request :soap_header" do
     it "merges the headers if both were provided as Hashes" do
       global_soap_header = {

data/spec/savon/response_spec.rb

@@ -118,6 +118,16 @@ describe Savon::Response do
       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

data/spec/support/adapters.rb

@@ -0,0 +1,48 @@
+require 'httpi/adapter/httpclient'
+
+# Proxy adapter. Records all requests and passes them to HTTPClient
+class AdapterForTest < HTTPI::Adapter::Base
+
+  register :adapter_for_test
+
+  def initialize(request)
+    @@requests ||= []
+    @@requests.push request
+    @request = request
+    @worker = HTTPI::Adapter::HTTPClient.new(request)
+  end
+
+  def client
+    @worker.client
+  end
+
+  def request(method)
+    @@methods ||= []
+    @@methods.push method
+    @worker.request(method)
+  end
+
+end
+
+# Fake adapter with request recording.
+# Takes path from url and returns fixture WSDL with that name.
+class FakeAdapterForTest < HTTPI::Adapter::Base
+
+  register :fake_adapter_for_test
+
+  def initialize(request)
+    @@requests ||= []
+    @@requests.push request
+    @request = request
+  end
+
+  attr_reader :client
+
+  def request(method)
+    @@methods ||= []
+    @@methods.push method
+    target = @request.url.path.to_sym
+    HTTPI::Response.new(200, {}, Fixture.wsdl(target))
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: savon
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Daniel Harrington
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-01 00:00:00.000000000 Z
+date: 2014-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nori
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: httpi
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.2
+        version: 3.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.2
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: akami
   requirement: !ruby/object:Gem::Requirement
@@ -233,6 +233,7 @@ files:
 - spec/fixtures/gzip/message.gz
 - spec/fixtures/response/another_soap_fault.xml
 - spec/fixtures/response/authentication.xml
+- spec/fixtures/response/f5.xml
 - spec/fixtures/response/header.xml
 - spec/fixtures/response/list.xml
 - spec/fixtures/response/multi_ref.xml
@@ -254,6 +255,7 @@ files:
 - spec/fixtures/wsdl/team_software.xml
 - spec/fixtures/wsdl/vies.xml
 - spec/fixtures/wsdl/wasmuth.xml
+- spec/integration/centra_spec.rb
 - spec/integration/email_example_spec.rb
 - spec/integration/random_quote_spec.rb
 - spec/integration/ratp_example_spec.rb
@@ -278,6 +280,7 @@ files:
 - spec/savon/response_spec.rb
 - spec/savon/soap_fault_spec.rb
 - spec/spec_helper.rb
+- spec/support/adapters.rb
 - spec/support/endpoint.rb
 - spec/support/fixture.rb
 - spec/support/integration.rb