rspec_api_blueprint_matchers 0.1.2 → 0.1.3

data/docker-compose.yml

@@ -0,0 +1,17 @@
+version: '2'
+
+services:
+  test:
+    image: rspec_api_blueprint_matchers
+    build:
+      context: .
+      dockerfile: Dockerfile
+    command: bash -c "bundle install && bundle exec rspec"
+    volumes:
+      - .:/app
+      - rubygems_cache:/rubygems
+    environment:
+      GEM_HOME: '/rubygems'
+      BUNDLE_PATH: '/rubygems'
+volumes:
+  rubygems_cache:

data/lib/rspec_api_blueprint_matchers.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 require "rspec_apib"

data/lib/rspec_apib/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RSpecApib
   class Config
     attr_accessor :default_blueprint_file

data/lib/rspec_apib/elements/annotation.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
     class Annotation < Base

data/lib/rspec_apib/elements/array.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
     class Array < ::Array

data/lib/rspec_apib/elements/asset.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
     class Asset < Base

data/lib/rspec_apib/elements/base.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
-    class Base < Struct.new(:element, :meta, :attributes, :content, :parent)
+    BaseStruct = Struct.new(:element, :meta, :attributes, :content, :parent)
 
-      def inspect(*args)
+    # A base class for all objects in api-elements (http://api-elements.readthedocs.io/en/latest/)
+    class Base < BaseStruct
+      def inspect
         "##{self.class} (element: #{element}, meta: #{meta}, attributes: #{attributes.inspect}, content: #{content.inspect}, parent: ##{parent.class})"
       end
 
@@ -14,11 +17,11 @@ module RSpecApib
 
       def self.parse(node_or_nodes, index:, parent:, klass: nil)
         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 is_basic_hash?(node_or_nodes)
-        return node_or_nodes unless !klass.nil? || is_base_element?(node_or_nodes)
+        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
         klass_name = klass
-        klass_name ||= hash["element"].slice(0,1).capitalize + hash["element"].slice(1..-1).gsub(" ", "")
+        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)
         klass = RSpecApib::Element.const_get(klass_name)
         index[klass] ||= []
@@ -61,12 +64,10 @@ module RSpecApib
         {}
       end
 
-      def self.is_base_element?(node)
+      def self.base_element?(node)
         node.is_a?(::Hash) && node.keys.include?("element")
       end
 
-      private
-
       def self.attributes_schema
         {}
       end
@@ -81,8 +82,8 @@ module RSpecApib
         node
       end
 
-      def self.is_basic_hash?(node)
-        node.is_a?(::Hash) && !is_base_element?(node)
+      def self.basic_hash?(node)
+        node.is_a?(::Hash) && !base_element?(node)
       end
 
       def self.transformed_basic_hash(node, index:, parent:)

data/lib/rspec_apib/elements/category.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
+    # Represents a category in api-elements (http://api-elements.readthedocs.io/en/latest/)
     class Category < Base
-
     end
   end
 end

data/lib/rspec_apib/elements/copy.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
+    # Represents copy text in api-elements (http://api-elements.readthedocs.io/en/latest/)
     class Copy < Base
-
     end
   end
 end

data/lib/rspec_apib/elements/data_structure.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
+    # Represents a data structure in api-elements (http://api-elements.readthedocs.io/en/latest/)
     class DataStructure < Base
 
     end

data/lib/rspec_apib/elements/href_variables.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
 require "addressable"
 module RSpecApib
   module Element
+    # Represents a collection of href variables in api-elements (http://api-elements.readthedocs.io/en/latest/)
     class HrefVariables < Base
       def [](key)
-        member = content.find {|h| h.is_a?(Member) && h.content.key?(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

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
+    # Represents a collection of http headers in api-elements (http://api-elements.readthedocs.io/en/latest/)
     class HttpHeaders < Base
       def [](key)
-        member = content.find {|h| h.is_a?(Member) && h.content.key?(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|
+        content.select { |h| h.is_a?(Member) }.each do |header|
           yield header.key, header.value
         end
       end
@@ -16,12 +18,11 @@ module RSpecApib
       def keep_if
         results = dup
         results.content = []
-        content.select {|h| h.is_a?(Member)}.each do |header|
+        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

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 require "json-schema"
 require "rspec_apib/elements/http_message_payload"
 module RSpecApib
   module Element
+    # Represents a http message payload in api-elements (http://api-elements.readthedocs.io/en/latest/)
     class HttpMessagePayload < Base
-
       # The content type if defined else nil
       # @return [String | NilClass] The content type header or nil
       def content_type
@@ -31,7 +32,7 @@ module RSpecApib
           reason: "Schema validation failure",
           details: errors
         }
-        return [failure_reason]
+        [failure_reason]
       end
 
       private

data/lib/rspec_apib/elements/http_request.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 require "json-schema"
 require "rspec_apib/elements/http_message_payload"
 module RSpecApib
   module Element
+    # Represents a http request in api-elements (http://api-elements.readthedocs.io/en/latest/)
     class HttpRequest < HttpMessagePayload
 
       # Indicates if the incoming request matches the method, path and path vars
@@ -9,8 +11,8 @@ module RSpecApib
       # @return [Boolean] true if matches else false
       def matches?(request, options: {})
         matches_method?(request) &&
-        matches_path?(request) &&
-        matches_headers?(request, options)
+          matches_path?(request) &&
+          matches_headers?(request, options)
       end
 
       # Inherit href and hrefVariables from any ancestor
@@ -30,10 +32,16 @@ module RSpecApib
         attributes && attributes["href"].to_s
       end
 
+      def self.attributes_schema
+        {
+          href: "TemplatedHref"
+        }
+      end
+
       private
 
-      def matches_headers?(request_or_response, options)
-        headers = attributes && attributes["headers"] && attributes["headers"].keep_if {|k, v| k == "Content-Type" || k == "Accept"}
+      def matches_headers?(request_or_response, _options)
+        headers = compared_headers
         return true if headers.nil?
         headers.each_pair do |header_key, header_value|
           return false unless request_or_response.headers.key?(header_key) &&
@@ -41,6 +49,10 @@ module RSpecApib
         end
       end
 
+      def compared_headers
+        attributes && attributes["headers"] && attributes["headers"].keep_if {|k, _v| k == "Content-Type" || k == "Accept"}
+      end
+
       def matches_method?(request)
         attributes && attributes["method"] && attributes["method"].downcase.to_sym == request.request_method
       end
@@ -48,12 +60,6 @@ module RSpecApib
       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

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
 require "rspec_apib/elements/http_message_payload"
 module RSpecApib
   module Element
+    # Represents a http response in api-elements (http://api-elements.readthedocs.io/en/latest/)
     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)
+          matches_content_type?(response)
       end
 
       def status

data/lib/rspec_apib/elements/http_transaction.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
+    # Represents a http transaction in api-elements (http://api-elements.readthedocs.io/en/latest/)
     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)
+          (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)

data/lib/rspec_apib/elements/member.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
+    # Represents a member in api-elements (http://api-elements.readthedocs.io/en/latest/)
     class Member < Base
-
       def self.from_hash(hash, index:, parent:)
         child = super
         content = child.content
-        child.content = {content["key"] => content["value"]}
+        child.content = { content["key"] => content["value"] }
         child
       end
 

data/lib/rspec_apib/elements/object.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
+    # Represents an object request in api-elements (http://api-elements.readthedocs.io/en/latest/)
     class Object < Base
-
     end
   end
 end

data/lib/rspec_apib/elements/parse_result.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
     class ParseResult < Base

data/lib/rspec_apib/elements/resource.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
     # (byebug) parent.parent["attributes"]

data/lib/rspec_apib/elements/source_map.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
     class SourceMap < Base

data/lib/rspec_apib/elements/string.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
     class String < ::String

data/lib/rspec_apib/elements/templated_href.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "addressable"
 module RSpecApib
   module Element

data/lib/rspec_apib/elements/transition.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RSpecApib
   module Element
     class Transition < Base

data/lib/rspec_apib/elements.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "rspec_apib/elements/base"
 require "rspec_apib/elements/parse_result"
 require "rspec_apib/elements/category"

data/lib/rspec_apib/extractors/http_transaction.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RSpecApib
   module Extractor
     class HttpTransaction

data/lib/rspec_apib/extractors/resource.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RSpecApib
   module Extractor
     class Resource

data/lib/rspec_apib/extractors.rb

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

data/lib/rspec_apib/parser.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "rspec_apib/transcluder"
 require "rspec_apib/extractors"
 require "rspec_apib/elements"
@@ -65,7 +66,7 @@ module RSpecApib
 
     def call_parser(file)
       op = nil
-      Open3.popen3("#{bin_path} -f json") do |stdin, stdout, stderr, wait_thr|
+      Open3.popen3("#{bin_path} -f json") do |stdin, stdout, _stderr, wait_thr|
         transcluder.each_line(file) do |line|
           stdin.write line
         end

data/lib/rspec_apib/request.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+require "forwardable"
 module RSpecApib
   class Request
+    extend Forwardable
     def initialize(request)
       self.raw_request = request
     end
@@ -8,19 +11,15 @@ module RSpecApib
       raw_request.method
     end
 
-    def url
-      raw_request.url
-    end
+    delegate url: :raw_request
 
     def validate_body_with_json_schema?
-      request_method != :get && is_json?
+      request_method != :get && json?
     end
 
     # The request body
     # @return [String] The request body - always as a string
-    def body
-      raw_request.body
-    end
+    delegate body: :raw_request
 
     def content_type
       headers["Content-Type"]
@@ -30,15 +29,13 @@ module RSpecApib
       raw_request.request_headers
     end
 
-
     private
 
     attr_accessor :raw_request
 
-    def is_json?
+    def json?
       content_type =~ /json/
     end
 
-
   end
 end