soaspec 0.1.18 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d67dcecc12aa7ed80c4064617ae5b4edf939c38
-  data.tar.gz: d38ea5011a5668761890aa5b66b93e8703f385cc
+  metadata.gz: bfa2bb6212fe0840b7909f7abc36b9d930130edf
+  data.tar.gz: 21bf07ae73063ea5b89cb893b34f4b9dd986c574
 SHA512:
-  metadata.gz: 445f7ce4e2883bbbe784a9e2b672860f90f68c46ad9b3b2e39659efd6c81375b646fe51a5b147df5b30e807f08628b52d6a276031314901519e7d9fe1f5dbd43
-  data.tar.gz: 8531ebc72ae98481f5d2b701b6ef719cc8ad77a94297b33469cdcb3a7ada81e4a11f21b5075e05d2e7c83bd81fe5a173fcfe520179abaa2c68fb275d5da4f24c
+  metadata.gz: 8da4766d8150595c4087ab1a5d4e85194a6731ccaa8720b8d25bf0f6a91d08e049da0e283f5e2ba3212e2789d74b4f4bb893b489eb33f70461bec05aa34fea2d
+  data.tar.gz: 7351a1edd83baa1e2dd74555ec8f8f14c5a5064be0bc81d43cf4034d41c4694eedccb5f6e637e5b2c9dfb0cccf8e4bc6738c5ca034100c02ed0f408e6f97454d

data/ChangeLog

@@ -1,3 +1,14 @@
+Version 0.2.0
+* Exception handling
+  * Raise meaningful exception if REST header value passed is null
+* Enhancements
+  * `soaspec add` exe to create basic 'rest' or 'soap' service
+  * Add another matcher to check response is successful
+  * Default hash and template_name can now be defined within a class rather than just at an instance of it
+  * Stubs making it clearer what parameters are when looking at code from RubyMine
+  * Basic auth file method on RestHandler for clearer defining of basic auth
+  * Handle ERB in 'base_url' method
+
 Version 0.1.18
 * Enhancements
   * Define 'exchange' method on response object so original exchange can be accessed

data/exe/soaspec

@@ -18,10 +18,10 @@ module Soaspec
     `soaspec new` will generate the initial files and folders for starting a testing project using soaspec
     \x5
 
-    `soaspec new soap` will create example files testing against a virtual SOAP service
+    `soaspec new soap` will create example files testing against a SOAP service
     \x5
 
-    `soaspec new rest` will create example files testing against a virtual REST service
+    `soaspec new rest` will create example files testing against a REST service
     LONGDESC
     desc 'new [type]', 'Initialize soaspec repository'
     option :ci, default: 'jenkins', banner: 'What Continuous Integration is used'
@@ -43,13 +43,28 @@ module Soaspec
       puts "Run 'rake spec' to run the tests"
     end
 
+    long_desc <<-LONGDESC
+    `soaspec add rest` will generate the initial files and folders for starting a testing project using soaspec
+    \x5
+
+    `soaspec add soap` will create example files testing against a virtual SOAP service
+    \x5
+
+    LONGDESC
+    desc 'add [type] [name]', 'Add new ExchangeHandler'
+    def add(type = 'rest', name = 'TestService')
+      raise "Type '#{type}' is not available" unless %w[rest soap].include? type
+      @name = name # Use instance variable for ERB
+      create_file(filename: File.join('lib', "#{name.snakecase}.rb"), content: retrieve_contents("lib/new_#{type}_service.rb"))
+    end
+
     desc 'generate', 'Generate initial test code from wsdl'
     long_desc <<-LONGDESC
     `soaspec generate wsdl=wsdl name=ServiceName ` will generate the initial files and folders to test each operation in a wsdl
     \x5
     Additionally the auth parameter can be used to use basic authentication to retrieve the WSDL.
     To do use the following `soaspec generate --auth=basic`
-
+    Note: This is still a work in progress and will only work for a very simple wsdl
     LONGDESC
     option :wsdl, required: true, aliases: :w
     option :name, default: 'Service', aliases: :n

data/lib/soaspec/cucumber/generic_steps.rb

@@ -1,49 +1,67 @@
 require 'active_support/core_ext/string/inflections'
 
+# @return [Exchange] Return current or last exchange used in Cucumber
+def current_exchange
+  @current_exchange ||= Soaspec.last_exchange
+end
+
+# Pass in the operation (HTTP method or SOAP operation) in first parameter and api name as second.
+# API name can be mulitple words and it will be converted to camel case to find the ExchangeHandler class
 Given 'I am performing a {word} on the {string} API' do |operation, api_name|
-  @exchange = api_name.camelize.constantize.send operation
+  @current_exchange = api_name.tr(' ', '_').camelize.constantize.send operation
 end
 
+# Set a parameter in the request body
+# @param [String] Element in request body to set
+# @param [String] Value to set it to
 Given 'I set the {word} to {string}' do |key, value|
-  @exchange[key] = value
+  current_exchange[key] = value
 end
 
+# Add onto the base_url to make a complete url for the test
 Given 'I use the path {word}' do |suburl|
-  @exchange.suburl = suburl
+  current_exchange.suburl = suburl
 end
 
+# Add a query parameter for http 'get' requests. e.g. will add '?filter_key=filter_value' onto URL
 Given 'I filter {string} by {string}' do |filter_key, filter_value|
   transformed_key = filter_key.to_sym
-  if @exchange.override_parameters[:q]
-    @exchange.override_parameters[:q][transformed_key] = filter_value
+  if current_exchange.override_parameters[:q]
+    current_exchange.override_parameters[:q][transformed_key] = filter_value
   else
-    @exchange.override_parameters[:q] = { transformed_key => filter_value }
+    current_exchange.override_parameters[:q] = { transformed_key => filter_value }
   end
 end
 
-# This is getting quite technical
+# Add HTTP header 'header_name' as 'header_value'
 Given 'I set header {string} to {string}' do |header_name, header_value|
-  if @exchange.override_parameters[:params]
-    @exchange.override_parameters[:params][header_name] = header_value
+  if current_exchange.override_parameters[:params]
+    current_exchange.override_parameters[:params][header_name] = header_value
   else
-    @exchange.override_parameters[:params] = { header_name => header_value }
+    current_exchange.override_parameters[:params] = { header_name => header_value }
   end
 end
 
+# Make the API call. This is automatically done when any method extracting a response is made. It can be done
+# explicitly here as it is a meaningful step
 When 'I make the request' do
-  @exchange.call
+  current_exchange.call
 end
 
+# Extract the value from the response that is at the path 'key' and verify it is eq to expected_value
 Then 'it should have the {word} {string}' do |key, expected_value|
-  expect(@exchange[key]).to eq expected_value
+  expect(current_exchange[key]).to eq expected_value
 end
 
+# Extract the value from the response that is at the path 'key_string' and verify it is eq to expected_value
+# Conversion is made on key_string to make it one snake case word
 Then 'it should have the {string} {string}' do |key_string, expected_value|
   key = key_string.tr(' ', '_')
-  actual_value = @exchange.respond_to?(key) ? @exchange.send(key) : @exchange[key]
+  actual_value = current_exchange.respond_to?(key) ? current_exchange.send(key) : current_exchange[key]
   expect(actual_value.to_s).to eq expected_value
 end
 
+# Verify that the HTTP status code is 200..299 and that any defined mandatory elements / mandatory values are as expected
 Then 'it should be successful' do
-  expect(200..299).to cover @exchange.status_code
+  expect(current_exchange).to be_successful
 end

data/lib/soaspec/exchange.rb

@@ -1,36 +1,11 @@
 require_relative '../soaspec'
-
-# Convenience methods to set Exchange specific properties
-module ExchangeAccessors
-
-  # Set default exchange handler for this exchange
-  # This is helpful for when you need a new exchange handler created for each exchange
-  def default_handler(handler_class, name = handler_class.to_s, params = '')
-    define_method('default_handler_used') do
-      params_used = Hash[params.map do |k, param|
-        [k, param.is_a?(String) ? ERB.new(param).result(binding) : param]
-      end]
-      handler_class.new name, params_used
-    end
-  end
-
-  # Set retry_for_success to true, retrying response until a successful status code is returned
-  def expect_positive_status(retry_count: 3)
-    define_method('retry_count') do
-      retry_count
-    end
-    define_method('retry_for_success?') do
-      true
-    end
-  end
-
-end
+require_relative 'exchange_properties'
 
 # This represents a request / response pair
 # Essentially, params in the exchange that are set are related to the request
 # What is returned is related to the response
 class Exchange
-  extend ExchangeAccessors
+  extend ExchangeProperties
 
   # Instance of ExchangeHandler for which this exchange is made
   attr_accessor :exchange_handler

data/lib/soaspec/exchange_handlers/exchange_handler.rb

@@ -16,18 +16,15 @@ module Soaspec
       public_methods.select { |i| i[/__custom_path_.+/] }
     end
 
-    # Set the default hash representing data to be used in making a request
-    # This will set the @request_option instance variable too
-    def default_hash=(hash)
-      @request_option = :hash
-      @default_hash = Soaspec.always_use_keys? ? hash.transform_keys_to_symbols : hash
-    end
-
     # Set instance variable name
     # @param [String, Symbol] name Name used when describing API test
     # @param [Hash] options Parameters defining handler. Used in descendants
     def initialize(name = self.class.to_s, options = {})
       use
+      @request_option = :hash
+      raise ArgumentError, 'Cannot define both template_name and default_hash' if respond_to?(:template_name_value) && respond_to?(:default_hash_value)
+      @template_name = respond_to?(:template_name_value) ? template_name_value : ''
+      @default_hash = respond_to?(:default_hash_value) ? default_hash_value : {}
       @name = name
     end
 
@@ -45,6 +42,13 @@ module Soaspec
       @name.to_s
     end
 
+    # Set the default hash representing data to be used in making a request
+    # This will set the @request_option instance variable too
+    def default_hash=(hash)
+      @request_option = :hash
+      @default_hash = Soaspec.always_use_keys? ? hash.transform_keys_to_symbols : hash
+    end
+
     # Set the request option type and the template name
     # Erb is used to parse the template file, executing Ruby code in `<%= %>` blocks to work out the final request
     # @param [String] name Name of file inside 'template' folder excluding extension
@@ -112,6 +116,5 @@ module Soaspec
       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/handler_accessors.rb

@@ -38,9 +38,7 @@ module Soaspec
     #
     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
+      define_method('expected_mandatory_xpath_values') { xpath_value_pairs }
     end
 
     # Defines mandatory json path value pairs to be included in 'success scenario' shared example
@@ -55,9 +53,7 @@ module Soaspec
     #
     def mandatory_json_values(json_value_pairs)
       raise ArgumentError("Hash of {'jsonpath' => expected values} expected") unless json_value_pairs.is_a? Hash
-      define_method('expected_mandatory_json_values') do
-        json_value_pairs
-      end
+      define_method('expected_mandatory_json_values') { json_value_pairs }
     end
 
     # Links a particular path to a meaningful method that can be accessed from Exchange class.
@@ -75,7 +71,7 @@ module Soaspec
     # This will use the 'value_from_path' method which
     # should be implemented by each ExchangeHandler
     # @param [String, Symbol] name Method name used to access attribute
-    # @param [String, nil, Hash] attribute Attribute name. If not set, this will default to @name
+    # @param [String, nil, Hash] attribute Attribute name to extract from xml. If not set, this will default to @name
     def attribute(name, attribute = nil)
       attribute_used = attribute ? attribute : name.to_s
       define_method("__custom_path_#{name}") do |response|
@@ -87,9 +83,7 @@ module Soaspec
     # You must then use lower case in the xpath's to obtain the desired values
     def convert_to_lower(set)
       return unless set
-      define_method('convert_to_lower?') do
-        true
-      end
+      define_method('convert_to_lower?') { true }
     end
 
     # Whether to remove namespaces from response in Xpath assertion automatically
@@ -99,8 +93,26 @@ module Soaspec
     def strip_namespaces(set)
       return unless set
       # Whether to remove namespaces in xpath assertion automatically
-      define_method('strip_namespaces?') do
-        true
+      define_method('strip_namespaces?') { true }
+    end
+
+    # Set the default hash representing data to be used in making a request
+    # This will set the @request_option instance variable too
+    # @param [Hash] hash Default hash of request
+    def default_hash(hash)
+      define_method('default_hash_value') do
+        @request_option = :hash
+        Soaspec.always_use_keys? ? hash.transform_keys_to_symbols : hash
+      end
+    end
+
+    # Set the request option type and the template name
+    # Erb is used to parse the template file, executing Ruby code in `<%= %>` blocks to work out the final request
+    # @param [String] name Name of file inside 'template' folder excluding extension
+    def template_name(name)
+      define_method('template_name_value') do
+        @request_option = :template
+        name
       end
     end
   end

data/lib/soaspec/exchange_handlers/rest_exchanger_factory.rb

@@ -0,0 +1,104 @@
+module Soaspec
+  # Convenience methods for once off usage of a REST request
+  module RestExchangeFactory
+    # Make REST Exchange with 'post' method within this Handler context
+    # @param [Hash, String] params Exchange parameters. If String is used it will be for the request payload
+    # @option override_parameters [Hash] :params Extra parameters (E.g. headers)
+    # @option override_parameters [String] suburl URL appended to base_url of class
+    # @option override_parameters [Hash] :q Query for REST
+    # Following are for the body of the request
+    # @option override_parameters [Hash] :body Hash to be converted to JSON in request body
+    # @option override_parameters [String] :payload String to be passed directly in request body
+    # @option override_parameters [String] :template_name Path to file to be read via ERB and passed in request body
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def post(params = {})
+      # This is a stub, used for indexing, source code below
+    end
+
+    # Make REST Exchange with 'patch' method within this Handler context
+    # @param [Hash, String] params Exchange parameters. If String is used it will be for the request payload
+    # @option override_parameters [Hash] :params Extra parameters (E.g. headers)
+    # @option override_parameters [String] suburl URL appended to base_url of class
+    # @option override_parameters [Hash] :q Query for REST
+    # Following are for the body of the request
+    # @option override_parameters [Hash] :body Hash to be converted to JSON in request body
+    # @option override_parameters [String] :payload String to be passed directly in request body
+    # @option override_parameters [String] :template_name Path to file to be read via ERB and passed in request body
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def patch(params)
+      # This is a stub, used for indexing, source code below
+    end
+
+    # Make REST Exchange with 'put' method within this Handler context
+    # @param [Hash, String] params Exchange parameters. If String is used it will be for the request payload
+    # @option override_parameters [Hash] :params Extra parameters (E.g. headers)
+    # @option override_parameters [String] suburl URL appended to base_url of class
+    # @option override_parameters [Hash] :q Query for REST
+    # Following are for the body of the request
+    # @option override_parameters [Hash] :body Hash to be converted to JSON in request body
+    # @option override_parameters [String] :payload String to be passed directly in request body
+    # @option override_parameters [String] :template_name Path to file to be read via ERB and passed in request body
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def put(params = {})
+      # This is a stub, used for indexing, source code below
+    end
+
+    # Make REST Exchange with 'get' method within this Handler context.
+    # If merely a string is passed it will be used as the URL appended to base_url. Otherwise a Hash is expected
+    # @param [Hash, String] params Exchange parameters. If String is used it will be for suburl
+    # @option override_parameters [Hash] :params Extra parameters (E.g. headers)
+    # @option override_parameters [String] suburl URL appended to base_url of class
+    # @option override_parameters [Hash] :q Query for REST
+    # Following are for the body of the request
+    # @option override_parameters [Hash] :body Hash to be converted to JSON in request body
+    # @option override_parameters [String] :payload String to be passed directly in request body
+    # @option override_parameters [String] :template_name Path to file to be read via ERB and passed in request body
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def get(params = {})
+      # This is a stub, used for indexing, source code below
+    end
+
+    # Make REST Exchange with 'delete' method within this Handler context.
+    # If merely a string is passed it will be used as the URL appended to base_url. Otherwise a Hash is expected
+    # @param [Hash, String] params Exchange parameters. If String is used it will be for suburl
+    # @option override_parameters [Hash] :params Extra parameters (E.g. headers)
+    # @option override_parameters [String] suburl URL appended to base_url of class
+    # @option override_parameters [Hash] :q Query for REST
+    # Following are for the body of the request
+    # @option override_parameters [Hash] :body Hash to be converted to JSON in request body
+    # @option override_parameters [String] :payload String to be passed directly in request body
+    # @option override_parameters [String] :template_name Path to file to be read via ERB and passed in request body
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def delete(params = {})
+      # This is a stub, used for indexing, source code below
+    end
+
+    methods = %w[post patch put get delete]
+
+    methods.each do |rest_method|
+      # Make REST Exchange within this Handler context
+      # @param [Hash, String] params Exchange parameters.
+      # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+      define_method(rest_method) do |params = {}|
+        unless params.is_a? Hash
+          params = case rest_method
+                   when 'get', 'delete'
+                     { suburl: params.to_s }
+                   when 'post', 'put', 'patch'
+                     { payload: params.to_s }
+                   else
+                     raise "'#{params}' needs to be a 'Hash' but is a #{params.class}"
+                   end
+        end
+        params[:name] ||= rest_method
+        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
+  end
+end

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -1,5 +1,7 @@
 require_relative 'exchange_handler'
-require_relative 'rest_accessors'
+require_relative 'rest_parameters'
+require_relative 'rest_parameters_defaults'
+require_relative 'rest_exchanger_factory'
 require_relative '../core_ext/hash'
 require_relative '../not_found_errors'
 require_relative 'handler_accessors'
@@ -8,13 +10,15 @@ require 'json'
 require 'jsonpath'
 require 'nori'
 require 'erb'
+require 'hashie/extensions/indifferent_access'
 
 module Soaspec
 
   # Wraps around Savon client defining default values dependent on the soap request
   class RestHandler < ExchangeHandler
-    extend Soaspec::RestAccessors
-    include Soaspec::RestAccessorsDefaults
+    extend Soaspec::RestParameters
+    include Soaspec::RestParametersDefaults
+    extend Soaspec::RestExchangeFactory
 
     # User used in making API calls
     attr_accessor :api_username
@@ -23,7 +27,6 @@ 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
-      @default_hash = {}
       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
@@ -31,6 +34,7 @@ module Soaspec
       super
       set_remove_keys(options, %i[api_username default_hash template_name])
       @init_options = options
+      init_merge_options # Call this to verify any issues with options on creating object
     end
 
     # Used in together with Exchange request that passes such override parameters
@@ -43,6 +47,7 @@ module Soaspec
     # @option override_parameters [Hash] :body Hash to be converted to JSON in request body
     # @option override_parameters [String] :payload String to be passed directly in request body
     # @option override_parameters [String] :template_name Path to file to be read via ERB and passed in request body
+    # @return [RestClient::Response] Response from making request
     def make_request(override_parameters)
       @merged_options ||= init_merge_options
       test_values = override_parameters
@@ -82,7 +87,10 @@ module Soaspec
     # Perform ERB on each header value
     # @return [Hash] Hash from 'rest_client_headers' passed through ERB
     def parse_headers
-      Hash[rest_client_headers.map { |k, header| [k, ERB.new(header).result(binding)] }]
+      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
 
     # Convert snakecase to PascalCase
@@ -95,6 +103,7 @@ module Soaspec
     # @return [Hash] Hash of merged options
     def init_merge_options
       options = rest_resource_options
+      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)
@@ -250,9 +259,10 @@ module Soaspec
     # Work out data to send based upon payload, template_name, or body
     # @return [String] Payload to send in REST request
     def post_data(test_values)
-      data = if test_values[:body]
+      data = if @request_option == :hash && test_values[:body]
                test_values[:payload] = JSON.generate(hash_used_in_request(test_values[:body])).to_s
              elsif @request_option == :template
+               test_values = test_values[:body].dup if test_values[:body]
                Soaspec::TemplateReader.new.render_body(template_name, binding)
              else
                test_values[:payload]
@@ -270,37 +280,5 @@ module Soaspec
         request
       end
     end
-
-    # Convenience methods for once off usage of a REST request
-    class << self
-
-      methods = %w[post patch put get delete]
-
-      methods.each do |rest_method|
-        # Make REST Exchange within this Handler context
-        # @param [Hash, String] params Exchange parameters. If String is used it will be for suburl
-        # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
-        define_method(rest_method) do |params = {}|
-          unless params.is_a? Hash
-            params = case rest_method
-                     when 'get', 'delete'
-                       { suburl: params.to_s }
-                     when 'post', 'put', 'patch'
-                       { payload: params.to_s }
-                     else
-                       params
-                     end
-          end
-          params[:name] ||= rest_method
-          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
-    end
   end
 end

data/lib/soaspec/exchange_handlers/rest_parameters.rb

@@ -0,0 +1,74 @@
+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
+
+    # Will create access_token method based on passed parameters
+    # @param [Hash] params OAuth 2 parameters
+    # @param_value [token_url] URL to retrieve OAuth token from. @Note this can be set globally instead of here
+    # @param_value [client_id] Client ID
+    # @param_value [client_secret] Client Secret
+    # @param_value [username] Username used in password grant
+    # @param_value [password] Password used in password grant
+    # @param_value [security_token] Security Token used in password grant
+    def oauth2(params)
+      # @!method oauth_obj Object to handle oauth2
+      define_method('oauth_obj') { OAuth2.new(params, api_username) }
+      # @!method access_token Retrieve OAuth2 access token
+      define_method('access_token') { oauth_obj.access_token }
+      # @!method instance_url Retrieve instance url from OAuth request
+      define_method('instance_url') { oauth_obj.response['instance_url'] }
+    end
+
+    # Pass path to YAML file containing OAuth2 parameters
+    # @param [String] path_to_filename Will have Soaspec.credentials_folder appended to it if set
+    def oauth2_file(path_to_filename)
+      oauth2 load_credentials_hash(path_to_filename)
+    end
+
+    # Define basic authentication
+    # @param [String] user Username to use
+    # @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
+    end
+
+    # Pass path to YAML file containing Basic Auth parameters (i.e, both username and password)
+    # @param [String] path_to_filename Will have Soaspec.credentials_folder appended to it if set
+    def basic_auth_file(path_to_filename)
+      basic_auth load_credentials_hash(path_to_filename)
+    end
+
+    # @param [Hash] headers Hash of REST headers used in RestClient
+    def headers(headers)
+      define_method('rest_client_headers') { headers }
+    end
+
+    # Convert each key from snake_case to PascalCase
+    def pascal_keys(set)
+      define_method('pascal_keys?') { set }
+    end
+
+    private
+
+    # Load credentials hash from a YAML using Soaspec.credentials_folder if set, adding '.yml' if not set
+    # @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

data/lib/soaspec/exchange_handlers/{rest_accessors_defaults.rb → rest_parameters_defaults.rb}

@@ -1,6 +1,6 @@
 module Soaspec
-  # Defaults for Soaspec RestAccessors method
-  module RestAccessorsDefaults
+  # Defaults for Soaspec RestParameters methods
+  module RestParametersDefaults
     # Set through following method. Base URL in REST requests.
     def base_url_value
       nil

data/lib/soaspec/exchange_handlers/soap_handler.rb

@@ -73,8 +73,6 @@ module Soaspec
     # Setup object to handle communicating with a particular SOAP WSDL
     # @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 = {})
-      @default_hash = {}
-      @request_option = :hash
       if name.is_a?(Hash) && options == {} # If name is not set
         options = name
         name = self.class.to_s

data/lib/soaspec/exchange_properties.rb

@@ -0,0 +1,28 @@
+# 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
+  # @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 = '')
+    define_method('default_handler_used') do
+      params_used = Hash[params.map do |k, param|
+        [k, param.is_a?(String) ? ERB.new(param).result(binding) : param]
+      end]
+      handler_class.new name, params_used
+    end
+  end
+
+  # Set retry_for_success to true, retrying response until a successful status code is returned
+  def expect_positive_status(retry_count: 3)
+    define_method('retry_count') do
+      retry_count
+    end
+    define_method('retry_for_success?') do
+      true
+    end
+  end
+end

data/lib/soaspec/exe_helpers.rb

@@ -31,7 +31,9 @@ module Soaspec
     end
 
     # Retrieve default file contents based on filename
-    def retrieve_contents(filename, erb)
+    # @param [String] filename Filename within 'lib/generator' to file retrieve contents from
+    # @param [Boolean] erb Whether to process file with ERB
+    def retrieve_contents(filename, erb = true)
       default_file = File.join(File.dirname(__FILE__), 'generator', filename + (erb ? '.erb' : ''))
       contents = File.read(default_file)
       erb ? ERB.new(contents).result(binding) : contents

data/lib/soaspec/generator/lib/new_rest_service.rb.erb

@@ -0,0 +1,50 @@
+# This class represent REST Api calls for the <%= @name %> API
+class <%= @name %> < Soaspec::RestHandler
+  ## Defining request
+
+  # All requests to <%= @name %> will start with this url
+  # TODO: Change this mandatory base_url to the url that all requests to this service start with
+  # base_url "https://my_host/api/<%= ENV['environment'] %>/api_name" # ERB can be used to make this dynamic based on environment
+
+  # Headers that will be sent by default using this Handler
+  # If symbol is used, they'll be converted to standard HTTP headers
+  # headers accept: 'application/json', content_type: 'application/json'
+
+  # Filename of oauth2 file to use for oauth2 parameters. 'Soaspec.credentials_folder' can be set to globally defined a folder with credentials
+  # This will add a default 'Authorization: Bearer access_token' header if 'Authorization' is not specified in headers
+  # The '.yml' extension will be added automatically if not present.
+  # oauth2_file 'filename.yml'
+
+  # Filename of YAML with basic auth parameters in it 'Soaspec.credentials_folder' can be set to globally defined a folder with credentials
+  # It is of the format
+  # user: 'username'
+  # password: 'password'
+  # basic_auth_file 'basic_auth.yml' # Load YAML file with basic auth credentials in it
+
+  ### Request Body
+
+  # Filename of template to be used. This is within 'Soaspec.template_folder' folder
+  # template_name 'filename'
+
+  # Default hash to be used in request that will be converted to JSON. This can be overriden and added to by each Exchange using this class
+  # default_hash a: 1, b: 2
+
+  ## Extracting response
+
+  # Use this to extract the value of either a JSON (JSONPath) or XML (Xpath) element. 'element_name' is the method that will be
+  # generated on an Exchange to obtain it
+  # element :element_name, 'element_path'
+
+  # Use this to extract an attribute from XML. If the name of the method and the attribute name are the same then only one parameter is
+  # needed
+  # attribute(:attribute_method_name, 'name_of_attribute')
+
+  ## Creating verifications for success response
+
+  # Values that must have a certain value for 'success scenario' shared example
+  # mandatory_json_values '$..status' => 'available'
+
+  # Elements that must be in the response for 'success scenario' shared example
+  # Below will expect an element at the path 'tags' to be present
+  # mandatory_elements :tags
+end

data/lib/soaspec/generator/lib/new_soap_service.rb.erb

@@ -0,0 +1,30 @@
+# This class represent SOAP Api calls for the <%= @name %> API
+class <%= @name %> < Soaspec::SoapHandler
+  # Wsdl for <%= @name %>
+  def savon_options
+      {
+          # wsdl 'https://my_host/api?wsdl' TODO: Change this to the wsdl that this SOAP service uses
+      }
+  end
+
+  ## Verifying on response
+
+  # Values that must have a certain value for 'success scenario' shared example
+  # mandatory_json_values '$..status' => 'available'
+
+  # Elements that must be in the response for 'success scenario' shared example
+  # Below will expect an element at the path 'tags' to be present
+  # mandatory_elements :tags
+
+  # Use this to extract the value of either a JSON (JSONPath) or XML (Xpath) element. 'element_name' is the method that will be
+  # generated on an Exchange to obtain it
+  # element :element_name, 'element_path'
+
+  # Use this to extract an attribute from XML. If the name of the method and the attribute name are the same then only one parameter is
+  # needed
+  # attribute(:attribute_method_name, 'name_of_attribute')
+
+  # Set an attribute on the root XML element
+  # root_attributes 'Version' => '1'
+
+end

data/lib/soaspec/matchers.rb

@@ -62,5 +62,28 @@ RSpec::Matchers.define :be_found do
   failure_message do |exchange|
     "expected result #{exchange.response} to be found. Status code is #{exchange.response.code}"
   end
+end
 
-end
+# Whether response has successful status code and correct mandatory elements and values
+RSpec::Matchers.define :be_successful do
+  match do |actual|
+    failure_list = []
+    exchange = actual.respond_to?(:exchange) ? actual.exchange : actual
+    failure_list << "#{exchange.status_code} not valid status code" unless (200..299).cover?(exchange.status_code)
+    exchange.exchange_handler.expected_mandatory_elements.each do |mandatory_element_path|
+      begin
+        exchange[mandatory_element_path]
+      rescue NoElementAtPath => error
+        failure_list << error.message
+      end
+    end
+    exchange.exchange_handler.expected_mandatory_xpath_values.each do |path, value|
+      failure_list << "Expected value at xpath '#{path}' to be '#{value}' but was '#{exchange[path]}'" unless exchange[path] == value
+    end
+    exchange.exchange_handler.expected_mandatory_json_values.each do |path, value|
+      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/soaspec_shared_examples.rb

@@ -17,7 +17,7 @@ shared_examples_for 'success scenario' do
     end
   end
   described_class.exchange_handler.expected_mandatory_json_values.each do |xpath, value|
-    it "has xpath '#{xpath}' equal to '#{value}'" do
+    it "has json '#{xpath}' equal to '#{value}'" do
       expect(described_class).to have_xpath_value(xpath => value)
     end
   end

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.1.18'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.2.0
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-18 00:00:00.000000000 Z
+date: 2018-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -361,11 +361,13 @@ files:
 - lib/soaspec/exchange.rb
 - lib/soaspec/exchange_handlers/exchange_handler.rb
 - lib/soaspec/exchange_handlers/handler_accessors.rb
-- lib/soaspec/exchange_handlers/rest_accessors.rb
-- lib/soaspec/exchange_handlers/rest_accessors_defaults.rb
+- lib/soaspec/exchange_handlers/rest_exchanger_factory.rb
 - lib/soaspec/exchange_handlers/rest_handler.rb
 - lib/soaspec/exchange_handlers/rest_methods.rb
+- lib/soaspec/exchange_handlers/rest_parameters.rb
+- lib/soaspec/exchange_handlers/rest_parameters_defaults.rb
 - lib/soaspec/exchange_handlers/soap_handler.rb
+- lib/soaspec/exchange_properties.rb
 - lib/soaspec/exe_helpers.rb
 - lib/soaspec/generator/.rspec.erb
 - lib/soaspec/generator/.travis.yml.erb
@@ -375,6 +377,8 @@ files:
 - lib/soaspec/generator/config/data/default.yml.erb
 - lib/soaspec/generator/lib/blz_service.rb.erb
 - lib/soaspec/generator/lib/dynamic_class_content.rb.erb
+- lib/soaspec/generator/lib/new_rest_service.rb.erb
+- lib/soaspec/generator/lib/new_soap_service.rb.erb
 - lib/soaspec/generator/lib/package_service.rb.erb
 - lib/soaspec/generator/lib/shared_example.rb.erb
 - lib/soaspec/generator/spec/dynamic_soap_spec.rb.erb

data/lib/soaspec/exchange_handlers/rest_accessors.rb

@@ -1,56 +0,0 @@
-require_relative 'rest_accessors_defaults'
-
-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
-
-    # Will create access_token method based on passed parameters
-    # @param [Hash] params OAuth 2 parameters
-    # @param_value [token_url] URL to retrieve OAuth token from. @Note this can be set globally instead of here
-    # @param_value [client_id] Client ID
-    # @param_value [client_secret] Client Secret
-    # @param_value [username] Username used in password grant
-    # @param_value [password] Password used in password grant
-    # @param_value [security_token] Security Token used in password grant
-    def oauth2(params)
-      # @!method oauth_obj Object to handle oauth2
-      define_method('oauth_obj') { OAuth2.new(params, api_username) }
-      # @!method access_token Retrieve OAuth2 access token
-      define_method('access_token') { oauth_obj.access_token }
-      # @!method instance_url Retrieve instance url from OAuth request
-      define_method('instance_url') { oauth_obj.response['instance_url'] }
-    end
-
-    # Pass path to YAML file containing OAuth2 parameters
-    # @param [String] path_to_filename Will have Soaspec.credentials_folder appended to it if set
-    def oauth2_file(path_to_filename)
-      full_path = Soaspec.credentials_folder ? File.join(Soaspec.credentials_folder, path_to_filename) : path_to_filename
-      full_path += '.yml' unless full_path.end_with?('.yml')
-      file_hash = YAML.load_file(full_path)
-      raise 'File at ' + full_path + ' is not a hash ' unless file_hash.is_a? Hash
-      oauth2 file_hash
-    end
-
-    # @param [Hash] headers Hash of REST headers used in RestClient
-    def headers(headers)
-      define_method('rest_client_headers') do
-        headers
-      end
-    end
-
-    # Convert each key from snake_case to PascalCase
-    def pascal_keys(set)
-      define_method('pascal_keys?') do
-        set
-      end
-    end
-  end
-end