jsonapi-serializers 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42699af4d36a1e0a2293c857393c2dc3536d8d82
-  data.tar.gz: 92ef3e0b867d350c32fe4145c01958e38ceb2a8b
+  metadata.gz: f3b9ea3fd617b920688a8694e6d2a923c39de458
+  data.tar.gz: e5fd7307ab8acd411c31e96a4fab0f4e82b25a93
 SHA512:
-  metadata.gz: 06c90bbb58c2910078140c46592ee8f6ce81d20504b530e1ca853484b7573a198fd1da7e2f98d54cbb8f76eb471eda50cc41599b5e99cd76733c6e66a7280c57
-  data.tar.gz: 696761f2e0863825c0b232d506795758e4eda93a166d32f05095e59b412cde1531dc992e7c89e83afe86b1b568712a57fd9bb5a44d4fad628f181022a4b290c4
+  metadata.gz: 5c4ac246ad0366b5d3cdfb165a62982b79e3f9a36d2762fff3feb404f6ef3adfd1b22f2fe88e6651d421ecd52406a6c458d73c87fe29e66fb80c3a86e5a5847e
+  data.tar.gz: 4c7c6b9793a408ad4ca7cbc1bc504654817900a57ecb2cbaf190c900864c5a04391df1a983b0229cc0925d908a8ed49b69b98ff3684e7d3c07dcd225bc4eaaa5

data/README.md

@@ -24,6 +24,7 @@ This library is up-to-date with the finalized v1 JSON API spec.
   * [Compound documents and includes](#compound-documents-and-includes)
   * [Relationship path handling](#relationship-path-handling)
 * [Rails example](#rails-example)
+* [Sinatra example](#sinatra-example)
 * [Unfinished business](#unfinished-business)
 * [Contributing](#contributing)
 
@@ -540,6 +541,104 @@ ActionDispatch::Http::Parameters::DEFAULT_PARSERS[Mime::Type.lookup(JSONAPI::MIM
 end
 ```
 
+## Sinatra example
+
+Using [Sequel ORM](http://sequel.jeremyevans.net) instead of ActiveRecord. The
+important things to note here are the `:tactical_eager_loading` plugin, which
+will greatly reduce the number of queries performed when sideloading related
+records, and the `:skip_collection_check` option that must be set to true in
+order for `JSONAPI::Serializer.serialize` to be able to serialize single
+Sequel::Model instances.
+
+```ruby
+require 'sequel'
+require 'sinatra/base'
+require 'json/ext'
+require 'jsonapi-serializers'
+
+class Post < Sequel::Model
+  plugin :tactical_eager_loading
+
+  one_to_many :comments
+end
+
+class Comment < Sequel::Model
+  many_to_one :post
+end
+
+class BaseSerializer
+  include JSONAPI::Serializer
+
+  def self_link
+    "/api/v1#{super}"
+  end
+end
+
+class PostSerializer < BaseSerializer
+  attribute :title
+  attribute :content
+
+  has_many :comments
+end
+
+class CommentSerializer < BaseSerializer
+  attribute :username
+  attribute :body
+
+  has_one :post
+end
+
+module Api
+  class V1 < Sinatra::Base
+    configure do
+      mime_type :jsonapi, 'application/vnd.api+json'
+
+      set :database, Sequel.connect
+    end
+
+    helpers do
+      # Parse the body of the request depending on its content-type:
+      def parse_request_body
+        request.body.rewind
+
+        case request.content_type
+        when /json$/, /javascript$/
+          JSON.parse(request.body.read, symbolize_names: true)
+        end
+      end
+
+      # Convenience methods for serializing models:
+      def serialize_model(model, options = {})
+        options[:is_collection] = false
+        options[:skip_collection_check] = true
+        JSONAPI::Serializer.serialize(model, options)
+      end
+
+      def serialize_models(models, options = {})
+        options[:is_collection] = true
+        JSONAPI::Serializer.serialize(models, options)
+      end
+    end
+
+    before do
+      @data = parse_request_body if request.body.size > 0
+    end
+
+    get '/posts', provides: :jsonapi do
+      posts = Post.all
+      not_found if posts.empty?
+      serialize_models(posts).to_json
+    end
+
+    get '/posts/:id', provides: :jsonapi do
+      post = Post[params[:id]]
+      not_found if post.nil?
+      serialize_model(post, include: 'comments').to_json
+    end
+  end
+end
+```
+
 ## Unfinished business
 
 * Support for passing `context` through to serializers is partially complete, but needs more work.
@@ -549,6 +648,7 @@ end
 
 ## Release notes
 
+* v0.6.0: Support for polymorphic collections and inheriting serializer attributes.
 * v0.5.0: Support for explicit serializer discovery.
 * v0.4.0: Support for declaring multiple `attributes`.
 * v0.3.1: Improve performance of loading included relationships.

data/lib/jsonapi-serializers/attributes.rb

@@ -3,6 +3,17 @@ module JSONAPI
     def self.included(target)
       target.send(:include, InstanceMethods)
       target.extend ClassMethods
+
+      target.class_eval do
+        def self.inherited(target)
+          [:attributes_map, :to_one_associations, :to_many_associations]
+            .each{|k|
+              key = "@#{k}"
+              attr = self.instance_variable_get(key)
+              target.instance_variable_set(key, attr.dup) if attr
+            }
+        end
+      end
     end
 
     module InstanceMethods

data/lib/jsonapi-serializers/serializer.rb

@@ -269,7 +269,6 @@ module JSONAPI
         primary_data = nil
       elsif options[:is_collection]
         # Have object collection.
-        passthrough_options[:serializer] ||= find_serializer_class(objects.first)
         primary_data = serialize_primary_multi(objects, passthrough_options)
       else
         # Duck-typing check for a collection being passed without is_collection true.
@@ -280,7 +279,6 @@ module JSONAPI
             'Must provide `is_collection: true` to `serialize` when serializing collections.')
         end
         # Have single object.
-        passthrough_options[:serializer] ||= find_serializer_class(objects)
         primary_data = serialize_primary(objects, passthrough_options)
       end
       result = {
@@ -314,7 +312,7 @@ module JSONAPI
     end
 
     def self.serialize_primary(object, options = {})
-      serializer_class = options.fetch(:serializer)
+      serializer_class = options[:serializer] || find_serializer_class(object)
 
       # 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.5.0'
+    VERSION = '0.6.0'
   end
 end

data/spec/serializer_spec.rb

@@ -323,6 +323,35 @@ describe JSONAPI::Serializer do
         },
       })
     end
+    it 'can find the correct serializer by object class name' do
+      post = create(:post)
+      primary_data = serialize_primary(post)
+      expect(primary_data).to eq({
+        'id' => '1',
+        'type' => 'posts',
+        'attributes' => {
+          'title' => 'Title for Post 1',
+          'long-content' => 'Body for Post 1',
+        },
+        'links' => {
+          'self' => '/posts/1',
+        },
+        'relationships' => {
+          'author' => {
+            'links' => {
+              'self' => '/posts/1/relationships/author',
+              'related' => '/posts/1/author',
+            },
+          },
+          'long-comments' => {
+            'links' => {
+              'self' => '/posts/1/relationships/long-comments',
+              'related' => '/posts/1/long-comments',
+            },
+          },
+        },
+      })
+    end
   end
 
   describe 'JSONAPI::Serializer.serialize' do
@@ -768,4 +797,36 @@ describe JSONAPI::Serializer do
       })
     end
   end
+
+  describe 'inheritance through subclassing' do
+    it 'inherits attributes' do
+      tagged_post = create(:tagged_post)
+      options = {serializer: MyApp::PostSerializerWithInheritedProperties}
+      data = JSONAPI::Serializer.serialize(tagged_post, options);
+      expect(data['data']['attributes']['title']).to eq('Title for TaggedPost 1');
+      expect(data['data']['attributes']['tag']).to eq('Tag for TaggedPost 1');
+    end
+
+    it 'inherits relations' do
+      long_comments = create_list(:long_comment, 2)
+      tagged_post = create(:tagged_post, :with_author, long_comments: long_comments)
+      options = {serializer: MyApp::PostSerializerWithInheritedProperties}
+      data = JSONAPI::Serializer.serialize(tagged_post, options);
+
+      expect(data['data']['relationships']).to eq({
+        'author' => {
+          'links' => {
+            'self' => '/tagged-posts/1/relationships/author',
+            'related' => '/tagged-posts/1/author',
+          },
+        },
+        'long-comments' => {
+          'links' => {
+            'self' => '/tagged-posts/1/relationships/long-comments',
+            'related' => '/tagged-posts/1/long-comments',
+          }
+        }
+      })
+    end
+  end
 end

data/spec/support/factory.rb

@@ -12,6 +12,19 @@ FactoryGirl.define do
     end
   end
 
+  # Post with some added property to test inheritance in serializer.
+  factory :tagged_post, class: MyApp::TaggedPost do
+    skip_create
+    sequence(:id) {|n| n }
+    sequence(:title) {|n| "Title for TaggedPost #{n}" }
+    sequence(:body) {|n| "Body for TaggedPost #{n}" }
+    sequence(:tag) {|n| "Tag for TaggedPost #{n}" }
+
+    trait :with_author do
+      association :author, factory: :user
+    end
+  end
+
   factory :long_comment, class: MyApp::LongComment do
     skip_create
     sequence(:id) {|n| n }

data/spec/support/serializers.rb

@@ -7,6 +7,15 @@ module MyApp
     attr_accessor :long_comments
   end
 
+  class TaggedPost
+    attr_accessor :id
+    attr_accessor :title
+    attr_accessor :body
+    attr_accessor :tag
+    attr_accessor :author
+    attr_accessor :long_comments
+  end
+
   class LongComment
     attr_accessor :id
     attr_accessor :body
@@ -138,6 +147,11 @@ module MyApp
 
     attributes :title, :body
   end
+
+  class PostSerializerWithInheritedProperties < PostSerializer
+    # Add only :tag, inherit the rest.
+    attribute :tag
+  end
 end
 
 # Test the `jsonapi_serializer_class_name` override method for serializers in different namespaces.
@@ -148,4 +162,4 @@ module MyAppOtherNamespace
 
     attribute :name
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializers
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-30 00:00:00.000000000 Z
+date: 2016-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport