soaspec 0.3.3 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9f6e35bf3fb8a025d3b6b3e7331686c6b1c2c6ab332fc46edf4c63e360e4b37
-  data.tar.gz: a1c11edd859c3b71a5f2384cef5437c41ec609a4104df144e6491d3081f588c6
+  metadata.gz: 6e3843bc70d12aba4f2d2d825ef0eb3f142cea08fe50c6042875bcbc8f08d770
+  data.tar.gz: 6448d093a3a2df45fa7db32c2c230349fd892258ffcf8d863f01759b79913a67
 SHA512:
-  metadata.gz: 74334ea904ce3ff6f131e43b1954945231bb0178aba8867564e7e9056b1f723a9506a500de582fa226d77dc872384a4944306b5dd35ae7766d1d1f0fd5c05af1
-  data.tar.gz: 8f9ff7688a0442663faa05a640912b8e4161317597ddd8ea6ad3e6cb7632800b50ed7441fb38caa080782e2f2b2d519d3e07ded33c552179c32514ceeeb21d35
+  metadata.gz: f81e8e90e494743cdd9fdd87d251194cb7c791631a53508c224f458787458417c1c12b0d8cae942e246f92b7ffe2bd76cede518ddf60f156ef85eb3d4874138e
+  data.tar.gz: 43c1a37a03e64cacce5a478083d183b6e4422d1ab5db5edc94b81c812968a804326df97c3c9ba539101e10fee8c27981f41186e337517e115d221194f922f7ad

data/ChangeLog

@@ -1,3 +1,17 @@
+Version 0.3.6
+* Enhancement
+  * Build up Rest request using `RestClient::Request` rather than use resource to allow
+    sending payload to HTTP methods like `delete` and `get` which doesn't usually take one but
+    sometimes does
+
+Version 0.3.5
+* Enhancement
+  * Clean up the Handler code, mainly REST by moving logic into RestRequest method
+
+Version 0.3.4
+* Bug fix
+  * Don't put global options on STDOUT. Put within logger
+
 Version 0.3.3
 * Enhancement
   * Ability to specify multipart on Soaspec::OAuth2, not always assume it's value

data/lib/soaspec/baseline.rb

@@ -4,7 +4,9 @@ require_relative 'exe_helpers'
 
 module Soaspec
   # Used for defining parameters for recording and asserting against
-  # a baseline
+  # a baseline.
+  # This does not take into account different payloads in the request, only
+  # for where a response varies by suburls or query parameters
   class Baseline
     include Soaspec::ExeHelpers
     @folder = File.join('config', 'baseline')
@@ -24,10 +26,10 @@ module Soaspec
     def initialize(exchange, format)
       self.exchange = exchange
       self.format = format
-      unless ALLOWED_FORMATS.include? format
-        raise ArgumentError, "Expected format #{format} to be " \
-            "either #{ALLOWED_FORMATS}"
-      end
+      return if ALLOWED_FORMATS.include? format
+
+      raise ArgumentError, "Expected format #{format} to be " \
+          "either #{ALLOWED_FORMATS}"
     end
 
     # Compare baseline with expected result. This will create baseline

data/lib/soaspec/exchange/exchange_properties.rb

@@ -6,7 +6,7 @@ module Soaspec
   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
+    # @param [< ExchangeHandler] handler_class Class of ExchangeHandler to set Exchange to use
     # @param [String] name Name to call handler when it's instantiated (Defaults to class name)
     # @param [Hash] params Hash of parameters to set for instance of ExchangeHandler
     def default_handler(handler_class, name = handler_class.to_s, params = '')

data/lib/soaspec/exchange_handlers/request/rest_request.rb

@@ -7,9 +7,11 @@ module Soaspec
     #   :get
     # @return [Symbol] REST method used
     attr_accessor :method
+    # This will be the actual payload sent. This could be set in Exchange through the payload
+    # explicitly, the 'body' param which will convert a Hash to JSON or a template
     # @example JSON body
     #   {"test":5}
-    # @return [String] Body of request sent
+    # @return [String] Body of request sent. Payload that will be sent in request
     attr_accessor :body
     # @return [String] Name given to test to describe it
     attr_accessor :test_name
@@ -27,6 +29,13 @@ module Soaspec
     # @return [Soaspec::RestHandler] RestHandler used for this request
     attr_accessor :rest_handler
 
+    # @return [String] Base url plus sub url
+    def full_url
+      url = rest_handler.base_url_value
+      url += "/#{suburl}" if suburl
+      @full_url = ERB.new(url).result(binding)
+    end
+
     # Interpret REST parameters given provided parameters and adding defaults, making
     # transformations
     #
@@ -51,19 +60,21 @@ module Soaspec
 
     # @param [Hash] overall Overall parameters used in Request
     # @param [Hash] options Headers and basic auth options
-    # @param [Soaspec::RestHandler] rest_handler RestHandler handling creation of this request
+    # @param [< Soaspec::RestHandler] rest_handler RestHandler handling creation of this request
     def initialize(overall, options, rest_handler)
       self.rest_handler = rest_handler
       overall_params = interpret_parameters(overall)
-      @overall_params = overall_params
+      @overall_params = overall_params.dup
       self.method = overall_params.delete(:method)
-      self.body = payload? ? post_data : nil #body
+      self.body = post_data
+      overall_params.delete(:body)
+      overall_params.delete(:payload)
       self.suburl = overall_params.delete(:suburl)
       self.test_name = overall_params.delete(:name)
       self.other_params = overall_params
       self.basic_auth_user = options[:user]
       self.basic_auth_password = options[:password]
-      self.headers = options[:headers]
+      self.headers = options[:headers] # TODO: Use this in request
     end
 
     # @return [Hash] Query parameters for a REST Request
@@ -98,30 +109,38 @@ module Soaspec
       File.join(*components.collect!(&:to_s))
     end
 
-    # @return [Boolean] Whether REST method should have a payload
-    def payload?
-      case method
-      when :post, :patch, :put
-        true
-      else
-        false
-      end
+    # Use the request parameters to call the REST api
+    def call(merged_options)
+      rest_handler.exception = nil # Remove any previously stored exception
+      Soaspec::SpecLogger.info("request body: #{body}") if body
+      merge_headers = (merged_options[:headers] || {}).merge(other_params)
+      params = merged_options.merge(method: method, url: full_url,
+                                    headers: merge_headers)
+      params.merge!(payload: body) if body
+      RestClient::Request.execute params
+    rescue RestClient::Exception => e
+      rest_handler.exception = e
+      raise e unless e.respond_to? :response
+
+      e.response
     end
 
-    # TODO: Implement this for this object
     # Work out data to send based upon payload, template_name, or body
-    # @return [String] Payload to send in REST request
+    # @return [String, NilClass] Payload to send in REST request. Nil if nothing is to be sent
     def post_data
       option = rest_handler.request_option
-      if option == :hash && !@overall_params[:payload]
-        @overall_params[:payload] = JSON.generate(rest_handler.hash_used_in_request(@overall_params[:body])).to_s
-      elsif option == :template
-        test_values = nil
-        test_values = @overall_params[:body].dup if @overall_params[:body]
-        Soaspec::TemplateReader.new.render_body(rest_handler.template_name, test_values || @overall_params)
-      else
-        @overall_params[:payload]
-      end
+      body = if option == :hash && !@overall_params[:payload]
+               @overall_params[:payload] = JSON.generate(rest_handler.hash_used_in_request(@overall_params[:body])).to_s
+             elsif option == :template
+               test_values = nil
+               test_values = @overall_params[:body].dup if @overall_params[:body]
+               Soaspec::TemplateReader.new.render_body(rest_handler.template_name, test_values || @overall_params)
+             else
+               @overall_params[:payload]
+             end
+      return body if body && body != '{}'
+
+      nil
     end
   end
 end

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -64,26 +64,8 @@ module Soaspec
     # @return [RestClient::Response] Response from making request
     def make_request(override_parameters)
       req_params = request_parameters override_parameters
-      # In order for ERB to be calculated at correct time, the first time request is made, the resource should be created
-      @resource ||= RestClient::Resource.new(ERB.new(base_url_value).result(binding), @merged_options)
-      @resource_used = req_params.suburl ? @resource[req_params.suburl] : @resource
-
-      self.exception = nil # Remove any previously stored exception
-      begin
-        response = case req_params.method
-                   when :post, :patch, :put
-                     Soaspec::SpecLogger.info("request body: #{req_params.post_data}")
-                     @resource_used.send(req_params.method, req_params.post_data, req_params.other_params)
-                   else # :get, :delete
-                     @resource_used.send(req_params.method, req_params.other_params )
-                   end
-      rescue RestClient::Exception => e
-        self.exception = e
-        raise e unless e.respond_to? :response
-
-        response = e.response
-      end
-      Soaspec::SpecLogger.info("response: \n  headers: #{response&.headers}\n  body: #{response}\n")
+      response = req_params.call @merged_options
+      Soaspec::SpecLogger.info("response:\n  headers: #{response&.headers}\n  body: #{response}\n")
       after_response(response, self)
       response
     end
@@ -160,7 +142,7 @@ module Soaspec
 
     # @return [Integer] HTTP Status code for response
     def status_code_for(response)
-      response.code
+      response&.code
     end
 
     # Returns the value at the provided xpath

data/lib/soaspec/exchange_handlers/soap_handler.rb

@@ -66,7 +66,8 @@ module Soaspec
 
     # Setup object to handle communicating with a particular SOAP WSDL
     # @param [String] name Name to describe handler. Used in calling 'to_s'
-    # @param [Hash] options Options defining SOAP request. WSDL, authentication, see http://savonrb.com/version2/globals.html for list of options
+    # @param [Hash] options Options defining SOAP request. WSDL, authentication,
+    #   See http://savonrb.com/version2/globals.html for list of options
     def initialize(name = self.class.to_s, options = {})
       if name.is_a?(Hash) && options == {} # If name is not set
         options = name
@@ -77,9 +78,9 @@ module Soaspec
       merged_options = SoapDefaults.options
       merged_options.merge!(logging_options) if Soaspec::SpecLogger.log_api_traffic?
       merged_options.merge! savon_options
-      puts 'globals' + savon_globals.to_s
       merged_options.merge! savon_globals
       merged_options.merge!(options)
+      Soaspec::SpecLogger.info "Using Savon globals: #{merged_options}"
       self.client = Savon.client(merged_options)
     end
 

data/lib/soaspec/version.rb

@@ -2,5 +2,5 @@
 
 module Soaspec
   # @return [String] Version of the gem
-  VERSION = '0.3.3'
+  VERSION = '0.3.6'
 end

data/lib/soaspec/virtual_server.rb

@@ -107,6 +107,11 @@ module Soaspec
       params.to_s
     end
 
+    documentation 'Sends back body received for delete'
+    delete '/echoer' do
+      request.body
+    end
+
     # Used for simple testing of posing
     documentation 'Simply sends the response body back'
     post '/echoer' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.6
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler