soaspec 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c021efb99c24b3ab3c9e20d17d9a6162dbc2000
-  data.tar.gz: 8a565f97656d00caaa5f3d55f17d76ef3d2e0966
+  metadata.gz: 85a80e81b02c106032a9d6843aec406708137ea7
+  data.tar.gz: 1f50e802564fdc610ecf72ca8bbdb33a63ddff95
 SHA512:
-  metadata.gz: 29afe2d8539a57f203330bc5a869648dbfa018c27aba144af9d5343a592c74591c0d07cec5c22439d5286200a01d27ecd4fbee6b646aa8145a434950f8b7ff5b
-  data.tar.gz: eec926fd442193365280f711ed49d705dfa6b29de63cb18714af7101b5d9c1b469d73586d5c775dea9135eb02f077b7224d7a9dbedf5aedade90fb2549bdcc3f
+  metadata.gz: 0e72ef672e17b4fbf87078fd950c173fd09610b480c8b40b26cdbe00a0e8e878fd87a81d5a21a2bdd416a2edfa5ee336d0b3f2c3ba218584d1ab90a682666ba4
+  data.tar.gz: 534d5ceb6f6888a29ce223f7f00bae1722f9f75ef8ca63cf1cd011356f279a61a953c31fc3956b97b65256cc09b61ddc4d652a13cb010b18fbac7660f246c693

data/ChangeLog

@@ -1,3 +1,9 @@
+Version 0.1.13
+* Enhancements
+  * Cleaned up comments (mainly OAuth2 related)
+  * Cleaned up REST handler code, adding more comments on usage
+  * Added 'soaspec/cucumber/generic_steps' to simplify reusing code and also demonstrate how gem can be used
+
 Version 0.1.12
 * Enhancements
   * Add 'refresh_token' attribute to Soaspec::OAuth2 class so that token can be retrieved once and then stored

data/lib/soaspec/cucumber/generic_steps.rb

@@ -0,0 +1,49 @@
+require 'active_support/core_ext/string/inflections'
+
+Given 'I am performing a {word} on the {string} API' do |operation, api_name|
+  @exchange = api_name.camelize.constantize.send operation
+end
+
+Given 'I set the {word} to {string}' do |key, value|
+  @exchange[key] = value
+end
+
+Given 'I use the path {word}' do |suburl|
+  @exchange.suburl = suburl
+end
+
+Given 'I filter {string} by {string}' do |filter_key, filter_value|
+  transformed_key = filter_key.to_sym
+  if @exchange.override_parameters[:q]
+    @exchange.override_parameters[:q][transformed_key] = filter_value
+  else
+    @exchange.override_parameters[:q] = { transformed_key => filter_value }
+  end
+end
+
+# This is getting quite technical
+Given 'I set header {string} to {string}' do |header_name, header_value|
+  if @exchange.override_parameters[:params]
+    @exchange.override_parameters[:params][header_name] = header_value
+  else
+    @exchange.override_parameters[:params] = { header_name => header_value }
+  end
+end
+
+When 'I make the request' do
+  @exchange.call
+end
+
+Then 'it should have the {word} {string}' do |key, expected_value|
+  expect(@exchange[key]).to eq expected_value
+end
+
+Then 'it should have the {string} {string}' do |key_string, expected_value|
+  key = key_string.tr(' ', '_')
+  actual_value = @exchange.respond_to?(key) ? @exchange.send(key) : @exchange[key]
+  expect(actual_value.to_s).to eq expected_value
+end
+
+Then 'it should be successful' do
+  expect(200..299).to cover @exchange.status_code
+end

data/lib/soaspec/exchange.rb

@@ -40,7 +40,8 @@ class Exchange
   attr_accessor :test_name
   # Expect Factory to fail upon trying to create
   attr_writer :fail_factory
-
+  # Parameters to override for default params
+  attr_accessor :override_parameters
 
   def values_from_path(path, attribute: nil)
     exchange_handler.values_from_path(response, path, attribute: attribute)

data/lib/soaspec/exchange_handlers/exchange_handler.rb

@@ -88,6 +88,13 @@ module Soaspec
       end
     end
 
+    # Set instance variable for each key in hash remove it from Hash
+    # @param [Hash] hash with items to remove from
+    # @param [Array] keys List of keys to remove from hash, setting each one
+    def set_remove_keys(hash, keys)
+      keys.each { |key| set_remove_key(hash, key) }
+    end
+
     # Set instance variable and remove it from Hash
     def set_remove_key(hash, key)
       return unless hash.key? key

data/lib/soaspec/exchange_handlers/rest_accessors.rb

@@ -1,3 +1,5 @@
+require_relative 'rest_accessors_defaults'
+
 module Soaspec
   # Accessors specific to REST handler
   module RestAccessors
@@ -11,25 +13,20 @@ module Soaspec
     end
 
     # Will create access_token method based on passed parameters
-    # @param [Hash] params Params client_id: nil, client_secret: nil, token_url: nil, username: nil, password: nil, security_token: nil
+    # @param [Hash] params OAuth 2 parameters
+    # @param_value [token_url] URL to retrieve OAuth token from. @Note this can be set globally instead of here
+    # @param_value [client_id] Client ID
+    # @param_value [client_secret] Client Secret
+    # @param_value [username] Username used in password grant
+    # @param_value [password] Password used in password grant
+    # @param_value [security_token] Security Token used in password grant
     def oauth2(params)
-      # Object to handle oauth2
-      define_method('oauth_obj') do
-        OAuth2.new(params, api_username)
-      end
-
-      # Method to send request to get oauth token based on parameters
-      define_method('oauth_response') do
-        oauth_obj.response
-      end
-
-      define_method('access_token') do
-        oauth_obj.access_token
-      end
-
-      define_method('instance_url') do
-        oauth_response['instance_url']
-      end
+      # @!method oauth_obj Object to handle oauth2
+      define_method('oauth_obj') { OAuth2.new(params, api_username) }
+      # @!method access_token Retrieve OAuth2 access token
+      define_method('access_token') { oauth_obj.access_token }
+      # @!method instance_url Retrieve instance url from OAuth request
+      define_method('instance_url') { oauth_obj.response['instance_url'] }
     end
 
     # Pass path to YAML file containing OAuth2 parameters

data/lib/soaspec/exchange_handlers/rest_accessors_defaults.rb

@@ -0,0 +1,21 @@
+module Soaspec
+  # Defaults for Soaspec RestAccessors method
+  module RestAccessorsDefaults
+    # Set through following method. Base URL in REST requests.
+    def base_url_value
+      nil
+    end
+
+    # Headers used in RestClient
+    def rest_client_headers
+      {}
+    end
+
+    # Whether to convert each key in the request to PascalCase
+    # It will also auto convert simple XPath, JSONPath where '//' or '..' not specified
+    # @return Whether to convert to PascalCase
+    def pascal_keys?
+      false
+    end
+  end
+end

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -14,18 +14,60 @@ module Soaspec
   # Wraps around Savon client defining default values dependent on the soap request
   class RestHandler < ExchangeHandler
     extend Soaspec::RestAccessors
+    include Soaspec::RestAccessorsDefaults
 
     # User used in making API calls
     attr_accessor :api_username
 
-    # Set through following method. Base URL in REST requests.
-    def base_url_value
-      nil
+    # Setup object to handle communicating with a particular SOAP WSDL
+    # @param [Hash] options Options defining REST request. base_url, default_hash
+    def initialize(name = self.class.to_s, options = {})
+      raise "Base URL not set! Please set in class with 'base_url' method" unless base_url_value
+      @default_hash = {}
+      if name.is_a?(Hash) && options == {} # If name is not set, use first parameter as the options hash
+        options = name
+        name = self.class.to_s
+      end
+      super
+      set_remove_keys(options, %i[api_username default_hash template_name])
+      @init_options = options
     end
 
-    # Headers used in RestClient
-    def rest_client_headers
-      {}
+    # Used in together with Exchange request that passes such override parameters
+    # @param [Hash] override_parameters Params to characterize REST request
+    # @option override_parameters [Hash] :params Extra parameters (E.g. headers)
+    # @option override_parameters [String] suburl URL appended to base_url of class
+    # @option override_parameters [Hash] :q Query for REST
+    # @option override_parameters [Symbol] :method REST method (:get, :post, :patch, etc)
+    # Following are for the body of the request
+    # @option override_parameters [Hash] :body Hash to be converted to JSON in request body
+    # @option override_parameters [String] :payload String to be passed directly in request body
+    # @option override_parameters [String] :template_name Path to file to be read via ERB and passed in request body
+    def make_request(override_parameters)
+      @merged_options ||= init_merge_options
+      test_values = override_parameters
+      test_values[:params] ||= {}
+      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)
+
+      @resource_used = test_values[:suburl] ? @resource[test_values[:suburl]] : @resource
+
+      begin
+        response = case test_values[:method]
+                   when :post, :patch, :put
+                     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
+        response = e.response
+      end
+      Soaspec::SpecLogger.info(["response_headers: #{response.headers}", "response_body: #{response}"])
+      response
     end
 
     # Add values to here when extending this class to have default REST options.
@@ -43,35 +85,12 @@ module Soaspec
       Hash[rest_client_headers.map { |k, header| [k, ERB.new(header).result(binding)] }]
     end
 
-    # Setup object to handle communicating with a particular SOAP WSDL
-    # @param [Hash] options Options defining SOAP request. WSDL, authentication
-    def initialize(name = self.class.to_s, options = {})
-      raise "Base URL not set! Please set in class with 'base_url' method" unless base_url_value
-      @default_hash = {}
-      if name.is_a?(Hash) && options == {} # If name is not set
-        options = name
-        name = self.class.to_s
-      end
-      super
-      set_remove_key(options, :api_username)
-      set_remove_key(options, :default_hash)
-      set_remove_key(options, :template_name)
-      @init_options = options
-    end
-
     # Convert snakecase to PascalCase
     def convert_to_pascal_case(key)
       return key if /[[:upper:]]/ =~ key[0] # If first character already capital, don't do conversion
       key.split('_').map(&:capitalize).join
     end
 
-    # Whether to convert each key in the request to PascalCase
-    # It will also auto convert simple XPath, JSONPath where '//' or '..' not specified
-    # @return Whether to convert to PascalCase
-    def pascal_keys?
-      false
-    end
-
     # Initialize value of merged options
     # @return [Hash] Hash of merged options
     def init_merge_options
@@ -84,40 +103,6 @@ module Soaspec
       options.merge(@init_options)
     end
 
-    # Used in together with Exchange request that passes such override parameters
-    # @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
-      test_values = override_parameters
-      test_values[:params] ||= {}
-      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)
-
-      @resource_used = test_values[:suburl] ? @resource[test_values[:suburl]] : @resource
-
-      begin
-      response = case test_values[:method]
-                 when :post, :patch, :put
-                   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
-        response = e.response
-      end
-      Soaspec::SpecLogger.info('response_headers: ' + response.headers.to_s)
-      Soaspec::SpecLogger.info('response_body: ' + response.to_s)
-      response
-    end
-
     # @param [Hash] format Format of expected result.
     # @return [Object] Generic body to be displayed in error messages
     def response_body(response, format: :hash)
@@ -134,25 +119,6 @@ module Soaspec
       status_code_for(response) != 404
     end
 
-    # Convert XML or JSON response into a Hash
-    # @param [String] response Response as a String (either in XML or JSON)
-    # @return [Hash]
-    def extract_hash(response)
-      raise ArgumentError("Empty Body. Can't assert on it") if response.body.empty?
-      case Interpreter.response_type_for response
-      when :json
-        converted = JSON.parse(response.body)
-        return converted.transform_keys_to_symbols if converted.is_a? Hash
-        return converted.map!(&:transform_keys_to_symbols) if converted.is_a? Array
-        raise 'Incorrect Type prodcued ' + converted.class
-      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
-
     # @return [Boolean] Whether response contains expected value
     def include_value?(response, expected)
       extract_hash(response).include_value? expected
@@ -168,25 +134,6 @@ module Soaspec
       response.code
     end
 
-    # Override this to specify elements that must be present in the response
-    # Will be used in 'success_scenarios' shared examples
-    # @return [Array] Array of symbols specifying element names
-    def mandatory_elements
-      []
-    end
-
-    # Override this to specify xpath results that must be present in the response
-    # Will be used in 'success_scenarios' shared examples
-    # @return [Hash] Hash of 'xpath' => 'expected value' pairs
-    def mandatory_xpath_values
-      {}
-    end
-
-    # Attributes set at the root XML element of SOAP request
-    def root_attributes
-      nil
-    end
-
     # Returns the value at the provided xpath
     # @param [RestClient::Response] response
     # @param [String] xpath
@@ -259,6 +206,26 @@ module Soaspec
       end
     end
 
+    # TODO: This and 'to_hash' method should be merged
+    # Convert XML or JSON response into a Hash
+    # @param [String] response Response as a String (either in XML or JSON)
+    # @return [Hash]
+    def extract_hash(response)
+      raise ArgumentError("Empty Body. Can't assert on it") if response.body.empty?
+      case Interpreter.response_type_for response
+      when :json
+        converted = JSON.parse(response.body)
+        return converted.transform_keys_to_symbols if converted.is_a? Hash
+        return converted.map!(&:transform_keys_to_symbols) if converted.is_a? Array
+        raise 'Incorrect Type produced ' + converted.class
+      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
+
     # @return [Hash] Hash representing response body
     def to_hash(response)
       case Interpreter.response_type_for(response)
@@ -272,7 +239,7 @@ module Soaspec
       end
     end
 
-    # Request of API call. Either intended request or actual request
+    # @response [RestClient::Request] Request of API call. Either intended request or actual request
     def request(response)
       return 'Request not yet sent' if response.nil?
       response.request
@@ -280,7 +247,7 @@ module Soaspec
 
     private
 
-    # Work out data to send based upon payload, template_name
+    # Work out data to send based upon payload, template_name, or body
     # @return [String] Payload to send in REST request
     def post_data(test_values)
       data = if test_values[:body]
@@ -325,6 +292,5 @@ module Soaspec
         end
       end
     end
-
   end
-end
+end

data/lib/soaspec/o_auth2.rb

@@ -25,6 +25,12 @@ module Soaspec
     attr_accessor :retry_count
 
     # @param [Hash] params_sent Parameters to make OAuth request
+    # @param_value [token_url] URL to retrieve OAuth token from. @Note this can be set globally instead of here
+    # @param_value [client_id] Client ID
+    # @param_value [client_secret] Client Secret
+    # @param_value [username] Username used in password grant
+    # @param_value [password] Password used in password grant
+    # @param_value [security_token] Security Token used in password grant
     # @param [String] api_username Username to use which can be set by Soaspec::ExchangeHandler
     def initialize(params_sent, api_username = nil)
       params = params_sent.transform_keys_to_symbols

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.1.12'.freeze
+  VERSION = '0.1.13'.freeze
 end

data/soaspec.gemspec

@@ -30,6 +30,7 @@ the same configuration "
   spec.add_development_dependency 'require_all', '1.5.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov'
+  spec.add_dependency 'activesupport'
   spec.add_dependency 'faker'
   spec.add_dependency 'hashie'
   spec.add_dependency 'jsonpath'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-25 00:00:00.000000000 Z
+date: 2018-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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
@@ -329,10 +343,12 @@ files:
 - exe/xml_to_yaml_file
 - 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/rest_accessors.rb
+- lib/soaspec/exchange_handlers/rest_accessors_defaults.rb
 - lib/soaspec/exchange_handlers/rest_handler.rb
 - lib/soaspec/exchange_handlers/rest_methods.rb
 - lib/soaspec/exchange_handlers/soap_handler.rb