restpack_serializer 0.2.3

data/spec/serializable/serializer_spec.rb

@@ -0,0 +1,102 @@
+require './spec/spec_helper'
+
+describe RestPack::Serializer do
+  let(:serializer) { PersonSerializer.new }
+  let(:person) { Person.new(id: 123, name: 'Gavin', age: 36) }
+  class Person
+    attr_accessor :id, :name, :age
+
+    def initialize(attributes = {})
+      @id = attributes[:id]
+      @name = attributes[:name]
+      @age = attributes[:age]
+    end
+
+    def self.table_name
+      "people"
+    end
+  end
+
+  context "bare bones serializer" do
+    class EmptySerializer
+      include RestPack::Serializer
+    end
+
+    it "serializes to an empty hash" do
+      EmptySerializer.as_json(person).should == { }
+    end
+  end
+
+  class PersonSerializer
+    include RestPack::Serializer
+    attributes :id, :name, :url, :admin_info
+
+    def url
+      "/api/v1/people/#{id}.json"
+    end
+
+    def admin_info
+      { key: "super_secret_sauce" }
+    end
+
+    def include_admin_info?
+      @options[:is_admin?]
+    end
+  end
+
+  describe ".as_json" do
+    it "serializes specified attributes" do
+      serializer.as_json(person).should == {
+        id: '123', name: 'Gavin', url: '/api/v1/people/123.json'
+      }
+    end
+
+    context "with options" do
+      it "excludes specified attributes" do
+        serializer.as_json(person, { include_url?: false }).should == {
+          id: '123', name: 'Gavin'
+        }
+      end
+
+      it "excludes custom attributes if specified" do
+        hash = serializer.as_json(person, { is_admin?: false })
+        hash[:admin_info].should == nil
+      end
+
+      it "includes custom attributes if specified" do
+        hash = serializer.as_json(person, { is_admin?: true })
+        hash[:admin_info].should == { key: "super_secret_sauce" }
+      end
+    end
+
+    context "links" do
+      let(:serializer) { 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
+        }
+      end
+    end
+  end
+
+  describe "#model_name" do
+    it "extracted the Model name from the Serializer name" do
+      PersonSerializer.model_name.should == "Person"
+    end
+  end
+
+  describe "#model_class" do
+    it "returns the correct class" do
+      PersonSerializer.model_class.should == Person
+    end
+  end
+
+  describe "#key" do
+    it "returns the correct key" do
+      PersonSerializer.key.should == :people
+    end
+  end
+end

data/spec/serializable/side_loading/belongs_to_spec.rb

@@ -0,0 +1,72 @@
+require './spec/spec_helper'
+
+describe RestPack::Serializer::SideLoading do
+  context "when side-loading" do
+    describe ".belongs_to" do
+
+      before(:each) do
+        FactoryGirl.create(:artist_with_albums, album_count: 2)
+        FactoryGirl.create(:artist_with_albums, album_count: 1)
+      end
+      let(:side_loads) { SongSerializer.side_loads(models, options) }
+
+      context "with no models" do
+        let(:models) { [] }
+
+        context "no side-loads" do
+          let(:options) { RestPack::Serializer::Options.new(Song) }
+
+          it "returns a hash with no data" do
+            side_loads.should == { :meta => {} }
+          end
+        end
+
+        context "when including :albums" do
+          let(:options) { RestPack::Serializer::Options.new(Song, { "includes" => "albums" }) }
+
+          it "returns a hash with no data" do
+            side_loads.should == { :meta => {} }
+          end
+        end
+      end
+
+      context "with a single model" do
+        let(:models) { [Song.first] }
+
+        context "when including :albums" do
+          let(:options) { RestPack::Serializer::Options.new(Song, { "includes" => "albums" }) }
+
+          it "returns side-loaded albums" do
+            side_loads.should == {
+              albums: [AlbumSerializer.as_json(Song.first.album)],
+              meta: { }
+            }
+          end
+        end
+      end
+
+      context "with multiple models" do
+        let(:artist1) { Artist.find(1) }
+        let(:artist2) { Artist.find(2) }
+        let(:song1) { artist1.songs.first }
+        let(:song2) { artist2.songs.first }
+        let(:models) { [song1, song2] }
+
+        context "when including :albums" do
+          let(:options) { RestPack::Serializer::Options.new(Song, { "includes" => "albums" }) }
+
+          it "returns side-loaded albums" do
+            side_loads.should == {
+              albums: [
+                AlbumSerializer.as_json(song1.album),
+                AlbumSerializer.as_json(song2.album)
+              ],
+              :meta => { }
+            }
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/serializable/side_loading/has_many_spec.rb

@@ -0,0 +1,43 @@
+require './spec/spec_helper'
+
+describe RestPack::Serializer::SideLoading do
+  context "when side-loading" do
+    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) { ArtistSerializer.side_loads(models, options) }
+
+      context "with a single model" do
+        let(:models) { [@artist1] }
+
+        context "when including :albums" do
+          let(:options) { RestPack::Serializer::Options.new(Artist, { "includes" => "albums" }) }
+
+          it "returns side-loaded albums" do
+            side_loads[:albums].count.should == @artist1.albums.count
+            side_loads[:meta][:albums][:page].should == 1
+            side_loads[:meta][:albums][:count].should == @artist1.albums.count
+          end
+        end
+      end
+
+      context "with two models" do
+        let(:models) { [@artist1, @artist2] }
+
+        context "when including :albums" do
+          let(:options) { RestPack::Serializer::Options.new(Artist, { "includes" => "albums" }) }
+
+          it "returns side-loaded albums" do
+            expected_count = @artist1.albums.count + @artist2.albums.count
+            side_loads[:albums].count.should == expected_count
+            side_loads[:meta][:albums][:count].should == expected_count
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/serializable/side_loading/side_loading_spec.rb

@@ -0,0 +1,82 @@
+require './spec/spec_helper'
+
+describe RestPack::Serializer::SideLoading do
+  context "invalid :includes" do
+    before(:each) do
+      FactoryGirl.create(:song)
+    end
+
+    context "an include to an inexistent model" do
+      it "raises an exception" do
+        exception = RestPack::Serializer::InvalidInclude
+        message = ":wrong is not a valid include for Song"
+
+        expect do
+          SongSerializer.side_loads([Song.first], RestPack::Serializer::Options.new(Song, { "includes" => "wrong" }))
+        end.to raise_error(exception, message)
+      end
+    end
+
+    context "an include to a model which has not been whitelisted with 'can_include'" do
+      it "raises an exception" do
+        payment = FactoryGirl.create(:payment)
+        exception = RestPack::Serializer::InvalidInclude
+        message = ":payments is not a valid include for Artist"
+
+        expect do
+          ArtistSerializer.side_loads([payment.artist], RestPack::Serializer::Options.new(Artist, { "includes" => "payments" }))
+        end.to raise_error(exception, message)
+      end
+    end
+  end
+
+  describe "#can_include" do
+    class CustomSerializer
+      include RestPack::Serializer
+      attributes :a, :b, :c
+    end
+    it "defaults to empty array" do
+      CustomSerializer.can_includes.should == []
+    end
+
+    it "allows includes to be specified" do
+      class CustomSerializer
+        can_include :model1
+        can_include :model2, :model3
+      end
+
+      CustomSerializer.can_includes.should == [:model1, :model2, :model3]
+    end
+  end
+
+  describe "#links" do
+    AlbumSerializer.links.should == {
+      "albums.artists" => {
+        :href => "/artists/{albums.artist}.json",
+        :type => :artists
+      },
+      "albums.songs" => {
+        :href => "/songs.json?album_id={albums.id}",
+        :type => :songs
+      }
+    }
+  end
+
+  describe "#filterable_by" do
+    context "a model with no :belongs_to relations" do
+      it "is filterable by :id only" do
+        ArtistSerializer.filterable_by.should == [:id]
+      end
+    end
+    context "a model with a single :belongs_torelations" do
+      it "is filterable by primary key and foreign keys" do
+        AlbumSerializer.filterable_by.should =~ [:id, :artist_id]
+      end
+    end
+    context "a model with multiple :belongs_to relations" do
+      it "is filterable by primary key and foreign keys" do
+        SongSerializer.filterable_by.should =~ [:id, :artist_id, :album_id]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'rspec'
+require './lib/restpack_serializer'
+require './spec/fixtures/db'
+require './spec/fixtures/serializers'
+require './spec/support/factory'
+require 'database_cleaner'
+
+FactoryGirl.find_definitions
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, :js => true) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/factory.rb

@@ -0,0 +1,45 @@
+  require 'factory_girl'
+
+FactoryGirl.define do
+  factory :artist do
+    sequence(:name) {|n| "Artist ##{n}" }
+    sequence(:website) {|n| "http://website#{n}.com/" }
+
+    factory :artist_with_albums do
+      ignore do
+        album_count 3
+      end
+
+      after(:create) do |artist, evaluator|
+        create_list(:album_with_songs, evaluator.album_count, artist: artist)
+      end
+    end
+  end
+
+  factory :album do
+    sequence(:title) {|n| "Album ##{n}" }
+    sequence(:year) {|n| 1960 + n }
+    artist
+
+    factory :album_with_songs do
+      ignore do
+        song_count 10
+      end
+
+      after(:create) do |album, evaluator|
+        create_list(:song, evaluator.song_count, album: album, artist: album.artist)
+      end
+    end
+  end
+
+  factory :song do
+    sequence(:title) {|n| "Song ##{n}" }
+    artist
+    album
+  end
+
+  factory :payment do
+    amount 999
+    artist
+  end
+end

metadata

@@ -0,0 +1,266 @@
+--- !ruby/object:Gem::Specification
+name: restpack_serializer
+version: !ruby/object:Gem::Version
+  version: 0.2.3
+  prerelease: 
+platform: ruby
+authors:
+- Gavin Joyce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Model serialization, paging, side-loading and filtering
+email:
+- gavinjoyce@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/restpack_serializer.rb
+- lib/restpack_serializer/factory.rb
+- lib/restpack_serializer/options.rb
+- lib/restpack_serializer/serializable.rb
+- lib/restpack_serializer/serializable/attributes.rb
+- lib/restpack_serializer/serializable/paging.rb
+- lib/restpack_serializer/serializable/resource.rb
+- lib/restpack_serializer/serializable/side_loading.rb
+- lib/restpack_serializer/version.rb
+- restpack_serializer.gemspec
+- spec/factory/factory_spec.rb
+- spec/fixtures/db.rb
+- spec/fixtures/serializers.rb
+- spec/serializable/attributes_spec.rb
+- spec/serializable/options_spec.rb
+- spec/serializable/paging_spec.rb
+- spec/serializable/resource_spec.rb
+- spec/serializable/serializer_spec.rb
+- spec/serializable/side_loading/belongs_to_spec.rb
+- spec/serializable/side_loading/has_many_spec.rb
+- spec/serializable/side_loading/side_loading_spec.rb
+- spec/spec_helper.rb
+- spec/support/factory.rb
+homepage: https://github.com/RestPack
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Model serialization, paging, side-loading and filtering
+test_files:
+- spec/factory/factory_spec.rb
+- spec/fixtures/db.rb
+- spec/fixtures/serializers.rb
+- spec/serializable/attributes_spec.rb
+- spec/serializable/options_spec.rb
+- spec/serializable/paging_spec.rb
+- spec/serializable/resource_spec.rb
+- spec/serializable/serializer_spec.rb
+- spec/serializable/side_loading/belongs_to_spec.rb
+- spec/serializable/side_loading/has_many_spec.rb
+- spec/serializable/side_loading/side_loading_spec.rb
+- spec/spec_helper.rb
+- spec/support/factory.rb