restpack_serializer 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d02fa321367307ada522ac8c84c68895ad53187b
-  data.tar.gz: 74d285e96499587df39af7183da04b5578f5a736
+  metadata.gz: 3daa5bd16f4c61dc8e0e46a1aa91234ea6eee250
+  data.tar.gz: 0ccaa8526f5811905ca6aee4c6c762fedd2576e9
 SHA512:
-  metadata.gz: c68fe0d43e8bb85c3743f5963c5526e33ac3f8b1914457056464dc69b1ce08edfd02743b74d0974b15d388ca01a89e343db14f1d4d302ab51890f9803e1fde05
-  data.tar.gz: 683ebf1933b2cdd9cb55148290d83b00ffac99b9bb5cd7a7178641b6581bd7e8df0dc6456c034667862c78bb12e1525533ede864393c34b5607cc25dc8be5425
+  metadata.gz: ac15ac3b387840b892689ccb93047f7356bf0e65a493228efde51916a1c67f4c196d59852b26519fa01975b8ab75ea6ee80e20f3e38ba532a4563c92afbd106c
+  data.tar.gz: 6cb929625f66ff9ae579b6d28d46a9c75d771a59f9b1f16681aa7b7b097a3d400d3c93931be4d4f54ea99d6918a3cc429b1643956fa5eec0977aed137f8beb65

data/README.md

@@ -120,7 +120,7 @@ http://restpack-serializer-sample.herokuapp.com/songs.json?page=2&page_size=3 yi
             "page": 2,
             "page_size": 3,
             "count": 42,
-            "includes": [],
+            "include": [],
             "page_count": 14,
             "previous_page": 1,
             "next_page": 3,
@@ -159,7 +159,7 @@ class AlbumSerializer
 end
 ```
 
-In this example, we are allowing related `songs` and `artists` to be included in API responses. Side-loads can be specifed by using the `includes` parameter:
+In this example, we are allowing related `songs` and `artists` to be included in API responses. Side-loads can be specifed by using the `include` parameter:
 
 #### No side-loads
 
@@ -167,7 +167,7 @@ In this example, we are allowing related `songs` and `artists` to be included in
 
 #### Side-load related Artists
 
-* http://restpack-serializer-sample.herokuapp.com/albums.json?includes=artists
+* http://restpack-serializer-sample.herokuapp.com/albums.json?include=artists
 
 which yields:
 
@@ -216,7 +216,7 @@ which yields:
             "page": 1,
             "page_size": 10,
             "count": 4,
-            "includes": [
+            "include": [
                 "artists"
             ],
             "page_count": 1,
@@ -269,7 +269,7 @@ which yields:
 
 #### Side-load related Songs
 
-* http://restpack-serializer-sample.herokuapp.com/albums.json?includes=songs
+* http://restpack-serializer-sample.herokuapp.com/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:
 
@@ -277,11 +277,11 @@ An album `:has_many` songs, so the side-loaded songs are paged. The `meta.songs`
 
 #### Side-load related Artists and Songs
 
-* http://restpack-serializer-sample.herokuapp.com/albums.json?includes=artists,songs
+* http://restpack-serializer-sample.herokuapp.com/albums.json?include=artists,songs
 
 ## Filtering
 
-Simple filtering based on primary and foreign keys is possible:
+Simple filtering based on primary and foreign keys is supported by default:
 
 #### By primary key:
 
@@ -293,6 +293,19 @@ Simple filtering based on primary and foreign keys is possible:
  * http://restpack-serializer-sample.herokuapp.com/albums.json?artist_id=1
  * http://restpack-serializer-sample.herokuapp.com/albums.json?artist_ids=2,3
 
+#### Custom filters:
+
+Custom filters can be defined with the `can_filter_by` option:
+
+ ```ruby
+class Account
+    include RestPack::Serializer
+    attributes :id, :application_id, :created_by, :name, :href
+
+    can_filter_by :application_id
+end
+```
+
 Side-loading is available when filtering:
 
- * http://restpack-serializer-sample.herokuapp.com/albums.json?artist_ids=2,3&includes=artists,songs
+ * http://restpack-serializer-sample.herokuapp.com/albums.json?artist_ids=2,3&include=artists,songs

data/lib/restpack_serializer/options.rb

@@ -1,13 +1,13 @@
 module RestPack::Serializer
   class Options
-    attr_accessor :page, :page_size, :includes, :filters, :serializer, :model_class, :scope, :include_links
+    attr_accessor :page, :page_size, :include, :filters, :serializer, :model_class, :scope, :include_links
 
     def initialize(serializer, params = {}, scope = nil)
       params.symbolize_keys! if params.respond_to?(:symbolize_keys!)
 
       @page = 1
       @page_size = RestPack::Serializer.config.page_size
-      @includes = []
+      @include = []
       @filters = filters_from_params(params, serializer)
       @serializer = serializer
       @model_class = serializer.model_class
@@ -16,7 +16,7 @@ module RestPack::Serializer
 
       @page = params[:page].to_i if params[:page]
       @page_size = params[:page_size].to_i if params[:page_size]
-      @includes = params[:includes].split(',').map(&:to_sym) if params[:includes]
+      @include = params[:include].split(',').map(&:to_sym) if params[:include]
     end
 
     def scope_with_filters
@@ -51,6 +51,5 @@ module RestPack::Serializer
       end
       filters
     end
-
   end
 end

data/lib/restpack_serializer/serializable/paging.rb

@@ -21,7 +21,7 @@ module RestPack::Serializer::Paging
 
       if options.include_links
         result[:links] = self.links
-        Array(RestPack::Serializer::Factory.create(*options.includes)).each do |serializer|
+        Array(RestPack::Serializer::Factory.create(*options.include)).each do |serializer|
           result[:links].merge! serializer.class.links
         end
       end
@@ -42,7 +42,7 @@ module RestPack::Serializer::Paging
         page: options.page,
         page_size: options.page_size,
         count: page.total_entries,
-        includes: options.includes
+        include: options.include
       }
 
       meta[:page_count] = ((page.total_entries - 1) / options.page_size) + 1
@@ -62,7 +62,7 @@ module RestPack::Serializer::Paging
       params = []
       params << "page=#{page}" unless page == 1
       params << "page_size=#{options.page_size}" unless options.default_page_size?
-      params << "includes=#{options.includes.join(',')}" if options.includes.any?
+      params << "include=#{options.include.join(',')}" if options.include.any?
       params << options.filters_as_url_params if options.filters.any?
 
       url += '?' + params.join('&') if params.any?

data/lib/restpack_serializer/serializable/side_loading.rb

@@ -6,9 +6,9 @@ module RestPack::Serializer::SideLoading
       side_loads = {
         :meta => { }
       }
-      return side_loads if models.empty? || options.includes.nil?
+      return side_loads if models.empty? || options.include.nil?
 
-      options.includes.each do |include|
+      options.include.each do |include|
         side_load_data = side_load(include, models, options)
         side_loads[:meta].merge!(side_load_data[:meta] || {})
         side_loads.merge! side_load_data.except(:meta)

data/lib/restpack_serializer/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Serializer
-    VERSION = '0.4.6'
+    VERSION = '0.4.7'
   end
 end

data/spec/serializable/options_spec.rb

@@ -7,7 +7,7 @@ describe RestPack::Serializer::Options do
 
   describe 'default values' do
     it { subject.model_class.should == MyApp::Song }
-    it { subject.includes.should == [] }
+    it { subject.include.should == [] }
     it { subject.page.should == 1 }
     it { subject.page_size.should == 10 }
     it { subject.filters.should == {} }
@@ -22,9 +22,9 @@ describe RestPack::Serializer::Options do
     it { subject.page_size.should == 8 }
   end
 
-  describe 'with includes' do
-    let(:params) { { 'includes' => 'model1,model2' } }
-    it { subject.includes.should == [:model1, :model2] }
+  describe 'with include' do
+    let(:params) { { 'include' => 'model1,model2' } }
+    it { subject.include.should == [:model1, :model2] }
   end
 
   context 'with filters' do

data/spec/serializable/paging_spec.rb

@@ -98,29 +98,29 @@ describe RestPack::Serializer::Paging do
     end
 
     context "when sideloading" do
-      let(:params) { { includes: 'albums' } }
+      let(:params) { { include: 'albums' } }
 
       it "includes side-loaded models" do
         page[:albums].should_not == nil
       end
 
       it "includes the side-loads in the main meta data" do
-        page[:meta][:songs][:includes].should == [:albums]
+        page[:meta][:songs][:include].should == [:albums]
       end
 
       it "includes the side-loads in page hrefs" do
-        page[:meta][:songs][:next_href].should == '/songs.json?page=2&includes=albums'
+        page[:meta][:songs][:next_href].should == '/songs.json?page=2&include=albums'
       end
 
       context "with includes as comma delimited string" do
-        let(:params) { { includes: "albums,artists" } }
+        let(:params) { { include: "albums,artists" } }
         it "includes side-loaded models" do
           page[:albums].should_not == nil
           page[:artists].should_not == nil
         end
 
         it "includes the side-loads in page hrefs" do
-          page[:meta][:songs][:next_href].should == '/songs.json?page=2&includes=albums,artists'
+          page[:meta][:songs][:next_href].should == '/songs.json?page=2&include=albums,artists'
         end
 
         it "includes links" do
@@ -195,7 +195,7 @@ describe RestPack::Serializer::Paging do
 
   context "paging with paged side-load" do
     let(:page) { MyApp::AlbumSerializer.page_with_options(options) }
-    let(:options) { RestPack::Serializer::Options.new(MyApp::AlbumSerializer, { includes: 'songs' }) }
+    let(:options) { RestPack::Serializer::Options.new(MyApp::AlbumSerializer, { include: 'songs' }) }
 
     it "includes side-loaded paging data in meta data" do
       page[:meta][:albums].should_not == nil
@@ -207,7 +207,7 @@ describe RestPack::Serializer::Paging do
 
   context "paging with two paged side-loads" do
     let(:page) { MyApp::ArtistSerializer.page_with_options(options) }
-    let(:options) { RestPack::Serializer::Options.new(MyApp::ArtistSerializer, { includes: 'albums,songs' }) }
+    let(:options) { RestPack::Serializer::Options.new(MyApp::ArtistSerializer, { include: 'albums,songs' }) }
 
     it "includes side-loaded paging data in meta data" do
       page[:meta][:albums].should_not == nil

data/spec/serializable/resource_spec.rb

@@ -15,7 +15,7 @@ describe RestPack::Serializer::Resource do
   end
 
   describe "side-loading" do
-    let(:params) { { id: @song.id, includes: 'albums' } }
+    let(:params) { { id: @song.id, include: 'albums' } }
 
     it "includes side-loaded models" do
       resource[:albums].count.should == 1
@@ -23,7 +23,7 @@ describe RestPack::Serializer::Resource do
     end
 
     it "includes the side-loads in the main meta data" do
-      resource[:meta][:songs][:includes].should == [:albums]
+      resource[:meta][:songs][:include].should == [:albums]
     end
   end
 

data/spec/serializable/side_loading/belongs_to_spec.rb

@@ -22,7 +22,7 @@ describe RestPack::Serializer::SideLoading do
         end
 
         context "when including :albums" do
-          let(:options) { RestPack::Serializer::Options.new(MyApp::SongSerializer, { "includes" => "albums" }) }
+          let(:options) { RestPack::Serializer::Options.new(MyApp::SongSerializer, { "include" => "albums" }) }
 
           it "returns a hash with no data" do
             side_loads.should == { :meta => {} }
@@ -34,7 +34,7 @@ describe RestPack::Serializer::SideLoading do
         let(:models) { [MyApp::Song.first] }
 
         context "when including :albums" do
-          let(:options) { RestPack::Serializer::Options.new(MyApp::SongSerializer, { "includes" => "albums" }) }
+          let(:options) { RestPack::Serializer::Options.new(MyApp::SongSerializer, { "include" => "albums" }) }
 
           it "returns side-loaded albums" do
             side_loads.should == {
@@ -53,7 +53,7 @@ describe RestPack::Serializer::SideLoading do
         let(:models) { [song1, song2] }
 
         context "when including :albums" do
-          let(:options) { RestPack::Serializer::Options.new(MyApp::SongSerializer, { "includes" => "albums" }) }
+          let(:options) { RestPack::Serializer::Options.new(MyApp::SongSerializer, { "include" => "albums" }) }
 
           it "returns side-loaded albums" do
             side_loads.should == {

data/spec/serializable/side_loading/has_many_spec.rb

@@ -14,7 +14,7 @@ describe RestPack::Serializer::SideLoading do
         let(:models) { [@artist1] }
 
         context "when including :albums" do
-          let(:options) { RestPack::Serializer::Options.new(MyApp::ArtistSerializer, { "includes" => "albums" }) }
+          let(:options) { RestPack::Serializer::Options.new(MyApp::ArtistSerializer, { "include" => "albums" }) }
 
           it "returns side-loaded albums" do
             side_loads[:albums].count.should == @artist1.albums.count
@@ -28,7 +28,7 @@ describe RestPack::Serializer::SideLoading do
         let(:models) { [@artist1, @artist2] }
 
         context "when including :albums" do
-          let(:options) { RestPack::Serializer::Options.new(MyApp::ArtistSerializer, { "includes" => "albums" }) }
+          let(:options) { RestPack::Serializer::Options.new(MyApp::ArtistSerializer, { "include" => "albums" }) }
 
           it "returns side-loaded albums" do
             expected_count = @artist1.albums.count + @artist2.albums.count

data/spec/serializable/side_loading/side_loading_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe RestPack::Serializer::SideLoading do
-  context "invalid :includes" do
+  context "invalid :include" do
     before(:each) do
       FactoryGirl.create(:song)
     end
@@ -12,7 +12,7 @@ describe RestPack::Serializer::SideLoading do
         message = ":wrong is not a valid include for MyApp::Song"
 
         expect do
-          MyApp::SongSerializer.side_loads([MyApp::Song.first], RestPack::Serializer::Options.new(MyApp::SongSerializer, { "includes" => "wrong" }))
+          MyApp::SongSerializer.side_loads([MyApp::Song.first], RestPack::Serializer::Options.new(MyApp::SongSerializer, { "include" => "wrong" }))
         end.to raise_error(exception, message)
       end
     end
@@ -24,7 +24,7 @@ describe RestPack::Serializer::SideLoading do
         message = ":payments is not a valid include for MyApp::Artist"
 
         expect do
-          MyApp::ArtistSerializer.side_loads([payment.artist], RestPack::Serializer::Options.new(MyApp::ArtistSerializer, { "includes" => "payments" }))
+          MyApp::ArtistSerializer.side_loads([payment.artist], RestPack::Serializer::Options.new(MyApp::ArtistSerializer, { "include" => "payments" }))
         end.to raise_error(exception, message)
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restpack_serializer
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors:
 - Gavin Joyce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-21 00:00:00.000000000 Z
+date: 2013-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -267,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: Model serialization, paging, side-loading and filtering