api: return partial data

Victor Costa · Rodrigo Souto
1 parent 37ec8a33
Showing 4 changed files with 36 additions and 11 deletions Show diff stats
lib/noosfero/api/entities.rb
lib/noosfero/api/entity.rb
lib/noosfero/api/v1/articles.rb
test/unit/api/articles_test.rb
@@ -2,11 +2,11 @@ module Noosfero
   module API
     module Entities
-      Grape::Entity.format_with :timestamp do |date|
+      Entity.format_with :timestamp do |date|
         date.strftime('%Y/%m/%d %H:%M:%S') if date
       end
-      class Image < Grape::Entity
+      class Image < Entity
         root 'images', 'image'
         expose  :icon_url do |image, options|
@@ -26,7 +26,7 @@ module Noosfero
         end
       end
-      class Profile < Grape::Entity
+      class Profile < Entity
         expose :identifier, :name, :id
         expose :created_at, :format_with => :timestamp
         expose :image, :using => Image
@@ -43,13 +43,13 @@ module Noosfero
         expose :description
       end
-      class Category < Grape::Entity
+      class Category < Entity
         root 'categories', 'category'
         expose :name, :id, :slug
         expose :image, :using => Image
       end
-      class ArticleChild < Grape::Entity
+      class ArticleChild < Entity
         root 'articles', 'article'
         expose :id, :body, :abstract
         expose :created_at, :format_with => :timestamp
@@ -59,8 +59,8 @@ module Noosfero
         expose :categories, :using => Category
         expose :image, :using => Image
       end
-  
-      class Article < Grape::Entity
+
+      class Article < Entity
         root 'articles', 'article'
         expose :id, :body, :abstract
         expose :created_at, :format_with => :timestamp
@@ -69,12 +69,12 @@ module Noosfero
         expose :profile, :using => Profile
         expose :categories, :using => Category
         # FIXME: create a method that overrides expose and include conditions for return attributes
-        expose :parent, :using => Article, :if => lambda { |article, options| options[:fields].blank? || options[:fields].include?(:parent) }
+        expose :parent, :using => Article
         expose :children, :using => ArticleChild
         expose :image, :using => Image
       end
-      class Comment < Grape::Entity
+      class Comment < Entity
         root 'comments', 'comment'
         expose :body, :title, :id
         expose :created_at, :format_with => :timestamp
@@ -82,7 +82,7 @@ module Noosfero
       end
-      class User < Grape::Entity
+      class User < Entity
         root 'users', 'user'
         expose :id
         expose :login
@@ -0,0 +1,17 @@
+class Noosfero::API::Entity < Grape::Entity
+
+  def self.fields_condition(fields)
+    lambda do |object, options|
+      return true if options[:fields].blank?
+      fields.map { |field| options[:fields].include?(field.to_s)}.grep(true).present?
+    end
+  end
+
+  def self.expose(*args, &block)
+    hash = args.last.is_a?(Hash) ? args.pop : {}
+    hash.merge!({:if => fields_condition(args)}) if hash[:if].blank?
+    args << hash
+    super
+  end
+
+end
@@ -33,7 +33,7 @@ module Noosfero
             article = find_article(environment.articles, params[:id])
             articles = select_filtered_collection_of(article, 'children', params)
             articles = articles.display_filter(current_person, nil)
-            present articles, :with => Entities::Article, :fields => [:id, :name, :abstract, :author]
+            present articles, :with => Entities::Article, :fields => params[:fields]
           end
           get ':id/children/:child_id' do
@@ -442,5 +442,13 @@ class ArticlesTest &lt; ActiveSupport::TestCase
     assert_equal user.person, Article.last.last_changed_by
   end
+  should 'list article children with partial fields' do
+    article = fast_create(Article, :profile_id => user.person.id, :name => "Some thing")
+    child1 = fast_create(Article, :parent_id => article.id, :profile_id => user.person.id, :name => "Some thing")
+    params[:fields] = [:title]
+    get "/api/v1/articles/#{article.id}/children?#{params.to_query}"
+    json = JSON.parse(last_response.body)
+    assert_equal ['title'], json['articles'].first.keys
+  end
 end
@@ -0,0 +1,17 @@		@@ -0,0 +1,17 @@
	1	+class Noosfero::API::Entity < Grape::Entity
	2	+
	3	+ def self.fields_condition(fields)
	4	+ lambda do \|object, options\|
	5	+ return true if options[:fields].blank?
	6	+ fields.map { \|field\| options[:fields].include?(field.to_s)}.grep(true).present?
	7	+ end
	8	+ end
	9	+
	10	+ def self.expose(*args, &block)
	11	+ hash = args.last.is_a?(Hash) ? args.pop : {}
	12	+ hash.merge!({:if => fields_condition(args)}) if hash[:if].blank?
	13	+ args << hash
	14	+ super
	15	+ end
	16	+
	17	+end
	@@ -33,7 +33,7 @@ module Noosfero		@@ -33,7 +33,7 @@ module Noosfero
33	article = find_article(environment.articles, params[:id])	33	article = find_article(environment.articles, params[:id])
34	articles = select_filtered_collection_of(article, 'children', params)	34	articles = select_filtered_collection_of(article, 'children', params)
35	articles = articles.display_filter(current_person, nil)	35	articles = articles.display_filter(current_person, nil)
36	- present articles, :with => Entities::Article, :fields => [:id, :name, :abstract, :author]	36	+ present articles, :with => Entities::Article, :fields => params[:fields]
37	end	37	end
38		38
39	get ':id/children/:child_id' do	39	get ':id/children/:child_id' do
	@@ -442,5 +442,13 @@ class ArticlesTest < ActiveSupport::TestCase		@@ -442,5 +442,13 @@ class ArticlesTest < ActiveSupport::TestCase
442	assert_equal user.person, Article.last.last_changed_by	442	assert_equal user.person, Article.last.last_changed_by
443	end	443	end
444		444
		445	+ should 'list article children with partial fields' do
		446	+ article = fast_create(Article, :profile_id => user.person.id, :name => "Some thing")
		447	+ child1 = fast_create(Article, :parent_id => article.id, :profile_id => user.person.id, :name => "Some thing")
		448	+ params[:fields] = [:title]
		449	+ get "/api/v1/articles/#{article.id}/children?#{params.to_query}"
		450	+ json = JSON.parse(last_response.body)
		451	+ assert_equal ['title'], json['articles'].first.keys
		452	+ end
445		453
446	end	454	end