soaspec 0.0.46 → 0.0.47

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f81e429ef1b144e0977520e79fd5ae9890bf3a89
-  data.tar.gz: ed934b5fcddfee84837c3dbedfd4b90b424377e5
+  metadata.gz: 687a34b22e83e1010cf5619a8abbe2279b15954f
+  data.tar.gz: be4f8c9f0f1732e3cb416aa9f812f537330af1a0
 SHA512:
-  metadata.gz: a64529f623d73ffe61da1c0d0ed28725d19ee4d26563ff804c24f7ea3c36dba203947a216169b3570d1df8b88a3e97e0e10a3de54e71a568da13caacc935ca34
-  data.tar.gz: 0b1f8d43be55b3a7a810a5968894093a8d42bebd0e51d46b25921f787c1f8763cf7afc2bafa3fdea97962678ca6dd52f61737c857ca327fff473999fc1fe355a
+  metadata.gz: 5f3c5fd3b00ba6e174aaef074770f6b1f4623f6744137e58dc204bca86f8406d9a94a26fd4f7a10c5f73c40f53ef8dca8ebb890656633b3fd628e76ecc6f6b03
+  data.tar.gz: b9bea7f0d4ec52d9d580a249d7fe3492484c784e1c1d9661a79c8e9113bbec126d1b627e278421eddce9edea430b7189b85534a592dee43ea808b98dd0fd1434

data/ChangeLog

@@ -1,3 +1,7 @@
+Version 0.0.47
+* Enhancements
+  * 'success scenarios' shared eg and 'retry_for_success' exchange method's status codes include 200..299, not just 200.
+
 Version 0.0.46
 * Enhancements
   * 'include_key?' method use 'value_from_path'. Iterating through Hashes with 'include_key?' wouldn't work as expected with some JSON bodies with my current implementation

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    soaspec (0.0.46)
+    soaspec (0.0.47)
       jsonpath
       rest-client (>= 2.0)
       rspec (~> 3.0)

data/Todo.md

@@ -3,6 +3,7 @@
 * Demonstrate using Cucumber
 * Give examples and convenience methods for building classes for each SOAP or REST operation
 * Handle REST template (similar way to SOAP)
+* spec for oauth demonstrating sharing same oauth params across multiple classes
 * Potentially have in built use of 'vcr' and 'http_stub' gems
 * Handle proxies to record traffic for MiddleWare testing
 * Much more

data/lib/soaspec.rb

@@ -11,6 +11,7 @@ require 'jsonpath'
 require 'soaspec/version'
 require 'soaspec/exchange_handlers/soap_handler'
 require 'soaspec/exchange_handlers/exchange_handler'
+require 'soaspec/exchange_handlers/rest_methods'
 require 'soaspec/exchange'
 require 'soaspec/matchers'
 require 'soaspec/soaspec_shared_examples'
@@ -25,130 +26,54 @@ require 'soaspec/not_found_errors'
 # Gem for handling SOAP and REST api tests
 module Soaspec
 
-  # Folder used to store credentials
-  # Used in auth2_file command
-  # @param [String] folder
-  def self.credentials_folder=(folder)
-    @credentials_folder = folder
-  end
-
-  # Credentials folder used to store secret data (not in source control) E.g passwords
-  def self.credentials_folder
-    @credentials_folder
-  end
-
-  # Used so that exchange class knows what context it's in
-  # @param [ExchangeHandler] handler A class inheriting from Soaspec::ExchangeHandler. Exchange class uses this
-  def self.api_handler=(handler)
-    @api_handler = handler
-  end
-
-  def self.api_handler
-    @api_handler
-  end
+  class << self
 
-  # Whether to transform strings to keys automatically
-  def self.always_use_keys=(use_keys)
-    @always_use_keys = use_keys
-  end
-
-  def self.always_use_keys?
-    @always_use_keys || true
-  end
-
-  # Whether to remove namespaces from response in Xpath assertion automatically
-  # For why this may not be a good thing in general see
-  # http://tenderlovemaking.com/2009/04/23/namespaces-in-xml.html
-  # This will be overridden if xpath has a ':' in it
-  def self.strip_namespaces=(remove_namespaces_from_response)
-    @strip_namespaces = remove_namespaces_from_response
-  end
-
-  # Whether to remove namespaces in xpath assertion automatically
-  def self.strip_namespaces?
-    @strip_namespaces || false
-  end
+    # Folder used to store credentials
+    # Used in auth2_file command
+    # @param [String] folder
+    def credentials_folder=(folder)
+      @credentials_folder = folder
+    end
 
-  # -Deprecated- for favour of putting directly in Soaspec
-  # Represents Environment parameters used in Soaspec tests
-  module Environment
+    # Credentials folder used to store secret data (not in source control) E.g passwords
+    def credentials_folder
+      @credentials_folder
+    end
 
     # Used so that exchange class knows what context it's in
-    def self.api_handler=(handler)
-      Soaspec.api_handler = handler
+    # @param [ExchangeHandler] handler A class inheriting from Soaspec::ExchangeHandler. Exchange class uses this
+    def api_handler=(handler)
+      @api_handler = handler
     end
 
-    def self.api_handler
-      Soaspec.api_handler
+    def api_handler
+      @api_handler
     end
 
-    # Whether to transform strings to keys automatically
-    def self.always_use_keys=(use_keys)
-      Soaspec.always_use_keys = use_keys
+    # Set whether to transform strings to keys in request automatically
+    # @param [Boolean] use_keys
+    def always_use_keys=(use_keys)
+      @always_use_keys = use_keys
     end
 
-    def self.always_use_keys?
-      Soaspec.always_use_keys? || true
+    # @return [Boolean] Whether to transform strings to keys in request automatically
+    def always_use_keys?
+      @always_use_keys || true
     end
 
     # Whether to remove namespaces from response in Xpath assertion automatically
     # For why this may not be a good thing in general see
     # http://tenderlovemaking.com/2009/04/23/namespaces-in-xml.html
     # This will be overridden if xpath has a ':' in it
-    def self.strip_namespaces=(remove_namespaces_from_response)
-      Soaspec.strip_namespaces = remove_namespaces_from_response
+    def strip_namespaces=(remove_namespaces)
+      @strip_namespaces = remove_namespaces
     end
 
     # Whether to remove namespaces in xpath assertion automatically
-    def self.strip_namespaces?
-      Soaspec.strip_namespaces? || false
-    end
-
-  end
-
-  # Contains commonly used REST methods
-  module RestMethods
-    # Make REST Post Exchange
-    # @param [String] name Name of test displayed
-    # @param [Hash] params Exchange parameters
-    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
-    def post(name, params = {})
-      Exchange.new(name, method: :post, **params)
-    end
-
-    # Make REST Patch Exchange
-    # @param [String] name Name of test displayed
-    # @param [Hash] params Exchange parameters
-    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
-    def patch(name, params = {})
-      Exchange.new(name, method: :patch, **params)
-    end
-
-    # Make REST Put Exchange
-    # @param [String] name Name of test displayed
-    # @param [Hash] params Exchange parameters
-    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
-    def put(name, params = {})
-      Exchange.new(name, method: :put, **params)
-    end
-
-    # Make REST Get Exchange
-    # @param [String] name Name of test displayed
-    # @param [Hash] params Exchange parameters
-    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
-    def get(name, params = {})
-      Exchange.new(name, method: :get, **params)
-    end
-
-    # Make REST Delete Exchange
-    # @param [String] name Name of test displayed
-    # @param [Hash] params Exchange parameters
-    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
-    def delete(name, params = {})
-      Exchange.new(name, method: :delete, **params)
+    def strip_namespaces?
+      @strip_namespaces || false
     end
   end
-
 end
 
 RestClient.log = Soaspec::SpecLogger.create

data/lib/soaspec/exchange.rb

@@ -3,6 +3,7 @@ require_relative '../soaspec'
 # This represents a request / response pair
 class Exchange
 
+  # Class of Api Handler for which this exchange is made
   attr_reader :api_class
   # How many times to retry for a success
   attr_accessor :retry_count
@@ -23,7 +24,7 @@ class Exchange
   # @param [Hash] override_parameters Parameters to override for default params
   def initialize(name, override_parameters = {})
     @test_name = name.to_s
-    @api_class = Soaspec.api_handler
+    @api_class = Soaspec.api_handler # This uses the global parameter. The handler should be set straight before an exchange is made
     @override_parameters = override_parameters
     @retry_for_success = false
     self.retry_count = 3
@@ -37,7 +38,7 @@ class Exchange
     retry_count.times do
       response = @api_class.make_request(@override_parameters)
       return response unless retry_for_success?
-      return response if @api_class.status_code_for(response) == 200
+      return response if (200..299).cover? @api_class.status_code_for(response)
       response
     end
   end

data/lib/soaspec/exchange_handlers/rest_methods.rb

@@ -0,0 +1,45 @@
+
+module Soaspec
+  # Contains commonly used REST methods
+  module RestMethods
+    # Make REST Post Exchange
+    # @param [String] name Name of test displayed
+    # @param [Hash] params Exchange parameters
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def post(name, params = {})
+      Exchange.new(name, method: :post, **params)
+    end
+
+    # Make REST Patch Exchange
+    # @param [String] name Name of test displayed
+    # @param [Hash] params Exchange parameters
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def patch(name, params = {})
+      Exchange.new(name, method: :patch, **params)
+    end
+
+    # Make REST Put Exchange
+    # @param [String] name Name of test displayed
+    # @param [Hash] params Exchange parameters
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def put(name, params = {})
+      Exchange.new(name, method: :put, **params)
+    end
+
+    # Make REST Get Exchange
+    # @param [String] name Name of test displayed
+    # @param [Hash] params Exchange parameters
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def get(name, params = {})
+      Exchange.new(name, method: :get, **params)
+    end
+
+    # Make REST Delete Exchange
+    # @param [String] name Name of test displayed
+    # @param [Hash] params Exchange parameters
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def delete(name, params = {})
+      Exchange.new(name, method: :delete, **params)
+    end
+  end
+end

data/lib/soaspec/soaspec_shared_examples.rb

@@ -1,8 +1,8 @@
 require 'rspec'
 
 shared_examples_for 'success scenario' do
-  it 'has status code of 200' do
-    expect(described_class.status_code).to eq 200
+  it 'has successful status code' do
+    expect(200..299).to cover described_class.status_code
   end
   context 'has expected mandatory elements' do
     described_class.api_class.expected_mandatory_elements.each do |mandatory_element|
@@ -21,6 +21,4 @@ shared_examples_for 'success scenario' do
       expect(described_class).to have_xpath_value(xpath => value)
     end
   end
-
-
-end
+end

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.0.46'
+  VERSION = '0.0.47'
 end

data/soaspec.gemspec

@@ -1,5 +1,5 @@
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'soaspec/version'
 
@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ['SamuelGarrattIQA']
   spec.email         = ['samuel.garratt@integrationqa.com']
 
-  spec.summary       = %q{Helps to create RSpec specs for SOAP or REST apis }
-  spec.description   = %q{Helps to create RSpec specs for SOAP or REST apis. Easily represent multiple requests with
-the same configuration }
+  spec.summary       = "Helps to create RSpec specs for 'SOAP' or 'REST' apis "
+  spec.description   = "Helps to create RSpec specs for 'SOAP' or 'REST' apis. Easily represent multiple requests with
+the same configuration "
   spec.homepage      = 'https://gitlab.com/samuel-garratt/soaspec'
   spec.license       = 'MIT'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.0.46
+  version: 0.0.47
 platform: ruby
 authors:
 - SamuelGarrattIQA
@@ -136,7 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.5
-description: "Helps to create RSpec specs for SOAP or REST apis. Easily represent
+description: "Helps to create RSpec specs for 'SOAP' or 'REST' apis. Easily represent
   multiple requests with\nthe same configuration "
 email:
 - samuel.garratt@integrationqa.com
@@ -171,6 +171,7 @@ files:
 - lib/soaspec/exchange.rb
 - lib/soaspec/exchange_handlers/exchange_handler.rb
 - lib/soaspec/exchange_handlers/rest_handler.rb
+- lib/soaspec/exchange_handlers/rest_methods.rb
 - lib/soaspec/exchange_handlers/soap_handler.rb
 - lib/soaspec/exe_helpers.rb
 - lib/soaspec/hash_methods.rb
@@ -209,5 +210,5 @@ rubyforge_project:
 rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Helps to create RSpec specs for SOAP or REST apis
+summary: Helps to create RSpec specs for 'SOAP' or 'REST' apis
 test_files: []