soaspec 0.0.45 → 0.0.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c4fe1e31ed200c99604632c3cedf641b493f72f
-  data.tar.gz: c48fc1bf2c281a6fadc6bd64752c6c86222d6bd1
+  metadata.gz: f81e429ef1b144e0977520e79fd5ae9890bf3a89
+  data.tar.gz: ed934b5fcddfee84837c3dbedfd4b90b424377e5
 SHA512:
-  metadata.gz: cddc01b446e5cafab7caab1e33130ec3d57fc3d42b685fd57db2216b59e25750e09952f4777815e23cce726ebbeaf9340c0918984ff76ac925eea5776c54262d
-  data.tar.gz: 91e7826c080dd542f9363dd06d89ffdc4bff5ffa612f37a4febc7602d8d8dafdff89d75b0c8791271d6fab558d142cba74766322cbbda8811a0aa333852dcefe
+  metadata.gz: a64529f623d73ffe61da1c0d0ed28725d19ee4d26563ff804c24f7ea3c36dba203947a216169b3570d1df8b88a3e97e0e10a3de54e71a568da13caacc935ca34
+  data.tar.gz: 0b1f8d43be55b3a7a810a5968894093a8d42bebd0e51d46b25921f787c1f8763cf7afc2bafa3fdea97962678ca6dd52f61737c857ca327fff473999fc1fe355a

data/ChangeLog

@@ -1,3 +1,7 @@
+Version 0.0.46
+* Enhancements
+  * 'include_key?' method use 'value_from_path'. Iterating through Hashes with 'include_key?' wouldn't work as expected with some JSON bodies with my current implementation
+
 Version 0.0.45
 * Enhancements
   * No need to use 'name' when creating SoapHandler and RestHandler. Default is ClassName

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    soaspec (0.0.45)
+    soaspec (0.0.46)
       jsonpath
       rest-client (>= 2.0)
       rspec (~> 3.0)

data/lib/soaspec/exchange.rb

@@ -94,7 +94,7 @@ class Exchange
   # @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)
+    @api_class.value_from_path(response, path)
   end
 
 end

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -174,7 +174,7 @@ module Soaspec
 
     # @return [Boolean] Whether response body contains expected key
     def include_key?(response, expected)
-      extract_hash(response).include_key? expected
+      value_from_path(response, expected)
     end
 
     # @return [Integer] HTTP Status code for response
@@ -202,12 +202,11 @@ module Soaspec
     end
 
     # Returns the value at the provided xpath
-    # @param [Exchange] exchange
+    # @param [RestClient::Response] response
     # @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
+    def xpath_value_for(response: nil, xpath: nil)
+      raise ArgumentError unless response && xpath
       raise "Can't perform XPATH if response is not XML" unless Interpreter.response_type_for(response) == :xml
       result =
         if Soaspec.strip_namespaces? && !xpath.include?(':')
@@ -217,29 +216,29 @@ module Soaspec
         else
           Nokogiri.parse(response.body).xpath(xpath).first
         end
-      raise NoElementAtXpath, "No value at Xpath '#{xpath}'" unless result
+      raise NoElementAtPath, "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
+    # @param [Object] path Xpath, JSONPath or other path identifying how to find element
     # @return [String] Value at Xpath
-    def value_from_path(exchange, path)
-      case Interpreter.response_type_for(exchange.response)
+    def value_from_path(response, path)
+      path = path.to_s
+      case Interpreter.response_type_for(response)
       when :xml
         path = '//' + path if path[0] != '/'
-        xpath_value_for(exchange: exchange, xpath: path)
+        xpath_value_for(response: response, xpath: path)
       when :json
         path = '$..' + path if path[0] != '$'
-        matching_values = JsonPath.on(exchange.response.body, path)
-        raise NoElementInHash, "Element in #{exchange.response.body} not found with path '#{path}'" if matching_values.empty?
+        matching_values = JsonPath.on(response.body, path)
+        raise NoElementAtPath, "Element in #{response.body} not found with path '#{path}'" if matching_values.empty?
         matching_values.first
       else
         raise 'Unrecognised response message. Neither xml nor json detected'
       end
-
     end
 
     # Convenience methods for once off usage of a REST request

data/lib/soaspec/exchange_handlers/soap_handler.rb

@@ -119,7 +119,7 @@ module Soaspec
       when :hash
         response.body
       when :raw
-        response.body.to_xml
+        response.xml
       else
         response.body
       end
@@ -148,31 +148,31 @@ module Soaspec
     end
 
     # Returns the value at the provided xpath
-    # @param [Exchange] exchange
+    # @param [Savon::Response] response
     # @param [String] xpath
     # @return [String] Value inside element found through Xpath
-    def xpath_value_for(exchange: nil, xpath: nil)
-      raise ArgumentError unless exchange && xpath
+    def xpath_value_for(response: nil, xpath: nil)
+      raise ArgumentError unless response && xpath
       result =
         if Soaspec.strip_namespaces? && !xpath.include?(':')
-          temp_doc = exchange.response.doc
+          temp_doc = response.doc
           temp_doc.remove_namespaces!
           temp_doc.xpath(xpath).first
         else
-          exchange.response.xpath(xpath).first
+          response.xpath(xpath).first
         end
-      raise NoElementAtXpath, "No value at Xpath '#{xpath}'" unless result
+      raise NoElementAtPath, "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 [Savon::Response] response
     # @param [String] path Xpath
     # @return [String] Value at Xpath
-    def value_from_path(exchange, path)
+    def value_from_path(response, path)
       path = '//' + path if path[0] != '/'
-      xpath_value_for(exchange: exchange, xpath: path)
+      xpath_value_for(response: response, xpath: path)
     end
 
     # Whether any of the keys of the Body Hash include value

data/lib/soaspec/matchers.rb

@@ -27,20 +27,20 @@ RSpec::Matchers.define :include_in_body do |expected|
 end
 
 # Whether expected element exists in body
-RSpec::Matchers.define :contain_key do |expected|
+RSpec::Matchers.define :contain_key do |path|
   match do |actual|
-    expect(actual.api_class.include_key?(actual.response, expected)).to be true
+    expect(actual).to have_element_at_path path
   end
 
   failure_message do |actual|
-    "expected that #{actual.api_class.response_body(actual.response, format: :hash)} would contain key #{expected}"
+    "expected that #{actual.api_class.response_body(actual.response, format: :hash)} would contain key #{path}"
   end
 end
 
 # Whether an element exists at expected xpath
-RSpec::Matchers.define :have_element_at_xpath do |xpath|
+RSpec::Matchers.define :have_element_at_path do |xpath|
   match do |exchange|
-    expect { exchange[xpath] }.to_not raise_error # Error will be raised if XPath returns no value
+    expect { exchange[xpath] }.to_not raise_error # Error will be raised if Path returns no value
   end
 
   failure_message do |actual|
@@ -48,7 +48,7 @@ RSpec::Matchers.define :have_element_at_xpath do |xpath|
   end
 end
 
-RSpec::Matchers.alias_matcher :have_element_at_path, :have_element_at_xpath
+RSpec::Matchers.alias_matcher :have_element_at_xpath, :have_element_at_path
 
 # Whether an element at xpath (defined by key) has value (defined by value).
 # @param [Hash] expected_hash Xpath => Value pair (e.g. '//xmlns:GetWeatherResult' => 'Data Not Found')

data/lib/soaspec/not_found_errors.rb

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

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.0.45'
+  VERSION = '0.0.46'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.0.45
+  version: 0.0.46
 platform: ruby
 authors:
 - SamuelGarrattIQA