soaspec 0.0.24 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4aaad0d9e089c5a7a5ed3f22e36ad11f74304065
-  data.tar.gz: 3a6ace44416ff6c6997012171e7d3c6875971ad4
+  metadata.gz: 6c1bcd1af7218c1860476c8b8c71d8cb97236640
+  data.tar.gz: ac9d54164f634b5887a22eb87779eb8e34c366b0
 SHA512:
-  metadata.gz: 587fae6e8d6a0d1ba507df5badb2030991302f5958cc0d8db5bfbb732bdb2283641dd5ad1fc59efd1cfba378f134f4d6a1b34a0ebddb7260a5ae0de8db11127d
-  data.tar.gz: 0e3410d331d2d2fe0c5dd46eb666910291672a49e380bc76b5b1fc2eba03c124138e1b3465f66170cda7ea43ed38d2258d6e5b703a92f6cfc2ba397d4315b795
+  metadata.gz: 16d7b2d861828838632b0ae50645b7ec87a55a63bef9513d626cfa4434e1db3c2b04b35edb58e217c40e7673acdbfa89979da4c6d9e88586b9c46e76ef07a8b3
+  data.tar.gz: 3bcd6ae8198b0dc230dd4fe0a12ed219248a276a5e9a7f04b04a2317512cf838e2419ddbb11a749d72f4011655071ed7b5b06b68d7cfd495e71dbfa501041bfe

data/ChangeLog

@@ -1,3 +1,8 @@
+Version 0.0.25 / 2018-2-25
+* Enhancements
+  * Updated rest_handler to convert JSON and XML into Hash and use it in 'contain_value'. This still needs work.
+  * Showed example of workflow using 'pet' url
+
 Version 0.0.24 / 2018-2-25
 * Enhancements
   * Added to soaspec-generate more types when creating YAML with data (int, boolean, double and custom enumeration).

data/Gemfile.lock

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

data/Rakefile

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

data/config/data/default.yml

@@ -1,3 +1,16 @@
 japan:
   city_name: 'Tokyo'
-  country_name: 'Japan'
+  country_name: 'Japan'
+
+pet:
+  id: '0'
+  category:
+    id: '1'
+    name: 'string'
+  name: 'test_rest'
+  photoUrls:
+    - 'string'
+  tags:
+    - id: '1'
+      name: 'string'
+  status: sold

data/lib/soaspec.rb

@@ -22,10 +22,6 @@ require 'soaspec/rest_handler'
 # Gem for handling SOAP and REST api tests
 module Soaspec
 
-  def self.hi
-    puts 'Hello world!'
-  end
-
   # Represents Environment parameters used in Soaspec tests
   module Environment
 
@@ -61,4 +57,34 @@ module Soaspec
     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 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
+
+RestClient.log = Soaspec::SpecLogger.create

data/lib/soaspec/basic_soap_handler.rb

@@ -132,5 +132,10 @@ module Soaspec
       xpath_value_for(exchange: exchange, xpath: path)
     end
 
+    # Whether any of the keys of the Body Hash include value
+    def include_value?(response, expected_value)
+      response.body.include_value?(expected_value)
+    end
+
   end
 end

data/lib/soaspec/matchers.rb

@@ -7,7 +7,7 @@ require_relative 'xpath_not_found'
 # 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
+    expect(actual.api_class.include_value?(actual.response, expected)).to be true
   end
 
   failure_message do |actual|

data/lib/soaspec/rest_handler.rb

@@ -2,6 +2,8 @@
 require_relative 'tester'
 require_relative 'hash_methods'
 require_relative 'xpath_not_found'
+require 'json'
+require 'nori'
 
 module Soaspec
   # Wraps around Savon client defining default values dependent on the soap request
@@ -18,7 +20,7 @@ module Soaspec
       }
     end
 
-    # Default Savon options. See http://savonrb.com/version2/globals.html for details
+    # Default Savon options. See https://github.com/rest-client/rest-client for details
     # @return [Hash] Default Savon options for all BasicSoapHandler
     def default_options
       {
@@ -41,12 +43,12 @@ module Soaspec
     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
+    # @param [Hash] specific_options Options defining SOAP request. WSDL, authentication
     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
+      @resource = RestClient::Resource.new(base_url, options) # @resource[url_extension].get
       super
     end
 
@@ -65,14 +67,57 @@ module Soaspec
     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])
+      test_values[:suburl] = test_values[:suburl].to_s if test_values[:suburl]
+
+      response = case test_values[:method]
+      when :post
+        if test_values[:suburl]
+          @resource[test_values[:suburl]].send(test_values[:method].to_s, test_values[:payload], test_values[:params])
+        else
+          @resource.send(test_values[:method].to_s, test_values[:payload], test_values[:params])
+        end
+      else
+        if test_values[:suburl]
+          @resource[test_values[:suburl]].send(test_values[:method].to_s, test_values[:params])
+        else
+          @resource.send(test_values[:method].to_s, test_values[:params])
+        end
+      end
+      Soaspec::SpecLogger.add_to(response)
+      response
     end
 
     def include_in_body?(response, expected)
       response.body.include? expected
     end
 
+    # Convert XML or JSON response into a Hash
+    def extract_hash(response)
+      raise "Empty Body. Can't assert on it" if response.body.empty?
+      type = case response.body[0]
+             when '<'
+               :xml
+             when '{'
+               :json
+             else
+               :unknown
+             end
+
+      case type
+      when :json
+        JSON.parse(response.body).transform_keys_to_symbols
+      when :xml
+        parser = Nori.new(:convert_tags_to => lambda { |tag| tag.snakecase.to_sym })
+        parser.parse(response.body)
+      else
+        raise "Neither XML nor JSON detected. It is #{type}. Don't know how to parse It is #{response.body}"
+      end
+    end
+
+    def include_value?(response, expected)
+      extract_hash(response).include_value? expected
+    end
+
     def status_code_for(response)
       response.code
     end

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.0.24'
+  VERSION = '0.0.25'
 end

data/test_rest.rb

@@ -1,11 +1,13 @@
 
 require 'rest-client'
+require 'json'
+require 'data_magic'
 
 options = {
   headers: {
    # accept: "application/xml",
-    accept: "application/json"
-  #  content_type: "application/json",
+    accept: "application/json",
+    content_type: "application/json"
  #   log: Logger.new('logs/traffic.log')
   }
 }
@@ -16,43 +18,59 @@ data_string = <<-EOF
 {
   "id": 1,
   "category": {
-    "id": 0,
+    "id": 1,
     "name": "string"
   },
-  "name": "doggie",
+  "name": "test_rest",
   "photoUrls": [
     "string"
   ],
   "tags": [
     {
-      "id": 0,
+      "id": 1,
       "name": "string"
     }
   ],
-  "status": "available"
+  "status": "sold"
 }
 EOF
 
 
 data = {
-  id: '1',
-  category: {
-    id: '1',
-    name: "test"
+  'id' => '1',
+  'category' => {
+    'id' => '1',
+    'name' => "string"
   },
-  name: "cat",
-  photoUrls: [
+  'name' => "test_rest",
+  'photoUrls' => [
     "string"
   ],
-  tags: [
+  'tags' => [
     {
-      id: '2',
-      name: "cute"
+      'id' => '1',
+      'name' => "string"
     }
   ],
-  status: "closed"
+  'status' => "sold"
 }
 
+# puts data.to_s
+#
+
+include DataMagic
+
+id = '1'
+default = data_for 'default/pet'
+merged_result = default.merge({ 'id' => id })
+
+#converted_data = JSON.generate(data).to_s
+converted_data = JSON.generate(merged_result).to_s
+
+puts converted_data
+# puts 'data'
+# puts data_string
+
 resource = RestClient::Resource.new('http://petstore.swagger.io/v2', options)
 # begin
 #   response = resource['pet'].post(data)
@@ -64,13 +82,17 @@ 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"})
+  #response = resource['pet/findByStatus?status=sold'].get(accept: 'application/xml')
+
+
+  #response = resource['pet'].post(data_string)
+  #response = resource['pet'].post(converted_data)
+  response = resource['pet/' + id].get
+  #response = resource['pet/' + id].delete
 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.24
+  version: 0.0.25
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-25 00:00:00.000000000 Z
+date: 2018-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler