restpack_serializer 0.2.6 → 0.2.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWM1YTg1ZWIyMWJmNjFlNDgyMTY0YWRkN2JkMzdiMzIyMTNkOTY3MQ==
+    MGQyN2VjOTdjYjFkMjI4NDIwNDc1ZTMxZTEyMjQ2YzZmNzk5MWFkYQ==
   data.tar.gz: !binary |-
-    ODQ4NTZjYzljZDBjNjllNjAyOGFlYzA1YjM5ODgwMzM3YjczODlhYQ==
+    Y2IwNjM4Y2E3NTAzYmI2ZWUzNTNmMWJkMmZhMjY2NjNmMGQ2N2U2Nw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MzRlMGQzOWFkMmRjYzI0Y2VmZDk0NTcyMzc4NTllOTM2ODk5OGU5MGJlZGFi
-    OTQ1MGQxNDIwMDdkZDQ1MzEyNWMwMWQyYjE2NmMwMDRhOGE3MWE5N2JhOTVh
-    ZGI1M2VjOTc4NmQ1ODJhMjU0YmY3YzlmMzY1N2E3OWIwZGRjNTY=
+    NWE2OGIxNTA0YjhkNjYzMTc2ZGQ2MzNlOTZmOTJkMjAyZjQ1Y2JjYTNmNTZi
+    Y2Q0MTU5ZWNhMzI4MDVmNzU4ZmNkNzZjZjVkNTAyZTJkMDVjZTUwMjczNTc1
+    ZDMxMDJmMDFjYjY2YzJiYjE4NDQ0OGQ5NzZiNTY3MDk0YTlmZTU=
   data.tar.gz: !binary |-
-    ODBlYzFkNDJiYjIxODk1OThhMTM5YWVlOTgwZGViZDBkMDIzMjJhOWVjNTk0
-    ODNmZWU1NWJmYWU3MGY3MmUyMDQzMjkwN2RmNDk0NWJiMDZlZjUyMGM4MzQ5
-    ZDE3ZGNhNGQ5Mjk3ZWU0YWY4ZjdhNzY2NjkwMDFiMTM3MDhjNWI=
+    OWU0MjUwNmQ2MTNhMDAxODFhNGI2MGQ5NjkxYjdhZjZlNjVjMjE1YzYxZGRj
+    OWUxZDVkYzJkNmE0N2MzMmRjMDhiMjJlNzU3OTEyZjFjODZhNzhlMGY0ZGM4
+    YWU1Y2Y5NDI1NDM2YTRjOTU3NjUzY2E5ODczZDJkMzkyN2U5NWE=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    restpack_serializer (0.2.6)
+    restpack_serializer (0.2.7)
       activerecord (>= 3.0)
       activesupport (>= 3.0)
       will_paginate (~> 3.0)

data/lib/restpack_serializer/options.rb

@@ -2,11 +2,13 @@ module RestPack::Serializer
   class Options
     attr_accessor :page, :page_size, :includes, :filters, :model_class, :scope, :include_links
 
+    DEFAULT_PAGE_SIZE = 10
+
     def initialize(model_class, params = {}, scope = nil)
       params.symbolize_keys! if params.respond_to?(:symbolize_keys!)
 
       @page = 1
-      @page_size = 10
+      @page_size = DEFAULT_PAGE_SIZE
       @includes = []
       @filters = filters_from_params(params, model_class)
       @model_class = model_class
@@ -31,6 +33,14 @@ module RestPack::Serializer
       @scope.where(scope_filter)
     end
 
+    def default_page_size?
+      @page_size == DEFAULT_PAGE_SIZE
+    end
+
+    def filters_as_url_params
+      @filters.sort.map {|k,v| "#{k}=#{v.join(',')}" }.join('&')
+    end
+
     private
 
     def filters_from_params(params, model_class)

data/lib/restpack_serializer/serializable/attributes.rb

@@ -1,10 +1,8 @@
 module RestPack::Serializer::Attributes
   extend ActiveSupport::Concern
 
-  module InstanceMethods
-    def default_href
-      "#{RestPack::Serializer.href_prefix}/#{@model.class.table_name}/#{@model.id}.json"
-    end
+  def default_href
+    "#{RestPack::Serializer.href_prefix}/#{@model.class.table_name}/#{@model.id}.json"
   end
 
   module ClassMethods

data/lib/restpack_serializer/serializable/paging.rb

@@ -48,7 +48,25 @@ module RestPack::Serializer::Paging
       meta[:page_count] = ((page.total_entries - 1) / options.page_size) + 1
       meta[:previous_page] = meta[:page] > 1 ? meta[:page] - 1 : nil
       meta[:next_page] = meta[:page] < meta[:page_count] ? meta[:page] + 1 : nil
+
+      meta[:previous_href] = page_href(meta[:previous_page], options)
+      meta[:next_href] = page_href(meta[:next_page], options)
       meta
     end
+
+    def page_href(page, options)
+      return nil unless page
+
+      url = "#{RestPack::Serializer.href_prefix}/#{self.key}.json"
+
+      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 << options.filters_as_url_params if options.filters.any?
+
+      url += '?' + params.join('&') if params.any?
+      url
+    end
   end
 end

data/lib/restpack_serializer/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Serializer
-    VERSION = '0.2.6'
+    VERSION = '0.2.7'
   end
 end

data/spec/serializable/options_spec.rb

@@ -12,6 +12,8 @@ describe RestPack::Serializer::Options do
     it { subject.page_size.should == 10 }
     it { subject.filters.should == {} }
     it { subject.scope.should == Song.scoped }
+    it { subject.default_page_size?.should == true }
+    it { subject.filters_as_url_params.should == '' }
   end
 
   describe 'with paging params' do
@@ -33,22 +35,27 @@ describe RestPack::Serializer::Options do
     describe 'with a primary key with a single value' do
       let(:params) { { 'id' => '142857' } }
       it { subject.filters.should == { id: ['142857'] } }
+      it { subject.filters_as_url_params.should == 'id=142857' }
     end
     describe 'with a primary key with multiple values' do
       let(:params) { { 'ids' => '42,142857' } }
       it { subject.filters.should == { id: ['42', '142857'] } }
+      it { subject.filters_as_url_params.should == 'id=42,142857' }
     end
     describe 'with a foreign key with a single value' do
       let(:params) { { 'album_id' => '789' } }
       it { subject.filters.should == { album_id: ['789'] } }
+      it { subject.filters_as_url_params.should == 'album_id=789' }
     end
     describe 'with a foreign key with multiple values' do
       let(:params) { { 'album_id' => '789,678,567' } }
       it { subject.filters.should == { album_id: ['789', '678', '567'] } }
+      it { subject.filters_as_url_params.should == 'album_id=789,678,567' }
     end
     describe 'with multiple foreign keys' do
       let(:params) { { 'album_id' => '111,222', 'artist_id' => '888,999' } }
       it { subject.filters.should == { album_id: ['111', '222'], artist_id: ['888', '999'] } }
+      it { subject.filters_as_url_params.should == 'album_id=111,222&artist_id=888,999' }
     end
   end
 

data/spec/serializable/paging_spec.rb

@@ -21,7 +21,9 @@ describe RestPack::Serializer::Paging do
         page[:meta][:songs][:count].should == 18
         page[:meta][:songs][:page_count].should == 2
         page[:meta][:songs][:previous_page].should == nil
+        page[:meta][:songs][:previous_href].should == nil
         page[:meta][:songs][:next_page].should == 2
+        page[:meta][:songs][:next_href].should == '/songs.json?page=2'
       end
       it "includes links" do
         page[:links].should == {
@@ -37,6 +39,10 @@ describe RestPack::Serializer::Paging do
         page[:meta][:songs][:page_size].should == 3
         page[:meta][:songs][:page_count].should == 6
       end
+      it "includes the custom page size in the page hrefs" do
+        page[:meta][:songs][:next_page].should == 2
+        page[:meta][:songs][:next_href].should == '/songs.json?page=2&page_size=3'
+      end
     end
 
     it "serializes results" do
@@ -71,6 +77,7 @@ describe RestPack::Serializer::Paging do
         page[:meta][:songs][:page].should == 2
         page[:meta][:songs][:previous_page].should == 1
         page[:meta][:songs][:next_page].should == nil
+        page[:meta][:songs][:previous_href].should == '/songs.json'
       end
     end
 
@@ -85,6 +92,10 @@ describe RestPack::Serializer::Paging do
         page[:meta][:songs][:includes].should == [:albums]
       end
 
+      it "includes the side-loads in page hrefs" do
+        page[:meta][:songs][:next_href].should == '/songs.json?page=2&includes=albums'
+      end
+
       context "with includes as comma delimited string" do
         let(:params) { { includes: "albums,artists" } }
         it "includes side-loaded models" do
@@ -92,6 +103,10 @@ describe RestPack::Serializer::Paging do
           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'
+        end
+
         it "includes links" do
           page[:links]['songs.album'].should_not == nil
           page[:links]['songs.artist'].should_not == nil
@@ -118,6 +133,10 @@ describe RestPack::Serializer::Paging do
         it "returns a page with songs from album1" do
           page[:meta][:songs][:count].should == @album1.songs.length
         end
+
+        it "includes the filter in page hrefs" do
+          page[:meta][:songs][:next_href].should == "/songs.json?page=2&album_id=#{@album1.id}"
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restpack_serializer
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Gavin Joyce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
+date: 2013-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord