restpack_serializer 0.4.27 → 0.4.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d11e2c868b50066fc5b49f6b8d29e168faf2b796
-  data.tar.gz: 00041f1def3a304b8ba4abbcebda28cd509b0f78
+  metadata.gz: 349f4fd2ffe9d0c1d9a7ccf4bcf724dd6ef59580
+  data.tar.gz: 9884153b0699c9f7fe9ced987b8284561cff48d3
 SHA512:
-  metadata.gz: 1594047af58178562a684999fb18b5cb5089f334e741fa78572e6847e93248125fcad82a90f373dfba596264bc0f1023ec7c8dd9d27f91477fa0c454e200b5f3
-  data.tar.gz: cf12374078885eb07db598c0a1d20c9c767a5e229becde7e9fab503e8851def1a4d2fd43378514b3166c5e50b620ab5c389857c80ae8b19b912125dfde103346
+  metadata.gz: b4792303f29da79c3dcf8518df080260d63dcdd89d620ca37b77388f2efdf0b2985d6e0d063624dc0d711c6aeadd6e12497ba0dc42266c2222bd5330bf1b88db
+  data.tar.gz: fb129097386e039f39fc6aa4964e97cdd36cf0a2825d53b27181c8d58486f5b9fef78856b76f083a0f9acae98aad29b4add0d5cb97b0c959179f4b900ef91b52

data/README.md

@@ -12,6 +12,17 @@ restpack_serializer allows you to quickly provide a set of RESTful endpoints for
 * [An overview of RestPack](http://www.slideshare.net/gavinjoyce/taming-monolithic-monsters)
 * [JSON API](http://jsonapi.org/)
 
+## Getting Started
+
+### For rails projects:
+After adding the gem `restpack_serializer` to your Gemfile, add this code to `config/initializers/restpack_serializer.rb`:
+
+```ruby
+Dir[Rails.root.join('app/serializers/**/*.rb')].each do |path|
+  require path
+end
+```
+
 ## Serialization
 
 Let's say we have an `Album` model:

data/lib/restpack_serializer.rb

@@ -1,5 +1,4 @@
 require 'kaminari'
-require 'protected_attributes'
 
 require 'restpack_serializer/version'
 require 'restpack_serializer/configuration'

data/lib/restpack_serializer/options.rb

@@ -7,9 +7,9 @@ module RestPack::Serializer
     def initialize(serializer, params = {}, scope = nil, context = {})
       params.symbolize_keys! if params.respond_to?(:symbolize_keys!)
 
-      @page = 1
-      @page_size = RestPack::Serializer.config.page_size
-      @include = []
+      @page = params[:page] ? params[:page].to_i : 1
+      @page_size = params[:page_size] ? params[:page_size].to_i : RestPack::Serializer.config.page_size
+      @include = params[:include] ? params[:include].split(',').map(&:to_sym) : []
       @filters = filters_from_params(params, serializer)
       @sorting = sorting_from_params(params, serializer)
       @serializer = serializer
@@ -17,19 +17,13 @@ module RestPack::Serializer
       @scope = scope || model_class.send(:all)
       @context = context
       @include_links = true
-
-      @page = params[:page].to_i if params[:page]
-      @page_size = params[:page_size].to_i if params[:page_size]
-      @include = params[:include].split(',').map(&:to_sym) if params[:include]
     end
 
     def scope_with_filters
       scope_filter = {}
+
       @filters.keys.each do |filter|
-        value = @filters[filter]
-        if value.is_a?(String)
-          value = value.split(',')
-        end
+        value = query_to_array(@filters[filter])
         scope_filter[filter] = value
       end
 
@@ -41,7 +35,7 @@ module RestPack::Serializer
     end
 
     def filters_as_url_params
-      @filters.sort.map {|k,v| "#{k}=#{v.join(',')}" }.join('&')
+      @filters.sort.map { |k,v| map_filter_ids(k,v) }.join('&')
     end
 
     def sorting_as_url_params
@@ -73,5 +67,25 @@ module RestPack::Serializer
       end
       sorting_parameters
     end
+
+    def map_filter_ids(key,value)
+      case value
+      when Hash
+        value.map { |k,v| map_filter_ids(k,v) }
+      else
+         "#{key}=#{value.join(',')}"
+      end
+    end
+
+    def query_to_array(value)
+      case value
+        when String
+          value.split(',')
+        when Hash
+          value.each { |k, v| value[k] = query_to_array(v) }
+        else
+          value
+      end
+    end
   end
 end

data/lib/restpack_serializer/serializable.rb

@@ -71,6 +71,11 @@ module RestPack
           if foreign_key_value
             data[:links][association.name.to_sym] = foreign_key_value.to_s
           end
+        elsif association.macro == :has_many && association.options[:through]
+          ids = model.send(association.name).pluck(:id).map { |id| id.to_s }
+
+          data[:links] ||= {}
+          data[:links][association.name.to_sym] = ids
         end
       end
       data

data/lib/restpack_serializer/serializable/side_loading.rb

@@ -85,10 +85,21 @@ module RestPack::Serializer::SideLoading
 
     def side_load_has_many(association, models, serializer)
       return {} if models.empty?
+
+      join_table = association.options[:through]
+
+      filters = if join_table
+        { join_table => { association.through_reflection.foreign_key.to_sym => models.map(&:id) } }
+      else
+        { association.foreign_key.to_sym => models.map(&:id) }
+      end
+
       options = RestPack::Serializer::Options.new(serializer.class)
-      options.filters = { association.foreign_key.to_sym => models.map(&:id) }
+      options.scope = options.scope.joins(join_table) if join_table
+      options.filters = filters
       options.include_links = false
-      return serializer.class.page_with_options(options)
+
+      serializer.class.page_with_options(options)
     end
 
     def association_from_include(include)

data/lib/restpack_serializer/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Serializer
-    VERSION = '0.4.27'
+    VERSION = '0.4.28'
   end
 end

data/restpack_serializer.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'activesupport', ['>= 4.0.3', '< 5.0']
   gem.add_dependency 'activerecord', ['>= 4.0.3', '< 5.0']
-  gem.add_dependency 'protected_attributes', '~> 1.0.5'
   gem.add_dependency 'kaminari', '~> 0.15.1'
 
   gem.add_development_dependency 'restpack_gem', '~> 0.0.9'
@@ -31,4 +30,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'database_cleaner', '~> 1.0.1'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'bump'
+  gem.add_development_dependency 'protected_attributes', '~> 1.0.5'
 end

data/spec/fixtures/db.rb

@@ -41,6 +41,13 @@ ActiveRecord::Schema.define(:version => 1) do
   create_table "payments", :force => true do |t|
     t.integer "amount"
     t.integer  "artist_id"
+    t.integer  "fan_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "fans", :force => true do |t|
+    t.string "name"
     t.datetime "created_at"
     t.datetime "updated_at"
   end
@@ -53,6 +60,7 @@ module MyApp
     has_many :albums
     has_many :songs
     has_many :payments
+    has_many :fans, :through => :payments
   end
 
   class Album < ActiveRecord::Base
@@ -82,5 +90,12 @@ module MyApp
     attr_accessible :amount, :artist
 
     belongs_to :artist
+    belongs_to :fan
+  end
+
+  class Fan < ActiveRecord::Base
+    attr_accessible :name
+    has_many :payments
+    has_many :artists, :through => :albums
   end
 end

data/spec/fixtures/serializers.rb

@@ -27,6 +27,11 @@ module MyApp
   class ArtistSerializer
     include RestPack::Serializer
     attributes :id, :name, :website
-    can_include :albums, :songs
+    can_include :albums, :songs, :fans
+  end
+
+  class FanSerializer
+    include RestPack::Serializer
+    attributes :id, :name
   end
 end

data/spec/serializable/serializer_spec.rb

@@ -139,14 +139,30 @@ describe RestPack::Serializer do
     end
 
     context "links" do
-      let(:serializer) { MyApp::SongSerializer.new }
-      it "includes 'links' data" do
-        @album1 = FactoryGirl.create(:album_with_songs, song_count: 11)
-        json = serializer.as_json(@album1.songs.first)
-        json[:links].should == {
-          artist: @album1.artist_id.to_s,
-          album: @album1.id.to_s
-        }
+      context "'belongs to' associations" do
+        let(:serializer) { MyApp::SongSerializer.new }
+
+        it "includes 'links' data for :belongs_to associations" do
+          @album1 = FactoryGirl.create(:album_with_songs, song_count: 11)
+          json = serializer.as_json(@album1.songs.first)
+          json[:links].should == {
+            artist: @album1.artist_id.to_s,
+            album: @album1.id.to_s
+          }
+        end
+      end
+
+      context "'has_many, through' associations" do
+        let(:artist_serializer) { MyApp::ArtistSerializer.new }
+
+        it "includes 'links' data when there are associated records" do
+          artist_with_fans = FactoryGirl.create :artist_with_fans
+
+          json = artist_serializer.as_json(artist_with_fans)
+          json[:links].should == {
+            fans: artist_with_fans.fans.collect {|obj| obj.id.to_s }
+          }
+        end
       end
     end
   end

data/spec/serializable/side_loading/has_many_spec.rb

@@ -2,13 +2,14 @@ require 'spec_helper'
 
 describe RestPack::Serializer::SideLoading do
   context "when side-loading" do
+    let(:side_loads) { MyApp::ArtistSerializer.side_loads(models, options) }
+
     describe ".has_many" do
 
       before(:each) do
         @artist1 = FactoryGirl.create(:artist_with_albums, album_count: 2)
         @artist2 = FactoryGirl.create(:artist_with_albums, album_count: 1)
       end
-      let(:side_loads) { MyApp::ArtistSerializer.side_loads(models, options) }
 
       context "with a single model" do
         let(:models) { [@artist1] }
@@ -37,7 +38,35 @@ describe RestPack::Serializer::SideLoading do
           end
         end
       end
+    end
+
+    describe '.has_many through' do
+      context 'when including :fans' do
+        let(:options) { RestPack::Serializer::Options.new(MyApp::ArtistSerializer, { "include" => "fans" }) }
+        let(:artist_1) {FactoryGirl.create :artist_with_fans}
+        let(:artist_2) {FactoryGirl.create :artist_with_fans}
 
+        context "with a single model" do
+          let(:models) {[artist_1]}
+
+          it 'returns side-loaded fans' do
+            side_loads[:fans].count.should == artist_1.fans.count
+            side_loads[:meta][:fans][:page].should == 1
+            side_loads[:meta][:fans][:count].should == artist_1.fans.count
+          end
+        end
+        context "with a multiple models" do
+          let(:models) {[artist_1, artist_2]}
+
+          it 'returns side-loaded fans' do
+            expected_count = artist_1.fans.count  + artist_2.fans.count
+
+            side_loads[:fans].count.should == expected_count
+            side_loads[:meta][:fans][:page].should == 1
+            side_loads[:meta][:fans][:count].should == expected_count
+          end
+        end
+      end
     end
   end
 end

data/spec/support/factory.rb

@@ -14,6 +14,15 @@ FactoryGirl.define do
         create_list(:album_with_songs, evaluator.album_count, artist: artist)
       end
     end
+
+    factory :artist_with_fans do
+      ignore do
+        fans_count 3
+      end
+      after(:create) do |artist, evaluator|
+        create_list(:payment, evaluator.fans_count, artist: artist)
+      end
+    end
   end
 
   factory :album, :class => MyApp::Album do
@@ -41,5 +50,10 @@ FactoryGirl.define do
   factory :payment, :class => MyApp::Payment do
     amount 999
     artist
+    fan
+  end
+
+  factory :fan, :class => MyApp::Fan do
+    sequence(:name) {|n| "Fan ##{n}"}
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restpack_serializer
 version: !ruby/object:Gem::Version
-  version: 0.4.27
+  version: 0.4.28
 platform: ruby
 authors:
 - Gavin Joyce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -50,20 +50,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: protected_attributes
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
@@ -204,6 +190,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: protected_attributes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
 description: Model serialization, paging, side-loading and filtering
 email:
 - gavinjoyce@gmail.com