soaspec 0.0.35 → 0.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c7df2a27ca4097085513de2d9afa7d45e8eb9ff
-  data.tar.gz: 691d473c89b69df0dbb5fcb21ffdfe13c67dd236
+  metadata.gz: '0877db6205f535e6fe2c1999d6fd43efc7c8c968'
+  data.tar.gz: cd409d133b72f33a343dcd2c6dae74e23bda9c00
 SHA512:
-  metadata.gz: 2a5a1e6b75df8eca6e4b03ac1e654e0d649c92dcbb72af84852115f5cdf3b8427697fdaf8a1aff779398c9d993e8734eeb4b0b2340a7e59e2956b15fd1178935
-  data.tar.gz: 38e3753dfaf0f7eeb859601777a3158019fa84cb5e0e1497b03cccc3143f6fd8b3f2b09ad0cce493c52fc46ff120d60ec0c319077747ec08e938d8e90a8fe4e4
+  metadata.gz: 0cf6f5d024199e9a4518bb86054927f768e096ae34c9f9686b8c58a5d79163fe979dbb3fc01448c90c89a2d057399e00f0ac0ff012e7ac3564e27f9d45a5ecd4
+  data.tar.gz: 630e900ca4727d7f17bec11c0d947c12e1378f57acadbe67cfae4442425f69807ca2abdf1dede554d7cbf477861b97002a543f1283d3f6bb64cd66068f64fed6

data/.gitlab-ci.yml

@@ -0,0 +1,10 @@
+before_script:
+  - apt-get update -qq && apt-get install -y -qq sqlite3 libsqlite3-dev nodejs
+  - ruby -v
+  - which ruby
+  - gem install bundler rake --no-ri --no-rdoc
+  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+
+rspec:
+  script:
+    - bundle exec rake spec

data/ChangeLog

@@ -1,3 +1,12 @@
+Version 0.0.36 / 2018-3-15
+* Bug fix
+   * Make test name log in correct place
+* Enhancements
+  * Made accessor 'mandatory_json_values' to make it easier to share mandatory json path - value pairs
+  * Created 'store' method for handler through which one can store a value and use it later on it in the same context
+* Deprecated
+  * Removed old 'mandatory_elements', 'mandatory_xpath_values' overridden way of handling data for favor of new way of it setting 'expected_mandatory_elements'
+
 Version 0.0.35 / 2018-3-13
 * Enhancements
   * Handle array of JSON hashes starting with '['

data/Gemfile.lock

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

data/Rakefile

@@ -3,9 +3,10 @@ require 'rspec/core/rake_task'
 require 'rake/clean'
 
 ENV['folder'] ||= ''
+ENV['test'] ||= ''
 
 RSpec::Core::RakeTask.new(:run_spec) do |t|
-  t.pattern = "spec/*/#{ENV['folder']}*/*_spec.rb"
+  t.pattern = "spec/*/#{ENV['folder']}*/#{ENV['test']}*_spec.rb"
 end
 
 desc 'Prepare log files'

data/config/data/default.yml

@@ -3,7 +3,7 @@ japan:
   country_name: 'Japan'
 
 pet:
-  id: '1'
+  id: '1122334400'
   category:
     id: '1'
     name: 'string'
@@ -14,3 +14,42 @@ pet:
     - id: '1'
       name: 'string'
   status: sold
+
+pet1:
+  id: '123987'
+  category:
+    id: '1'
+    name: 'string'
+  name: 'new_puppy'
+  photoUrls:
+    - 'string'
+  tags:
+    - id: '1'
+      name: 'string'
+  status: available
+
+pet2:
+  id: '9998772'
+  category:
+    id: '1'
+    name: 'string'
+  name: 'new_puppy'
+  photoUrls:
+    - 'string'
+  tags:
+    - id: '1'
+      name: 'string'
+  status: available
+
+pet3:
+  id: '554678'
+  category:
+    id: '1'
+    name: 'string'
+  name: 'new_puppy'
+  photoUrls:
+    - 'string'
+  tags:
+    - id: '1'
+      name: 'string'
+  status: available

data/lib/soaspec/accessors.rb

@@ -3,11 +3,12 @@ module Soaspec
   # Some are included in 'success scenarios' and to configure the request sent
   module Accessors
 
-    # Defines expected_mandatory_elements method used in 'success_scenarios' shared examples
+    # Defines expected_mandatory_elements method used in 'success_scenario' shared examples
     # to indicate certain elements must be present
-    # @param [Array] elements Array of symbols specifying expected element names for 'success_scearios' in snakecase
+    # @param [Array] elements Array of symbols specifying expected element names for 'success scenario' in snakecase
     def mandatory_elements(elements)
       define_method('expected_mandatory_elements') do
+        return [elements] if elements.is_a?(String) || elements.is_a?(Symbol)
         elements
       end
     end
@@ -29,5 +30,22 @@ module Soaspec
       end
     end
 
+    # Defines mandatory json path value pairs to be included in 'success scenario' shared example
+    #
+    # @example Inside class
+    #   mandatory_json_values '$..GetWeatherResult' => 'Found'
+    #
+    # In test
+    # describe Exchange(:name) do
+    #   it_behaves_like 'success scenario' # Includes json pair validation
+    # end
+    #
+    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
+    end
+
   end
 end

data/lib/soaspec/exchange.rb

@@ -5,6 +5,8 @@ class Exchange
 
   attr_reader :api_class
 
+  # @param [Symbol, String] name Name shown in RSpec run
+  # @param [Hash] override_parameters Parameters to override for default params
   def initialize(name, override_parameters = {})
     @test_name = name.to_s
     @api_class = Soaspec::Environment.api_handler
@@ -13,6 +15,7 @@ class Exchange
 
   # Make request to handler with parameters defined
   def make_request
+    Soaspec::SpecLogger.add_to 'Example ' + @test_name
     @api_class.make_request(@override_parameters)
   end
 
@@ -20,7 +23,6 @@ class Exchange
   # This will make the request and store the response
   # @return [String] Name given when initializing
   def to_s
-    Soaspec::SpecLogger.add_to 'Example ' + @test_name
     @test_name
   end
 
@@ -35,7 +37,7 @@ class Exchange
   # Get status code from api class. This is http response for Web Api
   # @return [Integer] Status code from api class
   def status_code
-    @api_class.status_code_for(self.response)
+    @api_class.status_code_for(response)
   end
 
   # Extract value from path api class

data/lib/soaspec/exchange_handlers/exchange_handler.rb

@@ -35,21 +35,27 @@ module Soaspec
       []
     end
 
-    # Use this to set 'expected_mandatory_elements' see 'accessors'
-    def mandatory_elements
-      []
+    # Change this through 'mandatory_xpath_values' method to specify xpath results that must be present in the response
+    # Will be used in 'success_scenarios' shared examples
+    # @return [Hash] Hash of 'xpath' => 'expected value' pairs
+    def expected_mandatory_xpath_values
+      {}
     end
 
-    # Override this to specify xpath results that must be present in the response
+    # Change this through 'mandatory_json_values' method to specify json results that must be present in the response
     # Will be used in 'success_scenarios' shared examples
     # @return [Hash] Hash of 'xpath' => 'expected value' pairs
-    def expected_mandatory_xpath_values
+    def expected_mandatory_json_values
       {}
     end
 
-    # Use this to set 'expected_mandatory_xpath_values' see 'accessors'
-    def mandatory_xpath_values
-      []
+    # Stores a value in a method that can be accessed by the provided name
+    # @param [Symbol] name Name of method to use to access this value within handler
+    # @param [String] value Value to store
+    def store(name, value)
+      define_singleton_method(name.to_s) do
+        value
+      end
     end
 
   end

data/lib/soaspec/soaspec_shared_examples.rb

@@ -10,24 +10,17 @@ shared_examples_for 'success scenario' do
         expect(described_class).to contain_key mandatory_element
       end
     end
-    # TODO: Remove this. Handle deprecated method temporarily
-    described_class.api_class.mandatory_elements.each do |mandatory_element|
-      puts "Overriding 'mandatory_elements' deprecated. Use new 'expected_mandatory_elements' instead of overriding this method"
-      it mandatory_element do
-        expect(described_class).to contain_key mandatory_element
-      end
-    end
   end
   described_class.api_class.expected_mandatory_xpath_values.each do |xpath, value|
     it "has xpath '#{xpath}' equal to '#{value}'" do
       expect(described_class).to have_xpath_value(xpath => value)
     end
   end
-  # TODO: Remove deprecated method
-  described_class.api_class.mandatory_xpath_values.each do |xpath, value|
-    puts "Overriding 'mandatory_elements' deprecated. Use new 'expected_mandatory_elements' instead of overriding this method"
+  described_class.api_class.expected_mandatory_json_values.each do |xpath, value|
     it "has xpath '#{xpath}' equal to '#{value}'" do
       expect(described_class).to have_xpath_value(xpath => value)
     end
   end
+
+
 end

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.0.35'
+  VERSION = '0.0.36'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.0.35
+  version: 0.0.36
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2018-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,6 +148,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"