soaspec 0.1.6 → 0.1.7

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

@@ -1,20 +1,20 @@
-
-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
-
-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']
-  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
+
+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']
+  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/interpreter.rb

@@ -1,41 +1,41 @@
-
-# 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
-          :unknown
-        end
-      elsif response.is_a? Hash
-        :hash
-      elsif response.is_a? Nokogiri::XML::NodeSet
-        :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
+
+# 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
+          :unknown
+        end
+      elsif response.is_a? Hash
+        :hash
+      elsif response.is_a? Nokogiri::XML::NodeSet
+        :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,66 +1,66 @@
-
-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 |exchange|
-    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 |actual|
-    "expected that #{actual.exchange_handler.response_body(actual.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 |exchange|
-    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.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
-
+
+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 |exchange|
+    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 |actual|
+    "expected that #{actual.exchange_handler.response_body(actual.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 |exchange|
+    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.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

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

@@ -0,0 +1,65 @@
+require 'erb'
+
+module Soaspec
+  # Handles working with OAuth2
+  class OAuth2
+    attr_accessor :params
+    # Count of tries to obtain access token
+    attr_accessor :retry_count
+
+    # @param [Hash] params Parameters to make OAuth request
+    # @param [String] api_username Username to use which can be set by Soaspec::ExchangeHandler
+    def initialize(params, api_username)
+      raise 'client_id and client_secret not set' unless params[:client_id] && params[:client_secret]
+      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]
+      Soaspec::SpecLogger.info request_message
+    end
+
+    # @return [Hash] Hash containing access token parameters
+    def response
+      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 Soaspec.debug_oauth?
+      JSON.parse(response)
+    end
+
+    # @return [String] String to represent OAuth for logging logs
+    def request_message
+      if Soaspec.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,24 +1,24 @@
-require 'rspec'
-
-shared_examples_for 'success scenario' do
-  it 'has successful status code' do
-    expect(200..299).to cover described_class.status_code
-  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 xpath '#{xpath}' equal to '#{value}'" do
-      expect(described_class).to have_xpath_value(xpath => value)
-    end
-  end
-end
+require 'rspec'
+
+shared_examples_for 'success scenario' do
+  it 'has successful status code' do
+    expect(200..299).to cover described_class.status_code
+  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 xpath '#{xpath}' equal to '#{value}'" do
+      expect(described_class).to have_xpath_value(xpath => value)
+    end
+  end
+end

data/lib/soaspec/spec_logger.rb

@@ -1,28 +1,35 @@
-
-require 'logger'
-require 'fileutils'
-
-module Soaspec
-
-  # Handles logs of API requests and responses
-  class SpecLogger
-    class << self
-      def create
-        unless File.exist?('logs/traffic.log')
-          FileUtils.mkdir_p 'logs'
-          FileUtils.touch File.join('logs', 'traffic.log')
-        end
-        @logger = Logger.new('logs/traffic.log') # Where request and responses of APIs are stored
-        @logger.level = Logger::DEBUG
-        @logger
-      end
-
-      # Log a message using Soaspec logger
-      # @param [String] message The message to add to the logger
-      def info(message)
-        @logger.info(message) if Soaspec.log_api_traffic?
-      end
-    end
-
-  end
+
+require 'logger'
+require 'fileutils'
+
+module Soaspec
+
+  # Handles logs of API requests and responses
+  class SpecLogger
+    class << self
+      def create
+        unless File.exist?('logs/traffic.log')
+          FileUtils.mkdir_p 'logs'
+          FileUtils.touch File.join('logs', 'traffic.log')
+        end
+        @logger = Logger.new('logs/traffic.log') # Where request and responses of APIs are stored
+        @logger.level = Logger::DEBUG
+        @logger
+      end
+
+      # Log a message using Soaspec logger
+      # @param [String] message The message to add to the logger
+      def info(message)
+        return unless Soaspec.log_api_traffic?
+        if message.respond_to? :each
+          message.each do |message_item|
+            @logger.info(message_item)
+          end
+        else
+          @logger.info(message)
+        end
+      end
+    end
+
+  end
 end