jsonapi-serializers 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac6048277d2389daf1b9a46079531c7098ff4ec4
-  data.tar.gz: 35480667be2ae7cedd19b756d6f347d2a7874caa
+  metadata.gz: 19d15964189040f00001f5a9deca26a44b21cbe6
+  data.tar.gz: a5b09f36c38933a31ca1b13bcb6bed226ee3a2c0
 SHA512:
-  metadata.gz: a43a227c9e86df5366015e5c65236c1b076af5e798869aca1172038876b791d4316940047150f296e012cbd207a62a5543085991e40abdcf48005af0d5f614ae
-  data.tar.gz: 0e81e742972468dd6428c6107650bce9849bbab8cd8dce00976374aa10e336fc10b6f89ab0c154e010fbc1c87c1c90a2c4bb668f910d74a58aef41833cd9e715
+  metadata.gz: 8e9effdc7369c2d055bf1533ee7d0f45e364b120e32bf13d34b5fa44faab9f64f40c8161d9470a33c945e83db4055674457c3ee213b4d281400c6dd1f2cc2813
+  data.tar.gz: 0aff7329c2ab1d3bb20a87ffd3c78ad24dcfa74c13d4b634331bb6b87546a2823f5c8546bd715697a6eeb18ee0383d406d6149efab5cb990645a958a1583e6b7

data/.travis.yml

@@ -7,7 +7,5 @@ rvm:
   - 2.2.2
   - ruby-head
 before_install:
-  # TODO: remove this when this issue is fixed: https://github.com/travis-ci/travis-ci/issues/5798
-  - gem uninstall bundler -v 1.6.9
   - gem install bundler
 script: bundle exec rspec

data/README.md

@@ -19,8 +19,10 @@ This library is up-to-date with the finalized v1 JSON API spec.
   * [More customizations](#more-customizations)
   * [Base URL](#base-url)
   * [Root metadata](#root-metadata)
+  * [Root links](#root-links)
   * [Root errors](#root-errors)
   * [Explicit serializer discovery](#explicit-serializer-discovery)
+  * [Namespace serializers](#namespace-serializers)
 * [Relationships](#relationships)
   * [Compound documents and includes](#compound-documents-and-includes)
   * [Relationship path handling](#relationship-path-handling)
@@ -317,6 +319,14 @@ You can pass a `meta` argument to specify top-level metadata:
 JSONAPI::Serializer.serialize(post, meta: {copyright: 'Copyright 2015 Example Corp.'})
 ```
 
+### Root links
+
+You can pass a `links` argument to specify top-level links:
+
+```ruby
+JSONAPI::Serializer.serialize(post, links: {self: 'https://example.com/posts'})
+```
+
 ### Root errors
 
 You can use `serialize_errors` method in order to specify top-level errors:
@@ -361,6 +371,36 @@ end
 
 Now, when a `User` object is serialized, it will use the `SomeOtherNamespace::CustomUserSerializer`.
 
+### Namespace serializers
+
+Assume you have an API with multiple versions:
+
+```ruby
+module Api
+  module V1
+    class PostSerializer
+      include JSONAPI::Serializer
+      attribute :title
+    end
+  end
+  module V2
+    class PostSerializer
+      include JSONAPI::Serializer
+      attribute :name
+    end
+  end
+end
+```
+
+With the namespace option you can choose which serializer is used.
+
+```ruby
+JSONAPI::Serializer.serialize(post, namespace: Api::V1)
+JSONAPI::Serializer.serialize(post, namespace: Api::V2)
+```
+
+This option overrides the `jsonapi_serializer_class_name` method.
+
 ## Relationships
 
 You can easily specify relationships with the `has_one` and `has_many` directives.

data/jsonapi-serializers.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "factory_girl", "~> 4.5"

data/lib/jsonapi-serializers/serializer.rb

@@ -216,20 +216,23 @@ module JSONAPI
       protected :evaluate_attr_or_block
     end
 
-    def self.find_serializer_class_name(object)
+    def self.find_serializer_class_name(object, options)
+      if options[:namespace]
+        return "#{options[:namespace]}::#{object.class.name}Serializer"
+      end
       if object.respond_to?(:jsonapi_serializer_class_name)
         return object.jsonapi_serializer_class_name.to_s
       end
       "#{object.class.name}Serializer"
     end
 
-    def self.find_serializer_class(object)
-      class_name = find_serializer_class_name(object)
+    def self.find_serializer_class(object, options)
+      class_name = find_serializer_class_name(object, options)
       class_name.constantize
     end
 
     def self.find_serializer(object, options)
-      find_serializer_class(object).new(object, options)
+      find_serializer_class(object, options).new(object, options)
     end
 
     def self.serialize(objects, options = {})
@@ -237,6 +240,7 @@ module JSONAPI
       options[:is_collection] = options.delete('is_collection') || options[:is_collection] || false
       options[:include] = options.delete('include') || options[:include]
       options[:serializer] = options.delete('serializer') || options[:serializer]
+      options[:namespace] = options.delete('namespace') || options[:namespace]
       options[:context] = options.delete('context') || options[:context] || {}
       options[:skip_collection_check] = options.delete('skip_collection_check') || options[:skip_collection_check] || false
       options[:base_url] = options.delete('base_url') || options[:base_url]
@@ -254,6 +258,7 @@ module JSONAPI
       passthrough_options = {
         context: options[:context],
         serializer: options[:serializer],
+        namespace: options[:namespace],
         include: includes,
         base_url: options[:base_url]
       }
@@ -316,7 +321,8 @@ module JSONAPI
           included_passthrough_options = {}
           included_passthrough_options[:base_url] = passthrough_options[:base_url]
           included_passthrough_options[:context] = passthrough_options[:context]
-          included_passthrough_options[:serializer] = find_serializer_class(data[:object])
+          included_passthrough_options[:serializer] = find_serializer_class(data[:object], options)
+          included_passthrough_options[:namespace] = passthrough_options[:namespace]
           included_passthrough_options[:include_linkages] = data[:include_linkages]
           serialize_primary(data[:object], included_passthrough_options)
         end
@@ -352,7 +358,7 @@ module JSONAPI
     end
 
     def self.serialize_primary(object, options = {})
-      serializer_class = options[:serializer] || find_serializer_class(object)
+      serializer_class = options[:serializer] || find_serializer_class(object, options)
 
       # Spec: Primary data MUST be either:
       # - a single resource object or null, for requests that target single resources.

data/lib/jsonapi-serializers/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Serializer
-    VERSION = '0.13.0'
+    VERSION = '0.14.0'
   end
 end

data/spec/serializer_spec.rb

@@ -1065,4 +1065,48 @@ describe JSONAPI::Serializer do
       end.not_to raise_error
     end
   end
+
+  describe 'serializer with namespace option' do
+    it 'can serialize a simple object with namespace Api::V1' do
+      user = create(:user)
+      expect(JSONAPI::Serializer.serialize(user, {namespace: Api::V1})).to eq({
+        'data' => serialize_primary(user, {serializer: Api::V1::MyApp::UserSerializer}),
+      })
+    end
+
+    it 'handles recursive loading of relationships with namespaces' do
+      user = create(:user)
+      long_comments = create_list(:long_comment, 2, user: user)
+      post = create(:post, :with_author, long_comments: long_comments)
+      # Make sure each long-comment has a circular reference back to the post.
+      long_comments.each { |c| c.post = post }
+
+      expected_data = {
+        'data' => serialize_primary(post, {serializer: Api::V1::MyApp::PostSerializer}),
+        'included' => [
+          # Intermediates are included: long-comments, long-comments.post, and long-comments.post.author
+          #  http://jsonapi.org/format/#document-structure-compound-documents
+          serialize_primary(post.long_comments.first, {
+            serializer: Api::V1::MyApp::LongCommentSerializer,
+            include_linkages: ['post']
+          }),
+          serialize_primary(post.long_comments.last, {
+            serializer: Api::V1::MyApp::LongCommentSerializer,
+            include_linkages: ['post']
+          }),
+          serialize_primary(post, {
+            serializer: Api::V1::MyApp::PostSerializer,
+            include_linkages: ['author', 'post.long-comments']
+          }),
+          serialize_primary(post.author, {serializer: Api::V1::MyApp::UserSerializer})
+        ],
+      }
+      includes = ['long-comments.post.author']
+      actual_data = JSONAPI::Serializer.serialize(post, include: includes, namespace: Api::V1)
+      # Multiple expectations for better diff output for debugging.
+      expect(actual_data['data']).to eq(expected_data['data'])
+      expect(actual_data['included']).to eq(expected_data['included'])
+      expect(actual_data).to eq(expected_data)
+    end
+  end
 end

data/spec/support/serializers.rb

@@ -231,3 +231,34 @@ module MyAppOtherNamespace
     attribute :name
   end
 end
+
+module Api
+  module V1
+    module MyApp
+      class UserSerializer
+        include JSONAPI::Serializer
+
+        attribute :name
+      end
+
+      class PostSerializer
+        include JSONAPI::Serializer
+
+        attribute :title
+
+        has_one :author
+        has_many :long_comments
+      end
+
+      class LongCommentSerializer
+        include JSONAPI::Serializer
+
+        attribute :body
+        has_one :user
+
+        # Circular-reference back to post.
+        has_one :post
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializers
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2016-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Pure Ruby readonly serializers for the JSON:API spec.