wsdl_validator 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9961bec661ee4694a60380405b01bde5eda2a839
-  data.tar.gz: b1a9280dc26806fd4c2fd5e313679f7959dcf696
+  metadata.gz: 8a26cd53860d077be92fa6ce8805acbfe00a5197
+  data.tar.gz: 0be7f70752fd4f9fb777d409891e92025e1fd922
 SHA512:
-  metadata.gz: de6d8ae3431d9ef649f547b06d53dcf24afddb76fd19ea343ca62609dec9cecbf20f6fc5b400b41b90b0560ea85c1dbb8abce31cbbf78abf95c67ba61d4a6d1d
-  data.tar.gz: 4e2aecefd02a9edb07fe135280764a8bba6603450cdc9da5bdce1a694b05013649c5d1a16d6f980f1cc6bb35b779ce9a63409fb0266d31206fec4a6f0c5c026e
+  metadata.gz: 424cacf768ad17fefe1e16be4a1e29a774610ba307663ca1962946730fef0fac2dd2f115c7b06cf121a2adf9bf556e9d76031fa29c384a498d210bd43776224c
+  data.tar.gz: bfba1e7cffc896465e8051c93a04f507573e4c3327ceb63494aa28232c8eefb555e1ee9d13559a228edf67e7f348cb6d98206e82c912aa2fd0e24b294f676358

data/README.md

@@ -4,7 +4,7 @@ A simple gem to aid with validator a SOAP message according to a WSDL.
 
 [![Build Status](https://gitlab.com/samuel-garratt/wsdl_validator/badges/master/build.svg)](https://gitlab.com/samuel-garratt/wsdl_validator/pipelines)
 
-This is a work in progress
+This is a work in progress. If your xml is not being validated corrected please raise an issue.
 
 ## Installation
 

data/lib/wsdl_validator/version.rb

@@ -1,3 +1,3 @@
 class WsdlValidator
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.1.6'.freeze
 end

data/lib/wsdl_validator/wsdl_validator.rb

@@ -2,13 +2,25 @@ require_relative 'error'
 
 # Helps to validate xml against schemas contained in a WSDL
 class WsdlValidator
-  # @param [String] wsdl_url URL to where WSDL is stored
+
+  attr_accessor :schemas
+  attr_accessor :basic_auth
+  attr_accessor :doc
+
+  # Parse WSDL storing authentication and all schemas from it
+  # @param [String] wsdl_url URL to where WSDL is stored or location to where file is stored
   def initialize(wsdl_url)
-    @doc = Wasabi.document wsdl_url
-    @schemas = @doc.parser.schemas.collect(&:to_s).join
+    self.basic_auth = extract_auth(wsdl_url)
+    self.doc = Wasabi.document wsdl_url
+    self.schemas = Nokogiri::XML::Schema(parse_wsdl_schemas)
+  rescue Wasabi::Resolver::HTTPError => e
+    raise WsdlValidator::Error, "Unauthorized for basic auth #{basic_auth}" if e.response.code == 401
+    raise e
   end
 
-  # This is not the ideal approach. Ideally Nokogiri parser would be able to understand SOAP xsd as well
+  # Gets the namespaces from the SOAP Envelope & Body element, adds them to the root element underneath the body
+  # and returns that element.
+  # @note This is not the ideal approach. Ideally Nokogiri parser would be able to understand SOAP xsd as well
   # @return [Nokogiri::XML::Document] Retrieve root element from SOAP
   def extract_root_from_soap(envelope)
     body = envelope.children.find { |child| child.name == 'Body' }
@@ -25,10 +37,46 @@ class WsdlValidator
     xml_under_test = Nokogiri::XML(xml.to_s)
     soap_envelope = xml_under_test.children.find { |e| e.name == 'Envelope' }
     xml_under_test = extract_root_from_soap(soap_envelope) if soap_envelope
-    xsd = Nokogiri::XML::Schema(@schemas)
-    validator = xsd.validate(xml_under_test)
-    # validator.each { |error| puts error.message }
+    validator = schemas.validate(xml_under_test)
     raise WsdlValidator::Error, validator.join unless validator.empty?
     true
   end
+
+  private
+
+  # Returns a string used to prefix a URL for basic auth
+  # @return [Array] Format is 'user_name:password@' or empty string
+  def extract_auth(wsdl_location)
+    return [] unless wsdl_location.to_s =~ /^http|socks/
+    url = wsdl_location.is_a?(URI) ? wsdl_location : URI(wsdl_location)
+    if url.user
+      [url.user, url.password]
+    else
+      []
+    end
+  end
+
+  # Join all the schemas within the WSDL, importing schemas if necessary
+  # @return [String] Schemas contained within WSDL
+  def parse_wsdl_schemas
+    doc.parser.schemas.collect do |schema|
+      imports = schema.children.select { |child| child.name == 'import' }
+      imported_xsds = imports.collect do |import|
+        extract_schema_for(import)
+      end.join
+      schema = Nokogiri::XML(imported_xsds).children unless imported_xsds.empty?
+      schema.to_s
+    end.join
+  end
+
+  # Makes a GET request returning the xsd from the defined location
+  # @return [String] Schema from location defined in 'schemaLocation' attribute
+  def extract_schema_for(import)
+    raise WsdlValidator::Error, "Could not find import location from #{import}" unless import['schemaLocation']
+    xsd_url = URI(import['schemaLocation'])
+    xsd_url.user, xsd_url.password = basic_auth unless basic_auth.empty?
+    request = HTTPI::Request.new(xsd_url.to_s)
+    HTTPI.get(request).body
+  end
+
 end

data/wsdl_validator.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.add_dependency 'httpi'
   spec.add_dependency 'nokogiri'
   spec.add_dependency 'wasabi'
 
@@ -30,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'sinatra'
+  spec.add_development_dependency 'sinatra-basic-auth'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: wsdl_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-26 00:00:00.000000000 Z
+date: 2018-08-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-basic-auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Makes verifying a SOAP message against a WSDL easy.
 email:
 - Samuel.Garratt@integrationqa.co.nz