RubyGems - soaspec - Versions diffs - 0.2.23 → 0.2.24 - Mend

soaspec 0.2.23 → 0.2.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (80) hide show

checksums.yaml +4 -4
data/.gitignore +15 -15
data/.gitlab-ci.yml +33 -33
data/.rspec +3 -3
data/.rubocop.yml +2 -2
data/CODE_OF_CONDUCT.md +74 -74
data/ChangeLog +577 -573
data/Gemfile +6 -6
data/LICENSE.txt +21 -21
data/README.md +230 -230
data/Rakefile +42 -42
data/Todo.md +15 -15
data/exe/soaspec +123 -123
data/exe/xml_to_yaml_file +42 -42
data/lib/soaspec.rb +101 -101
data/lib/soaspec/core_ext/hash.rb +35 -35
data/lib/soaspec/cucumber/generic_steps.rb +85 -85
data/lib/soaspec/demo.rb +4 -4
data/lib/soaspec/exchange/exchange.rb +111 -111
data/lib/soaspec/exchange/exchange_extractor.rb +83 -83
data/lib/soaspec/exchange/exchange_properties.rb +26 -26
data/lib/soaspec/exchange/exchange_repeater.rb +19 -19
data/lib/soaspec/exchange/request_builder.rb +68 -68
data/lib/soaspec/exchange/variable_storer.rb +22 -22
data/lib/soaspec/exchange_handlers/exchange_handler.rb +126 -126
data/lib/soaspec/exchange_handlers/handler_accessors.rb +130 -130
data/lib/soaspec/exchange_handlers/response_extractor.rb +82 -82
data/lib/soaspec/exchange_handlers/rest_exchanger_factory.rb +109 -109
data/lib/soaspec/exchange_handlers/rest_handler.rb +259 -259
data/lib/soaspec/exchange_handlers/rest_methods.rb +44 -44
data/lib/soaspec/exchange_handlers/rest_parameters.rb +86 -86
data/lib/soaspec/exchange_handlers/rest_parameters_defaults.rb +21 -21
data/lib/soaspec/exchange_handlers/soap_handler.rb +235 -235
data/lib/soaspec/exe_helpers.rb +92 -92
data/lib/soaspec/generate_server.rb +37 -37
data/lib/soaspec/generator/.rspec.erb +5 -5
data/lib/soaspec/generator/.travis.yml.erb +5 -5
data/lib/soaspec/generator/Gemfile.erb +8 -8
data/lib/soaspec/generator/README.md.erb +29 -29
data/lib/soaspec/generator/Rakefile.erb +19 -19
data/lib/soaspec/generator/config/data/default.yml.erb +2 -2
data/lib/soaspec/generator/css/bootstrap.css +6833 -6833
data/lib/soaspec/generator/generate_exchange.html.erb +35 -35
data/lib/soaspec/generator/lib/blz_service.rb.erb +26 -26
data/lib/soaspec/generator/lib/dynamic_class_content.rb.erb +12 -12
data/lib/soaspec/generator/lib/new_rest_service.rb.erb +51 -51
data/lib/soaspec/generator/lib/new_soap_service.rb.erb +29 -29
data/lib/soaspec/generator/lib/package_service.rb.erb +2 -2
data/lib/soaspec/generator/lib/shared_example.rb.erb +8 -8
data/lib/soaspec/generator/spec/dynamic_soap_spec.rb.erb +12 -12
data/lib/soaspec/generator/spec/rest_spec.rb.erb +9 -9
data/lib/soaspec/generator/spec/soap_spec.rb.erb +51 -51
data/lib/soaspec/generator/spec/spec_helper.rb.erb +23 -23
data/lib/soaspec/generator/template/soap_template.xml +6 -6
data/lib/soaspec/indifferent_hash.rb +7 -7
data/lib/soaspec/interpreter.rb +39 -39
data/lib/soaspec/matchers.rb +114 -114
data/lib/soaspec/not_found_errors.rb +13 -13
data/lib/soaspec/o_auth2.rb +128 -128
data/lib/soaspec/soaspec_shared_examples.rb +24 -24
data/lib/soaspec/spec_logger.rb +121 -121
data/lib/soaspec/template_reader.rb +28 -28
data/lib/soaspec/test_server/bank.wsdl +90 -90
data/lib/soaspec/test_server/get_bank.rb +164 -164
data/lib/soaspec/test_server/id_manager.rb +39 -39
data/lib/soaspec/test_server/invoices.rb +27 -27
data/lib/soaspec/test_server/namespace.xml +14 -14
data/lib/soaspec/test_server/note.xml +5 -5
data/lib/soaspec/test_server/puppy_service.rb +19 -19
data/lib/soaspec/test_server/test_attribute.rb +12 -12
data/lib/soaspec/test_server/test_namespace.rb +12 -12
data/lib/soaspec/version.rb +4 -3
data/lib/soaspec/virtual_server.rb +174 -174
data/lib/soaspec/wait.rb +41 -41
data/lib/soaspec/wsdl_generator.rb +215 -215
data/soaspec.gemspec +53 -53
data/test.wsdl +116 -116
data/test.xml +10 -10
data/test_wsdl.rb +41 -41
metadata +3 -4

data/lib/soaspec/generator/generate_exchange.html.erb CHANGED

@@ -1,36 +1,36 @@
-<html>
-<head>
-    <title>REST Exchange generator</title>
-    <link rel="stylesheet" href="css/bootstrap.css" type="text/css" charset="utf-8" />
-</head>
-<body>
-<main class="container-fluid">
-    <h1>REST Exchange generator</h1>
-    <h2>Handler creator <small><%= GenerateServer.create_params['feedback'] %></small></h2>
-    <form class="form-horizontal" method="POST" action="/generate">
-        <div class="form-group">
-            <label class="col-sm-2 control-label" for="className">Class Name</label>
-            <div class="col-sm-10">
-                <input id="className" class="form-control" type="text" name="className"
-                       placeholder="ApiUnderTest" value="<%= GenerateServer.create_params['className'] %>">
-                <p class="help-block">This is what you will refer to the API in your test code. Use Pascal Case</p>
-            </div>
-        </div>
-        <div class="form-group">
-            <label class="col-sm-2 control-label" for="baseUrl">Base URL</label>
-            <div class="col-sm-10">
-            <input id="baseUrl" class="form-control" type="text" name="baseUrl"
-                   placeholder="https://url/which/api/starts_with" value="<%= GenerateServer.create_params['baseUrl'] %>">
-            <p class="help-block">Url with which all REST requests using this class will start with.
-                Exchanges creating using this class can append to this with the 'suburl' parameter.</p>
-            </div>
-        </div>
-        <div class="form-group">
-            <div class="col-sm-offset-2 col-sm-10">
-                <input type="submit" value="Generate handler" class="btn btn-primary">
-            </div>
-        </div>
-    </form>
-</main>
-</body>
+<html>
+<head>
+    <title>REST Exchange generator</title>
+    <link rel="stylesheet" href="css/bootstrap.css" type="text/css" charset="utf-8" />
+</head>
+<body>
+<main class="container-fluid">
+    <h1>REST Exchange generator</h1>
+    <h2>Handler creator <small><%= GenerateServer.create_params['feedback'] %></small></h2>
+    <form class="form-horizontal" method="POST" action="/generate">
+        <div class="form-group">
+            <label class="col-sm-2 control-label" for="className">Class Name</label>
+            <div class="col-sm-10">
+                <input id="className" class="form-control" type="text" name="className"
+                       placeholder="ApiUnderTest" value="<%= GenerateServer.create_params['className'] %>">
+                <p class="help-block">This is what you will refer to the API in your test code. Use Pascal Case</p>
+            </div>
+        </div>
+        <div class="form-group">
+            <label class="col-sm-2 control-label" for="baseUrl">Base URL</label>
+            <div class="col-sm-10">
+            <input id="baseUrl" class="form-control" type="text" name="baseUrl"
+                   placeholder="https://url/which/api/starts_with" value="<%= GenerateServer.create_params['baseUrl'] %>">
+            <p class="help-block">Url with which all REST requests using this class will start with.
+                Exchanges creating using this class can append to this with the 'suburl' parameter.</p>
+            </div>
+        </div>
+        <div class="form-group">
+            <div class="col-sm-offset-2 col-sm-10">
+                <input type="submit" value="Generate handler" class="btn btn-primary">
+            </div>
+        </div>
+    </form>
+</main>
+</body>
 </html>

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

@@ -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 CHANGED

@@ -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/new_rest_service.rb.erb CHANGED

@@ -1,52 +1,52 @@
-# This class represent REST Api calls for the <%= @name %> API
-class <%= @name %> < Soaspec::RestHandler
-  ## Defining request
-  # All requests to <%= @name %> will start with this url <% if @base_url %>
-  base_url '<%= @base_url %>'
-  <% else %>
-  # TODO: Change this mandatory base_url to the url that all requests to this service start with
-  # base_url "https://my_host/api/<%= ENV['environment'] %>/api_name" # ERB can be used to make this dynamic based on environment
-  <% end %>
-  # Headers that will be sent by default using this Handler
-  # If symbol is used, they'll be converted to standard HTTP headers
-  # headers accept: 'application/json', content_type: 'application/json'
-  # Filename of oauth2 file to use for oauth2 parameters. 'Soaspec.credentials_folder' can be set to globally defined a folder with credentials
-  # This will add a default 'Authorization: Bearer access_token' header if 'Authorization' is not specified in headers
-  # The '.yml' extension will be added automatically if not present.
-  # oauth2_file 'filename.yml'
-  # Filename of YAML with basic auth parameters in it 'Soaspec.credentials_folder' can be set to globally defined a folder with credentials
-  # It is of the format
-  # user: 'username'
-  # password: 'password'
-  # basic_auth_file 'basic_auth.yml' # Load YAML file with basic auth credentials in it
-  ### Request Body
-  # Filename of template to be used. This is within 'Soaspec.template_folder' folder
-  # template_name 'filename'
-  # Default hash to be used in request that will be converted to JSON. This can be overriden and added to by each Exchange using this class
-  # default_hash a: 1, b: 2
-  ## Extracting response
-  # Use this to extract the value of either a JSON (JSONPath) or XML (Xpath) element. 'element_name' is the method that will be
-  # generated on an Exchange to obtain it
-  # element :element_name, 'element_path'
-  # Use this to extract an attribute from XML. If the name of the method and the attribute name are the same then only one parameter is
-  # needed
-  # attribute(:attribute_method_name, 'name_of_attribute')
-  ## Creating verifications for success response
-  # Values that must have a certain value for 'success scenario' shared example
-  # mandatory_json_values '$..status' => 'available'
-  # Elements that must be in the response for 'success scenario' shared example
-  # Below will expect an element at the path 'tags' to be present
-  # mandatory_elements :tags
+# This class represent REST Api calls for the <%= @name %> API
+class <%= @name %> < Soaspec::RestHandler
+  ## Defining request
+  # All requests to <%= @name %> will start with this url <% if @base_url %>
+  base_url '<%= @base_url %>'
+  <% else %>
+  # TODO: Change this mandatory base_url to the url that all requests to this service start with
+  # base_url "https://my_host/api/<%= ENV['environment'] %>/api_name" # ERB can be used to make this dynamic based on environment
+  <% end %>
+  # Headers that will be sent by default using this Handler
+  # If symbol is used, they'll be converted to standard HTTP headers
+  # headers accept: 'application/json', content_type: 'application/json'
+  # Filename of oauth2 file to use for oauth2 parameters. 'Soaspec.credentials_folder' can be set to globally defined a folder with credentials
+  # This will add a default 'Authorization: Bearer access_token' header if 'Authorization' is not specified in headers
+  # The '.yml' extension will be added automatically if not present.
+  # oauth2_file 'filename.yml'
+  # Filename of YAML with basic auth parameters in it 'Soaspec.credentials_folder' can be set to globally defined a folder with credentials
+  # It is of the format
+  # user: 'username'
+  # password: 'password'
+  # basic_auth_file 'basic_auth.yml' # Load YAML file with basic auth credentials in it
+  ### Request Body
+  # Filename of template to be used. This is within 'Soaspec.template_folder' folder
+  # template_name 'filename'
+  # Default hash to be used in request that will be converted to JSON. This can be overriden and added to by each Exchange using this class
+  # default_hash a: 1, b: 2
+  ## Extracting response
+  # Use this to extract the value of either a JSON (JSONPath) or XML (Xpath) element. 'element_name' is the method that will be
+  # generated on an Exchange to obtain it
+  # element :element_name, 'element_path'
+  # Use this to extract an attribute from XML. If the name of the method and the attribute name are the same then only one parameter is
+  # needed
+  # attribute(:attribute_method_name, 'name_of_attribute')
+  ## Creating verifications for success response
+  # Values that must have a certain value for 'success scenario' shared example
+  # mandatory_json_values '$..status' => 'available'
+  # Elements that must be in the response for 'success scenario' shared example
+  # Below will expect an element at the path 'tags' to be present
+  # mandatory_elements :tags
 end

data/lib/soaspec/generator/lib/new_soap_service.rb.erb CHANGED

@@ -1,30 +1,30 @@
-# This class represent SOAP Api calls for the <%= @name %> API
-class <%= @name %> < Soaspec::SoapHandler
-  # Wsdl for <%= @name %>
-  def savon_options
-      {
-          # wsdl 'https://my_host/api?wsdl' TODO: Change this to the wsdl that this SOAP service uses
-      }
-  end
-  ## Verifying on response
-  # Values that must have a certain value for 'success scenario' shared example
-  # mandatory_json_values '$..status' => 'available'
-  # Elements that must be in the response for 'success scenario' shared example
-  # Below will expect an element at the path 'tags' to be present
-  # mandatory_elements :tags
-  # Use this to extract the value of either a JSON (JSONPath) or XML (Xpath) element. 'element_name' is the method that will be
-  # generated on an Exchange to obtain it
-  # element :element_name, 'element_path'
-  # Use this to extract an attribute from XML. If the name of the method and the attribute name are the same then only one parameter is
-  # needed
-  # attribute(:attribute_method_name, 'name_of_attribute')
-  # Set an attribute on the root XML element
-  # root_attributes 'Version' => '1'
+# This class represent SOAP Api calls for the <%= @name %> API
+class <%= @name %> < Soaspec::SoapHandler
+  # Wsdl for <%= @name %>
+  def savon_options
+      {
+          # wsdl 'https://my_host/api?wsdl' TODO: Change this to the wsdl that this SOAP service uses
+      }
+  end
+  ## Verifying on response
+  # Values that must have a certain value for 'success scenario' shared example
+  # mandatory_json_values '$..status' => 'available'
+  # Elements that must be in the response for 'success scenario' shared example
+  # Below will expect an element at the path 'tags' to be present
+  # mandatory_elements :tags
+  # Use this to extract the value of either a JSON (JSONPath) or XML (Xpath) element. 'element_name' is the method that will be
+  # generated on an Exchange to obtain it
+  # element :element_name, 'element_path'
+  # Use this to extract an attribute from XML. If the name of the method and the attribute name are the same then only one parameter is
+  # needed
+  # attribute(:attribute_method_name, 'name_of_attribute')
+  # Set an attribute on the root XML element
+  # root_attributes 'Version' => '1'
 end

data/lib/soaspec/generator/lib/package_service.rb.erb CHANGED

@@ -1,3 +1,3 @@
-class PackageService < Soaspec::RestHandler
-  base_url 'http://localhost:4999/packages'
+class PackageService < Soaspec::RestHandler
+  base_url 'http://localhost:4999/packages'
 end

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

@@ -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 CHANGED

@@ -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/rest_spec.rb.erb CHANGED

@@ -1,9 +1,9 @@
-context PackageService.new('Test extract id') do
-  describe get 'Negative', suburl: '4/40' do
-    its(['success']) { is_expected.to eq 'false' }
-  end
-  describe get 'Positive', suburl: '4/41' do
-    its(['success']) { is_expected.to eq 'true' }
-  end
-end
+context PackageService.new('Test extract id') do
+  describe get 'Negative', suburl: '4/40' do
+    its(['success']) { is_expected.to eq 'false' }
+  end
+  describe get 'Positive', suburl: '4/41' do
+    its(['success']) { is_expected.to eq 'true' }
+  end
+end

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

@@ -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