soaspec 0.0.25 → 0.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c1bcd1af7218c1860476c8b8c71d8cb97236640
-  data.tar.gz: ac9d54164f634b5887a22eb87779eb8e34c366b0
+  metadata.gz: f1a29b66931af96e20a87509ba9a1bf8e962c9de
+  data.tar.gz: 382f40037e5b95d6042ae733e2521f59ee27d8b0
 SHA512:
-  metadata.gz: 16d7b2d861828838632b0ae50645b7ec87a55a63bef9513d626cfa4434e1db3c2b04b35edb58e217c40e7673acdbfa89979da4c6d9e88586b9c46e76ef07a8b3
-  data.tar.gz: 3bcd6ae8198b0dc230dd4fe0a12ed219248a276a5e9a7f04b04a2317512cf838e2419ddbb11a749d72f4011655071ed7b5b06b68d7cfd495e71dbfa501041bfe
+  metadata.gz: d120628f376d440e1975c42dc1f9197db934b8117296dac4b365ccdf49353bc2e9b79dc4f1968d8d0945a7bdacfd50767dd8519cb38398346c36421de2d639b8
+  data.tar.gz: 4e146610d9e218227cca8a8625b577f660184fe5d09edcd6d67e24eefbdd78bf18d233bb4cdd32c5e83f7835a46d787fbd54b7ac0a5fdb40ef909517f171fe07

data/ChangeLog

@@ -1,3 +1,7 @@
+Version 0.0.26 / 2018-3-5
+* Refactorings
+   * Using methods to define mandatory_elements, mandatory_xpath_values, root_attributes, base_url. Please see specs. This is shorter to type and clearer
+
 Version 0.0.25 / 2018-2-25
 * Enhancements
   * Updated rest_handler to convert JSON and XML into Hash and use it in 'contain_value'. This still needs work.

data/Gemfile.lock

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

data/lib/soaspec/accessors.rb

@@ -0,0 +1,23 @@
+module Soaspec
+  # Describes methods test handlers use to easily set attributes
+  # Some are included in 'success scenarios' and to configure the request sent
+  module Accessors
+
+    # Defines expected_mandatory_elements method used in 'success_scenarios' shared examples
+    # to indicate certain elements must be present
+    # @param [Array] elements Array of symbols specifying expected element names for 'success_scearios' in snakecase
+    def mandatory_elements(elements)
+      define_method('expected_mandatory_elements') do
+        elements
+      end
+    end
+
+    def mandatory_xpath_values(xpath_value_pairs)
+      raise ArgumentError('Hash of {xpath => expected values} expected ') unless xpath_value_pairs.is_a? Hash
+      define_method('expected_mandatory_xpath_values') do
+        xpath_value_pairs
+      end
+    end
+
+  end
+end

data/lib/soaspec/basic_soap_handler.rb

@@ -2,15 +2,35 @@
 require_relative 'tester'
 require_relative 'hash_methods'
 require_relative 'xpath_not_found'
+require_relative 'accessors'
 
 module Soaspec
+
+  # Accessors specific to SOAP handler
+  module SoapAccessors
+
+    def root_attributes(attributes)
+      define_method('request_root_attributes') do
+        attributes
+      end
+    end
+  end
+
   # Wraps around Savon client defining default values dependent on the soap request
   class BasicSoapHandler < Tester
+    extend Soaspec::Accessors
+    extend Soaspec::SoapAccessors
+
     # Savon client used to make SOAP calls
     attr_accessor :client
     # SOAP Operation to use by default
     attr_accessor :operation
 
+    # Attributes set at the root XML element of SOAP request
+    def request_root_attributes
+      nil
+    end
+
     # Options to log xml request and response
     def logging_options
       {
@@ -77,7 +97,7 @@ module Soaspec
         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)
+        @client.call(operation, message: @default_hash.merge(test_values), attributes: request_root_attributes)
       end
     end
 
@@ -90,29 +110,10 @@ module Soaspec
       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
-
     def include_in_body?(response, expected)
       response.to_xml.to_s.include? expected
     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 =

data/lib/soaspec/exchange.rb

@@ -25,16 +25,6 @@ class Exchange
     @test_name
   end
 
-  # Elements a shared 'success scenario' is expected to have
-  def mandatory_elements
-    @api_class.mandatory_elements
-  end
-
-  # Elements a shared 'success scenario' is expected to have
-  def mandatory_xpath_values
-    @api_class.mandatory_xpath_values
-  end
-
   # Returns response object from Api
   # For example for SOAP it will be a Savon response
   # response.body (body of response as Hash)

data/lib/soaspec/rest_handler.rb

@@ -2,40 +2,41 @@
 require_relative 'tester'
 require_relative 'hash_methods'
 require_relative 'xpath_not_found'
+require_relative 'accessors'
 require 'json'
 require 'nori'
 
 module Soaspec
+
+  # Accessors specific to REST handler
+  module RestAccessors
+
+    # Defines method 'base_url_value' containing base URL used in REST requests
+    # @param [String] url Base Url to use in REST requests. Suburl is appended to this
+    def base_url(url)
+      define_method('base_url_value') do
+        url
+      end
+    end
+  end
+
   # Wraps around Savon client defining default values dependent on the soap request
   class RestHandler < Tester
+    extend Soaspec::RestAccessors
+    extend Soaspec::Accessors
+
     # 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
-      {
-           # See request and response. (Put this in traffic file)
-      }
-    end
-
-    # Default Savon options. See https://github.com/rest-client/rest-client for details
-    # @return [Hash] Default Savon options for all BasicSoapHandler
-    def default_options
-      {
-          # method: :get
-          # headers: { content_type: 'text/plain' }
-      }
-    end
-
-    # Override in class
-    def base_url
-      ''
+    # Set through following method. Base URL in REST requests.
+    def base_url_value
+      nil
     end
 
     # Add values to here when extending this class to have default REST options.
-    # See rest client resource for details
+    # See rest client resource at https://github.com/rest-client/rest-client for details
     # @return [Hash] Options adding to & overriding defaults
     def rest_resource_options
       {
@@ -45,10 +46,10 @@ module Soaspec
     # Setup object to handle communicating with a particular SOAP WSDL
     # @param [Hash] specific_options Options defining SOAP request. WSDL, authentication
     def initialize(name, specific_options = {})
-      options = default_options.merge logging_options
-      options.merge! rest_resource_options
+      raise "Base URL not set! Please set in class with 'base_url' method" unless base_url_value
+      options = rest_resource_options
       options.merge!(specific_options)
-      @resource = RestClient::Resource.new(base_url, options) # @resource[url_extension].get
+      @resource = RestClient::Resource.new(base_url_value, options) # @resource[url_extension].get
       super
     end
 
@@ -92,6 +93,8 @@ module Soaspec
     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]
@@ -107,7 +110,7 @@ module Soaspec
       when :json
         JSON.parse(response.body).transform_keys_to_symbols
       when :xml
-        parser = Nori.new(:convert_tags_to => lambda { |tag| tag.snakecase.to_sym })
+        parser = Nori.new(convert_tags_to: lambda { |tag| tag.snakecase.to_sym })
         parser.parse(response.body)
       else
         raise "Neither XML nor JSON detected. It is #{type}. Don't know how to parse It is #{response.body}"

data/lib/soaspec/soaspec_shared_examples.rb

@@ -5,13 +5,27 @@ shared_examples_for 'success scenario' do
     expect(described_class.status_code).to eq 200
   end
   context 'has expected mandatory elements' do
-    described_class.mandatory_elements.each do |mandatory_element|
+    described_class.api_class.expected_mandatory_elements.each do |mandatory_element|
       it mandatory_element do
         expect(described_class).to contain_key mandatory_element
       end
     end
+    # TODO: Remove this. Handle depracated method temporariliy
+    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
+        expect(described_class).to contain_key mandatory_element
+      end
+    end
+  end
+  described_class.api_class.expected_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
-  described_class.mandatory_xpath_values.each do |xpath, value|
+  # TODO: Remove deprecated method
+  described_class.api_class.mandatory_xpath_values.each do |xpath, value|
+    puts "Overriding 'mandatory_elements' deprecated. Use new 'expected_mandatory_elements' instead of overriding this method"
     it "has xpath '#{xpath}' equal to '#{value}'" do
       expect(described_class).to have_xpath_value(xpath => value)
     end

data/lib/soaspec/tester.rb

@@ -27,5 +27,29 @@ module Soaspec
       @template_name = name
     end
 
+    # Will be used in 'success_scenarios' shared examples.
+    # Set though 'mandatory_elements' method
+    # @return [Array] Array of symbols specifying element names
+    def expected_mandatory_elements
+      []
+    end
+
+    # Use this to set 'expected_mandatory_elements' see 'accessors'
+    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 expected_mandatory_xpath_values
+      {}
+    end
+
+    # Use this to set 'expected_mandatory_xpath_values' see 'accessors'
+    def mandatory_xpath_values
+      []
+    end
+
   end
 end

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.0.25'
+  VERSION = '0.0.26'
 end

data/lib/soaspec.rb

@@ -17,7 +17,7 @@ require 'soaspec/hash_methods'
 require 'soaspec/spec_logger'
 require 'soaspec/exe_helpers'
 require 'soaspec/rest_handler'
-
+require 'soaspec/accessors'
 
 # Gem for handling SOAP and REST api tests
 module Soaspec

data/test.rb

@@ -0,0 +1,28 @@
+
+module TestM
+  def do_something(text)
+    define_method('hi') do
+      puts 'hi' + text
+    end
+  end
+end
+
+class BaseTest
+  extend TestM
+end
+
+class Tester < BaseTest
+
+  do_something('sam')
+end
+
+class Tes < BaseTest
+  do_something 'dsfd'
+end
+
+test = Tester.new
+
+coll = Tes.new
+
+test.hi
+coll.hi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.0.26
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2018-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,6 +151,7 @@ files:
 - exe/soaspec-init
 - exe/xml_to_yaml_file
 - lib/soaspec.rb
+- lib/soaspec/accessors.rb
 - lib/soaspec/basic_soap_handler.rb
 - lib/soaspec/exchange.rb
 - lib/soaspec/exe_helpers.rb
@@ -164,6 +165,7 @@ files:
 - lib/soaspec/xpath_not_found.rb
 - soaspec.gemspec
 - template/soap_template.xml
+- test.rb
 - test.wsdl
 - test.xml
 - test_rest.rb