jsonapi-validations 0.1.1.beta1 → 0.1.1.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51f6ad7a9024b404c821d08302c1211fc8ab6d84
-  data.tar.gz: 814b58de2920226fbd45d6368a872e603b1c88d1
+  metadata.gz: 50c60a21dbdeffb1d691453e6d7ff0fbb26687e7
+  data.tar.gz: 7c83f67e2f20618b772d8c32d3d5c98910db64e0
 SHA512:
-  metadata.gz: c7155434543ebdc5165d090d236940fb6a07cecb384744fef8ececdecf48dd92c3a2a09bd8b09c3ba2376589aff88dc888c1a9dba6405b11f41b7a9191bba75a
-  data.tar.gz: 03fa3a140f3ea5ef289957542d15df92e2aabc74e861db885170bf42e95284a609ff6a4ec00b5709a36b2b11ca711acc3640bb7e7260766f117fa3ddcfb14d91
+  metadata.gz: 15047d47eaf62e4080591e517f84db8a35bf42617b62cf85d1ad59ace892499cfdf1786e21acfbd2719157926731ff397091735072d28f5eeaccf05651dd35c1
+  data.tar.gz: 24d80073f4377572b7d409d67268388285c3357824c209fdf86b5ee852d2d0ee324adc4d14ae93f20ec126d317a9e46a6851b1453d2bb21fcabf1b54685895e8

data/lib/jsonapi/validations.rb

@@ -1,3 +1,6 @@
+require 'jsonapi/validations/relationship'
+require 'jsonapi/validations/resource'
+
 module JSONAPI
   module_function
 

data/lib/jsonapi/validations/relationship.rb

@@ -11,7 +11,7 @@ module JSONAPI
       # @param [Hash] params Validation parameters.
       #   @option [Symbol] kind Whether it is a :has_many or :has_one.
       #   @option [Array<Symbol>] types Permitted types for the relationship.
-      # @raise [JSONAPI::Validator::InvalidDocument] if document is invalid.
+      # @raise [JSONAPI::Parser::InvalidDocument] if document is invalid.
       def validate_relationship!(document, params = {})
         JSONAPI.parse_relationship!(document)
         validate_types!(document['data'], params[:types])
@@ -21,23 +21,29 @@ module JSONAPI
       def validate_types!(rel, rel_types, key = nil)
         rel_name = key ? " #{key}" : ''
         if rel_types[:kind] == :has_many
-          Document.ensure!(rel['data'].is_a?(Array),
-                           "Expected relationship#{rel_name} to be has_many.")
+          unless rel['data'].is_a?(Array)
+            raise JSONAPI::Parser::InvalidDocument,
+                  "Expected relationship#{rel_name} to be has_many."
+          end
           return unless rel_types[:types]
           rel['data'].each do |ri|
-            Document.ensure!(rel_types[:types].include?(ri['type'].to_sym),
-                             "Type mismatch for relationship#{rel_name}: " \
-                             "#{ri['type']} should be one of #{rel_types}")
+            next if rel_types[:types].include?(ri['type'].to_sym)
+            raise JSONAPI::Parser::InvalidDocument,
+                  "Type mismatch for relationship#{rel_name}: " \
+                  "#{ri['type']} should be one of #{rel_types}"
           end
         else
           return if rel['data'].nil?
-          Document.ensure!(rel['data'].is_a?(Hash),
-                           "Expected relationship#{rel_name} to be has_one.")
+          unless rel['data'].is_a?(Hash)
+            raise JSONAPI::Parser::InvalidDocument,
+                  "Expected relationship#{rel_name} to be has_one."
+          end
           return unless rel_types[:types]
           ri = rel['data']
-          Document.ensure!(rel_types[:types].include?(ri['type'].to_sym),
-                           "Type mismatch for relationship#{rel_name}: " \
-                           "#{ri['type']} should be one of #{rel_types}")
+          return if rel_types[:types].include?(ri['type'].to_sym)
+          raise JSONAPI::Parser::InvalidDocument,
+                "Type mismatch for relationship#{rel_name}: " \
+                "#{ri['type']} should be one of #{rel_types}"
         end
       end
     end

data/lib/jsonapi/validations/resource.rb

@@ -19,7 +19,7 @@ module JSONAPI
       #   @option [Hash] types Permitted primary/relationships types. Optional.
       #     The relationships must be explicitly permitted. Not all
       #     relationships' types have to be specified.
-      # @raise [JSONAPI::Validator::InvalidDocument] if document is invalid.
+      # @raise [JSONAPI::Parser::InvalidDocument] if document is invalid.
       #
       # @example
       #   params = {
@@ -58,54 +58,65 @@ module JSONAPI
       # @api private
       def validate_permitted!(data, permitted)
         return if permitted.nil?
-        Document.ensure!(permitted[:id] || !data.key?('id'),
-                         'Unpermitted id.')
+        unless permitted[:id] || !data.key?('id')
+          raise JSONAPI::Parser::InvalidDocument,
+                'Unpermitted id.'
+        end
         # TODO(beauby): Handle meta (and possibly links) once the spec has
         #   been clarified.
         permitted_attrs = permitted[:attributes] || []
         if data.key?('attributes')
           data['attributes'].keys.each do |attr|
-            Document.ensure!(permitted_attrs.include?(attr.to_sym),
-                             "Unpermitted attribute #{attr}")
+            unless permitted_attrs.include?(attr.to_sym)
+              raise JSONAPI::Parser::InvalidDocument,
+                    "Unpermitted attribute #{attr}"
+            end
           end
         end
         permitted_rels = permitted[:relationships] || []
-        if data.key?('relationships')
-          data['relationships'].keys.each do |rel|
-            Document.ensure!(permitted_rels.include?(rel.to_sym))
-          end
+        return unless  data.key?('relationships')
+        data['relationships'].keys.each do |rel|
+          next if permitted_rels.include?(rel.to_sym)
+          raise JSONAPI::Parser::InvalidDocument
         end
       end
 
       # @api private
       def validate_required!(data, required)
         return if required.nil?
-        Document.ensure!(data.key?('id') || !required[:id],
-                         'Missing required id.')
+        unless data.key?('id') || !required[:id]
+          raise JSONAPI::Parser::InvalidDocument, 'Missing required id.'
+        end
         # TODO(beauby): Same as for permitted.
 
-        Document.ensure!(data.key?('attributes') || !required[:attributes],
-                         'Missing required attributes.')
+        unless data.key?('attributes') || !required[:attributes]
+          raise JSONAPI::Parser::InvalidDocument, 'Missing required attributes.'
+        end
         required[:attributes].each do |attr|
-          Document.ensure!(data['attributes'][attr.to_s],
-                           "Missing required attribute #{attr}.")
+          next if data['attributes'][attr.to_s]
+          raise JSONAPI::Parser::InvalidDocument,
+                "Missing required attribute #{attr}."
+        end
+        unless data.key?('relationships') || !required[:relationships]
+          raise JSONAPI::Parser::InvalidDocument,
+                'Missing required relationships.'
         end
-        Document.ensure!(data.key?('relationships') ||
-                         !required[:relationships],
-                         'Missing required relationships.')
         required[:relationships].each do |rel|
-          Document.ensure!(data['relationships'][rel.to_s],
-                           "Missing required relationship #{rel}.")
+          unless data['relationships'][rel.to_s]
+            raise JSONAPI::Parser::InvalidDocument,
+                  "Missing required relationship #{rel}."
+          end
         end
       end
 
       # @api private
       def validate_types!(data, types)
         return if types.nil?
-        Document.ensure!(!types[:primary] ||
-                         types[:primary].include?(data['type'].to_sym),
-                         "Type mismatch for resource: #{data['type']} " \
-                         "should be one of #{types[:primary]}")
+        unless !types[:primary] || types[:primary].include?(data['type'].to_sym)
+          raise JSONAPI::Parser::InvalidDocument,
+                "Type mismatch for resource: #{data['type']} " \
+                "should be one of #{types[:primary]}"
+        end
         return unless data.key?('relationships') && types.key?(:relationships)
         types[:relationships].each do |key, rel_types|
           rel = data['relationships'][key.to_s]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-validations
 version: !ruby/object:Gem::Version
-  version: 0.1.1.beta1
+  version: 0.1.1.beta3
 platform: ruby
 authors:
 - Lucas Hosseini
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 description: Validate presence/absence of resource creation/update and relationship
   update payloads, as well as types related resources
 email: lucas.hosseini@gmail.com