soaspec 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a77bc501e360feb0326d9e0453fd134f534488d9
-  data.tar.gz: 0a5543099fdea5c919f5a6fcb10c15823f9d8889
+  metadata.gz: 9d48c8b910dd2bf87abcae57a3a7ef25f9bdd59d
+  data.tar.gz: 4c0d3566be81b05fa06878f7a01d0b54ccf776ca
 SHA512:
-  metadata.gz: 737e926e4fd459e15f4174c22991dd792d2c891f60ba48b36b538f9bf6beda5c652b4e32f50ce1cfdf189841da7bec26920e3f0ea284ff26417424271375dfc2
-  data.tar.gz: ad5987dbd6099d7887fc0186de8806821c973138f7e1229ec7a7aba179085a20ca6a011850e4c97f69006950bf63bba98d246ae16bac180b2a4ec9fce8d8617f
+  metadata.gz: ee025f3a394441a6ee3612befcaf94f36c3a0d3d5dc2901230f300f4d0798424f08315e6c82009b574d0ab98dce77f432579d265e445bf4ec15c8220f5b05824
+  data.tar.gz: 50abba523c74d01f098a9bd1e9b061ea9e6fbe66735c59cf5110e13174c5cb166537f1d0361c1fae9377f1889f2e2c6b048d81e358e3a6aac0f108c4b9644ab7

data/ChangeLog

@@ -1,3 +1,10 @@
+Version 0.1.10
+* Enhancements
+  * Rename default template folder from to 'template' to 'templates'
+  * Use TemplateReader to simplify and add error handling to extracting templates
+  * Got convenience Rest Methods able to handle taking in template_name
+  * Started making a request method to access request of API actually sent
+
 Version 0.1.9
 * Enhancements
   * Finally move `soaspec-virtual-server` into same binary as `soaspec` utilising Thor

data/Todo.md

@@ -1,5 +1,7 @@
 * Unit tests
   * OAuth class, etc
+* Request method from within exchange
+  * Use this in tests
 * Basic service generator
 * Give examples and convenience methods for building classes for each SOAP or REST operation
   * For SOAP give example of basic_auth

data/lib/soaspec.rb

@@ -10,6 +10,7 @@ require 'jsonpath'
 
 require 'soaspec/version'
 require 'soaspec/o_auth2'
+require 'soaspec/template_reader'
 require 'soaspec/exchange_handlers/soap_handler'
 require 'soaspec/exchange_handlers/exchange_handler'
 require 'soaspec/exchange_handlers/rest_methods'
@@ -34,19 +35,25 @@ require 'soaspec/wsdl_generator'
 # Gem for handling SOAP and REST api tests
 module Soaspec
 
-  @template_folder = 'template'
+  @template_folder = 'templates'
   @auto_oauth = true
 
   class << self
     # Specify whether to see params sent to and retrieved from oauth. This will put password in log file, only recommended for debugging
     attr_writer :debug_oauth
     # Folder used to store templates for API calls
-    attr_accessor :template_folder
+    attr_reader :template_folder
     # Stores last exchange
     attr_accessor :last_exchange
     # Automatically add Authorization header to RestHandler where oauth2 credentials are specified
     attr_accessor :auto_oauth
 
+    # Folder used to store templates for API calls
+    # Converts folder / folders into an array depending upon string passed
+    def template_folder=(folder)
+      @template_folder = folder.include?('\\') ? folder.split('\\') : folder.split('/')
+    end
+
     # Folder used to store credentials
     # Used in auth2_file command
     # @param [String] folder
@@ -86,11 +93,6 @@ module Soaspec
       @debug_oauth || false
     end
 
-    # @return [String] Folder used to store templates for API calls
-    # def template_folder
-    #   @template_folder || 'template'
-    # end
-
     # Whether to log all API traffic
     def log_api_traffic=(set)
       @log_api_traffic = set

data/lib/soaspec/exchange.rb

@@ -144,9 +144,9 @@ class Exchange
   end
 
   # Returns response object from Api. Will make the request if not made and then cache it for later on
-  # For example for SOAP it will be a Savon response
-  # response.body (body of response as Hash)
-  # response.header (head of response as Hash)
+  # @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
     Soaspec.last_exchange = self
     @response ||= make_request
@@ -154,6 +154,11 @@ class Exchange
 
   alias call response
 
+  # Request of API call. Either intended request or actual request
+  def request
+    exchange_handler.request(@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

data/lib/soaspec/exchange_handlers/exchange_handler.rb

@@ -100,5 +100,11 @@ module Soaspec
       false
     end
 
+    # Request of API call. Either intended request or actual request
+    def request(response)
+      return "Request not yet sent Request option is #{@request_option}" unless response
+      'Specific API handler should implement this'
+    end
+
   end
 end

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -272,19 +272,26 @@ module Soaspec
       end
     end
 
+    # Request of API call. Either intended request or actual request
+    def request(response)
+      return 'Request not yet sent' if response.nil?
+      response.request
+    end
+
     private
 
     # Work out data to send based upon payload, template_name
     # @return [String] Payload to send in REST request
     def post_data(test_values)
-      if test_values[:body]
-        test_values[:payload] = JSON.generate(hash_used_in_request(test_values[:body])).to_s
-      elsif @request_option == :template
-        request_body = File.read(File.join(Soaspec.template_folder, template_name))
-        ERB.new(request_body).result(binding)
-      else
-        test_values[:payload]
-      end
+      data = if test_values[:body]
+               test_values[:payload] = JSON.generate(hash_used_in_request(test_values[:body])).to_s
+             elsif @request_option == :template
+               Soaspec::TemplateReader.new.render_body(template_name, binding)
+             else
+               test_values[:payload]
+             end
+      # Soaspec::SpecLogger.info "Request Empty for '#{@request_option}'" if data.strip.empty?
+      data
     end
 
     # @return [Hash] Hash used in REST request based on data conversion
@@ -307,9 +314,13 @@ module Soaspec
         # @param [Hash] params Exchange parameters
         # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
         define_method(rest_method) do |params = {}|
-          # params ||= {}
           params[:name] ||= rest_method
-          new(params[:name])
+          exchange_params = { name: params[:name] }
+          if params[:template_name]
+            exchange_params[:template_name] = params[:template_name]
+            params.delete :template_name
+          end
+          new(exchange_params)
           Exchange.new(params[:name], method: rest_method.to_sym, **params)
         end
       end

data/lib/soaspec/exchange_handlers/soap_handler.rb

@@ -99,16 +99,15 @@ module Soaspec
     # @param [Hash] request_parameters Parameters used to overwrite defaults in request
     def make_request(request_parameters)
       test_values = request_body_params request_parameters
+      # Call the SOAP operation with the request XML provided
       begin
         if @request_option == :template
-          request_body = File.read(File.join(Soaspec.template_folder, template_name))
-          render_body = ERB.new(request_body).result(binding)
-          client.call(operation, xml: render_body) # Call the SOAP operation with the request XML provided
+          client.call(operation, xml: Soaspec::TemplateReader.new.render_body(template_name, binding))
         elsif @request_option == :hash
           client.call(operation, message: @default_hash.merge(test_values), attributes: request_root_attributes)
         end
-      rescue Savon::HTTPError => e
-        e
+      rescue Savon::HTTPError => soap_error
+        soap_error
       end
     end
 

data/lib/soaspec/template_reader.rb

@@ -0,0 +1,27 @@
+require 'erb'
+
+module Soaspec
+  # Handles reading templates for tests
+  class TemplateReader
+    # Name of file where template is stored
+    attr_accessor :template_name
+
+    # @return [String] Path to where template file is stored
+    def file_location
+      File.join(*Soaspec.template_folder, template_name)
+    end
+
+    # @param [String] template_name File where template is stored
+    # @return [String] Body of template after determining test_values
+    def render_body(template_name, binding)
+      self.template_name = template_name
+      unless File.exist? file_location
+        raise "Cannot see file at #{file_location}. "\
+              "Global folder is '#{Soaspec.template_folder}' and filename is '#{template_name}'"
+      end
+      request_body = File.read file_location
+      raise "Template at #{file_location} not parsed correctly" if request_body.strip.empty?
+      ERB.new(request_body).result(binding)
+    end
+  end
+end

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.1.9'.freeze
+  VERSION = '0.1.10'.freeze
 end

data/templates/rest_template.json

@@ -0,0 +1,22 @@
+{
+  "glossary": {
+    "title": "example glossary",
+    "GlossDiv": {
+      "title": "<%= test_values[:gloss_title] || 'Gloss' %>",
+      "GlossList": {
+        "GlossEntry": {
+          "ID": "SGML",
+          "SortAs": "SGML",
+          "GlossTerm": "Standard Generalized Markup Language",
+          "Acronym": "SGML",
+          "Abbrev": "ISO 8879:1986",
+          "GlossDef": {
+            "para": "A meta-markup language, used to create markup languages such as DocBook.",
+            "GlossSeeAlso": ["GML", "XML"]
+          },
+          "GlossSee": "markup"
+        }
+      }
+    }
+  }
+}

data/templates/soap_template.xml

@@ -0,0 +1,7 @@
+<env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://thomas-bayer.com/blz/" xmlns:env="http://www.w3.org/2003/05/soap-envelope">
+  <env:Body>
+    <tns:getBank>
+      <tns:blz><%= test_values[:blz] || '70070010' %></tns:blz>
+    </tns:getBank>
+  </env:Body>
+</env:Envelope>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-08 00:00:00.000000000 Z
+date: 2018-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -356,6 +356,7 @@ files:
 - lib/soaspec/o_auth2.rb
 - lib/soaspec/soaspec_shared_examples.rb
 - lib/soaspec/spec_logger.rb
+- lib/soaspec/template_reader.rb
 - lib/soaspec/test_server/bank.wsdl
 - lib/soaspec/test_server/get_bank.rb
 - lib/soaspec/test_server/id_manager.rb
@@ -369,6 +370,8 @@ files:
 - lib/soaspec/virtual_server.rb
 - lib/soaspec/wsdl_generator.rb
 - soaspec.gemspec
+- templates/rest_template.json
+- templates/soap_template.xml
 - test.wsdl
 - test.xml
 - test_wsdl.rb