soaspec 0.0.22 → 0.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 255d203844878ea2e75b0ef6ac282848d2363dbb
-  data.tar.gz: 99b6c40e7ba36d670fc7e16bbe1eee5760457082
+  metadata.gz: 72616e1074159a6f95e6def516fd54d1b9bae9c2
+  data.tar.gz: c63d9d36c73c36e14dc817ec9f846e01bd0cf3ef
 SHA512:
-  metadata.gz: 8dbd21eb8c38debaf22104b30523eb017d367586c3b0a1e530216b63a0fb68da351318941c138925403ebe07121a3f12f3d32794adc7e015e1a89c2d0a64cd46
-  data.tar.gz: 3e299cd2d4a87dbf2cf1e9e36e4207840ce96947a510a686a73abad6803e809d3f985f793f1dfdbfe7efd5c39c4f9a2741bbe4109f5d7be959839758c79c6e90
+  metadata.gz: 6d88345669ab61df3b26d28c3fad0e3ac860693426f348519f17e8e05eb89f1f7343085a81ed41b846251c167ff7a499ae7fbb435e84aaaead3ac4cef867777f
+  data.tar.gz: 7e63562503b905cceb8597d8d06947f774129df9631d0a9a9423e472dc3de174d52e9662c6b3987b2905fb4b1b285f2efcfb232c41d1b7838a4de7639d2d9574

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Max: 154

data/ChangeLog

@@ -1,3 +1,7 @@
+Version 0.0.23 / 2018-2-23
+* Enhancements
+  * Created RestHandler class (Very messy and ugly still) to handle REST requests using style used for SOAP using Rest Client resource
+
 Version 0.0.22 / 2018-2-15
 * Enhancements
   * Created new 'include_in_body' matcher to find value anywhere in response body (which could be a substring of an element)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    soaspec (0.0.22)
+    soaspec (0.0.23)
       rest-client (>= 2.0)
       rspec (~> 3.0)
       rspec-its (>= 1.2.0)

data/lib/soaspec.rb

@@ -16,6 +16,7 @@ require 'soaspec/soaspec_shared_examples'
 require 'soaspec/hash_methods'
 require 'soaspec/spec_logger'
 require 'soaspec/file_helpers'
+require 'soaspec/rest_handler'
 
 # Gem for handling SOAP and REST api tests
 module Soaspec

data/lib/soaspec/basic_soap_handler.rb

@@ -104,6 +104,10 @@ module Soaspec
       {}
     end
 
+    def include_in_body?(response, expected)
+      response.to_xml.to_s.include? expected
+    end
+
     # Attributes set at the root XML element of SOAP request
     def root_attributes
       nil
@@ -117,7 +121,6 @@ module Soaspec
           temp_doc.remove_namespaces!
           temp_doc.xpath(param[:xpath]).first
         else
-          puts 'no strip' + param[:xpath]
           param[:exchange].response.xpath(param[:xpath]).first
         end
       raise NoElementAtXpath, "No value at Xpath '#{param[:xpath]}'" unless result

data/lib/soaspec/matchers.rb

@@ -4,6 +4,7 @@ require_relative 'xpath_not_found'
 
 # TODO: Mathcers are specific to SOAP. Make generic for REST and others by using actual.api_class
 
+# Whether response has any element with the provided value
 RSpec::Matchers.define :contain_value do |expected|
   match do |actual|
     expect(actual.response.body.include_value?(expected)).to be true
@@ -14,9 +15,10 @@ RSpec::Matchers.define :contain_value do |expected|
   end
 end
 
+# Whether substring exists in body of response (more general than above)
 RSpec::Matchers.define :include_in_body do |expected|
   match do |actual|
-    expect(actual.response.to_xml.to_s.include?(expected)).to be true
+    expect(actual.api_class.include_in_body?(actual.response, expected)).to be true
   end
 
   failure_message do |actual|
@@ -24,6 +26,7 @@ RSpec::Matchers.define :include_in_body do |expected|
   end
 end
 
+# Whether expected element exists in body
 RSpec::Matchers.define :contain_key do |expected|
   match do |actual|
     expect(actual.response.body.include_key?(expected)).to be true
@@ -34,12 +37,19 @@ RSpec::Matchers.define :contain_key do |expected|
   end
 end
 
+# Whether an element exists at expected xpath
 RSpec::Matchers.define :have_element_at_xpath do |xpath|
   match do |exchange|
-    expect { exchange[xpath] }.to_not raise_error NoElementAtXpath
+    expect { exchange[xpath] }.to_not raise_error
+  end
+
+  failure_message do |actual|
+    "expected that #{actual.response.to_xml} would have element at xpath '#{xpath}'"
   end
 end
 
+# Whether an element at xpath (defined by key) has value (defined by value).
+# @param [Hash] expected_hash Xpath => Value pair (e.g. '//xmlns:GetWeatherResult' => 'Data Not Found')
 RSpec::Matchers.define :have_xpath_value do |expected_hash|
   match do |exchange|
     expected_hash = Hash[*expected_hash.flatten] if expected_hash.is_a?(Array) # For some reason Array was occuring

data/lib/soaspec/rest_handler.rb

@@ -0,0 +1,120 @@
+
+require_relative 'tester'
+require_relative 'hash_methods'
+require_relative 'xpath_not_found'
+
+module Soaspec
+  # Wraps around Savon client defining default values dependent on the soap request
+  class RestHandler < Tester
+    # Savon client used to make SOAP calls
+    attr_accessor :client
+    # SOAP Operation to use by default
+    attr_accessor :operation
+
+    # Options to log xml request and response
+    def logging_options
+      {
+           # See request and response. (Put this in traffic file)
+      }
+    end
+
+    # Default Savon options. See http://savonrb.com/version2/globals.html for details
+    # @return [Hash] Default Savon options for all BasicSoapHandler
+    def default_options
+      {
+          # method: :get
+          # headers: { content_type: 'text/plain' }
+      }
+    end
+
+    # Override in class
+    def base_url
+      ''
+    end
+
+    # Add values to here when extending this class to have default REST options.
+    # See rest client resource for details
+    # @return [Hash] Options adding to & overriding defaults
+    def rest_resource_options
+      {
+      }
+    end
+
+    # Setup object to handle communicating with a particular SOAP WSDL
+    # @param [Hash] specific_options Options defining SOAP request. WSDL, authentication, see http://savonrb.com/version2/globals.html for list of options
+    def initialize(name, specific_options = {})
+      options = default_options.merge logging_options
+      options.merge! rest_resource_options
+      options.merge!(specific_options)
+      @resource = RestClient::Resource.new(base_url, options: options) # @resource[url_extension].get
+      super
+    end
+
+    def name(name)
+      @test_values = {}
+      @test_name = name
+      self
+    end
+
+    def override(request_parameters)
+      @test_values = request_parameters
+      self
+    end
+
+    # Used in together with Exchange request that passes such override parameters
+    def make_request(override_parameters)
+      test_values = override_parameters
+      test_values[:params] ||= {}
+
+      @resource[test_values[:suburl]].send(test_values[:method].to_s, test_values[:params])
+    end
+
+    def include_in_body?(response, expected)
+      response.body.include? expected
+    end
+
+    def status_code_for(response)
+      response.code
+    end
+
+    # Override this to specify elements that must be present in the response
+    # Will be used in 'success_scenarios' shared examples
+    # @return [Array] Array of symbols specifying element names
+    def mandatory_elements
+      []
+    end
+
+    # Override this 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 mandatory_xpath_values
+      {}
+    end
+
+    # Attributes set at the root XML element of SOAP request
+    def root_attributes
+      nil
+    end
+
+    # Returns the value at the provided xpath
+    def xpath_value_for(param)
+      result =
+          if Soaspec::Environment.strip_namespaces? && !param[:xpath].include?(':')
+            temp_doc = param[:exchange].response.doc
+            temp_doc.remove_namespaces!
+            temp_doc.xpath(param[:xpath]).first
+          else
+            puts 'no strip' + param[:xpath]
+            param[:exchange].response.xpath(param[:xpath]).first
+          end
+      raise NoElementAtXpath, "No value at Xpath '#{param[:xpath]}'" unless result
+      result.inner_text
+    end
+
+    def value_from_path(exchange, path)
+      path = '//' + path if path[0] != '/'
+      xpath_value_for(exchange: exchange, xpath: path)
+    end
+
+  end
+end

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.0.22'
+  VERSION = '0.0.23'
 end

data/test_rest.rb

@@ -0,0 +1,76 @@
+
+require 'rest-client'
+
+options = {
+  headers: {
+   # accept: "application/xml",
+    accept: "application/json"
+  #  content_type: "application/json",
+ #   log: Logger.new('logs/traffic.log')
+  }
+}
+
+RestClient.log = Logger.new('logs/traffic.log')
+
+data_string = <<-EOF
+{
+  "id": 1,
+  "category": {
+    "id": 0,
+    "name": "string"
+  },
+  "name": "doggie",
+  "photoUrls": [
+    "string"
+  ],
+  "tags": [
+    {
+      "id": 0,
+      "name": "string"
+    }
+  ],
+  "status": "available"
+}
+EOF
+
+
+data = {
+  id: '1',
+  category: {
+    id: '1',
+    name: "test"
+  },
+  name: "cat",
+  photoUrls: [
+    "string"
+  ],
+  tags: [
+    {
+      id: '2',
+      name: "cute"
+    }
+  ],
+  status: "closed"
+}
+
+resource = RestClient::Resource.new('http://petstore.swagger.io/v2', options)
+# begin
+#   response = resource['pet'].post(data)
+# rescue RestClient::ExceptionWithResponse => e
+#   puts e.response
+# end
+
+begin
+  #response = resource['store/order/1'].get
+  #response = resource['store/inventory'].get
+  #
+  response = resource['pet/findByStatus?status=sold'].get(accept: 'application/xml')
+  #response = resource['pet'].post(data_string, additional_headers: { accept: "application/json"})
+rescue RestClient::ExceptionWithResponse => e
+  puts e.response
+end
+
+#puts response.to_s
+puts response.body
+puts response.code
+puts response.request

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.0.22
+  version: 0.0.23
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2018-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -135,6 +135,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - ChangeLog
@@ -155,6 +156,7 @@ files:
 - lib/soaspec/file_helpers.rb
 - lib/soaspec/hash_methods.rb
 - lib/soaspec/matchers.rb
+- lib/soaspec/rest_handler.rb
 - lib/soaspec/soaspec_shared_examples.rb
 - lib/soaspec/spec_logger.rb
 - lib/soaspec/tester.rb
@@ -164,6 +166,7 @@ files:
 - template/soap_template.xml
 - test.wsdl
 - test.xml
+- test_rest.rb
 - test_wsdl.rb
 homepage: https://gitlab.com/samuel-garratt/soaspec
 licenses: