wasabi-ng-1.6 3.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f5657201ca8ca58c80f372f9d46f164dc548af6
+  data.tar.gz: 1b07dede1bee0dc7ece80c96160becabb7dfcd81
+SHA512:
+  metadata.gz: bcd9c7b4e64663c9f01731eb21339111480865422e1b2df97811fd97a69b53fe0a4c77758c80eb60f2d994a973ebe37cd901d0318e7dfb1cbcf9e4b372db00ca
+  data.tar.gz: 5fa9f8b47ffcac82f092c81afce91c18c1d258c2b504443075c3230ac51809b2a3337768915acc1562f1bc364e797d67adc242f4b447399ce84830f9deae9a97

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+doc
+coverage
+pkg
+*~
+*.gem
+.bundle
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ree

data/CHANGELOG.md

@@ -0,0 +1,90 @@
+## 3.2.0 (2013-07-26)
+
+* Feature: [#20](https://github.com/savonrb/wasabi/issues/20) Limited support for listing an
+  operation's parameters. Please note that if your WSDL defines imports, this method might
+  not return all types.
+
+* Improvement: [#7](https://github.com/savonrb/wasabi/issues/7) Major speed improvements.
+
+* Improvement: [#16](https://github.com/savonrb/wasabi/issues/16) Various improvements regarding
+  element order and type information.
+
+* Fix: [#25](https://github.com/savonrb/wasabi/issues/25) Fixes a problem where Wasabi escaped
+  an already escaped endpoint URL.
+
+* Fix: [#15](https://github.com/savonrb/wasabi/issues/15) Fixes a bug where the operation tag
+  name was not correctly extracted from the WSDL document.
+
+## 3.1.0 (2013-04-21)
+
+* Feature: [#22](https://github.com/savonrb/wasabi/issues/22) added `Wasabi::Document#service_name`
+  to return the name of the SOAP service. Original issue: [savonrb/savon#408](https://github.com/savonrb/savon/pull/408).
+
+* Fix: [#21](https://github.com/savonrb/wasabi/issues/21) when the Resolver gets an
+  erroneous response (such as a 404), we now raise a more useful HTTPError.
+
+* Fix: [#23](https://github.com/savonrb/wasabi/issues/23) ignore extension base elements
+  defined in imports.
+
+## 3.0.0 (2012-12-17)
+
+* Updated to HTTPI 2.0 to play nicely with Savon 2.0.
+
+## 2.5.1 (2012-08-22)
+
+* Fix: [#14](https://github.com/savonrb/wasabi/issues/14) fixes an issue where
+  finding the correct SOAP input tag and namespace identifier fails when portTypes
+  are imported, since imports are currently not supported.
+
+  The bug was introduced in v2.2.0 by [583cf6](https://github.com/savonrb/wasabi/commit/583cf658f1953411a7a7a4c22923fa0a046c8d6d)
+
+* Refactoring: Removed `Object#blank?` core extension.
+
+## 2.5.0 (2012-06-28)
+
+* Fix: [#10](https://github.com/savonrb/wasabi/issues/10) fixes an issue where
+  Wasabi used the wrong operation name.
+
+## 2.4.1 (2012-06-18)
+
+* Fix: [savonrb/savon#296](https://github.com/savonrb/savon/issues/296) fixes an issue where
+  the WSDL message element doesn't have part element.
+
+## 2.4.0 (2012-06-08)
+
+* Feature: `Wasabi::Document` now accepts either a URL of a remote document,
+  a path to a local file or raw XML. The code for this was moved from Savon over
+  here as a first step towards supporting WSDL imports.
+
+## 2.3.0 (2012-06-07)
+
+* Improvement: [#3](https://github.com/savonrb/wasabi/pull/3) adds object inheritance.
+
+## 2.2.0 (2012-06-06)
+
+* Improvement: [#5](https://github.com/savonrb/wasabi/pull/5) - Get input from message
+  element or portType input. See [savonrb/savon#277](https://github.com/savonrb/savon/pull/277)
+  to get the full picture on how this all works together, and enables you to pass a single
+  symbol into the `Savon::Client#request` method and get automatic namespace mapping, as well
+  as the proper operation name -> input message mapping.
+
+## 2.1.1 (2012-05-18)
+
+* Fix: [issue 7](https://github.com/savonrb/wasabi/issues/7) - Performance regression.
+
+## 2.1.0 (2012-02-17)
+
+* Improvement: The value of elementFormDefault can now be manually specified/overwritten.
+
+* Improvement: [issue 2](https://github.com/savonrb/wasabi/issues/2) - Allow symbolic endpoints
+  like "http://server:port".
+
+## 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!

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'simplecov',       :require => false
+gem 'method_profiler', :require => false
+gem 'coveralls',       :require => false

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Daniel Harrington
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Wasabi
+
+A simple WSDL parser.
+
+[![Build Status](https://secure.travis-ci.org/savonrb/wasabi.png)](http://travis-ci.org/savonrb/wasabi)
+[![Gem Version](https://badge.fury.io/rb/wasabi.png)](http://badge.fury.io/rb/wasabi)
+[![Code Climate](https://codeclimate.com/github/savonrb/wasabi.png)](https://codeclimate.com/github/savonrb/wasabi)
+[![Coverage Status](https://coveralls.io/repos/savonrb/wasabi/badge.png?branch=master)](https://coveralls.io/r/savonrb/wasabi)
+
+
+## Installation
+
+Wasabi is available through [Rubygems](http://rubygems.org/gems/wasabi) and can be installed via:
+
+```
+$ gem install wasabi
+```
+
+
+## Getting started
+
+``` ruby
+document = Wasabi.document File.read("some.wsdl")
+```
+
+Get the SOAP endpoint:
+
+``` ruby
+document.endpoint
+# => "http://soap.example.com"
+```
+
+Get the target namespace:
+
+``` ruby
+document.namespace
+# => "http://v1.example.com"
+```
+
+Check whether elementFormDefault is set to `:qualified` or `:unqualified`:
+
+``` ruby
+document.element_form_default
+# => :qualified
+```
+
+Get a list of available SOAP actions (snakecase for convenience):
+
+``` ruby
+document.soap_actions
+# => [:create_user, :find_user]
+```
+
+Get a map of SOAP action Symbols, their input tag and original SOAP action name:
+
+``` ruby
+document.operations
+# => { :create_user => { :input => "createUser", :action => "createUser" },
+# =>   :find_user => { :input => "findUser", :action => "findUser" } }
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/wasabi.rb

@@ -0,0 +1,12 @@
+require "wasabi/version"
+require "wasabi/document"
+require "wasabi/resolver"
+
+module Wasabi
+
+  # Expects a WSDL document and returns a <tt>Wasabi::Document</tt>.
+  def self.document(document)
+    Document.new(document)
+  end
+
+end

data/lib/wasabi/core_ext/string.rb

@@ -0,0 +1,21 @@
+module Wasabi
+  module CoreExt
+    module String
+
+      # Returns the String in snakecase.
+      def snakecase
+        str = dup
+        str.gsub! /::/, '/'
+        str.gsub! /([A-Z]+)([A-Z][a-z])/, '\1_\2'
+        str.gsub! /([a-z\d])([A-Z])/, '\1_\2'
+        str.tr! ".", "_"
+        str.tr! "-", "_"
+        str.downcase!
+        str
+      end unless method_defined?(:snakecase)
+
+    end
+  end
+end
+
+String.send :include, Wasabi::CoreExt::String

data/lib/wasabi/document.rb

@@ -0,0 +1,166 @@
+require "nokogiri"
+require "wasabi/resolver"
+require "wasabi/parser"
+
+module Wasabi
+
+  # = Wasabi::Document
+  #
+  # Represents a WSDL document.
+  class Document
+
+    ELEMENT_FORM_DEFAULTS = [:unqualified, :qualified]
+
+    # Validates if a given +value+ is a valid elementFormDefault value.
+    # Raises an +ArgumentError+ if the value is not valid.
+    def self.validate_element_form_default!(value)
+      return if ELEMENT_FORM_DEFAULTS.include?(value)
+
+      raise ArgumentError, "Invalid value for elementFormDefault: #{value}\n" +
+                           "Must be one of: #{ELEMENT_FORM_DEFAULTS.inspect}"
+    end
+
+    # Accepts a WSDL +document+ to parse.
+    def initialize(document = nil)
+      self.document = document
+    end
+
+    attr_accessor :document, :request, :xml
+
+    alias_method :document?, :document
+
+    # Returns the SOAP endpoint.
+    def endpoint
+      @endpoint ||= parser.endpoint
+    end
+
+    # Sets the SOAP endpoint.
+    attr_writer :endpoint
+
+    # Returns the target namespace.
+    def namespace
+      @namespace ||= parser.namespace
+    end
+
+    # Sets the target namespace.
+    attr_writer :namespace
+
+    # Returns the value of elementFormDefault.
+    def element_form_default
+      @element_form_default ||= document ? parser.element_form_default : :unqualified
+    end
+
+    # Sets the elementFormDefault value.
+    def element_form_default=(value)
+      self.class.validate_element_form_default!(value)
+      @element_form_default = value
+    end
+
+    # Returns a list of available SOAP actions.
+    def soap_actions
+      @soap_actions ||= parser.operations.keys
+    end
+
+    # Returns the SOAP action for a given +key+.
+    def soap_action(key)
+      operations[key][:action] if operations[key]
+    end
+
+    # Returns the SOAP input for a given +key+.
+    def soap_input(key)
+      operations[key][:input] if operations[key]
+    end
+
+    # Returns a map of SOAP operations.
+    def operations
+      @operations ||= parser.operations
+    end
+
+    # Returns the service name.
+    def service_name
+      @service_name ||= parser.service_name
+    end
+
+    attr_writer :service_name
+
+    # Returns a list of parameter names for a given +key+
+    def soap_action_parameters(key)
+      params = operation_input_parameters(key)
+      params.keys if params
+    end
+
+    # Returns a list of input parameters for a given +key+.
+    def operation_input_parameters(key)
+      parser.operations[key][:parameters] if operations[key]
+    end
+
+    def type_namespaces
+      @type_namespaces ||= begin
+        namespaces = []
+
+        parser.types.each do |type, info|
+          namespaces << [[type], info[:namespace]]
+
+          element_keys(info).each do |field|
+            namespaces << [[type, field], info[:namespace]]
+          end
+        end if document
+
+        namespaces
+      end
+    end
+
+    def type_definitions
+      @type_definitions ||= begin
+        result = []
+
+        parser.types.each do |type, info|
+          element_keys(info).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 ||= Resolver.new(document, request).resolve
+    end
+
+    # 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 document
+      raise ArgumentError, "Wasabi needs a WSDL document"
+    end
+
+    # Parses the WSDL document and returns <tt>Wasabi::Parser</tt>.
+    def parse
+      parser = Parser.new Nokogiri::XML(xml)
+      parser.parse
+      parser
+    end
+
+    def element_keys(info)
+      info.keys - [:namespace, :order!, :base_type]
+    end
+  end
+end

data/lib/wasabi/parser.rb

@@ -0,0 +1,304 @@
+require "uri"
+require "wasabi/core_ext/string"
+
+module Wasabi
+
+  # = Wasabi::Parser
+  #
+  # Parses WSDL documents and remembers their important parts.
+  class Parser
+
+    XSD      = "http://www.w3.org/2001/XMLSchema"
+    WSDL     = "http://schemas.xmlsoap.org/wsdl/"
+    SOAP_1_1 = "http://schemas.xmlsoap.org/wsdl/soap/"
+    SOAP_1_2 = "http://schemas.xmlsoap.org/wsdl/soap12/"
+
+    def initialize(document)
+      self.document = document
+      self.operations = {}
+      self.namespaces = {}
+      self.service_name = ''
+      self.types = {}
+      self.deferred_types = []
+      self.element_form_default = :unqualified
+    end
+
+    # Returns the Nokogiri document.
+    attr_accessor :document
+
+    # Returns the target namespace.
+    attr_accessor :namespace
+
+    # Returns a map from namespace identifier to namespace URI.
+    attr_accessor :namespaces
+
+    # Returns the SOAP operations.
+    attr_accessor :operations
+
+    # Returns a map from a type name to a Hash with type information.
+    attr_accessor :types
+
+    # Returns a map of deferred type Proc objects.
+    attr_accessor :deferred_types
+
+    # Returns the SOAP endpoint.
+    attr_accessor :endpoint
+
+    # Returns the SOAP Service Name
+    attr_accessor :service_name
+
+    # Returns the elementFormDefault value.
+    attr_accessor :element_form_default
+
+    def parse
+      parse_namespaces
+      parse_endpoint
+      parse_service_name
+      parse_messages
+      parse_port_types
+      parse_port_type_operations
+      parse_operations
+      parse_operations_parameters
+      parse_types
+      parse_deferred_types
+    end
+
+    def parse_namespaces
+      element_form_default = schemas.first && schemas.first['elementFormDefault']
+      @element_form_default = element_form_default.to_s.to_sym if element_form_default
+
+      namespace = document.root['targetNamespace']
+      @namespace = namespace.to_s if namespace
+
+      @namespaces = @document.namespaces.inject({}) do |memo, (key, value)|
+        memo[key.sub("xmlns:", "")] = value
+        memo
+      end
+    end
+
+    def parse_endpoint
+      if service_node = service
+        endpoint = service_node.at_xpath(".//soap11:address/@location", 'soap11' => SOAP_1_1)
+        endpoint ||= service_node.at_xpath(service_node, ".//soap12:address/@location", 'soap12' => SOAP_1_2)
+      end
+
+      @endpoint = parse_url(endpoint) if endpoint
+    end
+
+    def parse_url(url)
+      unescaped_url = URI.unescape(url.to_s)
+      escaped_url   = URI.escape(unescaped_url)
+      URI.parse(escaped_url)
+    rescue URI::InvalidURIError
+    end
+
+    def parse_service_name
+      service_name = document.root['name']
+      @service_name = service_name.to_s if service_name
+    end
+
+    def parse_messages
+      messages = document.root.element_children.select { |node| node.name == 'message' }
+      @messages = Hash[messages.map { |node| [node['name'], node] }]
+    end
+
+    def parse_port_types
+      port_types = document.root.element_children.select { |node| node.name == 'portType' }
+      @port_types = Hash[port_types.map { |node| [node['name'], node] }]
+    end
+
+    def parse_port_type_operations
+      @port_type_operations = {}
+
+      @port_types.each do |port_type_name, port_type|
+        operations = port_type.element_children.select { |node| node.name == 'operation' }
+        @port_type_operations[port_type_name] = Hash[operations.map { |node| [node['name'], node] }]
+      end
+    end
+
+    def parse_operations_parameters
+      root_elements = document.xpath("wsdl:definitions/wsdl:types/*[local-name()='schema']/*[local-name()='element']", 'wsdl' => WSDL).each do |element|
+        name = element.attribute("name").to_s.snakecase.to_sym
+
+        if operation = @operations[name]
+          element.xpath("*[local-name() ='complexType']/*[local-name() ='sequence']/*[local-name() ='element']").each do |child_element|
+            attr_name = child_element.attribute("name").to_s
+            attr_type = (attr_type = child_element.attribute("type").to_s.split(":")).size > 1 ? attr_type[1] : attr_type[0]
+
+            operation[:parameters] ||= {}
+            operation[:parameters][attr_name.to_sym] = { :name => attr_name, :type => attr_type }
+          end
+        end
+      end
+    end
+
+    def parse_operations
+      operations = document.xpath("wsdl:definitions/wsdl:binding/wsdl:operation", 'wsdl' => WSDL)
+      operations.each do |operation|
+        name = operation.attribute("name").to_s
+
+        # TODO: check for soap namespace?
+        soap_operation = operation.element_children.find { |node| node.name == 'operation' }
+        soap_action = soap_operation['soapAction'] if soap_operation
+
+        if soap_action
+          soap_action = soap_action.to_s
+          action = soap_action && !soap_action.empty? ? soap_action : name
+
+          # There should be a matching portType for each binding, so we will lookup the input from there.
+          namespace_id, output = output_for(operation)
+          namespace_id, input = input_for(operation)
+
+          # Store namespace identifier so this operation can be mapped to the proper namespace.
+          @operations[name.snakecase.to_sym] = { :action => action, :input => input, :output => output, :namespace_identifier => namespace_id}
+        elsif !@operations[name.snakecase.to_sym]
+          @operations[name.snakecase.to_sym] = { :action => name, :input => name }
+        end
+      end
+    end
+
+    def parse_types
+      schemas.each do |schema|
+        schema_namespace = schema['targetNamespace']
+
+        schema.element_children.each do |node|
+          namespace = schema_namespace || @namespace
+
+          case node.name
+          when 'element'
+            complex_type = node.at_xpath('./xs:complexType', 'xs' => XSD)
+            process_type namespace, complex_type, node['name'].to_s if complex_type
+          when 'complexType'
+            process_type namespace, node, node['name'].to_s
+          end
+        end
+      end
+    end
+
+    def process_type(namespace, type, name)
+      @types[name] ||= { :namespace => namespace }
+      @types[name][:order!] = []
+
+      type.xpath("./xs:sequence/xs:element", 'xs' => XSD).each do |inner|
+        element_name = inner.attribute("name").to_s
+        @types[name][element_name] = { :type => inner.attribute("type").to_s }
+
+        [ :nillable, :minOccurs, :maxOccurs ].each do |attr|
+          if v = inner.attribute(attr.to_s)
+           @types[name][element_name][attr] = v.to_s
+          end
+        end
+
+        @types[name][:order!] << element_name
+      end
+
+      type.xpath("./xs:complexContent/xs:extension/xs:sequence/xs:element", 'xs' => XSD).each do |inner_element|
+        element_name = inner_element.attribute('name').to_s
+        @types[name][element_name] = { :type => inner_element.attribute('type').to_s }
+
+        @types[name][:order!] << element_name
+      end
+
+      type.xpath('./xs:complexContent/xs:extension[@base]', 'xs' => XSD).each do |inherits|
+        base = inherits.attribute('base').value.match(/\w+$/).to_s
+
+        if @types[base]
+          # Reverse merge because we don't want subclass attributes to be overriden by base class
+          @types[name] = types[base].merge(types[name])
+          @types[name][:order!] = @types[base][:order!] | @types[name][:order!]
+          @types[name][:base_type] = base
+        else
+          p = Proc.new do
+            if @types[base]
+              # Reverse merge because we don't want subclass attributes to be overriden by base class
+              @types[name] = @types[base].merge(@types[name])
+              @types[name][:order!] = @types[base][:order!] | @types[name][:order!]
+              @types[name][:base_type] = base
+            end
+          end
+          deferred_types << p
+        end
+      end
+    end
+
+    def parse_deferred_types
+      deferred_types.each(&:call)
+    end
+
+    def input_for(operation)
+     input_output_for(operation, "input")
+    end
+
+    def output_for(operation)
+     input_output_for(operation, "output")
+    end
+
+    def input_output_for(operation, input_output)
+      operation_name = operation["name"]
+
+      # Look up the input by walking up to portType, then up to the message.
+
+      binding_type = operation.parent['type'].to_s.split(':').last
+      if @port_type_operations[binding_type]
+        port_type_operation = @port_type_operations[binding_type][operation_name]
+      end
+
+      port_type_input_output = port_type_operation &&
+                               port_type_operation.element_children.find { |node| node.name == input_output }
+
+      # TODO: Stupid fix for missing support for imports.
+      # Sometimes portTypes are actually included in a separate WSDL.
+      if port_type_input_output
+        port_message_ns_id, port_message_type = port_type_input_output.attribute("message").to_s.split(':')
+
+        message_ns_id, message_type = nil
+
+        # TODO: Support multiple 'part' elements in the message.
+        message = @messages[port_message_type]
+        port_message_part = message.element_children.find { |node| node.name == 'part' }
+
+        if port_message_part
+          if (port_message_part_element = port_message_part.attribute("element"))
+            message_ns_id, message_type = port_message_part_element.to_s.split(':')
+          end
+        end
+
+        # Fall back to the name of the binding operation
+        if message_type
+          [message_ns_id, message_type]
+        else
+          [port_message_ns_id, port_message_type]
+        end
+      else
+        [nil, operation_name]
+      end
+    end
+
+    def schemas
+      types = section('types').first
+      types ? types.element_children : []
+    end
+
+    def service
+      services = section('service')
+      services.first if services  # service nodes could be imported?
+    end
+
+    def section(section_name)
+      sections[section_name] || []
+    end
+
+    def sections
+      return @sections if @sections
+
+      sections = {}
+      document.root.element_children.each do |node|
+        (sections[node.name] ||= []) << node
+      end
+
+      @sections = sections
+    end
+
+  end
+
+end