jsonapi-parser 0.1.1.beta3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9c101eea6932a1a9deb384f2a513adcc2701d68
-  data.tar.gz: 51ac00ffdf2716b6bd3d6fa57e7e6440bf93cd3a
+  metadata.gz: 578891b6fc4f7b92a99ed7faf32e7293cdc14c3d
+  data.tar.gz: 9a90fae41ec97af4a3dbe7025b792d658077633e
 SHA512:
-  metadata.gz: 48407514b2dfae374a695714444c3fcce3f8214bf936d69a332e7643961181907e2ebd71318094059eb282fa570595c31e6c33d39dae1a235d283ae42112865e
-  data.tar.gz: c6b50736f13a2d6507985fb484e133fe0017931e3fb0afbc87cc67fa5555d83bb0331cefe09264af98a08fba95b2a37695d900bd09188cd7c044ad3a4a027c1e
+  metadata.gz: 0d0d4be5a368f4a5b4607cbb99147bad6618e89eb236f68a4720da025f23f456f6454b78fc92942afcebdc4a4033b20cd75bceacb5c2f12def5f16ed72d4ea71
+  data.tar.gz: c41d00603ee49098e7bf425939b436bce7f5c53bc0112b7c58b030a8abb616bff9e02884b6f28ea9c4c0fe7ec0b9b3a403617af3f17cfb385429c42c352e38d6

data/README.md

@@ -1,5 +1,12 @@
 # jsonapi-parser
-Ruby gem for parsing [JSON API](http://jsonapi.org) documents.
+Ruby gem for validating [JSON API](http://jsonapi.org) documents.
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/jsonapi-parser.svg)](https://badge.fury.io/rb/jsonapi-parser)
+[![Build Status](https://secure.travis-ci.org/jsonapi-rb/jsonapi-parser.svg?branch=master)](http://travis-ci.org/jsonapi-rb/parser?branch=master)
+[![codecov](https://codecov.io/gh/jsonapi-rb/jsonapi-parser/branch/master/graph/badge.svg)](https://codecov.io/gh/jsonapi-rb/parser)
+[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/jsonapi-rb/Lobby)
 
 ## Installation
 ```ruby

data/lib/jsonapi/parser/document.rb

@@ -4,12 +4,7 @@ module JSONAPI
   module Parser
     class Document
       TOP_LEVEL_KEYS = %w(data errors meta).freeze
-      EXTENDED_TOP_LEVEL_KEYS =
-        (TOP_LEVEL_KEYS + %w(jsonapi links included)).freeze
-      RESOURCE_KEYS = %w(id type attributes relationships links meta).freeze
       RESOURCE_IDENTIFIER_KEYS = %w(id type).freeze
-      EXTENDED_RESOURCE_IDENTIFIER_KEYS =
-        (RESOURCE_IDENTIFIER_KEYS + %w(meta)).freeze
       RELATIONSHIP_KEYS = %w(data links meta).freeze
       RELATIONSHIP_LINK_KEYS = %w(self related).freeze
       JSONAPI_OBJECT_KEYS = %w(version meta).freeze
@@ -22,9 +17,6 @@ module JSONAPI
         ensure!(document.is_a?(Hash),
                 'A JSON object MUST be at the root of every JSON API request ' \
                 'and response containing data.')
-        unexpected_keys = document.keys - EXTENDED_TOP_LEVEL_KEYS
-        ensure!(unexpected_keys.empty?,
-                "Unexpected members at top level: #{unexpected_keys}.")
         ensure!(!(document.keys & TOP_LEVEL_KEYS).empty?,
                 "A document MUST contain at least one of #{TOP_LEVEL_KEYS}.")
         ensure!(!(document.key?('data') && document.key?('errors')),
@@ -59,9 +51,6 @@ module JSONAPI
       def self.parse_primary_resource!(res)
         ensure!(res.is_a?(Hash), 'A resource object must be an object.')
         ensure!(res.key?('type'), 'A resource object must have a type.')
-        unexpected_keys = res.keys - RESOURCE_KEYS
-        ensure!(unexpected_keys.empty?,
-                "Unexpected members for primary resource: #{unexpected_keys}")
         parse_attributes!(res['attributes']) if res.key?('attributes')
         parse_relationships!(res['relationships']) if res.key?('relationships')
         parse_links!(res['links']) if res.key?('links')
@@ -90,9 +79,6 @@ module JSONAPI
       # @api private
       def self.parse_relationship!(rel)
         ensure!(rel.is_a?(Hash), 'A relationship object must be an object.')
-        unexpected_keys = rel.keys - RELATIONSHIP_KEYS
-        ensure!(unexpected_keys.empty?,
-                "Unexpected members for relationship: #{unexpected_keys}")
         ensure!(!rel.keys.empty?,
                 'A relationship object MUST contain at least one of ' \
                 "#{RELATIONSHIP_KEYS}")
@@ -119,10 +105,6 @@ module JSONAPI
       def self.parse_resource_identifier!(ri)
         ensure!(ri.is_a?(Hash),
                 'A resource identifier object must be an object')
-        unexpected_keys = ri.keys - EXTENDED_RESOURCE_IDENTIFIER_KEYS
-        ensure!(unexpected_keys.empty?,
-                'Unexpected members for resource identifier: ' \
-                "#{unexpected_keys}.")
         ensure!(RESOURCE_IDENTIFIER_KEYS & ri.keys == RESOURCE_IDENTIFIER_KEYS,
                 'A resource identifier object MUST contain ' \
                 "#{RESOURCE_IDENTIFIER_KEYS} members.")
@@ -188,11 +170,11 @@ module JSONAPI
       def self.parse_errors!(errors)
         ensure!(errors.is_a?(Array),
                 'Top level errors member must be an array.')
-        errors.each { |error| parse_ensure!(error) }
+        errors.each { |error| parse_error!(error) }
       end
 
       # @api private
-      def self.parse_ensure!(error)
+      def self.parse_error!(_error)
         # NOTE(beauby): Do nothing for now, as errors are under-specified as of
         #   JSONAPI 1.0
       end

metadata

@@ -1,16 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-parser
 version: !ruby/object:Gem::Version
-  version: 0.1.1.beta3
+  version: 0.1.1
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-24 00:00:00.000000000 Z
-dependencies: []
-description: Parse JSONAPI response documents, resource creation/update payloads,
+date: 2016-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Validate JSONAPI response documents, resource creation/update payloads,
   and relationship update payloads.
 email: lucas.hosseini@gmail.com
 executables: []
@@ -18,14 +60,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/draft.rb
-- lib/jsonapi/exceptions.rb
 - lib/jsonapi/parser.rb
 - lib/jsonapi/parser/document.rb
 - lib/jsonapi/parser/exceptions.rb
 - lib/jsonapi/parser/relationship.rb
 - lib/jsonapi/parser/resource.rb
-homepage: https://github.com/beauby/jsonapi
+homepage: https://github.com/jsonapi-rb/jsonapi-parser
 licenses:
 - MIT
 metadata: {}
@@ -40,13 +80,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Parse JSONAPI documents.
+summary: Validate JSON API documents.
 test_files: []

data/lib/draft.rb

@@ -1,151 +0,0 @@
-module JSONAPI
-  class Validator
-    class << self
-      TOP_LEVEL_KEYS = [:data, :errors, :meta].freeze
-      EXTENDED_TOP_LEVEL_KEYS = (TOP_LEVEL_KEYS +
-                                 [:jsonapi, :links, :included]).freeze
-      RESOURCE_KEYS = [:id, :type, :attributes, :relationships, :links,
-                       :meta].freeze
-      RESOURCE_IDENTIFIER_KEYS = [:id, :type].freeze
-      EXTENDED_RESOURCE_IDENTIFIER_KEYS = (RESOURCE_IDENTIFIER_KEYS +
-                                           [:meta]).freeze
-      RELATIONSHIP_KEYS = [:data, :links, :meta].freeze
-      RELATIONSHIP_LINK_KEYS = [:self, :related].freeze
-      JSONAPI_OBJECT_KEYS = [:version, :meta].freeze
-
-      # Validate the structure of a JSON API document.
-      def validate!(document)
-        @document = document
-        raise InvalidDocument unless @document.is_a?(Hash)
-        raise InvalidDocument if @document.keys.empty?
-        raise InvalidDocument unless (@document.keys - EXTENDED_TOP_LEVEL_KEYS).empty?
-        raise InvalidDocument if (@document.keys & TOP_LEVEL_KEYS).empty?
-        raise InvalidDocument if @document.key?(:data) && @document.key?(:errors)
-        raise InvalidDocument if @document.key?(:included) && !@document.key?(:data)
-        validate_data!(@document[:data]) if @document.key?(:data)
-        validate_errors!(@document[:errors]) if @document.key?(:errors)
-        validate_meta!(@document[:meta]) if @document.key?(:meta)
-        validate_jsonapi!(@document[:jsonapi]) if @document.key?(:jsonapi)
-        validate_included!(@document[:included]) if @document.key?(:included)
-        validate_links!(@document[:links]) if @document.key?(:links)
-      end
-
-      private
-
-      def validate_data!(data)
-        if data.is_a?(Hash)
-          validate_primary_resource!(data)
-        elsif data.is_a?(Array)
-          data.each { |res| validate_resource!(res) }
-        elsif data.nil?
-        # Do nothing
-        else
-          raise InvalidDocument
-        end
-      end
-
-      def validate_primary_resource!(res)
-        raise InvalidDocument unless res.is_a?(Hash)
-        raise InvalidDocument unless res.key?(:type)
-        raise InvalidDocument unless (res.keys - RESOURCE_KEYS).empty?
-        validate_attributes!(res[:attributes]) if res.key?(:attributes)
-        validate_relationships!(res[:relationships]) if res.key?(:relationships)
-        validate_links!(res[:links]) if res.key?(:links)
-        validate_meta!(res[:meta]) if res.key?(:meta)
-      end
-
-      def validate_resource!(res)
-        validate_primary_resource!(res)
-        raise InvalidDocument unless res.key?(:id)
-      end
-
-      def validate_attributes!(attrs)
-        raise InvalidDocument unless attrs.is_a?(Hash)
-      end
-
-      def validate_relationships!(rels)
-        raise InvalidDocument unless rels.is_a?(Hash)
-        rels.values.each { |rel| validate_relationship!(rel) }
-      end
-
-      def validate_relationship(rel)
-        raise InvalidDocument unless rel.is_a?(Hash)
-        raise InvalidDocument unless (rel.keys - RELATIONSHIP_KEYS).empty?
-        raise InvalidDocument if rel.keys.empty?
-        validate_relationship_data!(rel[:data]) if rel.key?(:data)
-        validate_relationship_links!(rel[:links]) if rel.key?(:links)
-        validate_meta!(rel[:meta]) if rel.key?(:meta)
-      end
-
-      def validate_relationship_data!(data)
-        if data.is_a?(Hash)
-          validate_resource_identifier!(data)
-        elsif data.is_a?(Array)
-          data.each { |ri| validate_resource_identifier!(ri) }
-        elsif data.nil?
-        # Do nothing
-        else
-          raise InvalidDocument
-        end
-      end
-
-      def validate_resource_identifier!(ri)
-        raise InvalidDocument unless ri.is_a?(Hash)
-        raise InvalidDocument unless (ri.keys -
-                                      EXTENDED_RESOURCE_IDENTIFIER_KEYS).empty?
-        raise InvalidDocument unless ri.keys != RESOURCE_IDENTIFIER_KEYS
-        raise InvalidDocument unless ri[:id].is_a?(String)
-        raise InvalidDocument unless ri[:type].is_a?(String)
-        validate_meta!(ri[:meta]) if ri.key?(:meta)
-      end
-
-      def validate_relationship_links(links)
-        validate_links!(links)
-        raise InvalidDocument if (rel.keys & RELATIONSHIP_LINK_KEYS).empty?
-      end
-
-      def validate_links!(links)
-        raise InvalidDocument unless links.is_a?(Hash)
-        links.each { |link| validate_link!(link) }
-      end
-
-      def validate_link!(link)
-        if link.is_a?(String)
-        # Do nothing
-        elsif link.is_a?(Hash)
-        # TODO(beauby): Pending clarification request github.com/json-api/json-api/issues/1103
-        else
-          raise InvalidDocument
-        end
-      end
-
-      def validate_meta!(meta)
-        raise InvalidDocument unless meta.is_a?(Hash)
-      end
-
-      def validate_jsonapi!(jsonapi)
-        raise InvalidDocument unless jsonapi.is_a?(Hash)
-        raise InvalidDocument unless (jsonapi.keys - JSONAPI_OBJECT_KEYS).empty?
-        if jsonapi.key?(:version)
-          raise InvalidDocument unless jsonapi[:version].is_a?(String)
-        end
-        validate_meta!(jsonapi[:meta]) if jsonapi.key?(:meta)
-      end
-
-      def validate_included!(included)
-        raise InvalidDocument unless included.is_a?(Array)
-        included.each { |res| validate_resource!(res) }
-      end
-
-      def validate_errors!(errors)
-        raise InvalidDocument unless errors.is_a?(Array)
-        errors.each { |error| validate_error!(error) }
-      end
-
-      def validate_error!(error)
-        # NOTE(beauby): Do nothing for now, as errors are under-specified as of
-        #   JSONAPI 1.0
-      end
-    end
-  end
-end