json_api_ruby 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 018c57ac3ac726a576720f582783604eb22151a7
-  data.tar.gz: c8d50c7117d9b54654ad484b7e011e82a8402c8b
+  metadata.gz: 0061d47ce650e9fcb4fb372e55830c44ffc2ee84
+  data.tar.gz: e21dcd60e6302c6cfc8c206fcd84cf15fad78ddb
 SHA512:
-  metadata.gz: c40fd216bd9f2809c83bf7ecf47372b23772747fb5827c373d52d357a4a22b05b8f03a97eb62a85e1816f6c87009ea32c8e28a5ede090dda103375f428bae8d8
-  data.tar.gz: 8ea27ee8bb37753a4a8aa098d1529a69a0feff3d49d7b859dc3d2300bc14f68c5ddeb051eb90ea12162c0532907806b5505196d16e2e8076bdf0af84895746ab
+  metadata.gz: 955e5c106e646ca173aa3b31b3f292abdc43d3122928aa856a52f7d09354d97f818b530a03e2cacfb7cf931341e9886f4664ea9205c4dc0525f2bcbfc8f59b94
+  data.tar.gz: c3e643b234cf81c68b5bbbcc0924f128e5364ec4500807c4d9b69eb71090dc84d9e67d755176ede994ec4cbe106a3628ba27925073e002d73d14b06a2a75e6e4

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+0.4.1
+Some major refactoring but no backwards compatibility breaking functionality
+
 0.4.0
 Add support for nested includes and link enabling/disabling
 

data/lib/json_api_ruby/association.rb

@@ -0,0 +1,58 @@
+module JsonApi
+  class Association
+    # The resource object that "owns" this relationship
+    #
+    # Example:
+    #   class ArticleResource < JsonApi::Resource
+    #     has_one :author
+    #   end
+    #
+    # `ArticleResource` is the parent of the author object
+    attr_reader :parent
+    attr_reader :parent_model
+
+    # Determines whether the `data` attribute should be filled out and
+    # included
+    attr_reader :included
+    attr_reader :name
+    attr_reader :explicit_resource_class
+
+
+    # The resource object that represents this relationship
+    attr_reader :resources
+
+    def initialize(name, options)
+      @name = name
+      @resources = []
+      @parent = options.fetch(:parent_resource)
+      @parent_model = parent._model
+      @included = options.fetch(:included, JsonApi::Includes.new)
+      @explicit_resource_class = options.fetch(:explicit_resource_class)
+    end
+
+    def included?
+      included.has_name?(@name)
+    end
+
+    def to_hash
+      return_hash = {}
+      return_hash.merge!(relationship_links) if JsonApi.configuration.use_links
+      return_hash.merge!(data) if included?
+      return_hash
+    end
+
+    def relationship_links
+      {
+        'links' => {
+          'self' => JsonApi.configuration.base_url + parent.self_link_path + "/relationships/#{name}",
+          'related' => JsonApi.configuration.base_url + parent.self_link_path + "/#{name}"
+        }
+      }
+    end
+  end
+end
+
+require_relative 'associations/meta'
+require_relative 'associations/to_one'
+require_relative 'associations/to_many'
+

data/lib/json_api_ruby/associations/meta.rb

@@ -0,0 +1,48 @@
+module JsonApi
+  module Associations
+    UnknownCardinalityError = Class.new(StandardError)
+
+    class Meta
+      TO_ONE = :one
+      TO_MANY = :many
+      CARDINALITY = [TO_ONE, TO_MANY]
+
+      # The name of this relationship.
+      #
+      # This name comes from the resource object that defines the
+      # relationship. Example:
+      #
+      #   class ArticleResource < JsonApi::Resource
+      #     has_one :author # this is the name of this relationship
+      #   end
+      attr_reader :name
+
+      attr_reader :cardinality
+
+      attr_reader :explicit_resource_class
+
+      def initialize(name, resource_class: nil, cardinality:)
+        @name = name.to_s
+        validate_cardinality(cardinality)
+        @cardinality = cardinality
+        @explicit_resource_class = resource_class
+      end
+
+      def validate_cardinality(cardinality)
+        unless(CARDINALITY.include?(cardinality))
+          fail UnknownCardinalityError.new
+        end
+      end
+
+      def build_resources(options)
+        if cardinality == TO_ONE
+          relationship = ToOne.new(name, options.merge(explicit_resource_class: explicit_resource_class))
+        else
+          relationship = ToMany.new(name, options.merge(explicit_resource_class: explicit_resource_class))
+        end
+        relationship.build_resources(options)
+        relationship
+      end
+    end
+  end
+end

data/lib/json_api_ruby/associations/to_many.rb

@@ -0,0 +1,30 @@
+module JsonApi
+  module Associations
+    class ToMany < JsonApi::Association
+      def data(options={})
+        data = resource_objects.map do |object|
+          object.identifier_hash
+        end
+        {'data' => data}
+      end
+
+      # Build the related resources
+      def build_resources(options)
+        return unless included?
+
+        parent_model.send(name).each do |resource_model|
+          resource_class = JsonApi::Resources::Discovery.resource_for_name(resource_model, options.merge(parent_resource: parent, resource_class: explicit_resource_class))
+          @resources << resource_class.new(resource_model, options.merge({include: included.next}))
+        end
+      end
+
+      def resource_objects
+        @resources
+      end
+
+      def cardinality
+        :many
+      end
+    end
+  end
+end

data/lib/json_api_ruby/associations/to_one.rb

@@ -0,0 +1,28 @@
+module JsonApi
+  module Associations
+    # convenience classes
+    class ToOne < JsonApi::Association
+      def data(options={})
+        identifier_hash = resource_object.identifier_hash if resource_object
+        {'data' => identifier_hash}
+      end
+
+      def build_resources(options)
+        return unless included?
+        resource_model = parent_model.send(name)
+        return if resource_model.blank?
+
+        resource_class = JsonApi::Resources::Discovery.resource_for_name(resource_model, options.merge(parent_resource: parent, resource_class: explicit_resource_class))
+        @resources << resource_class.new(resource_model, options.merge({include: included.next}))
+      end
+
+      def resource_object
+        @resources.first
+      end
+
+      def cardinality
+        :one
+      end
+    end
+  end
+end

data/lib/json_api_ruby/includes.rb

@@ -3,7 +3,7 @@ module JsonApi
   class Includes
     attr_reader :name
     attr_writer :includes
-    attr_accessor :next
+    attr_writer :next
 
     # Returns:
     #   #<Includes>
@@ -20,17 +20,27 @@ module JsonApi
       zipped = first_array.zip(*other_arrays)
       first_array = zipped.shift
       first_include.includes = first_array.uniq.compact
+
       zipped.inject(first_include) do |base_include, object_name|
         new_include = self.new
         new_include.includes = object_name.uniq.compact
         base_include.next = new_include
         new_include
       end
+
       first_include
     end
 
+    def has_name?(name)
+      includes.include?(name)
+    end
+
     def includes
       @includes || []
     end
+
+    def next
+      @next || self.class.new
+    end
   end
 end

data/lib/json_api_ruby/resource.rb

@@ -1,5 +1,4 @@
 require_relative 'resources/base'
-require_relative 'resources/relationships'
 require_relative 'resources/dsl'
 
 module JsonApi
@@ -58,7 +57,7 @@ module JsonApi
     def initialize(model, options={})
       options.stringify_keys!
       @_model = model
-      @includes = options.fetch('include', [])
+      @includes = options.fetch('include', Includes.new)
       build_object_graph # base module method
     end
   end

data/lib/json_api_ruby/resources/dsl.rb

@@ -37,7 +37,7 @@ module JsonApi
       private
       def add_relationship(object_name, cardinality, options)
         @relationships ||= []
-        @relationships << RelationshipMeta.new(object_name, options.merge(cardinality: cardinality))
+        @relationships << JsonApi::Associations::Meta.new(object_name, options.merge(cardinality: cardinality))
         create_accessor_methods(object_name)
       end
 

data/lib/json_api_ruby/serializer.rb

@@ -25,7 +25,7 @@ module JsonApi
     def initialize(object, options)
       @meta           = options.fetch('meta', Hash.new).stringify_keys
       @object         = object
-      @includes       = options.fetch('include', [])
+      @includes       = options.fetch('include', Includes.new)
       @resource_class = options.fetch('resource_class', nil)
     end
 

data/lib/json_api_ruby/version.rb

@@ -1,3 +1,3 @@
 module JsonApi
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

data/lib/json_api_ruby.rb

@@ -3,6 +3,7 @@ end
 
 require_relative 'json_api_ruby/error_resource'
 require_relative 'json_api_ruby/serializer'
+require_relative 'json_api_ruby/association'
 require_relative 'json_api_ruby/resource'
 require_relative 'json_api_ruby/exceptions'
 require_relative 'json_api_ruby/configuration'

data/spec/json_api_ruby/association_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+
+describe JsonApi::Association do
+   let(:article) do
+     Article.new('How to raise Triops', 'Triops are hardy little creatures whose eggs can be frozen for as long as 40 years')
+   end
+ 
+   let(:article_resource) do
+     ArticleResource.new(article)
+   end
+ 
+   let(:author_relation) do
+     article_resource.class.relationships.find do |rel|
+       rel.name == 'author'
+     end
+   end
+ 
+   let(:comments_relation) do
+     article_resource.class.relationships.find do |rel|
+       rel.name == 'comments'
+     end
+   end
+ 
+   it 'exposes its cardinality' do
+     expect(author_relation.cardinality).to eq :one
+     expect(comments_relation.cardinality).to eq :many
+   end
+ 
+   describe 'link serialization' do
+     subject(:links_object) do
+       rel = author_relation.build_resources(parent_resource: article_resource)
+       rel.to_hash
+     end
+ 
+     it 'includes a links object' do
+       expect(links_object).to include('links')
+     end
+ 
+     it 'has a "self" object' do
+       expect(links_object['links']).to include('self')
+     end
+ 
+     it 'has a "related" object' do
+       expect(links_object['links']).to include('related')
+     end
+ 
+     describe 'self object' do
+       it 'is a link to the relationship on the parent object' do
+         expect(links_object['links']['self']).to eq "http://localhost:3000/articles/#{article.uuid}/relationships/author"
+       end
+     end
+ 
+     describe 'related object' do
+       it 'is a link to the base resource of the related object' do
+         expect(links_object['links']['related']).to eq "http://localhost:3000/articles/#{article.uuid}/author"
+       end
+     end
+ 
+     context 'with links turned off' do
+       before { JsonApi.configuration.use_links = false }
+       after { JsonApi.configuration.use_links = true }
+       it 'returns an empty hash' do
+         expect(links_object['links']).to be_blank
+       end
+     end
+   end
+ 
+   describe 'data serialization' do
+     let(:included_data) { JsonApi::Includes.parse_includes('author') }
+     subject(:serialized_object) do
+       rel = author_relation.build_resources(parent_resource: article_resource, included: included_data)
+       rel.to_hash
+     end
+ 
+     it 'has a data top level object' do
+       expect(serialized_object).to include('data')
+     end
+ 
+     describe 'data object' do
+       context 'when an array' do
+         let(:included_data) { JsonApi::Includes.parse_includes('comments') }
+         subject(:serialized_object) do
+           rel = comments_relation.build_resources(parent_resource: article_resource, included: included_data)
+           rel.to_hash
+         end
+ 
+         it 'has an identity hash for each object' do
+           expect(serialized_object['data'].flat_map(&:keys).uniq).to eq ['id', 'type']
+         end
+       end
+ 
+       context 'when a single object' do
+         it 'has an identity hash' do
+           expect(serialized_object['data'].keys).to eq ['id', 'type']
+         end
+       end
+     end
+   end
+ 
+   describe 'identity hash' do
+     let(:included_data) { JsonApi::Includes.parse_includes('author') }
+     it 'returns an identity hash given a model and parent resource' do
+       rel = author_relation.build_resources(parent_resource: article_resource, included: included_data)
+       serialized_object = rel.to_hash
+       expect(serialized_object['data'].keys).to eq ['id', 'type']
+     end
+   end
+ 
+   describe 'relationship serialization' do
+     context 'when the option "include" is true' do
+     let(:included_data) { JsonApi::Includes.parse_includes('author') }
+       it 'includes the data object' do
+         rel = author_relation.build_resources(parent_resource: article_resource, included: included_data)
+         serialized_data = rel.to_hash
+         expect(serialized_data).to include('data')
+       end
+     end
+ 
+     context 'when the option "include" is falsey' do
+       it 'does not include data object' do
+         rel = author_relation.build_resources(parent_resource: article_resource)
+         serialized_data = rel.to_hash
+         expect(serialized_data).to_not include('data')
+       end
+     end
+   end
+ 
+   describe 'passing in a resource class' do
+     let(:simple_article_resource) do
+       SimpleArticleResource.new(article, include: JsonApi::Includes.parse_includes(['author', 'comments']))
+     end
+ 
+     let(:author_relation) do
+       simple_article_resource.relationships.find do |rel|
+         rel.name == 'author'
+       end
+     end
+ 
+     let(:comment_relation) do
+       simple_article_resource.relationships.find do |rel|
+         rel.name == 'comments'
+       end
+     end
+ 
+     it 'uses the passed in resource_class for author' do
+       expect(author_relation.resource_object).to be_an_instance_of(SimplePersonResource)
+     end
+ 
+     it 'uses the passed in resource_class for each comment' do
+       comment_relation.resource_objects.each do |resource_object|
+         expect(resource_object).to be_an_instance_of(SimpleCommentResource)
+       end
+     end
+   end
+end

data/spec/json_api_ruby/associations/meta_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe JsonApi::Associations::Meta do
+  let(:parent_resource) { PersonResource.new(:person) }
+  it 'fails on an invalid cardinality' do
+    expect { JsonApi::Associations::Meta.new('person', resource_class: PersonResource, cardinality: :yeahbuddy) }.to raise_error(JsonApi::Associations::UnknownCardinalityError)
+  end
+
+  it 'builds a ToOne association' do
+    new_meta = JsonApi::Associations::Meta.new('person', resource_class: PersonResource, cardinality: :one)
+    expect(new_meta.build_resources({parent_resource: parent_resource})).to be_a(JsonApi::Associations::ToOne)
+  end
+
+  it 'builds a ToMany association' do
+    new_meta = JsonApi::Associations::Meta.new('person', resource_class: PersonResource, cardinality: :many)
+    expect(new_meta.build_resources({parent_resource: parent_resource})).to be_a(JsonApi::Associations::ToMany)
+  end
+end

data/spec/json_api_ruby/associations/to_many_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+class ResourceObject
+  def identifier_hash
+    {}
+  end
+end
+
+describe JsonApi::Associations::ToMany do
+  subject(:assoc_instance) do
+    assoc = described_class.new('tomanytest', parent_resource: double('person_resource', _model: nil), explicit_resource_class: nil)
+    assoc.instance_variable_set(:@resources, [ResourceObject.new])
+    assoc
+  end
+
+  it 'builds a data hash' do
+    expect(assoc_instance.data).to eq({'data' => [{}]})
+  end
+
+  it 'returns nil when no resources are present' do
+    assoc = described_class.new('toonetest', parent_resource: double('person_resource', _model: nil), explicit_resource_class: nil)
+    expect(assoc.data).to eq({'data' => []})
+  end
+
+  it 'returns its resource objects' do
+    expect(assoc_instance.resource_objects).to be_an Array
+  end
+
+  it 'returns `many` for its cardinality' do
+    expect(assoc_instance.cardinality).to eq :many
+  end
+
+  context 'is included' do
+    it 'builds its included resources' do
+      article = Article.new('How to raise Triops', 'Triops are hardy little creatures whose eggs can be frozen for as long as 40 years')
+      article_resource = ArticleResource.new(article)
+      options = {
+        parent_resource: article_resource,
+        explicit_resource_class: CommentResource,
+        included: JsonApi::Includes.parse_includes(['comments'])
+      }
+      comment_assoc = described_class.new('comments', options)
+      comment_assoc.build_resources(options)
+      expect(comment_assoc.resource_objects.count).to eq article.comments.count
+    end
+  end
+
+  context 'is not included' do
+    it 'returns nil' do
+      article = Article.new('How to raise Triops', 'Triops are hardy little creatures whose eggs can be frozen for as long as 40 years')
+      article_resource = ArticleResource.new(article)
+      options = {
+        parent_resource: article_resource,
+        explicit_resource_class: CommentResource
+      }
+      comment_assoc = described_class.new('comments', options)
+      comment_assoc.build_resources(options)
+      expect(comment_assoc.resource_objects.count).to eq 0
+    end
+  end
+end

data/spec/json_api_ruby/associations/to_one_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+class ResourceObject
+  def identifier_hash
+    {}
+  end
+end
+
+describe JsonApi::Associations::ToOne do
+  subject(:assoc_instance) do
+    assoc = described_class.new('toonetest', parent_resource: double('person_resource', _model: nil), explicit_resource_class: nil)
+    assoc.instance_variable_set(:@resources, [ResourceObject.new])
+    assoc
+  end
+
+  it 'builds a data hash' do
+    expect(assoc_instance.data).to eq({'data' => {}})
+  end
+
+  it 'returns nil when no resources are present' do
+    assoc = described_class.new('toonetest', parent_resource: double('person_resource', _model: nil), explicit_resource_class: nil)
+    expect(assoc.data).to eq({'data' => nil})
+  end
+
+  it 'returns its resource objects' do
+    expect(assoc_instance.resource_object).to be_a ResourceObject
+  end
+
+  it 'returns `many` for its cardinality' do
+    expect(assoc_instance.cardinality).to eq :one
+  end
+
+  context 'is included' do
+    it 'builds its included resources' do
+      article = Article.new('How to raise Triops', 'Triops are hardy little creatures whose eggs can be frozen for as long as 40 years')
+      article_resource = ArticleResource.new(article)
+      options = {
+        parent_resource: article_resource,
+        explicit_resource_class: CommentResource,
+        included: JsonApi::Includes.parse_includes(['comments'])
+      }
+      comment_assoc = described_class.new('comments', options)
+      comment_assoc.build_resources(options)
+      expect(comment_assoc.resource_object).to be_a CommentResource
+    end
+  end
+
+  context 'is not included' do
+    it 'returns nil' do
+      article = Article.new('How to raise Triops', 'Triops are hardy little creatures whose eggs can be frozen for as long as 40 years')
+      article_resource = ArticleResource.new(article)
+      options = {
+        parent_resource: article_resource,
+        explicit_resource_class: CommentResource
+      }
+      comment_assoc = described_class.new('comments', options)
+      comment_assoc.build_resources(options)
+      expect(comment_assoc.resource_object).to be_nil
+    end
+  end
+end

data/spec/json_api_ruby/includes_spec.rb

@@ -4,7 +4,7 @@ describe JsonApi::Includes do
   context 'with nil' do
     subject(:parsed_with_nil) { described_class.parse_includes(nil) }
     specify { expect(parsed_with_nil.includes).to eq [] }
-    specify { expect(parsed_with_nil.next).to be_nil }
+    specify { expect(parsed_with_nil.next).to be_an_instance_of(JsonApi::Includes) }
   end
 
   context 'with nested resources using the "." syntax' do

data/spec/json_api_ruby/resources/relationships_spec.rb

@@ -1,155 +1,4 @@
 require 'spec_helper'
 
-RSpec.describe JsonApi::Resources::RelationshipMeta do
-  let(:article) do
-    Article.new('How to raise Triops', 'Triops are hardy little creatures whose eggs can be frozen for as long as 40 years')
-  end
-
-  let(:article_resource) do
-    ArticleResource.new(article)
-  end
-
-  let(:author_relation) do
-    article_resource.class.relationships.find do |rel|
-      rel.name == 'author'
-    end
-  end
-
-  let(:comments_relation) do
-    article_resource.class.relationships.find do |rel|
-      rel.name == 'comments'
-    end
-  end
-
-  it 'exposes its cardinality' do
-    expect(author_relation.cardinality).to eq :one
-    expect(comments_relation.cardinality).to eq :many
-  end
-
-  describe 'link serialization' do
-    subject(:links_object) do
-      rel = author_relation.build_resources(parent_resource: article_resource)
-      rel.to_hash
-    end
-
-    it 'includes a links object' do
-      expect(links_object).to include('links')
-    end
-
-    it 'has a "self" object' do
-      expect(links_object['links']).to include('self')
-    end
-
-    it 'has a "related" object' do
-      expect(links_object['links']).to include('related')
-    end
-
-    describe 'self object' do
-      it 'is a link to the relationship on the parent object' do
-        expect(links_object['links']['self']).to eq "http://localhost:3000/articles/#{article.uuid}/relationships/author"
-      end
-    end
-
-    describe 'related object' do
-      it 'is a link to the base resource of the related object' do
-        expect(links_object['links']['related']).to eq "http://localhost:3000/articles/#{article.uuid}/author"
-      end
-    end
-
-    context 'with links turned off' do
-      before { JsonApi.configuration.use_links = false }
-      after { JsonApi.configuration.use_links = true }
-      it 'returns an empty hash' do
-        expect(links_object['links']).to be_blank
-      end
-    end
-  end
-
-  describe 'data serialization' do
-    let(:included_data) { JsonApi::Includes.parse_includes('author') }
-    subject(:serialized_object) do
-      rel = author_relation.build_resources(parent_resource: article_resource, included: included_data)
-      rel.to_hash
-    end
-
-    it 'has a data top level object' do
-      expect(serialized_object).to include('data')
-    end
-
-    describe 'data object' do
-      context 'when an array' do
-        let(:included_data) { JsonApi::Includes.parse_includes('comments') }
-        subject(:serialized_object) do
-          rel = comments_relation.build_resources(parent_resource: article_resource, included: included_data)
-          rel.to_hash
-        end
-
-        it 'has an identity hash for each object' do
-          expect(serialized_object['data'].flat_map(&:keys).uniq).to eq ['id', 'type']
-        end
-      end
-
-      context 'when a single object' do
-        it 'has an identity hash' do
-          expect(serialized_object['data'].keys).to eq ['id', 'type']
-        end
-      end
-    end
-  end
-
-  describe 'identity hash' do
-    let(:included_data) { JsonApi::Includes.parse_includes('author') }
-    it 'returns an identity hash given a model and parent resource' do
-      rel = author_relation.build_resources(parent_resource: article_resource, included: included_data)
-      serialized_object = rel.to_hash
-      expect(serialized_object['data'].keys).to eq ['id', 'type']
-    end
-  end
-
-  describe 'relationship serialization' do
-    context 'when the option "include" is true' do
-    let(:included_data) { JsonApi::Includes.parse_includes('author') }
-      it 'includes the data object' do
-        rel = author_relation.build_resources(parent_resource: article_resource, included: included_data)
-        serialized_data = rel.to_hash
-        expect(serialized_data).to include('data')
-      end
-    end
-
-    context 'when the option "include" is falsey' do
-      it 'does not include data object' do
-        rel = author_relation.build_resources(parent_resource: article_resource)
-        serialized_data = rel.to_hash
-        expect(serialized_data).to_not include('data')
-      end
-    end
-  end
-
-  describe 'passing in a resource class' do
-    let(:simple_article_resource) do
-      SimpleArticleResource.new(article, include: JsonApi::Includes.parse_includes(['author', 'comments']))
-    end
-
-    let(:author_relation) do
-      simple_article_resource.relationships.find do |rel|
-        rel.name == 'author'
-      end
-    end
-
-    let(:comment_relation) do
-      simple_article_resource.relationships.find do |rel|
-        rel.name == 'comments'
-      end
-    end
-
-    it 'uses the passed in resource_class for author' do
-      expect(author_relation.resource_object).to be_an_instance_of(SimplePersonResource)
-    end
-
-    it 'uses the passed in resource_class for each comment' do
-      comment_relation.resource_objects.each do |resource_object|
-        expect(resource_object).to be_an_instance_of(SimpleCommentResource)
-      end
-    end
-  end
-end
+# RSpec.describe JsonApi::Resources::RelationshipMeta do
+# end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Tracey Eubanks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-27 00:00:00.000000000 Z
+date: 2016-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -111,6 +111,10 @@ files:
 - Rakefile
 - json_api_ruby.gemspec
 - lib/json_api_ruby.rb
+- lib/json_api_ruby/association.rb
+- lib/json_api_ruby/associations/meta.rb
+- lib/json_api_ruby/associations/to_many.rb
+- lib/json_api_ruby/associations/to_one.rb
 - lib/json_api_ruby/configuration.rb
 - lib/json_api_ruby/error_resource.rb
 - lib/json_api_ruby/exceptions.rb
@@ -119,9 +123,12 @@ files:
 - lib/json_api_ruby/resources/base.rb
 - lib/json_api_ruby/resources/discovery.rb
 - lib/json_api_ruby/resources/dsl.rb
-- lib/json_api_ruby/resources/relationships.rb
 - lib/json_api_ruby/serializer.rb
 - lib/json_api_ruby/version.rb
+- spec/json_api_ruby/association_spec.rb
+- spec/json_api_ruby/associations/meta_spec.rb
+- spec/json_api_ruby/associations/to_many_spec.rb
+- spec/json_api_ruby/associations/to_one_spec.rb
 - spec/json_api_ruby/configuration_spec.rb
 - spec/json_api_ruby/includes_spec.rb
 - spec/json_api_ruby/resource_spec.rb
@@ -157,6 +164,10 @@ signing_key:
 specification_version: 4
 summary: Extremely lightweight implementation of JSON API
 test_files:
+- spec/json_api_ruby/association_spec.rb
+- spec/json_api_ruby/associations/meta_spec.rb
+- spec/json_api_ruby/associations/to_many_spec.rb
+- spec/json_api_ruby/associations/to_one_spec.rb
 - spec/json_api_ruby/configuration_spec.rb
 - spec/json_api_ruby/includes_spec.rb
 - spec/json_api_ruby/resource_spec.rb

data/lib/json_api_ruby/resources/relationships.rb

@@ -1,140 +0,0 @@
-module JsonApi
-  module Resources
-
-    class RelationshipMeta
-      # The name of this relationship.
-      #
-      # This name comes from the resource object that defines the
-      # relationship. Example:
-      #
-      #   class ArticleResource < JsonApi::Resource
-      #     has_one :author # this is the name of this relationship
-      #   end
-      attr_reader :name
-
-      attr_reader :cardinality
-
-      attr_reader :explicit_resource_class
-
-      def initialize(name, options)
-        @name = name.to_s
-        @cardinality = options.fetch(:cardinality)
-        @explicit_resource_class = options.fetch(:resource_class, nil)
-      end
-
-      def build_resources(options)
-        if cardinality == :one
-          relationship = ToOneRelationship.new(name, options.merge(explicit_resource_class: explicit_resource_class))
-        else
-          relationship = ToManyRelationship.new(name, options.merge(explicit_resource_class: explicit_resource_class))
-        end
-        relationship.build_resources(options)
-        relationship
-      end
-    end
-
-    class Relationship
-      # The resource object that "owns" this relationship
-      #
-      # Example:
-      #   class ArticleResource < JsonApi::Resource
-      #     has_one :author
-      #   end
-      #
-      # `ArticleResource` is the parent of the author object
-      attr_reader :parent
-      attr_reader :parent_model
-
-      # Determines whether the `data` attribute should be filled out and
-      # included
-      attr_reader :included
-      attr_reader :name
-      attr_reader :explicit_resource_class
-
-
-      # The resource object that represents this relationship
-      attr_reader :resources
-
-      def initialize(name, options)
-        @name = name
-        @resources = []
-        @parent = options.fetch(:parent_resource)
-        @parent_model = parent._model
-        @included = options.fetch(:included, {})
-        @explicit_resource_class = options.fetch(:explicit_resource_class)
-      end
-
-      def included?
-        included.present? && included.includes.include?(@name)
-      end
-
-      def to_hash
-        return_hash = {}
-        return_hash.merge!(relationship_links) if JsonApi.configuration.use_links
-        return_hash.merge!(data) if included?
-        return_hash
-      end
-
-      def relationship_links
-        {
-          'links' => {
-            'self' => JsonApi.configuration.base_url + parent.self_link_path + "/relationships/#{name}",
-            'related' => JsonApi.configuration.base_url + parent.self_link_path + "/#{name}"
-          }
-        }
-      end
-    end
-
-    # convenience classes
-    class ToOneRelationship < Relationship
-      def data(options={})
-        identifier_hash = resource_object.identifier_hash if resource_object
-        {'data' => identifier_hash}
-      end
-
-      def build_resources(options)
-        return unless included?
-        resource_model = parent_model.send(name)
-        return if resource_model.blank?
-
-        resource_class = Discovery.resource_for_name(resource_model, options.merge(parent_resource: parent, resource_class: explicit_resource_class))
-        @resources << resource_class.new(resource_model, options.merge({include: included.next}))
-      end
-
-      def resource_object
-        @resources.first
-      end
-
-      def cardinality
-        :one
-      end
-    end
-
-    class ToManyRelationship < Relationship
-      def data(options={})
-        data = resource_objects.map do |object|
-          object.identifier_hash
-        end
-        {'data' => data}
-      end
-
-      # Build the related resources
-      def build_resources(options)
-        return unless included?
-
-        parent_model.send(name).each do |resource_model|
-          resource_class = Discovery.resource_for_name(resource_model, options.merge(parent_resource: parent, resource_class: explicit_resource_class))
-          @resources << resource_class.new(resource_model, options.merge({include: included.next}))
-        end
-      end
-
-      def resource_objects
-        @resources
-      end
-
-      def cardinality
-        :many
-      end
-    end
-  end
-end