jsonapi-resources 0.10.0.beta3 → 0.10.0.beta4

data/lib/jsonapi/resource_serializer.rb

@@ -59,7 +59,7 @@ module JSONAPI
         end
       end
 
-      fail "To Many primary objects for show" if (primary_objects.count > 1)
+      fail "Too many primary objects for show" if (primary_objects.count > 1)
       primary_hash = { 'data' => primary_objects[0] }
 
       primary_hash['included'] = included_objects if included_objects.size > 0
@@ -93,24 +93,19 @@ module JSONAPI
       return serialize_resource_set_to_hash_plural(resource_set)
     end
 
-    def serialize_to_links_hash(source, requested_relationship, resource_ids)
+    def serialize_to_relationship_hash(source, requested_relationship, resource_ids)
       if requested_relationship.is_a?(JSONAPI::Relationship::ToOne)
         data = to_one_linkage(resource_ids[0])
       else
         data = to_many_linkage(resource_ids)
       end
 
-      {
-          'links' => {
-              'self' => self_link(source, requested_relationship),
-              'related' => related_link(source, requested_relationship)
-          },
-          'data' => data
-      }
-    end
+      rel_hash = { 'data': data }
 
-    def query_link(query_params)
-      link_builder.query_link(query_params)
+      links = default_relationship_links(source, requested_relationship)
+      rel_hash['links'] = links unless links.blank?
+
+      rel_hash
     end
 
     def format_key(key)
@@ -140,7 +135,6 @@ module JSONAPI
         supplying_attribute_fields: supplying_attribute_fields(resource_klass).sort,
         supplying_relationship_fields: supplying_relationship_fields(resource_klass).sort,
         link_builder_base_url: link_builder.base_url,
-        route_formatter_class: link_builder.route_formatter.uncached.class.name,
         key_formatter_class: key_formatter.uncached.class.name,
         always_include_to_one_linkage_data: always_include_to_one_linkage_data,
         always_include_to_many_linkage_data: always_include_to_many_linkage_data
@@ -165,7 +159,7 @@ module JSONAPI
         obj_hash['attributes'] = source.attributes_json if source.attributes_json
 
         relationships = cached_relationships_hash(source, fetchable_fields, relationship_data)
-        obj_hash['relationships'] = relationships unless relationships.nil? || relationships.empty?
+        obj_hash['relationships'] = relationships unless relationships.blank?
 
         obj_hash['meta'] = source.meta_json if source.meta_json
       else
@@ -184,7 +178,7 @@ module JSONAPI
         obj_hash['attributes'] = attributes unless attributes.empty?
 
         relationships = relationships_hash(source, fetchable_fields, relationship_data)
-        obj_hash['relationships'] = relationships unless relationships.nil? || relationships.empty?
+        obj_hash['relationships'] = relationships unless relationships.blank?
 
         meta = meta_hash(source)
         obj_hash['meta'] = meta unless meta.empty?
@@ -199,7 +193,7 @@ module JSONAPI
       @_supplying_attribute_fields.fetch resource_klass do
         attrs = Set.new(resource_klass._attributes.keys.map(&:to_sym))
         cur = resource_klass
-        while cur != JSONAPI::Resource
+        while !cur.root? # do not traverse beyond the first root resource
           if @fields.has_key?(cur._type)
             attrs &= @fields[cur._type]
             break
@@ -214,7 +208,7 @@ module JSONAPI
       @_supplying_relationship_fields.fetch resource_klass do
         relationships = Set.new(resource_klass._relationships.keys.map(&:to_sym))
         cur = resource_klass
-        while cur != JSONAPI::Resource
+        while !cur.root? # do not traverse beyond the first root resource
           if @fields.has_key?(cur._type)
             relationships &= @fields[cur._type]
             break
@@ -249,7 +243,9 @@ module JSONAPI
 
     def links_hash(source)
       links = custom_links_hash(source)
-      links['self'] = link_builder.self_link(source) unless links.key?('self')
+      if !links.key?('self') && !source.class.exclude_link?(:self)
+        links['self'] = link_builder.self_link(source)
+      end
       links.compact
     end
 
@@ -274,7 +270,8 @@ module JSONAPI
             end
           end
 
-          hash[format_key(name)] = link_object(source, relationship, rids, include_data)
+          ro = relationship_object(source, relationship, rids, include_data)
+          hash[format_key(name)] = ro unless ro.blank?
         end
       end
     end
@@ -323,6 +320,13 @@ module JSONAPI
       link_builder.relationships_related_link(source, relationship)
     end
 
+    def default_relationship_links(source, relationship)
+      links = {}
+      links['self'] = self_link(source, relationship) unless relationship.exclude_link?(:self)
+      links['related'] = related_link(source, relationship) unless relationship.exclude_link?(:related)
+      links.compact
+    end
+
     def to_many_linkage(rids)
       linkage = []
 
@@ -346,36 +350,36 @@ module JSONAPI
       }
     end
 
-    def link_object_to_one(source, relationship, rid, include_data)
+    def relationship_object_to_one(source, relationship, rid, include_data)
       link_object_hash = {}
-      link_object_hash['links'] = {}
-      link_object_hash['links']['self'] = self_link(source, relationship)
-      link_object_hash['links']['related'] = related_link(source, relationship)
+
+      links = default_relationship_links(source, relationship)
+
+      link_object_hash['links'] = links unless links.blank?
       link_object_hash['data'] = to_one_linkage(rid) if include_data
       link_object_hash
     end
 
-    def link_object_to_many(source, relationship, rids, include_data)
+    def relationship_object_to_many(source, relationship, rids, include_data)
       link_object_hash = {}
-      link_object_hash['links'] = {}
-      link_object_hash['links']['self'] = self_link(source, relationship)
-      link_object_hash['links']['related'] = related_link(source, relationship)
+
+      links = default_relationship_links(source, relationship)
+      link_object_hash['links'] = links unless links.blank?
       link_object_hash['data'] = to_many_linkage(rids) if include_data
       link_object_hash
     end
 
-    def link_object(source, relationship, rid, include_data)
+    def relationship_object(source, relationship, rid, include_data)
       if relationship.is_a?(JSONAPI::Relationship::ToOne)
-        link_object_to_one(source, relationship, rid, include_data)
+        relationship_object_to_one(source, relationship, rid, include_data)
       elsif relationship.is_a?(JSONAPI::Relationship::ToMany)
-        link_object_to_many(source, relationship, rid, include_data)
+        relationship_object_to_many(source, relationship, rid, include_data)
       end
     end
 
     def generate_link_builder(primary_resource_klass, options)
       LinkBuilder.new(
         base_url: options.fetch(:base_url, ''),
-        route_formatter: options.fetch(:route_formatter, JSONAPI.configuration.route_formatter),
         primary_resource_klass: primary_resource_klass,
       )
     end

data/lib/jsonapi/resource_set.rb

@@ -91,7 +91,7 @@ module JSONAPI
       # Step Four find any of the missing resources and join them into the result
       missed_resource_ids.each_pair do |resource_klass, ids|
         find_opts = {context: context, fields: find_options[:fields]}
-        found_resources = resource_klass.find_by_keys(ids, find_opts)
+        found_resources = resource_klass.find_to_populate_by_keys(ids, find_opts)
 
         found_resources.each do |resource|
           relationship_data = @resource_klasses[resource_klass][resource.id][:relationships]

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = '0.10.0.beta3'
+    VERSION = '0.10.0.beta4'
   end
 end

data/lib/jsonapi/response_document.rb

@@ -118,10 +118,15 @@ module JSONAPI
         result.pagination_params.each_pair do |link_name, params|
           if result.is_a?(JSONAPI::RelatedResourcesSetOperationResult)
             relationship = result.source_resource.class._relationships[result._type.to_sym]
-            @top_level_links[link_name] = serializer.link_builder.relationships_related_link(result.source_resource, relationship, query_params(params))
+            unless relationship.exclude_link?(link_name)
+              link = serializer.link_builder.relationships_related_link(result.source_resource, relationship, query_params(params))
+            end
           else
-            @top_level_links[link_name] = serializer.query_link(query_params(params))
+            unless serializer.link_builder.primary_resource_klass.exclude_link?(link_name)
+              link = serializer.link_builder.query_link(query_params(params))
+            end
           end
+          @top_level_links[link_name] = link unless link.blank?
         end
       end
     end

data/lib/jsonapi/routing_ext.rb

@@ -20,6 +20,10 @@ module ActionDispatch
           @resource_type = resources.first
           res = JSONAPI::Resource.resource_klass_for(resource_type_with_module_prefix(@resource_type))
 
+          unless res.singleton?
+            warn "Singleton routes created for non singleton resource #{res}. Links may not be generated correctly."
+          end
+
           options = resources.extract_options!.dup
           options[:controller] ||= @resource_type
           options.merge!(res.routing_resource_options)
@@ -80,6 +84,10 @@ module ActionDispatch
           @resource_type = resources.first
           res = JSONAPI::Resource.resource_klass_for(resource_type_with_module_prefix(@resource_type))
 
+          if res.singleton?
+            warn "Singleton resource #{res} should use `jsonapi_resource` instead."
+          end
+
           options = resources.extract_options!.dup
           options[:controller] ||= @resource_type
           options.merge!(res.routing_resource_options)
@@ -154,7 +162,8 @@ module ActionDispatch
 
           if methods.include?(:show)
             match "relationships/#{formatted_relationship_name}", controller: options[:controller],
-                  action: 'show_relationship', relationship: link_type.to_s, via: [:get]
+                  action: 'show_relationship', relationship: link_type.to_s, via: [:get],
+                  as: "relationships/#{link_type}"
           end
 
           if res.mutable?
@@ -182,7 +191,8 @@ module ActionDispatch
 
           if methods.include?(:show)
             match "relationships/#{formatted_relationship_name}", controller: options[:controller],
-                  action: 'show_relationship', relationship: link_type.to_s, via: [:get]
+                  action: 'show_relationship', relationship: link_type.to_s, via: [:get],
+                  as: "relationships/#{link_type}"
           end
 
           if res.mutable?
@@ -221,7 +231,8 @@ module ActionDispatch
 
           match formatted_relationship_name, controller: options[:controller],
                 relationship: relationship.name, source: resource_type_with_module_prefix(source._type),
-                action: 'show_related_resource', via: [:get]
+                action: 'show_related_resource', via: [:get],
+                as: relationship_name
         end
 
         def jsonapi_related_resources(*relationship)
@@ -238,7 +249,8 @@ module ActionDispatch
           match formatted_relationship_name,
                 controller: options[:controller],
                 relationship: relationship.name, source: resource_type_with_module_prefix(source._type),
-                action: 'index_related_resources', via: [:get]
+                action: 'index_related_resources', via: [:get],
+                as: relationship_name
         end
 
         protected

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.10.0.beta3
+  version: 0.10.0.beta4
 platform: ruby
 authors:
 - Dan Gebhardt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-25 00:00:00.000000000 Z
+date: 2019-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -176,10 +190,11 @@ files:
 - lib/generators/jsonapi/templates/jsonapi_controller.rb
 - lib/generators/jsonapi/templates/jsonapi_resource.rb
 - lib/jsonapi-resources.rb
-- lib/jsonapi/active_relation_resource_finder.rb
-- lib/jsonapi/active_relation_resource_finder/adapters/join_left_active_record_adapter.rb
-- lib/jsonapi/active_relation_resource_finder/join_manager.rb
+- lib/jsonapi/active_relation/adapters/join_left_active_record_adapter.rb
+- lib/jsonapi/active_relation/join_manager.rb
+- lib/jsonapi/active_relation_resource.rb
 - lib/jsonapi/acts_as_resource_controller.rb
+- lib/jsonapi/basic_resource.rb
 - lib/jsonapi/cached_response_fragment.rb
 - lib/jsonapi/callbacks.rb
 - lib/jsonapi/compiled_json.rb
@@ -232,7 +247,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Easily support JSON API in Rails.