xing-backend 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 862c1da5f835e9cd13790d7bc67c4739d14bc4f8
-  data.tar.gz: b02e0ee68d0d8cffa10fc9ec4a203907ebfed41f
+  metadata.gz: 827d47919fcc3646787ebec8fd234016afbddb78
+  data.tar.gz: 270b23ee03b4fcb2adfae0993069dd12f5c38bef
 SHA512:
-  metadata.gz: 64f348a5ae8f9a76d14afbb4a23ad8fabe05bca393b49d21e7facbec9d7bb8ee2657d91b3816d17bd4d20e054e1dcabe651a1027761ad9fdaa7b7a8b9cfc577f
-  data.tar.gz: b29cbe4dec8c39c58d0cafb97103556ce9a9dcc9aa79a76c1631796b102f748f9e5a08fea5c429f3dd5036a70faaa2e67c32d3324f98cb5d43839647912aad3f
+  metadata.gz: af3d2370c38452056e039a5e8409ed3602ef9f2ffc4633270695b551cdba582a9a48446f907bf9c5e17370907b950c75f0691208e9bafad957f3ae7a9d733cbb
+  data.tar.gz: c4dcade49aeac1b828d90f2df37e6ef56e0734acdc44bcc37869a2fb0e7dec7d75c302cf7f369d728266514e7a0122a1f8b154318ec370d7ef6c4d123f7dc2a5

data/lib/xing/serializers.rb

@@ -4,4 +4,5 @@ module Xing
 end
 
 require 'xing/serializers/base'
+require 'xing/serializers/paged_list'
 require 'xing/serializers/root_resources'

data/lib/xing/serializers/paged_list.rb

@@ -0,0 +1,55 @@
+require 'xing/serializers/base'
+
+module Xing::Serializers
+  class PagedList < Base
+    def initialize(list, page_num, total_pages, options = {})
+      @page_num = page_num.to_i
+      @total_pages = total_pages
+
+      super(list, options)
+    end
+
+    attr_reader :page_num, :total_pages
+
+    def item_serializer_class
+      raise NotImplemented,
+        "subclasses of Xing::Serializers::PagesData must override item_serializer_class to refer to the per-item serializer"
+    end
+
+    def item_serializer_options
+      {}
+    end
+
+    def page_link(options)
+      raise NotImplemented,
+        "subclasses of Xing::Serializers::PagesData must override page_link to return the URL of a page based on a :page => Integer() hash"
+    end
+
+    def self_link
+      raise NotImplemented,
+        "subclasses of Xing::Serializers::PagesData must override self_link to return their own path"
+    end
+
+    def as_json_without_wrap(options={})
+      object.map do |item|
+        item_serializer_class.new(item, item_serializer_options).as_json
+      end
+    end
+
+    def next_link
+      page_link({page: page_num + 1}) unless page_num == total_pages
+    end
+
+    def previous_link
+      page_link({page: page_num - 1}) unless page_num == 1
+    end
+
+    def links
+      {
+        :self => self_link,
+        :next => next_link,
+        :previous => previous_link
+      }
+    end
+  end
+end

data/spec/xing/serializers/base_spec.rb

@@ -1,7 +1,6 @@
 require 'xing/serializers/base'
 require 'json_spec'
 
-
 describe Xing::Serializers::Base do
   include JsonSpec::Matchers
 

data/spec/xing/serializers/paged_list_spec.rb

@@ -0,0 +1,118 @@
+require 'xing/serializers/paged_list'
+require 'json_spec'
+
+describe Xing::Serializers::PagedList do
+  include JsonSpec::Matchers
+
+  class ItemSerializer < Xing::Serializers::Base
+    attributes :name, :position
+    def links
+      { :self => 'url_for_this_model' }
+    end
+  end
+
+  class PageSerializer < Xing::Serializers::PagedList
+    def item_serializer_class
+      ItemSerializer
+    end
+
+    # Structures a testable "link" text
+    def page_link(options)
+      page_num = options.delete(:page)
+      "page_link:#{page_num}-#{options.keys.join(",")}"
+    end
+
+    def self_link
+      "url_for_this_page"
+    end
+  end
+
+  let :list do
+    (1..3).map do |index|
+      double("a mock activemodel").tap do |model|
+        allow(model).to receive(:read_attribute_for_serialization).with(:name).and_return("Name #{index}!")
+        allow(model).to receive(:read_attribute_for_serialization).with(:position).and_return(index)
+      end
+    end
+  end
+
+  let :total_pages do 3 end
+
+  let :serializer do
+    PageSerializer.new(list, page_num, total_pages)
+  end
+
+  let :json do
+    serializer.to_json
+  end
+
+  describe 'as_json' do
+    let :page_num do 1 end
+
+    it "should have the correct structure" do
+      expect(json).to have_json_path('links/self')
+      expect(json).to have_json_path('links/next')
+      expect(json).to have_json_path('links/previous')
+      expect(json).to have_json_path('data/')
+    end
+
+    it "should generate a JSON with the proper links and self" do
+      expect(json).to be_json_eql('"url_for_this_page"').at_path('links/self')
+      expect(json).to be_json_eql('"page_link:2-"').at_path('links/next')
+      expect(json).to be_json_eql('"Name 2!"').at_path('data/1/data/name')
+      expect(json).to be_json_eql('2').at_path('data/1/data/position')
+      expect(json).to be_json_eql('"url_for_this_model"').at_path('data/1/links/self')
+    end
+
+    it "should call the video response serializer" do
+      expect(ItemSerializer).to receive(:new).with(list[0], anything)
+      expect(ItemSerializer).to receive(:new).with(list[1], anything)
+      expect(ItemSerializer).to receive(:new).with(list[2], anything)
+      expect(json).to have_json_size(3).at_path('data')
+    end
+  end
+
+  describe 'links' do
+    context 'first page' do
+      let :page_num do
+        1
+      end
+
+      it 'should not have a previous link' do
+        expect(serializer.previous_link).to be_nil
+      end
+
+      it 'should have a next link' do
+        expect(serializer.next_link).to_not be_nil
+      end
+    end
+
+    context 'last page' do
+      let :page_num do
+        3
+      end
+
+      it 'should have a previous link' do
+        expect(serializer.previous_link).to_not be_nil
+      end
+
+      it 'should not have a next link' do
+        expect(serializer.next_link).to be_nil
+      end
+    end
+
+    context 'neither first page or last page' do
+      let :page_num do
+        2
+      end
+
+      it 'should have a previous link' do
+        expect(serializer.previous_link).to_not be_nil
+      end
+
+      it 'should have a next link' do
+        expect(serializer.next_link).to_not be_nil
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xing-backend
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Evan Dorn
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.2.1
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +132,7 @@ files:
 - lib/xing/mappers/base.rb
 - lib/xing/serializers.rb
 - lib/xing/serializers/base.rb
+- lib/xing/serializers/paged_list.rb
 - lib/xing/serializers/root_resources.rb
 - lib/xing/services.rb
 - lib/xing/services/error_converter.rb
@@ -148,6 +149,7 @@ files:
 - spec/xing/controllers/root_resources_controller_spec.rb
 - spec/xing/mappers/base_spec.rb
 - spec/xing/serializers/base_spec.rb
+- spec/xing/serializers/paged_list_spec.rb
 - spec/xing/serializers/root_resources_spec.rb
 - spec/xing/services/error_converter_spec.rb
 - spec/xing/services/json_tree_lister_spec.rb
@@ -200,7 +202,7 @@ rdoc_options:
 - "--main"
 - doc/README
 - "--title"
-- xing-backend-0.0.11 Documentation
+- xing-backend-0.0.12 Documentation
 require_paths:
 - lib/
 required_ruby_version: !ruby/object:Gem::Requirement