soaspec 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 648bba6578889b06fd5b8c3a1871e2dff381eb5e
-  data.tar.gz: 8b508b96c93f1928a222c3c7a4980d23438aae12
+  metadata.gz: 9fa5a1248a62fb5ce03d9b24d914dfa98c978e28
+  data.tar.gz: 601743d42c8399edb5a34e82c9569a35b7f7522e
 SHA512:
-  metadata.gz: b76fcbd53b8be2780a0dc64af8cf59a04ac07b1e68c91ffdb9814aeea3e4cbdc442510ef88a88991d1c914b011a567d4b260b8a07e22c52e95e419f57d9e3616
-  data.tar.gz: 18e2478c0df3c22b3c247fb2ffe974987bb5a1e14979c67ce049d056889d6cab944945a486069906774fc30ce32798d3a64d3f71afb5cfa0a1303d4d0ea6f819
+  metadata.gz: a3237657f1be3b97ecd7de2fe1f093fe7d024cf18b0d4f8e51879595b5aa7218270fd83eca07da23f2bf354c92625263c89ece87f7fd5664c59099593c4e06e1
+  data.tar.gz: a8d4aab8cbf8825512e197915655277e64033c453d346b5bca10c2ea7623a668282a481f47caf4c666e52d5890e852af50cf42c6eddd9819c8159bb93afe9f61

data/ChangeLog

@@ -1,9 +1,14 @@
+Version 0.0.10 / 2018-1-21
+* Enhancements
+  * Added [] method to perform xpath assertion
+  * Using Savon xpath. No need to explicitly provide namespace for xpath
+
 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
+  * Made mandatory_xpath_values method to add to 'success scenarios' shared example
 
 Version 0.0.8 / 2018-1-19
 * Enhancements

data/Gemfile

@@ -4,10 +4,11 @@ git_source(:gitlab) { |repo_name| "https://gitlab.com/samuel-garratt/soaspec" }
 
 # Specify your gem's dependencies in soaspec.gemspec
 gemspec
-gem 'rspec'
 gem 'rest-client'
 gem 'savon'
 gem 'require_all'
 gem 'nokogiri'
 gem 'rake', '12.2.1'
+gem 'rspec'
+gem 'rspec-its'
 gem 'rspec_junit_formatter'

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    soaspec (0.0.9)
+    soaspec (0.0.10)
       rest-client (>= 2.0)
       rspec (~> 3.0)
+      rspec-its (>= 1.2.0)
       savon (>= 2)
 
 GEM
@@ -55,6 +56,9 @@ GEM
     rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
     rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
@@ -89,6 +93,7 @@ DEPENDENCIES
   require_all
   rest-client
   rspec
+  rspec-its
   rspec_junit_formatter
   savon
   soaspec!

data/lib/soaspec.rb

@@ -2,12 +2,12 @@ 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/common'
 require 'soaspec/basic_soap_handler'
 require 'soaspec/tester'
 require 'soaspec/exchange'

data/lib/soaspec/basic_soap_handler.rb

@@ -1,6 +1,5 @@
 
 require 'yaml'
-require_relative 'common'
 require_relative 'tester'
 require_relative 'hash_methods'
 
@@ -9,8 +8,6 @@ module Soaspec
   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 :operation
 
@@ -57,7 +54,6 @@ module Soaspec
       options.merge! savon_options
       options.merge!(specific_options)
       @client = Savon.client(options)
-      self.namespaces = {}
       @name = name
     end
 
@@ -91,10 +87,6 @@ module Soaspec
       @name
     end
 
-    def include?(value)
-      @xml_response.include? value
-    end
-
     def default_hash=(hash)
       @request_option = :hash
       @default_hash = hash
@@ -123,5 +115,16 @@ module Soaspec
       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
 end

data/lib/soaspec/exchange.rb

@@ -3,10 +3,6 @@ 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
@@ -23,10 +19,6 @@ class Exchange
   # @return [String] Name given when initializing
   def to_s
     @response = make_request
-    if @api_class.class < Soaspec::BasicSoapHandler
-      @xml_response = @response.to_xml
-      @xml_doc = @response.doc
-    end
     @test_name
   end
 
@@ -40,15 +32,25 @@ class Exchange
     @api_class.mandatory_xpath_values
   end
 
-  # Returns Savon response
+  # Returns response object from Api
+  # For example for SOAP it will be a Savon response
   # response.body (body of response as Hash)
   # response.header (head of response as Hash)
   def response
     @response
   end
 
+  # Get status code from api class. This is http response for Web Api
+  # @return [Integer] Status code from api class
   def status_code
     @api_class.status_code_for(@response)
   end
 
+  # Extract value from path api class
+  # @param [String] path Path to return element for api class E.g - for SOAP this is XPath
+  # @return [String] Value at path
+  def [](path)
+    @api_class.value_from_path(self, path)
+  end
+
 end

data/lib/soaspec/hash_methods.rb

@@ -47,4 +47,25 @@ class Hash
     result != []
   end
 
+  # 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/matchers.rb

@@ -1,13 +1,6 @@
 
 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
@@ -30,13 +23,13 @@ end
 
 RSpec::Matchers.define :have_element_at_xpath do |xpath|
   match do |exchange|
-    expect(xpath_for(exchange: exchange, xpath: xpath).content).not_to be_empty
+    expect(exchange[xpath]).not_to be_empty
   end
 end
 
 RSpec::Matchers.define :have_xpath_value do |expected_hash|
   match do |exchange|
-    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
+    expected_hash = Hash[*expected_hash.flatten] if expected_hash.is_a?(Array) # For some reason Array was occuring
+    expect(exchange[expected_hash.keys.first]).to eq expected_hash.values.first
   end
 end

data/lib/soaspec/shared_examples.rb

@@ -11,9 +11,9 @@ shared_examples_for 'success scenario' do
       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 }
+  described_class.mandatory_xpath_values.each do |xpath, value|
+    it "has xpath '#{xpath}' equal to '#{value}'" do
+      expect(described_class).to have_xpath_value(xpath => value)
     end
   end
 end

data/lib/soaspec/tester.rb

@@ -1,6 +1,5 @@
 
 require 'yaml'
-require_relative 'common'
 
 module Soaspec
   # Has basic methods common for methods defining RSpec tests in YAML

data/lib/soaspec/version.rb

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

data/soaspec.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Helps to create RSpec specs for SOAP or REST apis }
   spec.description   = %q{Helps to create RSpec specs for SOAP or REST apis. Easily represent multiple requests with
-the same  }
+the same configuration }
   spec.homepage      = 'https://gitlab.com/samuel-garratt/soaspec'
   spec.license       = 'MIT'
 
@@ -27,6 +27,7 @@ the same  }
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_dependency 'rest-client', '>= 2.0' # REST
   spec.add_dependency 'rspec', '~> 3.0' # This framework is designed to work with RSpec
+  spec.add_dependency 'rspec-its', '>= 1.2.0'
   spec.add_dependency 'savon', '>= 2' # SOAP
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-20 00:00:00.000000000 Z
+date: 2018-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
 description: "Helps to create RSpec specs for SOAP or REST apis. Easily represent
-  multiple requests with\nthe same  "
+  multiple requests with\nthe same configuration "
 email:
 - samuel.garratt@integrationqa.com
 executables:
@@ -118,7 +132,6 @@ files:
 - exe/soaspec-init
 - lib/soaspec.rb
 - lib/soaspec/basic_soap_handler.rb
-- lib/soaspec/common.rb
 - lib/soaspec/exchange.rb
 - lib/soaspec/hash_methods.rb
 - lib/soaspec/matchers.rb

data/lib/soaspec/common.rb

@@ -1,24 +0,0 @@
-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