sinatra_resource 0.4.4 → 0.4.5

data/VERSION

@@ -1 +1 @@
-0.4.4
+0.4.5

data/examples/datacatalog/test/resources/categories/categories_get_many_test.rb

@@ -43,20 +43,26 @@ class CategoriesGetManyResourceTest < ResourceTestCase
     context "#{role} : get /" do
       before do
         get "/", :api_key => api_key_for(role)
+        @members = parsed_response_body['members']
       end
   
       use "return 200 Ok"
       
       test "body should have 3 categories" do
-        assert_equal 3, parsed_response_body.length
+        assert_equal 3, @members.length
       end
       
       test "body should have correct category names" do
-        actual = parsed_response_body.map { |e| e["name"] }
+        actual = @members.map { |e| e["name"] }
         assert_equal CATEGORIES, actual.sort
       end
       
-      docs_properties %w(name log sources id created_at updated_at)
+      test "members should only have correct attributes" do
+        correct = %w(name log sources id created_at updated_at)
+        @members.each do |member|
+          assert_properties(correct, member)
+        end
+      end
     end
   end
 

data/examples/datacatalog/test/resources/categories_sources/categories_sources_get_many_test.rb

@@ -73,20 +73,26 @@ class CategoriesSourcesGetManyResourceTest < ResourceTestCase
     context "#{role} : get /:id/sources" do
       before do
         get "/#{@category.id}/sources", :api_key => api_key_for(role)
+        @members = parsed_response_body['members']
       end
 
       use "return 200 Ok"
 
       test "body should have 3 sources" do
-        assert_equal 3, parsed_response_body.length
+        assert_equal 3, @members.length
       end
 
       test "body should have correct source titles" do
-        actual = parsed_response_body.map { |e| e["title"] }
+        actual = @members.map { |e| e["title"] }
         assert_equal @source_titles, actual.sort
       end
-      
-      docs_properties %w(title url raw id created_at updated_at)
+
+      test "members should only have correct attributes" do
+        correct = %w(title url raw id created_at updated_at)
+        @members.each do |member|
+          assert_properties(correct, member)
+        end
+      end
     end
   end
 

data/examples/datacatalog/test/resources/notes/notes_get_many_test.rb

@@ -49,12 +49,13 @@ class NotesGetManyResourceTest < ResourceTestCase
     context "#{role} : get /" do
       before do
         get "/", :api_key => api_key_for(role)
+        @members = parsed_response_body['members']
       end
   
       use "return 200 Ok"
       
       test "body should have an empty list" do
-        assert_equal [], parsed_response_body
+        assert_equal [], @members
       end
     end
   end
@@ -62,40 +63,52 @@ class NotesGetManyResourceTest < ResourceTestCase
   context "owner : get /" do
     before do
       get "/", :api_key => @users[0]._api_key
+      @members = parsed_response_body['members']
     end
     
     use "return 200 Ok"
   
     test "body should have 1 note" do
-      assert_equal 1, parsed_response_body.length
+      assert_equal 1, @members.length
     end
     
     test "body should have correct note text" do
-      actual = parsed_response_body.map { |e| e["text"] }
+      actual = @members.map { |e| e["text"] }
       assert_equal ["Note 0"], actual.sort
     end
     
-    docs_properties %w(text user_id id created_at updated_at)
+    test "members should only have correct attributes" do
+      correct = %w(text user_id id created_at updated_at)
+      @members.each do |member|
+        assert_properties(correct, member)
+      end
+    end
   end
 
   %w(admin).each do |role|
     context "#{role} : get /" do
       before do
         get "/", :api_key => api_key_for(role)
+        @members = parsed_response_body['members']
       end
   
       use "return 200 Ok"
       
       test "body should have 3 notes" do
-        assert_equal 3, parsed_response_body.length
+        assert_equal 3, @members.length
       end
       
       test "body should have correct note text" do
-        actual = parsed_response_body.map { |e| e["text"] }
+        actual = @members.map { |e| e["text"] }
         assert_equal @note_texts, actual.sort
       end
-      
-      docs_properties %w(text user_id id created_at updated_at)
+
+      test "notes should only have correct attributes" do
+        correct = %w(text user_id id created_at updated_at)
+        @members.each do |member|
+          assert_properties(correct, member)
+        end
+      end
     end
   end
 

data/examples/datacatalog/test/resources/sources/sources_get_many_filter_test.rb

@@ -45,19 +45,25 @@ class SourcesGetManyFilterResourceTest < ResourceTestCase
       context "#{role} : get /" do
         before do
           get "/", @search_params.merge(:api_key => api_key_for(role))
+          @members = parsed_response_body['members']
         end
 
         use "return 200 Ok"
 
         test "body should have 1 source" do
-          assert_equal 1, parsed_response_body.length
+          assert_equal 1, @members.length
         end
 
         test "body should have correct source" do
-          assert_equal 'Source 2', parsed_response_body[0]['title']
+          assert_equal 'Source 2', @members[0]['title']
         end
 
-        docs_properties %w(title url raw categories id created_at updated_at)
+        test "members should only have correct attributes" do
+          correct = %w(title url raw categories id created_at updated_at)
+          @members.each do |member|
+            assert_properties(correct, member)
+          end
+        end
       end
     end
   end
@@ -71,20 +77,26 @@ class SourcesGetManyFilterResourceTest < ResourceTestCase
       context "#{role} : get /" do
         before do
           get "/", @search_params.merge(:api_key => api_key_for(role))
+          @members = parsed_response_body['members']
         end
 
         use "return 200 Ok"
 
         test "body should have 3 sources" do
-          assert_equal 3, parsed_response_body.length
+          assert_equal 3, @members.length
         end
 
         test "body should have correct source titles" do
-          actual = parsed_response_body.map { |e| e["title"] }
+          actual = @members.map { |e| e["title"] }
           assert_equal @source_titles, actual.sort
         end
 
-        docs_properties %w(title url raw categories id created_at updated_at)
+        test "members should only have correct attributes" do
+          correct = %w(title url raw categories id created_at updated_at)
+          @members.each do |member|
+            assert_properties(correct, member)
+          end
+        end
       end
     end
   end

data/examples/datacatalog/test/resources/sources/sources_get_many_search_test.rb

@@ -73,20 +73,26 @@ class SourcesGetManySearchResourceTest < ResourceTestCase
       context "#{role} : get /" do
         before do
           get "/", @search_params.merge(:api_key => api_key_for(role))
+          @members = parsed_response_body['members']
         end
   
         use "return 200 Ok"
   
         test "body should have 1 source" do
-          assert_equal 1, parsed_response_body.length
+          assert_equal 1, @members.length
         end
         
         test "body should have correct source" do
           assert_equal %{2007 Crime in the United States},
-            parsed_response_body[0]['title']
+            @members[0]['title']
         end
         
-        docs_properties %w(title url raw categories id created_at updated_at)
+        test "members should only have correct attributes" do
+          correct = %w(title url raw categories id created_at updated_at)
+          @members.each do |member|
+            assert_properties(correct, member)
+          end
+        end
       end
     end
   end
@@ -100,12 +106,13 @@ class SourcesGetManySearchResourceTest < ResourceTestCase
       context "#{role} : get /" do
         before do
           get "/", @search_params.merge(:api_key => api_key_for(role))
+          @members = parsed_response_body['members']
         end
   
         use "return 200 Ok"
         
         test "body should have correct sources" do
-          titles = parsed_response_body.map { |x| x['title'] }
+          titles = @members.map { |x| x['title'] }
           assert_equal 2, titles.length
           assert_include %{Interest Rate Statistics - Daily Treasury Yield Curve Rates (1998)}, titles
           assert_include %{Interest Rate Statistics - Daily Treasury Bills Rates (Current month)}, titles

data/examples/datacatalog/test/resources/sources/sources_get_many_test.rb

@@ -40,20 +40,26 @@ class SourcesGetManyResourceTest < ResourceTestCase
     context "#{role} : get /" do
       before do
         get "/", :api_key => api_key_for(role)
+        @members = parsed_response_body['members']
       end
   
       use "return 200 Ok"
       
       test "body should have 3 sources" do
-        assert_equal 3, parsed_response_body.length
+        assert_equal 3, @members.length
       end
       
       test "body should have correct source titles" do
-        actual = parsed_response_body.map { |e| e["title"] }
+        actual = @members.map { |e| e["title"] }
         assert_equal @source_titles, actual.sort
       end
-      
-      docs_properties %w(title url raw categories id created_at updated_at)
+
+      test "members should only have correct attributes" do
+        correct = %w(title url raw categories id created_at updated_at)
+        @members.each do |member|
+          assert_properties(correct, member)
+        end
+      end
     end
   end
 

data/examples/datacatalog/test/resources/sources_usages/sources_usages_get_many_filter_test.rb

@@ -66,20 +66,26 @@ class SourcesUsagesGetManyFilterResourceTest < ResourceTestCase
         before do
           get "/#{@source.id}/usages", search.merge(
             :api_key => api_key_for(role))
+          @members = parsed_response_body['members']
         end
       
         use "return 200 Ok"
       
         test "body should have 2 sources" do
-          assert_equal 2, parsed_response_body.length
+          assert_equal 2, @members.length
         end
       
         test "body should have correct source titles" do
-          actual = parsed_response_body.map { |e| e["title"] }
+          actual = @members.map { |e| e["title"] }
           assert_equal ["Usage 0", "Usage 2"], actual.sort
         end
-      
-        docs_properties %w(title url description id)
+
+        test "members should only have correct attributes" do
+          correct = %w(title url description id)
+          @members.each do |member|
+            assert_properties(correct, member)
+          end
+        end
       end
     end
   end

data/examples/datacatalog/test/resources/sources_usages/sources_usages_get_many_test.rb

@@ -56,20 +56,26 @@ class SourcesUsagesGetManyResourceTest < ResourceTestCase
     context "#{role} : get /:id/usages" do
       before do
         get "/#{@source.id}/usages", :api_key => api_key_for(role)
+        @members = parsed_response_body['members']
       end
       
       use "return 200 Ok"
       
       test "body should have 3 sources" do
-        assert_equal 3, parsed_response_body.length
+        assert_equal 3, @members.length
       end
       
       test "body should have correct source titles" do
-        actual = parsed_response_body.map { |e| e["title"] }
+        actual = @members.map { |e| e["title"] }
         assert_equal @usage_titles, actual.sort
       end
-      
-      docs_properties %w(title url description id)
+
+      test "members should only have correct attributes" do
+        correct = %w(title url description id)
+        @members.each do |member|
+          assert_properties(correct, member)
+        end
+      end
     end
   end
 

data/examples/datacatalog/test/resources/users/users_get_many_test.rb

@@ -62,21 +62,22 @@ class UsersGetManyResourceTest < ResourceTestCase
     context "#{role} : get /" do
       before do
         get "/", :api_key => api_key_for(role)
+        @members = parsed_response_body['members']
       end
   
       use "return 200 Ok"
       
       test "body should have 6 users" do
-        assert_equal 6, parsed_response_body.length
+        assert_equal 6, @members.length
       end
       
       test "body should have correct names" do
-        actual = parsed_response_body.map { |e| e["name"] }
+        actual = @members.map { |e| e["name"] }
         assert_equal NAMES, actual.sort
       end
 
       test "body elements should be correct" do
-        parsed_response_body.each do |element|
+        @members.each do |element|
           if element["id"] == user_for(role).id
             assert_properties(%w(name email role _api_key token
               id created_at updated_at), element)
@@ -92,25 +93,31 @@ class UsersGetManyResourceTest < ResourceTestCase
     context "#{role} : get /" do
       before do
         get "/", :api_key => api_key_for(role)
+        @members = parsed_response_body['members']
       end
   
       use "return 200 Ok"
       
       test "body should have 6 users" do
-        assert_equal 6, parsed_response_body.length
+        assert_equal 6, @members.length
       end
       
       test "body should have correct names" do
-        actual = parsed_response_body.map { |e| e["name"] }
+        actual = @members.map { |e| e["name"] }
         assert_equal NAMES, actual.sort
       end
   
       test "body should have correct emails" do
-        actual = parsed_response_body.map { |e| e["email"] }
+        actual = @members.map { |e| e["email"] }
         assert_equal EMAILS, actual.sort
       end
-      
-      docs_properties %w(name email role _api_key token id created_at updated_at)
+
+      test "members should only have correct attributes" do
+        correct = %w(name email role _api_key token id created_at updated_at)
+        @members.each do |member|
+          assert_properties(correct, member)
+        end
+      end
     end
   end
   

data/lib/builder/action_definitions.rb

@@ -17,13 +17,21 @@ module SinatraResource
         end
       end
       
-      def documents_for_get_many(role, model, resource_config, leaf, parent_document, child_assoc)
+      def document_count_for_get_many(model, resource_config, parent_document, child_assoc)
+        if resource_config[:parent]
+          count_nested_documents(parent_document, child_assoc, model)
+        else
+          count_documents(model)
+        end
+      end
+      
+      def documents_for_get_many(role, model, resource_config, page, items_per_page, leaf, parent_document, child_assoc)
         check_permission(:list, role, resource_config)
         check_params(:list, role, resource_config, leaf)
         documents = if resource_config[:parent]
-          find_nested_documents!(parent_document, child_assoc, model)
+          find_nested_documents!(parent_document, child_assoc, model, page, items_per_page)
         else
-          find_documents!(model)
+          find_documents!(model, page, items_per_page)
         end
         documents.select do |doc|
           authorized?(:read, lookup_role(doc), resource_config)

data/lib/builder/helpers.rb

@@ -33,11 +33,28 @@ module SinatraResource
       #
       # @param [Hash] resource_config
       #
+      # @param [Integer] page
+      #
+      # @param [Integer] page_count
+      #
       # @return [Array<Hash<String => Object>>]
-      def build_resources(documents, resource_config)
-        documents.map do |document|
-          build_resource(lookup_role(document), document, resource_config)
+      def build_resources(documents, resource_config, page, page_count)
+        if page_count > 0 && page > page_count
+          error 400, convert(body_for(:errors,
+            "page (#{page}) must be <= page_count (#{page_count})"))
         end
+        {
+          'previous'   => page > 1 ? link_to_page(page - 1) : nil,
+          'next'       => page < page_count ? link_to_page(page + 1) : nil,
+          'page_count' => page_count,
+          'members'    => documents.map do |document|
+            build_resource(lookup_role(document), document, resource_config)
+          end,
+        }
+      end
+
+      def calculate_page_count(document_count, items_per_page)
+        (document_count.to_f / items_per_page).ceil
       end
 
       # Halt unless the current params are ok for +action+ and +role+.
@@ -160,6 +177,33 @@ module SinatraResource
         raise NotImplementedError
       end
 
+      # Get the page parameter.
+      #
+      # @param [Hash] params
+      # 
+      # @return [Integer]
+      def get_page(params)
+        raw = params.delete('page')
+        return 1 unless raw
+        page = raw.to_i
+        if page < 1
+          error 400, convert(body_for(:errors, "page must be >= 1"))
+        end
+        page
+      end
+
+      # Build a hash that contains a URL to +page_number+.
+      #
+      # @param [Integer] page
+      #
+      # @return [Hash]
+      def link_to_page(page_number)
+        q = Rack::Utils.parse_query(request.query_string)
+        q['page'] = page_number
+        query_string = Rack::Utils.build_query(q)
+        { 'href' => "#{request.path}?#{query_string}" }
+      end
+
       # Get role, using +model+ and +id+. Delegates to +lookup_role+.
       #
       # When +id+ is present, it can help determine 'relative' roles such

data/lib/builder/mongo_helpers.rb

@@ -22,6 +22,41 @@ module SinatraResource
         find_child!(children, child_id)
         true
       end
+
+      # Find +model+ documents: find all documents if no params, otherwise
+      # find selected documents.
+      #
+      # @param [Class] model
+      #   a class that includes MongoMapper::Document
+      #
+      # @return [Integer]
+      def count_documents(model)
+        conditions = params.empty? ? {} : make_conditions(params, model)
+        model.count(conditions)
+      end
+      
+      def count_nested_documents(parent, child_assoc, child_model)
+        #
+        # This code needs significant improvement.
+        # It is copy and pasted from find_nested_documents!
+        #
+        documents = if child_model.embeddable?
+          children = parent.send(child_assoc)
+          if params.empty?
+            children
+          else
+            select_by(children, make_conditions(params, child_model))
+          end
+        else
+          children = if params.empty?
+            child_model.all
+          else
+            child_model.all(make_conditions(params, child_model))
+          end
+          select_related(parent, child_assoc, children)
+        end
+        documents.length
+      end
       
       # Create a document from params. If not valid, returns 400.
       #
@@ -199,7 +234,7 @@ module SinatraResource
         end
         document
       end
-
+      
       # Find +model+ documents: find all documents if no params, otherwise
       # find selected documents.
       #
@@ -207,9 +242,12 @@ module SinatraResource
       #   a class that includes MongoMapper::Document
       #
       # @return [Array<MongoMapper::Document>]
-      def find_documents!(model)
-        return(model.all) if params.empty?
-        model.all(make_conditions(params, model))
+      def find_documents!(model, page, items_per_page)
+        conditions = params.empty? ? {} : make_conditions(params, model)
+        model.all(conditions.merge({
+          :skip  => items_per_page * (page - 1),
+          :limit => items_per_page
+        }))
       end
 
       # Find nested +child_model+ documents: find all documents if no
@@ -226,7 +264,11 @@ module SinatraResource
       #     * MongoMapper::EmbeddedDocument
       #
       # @return [Array<MongoMapper::Document>]
-      def find_nested_documents!(parent, child_assoc, child_model)
+      def find_nested_documents!(parent, child_assoc, child_model, page, items_per_page)
+        #
+        # TODO: handle page parameter
+        # TODO: handle items_per_page parameter
+        #
         documents = if child_model.embeddable?
           children = parent.send(child_assoc)
           if params.empty?
@@ -244,7 +286,7 @@ module SinatraResource
         end
       end
       
-      # Delegates to application, who should use custom logic to related
+      # Delegates to application, who should use custom logic to relate
       # +parent+ and +child+.
       #
       # @param [MongoMapper::Document] parent

data/lib/builder.rb

@@ -4,6 +4,8 @@ module SinatraResource
     
     FILTER_KEY = "filter"
     SEARCH_KEY = "search"
+
+    ITEMS_PER_PAGE = 20
     
     def initialize(klass)
       @klass  = klass
@@ -64,8 +66,11 @@ module SinatraResource
       if !@parent
         @klass.get '/?' do
           role = lookup_role(nil)
-          documents = documents_for_get_many(role, model, resource_config, true, nil, nil)
-          resources = build_resources(documents, resource_config)
+          page = get_page(params)
+          documents = documents_for_get_many(role, model, resource_config, page, ITEMS_PER_PAGE, true, nil, nil)
+          document_count = document_count_for_get_many(model, resource_config, nil, nil)
+          page_count = calculate_page_count(document_count, ITEMS_PER_PAGE)
+          resources = build_resources(documents, resource_config, page, page_count)
           display(:list, resources, resource_config)
         end
       else
@@ -79,8 +84,11 @@ module SinatraResource
           parent_document = document_for_get_one(parent_role, parent_model, parent_resource_config, false, parent_id, nil, nil)
           # ------
           role = lookup_role(nil)
-          documents = documents_for_get_many(role, model, resource_config, true, parent_document, child_assoc)
-          resources = build_resources(documents, resource_config)
+          page = get_page(params)
+          documents = documents_for_get_many(role, model, resource_config, page, ITEMS_PER_PAGE, true, parent_document, child_assoc)
+          document_count = document_count_for_get_many(model, resource_config, parent_document, child_assoc)
+          page_count = calculate_page_count(document_count, ITEMS_PER_PAGE)
+          resources = build_resources(documents, resource_config, page, page_count)
           display(:list, resources, resource_config, parent_id)
         end
       end

data/sinatra_resource.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra_resource}
-  s.version = "0.4.4"
+  s.version = "0.4.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David James"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra_resource
 version: !ruby/object:Gem::Version 
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors: 
 - David James