Merge branch 'comments_api_reply' into 'master'

API: Add the replies field in comment entity Also add pagination to comments and add an option to return root comments only. See merge request !842

Merge branch 'comments_api_reply' into 'master'
API: Add the replies field in comment entity Also add pagination to comments and add an option to return root comments only. See merge request !842
Leandro Santos
2 parents ceddcde8 e7aecdac
Showing 3 changed files with 33 additions and 3 deletions Show diff stats
lib/noosfero/api/entities.rb
lib/noosfero/api/v1/comments.rb
test/api/comments_test.rb
@@ -183,11 +183,16 @@ module Noosfero
         expose :children, :using => ArticleBase
       end
-      class Comment < Entity
-        root 'comments', 'comment'
+      class CommentBase < Entity
         expose :body, :title, :id
         expose :created_at, :format_with => :timestamp
         expose :author, :using => Profile
+        expose :reply_of, :using => CommentBase
+      end
+
+      class Comment < CommentBase
+        root 'comments', 'comment'
+        expose :children, as: :replies, :using => Comment
       end
       class User < Entity
@@ -2,9 +2,12 @@ module Noosfero
   module API
     module V1
       class Comments < Grape::API
+        MAX_PER_PAGE = 20
+
         before { authenticate! }
         resource :articles do
+          paginate max_per_page: MAX_PER_PAGE
           # Collect comments from articles
           #
           # Parameters:
@@ -17,7 +20,7 @@ module Noosfero
           get ":id/comments" do
             article = find_article(environment.articles, params[:id])
             comments = select_filtered_collection_of(article, :comments, params)
-
+            comments = comments.without_reply if(params[:without_reply].present?)
             present comments, :with => Entities::Comment, :current_person => current_person
           end
@@ -78,4 +78,26 @@ class CommentsTest &lt; ActiveSupport::TestCase
     assert_not_nil comment.source
   end
+  should 'paginate comments' do
+    article = fast_create(Article, :profile_id => user.person.id, :name => "Some thing")
+    5.times { article.comments.create!(:body => "some comment", :author => user.person) }
+    params[:per_page] = 3
+
+    get "/api/v1/articles/#{article.id}/comments?#{params.to_query}"
+    json = JSON.parse(last_response.body)
+    assert_equal 200, last_response.status
+    assert_equal 3, json["comments"].length
+  end
+
+  should 'return only root comments' do
+    article = fast_create(Article, :profile_id => user.person.id, :name => "Some thing")
+    comment1 = article.comments.create!(:body => "some comment", :author => user.person)
+    comment2 = article.comments.create!(:body => "another comment", :author => user.person, :reply_of_id => comment1.id)
+    params[:without_reply] = true
+
+    get "/api/v1/articles/#{article.id}/comments?#{params.to_query}"
+    json = JSON.parse(last_response.body)
+    assert_equal 200, last_response.status
+    assert_equal [comment1.id], json["comments"].map { |c| c['id'] }
+  end
 end
	@@ -78,4 +78,26 @@ class CommentsTest < ActiveSupport::TestCase		@@ -78,4 +78,26 @@ class CommentsTest < ActiveSupport::TestCase
78	assert_not_nil comment.source	78	assert_not_nil comment.source
79	end	79	end
80		80
		81	+ should 'paginate comments' do
		82	+ article = fast_create(Article, :profile_id => user.person.id, :name => "Some thing")
		83	+ 5.times { article.comments.create!(:body => "some comment", :author => user.person) }
		84	+ params[:per_page] = 3
		85	+
		86	+ get "/api/v1/articles/#{article.id}/comments?#{params.to_query}"
		87	+ json = JSON.parse(last_response.body)
		88	+ assert_equal 200, last_response.status
		89	+ assert_equal 3, json["comments"].length
		90	+ end
		91	+
		92	+ should 'return only root comments' do
		93	+ article = fast_create(Article, :profile_id => user.person.id, :name => "Some thing")
		94	+ comment1 = article.comments.create!(:body => "some comment", :author => user.person)
		95	+ comment2 = article.comments.create!(:body => "another comment", :author => user.person, :reply_of_id => comment1.id)
		96	+ params[:without_reply] = true
		97	+
		98	+ get "/api/v1/articles/#{article.id}/comments?#{params.to_query}"
		99	+ json = JSON.parse(last_response.body)
		100	+ assert_equal 200, last_response.status
		101	+ assert_equal [comment1.id], json["comments"].map { \|c\| c['id'] }
		102	+ end
81	end	103	end