soaspec 0.0.30 → 0.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb181def6480766a52b057843a32f43f12aa1156
-  data.tar.gz: '0187e411bdbfb2d722063222d2c5e32001979cb6'
+  metadata.gz: e08d39845eefbfb87ab3a5b7b8e6ae80fa321d54
+  data.tar.gz: 7903a5ab815ef9d56c9b6223b1d945181c57317e
 SHA512:
-  metadata.gz: 8760fa3a0f1f639fa86c1c328b7d8afcb1acdd62a28ac87d8c1c4aab98018fdff1a5153ecbb63397339ca163a86275e6f2c8fecf519449aa3e08e0a5fd08f666
-  data.tar.gz: 63d3ce6daf896b56b3b2585430fba47879c529fb5fde312d44e3fdb948307f2a7d657c29995dfd07c02c9b04cbc945b24d380c7289bdcb15a3f2a7c9fb6a9e20
+  metadata.gz: ccf078e392801d2ff1686836701c4ded6afbb2166591ad543c6ba6fa7b54fa0946f637e5bfdb3401b0e90deb105751e01edc2040379295dc280bf64acded3528
+  data.tar.gz: 2d8c97db2287c39369b0e6258202a3b446aa4c4e4375fd35af46402daf2bab6d5f260d93934d31852d089073549f5b94b7168ae6b85b99477387055388352b12

data/ChangeLog

@@ -1,3 +1,8 @@
+Version 0.0.31 / 2018-3-8
+* Enhancements
+  * Compacted unit tests for exchange handler
+  * Implemented include_key? and find via xpath for REST handler. See specs
+
 Version 0.0.30 / 2018-3-6
 * Bug fix
    * Made generated class file name in soaspec-generate snakecase (was CamelCase)

data/Gemfile.lock

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

data/lib/soaspec.rb

@@ -8,16 +8,18 @@ require 'nokogiri' # XPath
 require 'date'
 
 require 'soaspec/version'
-require 'soaspec/basic_soap_handler'
-require 'soaspec/exchange_handler'
+require 'soaspec/exchange_handlers/soap_handler'
+require 'soaspec/exchange_handlers/exchange_handler'
 require 'soaspec/exchange'
 require 'soaspec/matchers'
 require 'soaspec/soaspec_shared_examples'
 require 'soaspec/hash_methods'
 require 'soaspec/spec_logger'
 require 'soaspec/exe_helpers'
-require 'soaspec/rest_handler'
+require 'soaspec/exchange_handlers/rest_handler'
 require 'soaspec/accessors'
+require 'soaspec/interpreter'
+require 'soaspec/not_found_errors'
 
 # Gem for handling SOAP and REST api tests
 module Soaspec

data/lib/soaspec/exchange.rb

@@ -39,7 +39,7 @@ class Exchange
   end
 
   # Extract value from path api class
-  # @param [String] path Path to return element for api class E.g - for SOAP this is XPath
+  # @param [Object] path Path to return element for api class E.g - for SOAP this is XPath string. For JSON, this is Hash dig Array
   # @return [String] Value at path
   def [](path)
     @api_class.value_from_path(self, path)

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

@@ -9,7 +9,7 @@ module Soaspec
 
     # Set instance variable name
     # @param [String, Symbol] name Name used when describing API test
-    # @param [Hash] options Parameters defining
+    # @param [Hash] options Parameters defining handler. Used in descendants
     def initialize(name, options)
       @name = name
     end
@@ -18,7 +18,7 @@ module Soaspec
     # @return [String] Name set upon initialisation
     def to_s
       Soaspec::Environment.api_handler = self
-      @name
+      @name.to_s
     end
 
     # Set the request option type and the template name

data/lib/soaspec/{rest_handler.rb → exchange_handlers/rest_handler.rb}

@@ -1,8 +1,9 @@
 
 require_relative 'exchange_handler'
-require_relative 'hash_methods'
-require_relative 'xpath_not_found'
-require_relative 'accessors'
+require_relative '../hash_methods'
+require_relative '../not_found_errors'
+require_relative '../accessors'
+require_relative '../interpreter'
 require 'json'
 require 'nori'
 
@@ -54,16 +55,10 @@ module Soaspec
     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
     # @param [Hash] override_parameters Params to characterize REST request
     def make_request(override_parameters)
@@ -103,25 +98,17 @@ module Soaspec
       response.body.include? expected
     end
 
+    # Whether the request found the desired value or not
     def found?(response)
-      response.code != 404
+      status_code_for(response) != 404
     end
 
     # Convert XML or JSON response into a Hash
     # @param [String] response Response as a String (either in XML or JSON)
     # @return [Hash]
     def extract_hash(response)
-      raise "Empty Body. Can't assert on it" if response.body.empty?
-      type = case response.body[0]
-             when '<'
-               :xml
-             when '{'
-               :json
-             else
-               :unknown
-             end
-
-      case type
+      raise ArgumentError("Empty Body. Can't assert on it") if response.body.empty?
+      case Interpreter.response_type_for response
       when :json
         JSON.parse(response.body).transform_keys_to_symbols
       when :xml
@@ -132,10 +119,17 @@ module Soaspec
       end
     end
 
+    # @return [Boolean] Whether response contains expected value
     def include_value?(response, expected)
       extract_hash(response).include_value? expected
     end
 
+    # @return [Boolean] Whether response body contains expected key
+    def include_key?(response, expected)
+      extract_hash(response).include_key? expected
+    end
+
+    # @return [Integer] HTTP Status code for response
     def status_code_for(response)
       response.code
     end
@@ -160,23 +154,44 @@ module Soaspec
     end
 
     # Returns the value at the provided xpath
-    def xpath_value_for(param)
+    # @param [Exchange] exchange
+    # @param [String] xpath
+    # @return [String] Value inside element found through Xpath
+    def xpath_value_for(exchange: nil, xpath: nil)
+      raise ArgumentError unless exchange && xpath
+      response = exchange.response
+      raise "Can't perform XPATH if response is not XML" unless Interpreter.response_type_for(response) == :xml
       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
+        if Soaspec::Environment.strip_namespaces? && !xpath.include?(':')
+          temp_doc = Nokogiri.parse response.body
+          temp_doc.remove_namespaces!
+          temp_doc.xpath(xpath).first
+        else
+          Nokogiri.parse(response.body).xpath(xpath).first
+        end
+      raise NoElementAtXpath, "No value at Xpath '#{xpath}'" unless result
       result.inner_text
     end
 
+    # Based on a exchange, return the value at the provided xpath
+    # If the path does not begin with a '/', a '//' is added to it
+    # @param [Exchange] exchange
+    # @param [Object] path Xpath or other path identifying how to find element
+    # @return [String] Value at Xpath
     def value_from_path(exchange, path)
-      path = '//' + path if path[0] != '/'
-      xpath_value_for(exchange: exchange, xpath: path)
+      case Interpreter.response_type_for(exchange.response)
+      when :xml
+        path = '//' + path if path[0] != '/'
+        xpath_value_for(exchange: exchange, xpath: path)
+      when :json
+        hash = extract_hash exchange.response
+        value = hash.dig(*path)
+        raise NoElementInHash, "Element in #{hash} not found with path '#{path}'" unless value
+        value
+      else
+        raise 'Unrecognised response message. Neither xml nor json detected'
+      end
+
     end
 
   end

data/lib/soaspec/{basic_soap_handler.rb → exchange_handlers/soap_handler.rb}

@@ -1,8 +1,9 @@
 
 require_relative 'exchange_handler'
-require_relative 'hash_methods'
-require_relative 'xpath_not_found'
-require_relative 'accessors'
+require_relative '../hash_methods'
+require_relative '../not_found_errors'
+require_relative '../accessors'
+require_relative '../interpreter'
 
 module Soaspec
 
@@ -73,20 +74,16 @@ module Soaspec
       options.merge! savon_options
       options.merge!(specific_options)
       @client = Savon.client(options)
+      @default_hash = {}
+      @request_option = :hash
       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
@@ -101,6 +98,8 @@ module Soaspec
       end
     end
 
+    # Set the default hash representing data to be used in making a request
+    # This will set the @request_option instance variable too
     def default_hash=(hash)
       @request_option = :hash
       @default_hash = Soaspec::Environment.always_use_keys? ? hash.transform_keys_to_symbols : hash
@@ -119,28 +118,51 @@ module Soaspec
       end
     end
 
+    # @return [Boolean] Whether the request found the desired value or not
+    def found?(response)
+      status_code_for(response) != 404
+    end
+
+    # Response status code for response. '200' indicates a success
+    # @param [Savon::Response] response
+    # @return [Integer] Status code
     def status_code_for(response)
       response.http.code
     end
 
+    # @return [Boolean] Whether response includes provided string within it
     def include_in_body?(response, expected)
       response.to_xml.to_s.include? expected
     end
 
+    # @return [Boolean] Whether response body contains expected key
+    def include_key?(response, expected)
+      response.body.include_key? expected
+    end
+
     # Returns the value at the provided xpath
-    def xpath_value_for(param)
+    # @param [Exchange] exchange
+    # @param [String] xpath
+    # @return [String] Value inside element found through Xpath
+    def xpath_value_for(exchange: nil, xpath: nil)
+      raise ArgumentError unless exchange && xpath
       result =
-        if Soaspec::Environment.strip_namespaces? && !param[:xpath].include?(':')
-          temp_doc = param[:exchange].response.doc
+        if Soaspec::Environment.strip_namespaces? && !xpath.include?(':')
+          temp_doc = exchange.response.doc
           temp_doc.remove_namespaces!
-          temp_doc.xpath(param[:xpath]).first
+          temp_doc.xpath(xpath).first
         else
-          param[:exchange].response.xpath(param[:xpath]).first
+          exchange.response.xpath(xpath).first
         end
-      raise NoElementAtXpath, "No value at Xpath '#{param[:xpath]}'" unless result
+      raise NoElementAtXpath, "No value at Xpath '#{xpath}'" unless result
       result.inner_text
     end
 
+    # Based on a exchange, return the value at the provided xpath
+    # If the path does not begin with a '/', a '//' is added to it
+    # @param [Exchange] exchange
+    # @param [String] path Xpath
+    # @return [String] Value at Xpath
     def value_from_path(exchange, path)
       path = '//' + path if path[0] != '/'
       xpath_value_for(exchange: exchange, xpath: path)
@@ -153,6 +175,7 @@ module Soaspec
 
   end
 
+  # Deprecated class name. Will be removed in the future
   class BasicSoapHandler < SoapHandler
 
     def initialize(name, specific_options = {})

data/lib/soaspec/interpreter.rb

@@ -0,0 +1,26 @@
+
+# Help interpret the general type of a particular object
+class Interpreter
+
+  # @param [Object] response API response
+  # @return [Symbol] Type of provided response
+  def self.response_type_for(response)
+    if response.is_a? String
+      case response.body[0]
+      when '<'
+        :xml
+      when '{'
+        :json
+      else
+        :unknown
+      end
+    elsif response.is_a? Hash
+      :hash
+    elsif response.is_a? Nokogiri::XML::NodeSet
+      :xml
+    else
+      :unknown
+    end
+  end
+
+end

data/lib/soaspec/matchers.rb

@@ -1,6 +1,6 @@
 
 require_relative 'hash_methods'
-require_relative 'xpath_not_found'
+require_relative 'not_found_errors'
 
 # TODO: Mathcers are specific to SOAP. Make generic for REST and others by using actual.api_class
 
@@ -10,9 +10,8 @@ RSpec::Matchers.define :contain_value do |expected|
     expect(actual.api_class.include_value?(actual.response, expected)).to be true
   end
 
-  # TODO: Fix this for REST
   failure_message do |actual|
-    "expected that #{actual.response.body} would contain value #{expected}"
+    "expected that #{actual.api_class.response_body(actual.response, format: :hash)} would contain value #{expected}"
   end
 end
 
@@ -22,31 +21,30 @@ RSpec::Matchers.define :include_in_body do |expected|
     expect(actual.api_class.include_in_body?(actual.response, expected)).to be true
   end
 
-  # TODO: Fix this for REST
   failure_message do |actual|
-    "expected that #{actual.response.body.to_xml} would contain value #{expected}"
+    "expected that #{actual.api_class.response_body(actual.response, format: :xml)} would contain value #{expected}"
   end
 end
 
 # Whether expected element exists in body
 RSpec::Matchers.define :contain_key do |expected|
   match do |actual|
-    expect(actual.response.body.include_key?(expected)).to be true
+    expect(actual.api_class.include_key?(actual.response, expected)).to be true
   end
 
   failure_message do |actual|
-    "expected that #{actual.response.body} would contain key #{expected}"
+    "expected that #{actual.api_class.response_body(actual.response, format: :hash)} would contain key #{expected}"
   end
 end
 
 # Whether an element exists at expected xpath
 RSpec::Matchers.define :have_element_at_xpath do |xpath|
   match do |exchange|
-    expect { exchange[xpath] }.to_not raise_error
+    expect { exchange[xpath] }.to_not raise_error # Error will be raised if XPath returns no value
   end
 
   failure_message do |actual|
-    "expected that #{actual.response.to_xml} would have element at xpath '#{xpath}'"
+    "expected that #{actual.api_class.response_body(actual.response, format: :xml)} would have element at xpath '#{xpath}'"
   end
 end
 

data/lib/soaspec/not_found_errors.rb

@@ -0,0 +1,14 @@
+
+# Raised to represent when there's no element at an Xpath
+class NoElementAtXpath < StandardError
+  def initialize(msg="No element at Xpath found")
+    super
+  end
+end
+
+# Did not find any element by provided key in the Hash
+class NoElementInHash < StandardError
+  def initialize(msg='No element in Hash found')
+    super
+  end
+end

data/lib/soaspec/soaspec_shared_examples.rb

@@ -10,7 +10,7 @@ shared_examples_for 'success scenario' do
         expect(described_class).to contain_key mandatory_element
       end
     end
-    # TODO: Remove this. Handle depracated method temporariliy
+    # TODO: Remove this. Handle deprecated method temporarily
     described_class.api_class.mandatory_elements.each do |mandatory_element|
       puts "Overriding 'mandatory_elements' deprecated. Use new 'expected_mandatory_elements' instead of overriding this method"
       it mandatory_element do

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.0.30'
+  VERSION = '0.0.31'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.0.30
+  version: 0.0.31
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-06 00:00:00.000000000 Z
+date: 2018-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -152,17 +152,18 @@ files:
 - exe/xml_to_yaml_file
 - lib/soaspec.rb
 - lib/soaspec/accessors.rb
-- lib/soaspec/basic_soap_handler.rb
 - lib/soaspec/exchange.rb
-- lib/soaspec/exchange_handler.rb
+- lib/soaspec/exchange_handlers/exchange_handler.rb
+- lib/soaspec/exchange_handlers/rest_handler.rb
+- lib/soaspec/exchange_handlers/soap_handler.rb
 - lib/soaspec/exe_helpers.rb
 - lib/soaspec/hash_methods.rb
+- lib/soaspec/interpreter.rb
 - lib/soaspec/matchers.rb
-- lib/soaspec/rest_handler.rb
+- lib/soaspec/not_found_errors.rb
 - lib/soaspec/soaspec_shared_examples.rb
 - lib/soaspec/spec_logger.rb
 - lib/soaspec/version.rb
-- lib/soaspec/xpath_not_found.rb
 - soaspec.gemspec
 - template/soap_template.xml
 - test.wsdl

data/lib/soaspec/xpath_not_found.rb

@@ -1,7 +0,0 @@
-
-# Raised to represent when there's no element at an Xpath
-class NoElementAtXpath < StandardError
-  def initialize(msg="No element Xpath not found")
-    super
-  end
-end