rspec_api_blueprint_matchers 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6dc5ebff2689d095904f17137d1554b9a3d05240
-  data.tar.gz: bb68a6dcf5100596475dc17b36eb5e0e88f5ebe5
+  metadata.gz: c8bd0abe26c064df373492e78343f325abbd43c9
+  data.tar.gz: 7403ee224404cac77bc7706b11ed82e48285cb6b
 SHA512:
-  metadata.gz: 6029d68ee28a95f469637a4385f2e5ff663d7452cf6e37e886117c9c0ea25208ebbcbe0dce3ebcfbc12bf08388c83d82b0f5d8b30a95bb078bd4268a85d571bb
-  data.tar.gz: f596a4f15ecede8ac78cacd95ddae170364620fba52484f743912b90b3348e1ba7e4774753e7b8af2085049b88a3da24ffc7427262017ec6f6b5fb68ecb6919a
+  metadata.gz: f82510ff4c0051f2a614ba4df5dfbb77b2a28c97cc63b2d4e3574618d50aca81872f5de728289db9e31fcf0e304e62dba3227b6ad4073064d5242cde174484ed
+  data.tar.gz: 36f71401e0e26aae242359d060753a34c12f3afb46d9ca2eea935c5ce953db655c17339abbc0f0c9b770e8159c7757c659cfc54db9bcfe2dca28a6179d2ee2d6

data/.rubocop.yml

@@ -21,6 +21,6 @@ AllCops:
     - "config/*"
     - "bin/*"
     - "config.ru"
-    - "spec"
+    - "spec/**/*"
     - "vendor/gems/**/spec/**"
   TargetRubyVersion: 2.4

data/config/rubocop/.metrics_rubocop.yml

@@ -48,7 +48,7 @@ Metrics/CyclomaticComplexity:
 # Checks the length of lines in the source code.
 
 Metrics/LineLength:
-  Max: 160
+  Max: 180
   AllowHereDoc: true
   AllowURI: true
   URISchemes:
@@ -80,7 +80,7 @@ Metrics/ModuleLength:
 # Checks for methods with too many parameters.
 
 Metrics/ParameterLists:
-  Max: 5
+  Max: 6
   CountKeywordArgs: true
 
 
@@ -91,4 +91,3 @@ Metrics/ParameterLists:
 
 Metrics/PerceivedComplexity:
   Max: 7
-

data/lib/rspec_apib.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 require "rspec_apib/version"
 require "rspec_apib/parser"
-require "rspec_apib/extractors"
 require "rspec_apib/transaction_validator"
 require "rspec_apib/rspec"
 require "rspec_apib/config"

data/lib/rspec_apib/elements/array.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 module RSpecApib
   module Element
+    # Represents an array in api-elements (http://api-elements.readthedocs.io/en/latest/)
     class Array < ::Array
+      # rubocop:disable Lint/UnusedMethodArgument
       def self.from_hash(hash, index:, parent:)
         new(hash["content"])
       end

data/lib/rspec_apib/elements/base.rb

@@ -19,10 +19,13 @@ module RSpecApib
         return node_or_nodes.map { |node| parse(node, index: index, parent: parent) } if node_or_nodes.is_a?(::Array)
         return transformed_basic_hash(node_or_nodes, index: index, parent: parent) if basic_hash?(node_or_nodes)
         return node_or_nodes unless !klass.nil? || base_element?(node_or_nodes)
-        hash = node_or_nodes
+        parse_node(node_or_nodes, index: index, parent: parent, klass: klass)
+      end
+
+      def self.parse_node(hash, index:, parent:, klass: nil)
         klass_name = klass
         klass_name ||= hash["element"].slice(0, 1).capitalize + hash["element"].slice(1..-1).delete(" ")
-        return node_or_nodes unless RSpecApib::Element.const_defined?(klass_name)
+        return hash unless RSpecApib::Element.const_defined?(klass_name)
         klass = RSpecApib::Element.const_get(klass_name)
         index[klass] ||= []
         element = klass.from_hash(hash, index: index, parent: parent)

data/lib/rspec_apib/elements/http_message_payload.rb

@@ -23,6 +23,12 @@ module RSpecApib
           }
           return [failure_reason]
         end
+        validate_json_schema(schema, request_or_response)
+      end
+
+      private
+
+      def validate_json_schema(schema, request_or_response)
         schema = JSON.parse schema.content
         errors = JSON::Validator.fully_validate(schema, request_or_response.body)
         return [] if errors.length.zero?
@@ -35,8 +41,6 @@ module RSpecApib
         [failure_reason]
       end
 
-      private
-
       def body_schema_asset
         content.find { |node| node.is_a?(Asset) && node.meta && node.meta["classes"] && node.meta["classes"].include?("messageBodySchema")}
       end

data/lib/rspec_apib/elements/http_response.rb

@@ -7,6 +7,7 @@ module RSpecApib
       # Indicates if the incoming request matches the method, path and path vars
       # @param [::RSpecApib::Request] The incoming request - normalized
       # @return [Boolean] true if matches else false
+      # rubocop:disable Lint/UnusedMethodArgument
       def matches?(response, options: {})
         matches_status?(response) &&
           matches_content_type?(response)

data/lib/rspec_apib/elements/resource.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 module RSpecApib
   module Element
-    # (byebug) parent.parent["attributes"]
-    # {"meta"=>[#<struct RSpecApib::Element::Member element="member", meta={"classes"=>["user"]}, attributes={}, content={"FORMAT"=>"1A"}, parent=#<struct RSpecApib::Element::ParseResult element="parseResult", meta=nil, attributes=nil, content=nil, parent=nil>>, #<struct RSpecApib::Element::Member element="member", meta={"classes"=>["user"]}, attributes={}, content={"HOST"=>"http://api.shiftcommerce.com/inventory/v1"}, parent=#<struct RSpecApib::Element::ParseResult element="parseResult", meta=nil, attributes=nil, content=nil, parent=nil>>]}
-
+    # Represents a resource in api-elements (http://api-elements.readthedocs.io/en/latest/)
     class Resource < Base
       def transitions
         content.select { |item| item.is_a?(Transition) }
@@ -13,8 +11,6 @@ module RSpecApib
         content.select { |item| item.is_a?(Category) }
       end
 
-      private
-
       def self.attributes_schema
         {
           href: "TemplatedHref"

data/lib/rspec_apib/elements/string.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 module RSpecApib
   module Element
+    # Represents a string in api-elements (http://api-elements.readthedocs.io/en/latest/)
     class String < ::String
+      # rubocop:disable Lint/UnusedMethodArgument
       def self.from_hash(hash, index:, parent:)
         new(hash["content"] || "")
       end

data/lib/rspec_apib/elements/templated_href.rb

@@ -2,8 +2,11 @@
 require "addressable"
 module RSpecApib
   module Element
+    # Represents a templated href in api-elements (http://api-elements.readthedocs.io/en/latest/)
     class TemplatedHref < Base
-      # Note this is not really a hash !!
+      # Note this is not really a hash but the interface named it
+      # that early on as everything was a hash !!
+      # rubocop:disable Lint/UnusedMethodArgument
       def self.from_hash(hash, index:, parent:)
         new("templatedHref", nil, nil, hash, parent)
       end
@@ -23,10 +26,10 @@ module RSpecApib
       end
 
       def path
-        a1 = Addressable::URI.parse(url)
-        a1.path, a1.query, a1.fragment = nil
-        a2 = Addressable::URI.parse(url)
-        a2.to_s.gsub(a1.to_s, "")
+        url_1 = Addressable::URI.parse(url)
+        url_1.path, url_1.query, url_1.fragment = nil
+        url_2 = Addressable::URI.parse(url)
+        url_2.to_s.gsub(url_1.to_s, "")
       end
 
       def self.host_from_parent(node)

data/lib/rspec_apib/elements/transition.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 module RSpecApib
   module Element
+    # Represents a transition in api-elements (http://api-elements.readthedocs.io/en/latest/)
     class Transition < Base
       def http_transactions
         content.select { |item| item.is_a?(HttpTransaction) }
@@ -11,8 +12,6 @@ module RSpecApib
         [:href, :hrefVariables]
       end
 
-      private
-
       def self.attributes_schema
         {
           href: "TemplatedHref"

data/lib/rspec_apib/parser.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require "rspec_apib/transcluder"
-require "rspec_apib/extractors"
 require "rspec_apib/elements"
 require "open3"
 require "json"
@@ -73,7 +72,7 @@ module RSpecApib
       Open3.popen3("#{bin_path} -f json") do |stdin, stdout, _stderr, wait_thr|
         send_document(file: file, buffer: stdin)
         op = stdout.read
-        exit_status = wait_thr.value
+        wait_thr.value
       end
       op
     end

data/lib/rspec_apib/response.rb

@@ -17,7 +17,7 @@ module RSpecApib
     end
 
     def validate_body_with_json_schema?
-      is_json?
+      json?
     end
 
     def content_type
@@ -32,7 +32,7 @@ module RSpecApib
 
     attr_accessor :raw_response
 
-    def is_json?
+    def json?
       content_type =~ /json/
     end
   end

data/lib/rspec_apib/rspec.rb

@@ -12,7 +12,8 @@ RSpec::Matchers.define :match_api_docs_for do |path:, request_method:, content_t
       error_messages << "Expected the transaction to match api docs for #{method}:#{path} but the provided parser was invalid"
       false
     else
-      ::RSpecApib::TransactionValidator.new(path: path, request_method: request_method, content_type: content_type, parser: parser).validate(request: ::RSpecApib.normalize_request(actual.request), response: ::RSpecApib.normalize_response(actual.response), error_messages: error_messages)
+      validator = ::RSpecApib::TransactionValidator.new(path: path, request_method: request_method, content_type: content_type, parser: parser)
+      validator.validate(request: ::RSpecApib.normalize_request(actual.request), response: ::RSpecApib.normalize_response(actual.response), error_messages: error_messages)
     end
 
   end

data/lib/rspec_apib/transaction_coverage_report.rb

@@ -12,7 +12,7 @@ module RSpecApib
         acc
       end
       transactions.each do |requested_tx|
-        matching_transactions = documented_transaction_tracker.keys.each do |dtx|
+        documented_transaction_tracker.keys.each do |dtx|
           documented_transaction_tracker[dtx] = true if dtx.matches?(requested_tx.request, requested_tx.response)
         end
       end
@@ -30,8 +30,29 @@ module RSpecApib
       results
     end
 
+    def report_uncovered(errors:)
+      uncovered_transactions.each do |tx|
+        errors << self.class.uncovered_tx_message(tx)
+      end
+    end
+
+    def report_undocumented(errors:)
+      undocumented.each do |tx|
+        errors << self.class.undocumented_tx_message(tx)
+      end
+    end
+
     private
 
     attr_accessor :transactions, :parser
+
+    def self.uncovered_tx_message(tx)
+      "#{tx.request.request_method.to_s.upcase} #{tx.request.url} with response (#{tx.response.content_type}) status #{tx.response.status}- Not covered"
+    end
+
+    def self.undocumented_tx_message(tx)
+      "#{tx.request.request_method.upcase} #{tx.request.url} with response (#{tx.response.content_type}) status #{tx.response.status} - Not documented"
+    end
+
   end
 end

data/lib/rspec_apib/transaction_coverage_validator.rb

@@ -9,18 +9,14 @@ module RSpecApib
     def validate(transactions:, error_messages:)
       errors = []
       reporter = TransactionCoverageReport.new(transactions: transactions, parser: parser)
-      uncovered = reporter.uncovered_transactions
-      unless uncovered.empty?
-        uncovered.each do |tx|
-          errors << self.class.uncovered_tx_message(tx)
-        end
-      end
-      undocumented = reporter.undocumented_transactions
-      unless undocumented.empty?
-        undocumented.each do |tx|
-          errors << self.class.undocumented_tx_message(tx)
-        end
-      end
+      reporter.report_uncovered(errors: errors)
+      reporter.report_undocumented(errors: errors)
+      report_summary(errors: errors, error_messages: error_messages)
+    end
+
+    private
+
+    def report_summary(errors:, error_messages:)
       if !errors.empty?
         error_messages.concat errors
         error_messages << "Coverage Summary: #{uncovered.length} uncovered and #{undocumented.length} undocumented transactions"
@@ -30,21 +26,10 @@ module RSpecApib
       end
     end
 
-    private
-
     attr_accessor :parser
 
     def matched_transaction(request:, response:)
       parser.http_transactions.find { |t| t.matches?(request, response, options: {validate_request_schema: :never, validate_response_schema: :never}) }
     end
-
-    def self.uncovered_tx_message(tx)
-      "#{tx.request.request_method.to_s.upcase} #{tx.request.url} with response (#{tx.response.content_type}) status #{tx.response.status}- Not covered"
-    end
-
-    def self.undocumented_tx_message(tx)
-      "#{tx.request.request_method.upcase} #{tx.request.url} with response (#{tx.response.content_type}) status #{tx.response.status} - Not documented"
-    end
-
   end
 end

data/lib/rspec_apib/transaction_validator.rb

@@ -12,25 +12,32 @@ module RSpecApib
     end
 
     def validate(request:, response:, error_messages:, options: {})
-      candidates = transaction_candidates(request: request, response: response, options: options)
-      results = candidates.map do |candidate|
-        candidate.validate_schema(request, response, validate_request_schema: validate_request_schema, validate_response_schema: validate_response_schema)
-      end
-
+      results = matched_transactions(request, response, options)
       if results.empty?
         error_messages << "No candidates for #{request.inspect} with response #{response.inspect}"
         return false
       end
 
       return true unless results.flatten.find {|r| !r[:request_errors].empty? || !r[:response_errors].empty?}
+      report_error_messages(results, error_messages)
+      false
+    end
+
+    private
+
+    def report_error_messages(results, error_messages)
       results.each do |result|
         error_messages << "The request validation failed - reasons #{result[:request_errors].join("\n")}" unless result[:request_errors].empty?
         error_messages << "The response validation failed - reasons #{result[:response_errors].join("\n")}" unless result[:response_errors].empty?
       end
-      false
     end
 
-    private
+    def matched_transactions(request, response, options)
+      candidates = transaction_candidates(request: request, response: response, options: options)
+      candidates.map do |candidate|
+        candidate.validate_schema(request, response, validate_request_schema: validate_request_schema, validate_response_schema: validate_response_schema)
+      end
+    end
 
     def transaction_candidates(request:, response:, options: {})
       transactions = parser.http_transactions.select do |t|

data/lib/rspec_apib/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module RSpecApib
-  VERSION = "0.1.4".freeze
+  VERSION = "0.1.5".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_blueprint_matchers
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Shift Commerce Ltd
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-08 00:00:00.000000000 Z
+date: 2017-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -163,9 +163,6 @@ files:
 - lib/rspec_apib/elements/string.rb
 - lib/rspec_apib/elements/templated_href.rb
 - lib/rspec_apib/elements/transition.rb
-- lib/rspec_apib/extractors.rb
-- lib/rspec_apib/extractors/http_transaction.rb
-- lib/rspec_apib/extractors/resource.rb
 - lib/rspec_apib/parser.rb
 - lib/rspec_apib/request.rb
 - lib/rspec_apib/response.rb

data/lib/rspec_apib/extractors.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-require "rspec_apib/extractors/resource"
-require "rspec_apib/extractors/http_transaction"

data/lib/rspec_apib/extractors/http_transaction.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-module RSpecApib
-  module Extractor
-    class HttpTransaction
-      def self.call(document)
-        collector = []
-        find_nodes_within(document, collector: collector)
-        collector
-      end
-
-      private
-
-      def self.find_nodes_within(node, collector:)
-        return node.each { |node| find_nodes_within(node, collector: collector)} if node.is_a?(Array)
-        return unless node.is_a?(Hash)
-        if node["element"] == "httpTransaction"
-          collector << node
-        elsif node.key?("content")
-          find_nodes_within(node["content"], collector: collector)
-        end
-      end
-    end
-  end
-end

data/lib/rspec_apib/extractors/resource.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-module RSpecApib
-  module Extractor
-    class Resource
-      def self.call(document)
-        collector = []
-        find_nodes_within(document, collector: collector)
-        collector
-      end
-
-      private
-
-      def self.find_nodes_within(node, collector:)
-        return node.each { |node| find_nodes_within(node, collector: collector)} if node.is_a?(Array)
-        return unless node.is_a?(Hash)
-        if node["element"] == "resource"
-          collector << node
-        elsif node.key?("content")
-          find_nodes_within(node["content"], collector: collector)
-        end
-      end
-    end
-  end
-end