jsonapi 0.1.1.beta2 → 0.1.1.beta6

data/lib/jsonapi/relationships.rb

@@ -1,41 +0,0 @@
-module JSONAPI
-  # c.f. http://jsonapi.org/format/#document-resource-object-relationships
-  class Relationships
-    include Enumerable
-
-    def initialize(relationships_hash, options = {})
-      fail InvalidDocument,
-           "the value of 'relationships' MUST be an object" unless
-        relationships_hash.is_a?(Hash)
-
-      @hash = relationships_hash
-      @relationships = {}
-      relationships_hash.each do |rel_name, rel_hash|
-        @relationships[rel_name.to_s] = Relationship.new(rel_hash, options)
-        define_singleton_method(rel_name) do
-          @relationships[rel_name.to_s]
-        end
-      end
-    end
-
-    def to_hash
-      @hash
-    end
-
-    def each(&block)
-      @relationships.each(&block)
-    end
-
-    def [](rel_name)
-      @relationships[rel_name.to_s]
-    end
-
-    def defined?(rel_name)
-      @relationships.key?(rel_name.to_s)
-    end
-
-    def keys
-      @relationships.keys
-    end
-  end
-end

data/lib/jsonapi/resource.rb

@@ -1,46 +0,0 @@
-module JSONAPI
-  # c.f. http://jsonapi.org/format/#document-resource-objects
-  class Resource
-    attr_reader :id, :type, :attributes, :relationships, :links, :meta
-
-    def initialize(resource_hash, options = {})
-      @hash = resource_hash
-      @options = options.dup
-      @id_optional = @options.delete(:id_optional)
-      validate!(resource_hash)
-      @id = resource_hash['id']
-      @type = resource_hash['type']
-      @attributes_hash = resource_hash['attributes'] || {}
-      @attributes = Attributes.new(@attributes_hash, @options)
-      @relationships_hash = resource_hash['relationships'] || {}
-      @relationships = Relationships.new(@relationships_hash, @options)
-      @links_hash = resource_hash['links'] || {}
-      @links = Links.new(@links_hash, @options)
-      @meta = resource_hash['meta'] if resource_hash.key?('meta')
-    end
-
-    def to_hash
-      @hash
-    end
-
-    private
-
-    def validate!(resource_hash)
-      case
-      when !@id_optional && !resource_hash.key?('id')
-        # We might want to take care of
-        # > Exception: The id member is not required when the resource object
-        # > originates at the client and represents a new resource to be created
-        # > on the server.
-        # in the future.
-        fail InvalidDocument, "a resource object MUST contain an 'id'"
-      when !@id_optional && !resource_hash['id'].is_a?(String)
-        fail InvalidDocument, "the value of 'id' MUST be a string"
-      when !resource_hash.key?('type')
-        fail InvalidDocument, "a resource object MUST contain a 'type'"
-      when !resource_hash['type'].is_a?(String)
-        fail InvalidDocument, "the value of 'type' MUST be a string"
-      end
-    end
-  end
-end

data/lib/jsonapi/resource_identifier.rb

@@ -1,36 +0,0 @@
-module JSONAPI
-  # c.f. http://jsonapi.org/format/#document-resource-identifier-objects
-  class ResourceIdentifier
-    attr_reader :id, :type
-
-    def initialize(resource_identifier_hash, options = {})
-      @hash = resource_identifier_hash
-
-      validate!(resource_identifier_hash)
-
-      @id = resource_identifier_hash['id']
-      @type = resource_identifier_hash['type']
-    end
-
-    def to_hash
-      @hash
-    end
-
-    private
-
-    def validate!(resource_identifier_hash)
-      case
-      when !resource_identifier_hash.key?('id')
-        fail InvalidDocument,
-             "a resource identifier object MUST contain an 'id'"
-      when !resource_identifier_hash['id'].is_a?(String)
-        fail InvalidDocument, "the value of 'id' MUST be a string"
-      when !resource_identifier_hash.key?('type')
-        fail InvalidDocument,
-             "a resource identifier object MUST contain a 'type'"
-      when !resource_identifier_hash['type'].is_a?(String)
-        fail InvalidDocument, "the value of 'type' MUST be a string"
-      end
-    end
-  end
-end

data/lib/jsonapi/version.rb

@@ -1,3 +0,0 @@
-module JSONAPI
-  VERSION = '0.1.1.beta2'.freeze
-end

data/spec/duplicates_spec.rb

@@ -1,95 +0,0 @@
-require 'jsonapi'
-
-describe JSONAPI, '#parse' do
-  it 'succeeds when there are no duplicates' do
-    payload = {
-      'data' => [
-        {
-          'type' => 'articles',
-          'id' => '1',
-          'attributes' => {
-            'title' => 'JSON API paints my bikeshed!'
-          },
-          'links' => {
-            'self' => 'http://example.com/articles/1'
-          },
-          'relationships' => {
-            'author' => {
-              'links' => {
-                'self' => 'http://example.com/articles/1/relationships/author',
-                'related' => 'http://example.com/articles/1/author'
-              },
-              'data' => { 'type' => 'people', 'id' => '9' }
-            },
-            'journal' => {
-              'data' => nil
-            },
-            'comments' => {
-              'links' => {
-                'self' => 'http://example.com/articles/1/relationships/comments',
-                'related' => 'http://example.com/articles/1/comments'
-              },
-              'data' => [
-                { 'type' => 'comments', 'id' => '5' },
-                { 'type' => 'comments', 'id' => '12' }
-              ]
-            }
-          }
-        }]
-    }
-
-    JSONAPI.parse(payload, verify_duplicates: true)
-  end
-
-  it 'fails when there are duplicates within primary data' do
-    payload = {
-      'data' => [
-        {
-          'type' => 'articles',
-          'id' => '1'
-        }, {
-          'type' => 'articles',
-          'id' => '1'
-        }]
-    }
-
-    expect { JSONAPI.parse(payload, verify_duplicates: true) }
-      .to raise_error(JSONAPI::InvalidDocument)
-  end
-
-  it 'fails when there are duplicates within included' do
-    payload = {
-      'data' => nil,
-      'included' => [
-        {
-          'type' => 'articles',
-          'id' => '1'
-        }, {
-          'type' => 'articles',
-          'id' => '1'
-        }]
-    }
-
-    expect { JSONAPI.parse(payload, verify_duplicates: true) }
-      .to raise_error(JSONAPI::InvalidDocument)
-  end
-
-  it 'fails when there are duplicates within primary data' do
-    payload = {
-      'data' => [
-        {
-          'type' => 'articles',
-          'id' => '1'
-        }
-      ],
-      'included' => [
-        {
-          'type' => 'articles',
-          'id' => '1'
-        }]
-    }
-
-    expect { JSONAPI.parse(payload, verify_duplicates: true) }
-      .to raise_error(JSONAPI::InvalidDocument)
-  end
-end

data/spec/full_linkage_spec.rb

@@ -1,161 +0,0 @@
-require 'jsonapi'
-
-describe JSONAPI, '#parse' do
-  it 'succeeds when no included property is provided' do
-    payload = {
-      'data' => [
-        {
-          'type' => 'articles',
-          'id' => '1',
-          'attributes' => {
-            'title' => 'JSON API paints my bikeshed!'
-          },
-          'links' => {
-            'self' => 'http://example.com/articles/1'
-          },
-          'relationships' => {
-            'author' => {
-              'links' => {
-                'self' => 'http://example.com/articles/1/relationships/author',
-                'related' => 'http://example.com/articles/1/author'
-              },
-              'data' => { 'type' => 'people', 'id' => '9' }
-            },
-            'journal' => {
-              'data' => nil
-            },
-            'comments' => {
-              'links' => {
-                'self' => 'http://example.com/articles/1/relationships/comments',
-                'related' => 'http://example.com/articles/1/comments'
-              },
-              'data' => [
-                { 'type' => 'comments', 'id' => '5' },
-                { 'type' => 'comments', 'id' => '12' }
-              ]
-            }
-          }
-        }]
-    }
-
-    JSONAPI.parse(payload, verify_linkage: true)
-  end
-
-  it 'succeeds when full linkage is respected' do
-    payload = {
-      'data' => [
-        {
-          'type' => 'articles',
-          'id' => '1',
-          'attributes' => {
-            'title' => 'JSON API paints my bikeshed!'
-          },
-          'links' => {
-            'self' => 'http://example.com/articles/1'
-          },
-          'relationships' => {
-            'author' => {
-              'links' => {
-                'self' => 'http://example.com/articles/1/relationships/author',
-                'related' => 'http://example.com/articles/1/author'
-              },
-              'data' => { 'type' => 'people', 'id' => '9' }
-            },
-            'journal' => {
-              'data' => nil
-            },
-            'comments' => {
-              'links' => {
-                'self' => 'http://example.com/articles/1/relationships/comments',
-                'related' => 'http://example.com/articles/1/comments'
-              },
-              'data' => [
-                { 'type' => 'comments', 'id' => '5' },
-                { 'type' => 'comments', 'id' => '12' }
-              ]
-            }
-          }
-        }],
-      'included' => [
-        {
-          'type' => 'comments',
-          'id' => '5'
-        }, {
-          'type' => 'comments',
-          'id' => '12'
-        }, {
-          'type' => 'comments',
-          'id' => '13'
-        }, {
-          'type' => 'people',
-          'id' => '9',
-          'relationships' => {
-            'comments' => {
-              'data' => [
-                {
-                  'type' => 'comments',
-                  'id' => '13'
-                }
-              ]
-            }
-          }
-        }
-      ]
-    }
-
-    JSONAPI.parse(payload, verify_linkage: true)
-  end
-
-  it 'fails when full linkage is not respected' do
-    payload = {
-      'data' => [
-        {
-          'type' => 'articles',
-          'id' => '1',
-          'attributes' => {
-            'title' => 'JSON API paints my bikeshed!'
-          },
-          'links' => {
-            'self' => 'http://example.com/articles/1'
-          },
-          'relationships' => {
-            'author' => {
-              'links' => {
-                'self' => 'http://example.com/articles/1/relationships/author',
-                'related' => 'http://example.com/articles/1/author'
-              },
-              'data' => { 'type' => 'people', 'id' => '9' }
-            },
-            'journal' => {
-              'data' => nil
-            },
-            'comments' => {
-              'links' => {
-                'self' => 'http://example.com/articles/1/relationships/comments',
-                'related' => 'http://example.com/articles/1/comments'
-              },
-              'data' => [
-                { 'type' => 'comments', 'id' => '5' },
-                { 'type' => 'comments', 'id' => '12' }
-              ]
-            }
-          }
-        }],
-      'included' => [
-        {
-          'type' => 'comments',
-          'id' => '5'
-        }, {
-          'type' => 'comments',
-          'id' => '12'
-        }, {
-          'type' => 'comments',
-          'id' => '13'
-        }
-      ]
-    }
-
-    expect { JSONAPI.parse(payload, verify_linkage: true) }
-      .to raise_error(JSONAPI::InvalidDocument)
-  end
-end

data/spec/include_directive/parser_spec.rb

@@ -1,59 +0,0 @@
-require 'jsonapi/include_directive'
-
-describe JSONAPI::IncludeDirective::Parser, '.parse_include_args' do
-  it 'handles arrays of symbols and hashes' do
-    args = [:friends,
-            comments: [:author],
-            posts: [:author,
-                    comments: [:author]]]
-    hash = JSONAPI::IncludeDirective::Parser.parse_include_args(args)
-    expected = {
-      friends: {},
-      comments: { author: {} },
-      posts: { author: {}, comments: { author: {} } }
-    }
-
-    expect(hash).to eq expected
-  end
-
-  it 'handles strings with spaces' do
-    str = 'friends, comments.author, posts.author, posts.comments.author'
-    hash = JSONAPI::IncludeDirective::Parser.parse_include_args(str)
-    expected = {
-      friends: {},
-      comments: { author: {} },
-      posts: { author: {}, comments: { author: {} } }
-    }
-
-    expect(hash).to eq expected
-  end
-
-  it 'handles common prefixes in strings' do
-    args = ['friends', 'comments.author', 'posts.author',
-            'posts.comments.author']
-    hash = JSONAPI::IncludeDirective::Parser.parse_include_args(args)
-    expected = {
-      friends: {},
-      comments: { author: {} },
-      posts: { author: {}, comments: { author: {} } }
-    }
-
-    expect(hash).to eq expected
-  end
-
-  it 'handles an empty string' do
-    args = ''
-    hash = JSONAPI::IncludeDirective::Parser.parse_include_args(args)
-    expected = {}
-
-    expect(hash).to eq expected
-  end
-
-  it 'handles an empty array' do
-    args = []
-    hash = JSONAPI::IncludeDirective::Parser.parse_include_args(args)
-    expected = {}
-
-    expect(hash).to eq expected
-  end
-end