soaspec 0.0.89 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fbb853656c1ac3fa5e3f8cf9deb35d3ffd2094b
-  data.tar.gz: 4af040f838d170b0248adcddbee6adffee89d978
+  metadata.gz: 47048ecb768673e682744c8ed3064450530ed0de
+  data.tar.gz: 4f4137848f7a656914205ad76a3ae800a065c969
 SHA512:
-  metadata.gz: 72d6dcbf54043591c26c8e0951e68a56c331a26f7d8d05bc9acd76ae512bda463bddc5be2d96de322e4041c64c51b972f879aaf227f1e3465c436821bba2692a
-  data.tar.gz: d25a4e7f6ab09ed7657a886fcf2b24aefd15da539fc9ad18fa1ed70a17c278a750a098e771603dd7e571d5cb6a9bfc2749525ae37e96dd3eff34ddb01d2a81e8
+  metadata.gz: dd35e76ceae861c08bcad153b0e124643c83b856071e486116f40d1a7c210f92b4d0854172bcf14a5d1a462e42f5ad197fd8853bdd8a252bbfc469948c52a1d9
+  data.tar.gz: 167dbbf4db1b4a61def28a6c4bfea8810c192a922f03495ae727fc754b9086a0658e8e5b1c4a0265a7d5c2ae322207f65889d65d4096a3061b7a7cb20e6886fb

data/ChangeLog

@@ -1,3 +1,9 @@
+Version 0.1.0
+* Enhancements
+  * Cleaned up unit tests for WSDL generator. Won't bother for SOAP ComplexType for now as I'm not needing this and it looks like Savon 3 will create example requests anyway
+  * Put SOAP Basic Auth in Example
+  * Added template handling for REST handler
+
 Version 0.0.89
 * Enhancements
   * Move more functionality out of soaspec exe and into WsdlGenerator. Started unit tests for it

data/README.md

@@ -31,7 +31,7 @@ Example:
 ```
 mkdir 'api_test'
 cd 'api_test'
-soaspec-init
+soaspec new
 bundle install
 ```
 
@@ -41,7 +41,7 @@ Then you can run the tests with:
 rake spec
 ```
 
-You can also use `soaspec-generate` to generate a set of tests from a WSDL. This is still in trial period
+You can also use `soaspec generate` to generate a set of tests from a WSDL. This is still in trial period and will be finished probably after Savon 3 is more stable.
 
 ## Usage
 

data/Todo.md

@@ -1,7 +1,6 @@
 * Give examples and convenience methods for building classes for each SOAP or REST operation
   * For SOAP give example of basic_auth
-* Handle REST template (similar way to SOAP)
-* Get wsdl generator working for non complex gems
 * Potentially have in built use of 'vcr' and 'http_stub' gems
 * Handle proxies to record traffic for MiddleWare testing
-* Much more - please raise an issue for suggestion
+* Get wsdl generator working for non complex gems (Put on hold til new Savon version)
+* Much more - please raise an issue for suggestion

data/exe/soaspec-virtual-server

@@ -26,14 +26,9 @@ class SoaspecVirtualServer < Sinatra::Application
     Soaspec::TestServer::TestNamespace.food
   end
 
-  # This is the one being hit by SOAP actions
-  post '/BLZService' do
-    Soaspec::TestServer::GetBank.response_for request
-  end
-
-  # This is returned when a query for the WSDL is made
-  get '/BLZService' do
-    [200, { 'Content-Type' => 'text/xml' }, Soaspec::TestServer::GetBank.test_wsdl]
+  # Used for simple testing of posing
+  post '/echoer' do
+    request.body
   end
 
   # Simulate retrieving an ouath token. Passed to '/invoices'
@@ -46,6 +41,11 @@ class SoaspecVirtualServer < Sinatra::Application
     JSON.generate(customer_id: id, oauth: request.env['HTTP_AUTHORIZATION'], user: Soaspec::TestServer::Invoices.user_used)
   end
 
+  # This is returned when a query for the WSDL is made
+  get '/BLZService' do
+    [200, { 'Content-Type' => 'text/xml' }, Soaspec::TestServer::GetBank.test_wsdl]
+  end
+
   authorize do |username, password|
     username == 'admin' && password == 'secret'
   end
@@ -54,6 +54,11 @@ class SoaspecVirtualServer < Sinatra::Application
     get '/basic_secrets' do
       'Secret data'
     end
+
+    # This is the one being hit by SOAP actions
+    post '/BLZService' do
+      Soaspec::TestServer::GetBank.response_for request
+    end
   end
 
   # Used for testing storage of data

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -55,6 +55,7 @@ module Soaspec
       super
       set_remove_key(options, :api_username)
       set_remove_key(options, :default_hash)
+      set_remove_key(options, :template_name)
       @init_options = options
     end
 
@@ -71,16 +72,6 @@ module Soaspec
       false
     end
 
-    # @return [Hash]
-    def hash_used_in_request(override_hash)
-      request = @default_hash.merge(override_hash)
-      if pascal_keys?
-        request.map { |k, v| [convert_to_pascal_case(k.to_s), v] }.to_h
-      else
-        request
-      end
-    end
-
     # Initialize value of merged options
     def init_merge_options
       options = rest_resource_options
@@ -93,6 +84,7 @@ module Soaspec
     # @param [Hash] override_parameters Params to characterize REST request
     # @param_value [params] Extra parameters (E.g. headers)
     # @param_value [suburl] URL appended to base_url of class
+    # @param_value [q] Query for REST
     # @param_value [method] REST method (:get, :post, etc)
     def make_request(override_parameters)
       @merged_options ||= init_merge_options
@@ -101,7 +93,6 @@ module Soaspec
       test_values[:method] ||= :post
       test_values[:suburl] = test_values[:suburl].to_s if test_values[:suburl]
       test_values[:params][:params] = test_values[:q] if test_values[:q] # Use q for query parameters. Nested :params is ugly and long
-
       # In order for ERB to be calculated at correct time, the first time request is made, the resource should be created
       @resource ||= RestClient::Resource.new(ERB.new(base_url_value).result(binding), @merged_options)
 
@@ -110,11 +101,9 @@ module Soaspec
       begin
       response = case test_values[:method]
                  when :post, :patch, :put
-                   unless test_values[:payload]
-                     test_values[:payload] = JSON.generate(hash_used_in_request(test_values[:body])).to_s if test_values[:body]
-                   end
-                   @resource_used.send(test_values[:method].to_s, test_values[:payload], test_values[:params])
-                 else
+                   Soaspec::SpecLogger.info("request body: #{post_data(test_values)}")
+                   @resource_used.send(test_values[:method].to_s, post_data(test_values), test_values[:params])
+                 else # :get, :delete
                    @resource_used.send(test_values[:method].to_s, test_values[:params])
                  end
       rescue RestClient::ExceptionWithResponse => e
@@ -131,11 +120,12 @@ module Soaspec
       extract_hash response
     end
 
+    # @return [Boolean] Whether response body includes String
     def include_in_body?(response, expected)
       response.body.include? expected
     end
 
-    # Whether the request found the desired value or not
+    # @@return [Boolean] Whether the request found the desired value or not
     def found?(response)
       status_code_for(response) != 404
     end
@@ -275,6 +265,31 @@ module Soaspec
       end
     end
 
+    private
+
+    # Work out data to send based upon payload, template_name
+    # @return [String] Payload to send in REST request
+    def post_data(test_values)
+      if test_values[:body]
+        test_values[:payload] = JSON.generate(hash_used_in_request(test_values[:body])).to_s
+      elsif @request_option == :template
+        request_body = File.read('template/' + template_name)
+        ERB.new(request_body).result(binding)
+      else
+        test_values[:payload]
+      end
+    end
+
+    # @return [Hash] Hash used in REST request based on data conversion
+    def hash_used_in_request(override_hash)
+      request = @default_hash.merge(override_hash)
+      if pascal_keys?
+        request.map { |k, v| [convert_to_pascal_case(k.to_s), v] }.to_h
+      else
+        request
+      end
+    end
+
     # Convenience methods for once off usage of a REST request
     class << self
 

data/lib/soaspec/exchange_handlers/soap_handler.rb

@@ -101,11 +101,11 @@ module Soaspec
       test_values = request_body_params request_parameters
       begin
         if @request_option == :template
-          request_body = File.read('template/' + template_name + '.xml')
+          request_body = File.read('template/' + template_name)
           render_body = ERB.new(request_body).result(binding)
-          @client.call(operation, xml: render_body) # Call the SOAP operation with the request XML provided
+          client.call(operation, xml: render_body) # Call the SOAP operation with the request XML provided
         elsif @request_option == :hash
-          @client.call(operation, message: @default_hash.merge(test_values), attributes: request_root_attributes)
+          client.call(operation, message: @default_hash.merge(test_values), attributes: request_root_attributes)
         end
       rescue Savon::HTTPError => e
         e

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.0.89'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/lib/soaspec/wsdl_generator.rb

@@ -5,7 +5,7 @@ module Soaspec
     def try_enum_for(type)
       raise "'@wsdl_schemas' must be defined" if @wsdl_schemas.nil?
       custom_type = @wsdl_schemas.xpath("//*[@name='#{type}']")
-      if custom_type.first
+      if enumeration? custom_type
         prefix = custom_type.first.namespace.prefix
         enumerations = custom_type.xpath("//#{prefix}:enumeration")
         return 'Custom Type' if enumerations.empty?
@@ -17,6 +17,13 @@ module Soaspec
       end
     end
 
+    # @param [Nokogiri::XML::NodeSet]
+    # @return [Boolean] Whether WSDL type is an enumeration
+    def enumeration?(type)
+      return false unless type.first
+      !type.xpath("*/#{type.first.namespace.prefix}:enumeration").empty?
+    end
+
     # Return value of string after a namespace
     # @param [String] string String to parse for part after namespace
     def value_after_namespace(string)
@@ -40,6 +47,12 @@ module Soaspec
       end
     end
 
+    # @param [Nokogiri::XML::Element]
+    # @return [Boolean] True if nokogori element is a complex type, that is, has a complexType element underneath itself
+    def complex_type?(element)
+      element.children.any? { |child| child.name == 'complexType' }
+    end
+
     # @param [String, Symbol] underscore_separated Snakecase value to be converted to camel case
     def camel_case(underscore_separated)
       underscore_separated.to_s.split('_').collect(&:capitalize).join
@@ -52,27 +65,43 @@ module Soaspec
       root_element = @wsdl_schemas.at_xpath("//*[@name='#{op_details[:input]}']")
       raise 'Operation has no input defined' if root_element.nil?
       schema_namespace = root_element.namespace.prefix
-
       root_type = root_element['type']
       if root_type
         @wsdl_schemas.xpath("//*[@name='#{root_type.split(':').last}']//#{schema_namespace}:element")
       else
-        return [] unless root_element.children.any? { |child| child.name == 'complexType' } # Empty Array if there are no root elements
-        root_element.xpath("//#{schema_namespace}:element")
+        return [] unless complex_type? root_element # Empty Array if there are no root elements
+        complex_type = root_element.children.find { |c| c.name == 'complexType' }
+        sequence = complex_type.children.find { |c| c.name == 'sequence' }
+        sequence.xpath("#{schema_namespace}:element")
       end
     end
 
-    # @param [Nokogiri::NodeSet] list List
-    def wsdl_to_yaml_for(list)
-      raise "'@content' string must be set" if @content.nil?
-      puts list
-      list.each do |element|
+    # @param [Nokogiri::XML::Element]
+    def document_type_for(element, depth = 1)
+      # raise "Too far deep for #{element}" unless depth < 6
+      return unless depth < 6
+      if complex_type? element
+        complex_type = element.children.find { |c| c.name == 'complexType' }
+        sequence = complex_type.children.find { |c| c.name == 'sequence' }
+        sequence.children.select { |node| node.class == Nokogiri::XML::Element }.each do |sub_element|
+          document_type_for sub_element, depth += 1
+        end
+      else
+        return "No type seen for #{element}, #{element.class}" unless element['type']
         name = element['name']
         type = value_after_namespace(element['type'])
-        puts 'Name ' + name + ' type ' + type
         @use_camel_case = true if (/[[:upper:]]/.match(name[0]) != nil)
-        @content += "  #{name.snakecase}: #{fill_in_field_from_type(type)} # #{type} \n"
-        # TODO: If it is nested need to loop again
+        spaces = '  ' * depth
+        @content += "#{spaces}#{name.snakecase}: #{fill_in_field_from_type(type)} # #{type} \n"
+      end
+    end
+
+    # Makes a yaml string in a '@content' instance variable
+    # @param [Nokogiri::XML::NodeSet] list List
+    def wsdl_to_yaml_for(list)
+      raise "'@content' string must be set" if @content.nil?
+      list.each do |element|
+        document_type_for element
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.0.89
+  version: 0.1.0
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-06 00:00:00.000000000 Z
+date: 2018-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler