soaspec 0.2.8 → 0.2.9

data/lib/soaspec/spec_logger.rb

@@ -1,39 +1,72 @@
-
 require 'logger'
 require 'fileutils'
+require 'colorize'
 
 module Soaspec
-
   # Handles logs of API requests and responses
   class SpecLogger
-    @traffic_folder = 'logs' # Folder to put API traffic logs
+    # Folder to put API traffic logs
+    @traffic_folder = 'logs'
+    # Whether to output api traffic to terminal
+    @output_to_terminal = false
+    # Whether to output API traffic to log file
+    @output_to_file = true
+    # Time test run. Will only be calculated once once called
+    @time_test_run = Time.now.strftime('%Y-%m-%d_%H_%M_%S')
 
     class << self
       # Folder to put API traffic logs
       attr_accessor :traffic_folder
+      # Readers for log parameters
+      attr_reader :output_to_terminal, :output_to_file, :time_test_run
+
+      # Whether to log all API traffic
+      def log_api_traffic=(set)
+        @log_api_traffic = set
+        RestClient.log = nil unless set
+      end
+
+      # @return [Boolean] Whether to log all API traffic
+      def log_api_traffic?
+        @log_api_traffic.nil? ? true : @log_api_traffic
+      end
+
+      # @param [Symbol, Boolean] value # Whether to output API traffic to log file
+      def output_to_file=(value)
+        @output_to_file = value
+        RestClient.log = Soaspec::SpecLogger.create
+      end
+
+      # @param [Symbol, Boolean] value # Whether to output API traffic to STDOUT
+      def output_to_terminal=(value)
+        @output_to_terminal = value
+        RestClient.log = Soaspec::SpecLogger.create
+      end
 
       # @return [String] Traffic file to create logs at
       def traffic_file
-        filename = "traffic_#{Time.now.strftime('%Y-%m-%d_%H_%M_%S')}.log"
+        filename = "traffic_#{time_test_run}.log"
         File.join(traffic_folder, filename)
       end
 
       # Create new log file if necessary and setup logging level
       # @return [Logger] Logger class to record API traffic
       def create
-        unless File.exist?(traffic_file)
-          FileUtils.mkdir_p traffic_folder
-          FileUtils.touch traffic_file
-        end
+        create_log_file
         @logger = Logger.new(traffic_file) # Where request and responses of APIs are stored
-        @logger.level = Logger::DEBUG
+        @logger.formatter = proc do |severity, datetime, _progname, msg|
+          message = "SpecLog, [#{datetime.strftime('%Y-%m-%d_%H:%M:%S')}] #{severity} -- : #{msg}\n"
+          print message.colorize(:light_blue) if @output_to_terminal
+          message
+        end
         @logger
       end
 
       # Log a message using Soaspec logger
       # @param [String] message The message to add to the logger
       def info(message)
-        return unless Soaspec.log_api_traffic?
+        return unless log_api_traffic?
+
         if message.respond_to? :each
           message.each do |message_item|
             @logger.info(message_item)
@@ -42,7 +75,16 @@ module Soaspec
           @logger.info(message)
         end
       end
-    end
 
+      private
+
+      # Create folder and file to store logs
+      def create_log_file
+        return if File.exist?(traffic_file)
+
+        FileUtils.mkdir_p traffic_folder
+        FileUtils.touch traffic_file
+      end
+    end
   end
-end
+end

data/lib/soaspec/template_reader.rb

@@ -21,7 +21,8 @@ module Soaspec
       end
       request_body = File.read file_location
       raise "Template at #{file_location} not parsed correctly" if request_body.strip.empty?
+
       ERB.new(request_body).result(binding)
     end
   end
-end
+end

data/lib/soaspec/test_server/get_bank.rb

@@ -1,13 +1,11 @@
-
 require 'erb'
 
 module Soaspec
   module TestServer
     # Representing a GetBank SOAP service
     class GetBank
-
       class << self
-
+        # @return [String] WSDL of mock web service
         def test_wsdl
           ERB.new(File.read(File.join(File.dirname(__FILE__), 'bank.wsdl'))).result(binding)
         end
@@ -142,20 +140,22 @@ module Soaspec
           @title = 'Deutsche Bank'
           soap_action = request.env['HTTP_SOAPACTION']
           return 500, 'Not valid SOAP' unless soap_action
+
           request_body = request.body
           doc = Nokogiri::XML(request_body)
           soap_action = soap_action.strip # Used in ERB
           blz_element = doc.at_xpath('//tns:blz')
           return 500, error_response_template unless blz_element
+
           @bank_name = blz_element.inner_text
           @bank_id = @bank_name.to_i
           return 500, ERB.new(bank_not_found).result(binding) if @bank_id.zero?
+
           @title = 'DAB Bank' if @bank_id == 500
           @multiple_ort = (@bank_id == 20)
           ERB.new(success_response_template).result(binding)
         end
-
       end
     end
   end
-end
+end

data/lib/soaspec/test_server/id_manager.rb

@@ -5,7 +5,6 @@ module Soaspec
     class IdManager
       @developed = false
       class << self
-
         attr_accessor :developed
 
         # @return  Result depending on num, id and whether '@developed' is set
@@ -25,8 +24,7 @@ module Soaspec
             'true'
           end
         end
-
       end
     end
   end
-end
+end

data/lib/soaspec/test_server/invoices.rb

@@ -20,7 +20,6 @@ module Soaspec
             expires_in: '86399'
           }
         end
-
       end
     end
   end

data/lib/soaspec/test_server/puppy_service.rb

@@ -13,7 +13,6 @@ module Soaspec
           @current_id += 1
           @current_id - 1
         end
-
       end
     end
   end

data/lib/soaspec/test_server/test_attribute.rb

@@ -1,4 +1,3 @@
-
 module Soaspec
   module TestServer
     # Helps tests attribute methods

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.2.8'.freeze
-end
+  VERSION = '0.2.9'.freeze
+end

data/lib/soaspec/virtual_server.rb

@@ -147,7 +147,7 @@ module Soaspec
         ]
       }
     }
-        BOOKS
+      BOOKS
     end
   end
 end

data/lib/soaspec/wait.rb

@@ -38,4 +38,4 @@ module Soaspec
       raise Soaspec::TimeOutError, msg
     end
   end
-end
+end

data/lib/soaspec/wsdl_generator.rb

@@ -1,14 +1,15 @@
-
 module Soaspec
   module WsdlGenerator
     # Attempt to calculate values of enumeration by looking up type in Schema
     def try_enum_for(type)
       raise "'@wsdl_schemas' must be defined" if @wsdl_schemas.nil?
+
       custom_type = @wsdl_schemas.xpath("//*[@name='#{type}']")
       if enumeration? custom_type
         prefix = custom_type.first.namespace.prefix
         enumerations = custom_type.xpath("//#{prefix}:enumeration")
         return 'Custom Type' if enumerations.empty?
+
         @enums_values = []
         enumerations.each { |enum_value| @enums_values << "'#{enum_value['value']}'" }
         "~randomize [#{@enums_values.join(', ')}]"
@@ -21,6 +22,7 @@ module Soaspec
     # @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
 
@@ -62,14 +64,17 @@ module Soaspec
     # @return [Nokogiri::XML::NodeSet] List of the root elements in the SOAP body
     def root_elements_for(op_details)
       raise "'@wsdl_schemas' must be defined" if @wsdl_schemas.nil?
+
       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 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")
@@ -80,6 +85,7 @@ module Soaspec
     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' }
@@ -88,9 +94,10 @@ module Soaspec
         end
       else
         return "No type seen for #{element}, #{element.class}" unless element['type']
+
         name = element['name']
         type = value_after_namespace(element['type'])
-        @use_camel_case = true if (/[[:upper:]]/.match(name[0]) != nil)
+        @use_camel_case = true unless /[[:upper:]]/.match(name[0]).nil?
         spaces = '  ' * depth
         @content += "#{spaces}#{name.snakecase}: #{fill_in_field_from_type(type)} # #{type} \n"
       end
@@ -100,6 +107,7 @@ module Soaspec
     # @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
@@ -142,4 +150,4 @@ User Password:
       puts
     end
   end
-end
+end

data/soaspec.gemspec

@@ -21,16 +21,19 @@ the same configuration. Examples designed for RSpec and Cucumber."
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'cucumber'
   spec.add_development_dependency 'data_magic'
   spec.add_development_dependency 'factory_bot'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'require_all', '1.5.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'yard-cucumber'
   spec.add_dependency 'activesupport'
+  spec.add_dependency 'colorize'
   spec.add_dependency 'faker'
   spec.add_dependency 'hashie'
   spec.add_dependency 'jsonpath'
@@ -39,7 +42,9 @@ the same configuration. Examples designed for RSpec and Cucumber."
   spec.add_dependency 'rspec', '~> 3.0' # This framework is designed to work with RSpec
   spec.add_dependency 'rspec-its'
   spec.add_dependency 'savon', '>= 2' # SOAP
-  spec.add_dependency 'sinatra'
+  # https://github.com/sinatra/sinatra/issues/1514 in 2.0.5 version of Sinatra breaks '?wsdl' a param with no
+  # Only affects Ruby < 2.4
+  spec.add_dependency 'sinatra', '2.0.4'
   spec.add_dependency 'sinatra-basic-auth'
   spec.add_dependency 'sinatra-docdsl'
   spec.add_dependency 'thor'

data/test_wsdl.rb

@@ -1,15 +1,12 @@
-
 require 'wasabi'
 require 'savon'
 
-
-#document = Savon.client(wsdl: 'test.wsdl').wsdl
-#document = Savon.client(wsdl: 'http://www.webservicex.com/globalweather.asmx?wsdl').wsdl
-#document = Wasabi.document File.read('test.wsdl')
+# document = Savon.client(wsdl: 'test.wsdl').wsdl
+# document = Savon.client(wsdl: 'http://www.webservicex.com/globalweather.asmx?wsdl').wsdl
+# document = Wasabi.document File.read('test.wsdl')
 document = Wasabi.document 'http://www.webservicex.net/ConvertTemperature.asmx?WSDL'
 parser = document.parser
 
-
 # TEST SCHEMA
 #
 # parser.schemas.each do |schema|
@@ -41,4 +38,4 @@ if custom_type.first
   enumerations.each do |enum_value|
     puts enum_value['value']
   end
-end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-03 00:00:00.000000000 Z
+date: 2019-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -266,16 +308,16 @@ dependencies:
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.4
 - !ruby/object:Gem::Dependency
   name: sinatra-basic-auth
   requirement: !ruby/object:Gem::Requirement
@@ -356,12 +398,14 @@ files:
 - Todo.md
 - exe/soaspec
 - exe/xml_to_yaml_file
+- images/basic_demo.gif
 - lib/soaspec.rb
 - lib/soaspec/core_ext/hash.rb
 - lib/soaspec/cucumber/generic_steps.rb
 - lib/soaspec/exchange.rb
 - lib/soaspec/exchange_handlers/exchange_handler.rb
 - lib/soaspec/exchange_handlers/handler_accessors.rb
+- lib/soaspec/exchange_handlers/response_extractor.rb
 - lib/soaspec/exchange_handlers/rest_exchanger_factory.rb
 - lib/soaspec/exchange_handlers/rest_handler.rb
 - lib/soaspec/exchange_handlers/rest_methods.rb