soaspec 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a446e205c6a72dceb41dada3f7b910587629e0c0
-  data.tar.gz: f827d2d372ff408503f1111175b78cfa028a845f
+  metadata.gz: 17d2693e9fd08ec36b86235d2fd0a5991ef252a3
+  data.tar.gz: 68ec551ebe49f36c211a9fd856c3b5b669f3b5f8
 SHA512:
-  metadata.gz: 6cc6e07e30560774e7b5e9c9568bc15941df4cdfbb19102c97e322e53ffb3826d9d34d8e91cbb9182deb6745c710d23fef24dfb9d1c81688ae13131066f7f2e3
-  data.tar.gz: dee062b10eafcef1e52c96137108b4bdc0013d633e2871d9a85227e116580939144466b87ddd9f025f27c4b44e22e0d49b70c52ba94e8652e7172f3d881c9ccb
+  metadata.gz: 718d1fde689c36a4e96fc0ac61645151de132c3202a7213e21a8adad01c48b0aa6a76cfb057597c86b6e0e31177ef69dfcf88139e2f9285ad93c9e279b14c872
+  data.tar.gz: 7f2808840766e5ae179efc5ae3afd3e9d91364f92bc3196db8b7432df29df3bd0e19eef5d149bea6a817198468ee075dfcca5a2b26a120dc6e9aff2d8425ab76

data/.gitlab-ci.yml

@@ -19,23 +19,6 @@ cucumber:
   script:
     - bundle exec cucumber
 
-code_quality:
-  image: ruby:2.5
-  variables:
-    DOCKER_DRIVER: overlay2
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [gl-code-quality-report.json]
-
 pages:
   stage: deploy
   dependencies:

data/ChangeLog

@@ -1,3 +1,9 @@
+Version 0.2.9
+* Enhancements
+  * More documentation in README.md
+  * Started breaking up massive RestHandler more
+  * Allow one output logs to STDOUT through Soaspec::SpecLogger.output_to_terminal = true
+
 Version 0.2.8
 * Bug Fix
   * RSpec-its dependency produces a conflict. Remove specific version reference

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:gitlab) { |repo_name| "https://gitlab.com/samuel-garratt/soaspec" }
+git_source(:gitlab) { |_repo_name| 'https://gitlab.com/samuel-garratt/soaspec' }
 
 # Specify your gem's dependencies in soaspec.gemspec
 gemspec

data/README.md

@@ -1,6 +1,13 @@
 # Soaspec
 
 This gem helps to represent multiple API tests against a backend briefly, concisely and clearly.
+
+![Soaspec example](images/basic_demo.gif)
+> Example showing how a REST 'get' call can be made and it's response extracted.
+
+[![Build Status](https://gitlab.com/samuel-garratt/soaspec/badges/master/build.svg)](https://gitlab.com/samuel-garratt/soaspec/pipelines)
+[![Coverage](https://gitlab.com/samuel-garratt/soaspec/badges/master/coverage.svg)](https://samuel-garratt.gitlab.io/soaspec)
+
 It is essentially a wrapper around the Savon and RestClient gems, adding useful functionality including
 
 * Creating multiple API calls from the same base configuration through the use of an `ExchangeHandler` class
@@ -13,8 +20,6 @@ It is essentially a wrapper around the Savon and RestClient gems, adding useful
 * Accessing and utilising `oauth2` access tokens
 * Hosting a `virtual_server` that simulates REST & SOAP responses from an API
 
-[![Build Status](https://gitlab.com/samuel-garratt/soaspec/badges/master/build.svg)](https://gitlab.com/samuel-garratt/soaspec/pipelines)
-[![Coverage](https://gitlab.com/samuel-garratt/soaspec/badges/master/coverage.svg)](https://samuel-garratt.gitlab.io/soaspec)
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -72,13 +77,18 @@ For example:
 ```ruby
 # Classes are set up through inheriting from either `Soaspec::RestHandler` or `Soaspec::SoapHandler`
 class PuppyService < Soaspec::RestHandler
+  # Set default headers for all `Exchanges` using this class
+  headers accept: 'application/json', content_type: 'application/json'
 
-  headers accept: 'application/json', content_type: 'application/json' # Set default headers for all `Exchanges` using this class
+  # URL for which all requests using this class will start with
+  base_url 'http://petstore.swagger.io/v2/pet'
 
-  base_url 'http://petstore.swagger.io/v2/pet' # URL for which all requests using this class will start with
+  # Accessing parts of a response
 
-  element :id, :id # Define a method 'id' that can be obtained with either XPATH '//id' or JSONPath '$..id'
-  element :category_id, '$..category.id' # Define method to obtain a category id through JSON Path
+  # Define a method 'id' that can be obtained with either XPATH '//id' or JSONPath '$..id'
+  element :id, :id
+  # Define method to obtain a category id through JSON Path
+  element :category_id, '$..category.id'
 end
 ```
 
@@ -91,17 +101,40 @@ Upon initialization of the Exchange object (or later on through setters), parame
 Most getters of the `Exchange` are on the response & will implicitly trigger the API request to be made.
 Once this request has been made, all following accessors of the response will just use the response of the previous request made.
 
-For example, to create a http post using the above `ExchangeHandler` and extract a value from the response body using JSON PATH.
+For example, to create a http post using the above `ExchangeHandler` and get parts of it's response.
 ```ruby
-exchange = PuppyService.post(body: { status: 'sold' }) # The 'body' key will convert it's value from a Hash to JSON
 # Create a new Exchange that will post to 'http://petstore.swagger.io/v2/pet' with JSON { "status": "sold" }
+# The 'body' key will convert it's value from a Hash to JSON
+exchange = PuppyService.post(body: { status: 'sold' })
+
+# This will trigger the request to be made & return the response, in this case a RestClient::Response object
+response = exchange.response
+# This will reuse the response already received return a value at JSON path $..category.id, throwing an exception if not found
 exchange.category_id
-# This will trigger the request to be made & return a value at JSON path $..category.id, throwing an exception if not found
+# This will do the same but using path directly in code
+exchange['$..category.id']
+# Get the HTTP status code of the response
+exchange.status_code
 ```
 
 See [Request Body Parameters](https://gitlab.com/samuel-garratt/soaspec/wikis/RequestBodyParameters) for more details on setting a request body.
 See [Creating an Exchange](https://gitlab.com/samuel-garratt/soaspec/wikis/CreatingExchange) for details on how to create an Exchange.
 
+### Virtual Server
+
+Soaspec includes a virtual server that returns REST and SOAP responses that can be used when learning or experimenting with API testing.
+The gem itself uses this to test it's own functionality.
+
+To start the server, after installing the gem, type
+
+```
+soaspec virtual_server [port_num]
+```
+
+By default it runs on port 4999. This will be used if `port_num` is empty.
+
+You can look at the documentation for the web services provided at the rool url (e.g `localhost:4999`).
+
 ### RSpec
 
 For example:

data/Rakefile

@@ -27,4 +27,4 @@ end
 
 YARD::Rake::YardocTask.new do |t|
   t.files = %w[features/**/*.feature features/**/*.rb lib/soaspec/cucumber/*.rb] # lib/soaspec/cucumber/*.rb]
-end
+end

data/exe/soaspec

@@ -1,16 +1,13 @@
 #!/usr/bin/env ruby
 
-
 require 'thor'
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'savon'
 require 'soaspec'
 
 module Soaspec
-
   # Common executable for Soaspec
   class Exe < Thor
-
     include Soaspec::ExeHelpers
     include Soaspec::WsdlGenerator
 
@@ -54,6 +51,7 @@ module Soaspec
     desc 'add [type] [name]', 'Add new ExchangeHandler'
     def add(type = 'rest', name = 'TestService')
       raise "Type '#{type}' is not available" unless %w[rest soap].include? type
+
       @name = name # Use instance variable for ERB
       create_file filename: File.join('lib', "#{name.snakecase}.rb"),
                   content: retrieve_contents(File.join('lib', "new_#{type}_service.rb"))
@@ -87,30 +85,27 @@ module Soaspec
       @wsdl_doc = Savon.client(**savon_options).wsdl
       @wsdl_schemas = @wsdl_doc.parser.schemas
 
-      create_file filename: 'Rakefile', ignore_if_present: true
-      create_file filename: 'Gemfile', ignore_if_present: true
+      create_files %w[Rakefile Gemfile README.md spec/spec_helper.rb], ignore_if_present: true
       create_file(filename: '.rspec')
       create_file(filename: '.travis.yml') if options[:ci] == 'travis'
-      create_file filename: 'README.md', ignore_if_present: true
-      create_file filename: 'spec/spec_helper.rb', ignore_if_present: true
       create_folder 'logs'
       create_file filename: "lib/#{options[:name].snakecase}.rb", content: class_content
 
       # Files according to WSDL
-      @wsdl_doc.operations.each do |operation, details|
+      @wsdl_doc.operations.each do |operation, op_details|
         puts "Creating files for operation: #{operation}"
         @content = "default:\n"
         @use_camel_case = false
-        puts 'Message params: ' + details.to_s
+        puts 'Message params: ' + op_details.to_s
         # From namespace identifier, find namespace, and for that find schemaLocation xsd and use that to build request
-        if details[:parameters]
-          details[:parameters].each do |element, details|
-            @use_camel_case = true if /[[:upper:]]/.match(element.to_s[0]) != nil
+        if op_details[:parameters]
+          op_details[:parameters].each do |element, details|
+            @use_camel_case = true unless /[[:upper:]]/.match(element.to_s[0]).nil?
             @content += "  #{element.to_s.snakecase}: #{fill_in_field_from_type(details[:type])} # #{details[:type]} \n"
             # TODO: If details is a Hash need to loop again
           end
         end
-        wsdl_to_yaml_for root_elements_for(details)
+        wsdl_to_yaml_for root_elements_for(op_details)
         params = []
         params << 'convert_request_keys_to: :camelcase' if @use_camel_case
         params_string = params == [] ? '' : ', ' + params.join(', ')
@@ -133,4 +128,4 @@ module Soaspec
   end
 end
 
-Soaspec::Exe.start(ARGV)
+Soaspec::Exe.start(ARGV)

data/exe/xml_to_yaml_file

@@ -4,7 +4,7 @@ require 'xmlsimple'
 require 'yaml'
 require 'fileutils'
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'soaspec'
 
@@ -28,7 +28,7 @@ end
 def clean_up_yaml(yaml_string)
   yaml_string = yaml_string.gsub(/\R+(\s*)-/, '').gsub(/{}/, "''") # Remove arrays, {} -> ''
   # Insert new line where there are 2 ':' on 1 line. Issue from first gsub
-  yaml_string.gsub(/:(\s)(\w*):/){|s| s.insert(1, "\n")}
+  yaml_string.gsub(/:(\s)(\w*):/) { |s| s.insert(1, "\n") }
 end
 
 if ARGV[0]
@@ -39,4 +39,4 @@ if ARGV[0]
   create_file(filename: ARGV[1] || default_output_file, content: yaml_file)
 else
   puts 'usage: xml_to_yaml_file [input.xml] [output.yml] '
-end
+end

data/lib/soaspec.rb

@@ -36,7 +36,6 @@ require 'soaspec/wait'
 
 # Gem for handling SOAP and REST api tests
 module Soaspec
-
   @template_folder = 'templates'
   @auto_oauth = true
 
@@ -59,31 +58,21 @@ module Soaspec
     # Folder used to store credentials
     # Used in auth2_file command
     # @param [String] folder
-    def credentials_folder=(folder)
-      @credentials_folder = folder
-    end
+    attr_writer :credentials_folder
 
     # Credentials folder used to store secret data (not in source control) E.g passwords
-    def credentials_folder
-      @credentials_folder
-    end
+    attr_reader :credentials_folder
 
     # Used so that exchange class knows what context it's in
     # @param [ExchangeHandler] handler A class inheriting from Soaspec::ExchangeHandler. Exchange class uses this
-    def api_handler=(handler)
-      @api_handler = handler
-    end
+    attr_writer :api_handler
 
     # Exchange Handler class currently being used
-    def api_handler
-      @api_handler
-    end
+    attr_reader :api_handler
 
     # Set whether to transform strings to keys in request automatically
     # @param [Boolean] use_keys
-    def always_use_keys=(use_keys)
-      @always_use_keys = use_keys
-    end
+    attr_writer :always_use_keys
 
     # @return [Boolean] Whether to transform strings to keys in request automatically
     def always_use_keys?
@@ -97,13 +86,14 @@ module Soaspec
 
     # Whether to log all API traffic
     def log_api_traffic=(set)
-      @log_api_traffic = set
-      RestClient.log = nil unless set
+      puts 'Soaspec.log_api_traffic= now deprecated. Please use Soaspec::SpecLogger.log_api_traffic= instead'
+      Soaspec::SpecLogger.log_api_traffic = set
     end
 
     # @return [Boolean] Whether to log all API traffic
     def log_api_traffic?
-      @log_api_traffic.nil? ? true : @log_api_traffic
+      puts 'Soaspec.log_api_traffic? now deprecated. Please use Soaspec::SpecLogger.log_api_traffic? instead'
+      Soaspec::SpecLogger.log_api_traffic?
     end
   end
 end

data/lib/soaspec/core_ext/hash.rb

@@ -1,28 +1,25 @@
-
-
-
 # Override Hash class with convience methods
 class Hash
-
   # Transform each key in Hash to a symbol. Privately used by non-self method
   def self.transform_keys_to_symbols(value)
-    return value if not value.is_a?(Hash)
-    hash = value.inject({}){|memo,(k,v)| memo[k.to_sym] = Hash.transform_keys_to_symbols(v); memo}
-    return hash
+    return value unless value.is_a?(Hash)
+
+    hash = value.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = Hash.transform_keys_to_symbols(v); }
+    hash
   end
 
   # Take keys of hash and transform those to a symbols
   def transform_keys_to_symbols
-    inject({}){|memo, (k, v)| memo[k.to_sym] = Hash.transform_keys_to_symbols(v); memo}
+    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]
-    self.values.each do |hash_value|
-     # next if hash_value.is_a? Array
-     #
+    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
@@ -42,9 +39,11 @@ class Hash
     each_value do |v|
       return true if v == value
       next unless v.is_a? Hash
+
       v.each_value do |v|
         return true if v == value
         next unless v.is_a? Hash
+
         v.each_value do |v|
           return true if v == value
         end
@@ -79,5 +78,4 @@ class Hash
       end
     end
   end
-
 end

data/lib/soaspec/cucumber/generic_steps.rb

@@ -82,4 +82,4 @@ end
 # Verify that the HTTP status code is 200..299 and that any defined mandatory elements / mandatory values are as expected
 Then 'it should be successful' do
   expect(current_exchange).to be_successful
-end
+end

data/lib/soaspec/exchange.rb

@@ -62,6 +62,7 @@ class Exchange
     # As a last resort this uses the global parameter. The handler should be set straight before an exchange is made to use this
     @exchange_handler ||= default_handler_used || Soaspec.api_handler
     raise '@exchange_handler not set. Set either with `Soaspec.api_handler = Handler.new` or within the exchange' unless @exchange_handler
+
     @fail_factory = nil
     @override_parameters = override_parameters
     @retry_for_success = false
@@ -91,6 +92,7 @@ class Exchange
       response = exchange_handler.make_request(request_params)
       return response unless retry_for_success?
       return response if (200..299).cover? @exchange_handler.status_code_for(response)
+
       sleep 0.5
       break response if count == retry_count
     end
@@ -109,6 +111,7 @@ class Exchange
   def retrieve(name)
     method = '__stored_val__' + name.to_s
     raise ArgumentError('Value not stored at ') unless exchange_handler.respond_to? method
+
     exchange_handler.send(method)
   end
 
@@ -230,4 +233,4 @@ class Exchange
     end
     self
   end
-end
+end

data/lib/soaspec/exchange_handlers/exchange_handler.rb

@@ -1,8 +1,6 @@
-
 require_relative 'handler_accessors'
 
 module Soaspec
-
   # Inherit this for a class describing how to implement a particular exchange.
   # Has basic methods common for methods defining RSpec tests in YAML
   class ExchangeHandler
@@ -19,10 +17,11 @@ 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
-    def initialize(name = self.class.to_s, options = {})
+    def initialize(name = self.class.to_s, _options = {})
       use
       @request_option = :hash
       raise ArgumentError, 'Cannot define both template_name and default_hash' if respond_to?(:template_name_value) && respond_to?(:default_hash_value)
+
       @template_name = respond_to?(:template_name_value) ? template_name_value : ''
       @default_hash = respond_to?(:default_hash_value) ? default_hash_value : {}
       @name = name
@@ -102,6 +101,7 @@ module Soaspec
     # Set instance variable and remove it from Hash
     def set_remove_key(hash, key)
       return unless hash.key? key
+
       __send__("#{key}=", hash[key])
       hash.delete key
     end
@@ -114,7 +114,8 @@ module Soaspec
     # Request of API call. Either intended request or actual request
     def request(response)
       return "Request not yet sent Request option is #{@request_option}" unless response
+
       'Specific API handler should implement this'
     end
   end
-end
+end

data/lib/soaspec/exchange_handlers/handler_accessors.rb

@@ -2,7 +2,6 @@ module Soaspec
   # Describes methods test handlers use to easily set attributes
   # Some are included in 'success scenarios' and to configure the request sent
   module HandlerAccessors
-
     # Defines expected_mandatory_elements method used in 'success_scenario' shared examples
     # to indicate certain elements must be present
     # @param [Array] elements Array of symbols specifying expected element names for 'success scenario' in snakecase
@@ -22,6 +21,7 @@ module Soaspec
     def mandatory_elements(elements)
       define_method('expected_mandatory_elements') do
         return [elements] if elements.is_a?(String) || elements.is_a?(Symbol)
+
         elements
       end
     end
@@ -38,6 +38,7 @@ module Soaspec
     #
     def mandatory_xpath_values(xpath_value_pairs)
       raise ArgumentError('Hash of {xpath => expected values} expected ') unless xpath_value_pairs.is_a? Hash
+
       define_method('expected_mandatory_xpath_values') { xpath_value_pairs }
     end
 
@@ -53,6 +54,7 @@ module Soaspec
     #
     def mandatory_json_values(json_value_pairs)
       raise ArgumentError("Hash of {'jsonpath' => expected values} expected") unless json_value_pairs.is_a? Hash
+
       define_method('expected_mandatory_json_values') { json_value_pairs }
     end
 
@@ -73,7 +75,7 @@ module Soaspec
     # @param [String, Symbol] name Method name used to access attribute
     # @param [String, nil, Hash] attribute Attribute name to extract from xml. If not set, this will default to @name
     def attribute(name, attribute = nil)
-      attribute_used = attribute ? attribute : name.to_s
+      attribute_used = attribute || name.to_s
       define_method("__custom_path_#{name}") do |response|
         value_from_path(response, 'implicit', attribute: attribute_used)
       end
@@ -83,6 +85,7 @@ module Soaspec
     # You must then use lower case in the xpath's to obtain the desired values
     def convert_to_lower(set)
       return unless set
+
       define_method('convert_to_lower?') { true }
     end
 
@@ -92,6 +95,7 @@ module Soaspec
     # This will be overridden if xpath has a ':' in it
     def strip_namespaces(set)
       return unless set
+
       # Whether to remove namespaces in xpath assertion automatically
       define_method('strip_namespaces?') { true }
     end
@@ -116,4 +120,4 @@ module Soaspec
       end
     end
   end
-end
+end