restpack_serializer 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bb868ddc338559c261cf11b8b18c971b2d80bd7
-  data.tar.gz: d667ad9327dd544adbb23eff8b2c15028e917e28
+  metadata.gz: d02fa321367307ada522ac8c84c68895ad53187b
+  data.tar.gz: 74d285e96499587df39af7183da04b5578f5a736
 SHA512:
-  metadata.gz: 0ed2707234b857b4b5ea571fce09fe7247f2b8adf966f52045cc2540fbf1a2feb195a7bcff310fcd0b8d046bed11d9df70e786e1c0c073d76b6e7c61d68e248e
-  data.tar.gz: d663714aa5135e88a14f4418f474b367217a3b933b5da2152d864f01804ad6578814f8217fb848822837de5728cbea487f3abd297a8c863170c154e349c2bc37
+  metadata.gz: c68fe0d43e8bb85c3743f5963c5526e33ac3f8b1914457056464dc69b1ce08edfd02743b74d0974b15d388ca01a89e343db14f1d4d302ab51890f9803e1fde05
+  data.tar.gz: 683ebf1933b2cdd9cb55148290d83b00ffac99b9bb5cd7a7178641b6581bd7e8df0dc6456c034667862c78bb12e1525533ede864393c34b5607cc25dc8be5425

data/README.md

@@ -271,7 +271,7 @@ which yields:
 
 * http://restpack-serializer-sample.herokuapp.com/albums.json?includes=songs
 
-An album `:has_many` songs, so the side-loads are paged. We'll be soon adding URLs to the response meta data which will point to the next page of side-loaded data. These URLs will be something like:
+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
 

data/lib/restpack_serializer/serializable/filterable.rb

@@ -0,0 +1,24 @@
+module RestPack::Serializer::Filterable
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def serializable_filters
+      @serializable_filters
+    end
+
+    def can_filter_by(*attributes)
+      attributes.each do |attribute|
+        @serializable_filters ||= []
+        @serializable_filters << attribute.to_sym
+      end
+    end
+
+    def filterable_by
+      filters = [self.model_class.primary_key.to_sym]
+      filters += self.model_class.reflect_on_all_associations(:belongs_to).map(&:foreign_key).map(&:to_sym)
+
+      filters += @serializable_filters if @serializable_filters
+      filters.uniq
+    end
+  end
+end

data/lib/restpack_serializer/serializable/side_loading.rb

@@ -16,12 +16,6 @@ module RestPack::Serializer::SideLoading
       side_loads
     end
 
-    def filterable_by
-      filters = [self.model_class.primary_key.to_sym]
-      filters += self.model_class.reflect_on_all_associations(:belongs_to).map(&:foreign_key).map(&:to_sym)
-      filters.uniq
-    end
-
     def can_includes
       @can_includes || []
     end

data/lib/restpack_serializer/serializable.rb

@@ -1,6 +1,7 @@
 require 'active_support/concern'
 require_relative "options"
 require_relative "serializable/attributes"
+require_relative "serializable/filterable"
 require_relative "serializable/paging"
 require_relative "serializable/resource"
 require_relative "serializable/side_loading"
@@ -20,6 +21,7 @@ module RestPack
     include RestPack::Serializer::Paging
     include RestPack::Serializer::Resource
     include RestPack::Serializer::Attributes
+    include RestPack::Serializer::Filterable
     include RestPack::Serializer::SideLoading
 
     class InvalidInclude < Exception; end

data/lib/restpack_serializer/version.rb

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

data/spec/factory/factory_spec.rb

@@ -1,4 +1,4 @@
-require './spec/spec_helper'
+require 'spec_helper'
 
 describe RestPack::Serializer::Factory do
   let(:factory) { RestPack::Serializer::Factory }

data/spec/fixtures/serializers.rb

@@ -3,12 +3,14 @@ module MyApp
     include RestPack::Serializer
     attributes :id, :title, :album_id
     can_include :albums, :artists
+    can_filter_by :title
   end
 
   class AlbumSerializer
     include RestPack::Serializer
     attributes :id, :title, :year, :artist_id
     can_include :artists, :songs
+    can_filter_by :year
   end
 
   class ArtistSerializer

data/spec/serializable/attributes_spec.rb

@@ -1,4 +1,4 @@
-require './spec/spec_helper'
+require 'spec_helper'
 
 describe RestPack::Serializer::Attributes do
 	class CustomSerializer
@@ -24,4 +24,4 @@ describe RestPack::Serializer::Attributes do
 	it "correctly maps attribute with :key options" do
 		@attributes[:new_key].should == :old_attribute
 	end
-end
+end

data/spec/serializable/filterable_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe RestPack::Serializer::Filterable do
+  class CustomSerializer
+    include RestPack::Serializer
+    attributes :a, :b, :c
+
+    can_filter_by :a, :c
+  end
+
+  it "captures the specified filters" do
+    CustomSerializer.serializable_filters.should == [:a, :c]
+  end
+end

data/spec/serializable/options_spec.rb

@@ -1,4 +1,4 @@
-require './spec/spec_helper'
+require 'spec_helper'
 
 describe RestPack::Serializer::Options do
   let(:subject) { RestPack::Serializer::Options.new(MyApp::SongSerializer, params, scope) }

data/spec/serializable/paging_spec.rb

@@ -1,4 +1,4 @@
-require './spec/spec_helper'
+require 'spec_helper'
 
 describe RestPack::Serializer::Paging do
   before(:each) do
@@ -45,6 +45,22 @@ describe RestPack::Serializer::Paging do
       end
     end
 
+    context "with custom filter" do
+      context "valid :title" do
+        let(:params) { { title: @album1.songs[0].title } }
+        it "returns the album" do
+          page[:meta][:songs][:count].should == 1
+        end
+      end
+
+      context "invalid :title" do
+        let(:params) { { title: "this doesn't exist" } }
+        it "returns the album" do
+          page[:meta][:songs][:count].should == 0
+        end
+      end
+    end
+
     it "serializes results" do
       first = MyApp::Song.first
       page[:songs].first.should == {

data/spec/serializable/resource_spec.rb

@@ -1,4 +1,4 @@
-require './spec/spec_helper'
+require 'spec_helper'
 
 describe RestPack::Serializer::Resource do
   before(:each) do

data/spec/serializable/serializer_spec.rb

@@ -1,4 +1,4 @@
-require './spec/spec_helper'
+require 'spec_helper'
 
 describe RestPack::Serializer do
   let(:serializer) { PersonSerializer.new }

data/spec/serializable/side_loading/belongs_to_spec.rb

@@ -1,4 +1,4 @@
-require './spec/spec_helper'
+require 'spec_helper'
 
 describe RestPack::Serializer::SideLoading do
   context "when side-loading" do

data/spec/serializable/side_loading/has_many_spec.rb

@@ -1,4 +1,4 @@
-require './spec/spec_helper'
+require 'spec_helper'
 
 describe RestPack::Serializer::SideLoading do
   context "when side-loading" do

data/spec/serializable/side_loading/side_loading_spec.rb

@@ -1,4 +1,4 @@
-require './spec/spec_helper'
+require 'spec_helper'
 
 describe RestPack::Serializer::SideLoading do
   context "invalid :includes" do
@@ -77,12 +77,12 @@ describe RestPack::Serializer::SideLoading do
     end
     context "a model with a single :belongs_torelations" do
       it "is filterable by primary key and foreign keys" do
-        MyApp::AlbumSerializer.filterable_by.should =~ [:id, :artist_id]
+        MyApp::AlbumSerializer.filterable_by.should =~ [:id, :artist_id, :year]
       end
     end
     context "a model with multiple :belongs_to relations" do
       it "is filterable by primary key and foreign keys" do
-        MyApp::SongSerializer.filterable_by.should =~ [:id, :artist_id, :album_id]
+        MyApp::SongSerializer.filterable_by.should =~ [:id, :artist_id, :album_id, :title]
       end
     end
   end

data/spec/support/factory.rb

@@ -1,4 +1,4 @@
-  require 'factory_girl'
+require 'factory_girl'
 
 FactoryGirl.define do
   factory :artist, :class => MyApp::Artist do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restpack_serializer
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Gavin Joyce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-18 00:00:00.000000000 Z
+date: 2013-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -227,6 +227,7 @@ files:
 - lib/restpack_serializer/options.rb
 - lib/restpack_serializer/serializable.rb
 - lib/restpack_serializer/serializable/attributes.rb
+- lib/restpack_serializer/serializable/filterable.rb
 - lib/restpack_serializer/serializable/paging.rb
 - lib/restpack_serializer/serializable/resource.rb
 - lib/restpack_serializer/serializable/side_loading.rb
@@ -237,6 +238,7 @@ files:
 - spec/fixtures/serializers.rb
 - spec/restpack_serializer_spec.rb
 - spec/serializable/attributes_spec.rb
+- spec/serializable/filterable_spec.rb
 - spec/serializable/options_spec.rb
 - spec/serializable/paging_spec.rb
 - spec/serializable/resource_spec.rb
@@ -265,7 +267,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
@@ -275,6 +277,7 @@ test_files:
 - spec/fixtures/serializers.rb
 - spec/restpack_serializer_spec.rb
 - spec/serializable/attributes_spec.rb
+- spec/serializable/filterable_spec.rb
 - spec/serializable/options_spec.rb
 - spec/serializable/paging_spec.rb
 - spec/serializable/resource_spec.rb