soaspec 0.2.23 → 0.2.24

data/lib/soaspec/generator/spec/spec_helper.rb.erb

@@ -1,23 +1,23 @@
-
-require 'soaspec'
-require 'require_all'
-require_all 'lib'
-require 'data_magic'
-
-include DataMagic # Used as example of loading data smartly. Use 'data_for' method to load yml data
-<% if @type == 'rest' %>
-include Soaspec::RestMethods
-<% end %>
-
-RSpec.configure do |config|
-  # This will make backtrace much shorter by removing many lines from rspec failure message
-  config.backtrace_exclusion_patterns = [
-      /rspec/
-  ]
-<% if @virtual %>
-  # Close test server after all RSpec tests have run
-  config.after(:suite) do
-    Process.kill(:QUIT, ENV['test_server_pid'].to_i) if ENV['test_server_pid'] && !ENV['leave_server_running']
-  end
-<% end %>
-end
+
+require 'soaspec'
+require 'require_all'
+require_all 'lib'
+require 'data_magic'
+
+include DataMagic # Used as example of loading data smartly. Use 'data_for' method to load yml data
+<% if @type == 'rest' %>
+include Soaspec::RestMethods
+<% end %>
+
+RSpec.configure do |config|
+  # This will make backtrace much shorter by removing many lines from rspec failure message
+  config.backtrace_exclusion_patterns = [
+      /rspec/
+  ]
+<% if @virtual %>
+  # Close test server after all RSpec tests have run
+  config.after(:suite) do
+    Process.kill(:QUIT, ENV['test_server_pid'].to_i) if ENV['test_server_pid'] && !ENV['leave_server_running']
+  end
+<% end %>
+end

data/lib/soaspec/generator/template/soap_template.xml

@@ -1,7 +1,7 @@
-<env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://thomas-bayer.com/blz/" xmlns:env="http://www.w3.org/2003/05/soap-envelope">
-  <env:Body>
-    <tns:getBank>
-      <tns:blz><%= test_values[:blz] || '70070010' %></tns:blz>
-    </tns:getBank>
-  </env:Body>
+<env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://thomas-bayer.com/blz/" xmlns:env="http://www.w3.org/2003/05/soap-envelope">
+  <env:Body>
+    <tns:getBank>
+      <tns:blz><%= test_values[:blz] || '70070010' %></tns:blz>
+    </tns:getBank>
+  </env:Body>
 </env:Envelope>

data/lib/soaspec/indifferent_hash.rb

@@ -1,7 +1,7 @@
-require 'hashie'
-
-# Hash that allows accessing hash with either string or Hash
-class IndifferentHash < Hash
-  include Hashie::Extensions::MergeInitializer
-  include Hashie::Extensions::IndifferentAccess
-end
+require 'hashie'
+
+# Hash that allows accessing hash with either string or Hash
+class IndifferentHash < Hash
+  include Hashie::Extensions::MergeInitializer
+  include Hashie::Extensions::IndifferentAccess
+end

data/lib/soaspec/interpreter.rb

@@ -1,39 +1,39 @@
-# Help interpret the general type of a particular object
-class Interpreter
-  class << self
-    # @param [Object] response API response
-    # @return [Symbol] Type of provided response
-    def response_type_for(response)
-      @response = response
-      if @response.is_a? String
-        if xml?
-          :xml
-        elsif json?
-          :json
-        else
-          :string
-        end
-      elsif response.is_a? Hash
-        :hash
-      elsif response.is_a?(Nokogiri::XML::NodeSet) || response.is_a?(Nokogiri::XML::Document)
-        :xml
-      else
-        :unknown
-      end
-    end
-
-    # @return [Boolean] Whether valid XML
-    def xml?
-      Nokogiri::XML(@response) { |config| config.options = Nokogiri::XML::ParseOptions::STRICT }
-    rescue Nokogiri::XML::SyntaxError
-      false
-    end
-
-    # @return [Boolean] Whether valid JSON
-    def json?
-      JSON.parse(@response)
-    rescue JSON::ParserError
-      false
-    end
-  end
-end
+# Help interpret the general type of a particular object
+class Interpreter
+  class << self
+    # @param [Object] response API response
+    # @return [Symbol] Type of provided response
+    def response_type_for(response)
+      @response = response
+      if @response.is_a? String
+        if xml?
+          :xml
+        elsif json?
+          :json
+        else
+          :string
+        end
+      elsif response.is_a? Hash
+        :hash
+      elsif response.is_a?(Nokogiri::XML::NodeSet) || response.is_a?(Nokogiri::XML::Document)
+        :xml
+      else
+        :unknown
+      end
+    end
+
+    # @return [Boolean] Whether valid XML
+    def xml?
+      Nokogiri::XML(@response) { |config| config.options = Nokogiri::XML::ParseOptions::STRICT }
+    rescue Nokogiri::XML::SyntaxError
+      false
+    end
+
+    # @return [Boolean] Whether valid JSON
+    def json?
+      JSON.parse(@response)
+    rescue JSON::ParserError
+      false
+    end
+  end
+end

data/lib/soaspec/matchers.rb

@@ -1,114 +1,114 @@
-require_relative 'core_ext/hash'
-require_relative 'not_found_errors'
-
-# Whether response has any element with the provided value
-RSpec::Matchers.define :contain_value do |expected|
-  match do |actual|
-    expect(actual.exchange_handler.include_value?(actual.response, expected)).to be true
-  end
-
-  failure_message do |actual|
-    "expected that #{actual.exchange_handler.response_body(actual.response, format: :hash)} would contain value #{expected}"
-  end
-end
-
-# Whether substring exists in body of response (more general than above)
-RSpec::Matchers.define :include_in_body do |expected|
-  match do |actual|
-    expect(actual.exchange_handler.include_in_body?(actual.response, expected)).to be true
-  end
-
-  failure_message do |actual|
-    "expected that #{actual.exchange_handler.response_body(actual.response, format: :raw)} would contain value #{expected}"
-  end
-end
-
-# Whether an element exists at expected xpath
-RSpec::Matchers.define :have_element_at_path do |xpath|
-  match do |object|
-    # Object like `response` returns the Exchange object from which a path can be obtained
-    exchange = object.respond_to?(:exchange) ? object.exchange : object
-    expect { exchange[xpath] }.to_not raise_error # Error will be raised if Path returns no value
-  end
-
-  # TODO: Would be better to print failure message
-  failure_message do |object|
-    # Object like `response` returns the Exchange object from which a path can be obtained
-    exchange = object.respond_to?(:exchange) ? object.exchange : object
-    "expected that #{exchange.exchange_handler.response_body(exchange.response, format: :raw)} would have element at path '#{xpath}'"
-  end
-end
-
-RSpec::Matchers.alias_matcher :have_element_at_xpath, :have_element_at_path
-RSpec::Matchers.alias_matcher :contain_key, :have_element_at_path
-
-# Whether an element at xpath (defined by key) has value (defined by value).
-# @param [Hash] expected_hash Xpath => Value pair (e.g. '//xmlns:GetWeatherResult' => 'Data Not Found')
-RSpec::Matchers.define :have_xpath_value do |expected_hash|
-  match do |object|
-    # Object like `response` returns the Exchange object from which a path can be obtained
-    exchange = object.respond_to?(:exchange) ? object.exchange : object
-    expected_hash = Hash[*expected_hash.flatten] if expected_hash.is_a?(Array) # For some reason Array was occuring
-    expect(exchange[expected_hash.keys.first]).to eq expected_hash.values.first
-  end
-
-  failure_message do |actual|
-    "expected that xpath '#{expected_hash.keys.first}' has value '#{expected_hash.values.first}' but was '#{actual[expected_hash.keys.first]}'"
-  end
-end
-
-RSpec::Matchers.alias_matcher :have_jsonpath_value, :have_xpath_value
-
-RSpec::Matchers.define :be_found do
-  match do |exchange|
-    expect(exchange.exchange_handler.found?(exchange.response)).to be true
-  end
-
-  failure_message do |exchange|
-    "expected result #{exchange.response} to be found. Status code is #{exchange.response.code}"
-  end
-end
-
-# Whether response has successful status code and correct mandatory elements and values
-RSpec::Matchers.define :be_successful do
-  # @param [Exchange, RestClient::Response] actual Object that returns Exchange or is Exchange
-  # @return [Exchange] Exchange to use
-  def exchange_from(actual)
-    actual.respond_to?(:exchange) ? actual.exchange : actual
-  end
-
-  # @param [Exchange, RestClient::Response] exchange Object that returns Exchange or is Exchange
-  # @return [Array] List of errors when checking Exchange response is successful
-  def collect_errors(exchange)
-    failure_list = []
-    failure_list << "#{exchange.status_code} not valid status code" unless (200..299).cover?(exchange.status_code)
-    exchange.exchange_handler.expected_mandatory_elements.each do |mandatory_element_path|
-      begin
-        exchange[mandatory_element_path]
-      rescue NoElementAtPath => error
-        failure_list << error.message
-      end
-    end
-    exchange.exchange_handler.expected_mandatory_xpath_values.each do |path, value|
-      failure_list << "Expected value at xpath '#{path}' to be '#{value}' but was '#{exchange[path]}'" unless exchange[path] == value
-    end
-    exchange.exchange_handler.expected_mandatory_json_values.each do |path, value|
-      failure_list << "Expected value at json '#{path}' to be '#{value}' but was '#{exchange[path]}'" unless exchange[path] == value
-    end
-    failure_list
-  end
-
-  match do |actual|
-    exchange = exchange_from actual
-    failure_list = collect_errors exchange
-    raise failure_list.to_s unless failure_list.empty?
-    true
-  end
-
-  match_when_negated do |actual|
-    exchange = exchange_from actual
-    failure_list = collect_errors exchange
-    raise "Expected failure. Status code is #{exchange.status_code}" if failure_list.empty?
-    true
-  end
-end
+require_relative 'core_ext/hash'
+require_relative 'not_found_errors'
+
+# Whether response has any element with the provided value
+RSpec::Matchers.define :contain_value do |expected|
+  match do |actual|
+    expect(actual.exchange_handler.include_value?(actual.response, expected)).to be true
+  end
+
+  failure_message do |actual|
+    "expected that #{actual.exchange_handler.response_body(actual.response, format: :hash)} would contain value #{expected}"
+  end
+end
+
+# Whether substring exists in body of response (more general than above)
+RSpec::Matchers.define :include_in_body do |expected|
+  match do |actual|
+    expect(actual.exchange_handler.include_in_body?(actual.response, expected)).to be true
+  end
+
+  failure_message do |actual|
+    "expected that #{actual.exchange_handler.response_body(actual.response, format: :raw)} would contain value #{expected}"
+  end
+end
+
+# Whether an element exists at expected xpath
+RSpec::Matchers.define :have_element_at_path do |xpath|
+  match do |object|
+    # Object like `response` returns the Exchange object from which a path can be obtained
+    exchange = object.respond_to?(:exchange) ? object.exchange : object
+    expect { exchange[xpath] }.to_not raise_error # Error will be raised if Path returns no value
+  end
+
+  # TODO: Would be better to print failure message
+  failure_message do |object|
+    # Object like `response` returns the Exchange object from which a path can be obtained
+    exchange = object.respond_to?(:exchange) ? object.exchange : object
+    "expected that #{exchange.exchange_handler.response_body(exchange.response, format: :raw)} would have element at path '#{xpath}'"
+  end
+end
+
+RSpec::Matchers.alias_matcher :have_element_at_xpath, :have_element_at_path
+RSpec::Matchers.alias_matcher :contain_key, :have_element_at_path
+
+# Whether an element at xpath (defined by key) has value (defined by value).
+# @param [Hash] expected_hash Xpath => Value pair (e.g. '//xmlns:GetWeatherResult' => 'Data Not Found')
+RSpec::Matchers.define :have_xpath_value do |expected_hash|
+  match do |object|
+    # Object like `response` returns the Exchange object from which a path can be obtained
+    exchange = object.respond_to?(:exchange) ? object.exchange : object
+    expected_hash = Hash[*expected_hash.flatten] if expected_hash.is_a?(Array) # For some reason Array was occuring
+    expect(exchange[expected_hash.keys.first]).to eq expected_hash.values.first
+  end
+
+  failure_message do |actual|
+    "expected that xpath '#{expected_hash.keys.first}' has value '#{expected_hash.values.first}' but was '#{actual[expected_hash.keys.first]}'"
+  end
+end
+
+RSpec::Matchers.alias_matcher :have_jsonpath_value, :have_xpath_value
+
+RSpec::Matchers.define :be_found do
+  match do |exchange|
+    expect(exchange.exchange_handler.found?(exchange.response)).to be true
+  end
+
+  failure_message do |exchange|
+    "expected result #{exchange.response} to be found. Status code is #{exchange.response.code}"
+  end
+end
+
+# Whether response has successful status code and correct mandatory elements and values
+RSpec::Matchers.define :be_successful do
+  # @param [Exchange, RestClient::Response] actual Object that returns Exchange or is Exchange
+  # @return [Exchange] Exchange to use
+  def exchange_from(actual)
+    actual.respond_to?(:exchange) ? actual.exchange : actual
+  end
+
+  # @param [Exchange, RestClient::Response] exchange Object that returns Exchange or is Exchange
+  # @return [Array] List of errors when checking Exchange response is successful
+  def collect_errors(exchange)
+    failure_list = []
+    failure_list << "#{exchange.status_code} not valid status code" unless (200..299).cover?(exchange.status_code)
+    exchange.exchange_handler.expected_mandatory_elements.each do |mandatory_element_path|
+      begin
+        exchange[mandatory_element_path]
+      rescue NoElementAtPath => error
+        failure_list << error.message
+      end
+    end
+    exchange.exchange_handler.expected_mandatory_xpath_values.each do |path, value|
+      failure_list << "Expected value at xpath '#{path}' to be '#{value}' but was '#{exchange[path]}'" unless exchange[path] == value
+    end
+    exchange.exchange_handler.expected_mandatory_json_values.each do |path, value|
+      failure_list << "Expected value at json '#{path}' to be '#{value}' but was '#{exchange[path]}'" unless exchange[path] == value
+    end
+    failure_list
+  end
+
+  match do |actual|
+    exchange = exchange_from actual
+    failure_list = collect_errors exchange
+    raise failure_list.to_s unless failure_list.empty?
+    true
+  end
+
+  match_when_negated do |actual|
+    exchange = exchange_from actual
+    failure_list = collect_errors exchange
+    raise "Expected failure. Status code is #{exchange.status_code}" if failure_list.empty?
+    true
+  end
+end

data/lib/soaspec/not_found_errors.rb

@@ -1,13 +1,13 @@
-# Raised to represent when there's no element at an Xpath
-class NoElementAtPath < StandardError
-  def initialize(msg = 'No element at path found')
-    super
-  end
-end
-
-# Did not find any element by provided key in the Hash
-class NoElementInHash < StandardError
-  def initialize(msg = 'No element in Hash found')
-    super
-  end
-end
+# Raised to represent when there's no element at an Xpath
+class NoElementAtPath < StandardError
+  def initialize(msg = 'No element at path found')
+    super
+  end
+end
+
+# Did not find any element by provided key in the Hash
+class NoElementInHash < StandardError
+  def initialize(msg = 'No element in Hash found')
+    super
+  end
+end

data/lib/soaspec/o_auth2.rb

@@ -1,128 +1,128 @@
-require 'erb'
-
-module Soaspec
-  # Handles working with OAuth2
-  class OAuth2
-    # How often to refresh access token
-    @refresh_token = :always
-    # List of access tokens. They are mapped according to the OAuth parameters used
-    @access_tokens = {}
-    # List of instance URLs. They are mapped according to the OAuth parameters used
-    @instance_urls = {}
-    class << self
-      # Default token url used across entire suite
-      attr_accessor :token_url
-      # @attr [Symbol] refresh_token How often to refresh access token
-      # Values are:
-      #   * :always - (Default) Request token from token url every time it is needed
-      #   * :once - Request token once for the entire execution of the suite
-      attr_accessor :refresh_token
-      # @attr [Hash] access_tokens List of access tokens. They are mapped according to the OAuth parameters used
-      attr_accessor :access_tokens
-      # List of URLs to that define the instance of an application
-      attr_accessor :instance_urls
-      # Specify whether to see params sent to and retrieved from oauth. This will put password in log file, only recommended for debugging
-      attr_writer :debug_oauth
-
-      # @return [Boolean] Whether to see params sent to & received from oauth URL
-      def debug_oauth?
-        @debug_oauth || false
-      end
-    end
-
-    # @attr [Hash] OAuth parameters
-    attr_accessor :params
-    # @attr [Integer] Count of tries to obtain access token
-    attr_accessor :retry_count
-
-    # @param [Hash] params_sent Parameters to make OAuth request
-    # @option params_sent [token_url] URL to retrieve OAuth token from. @Note this can be set globally instead of here
-    # @option params_sent [client_id] Client ID
-    # @option params_sent [client_secret] Client Secret
-    # @option params_sent [username] Username used in password grant
-    # @option params_sent [password] Password used in password grant
-    # @option params_sent [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)
-      self.retry_count = 0 # No initial tries at getting access token
-      params = params_sent.transform_keys_to_symbols
-      params[:token_url] ||= Soaspec::OAuth2.token_url
-      raise ArgumentError, 'client_id and client_secret not set' unless params[:client_id] && params[:client_secret]
-      raise ArgumentError, 'token_url mandatory' unless params[:token_url]
-
-      self.params = params
-      params[:username] = api_username || ERB.new(params[:username]).result(binding) if params[:username]
-      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]
-    end
-
-    # Retrieve whether to debug oauth parameters based on global settings
-    # @return [Boolean] Whether to see params sent to & received from oauth URL
-    def debug_oauth?
-      self.class.debug_oauth?
-    end
-
-    # Retrieve instance_url according to access token response.
-    # Some applications have a different instance
-    # It's assumed this will be constant for a set of oauth parameters
-    # @return [String] Instance url
-    def instance_url
-      Soaspec::OAuth2.instance_urls[params] ||= response['instance_url']
-    end
-
-    # @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']
-      else # Default is :always
-        response['access_token']
-      end
-    end
-
-    # @return [Hash] Hash containing access token parameters
-    def response
-      Soaspec::SpecLogger.info "using oauth_params: #{params}" if debug_oauth?
-      response = RestClient.post(params[:token_url], payload, cache_control: 'no_cache', verify_ssl: false)
-    rescue RestClient::Exception => error
-      Soaspec::SpecLogger.info(["oauth_error: #{error.message}", "oauth_response: #{error.response}"])
-      self.retry_count += 1
-      sleep 0.1 # Wait if a bit before retying obtaining access token
-      retry if retry_count < 3
-      raise error
-    else
-      Soaspec::SpecLogger.info(["response_headers: #{response.headers}", "response_body: #{response.body}"]) if debug_oauth?
-      JSON.parse(response)
-    end
-
-    # @return [String] String to represent OAuth for logging logs
-    def request_message
-      if debug_oauth?
-        "request_params: #{payload}"
-      else
-        params[:username] ? "User '#{params[:username]}'" : 'client_credentials'
-      end
-    end
-
-    # @return [String] Password to use in OAuth request
-    def password
-      params[:security_token] ? (params[:password] + params[:security_token]) : params[:password]
-    end
-
-    # Payload to add to o-auth request dependent on params provided
-    # @return [Hash] Payload for retrieving OAuth access token
-    def payload
-      payload = { client_id: params[:client_id], client_secret: params[:client_secret] }
-      payload.merge(if params[:password] && params[:username]
-                      {
-                        grant_type: 'password', username: params[:username],
-                        password: password, multipart: true
-                      }
-                    else
-                      { grant_type: 'client_credentials' }
-                    end)
-    end
-  end
-end
+require 'erb'
+
+module Soaspec
+  # Handles working with OAuth2
+  class OAuth2
+    # How often to refresh access token
+    @refresh_token = :always
+    # List of access tokens. They are mapped according to the OAuth parameters used
+    @access_tokens = {}
+    # List of instance URLs. They are mapped according to the OAuth parameters used
+    @instance_urls = {}
+    class << self
+      # Default token url used across entire suite
+      attr_accessor :token_url
+      # @attr [Symbol] refresh_token How often to refresh access token
+      # Values are:
+      #   * :always - (Default) Request token from token url every time it is needed
+      #   * :once - Request token once for the entire execution of the suite
+      attr_accessor :refresh_token
+      # @attr [Hash] access_tokens List of access tokens. They are mapped according to the OAuth parameters used
+      attr_accessor :access_tokens
+      # List of URLs to that define the instance of an application
+      attr_accessor :instance_urls
+      # Specify whether to see params sent to and retrieved from oauth. This will put password in log file, only recommended for debugging
+      attr_writer :debug_oauth
+
+      # @return [Boolean] Whether to see params sent to & received from oauth URL
+      def debug_oauth?
+        @debug_oauth || false
+      end
+    end
+
+    # @attr [Hash] OAuth parameters
+    attr_accessor :params
+    # @attr [Integer] Count of tries to obtain access token
+    attr_accessor :retry_count
+
+    # @param [Hash] params_sent Parameters to make OAuth request
+    # @option params_sent [token_url] URL to retrieve OAuth token from. @Note this can be set globally instead of here
+    # @option params_sent [client_id] Client ID
+    # @option params_sent [client_secret] Client Secret
+    # @option params_sent [username] Username used in password grant
+    # @option params_sent [password] Password used in password grant
+    # @option params_sent [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)
+      self.retry_count = 0 # No initial tries at getting access token
+      params = params_sent.transform_keys_to_symbols
+      params[:token_url] ||= Soaspec::OAuth2.token_url
+      raise ArgumentError, 'client_id and client_secret not set' unless params[:client_id] && params[:client_secret]
+      raise ArgumentError, 'token_url mandatory' unless params[:token_url]
+
+      self.params = params
+      params[:username] = api_username || ERB.new(params[:username]).result(binding) if params[:username]
+      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]
+    end
+
+    # Retrieve whether to debug oauth parameters based on global settings
+    # @return [Boolean] Whether to see params sent to & received from oauth URL
+    def debug_oauth?
+      self.class.debug_oauth?
+    end
+
+    # Retrieve instance_url according to access token response.
+    # Some applications have a different instance
+    # It's assumed this will be constant for a set of oauth parameters
+    # @return [String] Instance url
+    def instance_url
+      Soaspec::OAuth2.instance_urls[params] ||= response['instance_url']
+    end
+
+    # @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']
+      else # Default is :always
+        response['access_token']
+      end
+    end
+
+    # @return [Hash] Hash containing access token parameters
+    def response
+      Soaspec::SpecLogger.info "using oauth_params: #{params}" if debug_oauth?
+      response = RestClient.post(params[:token_url], payload, cache_control: 'no_cache', verify_ssl: false)
+    rescue RestClient::Exception => error
+      Soaspec::SpecLogger.info(["oauth_error: #{error.message}", "oauth_response: #{error.response}"])
+      self.retry_count += 1
+      sleep 0.1 # Wait if a bit before retying obtaining access token
+      retry if retry_count < 3
+      raise error
+    else
+      Soaspec::SpecLogger.info(["response_headers: #{response.headers}", "response_body: #{response.body}"]) if debug_oauth?
+      JSON.parse(response)
+    end
+
+    # @return [String] String to represent OAuth for logging logs
+    def request_message
+      if debug_oauth?
+        "request_params: #{payload}"
+      else
+        params[:username] ? "User '#{params[:username]}'" : 'client_credentials'
+      end
+    end
+
+    # @return [String] Password to use in OAuth request
+    def password
+      params[:security_token] ? (params[:password] + params[:security_token]) : params[:password]
+    end
+
+    # Payload to add to o-auth request dependent on params provided
+    # @return [Hash] Payload for retrieving OAuth access token
+    def payload
+      payload = { client_id: params[:client_id], client_secret: params[:client_secret] }
+      payload.merge(if params[:password] && params[:username]
+                      {
+                        grant_type: 'password', username: params[:username],
+                        password: password, multipart: true
+                      }
+                    else
+                      { grant_type: 'client_credentials' }
+                    end)
+    end
+  end
+end