soaspec 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31e59104f7fe53eab3382cd0e569c6372ceac6f2
-  data.tar.gz: bd767b72d3ec217ac2d57416660e5fd848cf7b91
+  metadata.gz: c6d36ecf75fe66a1bf4dcfc6a8e2dfdd7e9eb074
+  data.tar.gz: 6ebbdbc38a6c0465c08b47ef42d7627171eda5ce
 SHA512:
-  metadata.gz: 77813ae5339c6ad088f89896d5b67fd63e94b4c5d1c4a979632011dcce5a71c3d87d642d1e560196f65da22279ceac443d9e59a7fac436fabb5720af14cdb1aa
-  data.tar.gz: 1ecd9df640c74a646ed9248f24889c2ae41e681fbcb420e154c4aed6344276c2b1acc4778e280bf086e2858e1978b8a4193e495243e3856f9dea9ba325b9d557
+  metadata.gz: 72df691e2a4ca57bbef566e8c2fc9b794f5d7b60964858bcce5a1c537ae06ae754b8a9cec33b186eedf045eea9ac32bd2e49e5c296a42bf5149d2746047fc7a7
+  data.tar.gz: 5a9a30d7cfbbd6b6e430f24310521f89e8cec2eed8d821b0fa50a2f979a3ec1aad50e70ce600f4128a0c294760e7a335135595bab98fc270c5ca770e382d13fe

data/ChangeLog

@@ -1,6 +1,12 @@
+Version 0.0.18 / 2018-1-25
+* Fixes
+  * Updated 'soaspec-init' so that it works again.
+* Enhancements
+  * Added example showing representing data for request in YAML
+
 Version 0.0.17 / 2018-1-25
 * Fixes
-  * Updated hash search so that it handles Array"
+  * Updated hash search so that it handles Array
 
 Version 0.0.16 / 2018-1-23
 * Fixes

data/Gemfile

@@ -4,6 +4,7 @@ git_source(:gitlab) { |repo_name| "https://gitlab.com/samuel-garratt/soaspec" }
 
 # Specify your gem's dependencies in soaspec.gemspec
 gemspec
+gem 'data_magic'
 gem 'rest-client'
 gem 'savon'
 gem 'require_all'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    soaspec (0.0.16)
+    soaspec (0.0.17)
       rest-client (>= 2.0)
       rspec (~> 3.0)
       rspec-its (>= 1.2.0)
@@ -15,9 +15,15 @@ GEM
       gyoku (>= 0.4.0)
       nokogiri
     builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    data_magic (1.2)
+      faker (>= 1.1.2)
+      yml_reader (>= 0.6)
     diff-lcs (1.3)
     domain_name (0.5.20170404)
       unf (>= 0.0.5, < 1.0.0)
+    faker (1.8.5)
+      i18n (~> 0.9.1)
     ffi (1.9.18-x64-mingw32)
     gyoku (1.3.1)
       builder (>= 2.1.2)
@@ -26,6 +32,8 @@ GEM
     httpi (2.4.2)
       rack
       socksify
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
@@ -83,6 +91,7 @@ GEM
       httpi (~> 2.0)
       nokogiri (>= 1.4.2)
     xml-simple (1.1.5)
+    yml_reader (0.7)
 
 PLATFORMS
   ruby
@@ -90,6 +99,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
+  data_magic
   nokogiri
   rake (= 12.2.1)
   require_all

data/config/data/default.yml

@@ -0,0 +1,3 @@
+japan:
+  city_name: 'Tokyo'
+  country_name: 'Japan'

data/exe/soaspec-init

@@ -38,6 +38,8 @@ gem_content = <<-EOF
 
 source 'https://rubygems.org'
 
+gem 'data_magic'
+gem 'require_all'
 gem 'soaspec'
 
 EOF
@@ -61,6 +63,11 @@ 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
@@ -71,21 +78,77 @@ end
 
 EOF
 
+weather_web_service = <<-EOF
+
+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 WeatherWebService < Soaspec::BasicSoapHandler
+  # Add to or override default Savon client options
+  def savon_options
+    {
+      wsdl: 'http://www.webservicex.com/globalweather.asmx?wsdl',
+      convert_request_keys_to: :camelcase
+    }
+  end
+
+  # Specifying that get_weather_result must be present in the SOAP response
+  def mandatory_elements
+    [:get_weather_result]
+  end
+
+  # Example of xpath value that must be true for all success scenarios
+  def mandatory_xpath_values
+    {
+      '//xmlns:GetWeatherResult' => 'Data Not Found'
+    }
+  end
+
+  # Example of setting an attribute on the root XML element
+  def root_attributes
+    {
+      'Version' => '1'
+    }
+  end
+
+end
+
+EOF
+
 soap_spec_content = <<-EOF
+
 require 'spec_helper'
 
-soap_example = Soaspec::BasicSoapHandler.new('Courier post',
-                                              wsdl: 'http://www.webservicex.com/globalweather.asmx?wsdl')
-soap_example.namespaces = { 'ns1' => 'http://www.webserviceX.NET' }
-soap_example.default_operation = :get_weather
-soap_example.template_name = 'soap_template'
+soap_example = WeatherWebService.new('Get Weather')
+soap_example.operation = :get_weather
+soap_example.default_hash = { city_name: 'Sydney', country_name: 'Australia' }
+# soap_example.template_name = 'soap_template' # Use this if you'd rather use template file and comment out previous line
+
+
+  context soap_example do
+    describe Exchange.new(:default) do
+      it { is_expected.to contain_value 'Data Not Found' }
+      it_behaves_like 'success scenario'
+    end
+
+    describe Exchange.new(:china, city_name: 'Shanghai', country_name: 'China') do
+      it_behaves_like 'success scenario'
+      context 'handle xpath' do
+        its(['//xmlns:GetWeatherResult']) { is_expected.to eq 'Data Not Found' }
+        its(['xmlns:GetWeatherResult']) { is_expected.to eq 'Data Not Found' }
+        it { is_expected.to have_element_at_xpath '//xmlns:GetWeatherResult' }
+        it { is_expected.to have_xpath_value '//xmlns:GetWeatherResult' => 'Data Not Found' }
+      end
+    end
+
+    describe Exchange.new(:japan, data_for(:japan)) do
+      it_behaves_like 'success scenario'
+    end
 
-RSpec.context soap_example do
-  describe Exchange.new(:default) do
-    it { is_expected.to contain 'Data Not Found' }
-    it_behaves_like 'success scenario'
   end
-end
+
 EOF
 
 soap_template_content = <<-EOF
@@ -101,6 +164,13 @@ soap_template_content = <<-EOF
 </s12:Envelope>
 EOF
 
+default_yaml_content = <<-EOF
+japan:
+  city_name: 'Tokyo'
+  country_name: 'Japan'
+
+EOF
+
 readme_content = <<-EOF
 
 # Prerequisites
@@ -141,9 +211,14 @@ EOF
 create_file(filename: 'Gemfile', content: gem_content)
 create_file(filename: 'Rakefile', content: rake_content)
 create_file(filename: 'README.md', content: readme_content)
+create_folder 'lib'
+create_file(filename: 'lib/weather_web_service.rb', content: weather_web_service)
+create_folder 'config'
+create_folder 'config/data'
+create_file(filename: 'config/data/default.yml', content: default_yaml_content)
 create_folder 'spec'
-create_folder 'template'
-create_folder 'logs'
 create_file(filename: 'spec/spec_helper.rb', content: spec_helper_content)
 create_file(filename: 'spec/soap_spec.rb', content: soap_spec_content)
+create_folder 'template'
 create_file(filename: 'template/soap_template.xml', content: soap_template_content)
+create_folder 'logs'

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.0.17'
+  VERSION = '0.0.18'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - SamuelGarrattIQA
@@ -144,6 +144,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- config/data/default.yml
 - exe/soaspec-init
 - exe/xml_to_yaml_file
 - lib/soaspec.rb