soaspec 0.2.33 → 0.3.1

data/lib/soaspec/o_auth2.rb

@@ -1,142 +1,142 @@
-# frozen_string_literal: true
-
-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 = {}
-    # Whether to see params sent to & received from oauth URL
-    @request_message = true
-    # How many times to attempt to authenticate before raising exception
-    @retry_limit = 2
-    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 include request message describing OAuth (either full or simplified)
-      attr_writer :request_message
-      # @return [Integer] How many times to attempt to authenticate before raising exception
-      attr_accessor :retry_limit
-      # @return [Boolean] Whether to see params sent to & received from oauth URL
-      def debug_oauth?
-        @debug_oauth || false
-      end
-
-      # @return [Boolean] Whether to include request message describing OAuth (either full or simplified)
-      def request_message?
-        @request_message
-      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 if self.class.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 => e
-      Soaspec::SpecLogger.info(["oauth_error: #{e.message}", "oauth_response: #{e.response}"])
-      self.retry_count += 1
-      sleep 0.1 # Wait if a bit before retying obtaining access token
-      retry if retry_count < self.class.retry_limit
-      raise e
-    else
-      Soaspec::SpecLogger.info(["response: \n  headers: #{response&.headers}\n  body: #{response}\n"]) 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
+# frozen_string_literal: true
+
+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 = {}
+    # Whether to see params sent to & received from oauth URL
+    @request_message = true
+    # How many times to attempt to authenticate before raising exception
+    @retry_limit = 2
+    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 include request message describing OAuth (either full or simplified)
+      attr_writer :request_message
+      # @return [Integer] How many times to attempt to authenticate before raising exception
+      attr_accessor :retry_limit
+      # @return [Boolean] Whether to see params sent to & received from oauth URL
+      def debug_oauth?
+        @debug_oauth || false
+      end
+
+      # @return [Boolean] Whether to include request message describing OAuth (either full or simplified)
+      def request_message?
+        @request_message
+      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 if self.class.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 => e
+      Soaspec::SpecLogger.info(["oauth_error: #{e.message}", "oauth_response: #{e.response}"])
+      self.retry_count += 1
+      sleep 0.1 # Wait if a bit before retying obtaining access token
+      retry if retry_count < self.class.retry_limit
+      raise e
+    else
+      Soaspec::SpecLogger.info(["response: \n  headers: #{response&.headers}\n  body: #{response}\n"]) 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

data/lib/soaspec/soaspec_shared_examples.rb

@@ -1,26 +1,26 @@
-# frozen_string_literal: true
-
-require 'rspec'
-
-RSpec.shared_examples_for 'success scenario' do
-  it 'has successful status code' do
-    expect(described_class.successful_status_code?).to be true
-  end
-  context 'has expected mandatory elements' do
-    described_class.exchange_handler.expected_mandatory_elements.each do |mandatory_element|
-      it mandatory_element do
-        expect(described_class).to contain_key mandatory_element
-      end
-    end
-  end
-  described_class.exchange_handler.expected_mandatory_xpath_values.each do |xpath, value|
-    it "has xpath '#{xpath}' equal to '#{value}'" do
-      expect(described_class).to have_xpath_value(xpath => value)
-    end
-  end
-  described_class.exchange_handler.expected_mandatory_json_values.each do |xpath, value|
-    it "has json '#{xpath}' equal to '#{value}'" do
-      expect(described_class).to have_xpath_value(xpath => value)
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'rspec'
+
+RSpec.shared_examples_for 'success scenario' do
+  it 'has successful status code' do
+    expect(described_class.successful_status_code?).to be true
+  end
+  context 'has expected mandatory elements' do
+    described_class.exchange_handler.expected_mandatory_elements.each do |mandatory_element|
+      it mandatory_element do
+        expect(described_class).to contain_key mandatory_element
+      end
+    end
+  end
+  described_class.exchange_handler.expected_mandatory_xpath_values.each do |xpath, value|
+    it "has xpath '#{xpath}' equal to '#{value}'" do
+      expect(described_class).to have_xpath_value(xpath => value)
+    end
+  end
+  described_class.exchange_handler.expected_mandatory_json_values.each do |xpath, value|
+    it "has json '#{xpath}' equal to '#{value}'" do
+      expect(described_class).to have_xpath_value(xpath => value)
+    end
+  end
+end

data/lib/soaspec/spec_logger.rb

@@ -1,143 +1,143 @@
-# frozen_string_literal: true
-
-require 'logger'
-require 'fileutils'
-require 'colorize'
-
-module Soaspec
-  # Custom class for logging API traffic
-  class ApiLogger < Logger
-    #
-    # Rewrite << to use info logger with formatting
-    #
-    def <<(msg)
-      info msg
-    end
-  end
-
-  # Handles logs of API requests and responses
-  class SpecLogger
-    # Folder to put API traffic logs
-    @traffic_folder = 'logs'
-    # Whether to output api traffic to terminal
-    @output_to_terminal = false
-    # Color shown when displaying in terminal
-    @terminal_color = :light_blue
-    # 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')
-    # By default file is based on time
-    @traffic_file = nil
-    # Name of program to include in logs
-    @progname
-    class << self
-      # Folder to put API traffic logs
-      attr_accessor :traffic_folder
-      # Color shown when displaying in terminal
-      attr_accessor :terminal_color
-      # Readers for log parameters
-      attr_reader :output_to_terminal, :output_to_file, :time_test_run
-      # @return [String] Name of program to include in logs
-      attr_accessor :progname
-      # @return [String] String representing date format to use for traffic
-      attr_writer :time_format
-      # Logger used to log API requests
-      attr_accessor :logger
-
-      # String representing date format to use for traffic
-      def time_format
-        @time_format || '%H:%M:%S'
-      end
-
-      # Set file to log traffic to
-      # @param [String] file Path to traffic file to use
-      def traffic_file=(file)
-        @traffic_file = file
-        reset_log
-      end
-
-      # @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
-
-      # Unset Logger object. It will be recreated on next time 'info' is called
-      def reset_log
-        @logger = nil
-        RestClient.log = nil
-      end
-
-      # Whether to log all API traffic
-      def log_api_traffic=(set)
-        @log_api_traffic = set
-        reset_log
-      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
-        reset_log
-      end
-
-      # @param [Symbol, Boolean] value # Whether to output API traffic to STDOUT
-      def output_to_terminal=(value)
-        @output_to_terminal = value
-        reset_log
-      end
-
-      # Create new log file if necessary and setup logging level
-      # @return [Logger] Logger class to record API traffic
-      def create
-        create_log_file
-        @logger = ApiLogger.new(traffic_file) # Where request and responses of APIs are stored
-        @logger.progname = progname || 'SpecLog'
-        @logger.formatter = proc do |_severity, datetime, progname, msg|
-          message = "#{progname}, [#{datetime.strftime(time_format)}] : #{msg}\n"
-          print message.colorize(terminal_color) if @output_to_terminal
-          message if @output_to_file
-        end
-        RestClient.log = @logger
-        @logger
-      end
-
-      # Log a message using Soaspec logger
-      # Logger (and it's file) will be created if it's not already set
-      # @param [String, Array] message The message to add to the logger or list of messages
-      def info(message)
-        return unless log_api_traffic?
-
-        create unless @logger
-        if message.respond_to? :each
-          message.each do |message_item|
-            info(message_item)
-          end
-        else
-          if block_given?
-            @logger.info(message) { yield }
-          else
-            @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
+# frozen_string_literal: true
+
+require 'logger'
+require 'fileutils'
+require 'colorize'
+
+module Soaspec
+  # Custom class for logging API traffic
+  class ApiLogger < Logger
+    #
+    # Rewrite << to use info logger with formatting
+    #
+    def <<(msg)
+      info msg
+    end
+  end
+
+  # Handles logs of API requests and responses
+  class SpecLogger
+    # Folder to put API traffic logs
+    @traffic_folder = 'logs'
+    # Whether to output api traffic to terminal
+    @output_to_terminal = false
+    # Color shown when displaying in terminal
+    @terminal_color = :light_blue
+    # 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')
+    # By default file is based on time
+    @traffic_file = nil
+    # Name of program to include in logs
+    @progname
+    class << self
+      # Folder to put API traffic logs
+      attr_accessor :traffic_folder
+      # Color shown when displaying in terminal
+      attr_accessor :terminal_color
+      # Readers for log parameters
+      attr_reader :output_to_terminal, :output_to_file, :time_test_run
+      # @return [String] Name of program to include in logs
+      attr_accessor :progname
+      # @return [String] String representing date format to use for traffic
+      attr_writer :time_format
+      # Logger used to log API requests
+      attr_accessor :logger
+
+      # String representing date format to use for traffic
+      def time_format
+        @time_format || '%H:%M:%S'
+      end
+
+      # Set file to log traffic to
+      # @param [String] file Path to traffic file to use
+      def traffic_file=(file)
+        @traffic_file = file
+        reset_log
+      end
+
+      # @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
+
+      # Unset Logger object. It will be recreated on next time 'info' is called
+      def reset_log
+        @logger = nil
+        RestClient.log = nil
+      end
+
+      # Whether to log all API traffic
+      def log_api_traffic=(set)
+        @log_api_traffic = set
+        reset_log
+      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
+        reset_log
+      end
+
+      # @param [Symbol, Boolean] value # Whether to output API traffic to STDOUT
+      def output_to_terminal=(value)
+        @output_to_terminal = value
+        reset_log
+      end
+
+      # Create new log file if necessary and setup logging level
+      # @return [Logger] Logger class to record API traffic
+      def create
+        create_log_file
+        @logger = ApiLogger.new(traffic_file) # Where request and responses of APIs are stored
+        @logger.progname = progname || 'SpecLog'
+        @logger.formatter = proc do |_severity, datetime, progname, msg|
+          message = "#{progname}, [#{datetime.strftime(time_format)}] : #{msg}\n"
+          print message.colorize(terminal_color) if @output_to_terminal
+          message if @output_to_file
+        end
+        RestClient.log = @logger
+        @logger
+      end
+
+      # Log a message using Soaspec logger
+      # Logger (and it's file) will be created if it's not already set
+      # @param [String, Array] message The message to add to the logger or list of messages
+      def info(message)
+        return unless log_api_traffic?
+
+        create unless @logger
+        if message.respond_to? :each
+          message.each do |message_item|
+            info(message_item)
+          end
+        else
+          if block_given?
+            @logger.info(message) { yield }
+          else
+            @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