wash_away_the_soap 0.1.0

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+gem "nokogiri"
+
+group :test do
+	gem "rspec", :require => "spec"
+end
+

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Michael Schubert <michael@schubert.cx>
+
+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,16 @@
+Wash Away The Soap
+=============
+
+WashAwayTheSoap parses WSDL and XSD files and attempts to
+pretty-print the service structure so you can make sense
+of a legacy (or just poorly written) system.
+
+Usage
+-------------
+
+    $ wash_away_the_soap *.wsdl *.xsd
+
+License
+-------------
+
+See the LICENSE file

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--color']
+end
+
+desc "Build gem from gemspec"
+task :build do
+  sh "gem build wash_away_the_soap.gemspec"
+end
+
+task :default => :spec

data/bin/wash_away_the_soap

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "wash_away_the_soap"))
+
+WashAwayTheSoap.parse

data/lib/wash_away_the_soap.rb

@@ -0,0 +1,97 @@
+require "rubygems"
+require "bundler/setup"
+require "nokogiri"
+
+class WashAwayTheSoap
+  attr_accessor :wsdls, :xsds, :wsdl_operations, :xsd_objects
+  
+  class << self
+    def parse
+      self.new.parse
+    end
+  end
+  
+  def initialize
+    @wsdl_operations = []
+    @xsd_objects = {}
+    @wsdls = []
+    @xsds = []
+  end
+  
+  def parse
+    ARGV.each do |argv|
+      @wsdls << argv if argv =~ /.wsdl$/
+      @xsds << argv if argv =~ /.xsd$/
+    end
+    wsdls.flatten!
+    xsds.flatten!
+    wsdls.each { |wsdl_file| parse_wsdl(File.read(wsdl_file), wsdl_file) }
+    xsds.each { |xsd_file| parse_xsd(File.read(xsd_file), xsd_file) }
+    build_results
+    print_results
+  end
+  
+  def parse_wsdl(wsdl, filename = nil)
+    doc = Nokogiri::XML(wsdl)
+    doc.xpath("//wsdl:operation", doc.root.namespaces).each do |operation|
+      wsdl_operations << operation.attributes["name"].value
+    end
+  rescue => e
+    puts "Error parsing wsdl file #{filename}"
+  end
+  
+  def parse_xsd(xsd, filename = nil)
+    doc = Nokogiri::XML(xsd)
+    doc.xpath("//xs:sequence//xs:element", doc.root.namespaces).each do |field|
+      operation = field.parent.parent.parent.attributes["name"]
+      unless operation.nil?
+        next unless operation.value
+        next unless field.attributes["name"]
+        operation_name = operation.value
+        field_name = field.attributes["name"].value
+        field_type, allow_blank, required = "unknown", false, false
+        field_type = field.attributes["type"].value.gsub(/^xs:/, "") if field.attributes["type"]
+        allow_blank = (field.attributes["nillable"].value ? true : false) if field.attributes["nillable"]
+        required = (field.attributes["minOccurs"].value.to_i > 0 ? true : false) if field.attributes["minOccurs"]
+        xsd_objects[operation_name] ||= {}
+        xsd_objects[operation_name][field_name] ||= {"type" => field_type, "allow_blank" => allow_blank, "required" => required}
+      end
+    end
+  rescue => e
+    puts "Error parsing xsd file #{filename}\nReason: #{e.to_s}, #{e.backtrace}"
+    exit 1
+  end
+  
+  def build_results
+    output = []
+    longest_field_name = 0
+    wsdl_operations.each do |operation|
+      if xsd_objects[operation]
+        xsd_objects[operation].each do |field, values|
+          longest_field_name = field.length if field.length > longest_field_name
+        end
+      end
+    end
+
+    wsdl_operations.each do |operation|
+      output << operation
+      if xsd_objects[operation]
+        xsd_objects[operation].each do |field, values|
+          field_options = []
+          field_options << values["type"]
+          field_options << "required" if values["required"]
+          field_options << "no_blanks" unless values["allow_blank"]
+          output << " #{field.rjust(longest_field_name)}: #{field_options.join(', ')}"
+        end
+      else
+        output << " - no fields found?"
+      end
+    end
+    output.join("\n") + "\n"
+  end
+  
+  def print_results
+    puts build_results
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "wash_away_the_soap"))
+require "rspec"

data/spec/wash_away_the_soap_spec.rb

@@ -0,0 +1,122 @@
+require "spec_helper"
+
+describe WashAwayTheSoap do
+
+  describe "#parse_wsdl" do
+    
+    before do
+      @wsdl_doc = <<-XML
+      <?xml version="1.0" encoding="utf-8"?>
+      <wsdl:definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
+          xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
+          name="Sample" targetNamespace="http://tempuri.org/">
+        <wsdl:binding>
+          <wsdl:operation name="OperationFoo">
+            <soap:operation soapAction="http://tempuri.org/SomeService/OperationFoo" style="document" />
+            <wsdl:input>
+              <soap:body use="literal" />
+            </wsdl:input>
+            <wsdl:output>
+              <soap:body use="literal" />
+            </wsdl:output>
+          </wsdl:operation>
+        </wsdl:binding>
+      </wsdl:definitions>
+      XML
+      subject.parse_wsdl(@wsdl_doc)
+    end
+    
+    it "records the operations it finds" do
+      subject.wsdl_operations.should include("OperationFoo")
+    end
+    
+  end
+  
+  describe "#parse_xsd" do
+    before do
+      @xsd_doc = <<-XML
+      <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+        <xs:element name="OperationFoo">
+          <xs:complexType>
+            <xs:sequence>
+              <xs:element minOccurs="0" name="UnrequiredNumberField" type="xs:decimal" />
+              <xs:element minOccurs="1" name="RequiredDateField" type="xs:dateTime" />
+              <xs:element minOccurs="0" name="NillableStringField" nillable="true" ype="xs:string" />
+            </xs:sequence>
+          </xs:complexType>
+        </xs:element>
+        <xs:element name="ignoredElement" nillable="true" type="xs:anyType" />
+        <xs:simpleType name="ignoredSimpleType">
+          <xs:restriction base="xs:int" />
+        </xs:simpleType>
+      </xs:schema>
+      XML
+      subject.parse_xsd(@xsd_doc)
+    end
+    
+    it "records the fields for a given object type" do
+      subject.xsd_objects["OperationFoo"].keys.should =~ ["UnrequiredNumberField", "RequiredDateField", "NillableStringField"]
+    end
+    
+    it "records the data type of a given field" do
+      subject.xsd_objects["OperationFoo"]["UnrequiredNumberField"]["type"].should == "decimal"
+    end
+    
+    it "records whether or not a field is required" do
+      subject.xsd_objects["OperationFoo"]["UnrequiredNumberField"]["required"].should be_false
+      subject.xsd_objects["OperationFoo"]["RequiredDateField"]["required"].should be_true
+      subject.xsd_objects["OperationFoo"]["NillableStringField"]["required"].should be_false
+    end
+    
+    it "records whether or not a field can be nil if it is provided" do
+      subject.xsd_objects["OperationFoo"]["UnrequiredNumberField"]["allow_blank"].should be_false
+      subject.xsd_objects["OperationFoo"]["RequiredDateField"]["allow_blank"].should be_false
+      subject.xsd_objects["OperationFoo"]["NillableStringField"]["allow_blank"].should be_true
+    end
+    
+  end
+  describe "#build_results" do
+    before do
+      @wsdl_doc = <<-XML
+      <wsdl:definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
+        <wsdl:binding>
+          <wsdl:operation name="OperationFoo">
+            <soap:operation soapAction="http://tempuri.org/SomeService/OperationFoo" style="document" />
+            <wsdl:input>
+              <soap:body use="literal" />
+            </wsdl:input>
+            <wsdl:output>
+              <soap:body use="literal" />
+            </wsdl:output>
+          </wsdl:operation>
+        </wsdl:binding>
+      </wsdl:definitions>
+      XML
+      subject.parse_wsdl(@wsdl_doc)
+      @xsd_doc = <<-XML
+      <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+        <xs:element name="OperationFoo">
+          <xs:complexType>
+            <xs:sequence>
+              <xs:element minOccurs="0" name="UnrequiredNumberField" type="xs:decimal" />
+              <xs:element minOccurs="1" name="RequiredDateField" type="xs:dateTime" />
+              <xs:element minOccurs="0" name="NillableStringField" nillable="true" type="xs:string" />
+            </xs:sequence>
+          </xs:complexType>
+        </xs:element>
+      </xs:schema>
+      XML
+      subject.parse_xsd(@xsd_doc)
+    end
+
+    it "outputs a wsdl web service, it's required fields and their details" do
+      subject.build_results.should == <<-EOS
+OperationFoo
+ UnrequiredNumberField: decimal, no_blanks
+     RequiredDateField: dateTime, required, no_blanks
+   NillableStringField: string
+      EOS
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: wash_away_the_soap
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Schubert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-07 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id003
+description: "    WashAwayTheSoap parses WSDL and XSD files and attempts to\n    pretty-print the service structure so you can make sense\n    of a legacy (or just poorly written) system.\n"
+email: 
+- michael@schubert.cx
+executables: 
+- wash_away_the_soap
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- lib/wash_away_the_soap.rb
+- bin/wash_away_the_soap
+- Gemfile
+- LICENSE
+- Rakefile
+- README.md
+- spec/spec_helper.rb
+- spec/wash_away_the_soap_spec.rb
+has_rdoc: true
+homepage: https://github.com/schubert/wash_away_the_soap
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: wash_away_the_soap
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Parse WSDL/XSD files for clues how to implement or talk to services
+test_files: []
+