soaspec 0.2.8 → 0.2.9

data/lib/soaspec/exchange_handlers/response_extractor.rb

@@ -0,0 +1,55 @@
+module Soaspec
+  # Enables extracting a response according to type / path
+  module ResponseExtractor
+    # Convert XML or JSON response into a Hash. Doesn't accept empty body
+    # @param [String] response Response as a String (either in XML or JSON)
+    # @return [Hash] Extracted Hash from response
+    def extract_hash(response)
+      raise NoElementAtPath, "Empty Body. Can't assert on it" if response.body.empty?
+
+      case Interpreter.response_type_for response
+      when :xml then parse_xml(response.body.to_s)
+      when :json
+        converted = JSON.parse(response.body)
+        return converted.transform_keys_to_symbols if converted.is_a? Hash
+        return converted.map!(&:transform_keys_to_symbols) if converted.is_a? Array
+
+        raise 'Incorrect Type produced ' + converted.class
+      else
+        raise "Neither XML nor JSON detected. It is #{type}. Don't know how to parse It is #{response.body}"
+      end
+    end
+
+    # @return [Hash] Hash representing response body
+    def to_hash(response)
+      case Interpreter.response_type_for(response)
+      when :xml then parse_xml(response.body.to_s)
+      when :json
+        JSON.parse(response.body.to_s)
+      else
+        raise "Unable to interpret type of #{response.body}"
+      end
+    end
+
+    private
+
+    # @param [String] xml XML to convert
+    # @return [Hash] Hash representing XML
+    def parse_xml(xml)
+      parser = Nori.new(strip_namespaces: strip_namespaces?, convert_tags_to: ->(tag) { tag.snakecase.to_sym })
+      parser.parse(xml)
+    end
+
+    # This enables shortcut xpaths to be used. If no '/' is given, one is appended to the start of the path
+    # If attribute value is set then this is also adjusted
+    # @return [String] New Xpath adjusted according to any add ons
+    def prefix_xpath(xpath, attribute)
+      xpath = "//*[@#{attribute}]" unless attribute.nil?
+      if xpath[0] != '/'
+        xpath = convert_to_pascal_case(xpath) if pascal_keys?
+        xpath = '//' + xpath
+      end
+      xpath
+    end
+  end
+end

data/lib/soaspec/exchange_handlers/rest_exchanger_factory.rb

@@ -106,4 +106,4 @@ module Soaspec
       end
     end
   end
-end
+end

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -6,6 +6,7 @@ require_relative '../core_ext/hash'
 require_relative '../not_found_errors'
 require_relative 'handler_accessors'
 require_relative '../interpreter'
+require_relative 'response_extractor'
 require 'json'
 require 'jsonpath'
 require 'nori'
@@ -14,6 +15,7 @@ require 'erb'
 module Soaspec
   # Wraps around Savon client defining default values dependent on the soap request
   class RestHandler < ExchangeHandler
+    include ResponseExtractor
     extend Soaspec::RestParameters
     include Soaspec::RestParametersDefaults
     extend Soaspec::RestExchangeFactory
@@ -25,6 +27,7 @@ module Soaspec
     # @param [Hash] options Options defining REST request. base_url, default_hash
     def initialize(name = self.class.to_s, options = {})
       raise "Base URL not set! Please set in class with 'base_url' method" unless base_url_value
+
       if name.is_a?(Hash) && options == {} # If name is not set, use first parameter as the options hash
         options = name
         name = self.class.to_s
@@ -87,6 +90,7 @@ module Soaspec
     def parse_headers
       Hash[rest_client_headers.map do |header_name, header_value|
         raise ArgumentError, "Header '#{header_name}' is null. Headers are #{rest_client_headers}" if header_value.nil?
+
         [header_name, ERB.new(header_value).result(binding)]
       end]
     end
@@ -94,6 +98,7 @@ module Soaspec
     # Convert snakecase to PascalCase
     def convert_to_pascal_case(key)
       return key if /[[:upper:]]/ =~ key[0] # If first character already capital, don't do conversion
+
       key.split('_').map(&:capitalize).join
     end
 
@@ -104,9 +109,7 @@ module Soaspec
       options.merge! basic_auth_params if respond_to? :basic_auth_params
       options[:headers] ||= {}
       options[:headers].merge! parse_headers
-      if Soaspec.auto_oauth && respond_to?(:access_token)
-        options[:headers][:authorization] ||= ERB.new('Bearer <%= access_token %>').result(binding)
-      end
+      options[:headers][:authorization] ||= ERB.new('Bearer <%= access_token %>').result(binding) if Soaspec.auto_oauth && respond_to?(:access_token)
       options.merge(@init_options)
     end
 
@@ -143,16 +146,14 @@ module Soaspec
 
     # Returns the value at the provided xpath
     # @param [RestClient::Response] response
-    # @param [String] xpath
+    # @param [String] xpath Path to find elements from
+    # @param [String] attribute Attribute to find path for
     # @return [Enumerable] Value inside element found through Xpath
     def xpath_elements_for(response: nil, xpath: nil, attribute: nil)
       raise ArgumentError unless response && xpath
       raise "Can't perform XPATH if response is not XML" unless Interpreter.response_type_for(response) == :xml
-      xpath = "//*[@#{attribute}]" unless attribute.nil?
-      if xpath[0] != '/'
-        xpath = convert_to_pascal_case(xpath) if pascal_keys?
-        xpath = '//' + xpath
-      end
+
+      xpath = prefix_xpath(xpath, attribute)
       temp_doc = Nokogiri.parse(response.body).dup
       if strip_namespaces? && !xpath.include?(':')
         temp_doc.remove_namespaces!
@@ -165,6 +166,7 @@ module Soaspec
     # @return [Enumerable] List of values matching JSON path
     def json_path_values_for(response, path, attribute: nil)
       raise 'JSON does not support attributes' if attribute
+
       if path[0] != '$'
         path = convert_to_pascal_case(path) if pascal_keys?
         path = '$..' + path
@@ -183,8 +185,9 @@ module Soaspec
       case Interpreter.response_type_for(response)
       when :xml
         result = xpath_elements_for(response: response, xpath: path, attribute: attribute).first
-        raise NoElementAtPath, "No value at Xpath '#{path}'" unless result
+        raise NoElementAtPath, "No value at Xpath '#{prefix_xpath(path, attribute)}'" unless result
         return result.inner_text if attribute.nil?
+
         return result.attributes[attribute].inner_text
       when :json
         paths_to_check = path.split(',')
@@ -192,11 +195,13 @@ module Soaspec
           json_path_values_for(response, path_to_check, attribute: attribute)
         end.reject(&:empty?)
         raise NoElementAtPath, "Path '#{path}' not found in '#{response.body}'" if matching_values.empty?
+
         matching_values.first.first
       when :hash
         response.dig(path.split('.')) # Use path as Hash dig expression separating params via '.' TODO: Unit test
       else
         raise NoElementAtPath, 'Response is empty' if response.to_s.empty?
+
         response.to_s[/path/] # Perform regular expression using path if not XML nor JSON TODO: Unit test
       end
     end
@@ -214,42 +219,10 @@ module Soaspec
       end
     end
 
-    # TODO: This and 'to_hash' method should be merged
-    # 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 NoElementAtPath, "Empty Body. Can't assert on it" if response.body.empty?
-      case Interpreter.response_type_for response
-      when :json
-        converted = JSON.parse(response.body)
-        return converted.transform_keys_to_symbols if converted.is_a? Hash
-        return converted.map!(&:transform_keys_to_symbols) if converted.is_a? Array
-        raise 'Incorrect Type produced ' + converted.class
-      when :xml
-        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}"
-      end
-    end
-
-    # @return [Hash] Hash representing response body
-    def to_hash(response)
-      case Interpreter.response_type_for(response)
-      when :xml
-        parser = Nori.new(strip_namespaces: strip_namespaces?, convert_tags_to: ->(tag) { tag.snakecase.to_sym })
-        parser.parse(response.body.to_s)
-      when :json
-        JSON.parse(response.body.to_s)
-      else
-        raise "Unable to interpret type of #{response.body}"
-      end
-    end
-
     # @response [RestClient::Request] Request of API call. Either intended request or actual request
     def request(response)
       return 'Request not yet sent' if response.nil?
+
       response.request
     end
 

data/lib/soaspec/exchange_handlers/rest_methods.rb

@@ -1,4 +1,3 @@
-
 module Soaspec
   # Contains commonly used REST methods
   module RestMethods
@@ -42,4 +41,4 @@ module Soaspec
       Exchange.new(name, method: :delete, **params)
     end
   end
-end
+end

data/lib/soaspec/exchange_handlers/rest_parameters.rb

@@ -1,11 +1,11 @@
 module Soaspec
   # Methods to define parameters specific to REST handler
   module RestParameters
-
     # 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)
       raise ArgumentError, "Base Url passed must be a String for #{self} but was #{url.class}" unless url.is_a?(String)
+
       define_method('base_url_value') { ERB.new(url).result(binding) }
     end
 
@@ -37,6 +37,7 @@ module Soaspec
     # @return [String] Client id obtained from credentials file
     def client_id
       raise '@client_id is not set. Set by specifying credentials file with "oauth2_file FILENAME" before this is called' unless @client_id
+
       @client_id
     end
 
@@ -45,6 +46,7 @@ module Soaspec
     # @param [String] password Password to use
     def basic_auth(user: nil, password: nil)
       raise ArgumentError, "Must pass both 'user' and 'password' for #{self}" unless user && password
+
       define_method('basic_auth_params') do
         { user: user, password: password }
       end
@@ -72,11 +74,13 @@ module Soaspec
     # @return [Hash] Hash with credentials in it
     def load_credentials_hash(filename)
       raise ArgumentError, "Filename passed must be a String for #{self} but was #{filename.class}" unless filename.is_a?(String)
+
       full_path = Soaspec.credentials_folder ? File.join(Soaspec.credentials_folder, filename) : filename
       full_path += '.yml' unless full_path.end_with?('.yml') # Automatically add 'yml' extension
       file_hash = YAML.load_file(full_path)
       raise "File at #{full_path} is not a hash" unless file_hash.is_a? Hash
+
       file_hash.transform_keys_to_symbols
     end
   end
-end
+end

data/lib/soaspec/exchange_handlers/rest_parameters_defaults.rb

@@ -18,4 +18,4 @@ module Soaspec
       false
     end
   end
-end
+end

data/lib/soaspec/exchange_handlers/soap_handler.rb

@@ -1,4 +1,3 @@
-
 require_relative 'exchange_handler'
 require_relative '../core_ext/hash'
 require_relative '../not_found_errors'
@@ -7,7 +6,6 @@ require_relative '../interpreter'
 require 'forwardable'
 
 module Soaspec
-
   # Accessors specific to SOAP handler
   module SoapAccessors
     # Define attributes set on root SOAP element
@@ -78,10 +76,8 @@ module Soaspec
         name = self.class.to_s
       end
       super
-      set_remove_key(options, :operation)
-      set_remove_key(options, :default_hash)
-      set_remove_key(options, :template_name)
-      merged_options = Soaspec.log_api_traffic? ? default_options.merge(logging_options) : default_options
+      set_remove_keys(options, %i[operation default_hash template_name])
+      merged_options = Soaspec::SpecLogger.log_api_traffic? ? default_options.merge(logging_options) : default_options
       merged_options.merge! savon_options
       merged_options.merge!(options)
       self.client = Savon.client(merged_options)
@@ -152,7 +148,7 @@ module Soaspec
     # @param [Nokogiri::XML::Document]
     def convert_to_lower_case(xml_doc)
       xml_doc.traverse do |node|
-        node.name = node.name.downcase if node.kind_of?(Nokogiri::XML::Element)
+        node.name = node.name.downcase if node.is_a?(Nokogiri::XML::Element)
       end
     end
 
@@ -162,6 +158,7 @@ module Soaspec
     # @return [Enumerable] Elements found through Xpath
     def xpath_elements_for(response: nil, xpath: nil, attribute: nil)
       raise ArgumentError('response and xpath must be passed to method') unless response && xpath
+
       xpath = "//*[@#{attribute}]" unless attribute.nil?
       xpath = '//' + xpath if xpath[0] != '/'
       temp_doc = response.doc.dup
@@ -184,6 +181,7 @@ module Soaspec
       results = xpath_elements_for(response: response, xpath: path, attribute: attribute)
       raise NoElementAtPath, "No value at Xpath '#{path}' in XML #{response.doc}" if results.empty?
       return results.first.inner_text if attribute.nil?
+
       results.first.attributes[attribute].inner_text
     end
 
@@ -206,7 +204,6 @@ module Soaspec
 
     # Convenience methods for once off usage of a SOAP request
     class << self
-
       # Implement undefined setter with []= for FactoryBot to use without needing to define params to set
       # @param [Object] method_name Name of method not defined
       # @param [Object] args Arguments passed to method
@@ -231,6 +228,5 @@ module Soaspec
         operations.include?(method_name) || super
       end
     end
-
   end
-end
+end

data/lib/soaspec/exchange_properties.rb

@@ -1,7 +1,6 @@
 # Convenience methods to set Exchange specific properties
 # Will be used when creating a subclass of Exchange
 module ExchangeProperties
-
   # Set default exchange handler for this exchange
   # This is helpful for when you need a new exchange handler created for each exchange
   # @param [Class] handler_class Class of ExchangeHandler to set Exchange to use
@@ -25,4 +24,4 @@ module ExchangeProperties
       true
     end
   end
-end
+end

data/lib/soaspec/exe_helpers.rb

@@ -1,9 +1,7 @@
-
 require 'fileutils'
 module Soaspec
   # Help with tasks common to soaspec executables
   module ExeHelpers
-
     # Create files in project depending on type of project
     # @param [String] type Type of project to create, e.g., 'soap', 'rest'
     def create_files_for(type)
@@ -19,9 +17,10 @@ module Soaspec
     end
 
     # @param [Array] filenames List of files to create
-    def create_files(filenames)
+    def create_files(filenames, ignore_if_present: false)
       raise ArgumentError, 'Expected filenames to be an Array' unless filenames.is_a? Array
-      filenames.each { |name| create_file filename: name }
+
+      filenames.each { |name| create_file filename: name, ignore_if_present: ignore_if_present }
     end
 
     # Spec task string depending upon whether virtual is used
@@ -45,15 +44,15 @@ module Soaspec
 
     # @param [String] filename Name of the file to create
     # @param [String] content Content to place inside file
+    # @param [Boolean] ignore_if_present Don't complain if file is present
     def create_file(filename: nil, content: nil, ignore_if_present: false, erb: true)
       raise 'Need to pass filename' unless filename
+
       content ||= retrieve_contents(filename, erb)
       create_folder File.split(filename).first
       if File.exist? filename
         old_content = File.read(filename)
-        if old_content != content && !ignore_if_present
-          warn "!! #{filename} already exists and differs from template"
-        end
+        warn "!! #{filename} already exists and differs from template" if old_content != content && !ignore_if_present
       else
         File.open(filename, 'w') { |f| f.puts content }
         puts 'Created: ' + filename
@@ -82,6 +81,5 @@ module Soaspec
     def generated_soap_spec_for(operation)
       ERB.new(File.read(File.join(File.dirname(__FILE__), 'generator', 'spec/dynamic_soap_spec.rb.erb'))).result(binding)
     end
-
   end
-end
+end

data/lib/soaspec/indifferent_hash.rb

@@ -4,4 +4,4 @@ require 'hashie'
 class IndifferentHash < Hash
   include Hashie::Extensions::MergeInitializer
   include Hashie::Extensions::IndifferentAccess
-end
+end

data/lib/soaspec/interpreter.rb

@@ -1,7 +1,5 @@
-
 # Help interpret the general type of a particular object
 class Interpreter
-
   class << self
     # @param [Object] response API response
     # @return [Symbol] Type of provided response
@@ -38,4 +36,4 @@ class Interpreter
       false
     end
   end
-end
+end

data/lib/soaspec/matchers.rb

@@ -1,4 +1,3 @@
-
 require_relative 'core_ext/hash'
 require_relative 'not_found_errors'
 
@@ -61,7 +60,6 @@ end
 RSpec::Matchers.alias_matcher :have_jsonpath_value, :have_xpath_value
 
 RSpec::Matchers.define :be_found do
-
   match do |exchange|
     expect(exchange.exchange_handler.found?(exchange.response)).to be true
   end
@@ -91,6 +89,7 @@ RSpec::Matchers.define :be_successful do
       failure_list << "Expected value at json '#{path}' to be '#{value}' but was '#{exchange[path]}'" unless exchange[path] == value
     end
     raise failure_list.to_s unless failure_list.empty?
+
     true
   end
 end

data/lib/soaspec/o_auth2.rb

@@ -38,6 +38,7 @@ module Soaspec
       params[:token_url] ||= Soaspec::OAuth2.token_url
       raise ArgumentError, 'client_id and client_secret not set' unless params[:client_id] && params[:client_secret]
       raise ArgumentError, 'token_url mandatory' unless params[:token_url]
+
       self.params = params
       params[:username] = api_username || ERB.new(params[:username]).result(binding) if params[:username]
       params[:security_token] = ERB.new(params[:security_token]).result(binding) if params[:security_token]
@@ -99,4 +100,4 @@ module Soaspec
                     end)
     end
   end
-end
+end