soaspec 0.0.28 → 0.0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18f0661c8b343eccfa911819e895b4a971f18e91
-  data.tar.gz: 6b9f9aa4d5a318efa2c0c71962fbc93ec3198dcb
+  metadata.gz: 175c61fcf50ffcad25f8cfaf8ffcc508de469607
+  data.tar.gz: 6753d697bea4c8058cf005964a100b6edb7f809a
 SHA512:
-  metadata.gz: c4ec79ab87e48032d3a142f7643484d7731b33d36d2d10d6a7640668ead69107c0e5032c7a8a5bdc87e65dad3948b9a0c9c3a773ab78baf7c639cee0e1582ad0
-  data.tar.gz: ab95079660cf8df4190137987b15b31bb0cbd0906ca8c44a28fc843fca6e921dfb01988e3f4bcbad02dfa9a79fd3975f4b9955aab52f64aa782dc320b1f27bd3
+  metadata.gz: fe07fbc0e1a63944070b2d4842527b1071005c8f61913a79de5990f943c2e4009de1c2f5ef28eadb9527ea8467f928be9f2189ee8cb18cf12d2b71c81f5b6875
+  data.tar.gz: db8b5cdac6ca0c6fafdaf1be2380984a354f3f25c0654225a3306606a136b1d38a600b41c9072ee363026aa9090ed0bd489c8d3964157693f20a11e7934bf6ce

data/ChangeLog

@@ -1,3 +1,8 @@
+Version 0.0.29 / 2018-3-6
+* Refactorings
+   * Base 'test' class from 'Tester' to 'ExhangeHandler'
+   * Made default Soap Handler class 'SoapHandler' and making use of 'BasicSoapHandler' deprecated
+
 Version 0.0.28 / 2018-3-6
 * Enhancements
   * Added not_found matcher and used in spec example

data/Gemfile.lock

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

data/exe/soaspec-generate

@@ -100,7 +100,7 @@ end
 
   require 'soaspec'
 
-  class <%= @name %> < Soaspec::BasicSoapHandler
+  class <%= @name %> < Soaspec::SoapHandler
     # Add to or override default Savon client options
     def savon_options
       {
@@ -145,6 +145,7 @@ 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
+create_file filename: 'README.md', content: readme_content, ignore_if_present: true
 
 create_folder 'logs'
 create_folder 'config'

data/exe/soaspec-init

@@ -9,18 +9,6 @@ include Soaspec::ExeHelpers
 
 puts 'Creating files for soaspec'
 
-gem_content = <<-EOF
-
-source 'https://rubygems.org'
-
-gem 'data_magic'
-gem 'require_all'
-gem 'rspec_junit_formatter'
-gem 'rake'
-gem 'soaspec'
-
-EOF
-
 weather_web_service = <<-EOF
 
 require 'soaspec'
@@ -28,7 +16,7 @@ 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
+class WeatherWebService < Soaspec::SoapHandler
   # Add to or override default Savon client options
   def savon_options
     {
@@ -84,9 +72,11 @@ soap_example.default_hash = { city_name: 'Sydney', country_name: 'Australia' }
 
   end
 
-soap_example.default_hash = { city_name: 'Washington' }
+error_example = WeatherWebService.new('Get Weather')
+error_example.operation = :get_weather
+error_example.default_hash = { city_name: 'Washington' }
 context 'error scenarios' do
-  context soap_example do
+  context error_example do
     describe Exchange.new(:error) do
       it_behaves_like 'error scenario'
     end
@@ -128,43 +118,6 @@ japan:
 
 EOF
 
-readme_content = <<-EOF
-
-# Prerequisites
-This creates files within an existing folder. It could add onto an existing project.
-For a new project create a folder and be at it's location on the command line
-
-```
-mkdir soaspec_test
-cd soaspec_test
-```
-
-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
-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
-
-## Libaries
-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
-
-EOF
-
 create_file(filename: 'Gemfile', content: gem_content)
 create_file(filename: 'Rakefile', content: rake_content)
 create_file(filename: 'README.md', content: readme_content)

data/lib/soaspec.rb

@@ -9,7 +9,7 @@ require 'date'
 
 require 'soaspec/version'
 require 'soaspec/basic_soap_handler'
-require 'soaspec/tester'
+require 'soaspec/exchange_handler'
 require 'soaspec/exchange'
 require 'soaspec/matchers'
 require 'soaspec/soaspec_shared_examples'

data/lib/soaspec/basic_soap_handler.rb

@@ -1,5 +1,5 @@
 
-require_relative 'tester'
+require_relative 'exchange_handler'
 require_relative 'hash_methods'
 require_relative 'xpath_not_found'
 require_relative 'accessors'
@@ -17,7 +17,7 @@ module Soaspec
   end
 
   # Wraps around Savon client defining default values dependent on the soap request
-  class BasicSoapHandler < Tester
+  class SoapHandler < ExchangeHandler
     extend Soaspec::Accessors
     extend Soaspec::SoapAccessors
 
@@ -106,6 +106,19 @@ module Soaspec
       @default_hash = Soaspec::Environment.always_use_keys? ? hash.transform_keys_to_symbols : hash
     end
 
+    # @param [Hash] format Format of expected result
+    # @return [Object] Generic body to be displayed in error messages
+    def response_body(response, format: :hash)
+      case format
+      when :hash
+        response.body
+      when :xml
+        response.body.to_xml
+      else
+        response.body
+      end
+    end
+
     def status_code_for(response)
       response.http.code
     end
@@ -139,4 +152,12 @@ module Soaspec
     end
 
   end
+
+  class BasicSoapHandler < SoapHandler
+
+    def initialize(name, specific_options = {})
+      super
+      warn "'BasicSoapHandler' class is Deprecated. Please use 'SoapHandler' instead"
+    end
+  end
 end

data/lib/soaspec/{tester.rb → exchange_handler.rb}

@@ -1,7 +1,8 @@
 
 module Soaspec
+  # Inherit this for a class describing how to implement a particular exchange.
   # Has basic methods common for methods defining RSpec tests in YAML
-  class Tester
+  class ExchangeHandler
 
     # Retrieve the name of the template file to be used in the API request
     attr_reader :template_name

data/lib/soaspec/exe_helpers.rb

@@ -83,6 +83,46 @@ end
     EOF
     end
 
+    # @return [String] Content of README.md to aid someone getting started with this using this gem
+    def readme_content
+      <<-EOF
+
+# Prerequisites
+This creates files within an existing folder. It could add onto an existing project.
+For a new project create a folder and be at it's location on the command line
+
+```
+mkdir soaspec_test
+cd soaspec_test
+```
+
+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
+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
+
+## Libaries
+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
+
+    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')

data/lib/soaspec/rest_handler.rb

@@ -1,5 +1,5 @@
 
-require_relative 'tester'
+require_relative 'exchange_handler'
 require_relative 'hash_methods'
 require_relative 'xpath_not_found'
 require_relative 'accessors'
@@ -21,7 +21,7 @@ module Soaspec
   end
 
   # Wraps around Savon client defining default values dependent on the soap request
-  class RestHandler < Tester
+  class RestHandler < ExchangeHandler
     extend Soaspec::RestAccessors
     extend Soaspec::Accessors
 
@@ -93,6 +93,12 @@ module Soaspec
       response
     end
 
+    # @param [Hash] format Format of expected result. Ignored for this
+    # @return [Object] Generic body to be displayed in error messages
+    def response_body(response, format: :hash)
+      extract_hash response
+    end
+
     def include_in_body?(response, expected)
       response.body.include? expected
     end

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.0.28'
+  VERSION = '0.0.29'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.0.28
+  version: 0.0.29
 platform: ruby
 authors:
 - SamuelGarrattIQA
@@ -154,13 +154,13 @@ files:
 - lib/soaspec/accessors.rb
 - lib/soaspec/basic_soap_handler.rb
 - lib/soaspec/exchange.rb
+- lib/soaspec/exchange_handler.rb
 - lib/soaspec/exe_helpers.rb
 - lib/soaspec/hash_methods.rb
 - lib/soaspec/matchers.rb
 - lib/soaspec/rest_handler.rb
 - lib/soaspec/soaspec_shared_examples.rb
 - lib/soaspec/spec_logger.rb
-- lib/soaspec/tester.rb
 - lib/soaspec/version.rb
 - lib/soaspec/xpath_not_found.rb
 - soaspec.gemspec