soaspec 0.0.19 → 0.0.20

data/exe/xml_to_yaml_file

@@ -1,64 +1,64 @@
-
-require 'xmlsimple'
-require 'yaml'
-require 'fileutils'
-
-default_output_file = 'output.yml'
-
-# Create file if not present. If present but different give warning
-def create_file(options)
-  filename = options[:filename]
-  raise 'Need to pass filename' unless filename
-  content = options[:content]
-  raise 'Need to pass contents to insert into file' unless content
-  if File.exist? filename
-    old_content = File.read(filename)
-    if old_content != content
-      warn "!! #{filename} already exists and differs from template"
-    end
-  else
-    File.open(filename, 'w') do |f|
-      f.puts content
-    end
-    puts 'Created: ' + filename
-  end
-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')
-    .gsub(/([a-z\d])([A-Z])/,'\1_\2')
-    .tr('-', '_')
-    .gsub(/\s/, '_')
-    .gsub(/__+/, '_')
-    .downcase
-end
-
-# For all keys in a Hash, convert Camelcase to underscore separated
-def convert_hash_keys(value)
-  case value
-    when Array
-      value.map { |v| convert_hash_keys(v) }
-    when Hash
-      Hash[value.map { |k, v| [underscore_key(k), convert_hash_keys(v)] }]
-    else
-      value
-  end
-end
-
-# Remove arrays created as another string
-def clean_up_yaml(yaml_string)
-  yaml_string = yaml_string.gsub(/\R+(\s*)-/, '').gsub(/{}/, "''") # Remove arrays, {} -> ''
-  # Insert new line where there are 2 ':' on 1 line. Issue from first gsub
-  yaml_string.gsub(/:(\s)(\w*):/){|s| s.insert(1, "\n")}
-end
-
-if ARGV[0]
-  warn "Using '#{default_output_file}' as default output file since no 2nd argument passed" unless ARGV[1]
-  hash = XmlSimple.xml_in(ARGV[0])
-  converted = convert_hash_keys hash
-  yaml_file = clean_up_yaml(converted.to_yaml)
-  create_file(filename: ARGV[1] || default_output_file, content: yaml_file)
-else
-  puts 'usage: xml_to_yaml_file [input.xml] [output.yml] '
+
+require 'xmlsimple'
+require 'yaml'
+require 'fileutils'
+
+default_output_file = 'output.yml'
+
+# Create file if not present. If present but different give warning
+def create_file(options)
+  filename = options[:filename]
+  raise 'Need to pass filename' unless filename
+  content = options[:content]
+  raise 'Need to pass contents to insert into file' unless content
+  if File.exist? filename
+    old_content = File.read(filename)
+    if old_content != content
+      warn "!! #{filename} already exists and differs from template"
+    end
+  else
+    File.open(filename, 'w') do |f|
+      f.puts content
+    end
+    puts 'Created: ' + filename
+  end
+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')
+    .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+    .tr('-', '_')
+    .gsub(/\s/, '_')
+    .gsub(/__+/, '_')
+    .downcase
+end
+
+# For all keys in a Hash, convert Camelcase to underscore separated
+def convert_hash_keys(value)
+  case value
+    when Array
+      value.map { |v| convert_hash_keys(v) }
+    when Hash
+      Hash[value.map { |k, v| [underscore_key(k), convert_hash_keys(v)] }]
+    else
+      value
+  end
+end
+
+# Remove arrays created as another string
+def clean_up_yaml(yaml_string)
+  yaml_string = yaml_string.gsub(/\R+(\s*)-/, '').gsub(/{}/, "''") # Remove arrays, {} -> ''
+  # Insert new line where there are 2 ':' on 1 line. Issue from first gsub
+  yaml_string.gsub(/:(\s)(\w*):/){|s| s.insert(1, "\n")}
+end
+
+if ARGV[0]
+  warn "Using '#{default_output_file}' as default output file since no 2nd argument passed" unless ARGV[1]
+  hash = XmlSimple.xml_in(ARGV[0])
+  converted = convert_hash_keys hash
+  yaml_file = clean_up_yaml(converted.to_yaml)
+  create_file(filename: ARGV[1] || default_output_file, content: yaml_file)
+else
+  puts 'usage: xml_to_yaml_file [input.xml] [output.yml] '
 end

data/lib/soaspec.rb

@@ -1,48 +1,61 @@
-require 'rest-client' # REST
-require 'erb' # Embedded ruby
-require 'yaml' # Reading yaml
-require 'rspec' # Testing framework
-require 'rspec/its'
-require 'savon' # SOAP
-require 'nokogiri' # XPath
-require 'date'
-
-require 'soaspec/version'
-require 'soaspec/basic_soap_handler'
-require 'soaspec/tester'
-require 'soaspec/exchange'
-require 'soaspec/matchers'
-require 'soaspec/soaspec_shared_examples'
-require 'soaspec/hash_methods'
-require 'soaspec/spec_logger'
-
-# Gem for handling SOAP and REST api tests
-module Soaspec
-
-  def self.hi
-    puts 'Hello world!'
-  end
-
-  # Represents Environment parameters used in Soaspec tests
-  module Environment
-
-    # Used so that exchange class knows what context it's in
-    def self.api_handler=(handler)
-      @api_handler = handler
-    end
-
-    def self.api_handler
-      @api_handler
-    end
-
-    # Whether to transform strings to keys automatically
-    def self.always_use_keys=(use_keys)
-      @always_use_keys = use_keys
-    end
-
-    def self.always_use_keys?
-      @always_use_keys || true
-    end
-
-  end
-end
+require 'rest-client' # REST
+require 'erb' # Embedded ruby
+require 'yaml' # Reading yaml
+require 'rspec' # Testing framework
+require 'rspec/its'
+require 'savon' # SOAP
+require 'nokogiri' # XPath
+require 'date'
+
+require 'soaspec/version'
+require 'soaspec/basic_soap_handler'
+require 'soaspec/tester'
+require 'soaspec/exchange'
+require 'soaspec/matchers'
+require 'soaspec/soaspec_shared_examples'
+require 'soaspec/hash_methods'
+require 'soaspec/spec_logger'
+
+# Gem for handling SOAP and REST api tests
+module Soaspec
+
+  def self.hi
+    puts 'Hello world!'
+  end
+
+  # Represents Environment parameters used in Soaspec tests
+  module Environment
+
+    # Used so that exchange class knows what context it's in
+    def self.api_handler=(handler)
+      @api_handler = handler
+    end
+
+    def self.api_handler
+      @api_handler
+    end
+
+    # Whether to transform strings to keys automatically
+    def self.always_use_keys=(use_keys)
+      @always_use_keys = use_keys
+    end
+
+    def self.always_use_keys?
+      @always_use_keys || true
+    end
+
+    # Whether to remove namespaces from response in Xpath assertion automatically
+    # For why this may not be a good thing in general see
+    # http://tenderlovemaking.com/2009/04/23/namespaces-in-xml.html
+    # This will be overridden if xpath has a ':' in it
+    def self.strip_namespaces=(remove_namespaces_from_response)
+      @strip_namespaces = remove_namespaces_from_response
+    end
+
+    # Whether to remove namespaces in xpath assertion automatically
+    def self.strip_namespaces?
+      @strip_namespaces || false
+    end
+
+  end
+end

data/lib/soaspec/basic_soap_handler.rb

@@ -1,123 +1,133 @@
-
-require_relative 'tester'
-require_relative 'hash_methods'
-
-module Soaspec
-  # Wraps around Savon client defining default values dependent on the soap request
-  class BasicSoapHandler < Tester
-    # Savon client used to make SOAP calls
-    attr_accessor :client
-    # SOAP Operation to use by default
-    attr_accessor :operation
-
-    # Options to log xml request and response
-    def logging_options
-      {
-        log: true, # See request and response. (Put this in traffic file)
-        log_level: :debug,
-        logger: Soaspec::SpecLogger.create,
-        pretty_print_xml: true # Prints XML pretty
-      }
-    end
-
-    # 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, # 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 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
-
-    # Setup object to handle communicating with a particular SOAP WSDL
-    # @param [Hash] specific_options Options defining SOAP request. WSDL, authentication, see http://savonrb.com/version2/globals.html for list of options
-    def initialize(name, specific_options = {})
-      options = default_options.merge logging_options
-      options.merge! savon_options
-      options.merge!(specific_options)
-      @client = Savon.client(options)
-      super
-    end
-
-    def name(name)
-      @test_values = {}
-      @test_name = name
-      self
-    end
-
-    def override(request_parameters)
-      @test_values = request_parameters
-      self
-    end
-
-    # Used in together with Exchange request that passes such override parameters
-    def make_request(override_parameters)
-      test_values = override_parameters # Used in Erb
-      # Erb parses template file, executing Ruby code in `<% %>` blocks to work out final request
-      test_values = test_values.transform_keys_to_symbols if Soaspec::Environment.always_use_keys?
-      if @request_option == :template
-        request_body = File.read('template/' + template_name + '.xml')
-        render_body = ERB.new(request_body).result(binding)
-        @client.call(operation, xml: render_body) # Call the SOAP operation with the request XML provided
-      elsif @request_option == :hash
-        @client.call(operation, message: @default_hash.merge(test_values), attributes: root_attributes)
-      end
-    end
-
-    def default_hash=(hash)
-      @request_option = :hash
-      @default_hash = Soaspec::Environment.always_use_keys? ? hash.transform_keys_to_symbols : hash
-    end
-
-    def status_code_for(response)
-      response.http.code
-    end
-
-    # Override this to specify elements that must be present in the response
-    # Will be used in 'success_scenarios' shared examples
-    # @return [Array] Array of symbols specifying element names
-    def mandatory_elements
-      []
-    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
-
-    def xpath_value_for(param)
-      result = param[:exchange].response.xpath(param[:xpath]).first
-      raise 'No value at Xpath' unless result
-      result.inner_text
-    end
-
-    def value_from_path(exchange, path)
-      path = '//' + path if path[0] != '/'
-      xpath_value_for(exchange: exchange, xpath: path)
-    end
-
-  end
+
+require_relative 'tester'
+require_relative 'hash_methods'
+require_relative 'xpath_not_found'
+
+module Soaspec
+  # Wraps around Savon client defining default values dependent on the soap request
+  class BasicSoapHandler < Tester
+    # Savon client used to make SOAP calls
+    attr_accessor :client
+    # SOAP Operation to use by default
+    attr_accessor :operation
+
+    # Options to log xml request and response
+    def logging_options
+      {
+        log: true, # See request and response. (Put this in traffic file)
+        log_level: :debug,
+        logger: Soaspec::SpecLogger.create,
+        pretty_print_xml: true # Prints XML pretty
+      }
+    end
+
+    # 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, # 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 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
+
+    # Setup object to handle communicating with a particular SOAP WSDL
+    # @param [Hash] specific_options Options defining SOAP request. WSDL, authentication, see http://savonrb.com/version2/globals.html for list of options
+    def initialize(name, specific_options = {})
+      options = default_options.merge logging_options
+      options.merge! savon_options
+      options.merge!(specific_options)
+      @client = Savon.client(options)
+      super
+    end
+
+    def name(name)
+      @test_values = {}
+      @test_name = name
+      self
+    end
+
+    def override(request_parameters)
+      @test_values = request_parameters
+      self
+    end
+
+    # Used in together with Exchange request that passes such override parameters
+    def make_request(override_parameters)
+      test_values = override_parameters # Used in Erb
+      # Erb parses template file, executing Ruby code in `<% %>` blocks to work out final request
+      test_values = test_values.transform_keys_to_symbols if Soaspec::Environment.always_use_keys?
+      if @request_option == :template
+        request_body = File.read('template/' + template_name + '.xml')
+        render_body = ERB.new(request_body).result(binding)
+        @client.call(operation, xml: render_body) # Call the SOAP operation with the request XML provided
+      elsif @request_option == :hash
+        @client.call(operation, message: @default_hash.merge(test_values), attributes: root_attributes)
+      end
+    end
+
+    def default_hash=(hash)
+      @request_option = :hash
+      @default_hash = Soaspec::Environment.always_use_keys? ? hash.transform_keys_to_symbols : hash
+    end
+
+    def status_code_for(response)
+      response.http.code
+    end
+
+    # Override this to specify elements that must be present in the response
+    # Will be used in 'success_scenarios' shared examples
+    # @return [Array] Array of symbols specifying element names
+    def mandatory_elements
+      []
+    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
+
+    # Returns the value at the provided xpath
+    def xpath_value_for(param)
+      result =
+        if Soaspec::Environment.strip_namespaces? && !param[:xpath].include?(':')
+          temp_doc = param[:exchange].response.doc
+          temp_doc.remove_namespaces!
+          temp_doc.xpath(param[:xpath]).first
+        else
+          puts 'no strip' + param[:xpath]
+          param[:exchange].response.xpath(param[:xpath]).first
+        end
+      raise NoElementAtXpath, "No value at Xpath '#{param[:xpath]}'" unless result
+      result.inner_text
+    end
+
+    def value_from_path(exchange, path)
+      path = '//' + path if path[0] != '/'
+      xpath_value_for(exchange: exchange, xpath: path)
+    end
+
+  end
 end