json_api_ruby 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93d0c530dccb948d4cdf11fa26118dd0978b0626
-  data.tar.gz: 6b7a8f64ce75ea54cf1c3bb27396c2b0985762f0
+  metadata.gz: 018c57ac3ac726a576720f582783604eb22151a7
+  data.tar.gz: c8d50c7117d9b54654ad484b7e011e82a8402c8b
 SHA512:
-  metadata.gz: 9bcb3571eed27f46b3e24591231fa81a852c0ad9921f935974b1505960eb011517878b532f568f0105dd93ed3aac6907f8877e136cab484402e007ffadc9b2ff
-  data.tar.gz: 47fd20d365c1e555649e3a93d7d6dc0a644f8dd845be1df776342f73ca88c869dc4f36a48fca19bac7b800c8881910c17410e5f9bfec9602c3bf0f116e57f196
+  metadata.gz: c40fd216bd9f2809c83bf7ecf47372b23772747fb5827c373d52d357a4a22b05b8f03a97eb62a85e1816f6c87009ea32c8e28a5ede090dda103375f428bae8d8
+  data.tar.gz: 8ea27ee8bb37753a4a8aa098d1529a69a0feff3d49d7b859dc3d2300bc14f68c5ddeb051eb90ea12162c0532907806b5505196d16e2e8076bdf0af84895746ab

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+0.4.0
+Add support for nested includes and link enabling/disabling
+
 0.3.0
 Added `cardinality` instance method to `ToManyRelationship` and `ToOneRelationship`
 

data/lib/json_api_ruby.rb

@@ -6,3 +6,4 @@ require_relative 'json_api_ruby/serializer'
 require_relative 'json_api_ruby/resource'
 require_relative 'json_api_ruby/exceptions'
 require_relative 'json_api_ruby/configuration'
+require_relative 'json_api_ruby/includes'

data/lib/json_api_ruby/configuration.rb

@@ -1,9 +1,17 @@
 module JsonApi
   class Configuration
-    attr_reader :base_url
+    attr_accessor :base_url
+    attr_accessor :use_links
+
+    DEFAULTS = {
+      base_url: 'http://localhost:3000',
+      use_links: true
+    }
 
     def initialize
-      @base_url = 'http://localhost:3000'
+      DEFAULTS.each do |key, value|
+        self.instance_variable_set("@#{key}", value)
+      end
     end
   end
 

data/lib/json_api_ruby/includes.rb

@@ -0,0 +1,36 @@
+module JsonApi
+  # Builds a traversible representation of the included resources
+  class Includes
+    attr_reader :name
+    attr_writer :includes
+    attr_accessor :next
+
+    # Returns:
+    #   #<Includes>
+    def self.parse_includes(includes)
+      first_include = self.new
+
+      split_includes = Array(includes).map{|inc| inc.to_s.split('.')}
+      if split_includes.blank?
+        return first_include
+      end
+
+      first_array = Array(split_includes.first)
+      other_arrays = split_includes[1..-1]
+      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 includes
+      @includes || []
+    end
+  end
+end

data/lib/json_api_ruby/resource.rb

@@ -9,6 +9,7 @@ module JsonApi
 
     def self.inherited(subclass)
       subclass.id_field(@_id_field || :id)
+      subclass.use_links(@_use_links || JsonApi.configuration.use_links)
     end
 
     # Can be set using `id_field` in the created resource class like so:
@@ -27,6 +28,10 @@ module JsonApi
       _model.class.to_s.underscore.pluralize
     end
 
+    def use_links
+      self.class._use_links
+    end
+
     # Makes the underlying object available to subclasses so we can do things
     # like
     #
@@ -53,7 +58,7 @@ module JsonApi
     def initialize(model, options={})
       options.stringify_keys!
       @_model = model
-      @includes = Array.wrap(options.fetch('include', [])).map(&:to_s)
+      @includes = options.fetch('include', [])
       build_object_graph # base module method
     end
   end

data/lib/json_api_ruby/resources/base.rb

@@ -13,17 +13,10 @@ module JsonApi
           resource_hash['relationships'][relationship.name] = relationship.to_hash
         end
 
-        resource_hash['links'] = links_hash
+        resource_hash['links'] = links_hash if self.use_links
         resource_hash
       end
 
-      # Very basic. Eventually this will need to parse things like
-      # "article.comments" and "article-comments", so, leaving the method here
-      # but only supporting the most basic of things
-      def parse_for_includes(includes)
-        Array(includes).map(&:to_s)
-      end
-
       def identifier_hash
         { 'id' => self.id, 'type' =>  self.type }
       end
@@ -48,8 +41,7 @@ module JsonApi
       def build_object_graph
         @relationships ||= []
         relationships_array.each do |relationship|
-          included = includes.include?(relationship.name)
-          rel = relationship.build_resources({parent_resource: self, included: included})
+          rel = relationship.build_resources({parent_resource: self, included: includes})
           @relationships << rel
         end
       end

data/lib/json_api_ruby/resources/dsl.rb

@@ -2,6 +2,7 @@ module JsonApi
   module Resources
     module DSL
       attr :_id_field
+      attr :_use_links
       attr :fields
       attr :relationships
 
@@ -29,6 +30,10 @@ module JsonApi
         @_id_field = key
       end
 
+      def use_links(yesno)
+        @_use_links = yesno
+      end
+
       private
       def add_relationship(object_name, cardinality, options)
         @relationships ||= []

data/lib/json_api_ruby/resources/relationships.rb

@@ -60,21 +60,22 @@ module JsonApi
         @resources = []
         @parent = options.fetch(:parent_resource)
         @parent_model = parent._model
-        @included = options.fetch(:included, false)
+        @included = options.fetch(:included, {})
         @explicit_resource_class = options.fetch(:explicit_resource_class)
       end
 
       def included?
-        included == true
+        included.present? && included.includes.include?(@name)
       end
 
       def to_hash
-        return_hash = links
+        return_hash = {}
+        return_hash.merge!(relationship_links) if JsonApi.configuration.use_links
         return_hash.merge!(data) if included?
         return_hash
       end
 
-      def links
+      def relationship_links
         {
           'links' => {
             'self' => JsonApi.configuration.base_url + parent.self_link_path + "/relationships/#{name}",
@@ -97,7 +98,7 @@ module JsonApi
         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)
+        @resources << resource_class.new(resource_model, options.merge({include: included.next}))
       end
 
       def resource_object
@@ -123,7 +124,7 @@ module JsonApi
 
         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)
+          @resources << resource_class.new(resource_model, options.merge({include: included.next}))
         end
       end
 

data/lib/json_api_ruby/serializer.rb

@@ -14,86 +14,74 @@ module JsonApi
     if !object.nil? && object.respond_to?(:to_a)
       serializer = CollectionSerializer.new(object, options)
     else
-      serializer = Serializer.new(object, options)
+      serializer = ObjectSerializer.new(object, options)
     end
     serializer.to_hash
   end
 
   class Serializer
+    attr_reader :object
+
     def initialize(object, options)
       @meta           = options.fetch('meta', Hash.new).stringify_keys
       @object         = object
       @includes       = options.fetch('include', [])
-      resource_name   = "#{@object.class.to_s.underscore}_resource".classify
-      @resource_class = options.fetch('resource_class', resource_name)
+      @resource_class = options.fetch('resource_class', nil)
+    end
+
+    def resource(object)
+      resource_name  = "#{object.class.to_s.underscore}_resource".classify
+      klass_name     = @resource_class || resource_name
+      resource_klass = Resources::Discovery.resource_for_name(object, resource_class: klass_name)
+      resource_klass.new(object, include: Includes.parse_includes(@includes))
+    end
+
+    def assemble_included_data(included_resources)
+      included_resources.map(&:to_hash)
     end
 
+    def find_included_resources(object_resource)
+      included_resources = object_resource.relationships.select {|rel| rel.included?}.flat_map {|rel| rel.resources }
+      included_resources += included_resources.flat_map {|res| find_included_resources(res) }
+      included_resources.flatten
+      included_resources.uniq { |rel| rel.id + rel.type }
+    end
+  end
+
+  class ObjectSerializer < Serializer
     def to_hash
+      included_resources = []
       if @object.nil?
         serialized = { 'data' => nil }
       else
-        resource_klass = Resources::Discovery.resource_for_name(@object, resource_class: @resource_class)
-        resource       = resource_klass.new(@object, include: @includes)
-        serialized     = { 'data' => resource.to_hash }
-        relationships  = resource.relationships
-        included_data  = assemble_included_data(relationships)
-
-        if included_data.present?
-          included_data.uniq! do |inc_data|
-            inc_data['id'] + inc_data['type']
-          end
-          serialized['included'] = included_data
-        end
+        object_resource = resource(@object)
+        serialized = { 'data' => object_resource.to_hash }
+        included_resources += find_included_resources(object_resource)
       end
 
+      serialized['included'] = assemble_included_data(included_resources) if included_resources.present?
       serialized['meta'] = @meta if @meta.present?
-      serialized
-    end
 
-    def assemble_included_data(relationships)
-      relationships.flat_map do |relationship|
-        next if relationship.resources.blank?
-        relationship.resources.map(&:to_hash)
-      end.compact
+      serialized
     end
   end
 
-  class CollectionSerializer
-    def initialize(objects, options = {})
-      @meta           = options.fetch('meta', Hash.new).stringify_keys
-      @objects        = objects
-      @includes       = options.fetch('include', [])
-      @resource_class = options.fetch('resource_class', nil)
-    end
-
+  class CollectionSerializer < Serializer
     def to_hash
       serialized = {}
       included_resources = []
 
-      data_array = @objects.map do |object|
-        resource_name  = "#{object.class.to_s.underscore}_resource".classify
-        klass_name     = @resource_class || resource_name
-        resource_klass = Resources::Discovery.resource_for_name(object, resource_class: klass_name)
-        resource       = resource_klass.new(object, include: @includes)
-        included_resources += resource.relationships.select {|rel| rel.included?}.flat_map {|rel| rel.resources }
-
-        resource.to_hash
-      end
-
-      included_resources.uniq! do |rel|
-        rel.id + rel.type
+      data_array = Array(@object).map do |object|
+        object_resource = resource(object)
+        included_resources += find_included_resources(object_resource)
+        object_resource.to_hash
       end
 
       serialized['data'] = data_array
-
-      serialized['meta'] = @meta if @meta.present?
       serialized['included'] = assemble_included_data(included_resources) if included_resources.present?
+      serialized['meta'] = @meta if @meta.present?
 
       serialized
     end
-
-    def assemble_included_data(included_resources)
-      included_resources.map(&:to_hash)
-    end
   end
 end

data/lib/json_api_ruby/version.rb

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

data/spec/json_api_ruby/configuration_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe JsonApi::Configuration do
+  subject('configuration') { JsonApi.configuration }
+  specify { expect(subject.base_url).to eq 'http://localhost:3000' }
+  specify { expect(subject.use_links).to be_truthy }
+
+  it 'allows overidding the base url' do
+    subject.base_url = 'https://google.com'
+    expect(subject.base_url).to eq 'https://google.com'
+  end
+
+  it 'allows overidding the use_links option' do
+    subject.use_links = false
+    expect(subject.use_links).to be_falsy
+  end
+
+  after(:all) do
+    JsonApi.configuration.base_url = 'http://localhost:3000'
+    JsonApi.configuration.use_links = true
+  end
+end

data/spec/json_api_ruby/includes_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+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 }
+  end
+
+  context 'with nested resources using the "." syntax' do
+    it 'has an includes array' do
+      parsed_includes = described_class.parse_includes(['thingone', 'thingtwo'])
+      expect(parsed_includes.includes).to eq ['thingone', 'thingtwo']
+    end
+
+    it 'has a reference to nested objects' do
+      parsed_includes = described_class.parse_includes(['thingone.thingtwo'])
+      expect(parsed_includes.next.includes).to eq ['thingtwo']
+    end
+
+    it 'handles triple nesting' do
+      parsed_includes = described_class.parse_includes(['thingone.thingtwo.thingthree'])
+      expect(parsed_includes.next.next.includes).to eq ['thingthree']
+    end
+
+    context 'complex includes' do
+      subject(:parsed_includes) do
+        described_class.parse_includes(['thingone.thingtwo.thingthree', 'thingone.thingfour', 'thingone.thingtwo.thingfive', 'thingsix.thingseven'])
+      end
+
+      specify { expect(parsed_includes.includes).to eq ['thingone', 'thingsix'] }
+      specify { expect(parsed_includes.next.includes).to eq ['thingtwo', 'thingfour', 'thingseven'] }
+      specify { expect(parsed_includes.next.next.includes).to eq ['thingthree', 'thingfive'] }
+    end
+  end
+end

data/spec/json_api_ruby/resource_spec.rb

@@ -29,7 +29,7 @@ RSpec.describe JsonApi::Resource do
   describe 'relationships' do
     subject(:serialized_article) do
       article = Person.new('Anatoly Fyodorovich Krimov', 'red_star@kremlin.mil').articles.first
-      ArticleResource.new(article, include: [:author, :comments]).to_hash
+      ArticleResource.new(article, include: JsonApi::Includes.parse_includes([:author, :comments])).to_hash
     end
 
     context 'with a cardinality of one' do

data/spec/json_api_ruby/resources/base_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+class BaseTestClass < JsonApi::Resource
+end
+
+describe BaseTestClass do
+  let!(:person) do
+    Person.new('Brad J. Armbruster', 'ace@airforce.mil')
+  end
+
+  subject(:test_class) { described_class.new(person) }
+
+  it 'provides a links hash' do
+    expect(test_class.links_hash).to eq({ 'self' => "http://localhost:3000/people/#{person.id}" })
+  end
+
+  it 'provides a links hash' do
+    expect(test_class.to_hash['links']).to be_present
+  end
+
+  it "doesn't include links if configuration has them turned off" do
+    BaseTestClass.instance_variable_set(:@_use_links, false)
+    expect(test_class.to_hash['links']).to be_blank
+  end
+end

data/spec/json_api_ruby/resources/relationships_spec.rb

@@ -55,11 +55,20 @@ RSpec.describe JsonApi::Resources::RelationshipMeta 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: true)
+      rel = author_relation.build_resources(parent_resource: article_resource, included: included_data)
       rel.to_hash
     end
 
@@ -69,8 +78,9 @@ RSpec.describe JsonApi::Resources::RelationshipMeta do
 
     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: true)
+          rel = comments_relation.build_resources(parent_resource: article_resource, included: included_data)
           rel.to_hash
         end
 
@@ -88,8 +98,9 @@ RSpec.describe JsonApi::Resources::RelationshipMeta do
   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: true)
+      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
@@ -97,8 +108,9 @@ RSpec.describe JsonApi::Resources::RelationshipMeta do
 
   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: true)
+        rel = author_relation.build_resources(parent_resource: article_resource, included: included_data)
         serialized_data = rel.to_hash
         expect(serialized_data).to include('data')
       end
@@ -115,7 +127,7 @@ RSpec.describe JsonApi::Resources::RelationshipMeta do
 
   describe 'passing in a resource class' do
     let(:simple_article_resource) do
-      SimpleArticleResource.new(article, include: ['author', 'comments'])
+      SimpleArticleResource.new(article, include: JsonApi::Includes.parse_includes(['author', 'comments']))
     end
 
     let(:author_relation) do

data/spec/json_api_ruby/serializer_spec.rb

@@ -36,6 +36,7 @@ RSpec.describe JsonApi::Serializer do
       subject(:serialized) do
         JsonApi.serialize(person, meta: { meta_key: 'meta value' }, include: [:articles])
       end
+
       it 'has a top level included object' do
         expect(serialized['included']).to be_present
       end
@@ -46,6 +47,14 @@ RSpec.describe JsonApi::Serializer do
         end
         expect(found_document).to be_present
       end
+
+      it 'supports nested includes' do
+        serialized = JsonApi.serialize(person, include: ['articles.comments'])
+        comments = serialized['included'].select do |document|
+          document['type'] == 'comments'
+        end
+        expect(comments).to be_present
+      end
     end
   end
 

data/spec/support/resource_objects.rb

@@ -125,10 +125,11 @@ end
 
 class CommentResource < JsonApi::Resource
   id_field :uuid
-  attribute :author
   attribute :comment_text
   attribute :created_at
   attribute :updated_at
+
+  has_one :author
 end
 
 # namespaced resources

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: json_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tracey Eubanks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 2016-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
 description: Extremely lightweight implementation of JSON API
@@ -101,8 +101,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -114,6 +114,7 @@ files:
 - lib/json_api_ruby/configuration.rb
 - lib/json_api_ruby/error_resource.rb
 - lib/json_api_ruby/exceptions.rb
+- lib/json_api_ruby/includes.rb
 - lib/json_api_ruby/resource.rb
 - lib/json_api_ruby/resources/base.rb
 - lib/json_api_ruby/resources/discovery.rb
@@ -121,7 +122,10 @@ files:
 - lib/json_api_ruby/resources/relationships.rb
 - lib/json_api_ruby/serializer.rb
 - lib/json_api_ruby/version.rb
+- spec/json_api_ruby/configuration_spec.rb
+- spec/json_api_ruby/includes_spec.rb
 - spec/json_api_ruby/resource_spec.rb
+- spec/json_api_ruby/resources/base_spec.rb
 - spec/json_api_ruby/resources/discover_spec.rb
 - spec/json_api_ruby/resources/relationships_spec.rb
 - spec/json_api_ruby/serializer_spec.rb
@@ -138,22 +142,25 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Extremely lightweight implementation of JSON API
 test_files:
+- spec/json_api_ruby/configuration_spec.rb
+- spec/json_api_ruby/includes_spec.rb
 - spec/json_api_ruby/resource_spec.rb
+- spec/json_api_ruby/resources/base_spec.rb
 - spec/json_api_ruby/resources/discover_spec.rb
 - spec/json_api_ruby/resources/relationships_spec.rb
 - spec/json_api_ruby/serializer_spec.rb