rspec-rails-api 0.3.4 → 0.5.0

data/lib/rspec/rails/api/utils.rb

@@ -7,80 +7,38 @@ module RSpec
     module Api
       # Helper methods
       class Utils
-        def self.deep_get(hash, path)
-          path.split('.').inject(hash) do |sub_hash, key|
-            return nil unless sub_hash.is_a?(Hash) && sub_hash.key?(key.to_sym)
-
-            sub_hash[key.to_sym] # rubocop:disable Lint/UnmodifiedReduceAccumulator
+        class << self
+          ##
+          # Sets a value at given dotted path in a hash
+          #
+          # @param hash      [Hash]   The target hash
+          # @param path      [Array]  List of keys to access value
+          # @param value     [*]      Value to set
+          #
+          # @return [Hash] The modified hash
+          def deep_set(hash, path, value)
+            raise 'path should be an array' unless path.is_a? Array
+
+            return value if path.count.zero?
+
+            current_key       = path.shift.to_s.to_sym
+            hash[current_key] = {} unless hash[current_key].is_a?(Hash)
+            hash[current_key] = deep_set(hash[current_key], path, value)
+
+            hash
           end
-        end
-
-        def self.deep_set(hash, path, value)
-          path = path.split('.') unless path.is_a? Array
-
-          return value if path.count.zero?
-
-          current_key       = path.shift.to_sym
-          hash[current_key] = {} unless hash[current_key].is_a?(Hash)
-          hash[current_key] = deep_set(hash[current_key], path, value)
-
-          hash
-        end
-
-        def self.check_value_type(type, value)
-          return true if type == :boolean && (value.is_a?(TrueClass) || value.is_a?(FalseClass))
-          return true if type == :array && value.is_a?(Array)
-
-          raise "Unknown type #{type}" unless PARAM_TYPES.key? type
-
-          value.is_a? PARAM_TYPES[type][:class]
-        end
-
-        def self.validate_object_structure(actual, expected)
-          # Check keys
-          return false unless same_keys? actual, expected
 
-          expected.each_key do |key|
-            next unless expected[key][:required]
+          ##
+          # Returns a hash from an object
+          #
+          # @param value [Hash,Class] A hash or something with a "body" (as responses object in tests)
+          #
+          # @return [Hash]
+          def hash_from_response(value)
+            return JSON.parse(value.body) if value.respond_to? :body
 
-            expected_type       = expected[key][:type]
-            expected_attributes = expected[key][:attributes]
-
-            # Type
-            return false unless check_value_type expected_type, actual[key.to_s]
-
-            # Deep object ?
-            return false unless validate_deep_object expected_type, expected_attributes, actual[key.to_s]
-          end
-
-          true
-        end
-
-        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
-        def self.validate_deep_object(expected_type, expected_attributes, actual)
-          if %i[object array].include?(expected_type) && expected_attributes.is_a?(Hash)
-            case expected_type
-            when :object
-              return false unless validate_object_structure actual, expected_attributes
-            when :array
-              actual.each do |array_entry|
-                return false unless validate_object_structure array_entry, expected_attributes
-              end
-            end
+            value
           end
-
-          true
-        end
-        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength
-
-        def self.same_keys?(actual, expected)
-          optional = expected.reject { |_key, value| value[:required] }.keys
-          actual.symbolize_keys.keys.sort - optional == expected.keys.sort - optional
-        end
-
-        def self.check_attribute_type(type, except: [])
-          keys = PARAM_TYPES.keys.reject { |key| except.include? key }
-          keys.include?(type)
         end
       end
     end

data/lib/rspec/rails/api/validator.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+require 'active_support/hash_with_indifferent_access'
+require 'rspec_rails_api'
+
+module RSpec
+  module Rails
+    module Api
+      # Set of method to validate data and data structures
+      class Validator
+        class << self
+          ##
+          # Validates an object keys and values types
+          #
+          # @param actual   [*]              Value to compare
+          # @param expected [Hash, NilClass] Definition
+          #
+          # @return [String, Hash, NilClass] Nil when no error, string when not an object and dictionary of errors
+          #         otherwise
+          def validate_object(actual, expected)
+            return 'is not a hash' unless actual.is_a? Hash
+            # Don't validate without a definition
+            return unless expected
+
+            keys_errors = validate_object_keys actual, expected
+            return keys_errors unless keys_errors.nil?
+
+            attributes_errors = validate_object_attributes(actual, expected)
+
+            attributes_errors unless attributes_errors.keys.empty?
+          end
+
+          ##
+          # Validates each entry of an array
+          #
+          # @param array    [*]                      The array to check
+          # @param expected [Symbol, Hash, NilClass] Attributes configuration
+          #
+          # @return [String, Hash, NilClass] Nil when no error, string when not an object and dictionary of errors
+          #         otherwise
+          def validate_array(array, expected)
+            return 'is not an array' unless array.is_a? Array
+            # Arrays without an expected entry type
+            return unless expected
+
+            errors = {}
+            array.each_with_index do |array_entry, index|
+              value_error = validate_array_entry array_entry, expected
+              errors["##{index}"] = value_error if value_error
+            end
+
+            errors unless errors.keys.empty?
+          end
+
+          ##
+          # Returns a human-readable string from matcher errors
+          #
+          # @param errors [String,Hash] Validation errors
+          # @param values [String]      JSON string representing the value
+          #
+          # @return [String]
+          def format_failure_message(errors, values)
+            if errors.is_a? Hash
+              errors = errors.deep_stringify_keys.to_yaml.split("\n")
+              errors.shift
+              errors.map! do |line|
+                "  #{line.sub(/^(\s+)"(#\d+)":(.*)$/, '\1\2:\3')}"
+              end
+              errors = errors.join("\n")
+            end
+
+            <<~TXT
+              expected object structure not to have these errors:
+              #{errors}
+
+              As a notice, here is the JSON object:
+                #{values}
+            TXT
+          end
+
+          ##
+          # Checks if a given type is in the supported types list
+          #
+          # @param type   [Symbol]   Type to check
+          # @param except [[Symbol]] List of types to ignore
+          #
+          # @return [Boolean]
+          def valid_type?(type, except: [])
+            keys = PARAM_TYPES.keys.reject { |key| except.include? key }
+            keys.include?(type)
+          end
+
+          ##
+          # Checks if a value is of the given type
+          #
+          # @param value [*]      Value to test
+          # @param type  [Symbol] Type to compare to
+          #
+          # @return [String,NilClass] True when the value corresponds to the given type
+          def validate_type(value, type)
+            if type == :boolean
+              return nil if value.is_a?(TrueClass) || value.is_a?(FalseClass)
+
+              return 'is not a "boolean"'
+            end
+
+            raise "Unknown type #{type}" unless PARAM_TYPES.key? type
+
+            return nil if value.is_a? PARAM_TYPES[type][:class]
+
+            "is not a \"#{type}\""
+          end
+
+          private
+
+          # Checks if a key should be skipped, whether it's missing and optional or nil
+          #
+          # @param key        [Symbol] Key to check
+          # @param value      [*]      Associated value
+          # @param definition [Hash]   Entity definitions
+          #
+          # @return [Boolean]
+          def skip_key_check?(key, value, definition)
+            # Ignore missing optional keys
+            return true unless value.key?(key.to_s) || definition[key][:required]
+            # Ignore null optional keys
+            return true if !definition[key][:required] && value[key.to_s].nil?
+
+            false
+          end
+
+          # Validates the keys of a hash
+          #
+          # @param actual     [Hash] The hash to check
+          # @param definition [Hash] The object definition
+          #
+          # @return [String, Hash, NilClass] Nil when no error, string when not an object and dictionary of errors
+          #         otherwise
+          def validate_object_keys(actual, definition)
+            # Hashes without an expected attributes type
+            return unless definition
+
+            errors = {}
+            actual.each_key do |key|
+              errors[key] = 'is not defined' unless definition.key?(key.to_sym)
+            end
+
+            errors unless errors.keys.empty?
+          end
+
+          ##
+          # Validates the attributes of a Hash
+          #
+          # @param actual   [Hash] Value to compare
+          # @param expected [Hash] Definition
+          #
+          # @return [String, Hash, NilClass] Nil when no error, string when not an object and dictionary of errors
+          #         otherwise
+          def validate_object_attributes(actual, expected)
+            errors = {}
+            expected.each_key do |key|
+              next if skip_key_check? key, actual, expected
+
+              value_error = validate_object_attribute key, actual, expected[key][:type], expected[key][:attributes]
+              errors[key] = value_error unless value_error.nil?
+            end
+
+            errors unless errors.keys.nil?
+          end
+
+          # Checks the value of an entry in a Hash
+          #
+          # @param key           [Symbol]      Key to check
+          # @param actual        [Hash]        Hash to check
+          # @param expected_type [Symbol]      Expected type
+          # @param definition    [Symbol,Hash] Attribute definition
+          #
+          # @return [String,Hash,NilClass] Nil when no error is met, string when not a primitive and dictionary of
+          #         errors otherwise
+          def validate_object_attribute(key, actual, expected_type, definition)
+            return 'is missing' unless actual.key? key.to_s
+
+            case expected_type
+            when :object
+              validate_object actual[key.to_s], definition
+            when :array
+              validate_array actual[key.to_s], definition
+            else
+              validate_type actual[key.to_s], expected_type
+            end
+          end
+
+          # Checks the validity of an array entry against a definition
+          #
+          # @param entry      [*]    Entry to check
+          # @param definition [Hash] Fields definition
+          #
+          # @return [String,Hash,NilClass] Nil when no error is met, string when not a primitive and dictionary of
+          #         errors otherwise
+          def validate_array_entry(entry, definition)
+            if definition[:type].is_a? Symbol # Array of "simple" values
+              validate_type entry, definition[:type]
+            else # Objects
+              validate_object entry, definition
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/rails/api/version.rb

@@ -3,7 +3,7 @@
 module RSpec
   module Rails
     module Api
-      VERSION = '0.3.4'
+      VERSION = '0.5.0'
     end
   end
 end

data/lib/rspec_rails_api.rb

@@ -15,6 +15,8 @@ module RSpec
       class Error < StandardError
       end
 
+      ##
+      # OpenAPI types, format and Ruby class correspondence
       PARAM_TYPES = {
         int32:    { type: 'integer', format: 'int32', class: Integer },
         int64:    { type: 'integer', format: 'int64', class: Integer },
@@ -32,6 +34,8 @@ module RSpec
         array:    { type: 'array', format: nil, class: Array },
         object:   { type: 'object', format: nil, class: Hash },
       }.freeze
+
+      PRIMITIVES = PARAM_TYPES.keys
     end
   end
 end

data/rspec-rails-api.gemspec

@@ -18,9 +18,10 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://gitlab.com/experimentslabs/rspec-rails-api'
   spec.license  = 'MIT'
   spec.metadata = {
-    'source_code_uri' => 'https://gitlab.com/experimentslabs/rspec-rails-api',
-    'bug_tracker_uri' => 'https://gitlab.com/experimentslabs/rspec-rails-api/issues',
-    'changelog_uri'   => 'https://gitlab.com/experimentslabs/rspec-rails-api/blob/master/CHANGELOG.md',
+    'source_code_uri'       => 'https://gitlab.com/experimentslabs/rspec-rails-api',
+    'bug_tracker_uri'       => 'https://gitlab.com/experimentslabs/rspec-rails-api/issues',
+    'changelog_uri'         => 'https://gitlab.com/experimentslabs/rspec-rails-api/blob/master/CHANGELOG.md',
+    'rubygems_mfa_required' => 'true',
   }
 
   # Specify which files should be added to the gem when it is released.
@@ -32,14 +33,18 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.add_development_dependency 'activesupport', '~> 6.0'
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rack'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2023-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Create acceptance tests to check the Rails API responses and generate
   documentation from it.
@@ -135,10 +191,12 @@ files:
 - ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -152,6 +210,7 @@ files:
 - lib/rspec/rails/api/metadata.rb
 - lib/rspec/rails/api/open_api_renderer.rb
 - lib/rspec/rails/api/utils.rb
+- lib/rspec/rails/api/validator.rb
 - lib/rspec/rails/api/version.rb
 - lib/rspec_rails_api.rb
 - rspec-rails-api.gemspec
@@ -162,6 +221,7 @@ metadata:
   source_code_uri: https://gitlab.com/experimentslabs/rspec-rails-api
   bug_tracker_uri: https://gitlab.com/experimentslabs/rspec-rails-api/issues
   changelog_uri: https://gitlab.com/experimentslabs/rspec-rails-api/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -170,15 +230,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Tests standard Rails API responses and generate doc