soaspec 0.1.0 → 0.1.1

data/lib/soaspec/exe_helpers.rb

@@ -1,57 +1,57 @@
-
-require 'fileutils'
-module Soaspec
-  # Help with tasks common to soaspec executables
-  module ExeHelpers
-
-    # Spec task string depending upon whether virtual is used
-    def spec_task
-      task_name = options[:virtual] ? 'spec: :start_test_server' : ':spec'
-      "RSpec::Core::RakeTask.new(#{task_name}) do |t|"
-    end
-
-    # Retrieve default file contents based on filename
-    def retrieve_contents(filename, erb)
-      default_file = File.join(File.dirname(__FILE__), 'generator', filename + (erb ? '.erb' : ''))
-      contents = File.read(default_file)
-      erb ? ERB.new(contents).result(binding) : contents
-    end
-
-    # @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, erb: true)
-      raise 'Need to pass filename' unless filename
-      content ||= retrieve_contents(filename, erb)
-      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
-        warn "!! #{folder} already exists and is not a directory" unless File.directory? folder
-      else
-        FileUtils.mkdir folder
-        puts "Created folder: #{folder}/"
-      end
-    end
-
-    # Create class representing wsdl in general
-    def class_content
-      ERB.new(File.read(File.join(File.dirname(__FILE__), 'generator', 'lib/dynamic_class_content.rb.erb'))).result(binding)
-    end
-
-    # Create a spec for an WSDL operation
-    # @param [String] operation Used in ERB to create a test for a WSDL operation
-    def generated_soap_spec_for(operation)
-      ERB.new(File.read(File.join(File.dirname(__FILE__), 'generator', 'spec/dynamic_soap_spec.rb.erb'))).result(binding)
-    end
-
-  end
+
+require 'fileutils'
+module Soaspec
+  # Help with tasks common to soaspec executables
+  module ExeHelpers
+
+    # Spec task string depending upon whether virtual is used
+    def spec_task
+      task_name = options[:virtual] ? 'spec: :start_test_server' : ':spec'
+      "RSpec::Core::RakeTask.new(#{task_name}) do |t|"
+    end
+
+    # Retrieve default file contents based on filename
+    def retrieve_contents(filename, erb)
+      default_file = File.join(File.dirname(__FILE__), 'generator', filename + (erb ? '.erb' : ''))
+      contents = File.read(default_file)
+      erb ? ERB.new(contents).result(binding) : contents
+    end
+
+    # @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, erb: true)
+      raise 'Need to pass filename' unless filename
+      content ||= retrieve_contents(filename, erb)
+      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
+        warn "!! #{folder} already exists and is not a directory" unless File.directory? folder
+      else
+        FileUtils.mkdir folder
+        puts "Created folder: #{folder}/"
+      end
+    end
+
+    # Create class representing wsdl in general
+    def class_content
+      ERB.new(File.read(File.join(File.dirname(__FILE__), 'generator', 'lib/dynamic_class_content.rb.erb'))).result(binding)
+    end
+
+    # Create a spec for an WSDL operation
+    # @param [String] operation Used in ERB to create a test for a WSDL operation
+    def generated_soap_spec_for(operation)
+      ERB.new(File.read(File.join(File.dirname(__FILE__), 'generator', 'spec/dynamic_soap_spec.rb.erb'))).result(binding)
+    end
+
+  end
 end

data/lib/soaspec/generator/.rspec.erb

@@ -1,5 +1,5 @@
---require spec_helper
---format documentation
-<%= '--format RspecJunitFormatter --out logs/spec.xml' if options[:ci] == 'jenkins' %>
---format html --out logs/spec.html
---color
+--require spec_helper
+--format documentation
+<%= '--format RspecJunitFormatter --out logs/spec.xml' if options[:ci] == 'jenkins' %>
+--format html --out logs/spec.html
+--color

data/lib/soaspec/generator/.travis.yml.erb

@@ -1,5 +1,5 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.4
-before_install: gem install bundler -v 1.16.0
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.16.0

data/lib/soaspec/generator/Gemfile.erb

@@ -1,8 +1,8 @@
-
-source 'https://rubygems.org'
-
-gem 'data_magic'
-gem 'require_all'
-gem 'rake'
-<%= "gem 'rspec_junit_formatter'" if options[:ci] == 'jenkins' %>
-gem 'soaspec'
+
+source 'https://rubygems.org'
+
+gem 'data_magic'
+gem 'require_all'
+gem 'rake'
+<%= "gem 'rspec_junit_formatter'" if options[:ci] == 'jenkins' %>
+gem 'soaspec'

data/lib/soaspec/generator/README.md.erb

@@ -1,29 +1,29 @@
-
-# Installation
-
-Run `bundle install` to install the gems mentioned in the Gemfile.
-
-To avoid conflict with gems on the machine globally it may be better to specify gem location with:
-
-`bundle install --path ~/.gem`
-
-# Running tests
-On the command line type:
-`bundle exec rake spec` or simply `bundle exec rake`
-
-# Structure
-
-## Tests
-RSpec tests are within the `spec` folder and end in `_spec`. Setup and teardown for tests is in `spec/spec_helper`
-
-## Templates
-These are the base requests with ERB inside them to create smartly changing requests accoring to the test.yml
-
-## Data
-Data used in the test is stored in `config/data` folder. The `data_magic` gem is used by default to read files here.
-
-## Libraries
-Libaries to be installed are in 'Gemfile'. Specific gem versions can be specified here and enforeced with `bundle exec rake`
-
-## Reports
-Reports are shown in the 'logs' folder. By default Rake produces a junit, an html report, and a `traffic.log` file with the API request and responses in it
+
+# Installation
+
+Run `bundle install` to install the gems mentioned in the Gemfile.
+
+To avoid conflict with gems on the machine globally it may be better to specify gem location with:
+
+`bundle install --path ~/.gem`
+
+# Running tests
+On the command line type:
+`bundle exec rake spec` or simply `bundle exec rake`
+
+# Structure
+
+## Tests
+RSpec tests are within the `spec` folder and end in `_spec`. Setup and teardown for tests is in `spec/spec_helper`
+
+## Templates
+These are the base requests with ERB inside them to create smartly changing requests accoring to the test.yml
+
+## Data
+Data used in the test is stored in `config/data` folder. The `data_magic` gem is used by default to read files here.
+
+## Libraries
+Libaries to be installed are in 'Gemfile'. Specific gem versions can be specified here and enforeced with `bundle exec rake`
+
+## Reports
+Reports are shown in the 'logs' folder. By default Rake produces a junit, an html report, and a `traffic.log` file with the API request and responses in it

data/lib/soaspec/generator/Rakefile.erb

@@ -1,20 +1,20 @@
-
-# The list of task for a Rake file can be seen with `rake -T`
-require 'rspec/core/rake_task' # 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
-<%= spec_task %>
-  t.pattern = "spec/*_spec.rb" # Run all specs in 'spec' folder ending in '_spec'
-  <%= 't.fail_on_error = false' if options[:ci] == 'jenkins' %>
-end
-
-task default: :spec # This runs the 'spec' task by default when no task is mentioned. E.g., if only `rake` is typed
-
-<% if @virtual %>
-desc 'Start virtual web service'
-task :start_test_server do
-  ENV['test_server_pid'] = Process.spawn('soaspec-virtual-server', err: %w[logs/test_server.log w]).to_s
-  puts 'Running test server at pid ' + ENV['test_server_pid']
-  sleep 0.5 # Wait a little for virtual server to start up
-end
+
+# The list of task for a Rake file can be seen with `rake -T`
+require 'rspec/core/rake_task' # 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
+<%= spec_task %>
+  t.pattern = "spec/*_spec.rb" # Run all specs in 'spec' folder ending in '_spec'
+  <%= 't.fail_on_error = false' if options[:ci] == 'jenkins' %>
+end
+
+task default: :spec # This runs the 'spec' task by default when no task is mentioned. E.g., if only `rake` is typed
+
+<% if @virtual %>
+desc 'Start virtual web service'
+task :start_test_server do
+  ENV['test_server_pid'] = Process.spawn('soaspec-virtual-server', err: %w[logs/test_server.log w]).to_s
+  puts 'Running test server at pid ' + ENV['test_server_pid']
+  sleep 0.5 # Wait a little for virtual server to start up
+end
 <% end %>

data/lib/soaspec/generator/config/data/default.yml.erb

@@ -1,2 +1,2 @@
-small_id:
+small_id:
   blz: 100

data/lib/soaspec/generator/lib/blz_service.rb.erb

@@ -1,26 +1,26 @@
-
-require 'soaspec'
-
-# This class is not part of the gem. It's an example of a class you can make
-# to describe your APIs. Usually this would exist in the 'lib' directory
-# Common configuration for the Savon client should go here
-class BLZService < Soaspec::SoapHandler
-  # Add to or override default Savon client options
-  def savon_options
-    {
-      wsdl: 'http://localhost:4999/BLZService?wsdl'
-    }
-  end
-
-  strip_namespaces true # This allows namespace not to be used. Be careful with this
-
-  # # Specifying that get_weather_result must be present in the SOAP response
-  mandatory_elements [:plz]
-
-  # Example of xpath value that must be true for all success scenarios
-  mandatory_xpath_values 'ns1:bezeichnung' => 'Deutsche Bank'
-
-  # Example of setting an attribute on the root XML element
-  root_attributes 'Version' => '1'
-
-end
+
+require 'soaspec'
+
+# This class is not part of the gem. It's an example of a class you can make
+# to describe your APIs. Usually this would exist in the 'lib' directory
+# Common configuration for the Savon client should go here
+class BLZService < Soaspec::SoapHandler
+  # Add to or override default Savon client options
+  def savon_options
+    {
+      wsdl: 'http://localhost:4999/BLZService?wsdl'
+    }
+  end
+
+  strip_namespaces true # This allows namespace not to be used. Be careful with this
+
+  # # Specifying that get_weather_result must be present in the SOAP response
+  mandatory_elements [:plz]
+
+  # Example of xpath value that must be true for all success scenarios
+  mandatory_xpath_values 'ns1:bezeichnung' => 'Deutsche Bank'
+
+  # Example of setting an attribute on the root XML element
+  root_attributes 'Version' => '1'
+
+end

data/lib/soaspec/generator/lib/dynamic_class_content.rb.erb

@@ -1,12 +1,12 @@
-
-require 'soaspec'
-
-class <%= options[:name] %> < Soaspec::SoapHandler
-  # Add to or override default Savon client options
-  def savon_options
-    {
-        wsdl: '<%= options[:wsdl] %>'
-    }
-  end
-
-end
+
+require 'soaspec'
+
+class <%= options[:name] %> < Soaspec::SoapHandler
+  # Add to or override default Savon client options
+  def savon_options
+    {
+        wsdl: '<%= options[:wsdl] %>'
+    }
+  end
+
+end

data/lib/soaspec/generator/lib/shared_example.rb.erb

@@ -1,8 +1,8 @@
-
-require 'rspec'
-
-shared_examples_for 'error scenario' do
-  it 'does not have status code of 200' do
-    expect(described_class.status_code).not_to eq 200
-  end
-end
+
+require 'rspec'
+
+shared_examples_for 'error scenario' do
+  it 'does not have status code of 200' do
+    expect(described_class.status_code).not_to eq 200
+  end
+end

data/lib/soaspec/generator/spec/dynamic_soap_spec.rb.erb

@@ -1,12 +1,12 @@
-
-require 'spec_helper'
-
-<%= operation %> = <%= options[:name] %>.new(<%= @class_params %>)
-<%= operation %>.operation = :<%= operation %>
-<%= operation %>.default_hash = data_for '<%= operation %>/default'
-
-context <%= operation %> do
-  describe Exchange.new(:default) do
-    it_behaves_like 'success scenario'
-  end
-end
+
+require 'spec_helper'
+
+<%= operation %> = <%= options[:name] %>.new(<%= @class_params %>)
+<%= operation %>.operation = :<%= operation %>
+<%= operation %>.default_hash = data_for '<%= operation %>/default'
+
+context <%= operation %> do
+  describe Exchange.new(:default) do
+    it_behaves_like 'success scenario'
+  end
+end

data/lib/soaspec/generator/spec/soap_spec.rb.erb

@@ -1,51 +1,51 @@
-
-require 'spec_helper'
-
-id = '70070010'
-# BLZService.new(template_name: 'soap_template') Use this instead of default_hash to use template approach
-
-context 'Test Examples' do
-  context BLZService.new('Get Bank', operation: :get_bank, default_hash: { blz: id }) do
-
-    describe Exchange.new(:default) do
-      it { is_expected.to contain_value id }
-      it { is_expected.to include_in_body id }
-      it_behaves_like 'success scenario'
-      after(:all) { described_class.store(:title, 'bezeichnung') }
-    end
-
-    describe Exchange.new(:xpath_eg, blz: 100000) do
-      its(['plz']) { is_expected.to eq '100000' }
-      it { is_expected.to have_xpath_value '//ns1:bezeichnung' => 'Deutsche Bank' }
-      context 'Handle retrieving stored value' do
-        it { is_expected.to have_xpath_value 'bezeichnung' => described_class.retrieve(:title) }
-      end
-    end
-
-    describe Exchange.new(:yaml_eg, data_for(:small_id)) do
-      it_behaves_like 'success scenario'
-    end
-
-    # Retry for success more for web services that intermittently fail
-    describe Exchange.new(:short_hand_xpath).retry_for_success do
-      # Be careful. If you call a method that does not use namespaces, calling one that does may not find the element
-      its(['ns1:bezeichnung']) { is_expected.to eq 'Deutsche Bank' } # '//' is not required at the beginning
-    end
-    describe Exchange.new('Check existence of elements') do
-      it { is_expected.to have_element_at_xpath '//ns1:bezeichnung' }
-      it { is_expected.not_to have_element_at_xpath '//ns1:bezeichnung_pretend' }
-    end
-  end
-end
-
-error_example = BLZService.new('Error example')
-error_example.operation = :get_bank
-error_example.default_hash = {}
-
-context 'Error Examples' do
-  context error_example do
-    describe Exchange.new(:no_blz_error) do
-      it_behaves_like 'error scenario'
-    end
-  end
-end
+
+require 'spec_helper'
+
+id = '70070010'
+# BLZService.new(template_name: 'soap_template') Use this instead of default_hash to use template approach
+
+context 'Test Examples' do
+  context BLZService.new('Get Bank', operation: :get_bank, default_hash: { blz: id }) do
+
+    describe Exchange.new(:default) do
+      it { is_expected.to contain_value id }
+      it { is_expected.to include_in_body id }
+      it_behaves_like 'success scenario'
+      after(:all) { described_class.store(:title, 'bezeichnung') }
+    end
+
+    describe Exchange.new(:xpath_eg, blz: 100000) do
+      its(['plz']) { is_expected.to eq '100000' }
+      it { is_expected.to have_xpath_value '//ns1:bezeichnung' => 'Deutsche Bank' }
+      context 'Handle retrieving stored value' do
+        it { is_expected.to have_xpath_value 'bezeichnung' => described_class.retrieve(:title) }
+      end
+    end
+
+    describe Exchange.new(:yaml_eg, data_for(:small_id)) do
+      it_behaves_like 'success scenario'
+    end
+
+    # Retry for success more for web services that intermittently fail
+    describe Exchange.new(:short_hand_xpath).retry_for_success do
+      # Be careful. If you call a method that does not use namespaces, calling one that does may not find the element
+      its(['ns1:bezeichnung']) { is_expected.to eq 'Deutsche Bank' } # '//' is not required at the beginning
+    end
+    describe Exchange.new('Check existence of elements') do
+      it { is_expected.to have_element_at_xpath '//ns1:bezeichnung' }
+      it { is_expected.not_to have_element_at_xpath '//ns1:bezeichnung_pretend' }
+    end
+  end
+end
+
+error_example = BLZService.new('Error example')
+error_example.operation = :get_bank
+error_example.default_hash = {}
+
+context 'Error Examples' do
+  context error_example do
+    describe Exchange.new(:no_blz_error) do
+      it_behaves_like 'error scenario'
+    end
+  end
+end