xing-backend 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8124784dfc906a44033c779b625e825133266b78
-  data.tar.gz: ef03e6925c23a2b62f28e9de03db9463a78dba24
+  metadata.gz: a7bb90034c2383f0866fde062f849ea3aabace59
+  data.tar.gz: a5823af9381a90361195f139eb80292cb085f738
 SHA512:
-  metadata.gz: 476da8b9dfc5228f14460bd93706c9acadea42784f11bd646a3d5d63ea31d7c859eff7f0f59fc8e7b0831d1c03b3c91daefec1fbbf0e6dfab35eba2866a39138
-  data.tar.gz: ba5adaf5ed0f9af7b4a1fcaf6c80e981f44b92c536f0d9d5eea070f78c1f0d90be6e6173d034cdb29dfd25c6352ff3d88254d261876797b040b44f1272452d99
+  metadata.gz: 43fd7dd223af84a296b348e0731aaaf800ff4b41b61068df3069dd9dd8f934cb4bdd4ec5228a9af313a107442a0ae3192598951da13ef40943beffef481b5382
+  data.tar.gz: d0b79eed9ed10eb308b65b0104c7fe6d93a36aa63853139157b98ade4445979fc05c65fbaa5f5fcc371d4d3d4c93245aae46837a31a80e8dc4f731117854195e

data/lib/xing/serializers/paged.rb

@@ -0,0 +1,35 @@
+module Xing::Serializers
+  module Paged
+    def template_link
+      raise NotImplementedError,
+        "subclasses of Xing::Serializers::PagedList must override template_link to provide a path URL template with a single :page field\n" +
+        "usually you can do something like my_resource_path_rfc6570 (sometimes you'll need to also call .partial_expand)\n\n" +
+        "If you prefer, you can return nil from template_link and override page_link to do something else."
+    end
+
+    def total_pages
+      object.total_pages
+    end
+
+    def first_link
+      page_link({page: 1})
+    end
+
+    def last_link
+      page_link({page: total_pages})
+    end
+
+    def page_link(options)
+      template_link.expand(options)
+    end
+
+    def links
+      {
+        :self => self_link,
+        :first => first_link,
+        :last => last_link,
+        :template => template_link
+      }
+    end
+  end
+end

data/lib/xing/serializers/paged_index.rb

@@ -0,0 +1,35 @@
+require 'xing/serializers/base'
+require 'xing/serializers/paged'
+
+module Xing::Serializers
+  # Serializes the reference index of a long paginated list. We assume the
+  # interface provided by Kaminari: the object to be serialized needs to
+  # respond to:
+  #
+  #   current_page, limit_value, total_pages, total_count, each(and various
+  #   Enumerable methods)
+
+  class PagedIndex < Base
+    include Paged
+
+    def self.total_called(name)
+      attributes name
+      alias_method name, :total_items
+    end
+
+    attributes :per_page, :total_pages, :total_items
+
+    def total_items
+      object.total_count
+    end
+
+    def per_page
+      object.limit_value
+    end
+
+    def self_link
+      raise NotImplementedError,
+        "subclasses of Xing::Serializers::PagedIndex must override self_link to provide a path URL to themselves"
+    end
+  end
+end

data/lib/xing/serializers/paged_list.rb

@@ -1,19 +1,19 @@
 require 'xing/serializers/list'
+require 'xing/serializers/paged'
 
 module Xing::Serializers
-  class PagedList < List
-    def initialize(list, page_num, total_pages, options = {})
-      @page_num = page_num.to_i
-      @total_pages = total_pages
 
-      super(list, options)
-    end
+  # Serializes a single page of a long paginated list. We assume the interface
+  # provided by Kaminari: the object to be serialized needs to respond to:
+  #
+  #   current_page, limit_value, total_pages, total_count, each(and various
+  #   Enumerable methods)
 
-    attr_reader :page_num, :total_pages
+  class PagedList < List
+    include Paged
 
-    def page_link(options)
-      raise NotImplementedError,
-        "subclasses of Xing::Serializers::PagesData must override page_link to return the URL of a page based on a :page => Integer() hash"
+    def page_num
+      object.current_page
     end
 
     def next_link
@@ -25,11 +25,10 @@ module Xing::Serializers
     end
 
     def links
-      {
-        :self => self_link,
-        :next => next_link,
-        :previous => previous_link
-      }
+      super.merge(
+                  :next => next_link,
+                  :previous => previous_link
+                 )
     end
   end
 end

data/lib/xing/services/page_wrapper.rb

@@ -0,0 +1,25 @@
+module Xing::Services
+  # If you want to use the PagedList serializers, but are using resources that
+  # aren't actually provided by Kaminari, you can instead feed them to
+  # PageWrapper and you should get everything you need
+  class PageWrapper
+    include Enumerable
+
+    def initialize(list, page_num, total_items, per_page)
+      @list, @total_items, @per_page, @page_num = list, total_items, per_page, page_num
+    end
+    attr_reader :list, :total_items, :per_page, :page_num
+
+    alias current_page page_num
+    alias total_count total_items
+    alias limit_value per_page
+
+    def total_pages
+      (total_items / per_page.to_f).ceil
+    end
+
+    def each(*args, &block)
+      @list.each(*args, &block)
+    end
+  end
+end

data/spec/xing/mappers/base_spec.rb

@@ -32,7 +32,7 @@ describe Xing::Mappers::Base do
 
       expect do
         mapper.save
-      end.to raise_error
+      end.to raise_error(NameError, /update_record/)
     end
 
     it "shouldn't error if it does have an update_record and a record_class method" do

data/spec/xing/serializers/paged_index_spec.rb

@@ -0,0 +1,73 @@
+require 'xing/serializers/paged_index'
+require 'xing/services/page_wrapper'
+
+describe Xing::Serializers::PagedIndex do
+  class PageIndexSerializer < Xing::Serializers::PagedIndex
+    def self_link
+      "url_for_index"
+    end
+
+    def template_link
+      Addressable::Template.new("/page{/page}")
+    end
+  end
+
+  let :per_page do
+    3
+  end
+
+  let :list do
+    (1..per_page).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 :page_num do 1 end
+
+  let :total_pages do 3 end
+
+  let :total_items do
+    total_pages * per_page - 1
+  end
+
+  let :json do
+    serializer.to_json
+  end
+
+  describe 'as_json' do
+    let :serializer do
+      PageIndexSerializer.new(Xing::Services::PageWrapper.new(list, page_num, total_items, per_page))
+    end
+
+    it "should generate a JSON with the proper links and self" do
+      expect(parse_json(json, "links/self")).to eq("url_for_index")
+      expect(parse_json(json, "links/first")).to eq("/page/1")
+      expect(parse_json(json, "links/last")).to eq("/page/3")
+      expect(parse_json(json, "data/per_page")).to eq(per_page)
+      expect(parse_json(json, "data/total_pages")).to eq(total_pages)
+      expect(parse_json(json, "data/total_items")).to eq(total_items)
+    end
+  end
+
+  describe 'using Kaminari' do
+    let :kaminari_list do
+      Kaminari.paginate_array((list * 3)[0..-2]).page(1).per(per_page)
+    end
+
+    let :serializer do
+      PageIndexSerializer.new(kaminari_list)
+    end
+
+    it "should generate a JSON with the proper links and self" do
+      expect(parse_json(json, "links/self")).to eq("url_for_index")
+      expect(parse_json(json, "links/first")).to eq("/page/1")
+      expect(parse_json(json, "links/last")).to eq("/page/3")
+      expect(parse_json(json, "data/per_page")).to eq(per_page)
+      expect(parse_json(json, "data/total_pages")).to eq(total_pages)
+      expect(parse_json(json, "data/total_items")).to eq(total_items)
+    end
+  end
+end

data/spec/xing/serializers/paged_list_spec.rb

@@ -1,9 +1,6 @@
 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
@@ -16,10 +13,8 @@ describe Xing::Serializers::PagedList do
       ItemSerializer
     end
 
-    # Structures a testable "link" text
-    def page_link(options)
-      page_num = options.delete(:page)
-      "page_link:#{page_num}-#{options.keys.join(",")}"
+    def template_link
+      Addressable::Template.new("/page{/page}")
     end
 
     def self_link
@@ -27,8 +22,12 @@ describe Xing::Serializers::PagedList do
     end
   end
 
+  let :per_page do
+    3
+  end
+
   let :list do
-    (1..3).map do |index|
+    (1..per_page).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)
@@ -38,8 +37,12 @@ describe Xing::Serializers::PagedList do
 
   let :total_pages do 3 end
 
+  let :total_items do
+    total_pages * per_page - 1
+  end
+
   let :serializer do
-    PageSerializer.new(list, page_num, total_pages)
+    PageSerializer.new(Xing::Services::PageWrapper.new(list, page_num, total_items, per_page))
   end
 
   let :json do
@@ -57,11 +60,49 @@ describe Xing::Serializers::PagedList do
     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')
+      expect(parse_json(json, "links/self")).to eq("url_for_this_page")
+      expect(parse_json(json, "links/next")).to eq("/page/2")
+      expect(parse_json(json, "links/first")).to eq("/page/1")
+      expect(parse_json(json, "links/last")).to eq("/page/3")
+      expect(parse_json(json, "data/1/data/name")).to eq("Name 2!")
+      expect(parse_json(json, "data/1/data/position")).to eq(2)
+      expect(parse_json(json, "data/1/links/self")).to eq("url_for_this_model")
+    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 'using Kaminara' do
+    let :kaminari_list do
+      Kaminari.paginate_array(list * 3).page(1).per(per_page)
+    end
+
+    let :serializer do
+      PageSerializer.new(kaminari_list)
+    end
+
+    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(parse_json(json, "links/self")).to eq("url_for_this_page")
+      expect(parse_json(json, "links/next")).to eq("/page/2")
+      expect(parse_json(json, "links/first")).to eq("/page/1")
+      expect(parse_json(json, "links/last")).to eq("/page/3")
+      expect(parse_json(json, "data/1/data/name")).to eq("Name 2!")
+      expect(parse_json(json, "data/1/data/position")).to eq(2)
+      expect(parse_json(json, "data/1/links/self")).to eq("url_for_this_model")
     end
 
     it "should call the video response serializer" do

data/spec_help/spec_helper.rb

@@ -26,4 +26,6 @@ RSpec.configure do |config|
   config.around(:type => :deprecation) do |example|
     ActiveSupport::Deprecation.silence(&example)
   end
+
+  config.include JsonSpec::Helpers
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xing-backend
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Evan Dorn
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2016-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -135,12 +135,15 @@ files:
 - lib/xing/serializers.rb
 - lib/xing/serializers/base.rb
 - lib/xing/serializers/list.rb
+- lib/xing/serializers/paged.rb
+- lib/xing/serializers/paged_index.rb
 - lib/xing/serializers/paged_list.rb
 - lib/xing/serializers/root_resources.rb
 - lib/xing/services.rb
 - lib/xing/services/error_converter.rb
 - lib/xing/services/json_tree_lister.rb
 - lib/xing/services/locator.rb
+- lib/xing/services/page_wrapper.rb
 - lib/xing/services/snapshot_fetcher.rb
 - lib/xing/services/snapshot_writer.rb
 - spec/xing/builders/list_builder_spec.rb
@@ -149,6 +152,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_index_spec.rb
 - spec/xing/serializers/paged_list_spec.rb
 - spec/xing/serializers/root_resources_spec.rb
 - spec/xing/services/error_converter_spec.rb
@@ -200,7 +204,7 @@ rdoc_options:
 - "--main"
 - doc/README
 - "--title"
-- xing-backend-0.0.18 Documentation
+- xing-backend-0.0.19 Documentation
 require_paths:
 - lib/
 required_ruby_version: !ruby/object:Gem::Requirement