rspec_api_blueprint_matchers 0.1.2

data/lib/rspec_apib/elements/data_structure.rb

@@ -0,0 +1,7 @@
+module RSpecApib
+  module Element
+    class DataStructure < Base
+
+    end
+  end
+end

data/lib/rspec_apib/elements/href_variables.rb

@@ -0,0 +1,13 @@
+require "addressable"
+module RSpecApib
+  module Element
+    class HrefVariables < Base
+      def [](key)
+        member = content.find {|h| h.is_a?(Member) && h.content.key?(key) }
+        return nil if member.nil?
+        member.content[key]
+      end
+
+    end
+  end
+end

data/lib/rspec_apib/elements/http_headers.rb

@@ -0,0 +1,27 @@
+module RSpecApib
+  module Element
+    class HttpHeaders < Base
+      def [](key)
+        member = content.find {|h| h.is_a?(Member) && h.content.key?(key) }
+        return nil if member.nil?
+        member.content[key]
+      end
+
+      def each_pair
+        content.select {|h| h.is_a?(Member)}.each do |header|
+          yield header.key, header.value
+        end
+      end
+
+      def keep_if
+        results = dup
+        results.content = []
+        content.select {|h| h.is_a?(Member)}.each do |header|
+          results.content << header if yield header.key, header.value
+        end
+        results
+      end
+
+    end
+  end
+end

data/lib/rspec_apib/elements/http_message_payload.rb

@@ -0,0 +1,45 @@
+require "json-schema"
+require "rspec_apib/elements/http_message_payload"
+module RSpecApib
+  module Element
+    class HttpMessagePayload < Base
+
+      # The content type if defined else nil
+      # @return [String | NilClass] The content type header or nil
+      def content_type
+        attributes["headers"] && attributes["headers"]["Content-Type"]
+      end
+
+      def validate_schema(request_or_response, allow_no_schema: false)
+        return [] unless request_or_response.validate_body_with_json_schema?
+        schema = body_schema_asset
+        return [] if schema.nil? && allow_no_schema
+        if schema.nil?
+          failure_reason = {
+            success: false,
+            reason: "Missing a body schema",
+            details: []
+          }
+          return [failure_reason]
+        end
+        schema = JSON.parse schema.content
+        errors = JSON::Validator.fully_validate(schema, request_or_response.body)
+        return [] if errors.length.zero?
+
+        failure_reason = {
+          success: false,
+          reason: "Schema validation failure",
+          details: errors
+        }
+        return [failure_reason]
+      end
+
+      private
+
+      def body_schema_asset
+        content.find { |n| n.is_a?(Asset) && n.meta && n.meta["classes"] && n.meta["classes"].include?("messageBodySchema")}
+      end
+
+    end
+  end
+end

data/lib/rspec_apib/elements/http_request.rb

@@ -0,0 +1,59 @@
+require "json-schema"
+require "rspec_apib/elements/http_message_payload"
+module RSpecApib
+  module Element
+    class HttpRequest < HttpMessagePayload
+
+      # 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
+      def matches?(request, options: {})
+        matches_method?(request) &&
+        matches_path?(request) &&
+        matches_headers?(request, options)
+      end
+
+      # Inherit href and hrefVariables from any ancestor
+      def self.attrs_to_inherit
+        [:href, :hrefVariables, :method]
+      end
+
+      def request_method
+        attributes && attributes["method"] && attributes["method"].downcase.to_sym
+      end
+
+      def path
+        attributes && attributes["href"] && attributes["href"].path
+      end
+
+      def url
+        attributes && attributes["href"].to_s
+      end
+
+      private
+
+      def matches_headers?(request_or_response, options)
+        headers = attributes && attributes["headers"] && attributes["headers"].keep_if {|k, v| k == "Content-Type" || k == "Accept"}
+        return true if headers.nil?
+        headers.each_pair do |header_key, header_value|
+          return false unless request_or_response.headers.key?(header_key) &&
+                              request_or_response.headers[header_key] == header_value
+        end
+      end
+
+      def matches_method?(request)
+        attributes && attributes["method"] && attributes["method"].downcase.to_sym == request.request_method
+      end
+
+      def matches_path?(request)
+        attributes && attributes["href"] && attributes["href"].matches_path?(request)
+      end
+
+      def self.attributes_schema
+        {
+          href: "TemplatedHref"
+        }
+      end
+    end
+  end
+end

data/lib/rspec_apib/elements/http_response.rb

@@ -0,0 +1,35 @@
+require "rspec_apib/elements/http_message_payload"
+module RSpecApib
+  module Element
+    class HttpResponse < HttpMessagePayload
+      # 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
+      def matches?(response, options: {})
+        matches_status?(response) &&
+        matches_content_type?(response)
+      end
+
+      def status
+        attributes["statusCode"]
+      end
+
+      private
+
+      def matches_status?(response)
+        response.status == attributes["statusCode"]
+      end
+
+      def matches_content_type?(response)
+        expected_content_type = content_type
+        expected_content_type.nil? || (expected_content_type == response.content_type)
+      end
+
+      def self.attributes_schema
+        {
+          href: "TemplatedHref"
+        }
+      end
+    end
+  end
+end

data/lib/rspec_apib/elements/http_transaction.rb

@@ -0,0 +1,58 @@
+module RSpecApib
+  module Element
+    class HttpTransaction < Base
+
+      def matches?(request_in, response_in, options: {})
+        request.matches?(request_in, options: options) && response.matches?(response_in, options: options)
+      end
+
+      def potential_match?(path:, request_method:, content_type:)
+        potential_match_content_type?(content_type) &&
+        (request_method == :any || request_method == request.request_method) &&
+        (path == :any || request.path == path)
+      end
+
+      def validate_schema(request_in, response_in, validate_request_schema: :always, validate_response_schema: :always)
+        request_errors = validate_request_schema(request_in, validate_request_schema)
+        response_errors = validate_response_schema(response_in, validate_response_schema)
+        { request_errors: request_errors, response_errors: response_errors }
+      end
+
+      def request
+        @request ||= content.find {|r| r.is_a?(HttpRequest)}
+      end
+
+      def response
+        @response ||= content.find {|r| r.is_a?(HttpResponse)}
+      end
+
+      private
+
+      def potential_match_content_type?(content_type)
+        content_type == :any || content_type == (response.content_type || request.content_type)
+      end
+
+      def validate_request_schema(request_in, validate_request_schema)
+        return [] if validate_request_schema == :never
+        request.validate_schema(request_in, allow_no_schema: (validate_request_schema == :when_defined))
+      end
+
+      def validate_response_schema(response_in, validate_response_schema)
+        return [] if validate_response_schema == :never
+        response.validate_schema(response_in, allow_no_schema: (validate_response_schema == :when_defined))
+      end
+
+      # Inherit href and hrefVariables from any ancestor
+      def self.attrs_to_inherit
+        [:href, :hrefVariables]
+      end
+
+      def self.attributes_schema
+        {
+          href: "TemplatedHref"
+        }
+      end
+
+    end
+  end
+end

data/lib/rspec_apib/elements/member.rb

@@ -0,0 +1,21 @@
+module RSpecApib
+  module Element
+    class Member < Base
+
+      def self.from_hash(hash, index:, parent:)
+        child = super
+        content = child.content
+        child.content = {content["key"] => content["value"]}
+        child
+      end
+
+      def key
+        content.keys.first
+      end
+
+      def value
+        content.values.first
+      end
+    end
+  end
+end

data/lib/rspec_apib/elements/object.rb

@@ -0,0 +1,7 @@
+module RSpecApib
+  module Element
+    class Object < Base
+
+    end
+  end
+end

data/lib/rspec_apib/elements/parse_result.rb

@@ -0,0 +1,7 @@
+module RSpecApib
+  module Element
+    class ParseResult < Base
+      
+    end
+  end
+end

data/lib/rspec_apib/elements/resource.rb

@@ -0,0 +1,24 @@
+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>>]}
+
+    class Resource < Base
+      def transitions
+        content.select { |item| item.is_a?(Transition) }
+      end
+
+      def categories
+        content.select { |item| item.is_a?(Category) }
+      end
+
+      private
+
+      def self.attributes_schema
+        {
+          href: "TemplatedHref"
+        }
+      end
+    end
+  end
+end

data/lib/rspec_apib/elements/source_map.rb

@@ -0,0 +1,7 @@
+module RSpecApib
+  module Element
+    class SourceMap < Base
+
+    end
+  end
+end

data/lib/rspec_apib/elements/string.rb

@@ -0,0 +1,9 @@
+module RSpecApib
+  module Element
+    class String < ::String
+      def self.from_hash(hash, index:, parent:)
+        new(hash["content"] || "")
+      end
+    end
+  end
+end

data/lib/rspec_apib/elements/templated_href.rb

@@ -0,0 +1,43 @@
+require "addressable"
+module RSpecApib
+  module Element
+    class TemplatedHref < Base
+      # Note this is not really a hash !!
+      def self.from_hash(hash, index:, parent:)
+        new("templatedHref", nil, nil, hash, parent)
+      end
+
+      def to_s
+        content
+      end
+
+      def matches_path?(request)
+        tpl = Addressable::Template.new(url)
+        result = tpl.extract(request.url)
+        !result.nil?
+      end
+
+      def url
+        @url ||= File.join(self.class.host_from_parent(parent), content)
+      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, "")
+      end
+
+      def self.host_from_parent(node)
+        return "" if node.nil?
+        attrs = node.attributes
+        return host_from_parent(node.parent) unless attrs && attrs["meta"]
+        host_member = attrs["meta"].find do |member|
+          member.is_a?(Member) && member.content.key?("HOST")
+        end
+        return host_from_parent(node.parent) unless host_member
+        host_member.content["HOST"]
+      end
+    end
+  end
+end

data/lib/rspec_apib/elements/transition.rb

@@ -0,0 +1,22 @@
+module RSpecApib
+  module Element
+    class Transition < Base
+      def http_transactions
+        content.select { |item| item.is_a?(HttpTransaction) }
+      end
+
+      # Inherit href and hrefVariables from any ancestor (normally resource)
+      def self.attrs_to_inherit
+        [:href, :hrefVariables]
+      end
+
+      private
+
+      def self.attributes_schema
+        {
+          href: "TemplatedHref"
+        }
+      end
+    end
+  end
+end

data/lib/rspec_apib/extractors.rb

@@ -0,0 +1,2 @@
+require "rspec_apib/extractors/resource"
+require "rspec_apib/extractors/http_transaction"

data/lib/rspec_apib/extractors/http_transaction.rb

@@ -0,0 +1,23 @@
+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

@@ -0,0 +1,23 @@
+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