rspec_contracts 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6576fa2cf41a382ea4b30ec4214c2ead84d6c17e2906fbcfb956dd86c21437cf
-  data.tar.gz: 5b5c0b1f48ea60ceaa207375152c19ca42d729780e939e2dff5245c201654424
+  metadata.gz: 416990094d07bd3e4a083be651518350f4a730fad14feb0e109d99710ea2b0f4
+  data.tar.gz: 734de59f3870c8afb9231bf55b8712c8fd61c244f8178f5dcf09ec1cbb3a7a39
 SHA512:
-  metadata.gz: c734f0ab1fbfaecc7a51c67c8ec5c1eba147b9477908a8c9196a33ebc0ffcc030f357981379e569675b365700a0f6130427bf4cec9164282289730cd09bb38ca
-  data.tar.gz: c8cc4756d8cc3a7475cb0346eb42bd897ddeea6e448d87961c8ff1529bd3234448354cf9b7eee4bbd01366a89e29ea2394d97b3d60f9de09663bb0d60d5c531d
+  metadata.gz: 1360e61a50dd701ca97deae3228f541e897712da1c6a9ce86c7a7e7f934cc4bf35e5e2f1434bee891f758402e3d8854534feaf4bac8686ae6faff71b7a780975
+  data.tar.gz: 33716e95b8cad067992ce6423a3c6b58ec16e22400f90ef2f77cb3812df74690c42f824fadf28240b4389724ab6913c9ddb45c8b4452e98152f1a47f4f949dcf

data/README.md

@@ -117,7 +117,9 @@ The operation you're trying to test does not match either the HTTP method, or th
 
 The POST body (if one is present) does not match the schema for a valid request as defined by the given operation.
 
-### `RspecContracts::Error::RequestValidation`
+This error is never raised if there is no POST body.
+
+### `RspecContracts::Error::ResponseValidation`
 
 The response body does not match the schema for a valid response as defined by the given operation.
 

data/lib/rspec_contracts.rb

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-require 'active_support/lazy_load_hooks'
+require "active_support/lazy_load_hooks"
 require "rspec_contracts/engine"
 require "rspec_contracts/integration"
-require 'rspec_contracts/contract'
-require 'rspec_contracts/operation'
-require 'rspec_contracts/error'
-require 'rspec_contracts/error/operation_lookup'
-require 'rspec_contracts/error/request_validation'
-require 'rspec_contracts/error/response_validation'
-require 'rspec_contracts/error/path_validation'
-require 'rspec_contracts/error/schema'
-require 'rspec_contracts/path_validator'
-require 'rspec_contracts/request_validator'
-require 'rspec_contracts/response_validator'
-require 'rspec_contracts/railtie' if defined?(Rails::Railtie)
+require "rspec_contracts/contract"
+require "rspec_contracts/operation"
+require "rspec_contracts/error"
+require "rspec_contracts/error/operation_lookup"
+require "rspec_contracts/error/request_validation"
+require "rspec_contracts/error/response_validation"
+require "rspec_contracts/error/path_validation"
+require "rspec_contracts/error/schema"
+require "rspec_contracts/path_validator"
+require "rspec_contracts/request_validator"
+require "rspec_contracts/response_validator"
+require "rspec_contracts/railtie" if defined?(Rails::Railtie)
 require "openapi_parser"
 require "semverse"
 
@@ -37,9 +37,9 @@ module RspecContracts
   end
 
   def self.valid_json?(json)
-    JSON.parse(json)
-    return true
-  rescue JSON::ParserError => e
-    return false
+    JSON.parse(json.to_s)
+    true
+  rescue JSON::ParserError => _e
+    false
   end
 end

data/lib/rspec_contracts/contract.rb

@@ -1,36 +1,40 @@
-class RspecContracts::Contract
-  def initialize(schema)
-    @schema = schema.with_indifferent_access
-    @root = OpenAPIParser.parse(schema)
-  end
+# frozen_string_literal: true
 
-  def [](key)
-    return RspecContracts::Operation.new(nil, self) unless operations.key?(key)
+module RspecContracts
+  class Contract
+    def initialize(schema)
+      @schema = schema.with_indifferent_access
+      @root = OpenAPIParser.parse(schema)
+    end
 
-    operations[key]
-  end
+    def [](key)
+      return RspecContracts::Operation.new(nil, self) unless operations.key?(key)
 
-  def version
-    @schema[:info][:version]
-  rescue NoMethodError => _e
-    raise RspecContracts::Error.new("Version not found in schema")
-  end
+      operations[key]
+    end
 
-  def operations
-    @operations ||= paths.map do |p|
-      p._openapi_all_child_objects.values.map do |op| 
-        next unless op.respond_to?(:operation_id)
+    def version
+      @schema[:info][:version]
+    rescue NoMethodError => _e
+      raise RspecContracts::Error.new("Version not found in schema")
+    end
 
-        [op.operation_id, RspecContracts::Operation.new(op, self)]
-      end.compact.to_h
-    end.inject(:merge).with_indifferent_access
-  end
+    def operations
+      @operations ||= paths.map do |p|
+        p._openapi_all_child_objects.values.map do |op|
+          next unless op.respond_to?(:operation_id)
 
-  def paths
-    @paths ||= @root.paths._openapi_all_child_objects.values
-  end
+          [op.operation_id, RspecContracts::Operation.new(op, self)]
+        end.compact.to_h
+      end.inject(:merge).with_indifferent_access
+    end
+
+    def paths
+      @paths ||= @root.paths._openapi_all_child_objects.values
+    end
 
-  def method_missing(m, *args, &block)
-    @root.send(m, *args, &block)
+    def method_missing(m, *args, &block)
+      @root.send(m, *args, &block)
+    end
   end
 end

data/lib/rspec_contracts/error.rb

@@ -1,2 +1,6 @@
-class RspecContracts::Error < StandardError
+# frozen_string_literal: true
+
+module RspecContracts
+  class Error < StandardError
+  end
 end

data/lib/rspec_contracts/error/operation_lookup.rb

@@ -1,2 +1,8 @@
-class RspecContracts::Error::OperationLookup < RspecContracts::Error
+# frozen_string_literal: true
+
+module RspecContracts
+  class Error
+    class OperationLookup < RspecContracts::Error
+    end
+  end
 end

data/lib/rspec_contracts/error/path_validation.rb

@@ -1,2 +1,8 @@
-class RspecContracts::Error::PathValidation < RspecContracts::Error
+# frozen_string_literal: true
+
+module RspecContracts
+  class Error
+    class PathValidation < RspecContracts::Error
+    end
+  end
 end

data/lib/rspec_contracts/error/request_validation.rb

@@ -1,2 +1,8 @@
-class RspecContracts::Error::RequestValidation < RspecContracts::Error
+# frozen_string_literal: true
+
+module RspecContracts
+  class Error
+    class RequestValidation < RspecContracts::Error
+    end
+  end
 end

data/lib/rspec_contracts/error/response_validation.rb

@@ -1,2 +1,8 @@
-class RspecContracts::Error::ResponseValidation < RspecContracts::Error
+# frozen_string_literal: true
+
+module RspecContracts
+  class Error
+    class ResponseValidation < RspecContracts::Error
+    end
+  end
 end

data/lib/rspec_contracts/error/schema.rb

@@ -1,2 +1,8 @@
-class RspecContracts::Error::Schema < RspecContracts::Error  
+# frozen_string_literal: true
+
+module RspecContracts
+  class Error
+    class Schema < RspecContracts::Error
+    end
+  end
 end

data/lib/rspec_contracts/integration.rb

@@ -1,24 +1,32 @@
-module RspecContracts::Integration
-  http_verbs = %w(get post patch put delete)
+# frozen_string_literal: true
 
-  http_verbs.each do |method|
-    define_method(method) do |*args, **kwargs|
-      request_path = args.first
-      api_operation = kwargs.delete(:api_operation)
-      api_version = kwargs.delete(:api_version)
-      super(*args, **kwargs).tap do |status_code|
-        return unless api_operation # even a not found contract lookup will still be present
-        return if api_version.present? && !Semverse::Constraint.new(api_operation.root.version).include?(api_version)
-        raise RspecContracts::Error::OperationLookup.new("Operation not found") unless api_operation.valid?
+module RspecContracts
+  module Integration
+    http_verbs = %w[get post patch put delete]
 
-        RspecContracts.config.logger.tagged("rspec_contracts", api_operation.operation_id) do
+    http_verbs.each do |method|
+      define_method(method) do |*args, **kwargs|
+        request_path = args.first
+        api_operation = kwargs.delete(:api_operation)
+        api_version = kwargs.delete(:api_version)
+        super(*args, **kwargs).tap do |status_code|
+          next unless api_operation # even a not found contract lookup will still be present
+          next if api_version.present? && !Semverse::Constraint.new(api_operation.root.version).include?(api_version)
+          raise RspecContracts::Error::OperationLookup.new("Operation not found") unless api_operation.valid?
 
-          RspecContracts::PathValidator.validate_path(api_operation, method, request_path) unless RspecContracts.config.path_validation_mode == :ignore
-          RspecContracts::RequestValidator.validate_request(api_operation, request) unless RspecContracts.config.request_validation_mode == :ignore
+          RspecContracts.config.logger.tagged("rspec_contracts", api_operation.operation_id) do
+            unless RspecContracts.config.path_validation_mode == :ignore
+              RspecContracts::PathValidator.validate_path(api_operation, method, request_path)
+            end
+            unless RspecContracts.config.request_validation_mode == :ignore
+              RspecContracts::RequestValidator.validate_request(api_operation, request)
+            end
 
-          unless RspecContracts.config.response_validation_mode == :ignore
-            validatable_response = OpenAPIParser::RequestOperation::ValidatableResponseBody.new(status_code, JSON.parse(response.body), response.headers)
-            RspecContracts::ResponseValidator.validate_response(api_operation, validatable_response)
+            unless RspecContracts.config.response_validation_mode == :ignore
+              parsed = RspecContracts.valid_json?(response.body) ? JSON.parse(response.body) : nil
+              vr = OpenAPIParser::RequestOperation::ValidatableResponseBody.new(status_code, parsed, response.headers)
+              RspecContracts::ResponseValidator.validate_response(api_operation, vr)
+            end
           end
         end
       end

data/lib/rspec_contracts/operation.rb

@@ -1,19 +1,24 @@
-class RspecContracts::Operation
-  attr_reader :root
-  def initialize(op, root)
-    @op = op
-    @root = root
-  end
+# frozen_string_literal: true
 
-  def valid?
-    @op.present?
-  end
+module RspecContracts
+  class Operation
+    attr_reader :root
 
-  def ==(val)
-    val == @op
-  end
+    def initialize(op, root)
+      @op = op
+      @root = root
+    end
+
+    def valid?
+      @op.present?
+    end
+
+    def ==(val)
+      val == @op
+    end
 
-  def method_missing(m, *args, &block)
-    @op.send(m, *args, &block)
+    def method_missing(m, *args, &block)
+      @op.send(m, *args, &block)
+    end
   end
 end

data/lib/rspec_contracts/path_validator.rb

@@ -1,17 +1,21 @@
-class RspecContracts::PathValidator
-  class << self
-    def validate_path(op, method, path)
-      lookup_path = path.remove(RspecContracts.config.base_path)
-      return if operation_matches_request?(op, method, lookup_path)
+# frozen_string_literal: true
 
-      msg = "#{method.upcase} #{path} does not resolve to #{op.operation_id}"
-      raise RspecContracts::Error::PathValidation.new(msg)  if RspecContracts.config.path_validation_mode == :raise 
-    
-      RspecContracts.config.logger.error "Contract validation warning: #{msg}"
-    end
+module RspecContracts
+  class PathValidator
+    class << self
+      def validate_path(op, method, path)
+        lookup_path = path.remove(RspecContracts.config.base_path)
+        return if operation_matches_request?(op, method, lookup_path)
+
+        msg = "#{method.upcase} #{path} does not resolve to #{op.operation_id}"
+        raise RspecContracts::Error::PathValidation.new(msg) if RspecContracts.config.path_validation_mode == :raise
+
+        RspecContracts.config.logger.error "Contract validation warning: #{msg}"
+      end
 
-    def operation_matches_request?(op, method, path)
-      op == op.root.request_operation(method.to_sym, path)&.operation_object
+      def operation_matches_request?(op, method, path)
+        op == op.root.request_operation(method.to_sym, path)&.operation_object
+      end
     end
   end
 end

data/lib/rspec_contracts/railtie.rb

@@ -1,5 +1,9 @@
-class RspecContracts::Railtie < Rails::Railtie
-  initializer "rspec_contracts" do
-    RspecContracts.install
+# frozen_string_literal: true
+
+module RspecContracts
+  class Railtie < Rails::Railtie
+    initializer "rspec_contracts" do
+      RspecContracts.install
+    end
   end
 end

data/lib/rspec_contracts/request_validator.rb

@@ -1,22 +1,29 @@
-class RspecContracts::RequestValidator
-  class << self
-    def validate_request(op, request)
-      body = request.body.read
-      parsed_body = RspecContracts.valid_json?(body) ? JSON.parse(request.body.read) : nil
-      op.validate_request_body(request.content_type, parsed_body, opts)
-    rescue OpenAPIParser::OpenAPIError => e
-      raise RspecContracts::Error::RequestValidation.new(e.message) if RspecContracts.config.request_validation_mode == :raise
+# frozen_string_literal: true
 
-      formatted_for_logging = {
-        body: parsed_body,
-        headers: request.headers.to_h.select { |k, _| k.starts_with?("HTTP_") }.transform_keys { |k| k.remove("HTTP_").downcase }
-      }
-      RspecContracts.config.logger.error "Contract validation warning: #{e.message}"
-      RspecContracts.config.logger.error "Request was: #{formatted_for_logging}"
-    end
+module RspecContracts
+  class RequestValidator
+    class << self
+      def validate_request(op, request)
+        body = request.body.read
+        parsed_body = RspecContracts.valid_json?(body) ? JSON.parse(request.body.read) : nil
+        op.validate_request_body(request.content_type, parsed_body, opts)
+      rescue OpenAPIParser::OpenAPIError => e
+        if RspecContracts.config.request_validation_mode == :raise
+          raise RspecContracts::Error::RequestValidation.new(e.message)
+        end
+
+        formatted_for_logging = {
+          body:    parsed_body,
+          headers: request.headers.to_h.select {|k, _| k.starts_with?("HTTP_") }
+                          .transform_keys {|k| k.remove("HTTP_").downcase }
+        }
+        RspecContracts.config.logger.error "Contract validation warning: #{e.message}"
+        RspecContracts.config.logger.error "Request was: #{formatted_for_logging}"
+      end
 
-    def opts
-      OpenAPIParser::SchemaValidator::Options.new(coerce_value: true, datetime_coerce_class: DateTime)
+      def opts
+        OpenAPIParser::SchemaValidator::Options.new(coerce_value: true, datetime_coerce_class: DateTime)
+      end
     end
   end
 end

data/lib/rspec_contracts/response_validator.rb

@@ -1,16 +1,23 @@
-class RspecContracts::ResponseValidator
-  class << self
-    def validate_response(op, resp)
-      op.validate_response(resp, opts)
-    rescue OpenAPIParser::OpenAPIError => e
-      raise RspecContracts::Error::ResponseValidation.new(e.message) if RspecContracts.config.response_validation_mode == :raise
-    
-      RspecContracts.config.logger.error "Contract validation warning: #{e.message}"
-      RspecContracts.config.logger.error "Response was: #{resp}"
-    end
+# frozen_string_literal: true
+
+module RspecContracts
+  class ResponseValidator
+    class << self
+      def validate_response(op, resp)
+        op.validate_response(resp, opts(has_content: resp.content_type.present?))
+      rescue OpenAPIParser::OpenAPIError => e
+        if RspecContracts.config.response_validation_mode == :raise
+          raise RspecContracts::Error::ResponseValidation.new(e.message)
+        end
+
+        RspecContracts.config.logger.error "Contract validation warning: #{e.message}"
+        RspecContracts.config.logger.error "Response was: #{resp}"
+      end
 
-    def opts
-      OpenAPIParser::SchemaValidator::ResponseValidateOptions.new(strict: RspecContracts.config.strict_response_validation)
+      def opts(has_content: true)
+        OpenAPIParser::SchemaValidator::ResponseValidateOptions.new(strict: has_content &&
+                                                                    RspecContracts.config.strict_response_validation)
+      end
     end
   end
 end

data/lib/rspec_contracts/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RspecContracts
-  VERSION = "0.1.1"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_contracts
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Steven Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2020-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,7 +45,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: openapi_parser
+  name: semverse
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -59,13 +59,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: semverse
+  name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -87,7 +87,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: active_model_serializers
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -101,7 +101,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -115,7 +115,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,7 +129,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_bot_rails
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -143,7 +143,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -157,7 +157,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-bundler
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -171,7 +171,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: overcommit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -185,7 +185,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: overcommit
+  name: pry-rescue
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -199,7 +199,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -216,16 +216,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.83.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.83.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -244,16 +244,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: simplecov-console
   requirement: !ruby/object:Gem::Requirement