wasabi 1.0.0 → 2.0.0

data/CHANGELOG.md

@@ -1,4 +1,9 @@
+## 2.0.0 (2011-07-07)
+
+* Feature: Wasabi can now parse type definitions and namespaces.
+  Thanks to [jkingdon](https://github.com/jkingdon) for implementing this.
+
 ## 1.0.0 (2011-07-03)
 
 * Initial version extracted from the [Savon](http://rubygems.org/gems/savon) library.
-  Use it to build your own SOAP client and help to improve it!
+  Use it to build your own SOAP client and help to improve it!

data/lib/wasabi/core_ext/object.rb

@@ -0,0 +1,14 @@
+module Wasabi
+  module CoreExt
+    module Object
+
+      # Returns +true+ if the Object is nil, false or empty. Implementation from ActiveSupport.
+      def blank?
+        respond_to?(:empty?) ? empty? : !self
+      end unless method_defined?(:blank?)
+
+    end
+  end
+end
+
+Object.send :include, Wasabi::CoreExt::Object

data/lib/wasabi/document.rb

@@ -61,19 +61,50 @@ module Wasabi
       @operations ||= parser.operations
     end
 
+    def type_namespaces
+      @type_namespaces ||= begin
+        namespaces = []
+        parser.types.each do |type, info|
+          namespaces << [[type], info[:namespace]]
+          (info.keys - [:namespace]).each { |field| namespaces << [[type, field], info[:namespace]] }
+        end if document?
+        namespaces
+      end
+    end
+
+    def type_definitions
+      @type_definitions ||= begin
+        result = []
+        parser.types.each do |type, info|
+          (info.keys - [:namespace]).each do |field|
+            field_type = info[field][:type]
+            tag, namespace = field_type.split(":").reverse
+            result << [[type, field], tag] if user_defined(namespace)
+          end
+        end if document?
+        result
+      end
+    end
+
+    # Returns whether the given +namespace+ was defined manually.
+    def user_defined(namespace)
+      uri = parser.namespaces[namespace]
+      !(uri =~ %r{^http://schemas.xmlsoap.org} || uri =~ %r{^http://www.w3.org})
+    end
+
     # Returns the raw WSDL document.
     # Can be used as a hook to extend the library.
     def xml
       @xml ||= document
     end
 
-  private
-
     # Parses the WSDL document and returns the <tt>Wasabi::Parser</tt>.
     def parser
       @parser ||= guard_parse && parse
     end
 
+  private
+
     # Raises an error if the WSDL document is missing.
     def guard_parse
       return true if xml.kind_of?(String)

data/lib/wasabi/parser.rb

@@ -1,4 +1,5 @@
 require "uri"
+require "wasabi/core_ext/object"
 require "wasabi/core_ext/string"
 
 module Wasabi
@@ -8,30 +9,37 @@ module Wasabi
   # Parses WSDL documents and remembers their important parts.
   class Parser
 
-    def initialize(document)
-      @document = document
-      @path = []
+    def initialize(nokogiri_document)
+      @document = nokogiri_document
       @operations = {}
       @namespaces = {}
+      @types = {}
       @element_form_default = :unqualified
     end
 
-    # Returns the SOAP endpoint.
-    attr_reader :endpoint
-
     # Returns the target namespace.
     attr_reader :namespace
 
+    # Returns a map from namespace identifier to namespace URI.
+    attr_reader :namespaces
+
     # Returns the SOAP operations.
     attr_reader :operations
 
-    # Returns the value of elementFormDefault.
+    # Returns a map from a type name to a Hash with type information.
+    attr_reader :types
+
+    # Returns the SOAP endpoint.
+    attr_reader :endpoint
+
+    # Returns the elementFormDefault value.
     attr_reader :element_form_default
 
     def parse
       parse_namespaces
       parse_endpoint
       parse_operations
+      parse_types
     end
 
     def parse_namespaces
@@ -45,6 +53,10 @@ module Wasabi
         "s0:definitions/@targetNamespace",
         "s0" => "http://schemas.xmlsoap.org/wsdl/")
       @namespace = namespace.to_s if namespace
+
+      @namespaces = @document.collect_namespaces.inject({}) do |result, (key, value)|
+        result.merge(key.gsub(/xmlns:/, '') => value)
+      end
     end
 
     def parse_endpoint
@@ -64,7 +76,6 @@ module Wasabi
       operations = @document.xpath(
         "s0:definitions/s0:binding/s0:operation",
         "s0" => "http://schemas.xmlsoap.org/wsdl/")
-
       operations.each do |operation|
         name = operation.attribute("name").to_s
 
@@ -78,8 +89,8 @@ module Wasabi
         if soap_action
           soap_action = soap_action.to_s
 
-          action = soap_action && !soap_action.empty? ? soap_action : name
-          input = (!name || name.empty?) ? action.split("/").last : name
+          action = soap_action.blank? ? name : soap_action
+          input = name.blank? ? action.split("/").last : name
 
           @operations[input.snakecase.to_sym] =
             { :action => action, :input => input }
@@ -90,5 +101,45 @@ module Wasabi
       end
     end
 
+    def parse_types
+      @document.xpath(
+        "s0:definitions/s0:types/xs:schema/xs:element[@name]",
+        "s0" => "http://schemas.xmlsoap.org/wsdl/",
+        "xs" => "http://www.w3.org/2001/XMLSchema"
+      ).each do |type|
+        process_type(type.at_xpath('./xs:complexType',
+          "xs" => "http://www.w3.org/2001/XMLSchema"
+        ), type.attribute('name').to_s)
+      end
+
+      @document.xpath(
+        "s0:definitions/s0:types/xs:schema/xs:complexType[@name]",
+        "s0" => "http://schemas.xmlsoap.org/wsdl/",
+        "xs" => "http://www.w3.org/2001/XMLSchema"
+      ).each do |type|
+        process_type(type, type.attribute('name').to_s)
+      end
+    end
+
+    def process_type(type, name)
+      return unless type
+      @types[name] ||= { :namespace => find_namespace(type) }
+
+      type.xpath("./xs:sequence/xs:element",
+        "xs" => "http://www.w3.org/2001/XMLSchema"
+      ).each do |inner_element|
+        @types[name][inner_element.attribute('name').to_s] = {
+          :type => inner_element.attribute('type').to_s
+        }
+      end
+    end
+
+    def find_namespace(type)
+      schema_namespace = type.at_xpath("ancestor::xs:schema/@targetNamespace",
+        "xs" => "http://www.w3.org/2001/XMLSchema"
+      )
+      schema_namespace ? schema_namespace.to_s : @namespace
+    end
+
   end
 end

data/lib/wasabi/version.rb

@@ -1,5 +1,5 @@
 module Wasabi
 
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 
 end

data/spec/fixtures/lower_camel.xml

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<definitions
+  xmlns="http://schemas.xmlsoap.org/wsdl/"
+  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
+  xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
+  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
+  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xmlns:s="http://www.w3.org/2001/XMLSchema"
+  xmlns:actions="http://example.com/actions"
+  targetNamespace="http://example.com/topLevelNamespace">
+    <types>
+        <s:schema elementFormDefault="qualified" targetNamespace="http://example.com/actions">
+            <s:element name="Save">
+                <s:complexType>
+                    <s:sequence>
+                        <s:element name="lowerCamel" type="s:string"/>
+                    </s:sequence>
+                </s:complexType>
+            </s:element>
+        </s:schema>
+    </types>
+    <message name="SaveSoapIn">
+        <part name="parameters" element="actions:Save"/>
+    </message>
+    <message name="SaveSoapOut">
+        <part name="parameters" element="actions:SaveResponse"/>
+    </message>
+    <portType name="ArticleSoap">
+        <operation name="Save">
+            <input message="actions:SaveSoapIn"/>
+            <output message="actions:SaveSoapOut"/>
+        </operation>
+    </portType>
+    <binding name="ArticleSoap" type="actions:ArticleSoap">
+        <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
+        <operation name="Save">
+            <soap:operation soapAction="http://example.com/actions.Save" style="document"/>
+            <input>
+                <soap:body use="literal"/>
+            </input>
+            <output>
+                <soap:body use="literal"/>
+            </output>
+        </operation>
+    </binding>
+    <service name="StudyMDL">
+        <port name="StudyMDLSoap" binding="actions:StudyMDLSoap">
+            <soap:address location="http://example.com:1234/soap"/>
+        </port>
+    </service>
+</definitions>

data/spec/fixtures/multiple_namespaces.xml

@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<definitions
+  xmlns="http://schemas.xmlsoap.org/wsdl/"
+  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
+  xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
+  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
+  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xmlns:s="http://www.w3.org/2001/XMLSchema"
+  xmlns:article="http://example.com/article"
+  xmlns:actions="http://example.com/actions"
+  targetNamespace="http://example.com/actions">
+    <types>
+        <s:schema elementFormDefault="qualified" targetNamespace="http://example.com/actions">
+            <s:element name="Save">
+                <s:complexType>
+                    <s:sequence>
+                        <s:element name="article" type="article:Article"/>
+                    </s:sequence>
+                </s:complexType>
+            </s:element>
+        </s:schema>
+        <s:schema elementFormDefault="qualified" targetNamespace="http://example.com/article">
+            <s:complexType name="Article">
+                <s:sequence>
+                    <s:element minOccurs="0" name="Author" type="s:string"/>
+                    <s:element minOccurs="0" name="Title" type="s:string"/>
+                </s:sequence>
+            </s:complexType>
+        </s:schema>
+    </types>
+    <message name="SaveSoapIn">
+        <part name="parameters" element="actions:Save"/>
+    </message>
+    <message name="SaveSoapOut">
+        <part name="parameters" element="actions:SaveResponse"/>
+    </message>
+    <portType name="ArticleSoap">
+        <operation name="Save">
+            <input message="actions:SaveSoapIn"/>
+            <output message="actions:SaveSoapOut"/>
+        </operation>
+    </portType>
+    <binding name="ArticleSoap" type="actions:ArticleSoap">
+        <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
+        <operation name="Save">
+            <soap:operation soapAction="http://example.com/actions.Save" style="document"/>
+            <input>
+                <soap:body use="literal"/>
+            </input>
+            <output>
+                <soap:body use="literal"/>
+            </output>
+        </operation>
+    </binding>
+    <service name="StudyMDL">
+        <port name="StudyMDLSoap" binding="actions:StudyMDLSoap">
+            <soap:address location="http://example.com:1234/soap"/>
+        </port>
+    </service>
+</definitions>

data/spec/fixtures/multiple_types.xml

@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<definitions
+  xmlns="http://schemas.xmlsoap.org/wsdl/"
+  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
+  xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
+  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
+  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xmlns:s="http://www.w3.org/2001/XMLSchema"
+  xmlns:article="http://example.com/article"
+  xmlns:actions="http://example.com/actions"
+  targetNamespace="http://example.com/actions">
+    <types>
+        <s:schema elementFormDefault="qualified" targetNamespace="http://example.com/actions">
+            <s:element name="Save">
+                <s:complexType>
+                    <s:sequence>
+                        <s:element name="article" type="s:string"/>
+                    </s:sequence>
+                </s:complexType>
+            </s:element>
+            <s:element name="Get">
+                <s:complexType>
+                    <s:sequence>
+                        <s:element name="articleId" type="s:long"/>
+                    </s:sequence>
+                </s:complexType>
+            </s:element>
+        </s:schema>
+    </types>
+    <message name="SaveSoapIn">
+        <part name="parameters" element="actions:Save"/>
+    </message>
+    <message name="SaveSoapOut">
+        <part name="parameters" element="actions:SaveResponse"/>
+    </message>
+    <portType name="ArticleSoap">
+        <operation name="Save">
+            <input message="actions:SaveSoapIn"/>
+            <output message="actions:SaveSoapOut"/>
+        </operation>
+    </portType>
+    <binding name="ArticleSoap" type="actions:ArticleSoap">
+        <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
+        <operation name="Save">
+            <soap:operation soapAction="http://example.com/actions.Save" style="document"/>
+            <input>
+                <soap:body use="literal"/>
+            </input>
+            <output>
+                <soap:body use="literal"/>
+            </output>
+        </operation>
+    </binding>
+    <service name="StudyMDL">
+        <port name="StudyMDLSoap" binding="actions:StudyMDLSoap">
+            <soap:address location="http://example.com:1234/soap"/>
+        </port>
+    </service>
+</definitions>

data/spec/wasabi/core_ext/object_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe Object do
+
+  describe "blank?" do
+    it "returns true for Objects perceived to be blank" do
+      ["", false, nil, [], {}].each do |object|
+        object.should be_blank
+      end
+    end
+
+    it "returns false for every other Object" do
+      ["!blank", true, [:a], {:a => "b"}].each do |object|
+        object.should_not be_blank
+      end
+    end
+  end
+
+end

data/spec/wasabi/document/multiple_namespaces_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Wasabi::Document do
+  context "with: multiple_namespaces.xml" do
+
+    subject { Wasabi::Document.new fixture(:multiple_namespaces) }
+
+    its(:namespace) { should == "http://example.com/actions" }
+
+    its(:endpoint) { should == URI("http://example.com:1234/soap") }
+
+    its(:element_form_default) { should == :qualified }
+
+    it { should have(1).operations }
+
+    its(:operations) do
+      should == { :save => { :input => "Save", :action => "http://example.com/actions.Save" } }
+    end
+
+    its(:type_namespaces) do
+      should =~ [
+        [["Save"], "http://example.com/actions"],
+        [["Save", "article"], "http://example.com/actions"],
+        [["Article"], "http://example.com/article"],
+        [["Article", "Author"], "http://example.com/article"],
+        [["Article", "Title"], "http://example.com/article"]
+      ]
+    end
+
+    its(:type_definitions) do
+      should =~ [ [["Save", "article"], "Article"] ]
+    end
+
+  end
+end

data/spec/wasabi/parser/multiple_namespaces_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe Wasabi::Parser do
+  context "with: multiple_namespaces.xml" do
+
+    subject do
+      parser = Wasabi::Parser.new Nokogiri::XML(xml)
+      parser.parse
+      parser
+    end
+
+    let(:xml) { fixture(:multiple_namespaces) }
+
+    it "lists the types" do
+      subject.types.keys.sort.should == ["Article", "Save"]
+    end
+
+    it "records the namespace for each type" do
+      subject.types["Save"][:namespace].should == "http://example.com/actions"
+    end
+
+    it "records the fields under a type" do
+      subject.types["Save"].keys.should =~ ["article", :namespace]
+    end
+
+    it "records multiple fields when there are more than one" do
+      subject.types["Article"].keys.should =~ ["Title", "Author", :namespace]
+    end
+
+    it "records the type of a field" do
+      subject.types["Save"]["article"][:type].should == "article:Article"
+      subject.namespaces["article"].should == "http://example.com/article"
+    end
+
+  end
+end

data/spec/wasabi/parser/no_namespace_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Wasabi::Parser do
+  context "with: no_namespace.xml" do
+
+    subject do
+      parser = Wasabi::Parser.new Nokogiri::XML(xml)
+      parser.parse
+      parser
+    end
+
+    let(:xml) { fixture(:no_namespace) }
+
+    it "lists the types" do
+      subject.types.keys.sort.should == ["McContact", "McContactArray", "MpUser", "MpUserArray"]
+    end
+
+    it "ignores xsd:all" do
+      subject.types["MpUser"].keys.should == [:namespace]
+    end
+
+  end
+end

data/spec/wasabi/parser/no_target_namespace_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe Wasabi::Parser do
+  context "with a WSDL defining xs:schema without targetNamespace" do
+
+    subject do
+      parser = Wasabi::Parser.new Nokogiri::XML(xml)
+      parser.parse
+      parser
+    end
+
+    let(:xml) do
+      %Q{
+        <definitions xmlns='http://schemas.xmlsoap.org/wsdl/'
+          xmlns:xs='http://www.w3.org/2001/XMLSchema'
+          targetNamespace='http://def.example.com'>
+          <types>
+            <xs:schema elementFormDefault='qualified'>
+              <xs:element name='Save'>
+                <xs:complexType></xs:complexType>
+              </xs:element>
+            </xs:schema>
+          </types>
+        </definitions>
+      }
+    end
+
+    # Don't know if real WSDL files omit targetNamespace from xs:schema,
+    # but I suppose we should do something reasonable if they do.
+
+    it "defaults to the target namespace from xs:definitions" do
+      subject.types["Save"][:namespace].should == "http://def.example.com"
+    end
+
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wasabi
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 15
   prerelease: 
   segments: 
-  - 1
+  - 2
   - 0
   - 0
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-03 00:00:00 Z
+date: 2011-07-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -114,25 +114,34 @@ files:
 - README.md
 - Rakefile
 - lib/wasabi.rb
+- lib/wasabi/core_ext/object.rb
 - lib/wasabi/core_ext/string.rb
 - lib/wasabi/document.rb
 - lib/wasabi/parser.rb
 - lib/wasabi/version.rb
 - spec/fixtures/authentication.xml
 - spec/fixtures/geotrust.xml
+- spec/fixtures/lower_camel.xml
+- spec/fixtures/multiple_namespaces.xml
+- spec/fixtures/multiple_types.xml
 - spec/fixtures/namespaced_actions.xml
 - spec/fixtures/no_namespace.xml
 - spec/fixtures/soap12.xml
 - spec/fixtures/two_bindings.xml
 - spec/spec_helper.rb
 - spec/support/fixture.rb
+- spec/wasabi/core_ext/object_spec.rb
 - spec/wasabi/core_ext/string_spec.rb
 - spec/wasabi/document/authentication_spec.rb
 - spec/wasabi/document/geotrust_spec.rb
+- spec/wasabi/document/multiple_namespaces_spec.rb
 - spec/wasabi/document/namespaced_actions_spec.rb
 - spec/wasabi/document/no_namespace_spec.rb
 - spec/wasabi/document/soap12_spec.rb
 - spec/wasabi/document/two_bindings_spec.rb
+- spec/wasabi/parser/multiple_namespaces_spec.rb
+- spec/wasabi/parser/no_namespace_spec.rb
+- spec/wasabi/parser/no_target_namespace_spec.rb
 - spec/wasabi/wasabi_spec.rb
 - wasabi.gemspec
 homepage: https://github.com/rubiii/wasabi
@@ -171,17 +180,25 @@ summary: A simple WSDL parser
 test_files: 
 - spec/fixtures/authentication.xml
 - spec/fixtures/geotrust.xml
+- spec/fixtures/lower_camel.xml
+- spec/fixtures/multiple_namespaces.xml
+- spec/fixtures/multiple_types.xml
 - spec/fixtures/namespaced_actions.xml
 - spec/fixtures/no_namespace.xml
 - spec/fixtures/soap12.xml
 - spec/fixtures/two_bindings.xml
 - spec/spec_helper.rb
 - spec/support/fixture.rb
+- spec/wasabi/core_ext/object_spec.rb
 - spec/wasabi/core_ext/string_spec.rb
 - spec/wasabi/document/authentication_spec.rb
 - spec/wasabi/document/geotrust_spec.rb
+- spec/wasabi/document/multiple_namespaces_spec.rb
 - spec/wasabi/document/namespaced_actions_spec.rb
 - spec/wasabi/document/no_namespace_spec.rb
 - spec/wasabi/document/soap12_spec.rb
 - spec/wasabi/document/two_bindings_spec.rb
+- spec/wasabi/parser/multiple_namespaces_spec.rb
+- spec/wasabi/parser/no_namespace_spec.rb
+- spec/wasabi/parser/no_target_namespace_spec.rb
 - spec/wasabi/wasabi_spec.rb