restpack_serializer 0.4.9 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c406b9af62170a52083627f373ffdc67a1942140
-  data.tar.gz: 7b73768866438375cf7e1b870e5da680ef60b363
+  metadata.gz: 2dfadef3b0cdb67cc4f5a4b659448218f230bcba
+  data.tar.gz: 5f83c011e2b01d6c539250e289661fde606d1d55
 SHA512:
-  metadata.gz: ddd06300644271b871ace5bf86921c284145361fe7d3f5e3c334fedf7e8475f10afaaf74299e628a21320706229ae56927c7a20a404b414c8d8aed53a26d2fd5
-  data.tar.gz: a92f904c22955987d9415c772e61b7b0bccbffb8864d102d3a1d6b3d96d2b9af431eb4dc79e4d29b6bf6d756a51d80d687fb4b300499243380b27501ca0d401c
+  metadata.gz: b13cf34cf4f9e0a4cda766e356d6fc69e249eb9944de45f3ad5e489e9fda2f9506b377540f9a798782aa5cf230ecdaa5f966df884040b98b62afe5790689266d
+  data.tar.gz: 0d6c339987850df7d6a3e8dfe2a3e683eb2df3277878c0e98eaf613a0677f1da91eff1007bce939e9d8092d5ca976d9694143676209fd94f2406a682edc28492

data/README.md

@@ -64,8 +64,8 @@ end
 
 These endpoint will live at URLs such as `/albums` and `/albums/142857`:
 
-* http://restpack-serializer-sample.herokuapp.com/albums.json
-* http://restpack-serializer-sample.herokuapp.com/albums/4.json
+* http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json
+* http://restpack-serializer-sample.herokuapp.com/api/v1/albums/4.json
 
 Both `page` and `resource` methods take an optional scope argument allowing us to enforce arbitrary constraints:
 
@@ -77,12 +77,12 @@ AlbumSerializer.page(params, Albums.where("year < 1950"))
 
 Collections are paged by default. `page` and `page_size` parameters are available:
 
-* http://restpack-serializer-sample.herokuapp.com/songs.json?page=2
-* http://restpack-serializer-sample.herokuapp.com/songs.json?page=2&page_size=3
+* http://restpack-serializer-sample.herokuapp.com/api/v1/songs.json?page=2
+* http://restpack-serializer-sample.herokuapp.com/api/v1/songs.json?page=2&page_size=3
 
 Paging details are included in a `meta` attribute:
 
-http://restpack-serializer-sample.herokuapp.com/songs.json?page=2&page_size=3 yields:
+http://restpack-serializer-sample.herokuapp.com/api/v1/songs.json?page=2&page_size=3 yields:
 
 ```javascript
 {
@@ -163,11 +163,11 @@ In this example, we are allowing related `songs` and `artists` to be included in
 
 #### No side-loads
 
-* http://restpack-serializer-sample.herokuapp.com/albums.json
+* http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json
 
 #### Side-load related Artists
 
-* http://restpack-serializer-sample.herokuapp.com/albums.json?include=artists
+* http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json?include=artists
 
 which yields:
 
@@ -269,15 +269,15 @@ which yields:
 
 #### Side-load related Songs
 
-* http://restpack-serializer-sample.herokuapp.com/albums.json?include=songs
+* http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json?include=songs
 
 An album `:has_many` songs, so the side-loaded songs are paged. The `meta.songs` includes `previous_href` and `next_href` which point to the previous and next page of this side-loaded data. These URLs take the form:
 
-* http://restpack-serializer-sample.herokuapp.com/songs.json?album_ids=1,2,3,4&page=2
+* http://restpack-serializer-sample.herokuapp.com/api/v1/songs.json?album_ids=1,2,3,4&page=2
 
 #### Side-load related Artists and Songs
 
-* http://restpack-serializer-sample.herokuapp.com/albums.json?include=artists,songs
+* http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json?include=artists,songs
 
 ## Filtering
 
@@ -285,13 +285,13 @@ Simple filtering based on primary and foreign keys is supported by default:
 
 #### By primary key:
 
- * http://restpack-serializer-sample.herokuapp.com/albums.json?id=1
- * http://restpack-serializer-sample.herokuapp.com/albums.json?ids=1,2,4
+ * http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json?id=1
+ * http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json?ids=1,2,4
 
 #### By foreign key:
 
- * http://restpack-serializer-sample.herokuapp.com/albums.json?artist_id=1
- * http://restpack-serializer-sample.herokuapp.com/albums.json?artist_ids=2,3
+ * http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json?artist_id=1
+ * http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json?artist_ids=2,3
 
 #### Custom filters:
 
@@ -308,4 +308,4 @@ end
 
 Side-loading is available when filtering:
 
- * http://restpack-serializer-sample.herokuapp.com/albums.json?artist_ids=2,3&include=artists,songs
+ * http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json?artist_ids=2,3&include=artists,songs

data/lib/restpack_serializer.rb

@@ -5,6 +5,7 @@ require 'restpack_serializer/version'
 require 'restpack_serializer/configuration'
 require 'restpack_serializer/serializable'
 require 'restpack_serializer/factory'
+require 'restpack_serializer/result'
 
 module RestPack
   module Serializer

data/lib/restpack_serializer/result.rb

@@ -0,0 +1,53 @@
+module RestPack::Serializer
+  class Result
+    attr_accessor :resources, :meta, :links
+
+    def initialize
+      @resources = {}
+      @meta = {}
+      @links = {}
+    end
+
+    def serialize
+      result = {}
+
+      result[:meta] = @meta unless @meta.empty?
+      result[:links] = @links unless @links.empty?
+
+      unless @resources.empty?
+        inject_to_many_links!
+        result[@resources.keys.first] = @resources.values.first
+
+        linked = @resources.except(@resources.keys.first)
+        result[:linked] = linked unless linked.empty?
+      end
+
+      result
+    end
+
+    private
+
+    def inject_to_many_links! #find and inject to_many links from related @resources
+      @resources.keys.each do |key|
+        @resources[key].each do |item|
+          if item[:links]
+            item[:links].each do |link_key, link_value|
+              unless link_value.is_a? Array
+                plural_linked_key = "#{link_key}s".to_sym
+
+                if @resources[plural_linked_key]
+                  linked_resource = @resources[plural_linked_key].find { |i| i[:id] == link_value }
+                  if linked_resource
+                    linked_resource[:links] ||= {}
+                    linked_resource[:links][key] ||= []
+                    linked_resource[:links][key] << item[:id]
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/restpack_serializer/serializable/paging.rb

@@ -12,24 +12,21 @@ module RestPack::Serializer::Paging
         per_page: options.page_size
       )
 
-      result = {
-        self.key => serialize_page(page),
-        :meta => {
-          self.key => serialize_meta(page, options)
-        }
-      }
+      result = RestPack::Serializer::Result.new
+      result.resources[self.key] = serialize_page(page)
+      result.meta[self.key] = serialize_meta(page, options)
 
       if options.include_links
-        result[:links] = self.links
+        result.links = self.links
         Array(RestPack::Serializer::Factory.create(*options.include)).each do |serializer|
-          result[:links].merge! serializer.class.links
+          result.links.merge! serializer.class.links
         end
       end
 
       side_load_data = side_loads(page, options)
-      result[:meta].merge!(side_load_data[:meta] || {})
-      result = result.merge side_load_data.except(:meta)
-      inject_to_many_links result
+      result.meta.merge!(side_load_data[:meta] || {})
+      result.resources.merge! side_load_data.except(:meta)
+      result.serialize
     end
 
     private
@@ -69,32 +66,5 @@ module RestPack::Serializer::Paging
       url += '?' + params.join('&') if params.any?
       url
     end
-
-    def inject_to_many_links(result) #TODO: GJ: extract this into a result class and refactor
-      keys = result.keys - [:meta, :links]
-
-      keys.each do |key|
-        result[key].each do |item|
-          if item[:links]
-            item[:links].each do |link_key, link_value|
-              unless link_value.is_a? Array
-                plural_linked_key = "#{link_key}s".to_sym
-
-                if result[plural_linked_key]
-                  linked_resource = result[plural_linked_key].find { |i| i[:id] == link_value }
-                  if linked_resource
-                    linked_resource[:links] ||= {}
-                    linked_resource[:links][key] ||= []
-                    linked_resource[:links][key] << item[:id]
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-
-      result
-    end
   end
 end

data/lib/restpack_serializer/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Serializer
-    VERSION = '0.4.9'
+    VERSION = '0.4.10'
   end
 end

data/spec/result_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe RestPack::Serializer::Result do
+  context 'a new instance' do
+    it 'has defaults' do
+      subject.resources.should == {}
+      subject.meta.should == {}
+      subject.links.should == {}
+    end
+  end
+
+  context 'when serializing' do
+    let(:result) { subject.serialize }
+    context 'in jsonapi.org format' do
+      context 'an empty result' do
+        it 'returns an empty result' do
+          result.should == {}
+        end
+      end
+
+      context 'a simple list of resources' do
+        before do
+          subject.resources[:albums] = [{ name: 'Album 1' }, { name: 'Album 2'}]
+          subject.meta[:albums] = { count: 2 }
+          subject.links['albums.songs'] = { href: 'songs.json', type: 'songs' }
+        end
+
+        it 'returns correct jsonapi.org format' do
+          result[:albums].should == subject.resources[:albums]
+          result[:meta].should == subject.meta
+          result[:links].should == subject.links
+        end
+      end
+
+      context 'a list with side-loaded resources' do
+        before do
+          subject.resources[:albums] = [{ id: '1', name: 'AMOK'}]
+          subject.resources[:songs] = [{ id: '91', name: 'Before Your Very Eyes...', links: { album: '1' }}]
+          subject.links['albums.songs'] = { type: 'songs', href: '/api/v1/songs?album_id={albums.id}' }
+          subject.links['songs.album'] = { type: 'albums', href: '/api/v1/albums/{songs.album}' }
+        end
+
+        it 'returns correct jsonapi.org format, including injected to_many links' do
+          result[:albums].should == [{ id: '1', name: 'AMOK', links: { songs: ['91'] } }]
+          result[:links].should == subject.links
+          result[:linked][:songs].should == subject.resources[:songs]
+        end
+      end
+    end
+  end
+end

data/spec/serializable/paging_spec.rb

@@ -101,7 +101,7 @@ describe RestPack::Serializer::Paging do
       let(:params) { { include: 'albums' } }
 
       it "includes side-loaded models" do
-        page[:albums].should_not == nil
+        page[:linked][:albums].should_not == nil
       end
 
       it "includes the side-loads in the main meta data" do
@@ -118,7 +118,7 @@ describe RestPack::Serializer::Paging do
         song[:links][:album].should == song_model.album_id.to_s
         song[:links][:artist].should == song_model.artist_id.to_s
 
-        album = page[:albums].first
+        album = page[:linked][:albums].first
         album_model = MyApp::Album.find(album[:id])
 
         album[:links][:artist].should == album_model.artist_id.to_s
@@ -128,8 +128,8 @@ describe RestPack::Serializer::Paging do
       context "with includes as comma delimited string" do
         let(:params) { { include: "albums,artists" } }
         it "includes side-loaded models" do
-          page[:albums].should_not == nil
-          page[:artists].should_not == nil
+          page[:linked][:albums].should_not == nil
+          page[:linked][:artists].should_not == nil
         end
 
         it "includes the side-loads in page hrefs" do

data/spec/serializable/resource_spec.rb

@@ -18,8 +18,8 @@ describe RestPack::Serializer::Resource do
     let(:params) { { id: @song.id, include: 'albums' } }
 
     it "includes side-loaded models" do
-      resource[:albums].count.should == 1
-      resource[:albums].first[:id].should == @song.album.id.to_s
+      resource[:linked][:albums].count.should == 1
+      resource[:linked][:albums].first[:id].should == @song.album.id.to_s
     end
 
     it "includes the side-loads in the main meta data" do

data/spec/serializable/side_loading/side_loading_spec.rb

@@ -75,7 +75,7 @@ describe RestPack::Serializer::SideLoading do
         MyApp::ArtistSerializer.filterable_by.should == [:id]
       end
     end
-    context "a model with a single :belongs_torelations" do
+    context "a model with a single :belongs_to relations" do
       it "is filterable by primary key and foreign keys" do
         MyApp::AlbumSerializer.filterable_by.should =~ [:id, :artist_id, :year]
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restpack_serializer
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.4.10
 platform: ruby
 authors:
 - Gavin Joyce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-25 00:00:00.000000000 Z
+date: 2014-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -225,6 +225,7 @@ files:
 - lib/restpack_serializer/configuration.rb
 - lib/restpack_serializer/factory.rb
 - lib/restpack_serializer/options.rb
+- lib/restpack_serializer/result.rb
 - lib/restpack_serializer/serializable.rb
 - lib/restpack_serializer/serializable/attributes.rb
 - lib/restpack_serializer/serializable/filterable.rb
@@ -237,6 +238,7 @@ files:
 - spec/fixtures/db.rb
 - spec/fixtures/serializers.rb
 - spec/restpack_serializer_spec.rb
+- spec/result_spec.rb
 - spec/serializable/attributes_spec.rb
 - spec/serializable/filterable_spec.rb
 - spec/serializable/options_spec.rb
@@ -267,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: Model serialization, paging, side-loading and filtering
@@ -276,6 +278,7 @@ test_files:
 - spec/fixtures/db.rb
 - spec/fixtures/serializers.rb
 - spec/restpack_serializer_spec.rb
+- spec/result_spec.rb
 - spec/serializable/attributes_spec.rb
 - spec/serializable/filterable_spec.rb
 - spec/serializable/options_spec.rb