soaspec 0.2.25 → 0.2.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e05f737b159b34765390c9e79d2fa63c3f38224
-  data.tar.gz: b0b6698390955dd891e546e8d23a73b06aa5a494
+  metadata.gz: 4bd3c881794d21629f39071352bc0e9c49eba252
+  data.tar.gz: 919b6649e0b29f590f388bb78af1b9f34d6d8613
 SHA512:
-  metadata.gz: 565dd25349cb90c5c15064a0040f3ce503c74e1f522f42c0329dc8cd02ba1ae5c7a64321711438ad6c09418428606a6c8ef76fad8c5a114f3a88625f0eaed198
-  data.tar.gz: 41c2cc405ee6a1fc8e86929cd00a91b30ce2f9abcd71caa4fc3b024ce3d157c43d99e2b58ba701a96e572f71d520a3b49c2df78341d9dbe16d9ffa609851ccec
+  metadata.gz: 0c95b0a30c4efbc31b369cb3735d4676ff7c5cabe1577f065b66dc9b427010d2c4b5c4b2370e7db2f67574bb907feb6d03109275c33b5a9ade6158f7ec51c2a3
+  data.tar.gz: ef8f3c18d7e64ecc1953c73463373ca26ce22f2b8fcf7ca70a4f3d51f08606cd5cfb82f235dd578d7d30e5971f5e3c1816d0bed96654bc089408a70c3c581e9b

data/.gitignore

@@ -9,7 +9,7 @@
 /tmp/
 /.idea/
 Gemfile.lock
-coverage
+/vendor/
 
 # rspec failure tracking
 .rspec_status

data/.gitlab-ci.yml

@@ -4,29 +4,40 @@ before_script:
   - ruby -v
   - which ruby
   - gem install bundler rake
-  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+  - bundle install --jobs $(nproc) --path vendor # Install dependencies into ./vendor/ruby
+
+cache:
+  key: ${CI_COMMIT_REF_SLUG}
+  paths:
+    - vendor/ruby
 
 ruby_2.3:
   stage: test
   image: ruby:2.3
   script:
-    - bundle exec rake spec
+    - bundle exec rake
 
 ruby_2.4:
   stage: test
   image: ruby:2.4
   script:
-    - bundle exec rake spec
+    - bundle exec rake
 
 ruby_2.5:
   stage: test
   image: ruby:2.5
   script:
-    - bundle exec rake spec
+    - bundle exec rake
   artifacts:
     paths:
       - coverage/
 
+ruby_2.6:
+  stage: test
+  image: ruby:2.6
+  script:
+    - bundle exec rake
+
 cucumber:
   stage: test
   script:

data/ChangeLog

@@ -1,3 +1,8 @@
+Version 0.2.26
+* Enhancement
+  * Method `successful_status_code?` to return whether status code is 200..299
+  * Ability to turn off OAuth request message
+
 Version 0.2.25
 * Enhancement
   * Started running yard-doctest to check yard examples are correct

data/Dockerfile

@@ -0,0 +1,5 @@
+FROM ruby:2.6
+MAINTAINER Samuel Garratt
+LABEL url="https://gitlab.com/samuel-garratt/soaspec/blob/master/Dockerfile"
+# Simple Dockerfile with gems preinstalled
+RUN gem install bundler rake soaspec

data/Todo.md

@@ -1,3 +1,4 @@
+* Exception in setting a value results in 'headers' being called on Nil Class
 * `yard` should show everything documented
 * Rubocop should have 0 offenses
 * Unit tests

data/lib/soaspec/exchange/exchange_extractor.rb

@@ -14,6 +14,11 @@ module Soaspec
       exchange_handler.status_code_for(response)
     end
 
+    # @return [Boolean] Whether Api success code is successful
+    def successful_status_code?
+      (200..299).cover? status_code
+    end
+
     # Extract value from path api class
     # @example Extract unique value
     #   @exchange['unique_value_name']

data/lib/soaspec/exchange/exchange_repeater.rb

@@ -7,7 +7,7 @@ module Soaspec
     # @option opts [Numeric] :interval (0.2) Seconds to sleep between polls.
     # @option opts [String] :message Exception message if timed out.
     # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Error::NoSuchElementError)
-    # @return [Self] Returns itself so operations can be done on the exchange after it's done waiting
+    # @return [Exchange] Returns itself so operations can be done on the exchange after it's done waiting
     def until(opts = {}, &script)
       Soaspec::Wait.until(opts) do
         @response = nil # Reset response so it can be made repeatedly

data/lib/soaspec/exchange_handlers/response_extractor.rb

@@ -28,7 +28,7 @@ module Soaspec
       when :json
         IndifferentHash.new(JSON.parse(response.body.to_s))
       else
-        raise "Unable to interpret type of #{response.body}"
+        raise "Unable to interpret type of '#{response.body}'. Could be because of: #{Interpreter.diagnose_error}"
       end
     end
 

data/lib/soaspec/interpreter.rb

@@ -1,9 +1,17 @@
 # Help interpret the general type of a particular object
 class Interpreter
   class << self
+    # @return [Error] XML Errors found in interpreting response
+    attr_accessor :xml_errors
+
+    # @return [Error] JSON Errors found in interpreting response
+    attr_accessor :json_errors
+
     # @param [Object] response API response
     # @return [Symbol] Type of provided response
     def response_type_for(response)
+      @xml_errors = nil
+      @json_errors = nil
       @response = response
       if @response.is_a? String
         if xml?
@@ -22,17 +30,38 @@ class Interpreter
       end
     end
 
+    # @return [Boolean] Whether response has tag like syntax similar to XML. Could be a syntax error occurred
+    def looks_like_xml?
+      @response[0] == '<' && @response[-1] == '>'
+    end
+
+    # @return [Boolean] Whether response has bracket like syntax similar to JSON. Could be a syntax error occurred
+    def looks_like_json?
+      @response[0] == '{' && @response[-1] == '}'
+    end
+
+    # @return [String] Description of error
+    def diagnose_error
+      return xml_errors if looks_like_xml?
+
+      return json_errors if looks_like_json?
+
+      ''
+    end
+
     # @return [Boolean] Whether valid XML
     def xml?
       Nokogiri::XML(@response) { |config| config.options = Nokogiri::XML::ParseOptions::STRICT }
-    rescue Nokogiri::XML::SyntaxError
+    rescue Nokogiri::XML::SyntaxError => xml_error
+      self.xml_errors = xml_error
       false
     end
 
     # @return [Boolean] Whether valid JSON
     def json?
       JSON.parse(@response)
-    rescue JSON::ParserError
+    rescue JSON::ParserError=> json_error
+      self.json_errors = json_error
       false
     end
   end

data/lib/soaspec/matchers.rb

@@ -81,7 +81,7 @@ RSpec::Matchers.define :be_successful do
   # @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)
+    failure_list << "#{exchange.status_code} not valid status code" unless exchange.successful_status_code?
     exchange.exchange_handler.expected_mandatory_elements.each do |mandatory_element_path|
       begin
         exchange[mandatory_element_path]

data/lib/soaspec/o_auth2.rb

@@ -9,6 +9,8 @@ module Soaspec
     @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
     class << self
       # Default token url used across entire suite
       attr_accessor :token_url
@@ -23,11 +25,18 @@ module Soaspec
       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 [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
@@ -73,7 +82,7 @@ module Soaspec
 
     # @return [String] Existing or new access token, dependent on refresh_token attribute
     def access_token
-      Soaspec::SpecLogger.info request_message
+      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']

data/lib/soaspec/soaspec_shared_examples.rb

@@ -2,7 +2,7 @@ require 'rspec'
 
 RSpec.shared_examples_for 'success scenario' do
   it 'has successful status code' do
-    expect(200..299).to cover described_class.status_code
+    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|

data/lib/soaspec/version.rb

@@ -1,4 +1,4 @@
 module Soaspec
   # @return [String] Version of the gem
-  VERSION = '0.2.25'.freeze
+  VERSION = '0.2.26'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.2.25
+  version: 0.2.26
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2019-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -461,6 +461,7 @@ files:
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - ChangeLog
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md