soaspec 0.0.23 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72616e1074159a6f95e6def516fd54d1b9bae9c2
-  data.tar.gz: c63d9d36c73c36e14dc817ec9f846e01bd0cf3ef
+  metadata.gz: 4aaad0d9e089c5a7a5ed3f22e36ad11f74304065
+  data.tar.gz: 3a6ace44416ff6c6997012171e7d3c6875971ad4
 SHA512:
-  metadata.gz: 6d88345669ab61df3b26d28c3fad0e3ac860693426f348519f17e8e05eb89f1f7343085a81ed41b846251c167ff7a499ae7fbb435e84aaaead3ac4cef867777f
-  data.tar.gz: 7e63562503b905cceb8597d8d06947f774129df9631d0a9a9423e472dc3de174d52e9662c6b3987b2905fb4b1b285f2efcfb232c41d1b7838a4de7639d2d9574
+  metadata.gz: 587fae6e8d6a0d1ba507df5badb2030991302f5958cc0d8db5bfbb732bdb2283641dd5ad1fc59efd1cfba378f134f4d6a1b34a0ebddb7260a5ae0de8db11127d
+  data.tar.gz: 0e3410d331d2d2fe0c5dd46eb666910291672a49e380bc76b5b1fc2eba03c124138e1b3465f66170cda7ea43ed38d2258d6e5b703a92f6cfc2ba397d4315b795

data/ChangeLog

@@ -1,3 +1,9 @@
+Version 0.0.24 / 2018-2-25
+* Enhancements
+  * Added to soaspec-generate more types when creating YAML with data (int, boolean, double and custom enumeration).
+  * Binaries use common module (exe-helper) to reduce repeatability
+* TODO: soaspec-generate read xsd's mentioned to import in WSDL schema
+
 Version 0.0.23 / 2018-2-23
 * Enhancements
   * Created RestHandler class (Very messy and ugly still) to handle REST requests using style used for SOAP using Rest Client resource

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    soaspec (0.0.23)
+    soaspec (0.0.24)
       rest-client (>= 2.0)
       rspec (~> 3.0)
       rspec-its (>= 1.2.0)

data/exe/soaspec-generate

@@ -9,16 +9,40 @@ $LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 require 'savon'
 require 'soaspec'
 
+include Soaspec::ExeHelpers
+
+def try_enum_for(type)
+  custom_type = @wsdl_schemas.xpath("//*[@name='#{type}']")
+  if custom_type.first
+    prefix = custom_type.first.namespace.prefix
+    enumerations = custom_type.xpath("//#{prefix}:enumeration")
+    return 'Custom Type' if enumerations.empty?
+    @enums_values = Array.new
+    enumerations.each do |enum_value|
+      @enums_values << "'#{enum_value['value']}'"
+    end
+    "~randomize [#{@enums_values.join(', ')}]"
+  else
+    'Custom Type'
+  end
+end
+
 def fill_in_field_from_type(type)
   case type
   when 'string'
     'test string'
-    else
-      'test'
+  when 'int'
+    2
+  when 'boolean'
+    true
+  when 'double'
+    '1.5'
+  else
+    try_enum_for type
   end
 end
 
-def self.ask_wsdl
+def ask_wsdl
   prompt = <<-EOF
 Enter WSDL:
   EOF
@@ -27,7 +51,7 @@ Enter WSDL:
   puts
 end
 
-def self.name_of_wsdl
+def name_of_wsdl
   prompt = <<-EOF
 Enter what you would like to name WSDL (CamelCase):
   EOF
@@ -36,6 +60,38 @@ Enter what you would like to name WSDL (CamelCase):
   puts
 end
 
+def authentication_type
+  prompt = <<-EOF
+Authentication
+(1) Basic
+(2) None
+
+Type:
+EOF
+  print prompt.chop
+  num = $stdin.gets.to_i - 1
+  puts
+
+  @auth = [:basic, :none][num] || :none
+
+  if @auth == :basic
+    prompt = <<-EOF
+User Name:
+    EOF
+    print prompt.chop
+    @auth_name = $stdin.gets.strip
+    puts
+
+    prompt = <<-EOF
+User Password:
+    EOF
+    print prompt.chop
+    @auth_password = $stdin.gets.strip
+    puts
+  end
+
+end
+
 def camel_case(underscore_seperated)
   underscore_seperated.to_s.split('_').collect(&:capitalize).join
 end
@@ -48,8 +104,7 @@ end
     # Add to or override default Savon client options
     def savon_options
       {
-        wsdl: '<%= @wsdl %>',
-        convert_request_keys_to: :camelcase # Remove this if request is not in camelcase
+        wsdl: '<%= @wsdl %>'        
       }
     end
 
@@ -62,7 +117,7 @@ require 'spec_helper'
 
 Soaspec::Environment.strip_namespaces = true # This allows namespace not to be used. Be careful with this
 
-<%= operation %> = <%= @name %>.new('<%= camel_case(operation) %>')
+<%= operation %> = <%= @name %>.new(<%= @class_params %>)
 <%= operation %>.operation = :<%= operation %>
 <%= operation %>.default_hash = data_for '<%= operation %>/default'
 
@@ -74,78 +129,48 @@ end
 
 EOF
 
-rake_content = <<-EOF
-# The list of task for a Rake file can be seen with `rake -T`
-require 'rspec/core/rake_task' # See See https://relishapp.com/rspec/rspec-core/docs/command-line/rake-task for details
-
-# This runs `rspec` command with the following options. Type `rake spec` to run this task
-RSpec::Core::RakeTask.new(:spec) do |t, task_args|
-  t.pattern = "spec/*_spec.rb" # Run all specs in 'spec' folder ending in '_spec'
-  # Next line shows output on the screen, Junit xml report and an HTML report
-  t.rspec_opts = "--format documentation --format RspecJunitFormatter --out logs/spec.xml --format html --out logs/spec.html"
-  t.fail_on_error = false
-end
-
-task :default => :spec # This runs the 'spec' task by default when no task is mentioned. E.g., if only `rake` is typed
-EOF
-
-
-gem_content = <<-EOF
-
-source 'https://rubygems.org'
-
-gem 'data_magic'
-gem 'require_all'
-gem 'rspec_junit_formatter'
-gem 'rake'
-gem 'soaspec'
-
-EOF
-
-spec_helper_content = <<-EOF
-
-require 'soaspec'
-require 'require_all'
-require_all 'lib'
-require 'data_magic'
-
-include DataMagic # Used as example of loading data smartly. Use 'data_for' method to load yml data
-
-RSpec.configure do |config|
-  # This will make backtrace much shorter by removing many lines from rspec failure message
-  config.backtrace_exclusion_patterns = [
-    /rspec/
-  ]
-end
-
-EOF
-
 name_of_wsdl
 ask_wsdl
 
-wsdl_doc = Savon.client(wsdl: @wsdl).wsdl
+authentication_type
 
-  # Basics. May already be there
-Soaspec::FileHelpers.create_file filename: 'Rakefile', content: rake_content, ignore_if_present: true
-Soaspec::FileHelpers.create_file filename: 'Gemfile', content: gem_content, ignore_if_present: true
-Soaspec::FileHelpers.create_folder 'spec'
-Soaspec::FileHelpers.create_file(filename: 'spec/spec_helper.rb', content: spec_helper_content)
+savon_options = { wsdl: @wsdl }
+savon_options[:basic_auth] = [@auth_name, @auth_password] if @auth == :basic
 
-module Soaspec::FileHelpers
-  create_folder 'logs'
-  create_folder 'config'
-  create_folder 'config/data'
-  create_folder 'lib'
-end
-Soaspec::FileHelpers.create_file filename: "lib/#{@name}.rb", content: ERB.new(@class_content).result(binding)
+@wsdl_doc = Savon.client(**savon_options).wsdl
+@wsdl_schemas = @wsdl_doc.parser.schemas
+
+# Basic files. May already be there
+create_file filename: 'Rakefile', content: rake_content, ignore_if_present: true
+create_file filename: 'Gemfile', content: gem_content, ignore_if_present: true
+create_folder 'spec'
+create_file filename: 'spec/spec_helper.rb', content: spec_helper_content
 
-wsdl_doc.operations.each do |operation, details|
+create_folder 'logs'
+create_folder 'config'
+create_folder 'config/data'
+create_folder 'lib'
+create_file filename: "lib/#{@name}.rb", content: ERB.new(@class_content).result(binding)
+# Files according to WSDL
+@wsdl_doc.operations.each do |operation, details|
   puts "Creating files for operation: #{operation}"
   @content = "default:\n"
-  details[:parameters].each do |element, details|
-    @content += "  #{element.to_s}: #{fill_in_field_from_type(details[:type])} \n"
+  @use_camel_case = false
+  puts 'Message params: ' + details.to_s
+  # From namespace identifier, find namespace, and for that find schemaLocation xsd and use that to build request
+  if details[:parameters]
+    details[:parameters].each do |element, details|
+      @use_camel_case = true if (/[[:upper:]]/.match(element.to_s[0]) != nil)
+      @content += "  #{underscore_key element}: #{fill_in_field_from_type(details[:type])} # #{details[:type]} \n"
+      # TODO: If details is a Hash need to loop again
+    end
   end
 
-  Soaspec::FileHelpers.create_file(filename: "config/data/#{operation}.yml", content: @content)
-  Soaspec::FileHelpers.create_file(filename: "spec/#{operation}_spec.rb", content: ERB.new(@soap_spec_content).result(binding))
+  params = []
+  params << 'convert_request_keys_to: :camelcase' if @use_camel_case
+  params_string = params == [] ? '' : ', ' + params.join(', ')
+  @class_params = "'#{camel_case(operation)}'#{params_string}"
+
+  create_file(filename: "config/data/#{operation}.yml", content: @content)
+  create_file(filename: "spec/#{operation}_spec.rb", content: ERB.new(@soap_spec_content).result(binding))
 end

data/exe/soaspec-init

@@ -1,36 +1,11 @@
 #!/usr/bin/env ruby
 
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'savon'
 require 'soaspec'
-require 'fileutils'
-
-def create_file(options)
-  filename = options[:filename]
-  raise 'Need to pass filename' unless filename
-  content = options[:content]
-  raise 'Need to pass contents to insert into file' unless content
-  if File.exist? filename
-    old_content = File.read(filename)
-    if old_content != content
-      warn "!! #{filename} already exists and differs from template"
-    end
-  else
-    File.open(filename, 'w') do |f|
-      f.puts content
-    end
-    puts 'Created: ' + filename
-  end
-end
 
-def create_folder(folder)
-  if File.exists? folder
-    unless File.directory? folder
-      $stderr.puts "!! #{folder} already exists and is not a directory"
-    end
-  else
-    FileUtils.mkdir folder
-    puts "Created folder: #{folder}/"
-  end
-end
+include Soaspec::ExeHelpers
 
 puts 'Creating files for soaspec'
 
@@ -46,40 +21,6 @@ gem 'soaspec'
 
 EOF
 
-rake_content = <<-EOF
-# The list of task for a Rake file can be seen with `rake -T`
-require 'rspec/core/rake_task' # See See https://relishapp.com/rspec/rspec-core/docs/command-line/rake-task for details
-
-# This runs `rspec` command with the following options. Type `rake spec` to run this task
-RSpec::Core::RakeTask.new(:spec) do |t, task_args|
-  t.pattern = "spec/*_spec.rb" # Run all specs in 'spec' folder ending in '_spec'
-  # Next line shows output on the screen, Junit xml report and an HTML report
-  t.rspec_opts = "--format documentation --format RspecJunitFormatter --out logs/spec.xml --format html --out logs/spec.html"
-  t.fail_on_error = false
-end
-
-task :default => :spec # This runs the 'spec' task by default when no task is mentioned. E.g., if only `rake` is typed
-EOF
-
-
-spec_helper_content = <<-EOF
-
-require 'soaspec'
-require 'require_all'
-require_all 'lib'
-require 'data_magic'
-
-include DataMagic # Used as example of loading data smartly. Use 'data_for' method to load yml data
-
-RSpec.configure do |config|
-  # This will make backtrace much shorter by removing many lines from rspec failure message
-  config.backtrace_exclusion_patterns = [
-    /rspec/
-  ]
-end
-
-EOF
-
 weather_web_service = <<-EOF
 
 require 'soaspec'

data/exe/xml_to_yaml_file

@@ -4,6 +4,12 @@ require 'xmlsimple'
 require 'yaml'
 require 'fileutils'
 
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'soaspec'
+
+include Soaspec::ExeHelpers
+
 default_output_file = 'output.yml'
 
 # Create file if not present. If present but different give warning
@@ -25,25 +31,15 @@ def create_file(options)
   end
 end
 
-# Convert key in camelcase to underscore separated (snakecase)
-def underscore_key(key)
-  key.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-    .gsub(/([a-z\d])([A-Z])/,'\1_\2')
-    .tr('-', '_')
-    .gsub(/\s/, '_')
-    .gsub(/__+/, '_')
-    .downcase
-end
-
 # For all keys in a Hash, convert Camelcase to underscore separated
 def convert_hash_keys(value)
   case value
-    when Array
-      value.map { |v| convert_hash_keys(v) }
-    when Hash
-      Hash[value.map { |k, v| [underscore_key(k), convert_hash_keys(v)] }]
-    else
-      value
+  when Array
+    value.map { |v| convert_hash_keys(v) }
+  when Hash
+    Hash[value.map { |k, v| [underscore_key(k), convert_hash_keys(v)] }]
+  else
+    value
   end
 end
 

data/lib/soaspec.rb

@@ -15,9 +15,10 @@ require 'soaspec/matchers'
 require 'soaspec/soaspec_shared_examples'
 require 'soaspec/hash_methods'
 require 'soaspec/spec_logger'
-require 'soaspec/file_helpers'
+require 'soaspec/exe_helpers'
 require 'soaspec/rest_handler'
 
+
 # Gem for handling SOAP and REST api tests
 module Soaspec
 

data/lib/soaspec/exe_helpers.rb

@@ -0,0 +1,97 @@
+
+module Soaspec
+  # Help with tasks common to soaspec executables
+  module ExeHelpers
+    require 'fileutils'
+
+    # @param [String] filename Name of the file to create
+    # @param [String] content Content to place inside file
+    def create_file(filename: nil, content: nil, ignore_if_present: false)
+      #filename = options[:filename]
+      raise 'Need to pass filename' unless filename
+      #content = options[:content]
+      raise 'Need to pass contents to insert into file' unless content
+      if File.exist? filename
+        old_content = File.read(filename)
+        if old_content != content && !ignore_if_present
+          warn "!! #{filename} already exists and differs from template"
+        end
+      else
+        File.open(filename, 'w') { |f| f.puts content }
+        puts 'Created: ' + filename
+      end
+    end
+
+    def create_folder(folder)
+      if File.exist? folder
+        unless File.directory? folder
+          warn "!! #{folder} already exists and is not a directory"
+        end
+      else
+        FileUtils.mkdir folder
+        puts "Created folder: #{folder}/"
+      end
+    end
+
+    def rake_content
+      <<-EOF
+# The list of task for a Rake file can be seen with `rake -T`
+require 'rspec/core/rake_task' # See See https://relishapp.com/rspec/rspec-core/docs/command-line/rake-task for details
+
+# This runs `rspec` command with the following options. Type `rake spec` to run this task
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/*_spec.rb" # Run all specs in 'spec' folder ending in '_spec'
+  # Next line shows output on the screen, Junit xml report and an HTML report
+  t.rspec_opts = "--format documentation --format RspecJunitFormatter --out logs/spec.xml --format html --out logs/spec.html"
+  t.fail_on_error = false
+end
+
+task :default => :spec # This runs the 'spec' task by default when no task is mentioned. E.g., if only `rake` is typed
+    EOF
+    end
+
+    def gem_content
+      <<-EOF
+source 'https://rubygems.org'
+
+gem 'data_magic'
+gem 'require_all'
+gem 'rspec_junit_formatter'
+gem 'rake'
+gem 'soaspec'
+
+    EOF
+    end
+
+    def spec_helper_content
+    <<-EOF
+
+require 'soaspec'
+require 'require_all'
+require_all 'lib'
+require 'data_magic'
+
+include DataMagic # Used as example of loading data smartly. Use 'data_for' method to load yml data
+
+RSpec.configure do |config|
+  # This will make backtrace much shorter by removing many lines from rspec failure message
+  config.backtrace_exclusion_patterns = [
+    /rspec/
+  ]
+end
+
+    EOF
+    end
+
+    # Convert key in camelcase to underscore separated (snakecase)
+    def underscore_key(key)
+      key.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+         .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+         .tr('-', '_')
+         .gsub(/\s/, '_')
+         .gsub(/__+/, '_')
+         .downcase
+    end
+
+  end
+end

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.0.23'
+  VERSION = '0.0.24'
 end

data/test_wsdl.rb

@@ -3,22 +3,42 @@ require 'wasabi'
 require 'savon'
 
 
-document = Savon.client(wsdl: 'test.wsdl').wsdl
+#document = Savon.client(wsdl: 'test.wsdl').wsdl
 #document = Savon.client(wsdl: 'http://www.webservicex.com/globalweather.asmx?wsdl').wsdl
 #document = Wasabi.document File.read('test.wsdl')
+document = Wasabi.document 'http://www.webservicex.net/ConvertTemperature.asmx?WSDL'
 parser = document.parser
 
 
-
-parser.schemas.each do |schema|
-  puts 'SCHEMA * '
-  puts schema
-
-  xsd = Nokogiri::XML::Schema(schema.to_s)
-
-  doc = Nokogiri::XML(File.read('test.xml'))
-
-  xsd.validate(doc).each do |error|
-    puts error.message
+# TEST SCHEMA
+#
+# parser.schemas.each do |schema|
+#   puts 'SCHEMA * '
+#   puts schema
+#
+#   xsd = Nokogiri::XML::Schema(schema.to_s)
+#
+#   doc = Nokogiri::XML(File.read('test.xml'))
+#
+#   xsd.validate(doc).each do |error|
+#     puts error.message
+#   end
+# end
+#
+
+schemes = parser.schemas
+puts schemes
+custom_type = schemes.xpath("//*[@name='TemperatureUnit']")
+if custom_type.first
+  puts 'CUST' + custom_type.to_s
+  prefix = custom_type.first.namespace.prefix
+  puts prefix
+
+  enumerations = custom_type.xpath("//#{prefix}:enumeration")
+
+  puts 'ENUM' + enumerations.to_s
+
+  enumerations.each do |enum_value|
+    puts enum_value['value']
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.0.24
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-23 00:00:00.000000000 Z
+date: 2018-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -153,7 +153,7 @@ files:
 - lib/soaspec.rb
 - lib/soaspec/basic_soap_handler.rb
 - lib/soaspec/exchange.rb
-- lib/soaspec/file_helpers.rb
+- lib/soaspec/exe_helpers.rb
 - lib/soaspec/hash_methods.rb
 - lib/soaspec/matchers.rb
 - lib/soaspec/rest_handler.rb

data/lib/soaspec/file_helpers.rb

@@ -1,35 +0,0 @@
-
-module Soaspec
-  module FileHelpers
-    require 'fileutils'
-
-    def self.create_file(options)
-      filename = options[:filename]
-      raise 'Need to pass filename' unless filename
-      content = options[:content]
-      raise 'Need to pass contents to insert into file' unless content
-      if File.exist? filename
-        old_content = File.read(filename)
-        if old_content != content && !options[:ignore_if_present]
-          warn "!! #{filename} already exists and differs from template"
-        end
-      else
-        File.open(filename, 'w') do |f|
-          f.puts content
-        end
-        puts 'Created: ' + filename
-      end
-    end
-
-    def self.create_folder(folder)
-      if File.exists? folder
-        unless File.directory? folder
-          $stderr.puts "!! #{folder} already exists and is not a directory"
-        end
-      else
-        FileUtils.mkdir folder
-        puts "Created folder: #{folder}/"
-      end
-    end
-  end
-end