soaspec 0.0.5 → 0.0.6

data/lib/soaspec.rb

@@ -1,35 +1,36 @@
-require 'rest-client' # REST
-require 'erb' # Embedded ruby
-require 'yaml' # Reading yaml
-require 'rspec' # Testing framework
-require 'savon' # SOAP
-require 'nokogiri' # XPath
-require 'date'
-
-require 'soaspec/version'
-require 'soaspec/common'
-require 'soaspec/basic_soap_handler'
-require 'soaspec/tester'
-require 'soaspec/exchange'
-require 'soaspec/matchers'
-require 'soaspec/shared_examples'
-
-# 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
-
-    def self.api_handler=(handler)
-      @api_handler = handler
-    end
-
-    def self.api_handler
-      @api_handler
-    end
-  end
-end
+require 'rest-client' # REST
+require 'erb' # Embedded ruby
+require 'yaml' # Reading yaml
+require 'rspec' # Testing framework
+require 'savon' # SOAP
+require 'nokogiri' # XPath
+require 'date'
+
+require 'soaspec/version'
+require 'soaspec/common'
+require 'soaspec/basic_soap_handler'
+require 'soaspec/tester'
+require 'soaspec/exchange'
+require 'soaspec/matchers'
+require 'soaspec/shared_examples'
+require 'soaspec/hash_methods'
+
+# 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
+
+    def self.api_handler=(handler)
+      @api_handler = handler
+    end
+
+    def self.api_handler
+      @api_handler
+    end
+  end
+end

data/lib/soaspec/basic_soap_handler.rb

@@ -1,85 +1,105 @@
-require 'yaml'
-require_relative 'common'
-require_relative 'tester'
-
-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
-    # Namespaces used in XML body
-    attr_accessor :namespaces
-    # SOAP Operation to use by default
-    attr_accessor :default_operation
-
-    # 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)
-      super
-      options = {
-        ssl_verify_mode: :none,
-        follow_redirects: true, # Necessary
-        log: true, # See request and response. (Put this in traffic file)
-        log_level: :debug,
-        logger: file_logger,
-        soap_version: 2, # use SOAP 1.2. You will get 415 error if this set to default
-        pretty_print_xml: true, # Prints XML pretty
-        raise_errors: false
-      }
-      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
-      self
-    end
-
-    def override(request_parameters)
-      @test_values = request_parameters
-      self
-    end
-
-    # TODO: Use this together with Exchange request
-    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
-      if @request_option == :template
-        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
-      elsif @request_option == :hash
-        @client.call(default_operation, message: @default_hash)
-      end
-    end
-
-    def to_s
-      Soaspec::Environment.api_handler = self
-      @name
-    end
-
-    def include?(value)
-      @xml_response.include? value
-    end
-
-    def default_hash=(hash)
-      @request_option = :hash
-      @default_hash = hash
-    end
-
-  end
+require 'yaml'
+require_relative 'common'
+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
+    # Namespaces used in XML body
+    attr_accessor :namespaces
+    # SOAP Operation to use by default
+    attr_accessor :default_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: file_logger,
+        pretty_print_xml: true # Prints XML pretty
+      }
+    end
+
+    # Default Savon options
+    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
+      }
+    end
+
+    # Add values to here when extending this class
+    def class_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 = {})
+      super
+      options = default_options.merge logging_options
+      options.merge! class_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
+      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
+      if @request_option == :template
+        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
+      elsif @request_option == :hash
+        @client.call(default_operation, message: @default_hash.merge(test_values))
+      end
+    end
+
+    def to_s
+      Soaspec::Environment.api_handler = self
+      @name
+    end
+
+    def include?(value)
+      @xml_response.include? value
+    end
+
+    def default_hash=(hash)
+      @request_option = :hash
+      @default_hash = hash
+    end
+
+  end
 end

data/lib/soaspec/common.rb

@@ -1,24 +1,24 @@
-class Hash
-
-  # Loop through each item within a key within a Hash if the key exists
-  # @param [Key] Key within hash to iterate through
-  def each_if_not_null(key)
-    case key.class.to_s
-    when 'String'
-      if self[key]
-        self[key].each do |list_item|
-          yield(list_item)
-        end
-      end
-    when 'Array'
-      if self[key[0]]
-        if self[key[0]][key[1]]
-          self[key[0]][key[1]].each do |list_item|
-            yield(list_item)
-          end
-        end
-      end
-    end
-  end
-
-end
+class Hash
+
+  # Loop through each item within a key within a Hash if the key exists
+  # @param [Key] Key within hash to iterate through
+  def each_if_not_null(key)
+    case key.class.to_s
+    when 'String'
+      if self[key]
+        self[key].each do |list_item|
+          yield(list_item)
+        end
+      end
+    when 'Array'
+      if self[key[0]]
+        if self[key[0]][key[1]]
+          self[key[0]][key[1]].each do |list_item|
+            yield(list_item)
+          end
+        end
+      end
+    end
+  end
+
+end

data/lib/soaspec/exchange.rb

@@ -1,40 +1,47 @@
-require_relative '../soaspec'
-#require_relative 'basic_soap_handler'
-# This represents a request / response pair
-class Exchange
-
-  attr_reader :xml_response
-
-  attr_reader :xml_doc
-
-  def initialize(name, override_parameters = {})
-    @test_name = name.to_s
-    @api_class = Soaspec::Environment.api_handler
-    @override_parameters = override_parameters
-  end
-
-  # Make request to handler with parameters defined
-  def make_request
-    @api_class.make_request(@override_parameters)
-  end
-
-  # Name describing this class when used with `RSpec.describe`
-  # @return [String] Name given when initializing
-  def to_s
-    @response = self.make_request
-    if Soaspec::Environment.api_handler.class == Soaspec::BasicSoapHandler
-      @xml_response = @response.to_xml
-      @xml_doc = Nokogiri::XML(@xml_response)
-    end
-    @test_name
-  end
-
-  def contain(value)
-    @xml_response.include? value
-  end
-
-  def status_code
-    @response.http.code
-  end
-
+require_relative '../soaspec'
+
+# This represents a request / response pair
+class Exchange
+
+  attr_reader :xml_response
+
+  attr_reader :xml_doc
+
+  def initialize(name, override_parameters = {})
+    @test_name = name.to_s
+    @api_class = Soaspec::Environment.api_handler
+    @override_parameters = override_parameters
+  end
+
+  # Make request to handler with parameters defined
+  def make_request
+    @api_class.make_request(@override_parameters)
+  end
+
+  # Name describing this class when used with `RSpec.describe`
+  # @return [String] Name given when initializing
+  def to_s
+    @response = self.make_request
+    if Soaspec::Environment.api_handler.class < Soaspec::BasicSoapHandler
+      @xml_response = @response.to_xml
+      @xml_doc = @response.doc
+    end
+    @test_name
+  end
+
+  def contain(value)
+    @xml_response.include? value
+  end
+  
+  # Returns Savon response
+  # response.body (body of response as Hash)
+  # response.header (head of response as Hash)
+  def response
+    @response
+  end
+
+  def status_code
+    @response.http.code
+  end
+
 end

data/lib/soaspec/hash_methods.rb

@@ -0,0 +1,29 @@
+
+# Override Hash class with convience methods
+class Hash
+
+  def self.transform_keys_to_symbols(value)
+    return value if not value.is_a?(Hash)
+    hash = value.inject({}){|memo,(k,v)| memo[k.to_sym] = Hash.transform_keys_to_symbols(v); memo}
+    return hash
+  end
+
+  # Take keys of hash and transform those to a symbols
+  def transform_keys_to_symbols
+    inject({}){|memo, (k, v)| memo[k.to_sym] = Hash.transform_keys_to_symbols(v); memo}
+  end
+
+  # Value present in nested Hash
+  def include_value?(value)
+    self.each_value do |v|
+      return true if v == value
+      if v.is_a? Hash
+        v.each_value do |v|
+          return true if v == value
+        end
+      end
+    end
+    false
+  end
+
+end

data/lib/soaspec/matchers.rb

@@ -1,17 +1,24 @@
-RSpec::Matchers.define :contain do |expected|
-  match do |actual|
-    expect(actual.xml_response).to include expected
-  end
-end
-
-RSpec::Matchers.define :have_element_at_xpath do |expected|
-  match do |soap_class|
-    expect(soap_class.xml_doc.at_xpath(expected, Soaspec::Environment.api_handler.namespaces).content).not_to be_empty
-  end
-end
-
-RSpec::Matchers.define :have_xpath_value do |expected_hash|
-  match do |soap_class|
-    expect(soap_class.xml_doc.at_xpath(expected_hash.keys.first, Soaspec::Environment.api_handler.namespaces).content).to eq expected_hash.values.first
-  end
+
+require_relative 'hash_methods'
+
+RSpec::Matchers.define :contain_value do |expected|
+  match do |actual|
+    expect(actual.response.body.include_value?(expected)).to be true
+  end
+
+  failure_message do |actual|
+    "expected that #{actual.response.body} would contain value #{expected}"
+  end
+end
+
+RSpec::Matchers.define :have_element_at_xpath do |expected|
+  match do |exchange|
+    expect(exchange.xml_doc.at_xpath(expected, Soaspec::Environment.api_handler.namespaces).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
+  end
 end