soaspec 0.2.11 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4316417650edcdef9d66fb391ff90736a400dc2
-  data.tar.gz: 163b3ca2c9a547915693d33a7e7147dbc079cea6
+  metadata.gz: 70554212f6b7e667767a9d38f2c3b9c2f0bfec96
+  data.tar.gz: 3eaae9121a99e8b9a48b4f25ecb5a17178158e7c
 SHA512:
-  metadata.gz: 2a58886e537a7e063f4977a184cac67d32ffe4827d4331315475d780450d0025bf86a000978457a0d5b52f1361e54496d1661f70904f6aa84f9ada7a8d300f12
-  data.tar.gz: 41c07147d1db749aab3b3c4dfbfa638b46e46297ddbdc39c9f8eef0eb27bc9ad47dc347920c960fa1069236641aa2acd58d4619c6f46f0d775783b933b8dcbfb
+  metadata.gz: 6c7f0b3de2c2c31778410004db25705e3a561617be0e227be1c913e7b22e741b471fea0ce5ce2e575ea8f134dc39db5e28f9bbc61d7a0ccb17bace96e94a7500
+  data.tar.gz: 5deb9f12a6b63ec3e0077ca84c79ff625ee90e0cd86a7fadc60924ea0b3e98b8b85fd6274304ac2b54c930c960ec229dc9c3dbd0c2595de17a3fecea62541535

data/ChangeLog

@@ -1,3 +1,7 @@
+Version 0.2.12
+* Enhancements
+  * Make it easier to set 'traffic_file' location with `Soaspec::SpecLogger.traffic_file = ''`
+
 Version 0.2.11
 * Bug Fix
   * Cache 'Soaspec::OAuth2.instance_url' so Access token server not called everytime it's needed

data/README.md

@@ -175,6 +175,15 @@ expect(@exchange['message']).to include 'success'
 expect(@exchange.status_code).to eq 200
 ```
 
+## Logging
+
+By default traffic is logged to a file in the `logs` folder called `traffic_DATETIME.log`.
+
+The `SpecLogger` class is responsible for handling all the logs.
+
+To change the output file location to 'custom.log':
+`Soaspec::SpecLogger.traffic_file = 'custom.log'`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -28,3 +28,11 @@ end
 YARD::Rake::YardocTask.new do |t|
   t.files = %w[features/**/*.feature features/**/*.rb lib/soaspec/cucumber/*.rb] # lib/soaspec/cucumber/*.rb]
 end
+
+desc 'Ensure system has all docs'
+task :must_have_docs do
+  yard = `yard`
+  puts yard
+  percentage = yard.lines.last.strip.split('%').first.to_f
+  raise 'Must be fully documented' unless percentage == 100.00
+end

data/Todo.md

@@ -1,6 +1,8 @@
-* Get initial `soaspec new` working with TODOs as placeholders for how to get started
+* `yard` should show everything documented
+* Rubocop should have 0 offenses
 * Unit tests
   * OAuth class, etc
+* Get initial `soaspec new` working with TODOs as placeholders for how to get started
 * Request method from within exchange
   * Use this in tests
 * Basic service generator

data/lib/soaspec/core_ext/hash.rb

@@ -1,6 +1,7 @@
-# Override Hash class with convience methods
+# Override Hash class with convenience methods
 class Hash
   # Transform each key in Hash to a symbol. Privately used by non-self method
+  # @param [Object] value Value inside hash to transform keys under
   def self.transform_keys_to_symbols(value)
     return value unless value.is_a?(Hash)
 
@@ -13,28 +14,8 @@ class Hash
     each_with_object({}) { |(k, v), memo| memo[k.to_sym] = Hash.transform_keys_to_symbols(v); }
   end
 
-  # Returns all keys that have a particular value within a nested Hash
-  def find_all_values_for(key)
-    result = []
-    result << self[key]
-    values.each do |hash_value|
-      # next if hash_value.is_a? Array
-      #
-      if hash_value.is_a?(Array)
-        hash_value.each do |array_element|
-          result += array_element.find_all_values_for(key) if array_element.is_a? Hash
-        end
-      end
-
-      values = [hash_value]
-      values.each do |value|
-        result += value.find_all_values_for(key) if value.is_a? Hash
-      end
-    end
-    result.compact
-  end
-
   # Value present in nested Hash.
+  # @return [Boolean] Whether value is included in nested Hash
   def include_value?(value)
     each_value do |v|
       return true if v == value
@@ -51,31 +32,4 @@ class Hash
     end
     false
   end
-
-  # # Whether key is present at least once
-  # def include_key?(key)
-  #   result = find_all_values_for key
-  #   result != []
-  # end
-
-  # Loop through each item within a key within a Hash if the key exists
-  # @param [Key] key Key within hash to iterate through
-  def each_if_not_null(key)
-    case key.class.to_s
-    when 'String'
-      if self[key]
-        self[key].each do |list_item|
-          yield(list_item)
-        end
-      end
-    when 'Array', 'Hash'
-      if self[key[0]]
-        if self[key[0]][key[1]]
-          self[key[0]][key[1]].each do |list_item|
-            yield(list_item)
-          end
-        end
-      end
-    end
-  end
 end

data/lib/soaspec/exchange/exchange.rb

@@ -43,6 +43,8 @@ class Exchange
     nil
   end
 
+  # Create new Exchange according to parameters set. A response will be made if called
+  # explicitly with 'response' method or through other methods that use it like 'status_code'
   # @param [Symbol, String] name Name shown in RSpec run
   # @param [Hash] override_parameters Parameters to override for default params
   def initialize(name = self.class.to_s, override_parameters = {})

data/lib/soaspec/exchange/exchange_properties.rb

@@ -17,6 +17,7 @@ module Soaspec
     end
 
     # Set retry_for_success to true, retrying response until a successful status code is returned
+    # @param [Integer] retry_count Times to retry to get a positive response
     def expect_positive_status(retry_count: 3)
       define_method('retry_count') do
         retry_count

data/lib/soaspec/exchange/request_builder.rb

@@ -16,6 +16,12 @@ module Soaspec
     # Set a parameter request in the request body.
     # Can be used to build a request over several steps (e.g Cucumber)
     # Will be used with FactoryBot
+    #
+    # @example
+    #   exchange['name'] = 'tester'
+    #   # Will set { name: tester } in the response, formatting as JSON or XML depending on REST / SOAP
+    # @param [String, Symbol] key Name of request element to set
+    # @param [String] value Value to set request element to
     def []=(key, value)
       @override_parameters[:body] ||= {}
       @override_parameters[:body][key] = value
@@ -24,7 +30,7 @@ module Soaspec
     # Implement undefined setter with []= for FactoryBot to use without needing to define params to set
     # @param [Object] method_name Name of method not defined
     # @param [Object] args Arguments passed to method
-    # @param [Object] block
+    # @param [Object] block Block passed to method
     def method_missing(method_name, *args, &block)
       set_value = args.first
       if method_name[-1] == '=' # A setter method
@@ -41,13 +47,15 @@ module Soaspec
     end
 
     # Used for setters that are not defined
+    # @param [String] method_name Name of method
+    # @param [Array] args List of arguments to method
     def respond_to_missing?(method_name, *args)
       method_name[-1] == '=' || super
     end
 
     # Makes request, caching the response and returning self
     # Used by FactoryBot
-    # @return [Self]
+    # @return [Self] Return itself so methods can be called on itself afterwards
     def save!
       @retry_for_success = @fail_factory ? false : true
       call

data/lib/soaspec/exchange_handlers/exchange_handler.rb

@@ -16,7 +16,7 @@ module Soaspec
 
     # Set instance variable name
     # @param [String, Symbol] name Name used when describing API test
-    # @param [Hash] options Parameters defining handler. Used in descendants
+    # @param [Hash] _options Parameters defining handler. Used in descendants
     def initialize(name = self.class.to_s, _options = {})
       use
       @request_option = :hash
@@ -86,9 +86,7 @@ module Soaspec
     # @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('__stored_val__' + name.to_s) do
-        value
-      end
+      define_singleton_method('__stored_val__' + name.to_s) { value }
     end
 
     # Set instance variable for each key in hash remove it from Hash
@@ -99,6 +97,8 @@ module Soaspec
     end
 
     # Set instance variable and remove it from Hash
+    # @param [Hash] hash Hash to remove/retrieve keys from
+    # @param [String,Symbol] key Key to remove and to set instance variable for
     def set_remove_key(hash, key)
       return unless hash.key? key
 
@@ -112,6 +112,7 @@ module Soaspec
     end
 
     # Request of API call. Either intended request or actual request
+    # @param [Object] response Response from calling exchange
     def request(response)
       return "Request not yet sent Request option is #{@request_option}" unless response
 

data/lib/soaspec/exchange_handlers/handler_accessors.rb

@@ -31,11 +31,13 @@ module Soaspec
     # @example Inside class
     #   mandatory_xpath_values '//xmlns:GetWeatherResult' => 'Data Not Found'
     #
-    # In test
-    # describe Exchange(:name) do
-    #   it_behaves_like 'success scenario' # Includes xpath pair validation
-    # end
+    # @example In test
+    #   describe Exchange(:name) do
+    #     it_behaves_like 'success scenario' # Includes xpath pair validation
+    #   end
     #
+    # @param [Hash] xpath_value_pairs Hash of element => expected value that must appear
+    #                                 in a successful response body
     def mandatory_xpath_values(xpath_value_pairs)
       raise ArgumentError('Hash of {xpath => expected values} expected ') unless xpath_value_pairs.is_a? Hash
 
@@ -47,11 +49,13 @@ module Soaspec
     # @example Inside class
     #   mandatory_json_values '$..GetWeatherResult' => 'Found'
     #
-    # In test
-    # describe Exchange(:name) do
-    #   it_behaves_like 'success scenario' # Includes json pair validation
-    # end
+    # @example In test
+    #   describe Exchange(:name) do
+    #     it_behaves_like 'success scenario' # Includes json pair validation
+    #   end
     #
+    # @param [Hash] json_value_pairs Hash of element => expected value that must appear
+    #                                in a successful response body
     def mandatory_json_values(json_value_pairs)
       raise ArgumentError("Hash of {'jsonpath' => expected values} expected") unless json_value_pairs.is_a? Hash
 
@@ -84,6 +88,7 @@ module Soaspec
 
     # All xpath will be done with XML that is converted to lower case
     # You must then use lower case in the xpath's to obtain the desired values
+    # @param [Boolean] set Whether to convert all xml in response to lower case before performing XPath
     def convert_to_lower(set)
       return unless set
 
@@ -94,6 +99,7 @@ module Soaspec
     # For why this may not be a good thing in general see
     # http://tenderlovemaking.com/2009/04/23/namespaces-in-xml.html
     # This will be overridden if xpath has a ':' in it
+    # @param [Boolean] set Whether to strip namespaces form XML response
     def strip_namespaces(set)
       return unless set
 

data/lib/soaspec/exchange_handlers/response_extractor.rb

@@ -20,6 +20,7 @@ module Soaspec
       end
     end
 
+    # @param [Object] response Response object
     # @return [Hash] Hash representing response body
     def to_hash(response)
       case Interpreter.response_type_for(response)

data/lib/soaspec/exchange_handlers/soap_handler.rb

@@ -145,7 +145,7 @@ module Soaspec
     end
 
     # Convert all XML nodes to lowercase
-    # @param [Nokogiri::XML::Document]
+    # @param [Nokogiri::XML::Document] xml_doc Xml document to convert
     def convert_to_lower_case(xml_doc)
       xml_doc.traverse do |node|
         node.name = node.name.downcase if node.is_a?(Nokogiri::XML::Element)

data/lib/soaspec/o_auth2.rb

@@ -48,7 +48,6 @@ module Soaspec
       params[:security_token] = ERB.new(params[:security_token]).result(binding) if params[:security_token]
       params[:token_url] = ERB.new(params[:token_url]).result(binding) if params[:token_url]
       params[:password] = ERB.new(params[:password]).result(binding) if params[:password]
-      Soaspec::SpecLogger.info request_message
     end
 
     # Retrieve instance_url according to access token response.
@@ -61,6 +60,7 @@ module Soaspec
 
     # @return [String] Existing or new access token, dependent on refresh_token attribute
     def access_token
+      Soaspec::SpecLogger.info request_message
       case Soaspec::OAuth2.refresh_token
       when :once
         Soaspec::OAuth2.access_tokens[params] ||= response['access_token']

data/lib/soaspec/spec_logger.rb

@@ -23,12 +23,15 @@ module Soaspec
     @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')
-
+    # By default file is based on time
+    @traffic_file = nil
     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
+      # Set file to log traffic to
+      attr_writer :traffic_file
 
       # Whether to log all API traffic
       def log_api_traffic=(set)
@@ -55,6 +58,8 @@ module Soaspec
 
       # @return [String] Traffic file to create logs at
       def traffic_file
+        return File.join(traffic_folder, @traffic_file) if @traffic_file
+
         filename = "traffic_#{time_test_run}.log"
         File.join(traffic_folder, filename)
       end

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.2.11'.freeze
+  VERSION = '0.2.12'.freeze
 end

data/lib/soaspec/wsdl_generator.rb

@@ -1,6 +1,8 @@
 module Soaspec
+  # Produce test content from a WSDL
   module WsdlGenerator
     # Attempt to calculate values of enumeration by looking up type in Schema
+    # @param [String] type Try out filling enumeration for type. Return Custom Type if can't be done
     def try_enum_for(type)
       raise "'@wsdl_schemas' must be defined" if @wsdl_schemas.nil?
 
@@ -28,34 +30,33 @@ module Soaspec
 
     # Return value of string after a namespace
     # @param [String] string String to parse for part after namespace
+    # @return [String] Part after the namespace, demonstrated by ':'
     def value_after_namespace(string)
       string.split(':').last
     end
 
     # Based on WSDL type return a valid value
     # @param [String] type Type without the WSDL
+    # @return [Object] Value representing type to fill in
     def fill_in_field_from_type(type)
       case type
-      when 'string'
-        options[:string_default] # 'test string'
-      when 'int'
-        2
-      when 'boolean'
-        true
-      when 'double'
-        '1.5'
+      when 'string' then options[:string_default] # 'test string'
+      when 'int' then 2
+      when 'boolean' then true
+      when 'double' then '1.5'
       else
         try_enum_for type
       end
     end
 
     # @param [Nokogiri::XML::Element]
-    # @return [Boolean] True if nokogori element is a complex type, that is, has a complexType element underneath itself
+    # @return [Boolean] True if Nokogiri 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
+    # @return [String] CamelCased value
     def camel_case(underscore_separated)
       underscore_separated.to_s.split('_').collect(&:capitalize).join
     end
@@ -81,7 +82,9 @@ module Soaspec
       end
     end
 
-    # @param [Nokogiri::XML::Element]
+    # Adds documentation content for all children of XML element
+    # @param [Nokogiri::XML::Element] element Type to document for
+    # @param [Integer] depth How many times to iterate depth for
     def document_type_for(element, depth = 1)
       # raise "Too far deep for #{element}" unless depth < 6
       return unless depth < 6
@@ -104,20 +107,18 @@ module Soaspec
     end
 
     # Makes a yaml string in a '@content' instance variable
-    # @param [Nokogiri::XML::NodeSet] list List
+    # @param [Nokogiri::XML::NodeSet] list List to convert to YAML
     def wsdl_to_yaml_for(list)
       raise "'@content' string must be set" if @content.nil?
 
-      list.each do |element|
-        document_type_for element
-      end
+      list.each { |element| document_type_for element }
     end
 
     # Prompt user for wsdl
     def ask_wsdl
-      prompt = <<-EOF
-Enter WSDL:
-      EOF
+      prompt = <<-WSDL_LOC
+  Enter WSDL:
+      WSDL_LOC
       print prompt.chop
       @wsdl = $stdin.gets.strip
       puts
@@ -125,9 +126,9 @@ Enter WSDL:
 
     # Prompt user for Service name for wsdl
     def name_of_wsdl
-      prompt = <<-EOF
-Enter what you would like to name WSDL (CamelCase):
-      EOF
+      prompt = <<-WSDL_NAME
+  Enter what you would like to name WSDL (CamelCase):
+      WSDL_NAME
       print prompt.chop
       @name = $stdin.gets.strip
       puts
@@ -135,16 +136,16 @@ Enter what you would like to name WSDL (CamelCase):
 
     # Prompt user to enter basic auth details
     def enter_auth_details
-      prompt = <<-EOF
-User Name:
-      EOF
+      prompt = <<-AUTH_PROMPT
+  User Name:
+      AUTH_PROMPT
       print prompt.chop
       @auth_name = $stdin.gets.strip
       puts
 
-      prompt = <<-EOF
-User Password:
-      EOF
+      prompt = <<-PASSWORD
+  User Password:
+      PASSWORD
       print prompt.chop
       @auth_password = $stdin.gets.strip
       puts

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.12
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-06 00:00:00.000000000 Z
+date: 2019-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler