soaspec 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94c09dc736076e7a885813bff6f82fb4542d5aee
-  data.tar.gz: c8c9ab3703b8ed38358f2fd8d840d81d4fff4431
+  metadata.gz: 648bba6578889b06fd5b8c3a1871e2dff381eb5e
+  data.tar.gz: 8b508b96c93f1928a222c3c7a4980d23438aae12
 SHA512:
-  metadata.gz: 82bf609a95402240f1af578266ca891f37f96d5f947b4fe48a99c2e35b94d1a2e5ea3be78b5c215a6de350dedfc7f91e83ec9a71b37fd7ed188f191c97a97f76
-  data.tar.gz: 22c17de478c533f2d6a79c5a19276391d1dcfe877cae518fda76866b5961ea52ef47e0d239738a0f21772a25de09d20095184524ae381cb61184589cf358c234
+  metadata.gz: b76fcbd53b8be2780a0dc64af8cf59a04ac07b1e68c91ffdb9814aeea3e4cbdc442510ef88a88991d1c914b011a567d4b260b8a07e22c52e95e419f57d9e3616
+  data.tar.gz: 18e2478c0df3c22b3c247fb2ffe974987bb5a1e14979c67ce049d056889d6cab944945a486069906774fc30ce32798d3a64d3f71afb5cfa0a1303d4d0ea6f819

data/ChangeLog

@@ -1,3 +1,10 @@
+Version 0.0.9 / 2018-1-20
+* Refactoring
+  * class_options -> savon_options - More specific
+  * default_operation -> operation - Not default anymore so better not in name
+* Enhancements
+  * Made mandatory_xpath_values method to add to 'success sceanarios' shared example
+
 Version 0.0.8 / 2018-1-19
 * Enhancements
   * Added root_attributes method to add attribute to the root class

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    soaspec (0.0.8)
+    soaspec (0.0.9)
       rest-client (>= 2.0)
       rspec (~> 3.0)
       savon (>= 2)

data/README.md

@@ -22,18 +22,21 @@ Or install it yourself as:
 ## Todo
 
 Handle REST
-Give examples and convience methods for building classes for each SOAP or REST operation
-Potentially have in built use of vcr and http_stub gems
+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
 
 ## Usage
 
-See specs for example of usage. This will be added to later. 
+* SOAP - this uses Savon behind the scenes. Some defaults are overridden. Please see 'basic_soap_handler.rb'-'default_options' method
+for such defaults. When describing an API override this in 'savon_options' method  
 
-It is recommended that a class be created representing a Web Service Operation or REST call. Then tests refer back to 
-that class. See get_weather_web_service class in spec/soaspec/soap folder for example.
+See specs for example of usage. This will be added to later. 
 
 ### Recommended
 
+It is recommended that a class be created representing a Web Service Operation or REST call. Then tests refer back to 
+that class. See 'weather_web_service.rb' class in spec/soaspec/soap folder for example.
+
 If you find having a large backtrace on errors or RSpec shared examples such as 'success scenarios' this can shorten the 
 backtrace.
 

data/lib/soaspec/basic_soap_handler.rb

@@ -1,3 +1,4 @@
+
 require 'yaml'
 require_relative 'common'
 require_relative 'tester'
@@ -11,7 +12,7 @@ module Soaspec
     # Namespaces used in XML body
     attr_accessor :namespaces
     # SOAP Operation to use by default
-    attr_accessor :default_operation
+    attr_accessor :operation
 
     # Options to log xml request and response
     def logging_options
@@ -23,18 +24,27 @@ module Soaspec
       }
     end
 
-    # Default Savon options
+    # Default Savon options. See http://savonrb.com/version2/globals.html for details
+    # @return [Hash] Default Savon options for all BasicSoapHandler
     def default_options
       {
-          ssl_verify_mode: :none,
-          follow_redirects: true, # Necessary for many API calls
-          soap_version: 2, # use SOAP 1.2. You will get 415 error if this set to default
-          raise_errors: false
+        ssl_verify_mode: :none, # Easier for testing. Not so secure
+        follow_redirects: true, # Necessary for many API calls
+        soap_version: 2, # use SOAP 1.2. You will get 415 error if this is incorrect
+        raise_errors: false # HTTP errors not cause failure as often negative test scenarios expect not 200 response
+        # Things could go wrong if not set properly
+        # env_namespace: :soap, # Change environment namespace
+        # namespace_identifier: :tst, # Change namespace element
+        # element_form_default: :qualified # Populate each element with namespace
+        # namespace: 'http://Extended_namespace.xsd' change root namespace
+        # basic_auth: 'user', 'password'
       }
     end
 
-    # Add values to here when extending this class
-    def class_options
+    # Add values to here when extending this class to have default Savon options.
+    # See http://savonrb.com/version2/globals.html for details
+    # @return [Hash] Savon options adding to & overriding defaults
+    def savon_options
       {
       }
     end
@@ -44,24 +54,13 @@ module Soaspec
     def initialize(name, specific_options = {})
       super
       options = default_options.merge logging_options
-      options.merge! class_options
+      options.merge! savon_options
       options.merge!(specific_options)
       @client = Savon.client(options)
       self.namespaces = {}
       @name = name
     end
 
-    # Sends a call to the API (is being made obsolete)
-    # @param [Hash] options Dictionary of key value pairs specifying what API call to make
-    # @return [SavonResponse] Savon response from which areas (header, body, etc) of the SOAP response can be accessed
-    # def call(options)
-    #   test_values = options[:overide_values]['request'] || {} # Empty hash if no specific request values are set
-    #   options[:operation] ||= self.default_operation
-    #   # Erb parses template file, executing Ruby code in `<% %>` blocks to work out final request
-    #   render_body = ERB.new(options[:template]).result(binding)
-    #   @client.call(options[:operation], xml: render_body ) # Call the SOAP operation with the request XML provided
-    # end
-
     def name(name)
       @test_values = {}
       @test_name = name
@@ -81,14 +80,14 @@ module Soaspec
         test_values = test_values.transform_keys_to_symbols # Either string or symbol
         request_body = File.read('template/' + template_name + '.xml')
         render_body = ERB.new(request_body).result(binding)
-        @client.call(default_operation, xml: render_body ) # Call the SOAP operation with the request XML provided
+        @client.call(operation, xml: render_body) # Call the SOAP operation with the request XML provided
       elsif @request_option == :hash
-        @client.call(default_operation, message: @default_hash.merge(test_values), attributes: root_attributes)
+        @client.call(operation, message: @default_hash.merge(test_values), attributes: root_attributes)
       end
     end
 
     def to_s
-      Soaspec::Environment.api_handler = self
+      Soaspec::Environment.api_handler = self # Sets this variable globally. This is used in 'Exchange' class
       @name
     end
 
@@ -106,11 +105,20 @@ module Soaspec
     end
 
     # Override this to specify elements that must be present in the response
-    # Make it an Array of keys
+    # Will be used in 'success_scenarios' shared examples
+    # @return [Array] Array of symbols specifying element names
     def mandatory_elements
-      nil
+      []
+    end
+
+    # Override this to specify xpath results that must be present in the response
+    # Will be used in 'success_scenarios' shared examples
+    # @return [Hash] Hash of 'xpath' => 'expected value' pairs
+    def mandatory_xpath_values
+      {}
     end
 
+    # Attributes set at the root XML element of SOAP request
     def root_attributes
       nil
     end

data/lib/soaspec/exchange.rb

@@ -35,6 +35,11 @@ class Exchange
     @api_class.mandatory_elements
   end
 
+  # Elements a shared 'success scenario' is expected to have
+  def mandatory_xpath_values
+    @api_class.mandatory_xpath_values
+  end
+
   # Returns Savon response
   # response.body (body of response as Hash)
   # response.header (head of response as Hash)

data/lib/soaspec/matchers.rb

@@ -1,6 +1,13 @@
 
 require_relative 'hash_methods'
 
+def xpath_for(param)
+  # TODO: look a using Savon's xpath rather than converting to Nokogiri
+  result = param[:exchange].xml_doc.at_xpath(param[:xpath], Soaspec::Environment.api_handler.namespaces)
+  raise 'No value at Xpath' unless result
+  result
+end
+
 RSpec::Matchers.define :contain_value do |expected|
   match do |actual|
     expect(actual.response.body.include_value?(expected)).to be true
@@ -21,14 +28,15 @@ RSpec::Matchers.define :contain_key do |expected|
   end
 end
 
-RSpec::Matchers.define :have_element_at_xpath do |expected|
+RSpec::Matchers.define :have_element_at_xpath do |xpath|
   match do |exchange|
-    expect(exchange.xml_doc.at_xpath(expected, Soaspec::Environment.api_handler.namespaces).content).not_to be_empty
+    expect(xpath_for(exchange: exchange, xpath: xpath).content).not_to be_empty
   end
 end
 
 RSpec::Matchers.define :have_xpath_value do |expected_hash|
   match do |exchange|
-    expect(exchange.xml_doc.at_xpath(expected_hash.keys.first, Soaspec::Environment.api_handler.namespaces).content).to eq expected_hash.values.first
+    expected_hash = Hash[*expected_hash.flatten] if expected_hash.is_a?(Array)  # For some reason Array was occuring
+    expect(xpath_for(exchange: exchange, xpath: expected_hash.keys.first).content).to eq expected_hash.values.first
   end
 end

data/lib/soaspec/shared_examples.rb

@@ -4,13 +4,16 @@ shared_examples_for 'success scenario' do
   it 'has status code of 200' do
     expect(described_class.status_code).to eq 200
   end
-  if described_class.mandatory_elements
-    context 'has expected mandatory elements' do
-      described_class.mandatory_elements.each do |mandatory_element|
-        it mandatory_element do
-          expect(described_class).to contain_key mandatory_element
-        end
+  context 'has expected mandatory elements' do
+    described_class.mandatory_elements.each do |mandatory_element|
+      it mandatory_element do
+        expect(described_class).to contain_key mandatory_element
       end
     end
   end
+  context 'has expected xpath values' do
+    described_class.mandatory_xpath_values.each do |xpath_pair|
+      it { is_expected.to have_xpath_value xpath_pair }
+    end
+  end
 end

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2018-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler