soaspec 0.2.24 → 0.2.25

data/Rakefile

@@ -1,42 +1,50 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rake/clean'
-require 'yard'
-
-ENV['folder'] ||= ''
-ENV['test'] ||= ''
-
-desc 'Run tests'
-RSpec::Core::RakeTask.new(spec: %i[clean clobber start_test_server]) do |t|
-  t.pattern = "spec/**/#{ENV['folder']}*/#{ENV['test']}*_spec.rb"
-end
-
-task :parallel => [:clean, :clobber, :start_test_server] do
-  puts `parallel_rspec spec`
-end
-
-task default: :spec
-
-CLEAN.include 'tmp/*'
-CLOBBER.include 'logs/*'
-
-desc 'Start virtual web service'
-task :start_test_server do
-  ENV['leave_server_running'] = 'true' # This will stop created suites from killing this service
-  mkdir_p 'logs'
-  ENV['test_server_pid'] = Process.spawn('ruby', 'exe/soaspec', 'virtual_server', err: %w[logs/test_server.log w]).to_s
-  sleep 2 # Wait a little for virtual server to start up
-  puts 'Running test server at pid ' + ENV['test_server_pid']
-end
-
-YARD::Rake::YardocTask.new do |t|
-  t.files = %w[features/**/*.feature features/**/*.rb lib/soaspec/cucumber/*.rb] # lib/soaspec/cucumber/*.rb]
-end
-
-desc 'Ensure system has all docs'
-task :must_have_docs do
-  yard = `yard`
-  puts yard
-  percentage = yard.lines.last.strip.split('%').first.to_f
-  raise 'Must be fully documented' unless percentage == 100.00
-end
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rake/clean'
+require 'yard'
+require 'yard/doctest/rake'
+
+ENV['folder'] ||= ''
+ENV['test'] ||= ''
+
+desc 'Run tests'
+RSpec::Core::RakeTask.new(spec: %i[clean clobber start_test_server]) do |t|
+  t.pattern = "spec/**/#{ENV['folder']}*/#{ENV['test']}*_spec.rb"
+end
+
+task :parallel => [:clean, :clobber, :start_test_server] do
+  puts `parallel_rspec spec`
+end
+
+task default: :spec
+
+CLEAN.include 'tmp/*'
+CLOBBER.include 'logs/*'
+
+desc 'Start virtual web service'
+task :start_test_server do
+  ENV['leave_server_running'] = 'true' # This will stop created suites from killing this service
+  mkdir_p 'logs'
+  ENV['test_server_pid'] = Process.spawn('ruby', 'exe/soaspec', 'virtual_server', err: %w[logs/test_server.log w]).to_s
+  sleep 2 # Wait a little for virtual server to start up
+  puts 'Running test server at pid ' + ENV['test_server_pid']
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = %w[features/**/*.feature features/**/*.rb lib/soaspec/cucumber/*.rb] # lib/soaspec/cucumber/*.rb]
+end
+
+desc 'Ensure system has all docs'
+task :must_have_docs do
+  yard = `yard`
+  puts yard
+  percentage = yard.lines.last.strip.split('%').first.to_f
+  raise 'Must be fully documented' unless percentage == 100.00
+end
+
+desc 'Test examples shown in documentation'
+YARD::Doctest::RakeTask.new do |task|
+  task.doctest_opts = %w[-v]
+  # task.pattern = 'lib/**/*.rb'
+  task.pattern = 'lib/soaspec/core_ext/hash.rb'
+end

data/Todo.md

@@ -1,15 +1,15 @@
-* `yard` should show everything documented
-* Rubocop should have 0 offenses
-* Unit tests
-  * OAuth class, etc
-* Get initial `soaspec new` working with TODOs as placeholders for how to get started
-* Request method from within exchange
-  * Use this in tests
-* Basic service generator
-* Give examples and convenience methods for building classes for each SOAP or REST operation
-* Potentially have in built use of 'vcr' and 'http_stub' gems
-* Handle proxies to record traffic for MiddleWare testing
-* soaspec generate
-  * Get wsdl generator working for non complex gems (Put on hold til new Savon version)
-  * Generate from a RAML
-* Much more - please raise an issue for suggestion
+* `yard` should show everything documented
+* Rubocop should have 0 offenses
+* Unit tests
+  * OAuth class, etc
+* Get initial `soaspec new` working with TODOs as placeholders for how to get started
+* Request method from within exchange
+  * Use this in tests
+* Basic service generator
+* Give examples and convenience methods for building classes for each SOAP or REST operation
+* Potentially have in built use of 'vcr' and 'http_stub' gems
+* Handle proxies to record traffic for MiddleWare testing
+* soaspec generate
+  * Get wsdl generator working for non complex gems (Put on hold til new Savon version)
+  * Generate from a RAML
+* Much more - please raise an issue for suggestion

data/exe/soaspec

@@ -1,123 +1,137 @@
-#!/usr/bin/env ruby
-
-require 'thor'
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-require 'savon'
-require 'soaspec'
-require 'soaspec/virtual_server'
-require 'soaspec/wsdl_generator'
-
-module Soaspec
-  # Common executable for Soaspec
-  class Exe < Thor
-    include Soaspec::ExeHelpers
-    include Soaspec::WsdlGenerator
-
-    long_desc <<-LONGDESC
-    `soaspec new` will generate the initial files and folders for starting a testing project using soaspec
-    \x5
-
-    `soaspec new soap` will create example files testing against a SOAP service
-    \x5
-
-    `soaspec new rest` will create example files testing against a REST service
-    LONGDESC
-    desc 'new [type]', 'Initialize soaspec repository'
-    option :ci, default: 'jenkins', banner: 'What Continuous Integration is used'
-    option :virtual, type: :boolean, default: true, banner: 'Whether to set things up for a virtual server'
-    def new(type = 'initial')
-      @virtual = options[:virtual]
-      @type = type
-      puts "Creating files for soaspec. options are #{options}"
-      create_file(filename: 'Gemfile')
-      create_file(filename: 'Rakefile')
-      create_file(filename: '.rspec')
-      create_file(filename: 'README.md')
-      create_file(filename: '.travis.yml') if options[:ci] == 'travis'
-      create_folder 'lib'
-      create_files_for type
-      create_file(filename: 'config/data/default.yml') # Example of data file
-      create_file(filename: 'spec/spec_helper.rb')
-      puts "Run 'bundle install' to install necessary gems"
-      puts "Run 'rake spec' to run the tests"
-    end
-
-    long_desc <<-LONGDESC
-    `soaspec add rest` will generate the initial files and folders for starting a testing project using soaspec
-    \x5
-
-    `soaspec add soap` will create example files testing against a virtual SOAP service
-    \x5
-
-    LONGDESC
-    desc 'add [type] [name]', 'Add new ExchangeHandler'
-    def add(type = 'rest', name = 'TestService')
-      raise "Type '#{type}' is not available" unless %w[rest soap].include? type
-
-      @name = name # Use instance variable for ERB
-      create_file filename: File.join('lib', "#{name.snakecase}.rb"),
-                  content: retrieve_contents(File.join('lib', "new_#{type}_service.rb"))
-    end
-
-    desc 'cucumber', 'Add cucumber generic steps template within step_definitions folder'
-    def cucumber
-      create_file filename: File.join('features', 'step_definitions', 'generic_steps.rb'),
-                  content: retrieve_contents(File.join('../cucumber', 'generic_steps.rb'), false)
-    end
-
-    desc 'generate', 'Generate initial test code from wsdl'
-    long_desc <<-LONGDESC
-    If no wsdl is given a server will be started from which code to generate Exchanges
-
-    `soaspec generate wsdl=wsdl name=ServiceName ` will generate the initial files and folders to test each operation in a wsdl
-    \x5
-    Additionally the auth parameter can be used to use basic authentication to retrieve the WSDL.
-    To do use the following `soaspec generate --auth=basic`
-    Note: This is still a work in progress and will only work for a very simple wsdl
-    LONGDESC
-    option :wsdl, default: nil, aliases: :w
-    option :name, default: 'Service', aliases: :n
-    option :ci, default: 'jenkins', banner: 'What Continuous Integration is used'
-    option :auth
-    option :open_browser, default: 'true'
-    option :string_default, default: 'test string'
-    def generate
-      if options[:wsdl]
-        generate_from_wsdl(options)
-      else
-        require 'launchy'
-        require 'soaspec/generate_server'
-        Soaspec::GenerateServer.run! do
-          Launchy.open 'http://localhost:8999' if options[:open_browser] == 'true'
-        end
-      end
-    end
-
-    long_desc <<-LONGDESC
-    Run virtual web services on localhost. See root for documentation of web services provided.
-    LONGDESC
-    desc 'virtual_server [port]', 'Run virtual web service on localhost'
-    def virtual_server(port = '4999')
-      ENV['port'] = port
-      require 'soaspec/virtual_server'
-      Soaspec::VirtualServer.run!(Port: port)
-    end
-
-    long_desc <<-LONGDESC
-    Run pry with Soaspec and other relevant libraries loaded. Pass either the relative path to files desired with a
-    '.rb' extension or the path to the folder to be loaded with 'require_all'
-    LONGDESC
-    desc 'pry [required_files]', 'Run pry with Soaspec and other relevant libraries loaded'
-    def pry(required_files = nil)
-      require 'soaspec'
-
-      require 'require_all'
-      require_all required_files if required_files
-
-      require 'pry'
-      Pry.start
-    end
-  end
-end
-
-Soaspec::Exe.start(ARGV)
+#!/usr/bin/env ruby
+
+require 'thor'
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'savon'
+require 'soaspec'
+require 'soaspec/virtual_server'
+require 'soaspec/wsdl_generator'
+
+module Soaspec
+  # Common executable for Soaspec
+  class Exe < Thor
+    include Soaspec::ExeHelpers
+    include Soaspec::WsdlGenerator
+
+    long_desc <<-LONGDESC
+    `soaspec new` will generate the initial files and folders for starting a testing project using soaspec
+    \x5
+
+    `soaspec new soap` will create example files testing against a SOAP service
+    \x5
+
+    `soaspec new rest` will create example files testing against a REST service
+    LONGDESC
+    desc 'new [type]', 'Initialize soaspec repository'
+    option :ci, default: 'jenkins', banner: 'What Continuous Integration is used'
+    option :virtual, type: :boolean, default: true, banner: 'Whether to set things up for a virtual server'
+    def new(type = 'initial')
+      @virtual = options[:virtual]
+      @type = type
+      puts "Creating files for soaspec. options are #{options}"
+      create_file(filename: 'Gemfile')
+      create_file(filename: 'Rakefile')
+      create_file(filename: '.rspec')
+      create_file(filename: 'README.md')
+      create_file(filename: '.travis.yml') if options[:ci] == 'travis'
+      create_folder 'lib'
+      create_files_for type
+      create_file(filename: 'config/data/default.yml') # Example of data file
+      create_file(filename: 'spec/spec_helper.rb')
+      puts "Run 'bundle install' to install necessary gems"
+      puts "Run 'rake spec' to run the tests"
+    end
+
+    long_desc <<-LONGDESC
+    `soaspec add rest` will generate the initial files and folders for starting a testing project using soaspec
+    \x5
+
+    `soaspec add soap` will create example files testing against a virtual SOAP service
+    \x5
+
+    LONGDESC
+    desc 'add [type] [name]', 'Add new ExchangeHandler'
+    def add(type = 'rest', name = 'TestService')
+      raise "Type '#{type}' is not available" unless %w[rest soap].include? type
+
+      @name = name # Use instance variable for ERB
+      create_file filename: File.join('lib', "#{name.snakecase}.rb"),
+                  content: retrieve_contents(File.join('lib', "new_#{type}_service.rb"))
+    end
+
+    long_desc <<-LONGDESC
+    `soaspec cucumber` will add generic steps file within step definitions folder. It will also
+    add Gemfile, and other Cucumber setup files if not already added
+    \x5
+
+    LONGDESC
+    desc 'cucumber', 'Add cucumber generic steps template within step_definitions folder'
+    def cucumber
+      @cucumber = true
+      create_file(filename: 'Gemfile', ignore_if_present: true)
+      create_file(filename: 'features/support/env.rb', ignore_if_present: true)
+      create_file filename: File.join('features', 'step_definitions', 'generic_steps.rb'),
+                  content: retrieve_contents(File.join('../cucumber', 'generic_steps.rb'), false)
+    end
+
+    desc 'generate', 'Generate initial test code from wsdl'
+    long_desc <<-LONGDESC
+    If no wsdl is given a server will be started from which code to generate Exchanges
+
+    `soaspec generate wsdl=wsdl name=ServiceName ` will generate the initial files and folders to test each operation in a wsdl
+    \x5
+    Additionally the auth parameter can be used to use basic authentication to retrieve the WSDL.
+    To do use the following `soaspec generate --auth=basic`
+    Note: This is still a work in progress and will only work for a very simple wsdl
+    LONGDESC
+    option :wsdl, default: nil, aliases: :w
+    option :name, default: 'Service', aliases: :n
+    option :ci, default: 'jenkins', banner: 'What Continuous Integration is used'
+    option :auth
+    option :open_browser, default: 'true'
+    option :string_default, default: 'test string'
+    option :port, default: nil, banner: 'What port to run generate server. Default is random'
+    def generate
+      if options[:wsdl]
+        generate_from_wsdl(options)
+      else
+        require 'launchy'
+        require 'soaspec/generate_server'
+        require 'random-port'
+        port = options[:port] || RandomPort::Pool.new.acquire.to_s
+        puts "Using random port '#{port}' for hosting generate server"
+
+        Soaspec::GenerateServer.run!(port: port) do
+          Launchy.open "http://localhost:#{port}" if options[:open_browser] == 'true'
+        end
+      end
+    end
+
+    long_desc <<-LONGDESC
+    Run virtual web services on localhost. See root for documentation of web services provided.
+    LONGDESC
+    desc 'virtual_server [port]', 'Run virtual web service on localhost'
+    def virtual_server(port = '4999')
+      ENV['port'] = port
+      require 'soaspec/virtual_server'
+      Soaspec::VirtualServer.run!(port: port)
+    end
+
+    long_desc <<-LONGDESC
+    Run pry with Soaspec and other relevant libraries loaded. Pass either the relative path to files desired with a
+    '.rb' extension or the path to the folder to be loaded with 'require_all'
+    LONGDESC
+    desc 'pry [required_files]', 'Run pry with Soaspec and other relevant libraries loaded'
+    def pry(required_files = nil)
+      require 'soaspec'
+
+      require 'require_all'
+      require_all required_files if required_files
+
+      require 'pry'
+      Pry.start
+    end
+  end
+end
+
+Soaspec::Exe.start(ARGV)

data/exe/xml_to_yaml_file

@@ -1,42 +1,42 @@
-#!/usr/bin/env ruby
-
-require 'xmlsimple'
-require 'yaml'
-require 'fileutils'
-
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-
-require 'soaspec'
-
-include Soaspec::ExeHelpers
-
-default_output_file = 'output.yml'
-
-# 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| [k.snakecase, convert_hash_keys(v)] }]
-  else
-    value
-  end
-end
-
-# Remove arrays created as another string
-def clean_up_yaml(yaml_string)
-  yaml_string = yaml_string.gsub(/\R+(\s*)-/, '').gsub(/{}/, "''") # Remove arrays, {} -> ''
-  # Insert new line where there are 2 ':' on 1 line. Issue from first gsub
-  yaml_string.gsub(/:(\s)(\w*):/) { |s| s.insert(1, "\n") }
-end
-
-if ARGV[0]
-  warn "Using '#{default_output_file}' as default output file since no 2nd argument passed" unless ARGV[1]
-  hash = XmlSimple.xml_in(ARGV[0])
-  converted = convert_hash_keys hash
-  yaml_file = clean_up_yaml(converted.to_yaml)
-  create_file(filename: ARGV[1] || default_output_file, content: yaml_file)
-else
-  puts 'usage: xml_to_yaml_file [input.xml] [output.yml] '
-end
+#!/usr/bin/env ruby
+
+require 'xmlsimple'
+require 'yaml'
+require 'fileutils'
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'soaspec'
+
+include Soaspec::ExeHelpers
+
+default_output_file = 'output.yml'
+
+# 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| [k.snakecase, convert_hash_keys(v)] }]
+  else
+    value
+  end
+end
+
+# Remove arrays created as another string
+def clean_up_yaml(yaml_string)
+  yaml_string = yaml_string.gsub(/\R+(\s*)-/, '').gsub(/{}/, "''") # Remove arrays, {} -> ''
+  # Insert new line where there are 2 ':' on 1 line. Issue from first gsub
+  yaml_string.gsub(/:(\s)(\w*):/) { |s| s.insert(1, "\n") }
+end
+
+if ARGV[0]
+  warn "Using '#{default_output_file}' as default output file since no 2nd argument passed" unless ARGV[1]
+  hash = XmlSimple.xml_in(ARGV[0])
+  converted = convert_hash_keys hash
+  yaml_file = clean_up_yaml(converted.to_yaml)
+  create_file(filename: ARGV[1] || default_output_file, content: yaml_file)
+else
+  puts 'usage: xml_to_yaml_file [input.xml] [output.yml] '
+end