api: better support to choose returned fields

Victor Costa
1 parent 92fbfd94
Showing 8 changed files with 65 additions and 37 deletions Show diff stats
lib/noosfero/api/entities.rb
lib/noosfero/api/entity.rb
lib/noosfero/api/helpers.rb
lib/noosfero/api/v1/articles.rb
lib/noosfero/api/v1/people.rb
lib/noosfero/api/v1/tasks.rb
test/unit/api/helpers_test.rb
test/unit/api/people_test.rb
@@ -96,14 +96,14 @@ module Noosfero
       class Person < Profile
         root 'people', 'person'
         expose :user, :using => UserBasic, documentation: {type: 'User', desc: 'The user data of a person' }
-        expose :vote_count, if: lambda { |object, options| options[:fields].present? ? options[:fields].include?('vote_count') : false}
-        expose :comments_count, if: lambda { |object, options| options[:fields].present? ? options[:fields].include?('comments_count') : false}  do |person, options|
+        expose :vote_count
+        expose :comments_count do |person, options|
           person.comments.count
         end
-        expose :following_articles_count, if: lambda { |object, options| options[:fields].present? ? options[:fields].include?('following_articles_count') : false}  do |person, options|
+        expose :following_articles_count do |person, options|
           person.following_articles.count
         end
-        expose :articles_count, if: lambda { |object, options| options[:fields].present? ? options[:fields].include?('articles_count') : false}  do |person, options|
+        expose :articles_count do |person, options|
           person.articles.count
         end
@@ -22,18 +22,4 @@ class Noosfero::API::Entity &lt; Grape::Entity
     end
   end
-  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
@@ -39,6 +39,20 @@ require_relative &#39;../../find_by_contents&#39;
         @environment
       end
+      def present_partial(model, options)
+        if(params[:fields].present?)
+          begin
+            fields = JSON.parse(params[:fields])
+            if fields.present?
+              options.merge!(fields.symbolize_keys.slice(:only, :except))
+            end
+          rescue
+            options[:only] = Array.wrap(params[:fields])
+          end
+        end
+        present model, options
+      end
+
       include FindByContents
       ####################################################################
@@ -99,12 +113,12 @@ require_relative &#39;../../find_by_contents&#39;
         if !article.save
           render_api_errors!(article.errors.full_messages)
         end
-        present article, :with => Entities::Article, :fields => params[:fields]
+        present_partial article, :with => Entities::Article
       end
       def present_article(asset)
         article = find_article(asset.articles, params[:id])
-        present article, :with => Entities::Article, :fields => params[:fields]
+        present_partial article, :with => Entities::Article
       end
       def present_articles_for_asset(asset, method = 'articles')
@@ -113,12 +127,12 @@ require_relative &#39;../../find_by_contents&#39;
       end
       def present_articles(articles)
-        present articles, :with => Entities::Article, :fields => params[:fields]
+        present_partial articles, :with => Entities::Article
       end
       def present_articles_paginated(articles, per_page=nil)
         articles = paginate(articles)
-        present articles, :with => Entities::Article, :fields => params[:fields]
+        present_partial articles, :with => Entities::Article
       end
       def find_articles(asset, method = 'articles')
@@ -148,19 +162,19 @@ require_relative &#39;../../find_by_contents&#39;
         if !task.save
           render_api_errors!(task.errors.full_messages)
         end
-        present task, :with => Entities::Task, :fields => params[:fields]
+        present_partial task, :with => Entities::Task
       end
       def present_task(asset)
         task = find_task(asset, params[:id])
-        present task, :with => Entities::Task, :fields => params[:fields]
+        present_partial task, :with => Entities::Task
       end
       def present_tasks(asset)
         tasks = select_filtered_collection_of(asset, 'tasks', params)
         tasks = tasks.select {|t| current_person.has_permission?(t.permission, asset)}
         return forbidden! if tasks.empty? && !current_person.has_permission?(:perform_task, asset)
-        present tasks, :with => Entities::Task, :fields => params[:fields]
+        present_partial tasks, :with => Entities::Task
       end
       def make_conditions_with_parameter(params = {})
@@ -58,7 +58,7 @@ module Noosfero
             article = environment.articles.find(params[:id])
             return forbidden! unless article.allow_edit?(current_person)
             article.update_attributes!(params[:article])
-            present article, :with => Entities::Article, :fields => params[:fields]
+            present_partial article, :with => Entities::Article
           end
           desc 'Report a abuse and/or violent content in a article by id' do
@@ -190,7 +190,7 @@ module Noosfero
             article = find_article(environment.articles, params[:id])
             child = find_article(article.children, params[:child_id])
             child.hit
-            present child, :with => Entities::Article, :fields => params[:fields]
+            present_partial child, :with => Entities::Article
           end
           desc 'Suggest a article to another profile' do
@@ -213,7 +213,7 @@ module Noosfero
             unless suggest_article.save
               render_api_errors!(suggest_article.article_object.errors.full_messages)
             end
-            present suggest_article, :with => Entities::Task, :fields => params[:fields]
+            present_partial suggest_article, :with => Entities::Task
           end
           # Example Request:
@@ -244,7 +244,7 @@ module Noosfero
             if !article.save
               render_api_errors!(article.errors.full_messages)
             end
-            present article, :with => Entities::Article, :fields => params[:fields]
+            present_partial article, :with => Entities::Article
           end
         end
@@ -271,7 +271,7 @@ module Noosfero
                       article = forbidden!
                     end
-                    present article, :with => Entities::Article, :fields => params[:fields]
+                    present_partial article, :with => Entities::Article
                   else
                     present_articles_for_asset(profile)
@@ -33,12 +33,12 @@ module Noosfero
           get do
             people = select_filtered_collection_of(environment, 'people', params)
             people = people.visible_for_person(current_person)
-            present people, :with => Entities::Person, :fields => params[:fields]
+            present_partial people, :with => Entities::Person
           end
           desc "Return the logged user information"
           get "/me" do
-            present current_person, :with => Entities::Person, :fields => params[:fields]
+            present_partial current_person, :with => Entities::Person
           end
           desc "Return the person information"
@@ -20,13 +20,13 @@ module Noosfero
           get do
             tasks = select_filtered_collection_of(environment, 'tasks', params)
             tasks = tasks.select {|t| current_person.has_permission?(t.permission, environment)}
-            present tasks, :with => Entities::Task, :fields => params[:fields]
+            present_partial tasks, :with => Entities::Task
           end
           desc "Return the task id"
           get ':id' do
             task = find_task(environment, params[:id])
-            present task, :with => Entities::Task, :fields => params[:fields]
+            present_partial task, :with => Entities::Task
           end
         end
@@ -214,6 +214,26 @@ class APIHelpersTest &lt; ActiveSupport::TestCase
     #assert_equals [article1, article2], present_articles
   end
+  should 'not touch in options when no fields parameter is passed' do
+    model = mock
+    expects(:present).with(model, {})
+    present_partial(model, {})
+  end
+
+  should 'fallback to array when fields parameter is not a json when calling present partial' do
+    model = mock
+    params[:fields] = 'name'
+    expects(:present).with(model, {:only => ['name']})
+    present_partial(model, {})
+  end
+
+  should 'accept json as fields parameter when calling present partial' do
+    model = mock
+    params[:fields] = {only: [:name, {user: [:login]}]}.to_json
+    expects(:present).with(model, {:only => ['name', {'user' => ['login']}]})
+    present_partial(model, {})
+  end
+
 ###### Captcha tests ######
 should 'do not test captcha when there are no settings' do
@@ -54,6 +54,14 @@ class PeopleTest &lt; ActiveSupport::TestCase
     assert_equal expected, json
   end
+  should 'people endpoint filter by fields parameter with hierarchy' do
+    fields = {only: [:name, {user: [:login]}]}.to_json
+    get "/api/v1/people?#{params.to_query}&fields=#{fields}"
+    json = JSON.parse(last_response.body)
+    expected = {'people' => [{'name' => person.name, 'user' => {'login' => 'testapi'}}]}
+    assert_equal expected, json
+  end
+
   should 'get logged person' do
     get "/api/v1/people/me?#{params.to_query}"
@@ -184,13 +192,13 @@ class PeopleTest &lt; ActiveSupport::TestCase
   PERSON_ATTRIBUTES.map do |attribute|
-    define_method "test_should_not_expose_#{attribute}_attribute_in_person_enpoint_if_field_parameter_is_not_passed" do
-      get "/api/v1/people/me?#{params.to_query}"
+    define_method "test_should_not_expose_#{attribute}_attribute_in_person_enpoint_if_field_parameter_does_not_contain_the_attribute" do
+      get "/api/v1/people/me?#{params.to_query}&fields=name"
       json = JSON.parse(last_response.body)
       assert_nil json['person'][attribute]
     end
-    define_method "test_should_expose_#{attribute}_attribute_in_person_enpoints_only_if_field_parameter_is_passed" do
+    define_method "test_should_expose_#{attribute}_attribute_in_person_enpoints_if_field_parameter_is_passed" do
       get "/api/v1/people/me?#{params.to_query}&fields=#{attribute}"
       json = JSON.parse(last_response.body)
       assert_not_nil json['person'][attribute]
	@@ -22,18 +22,4 @@ class Noosfero::API::Entity < Grape::Entity		@@ -22,18 +22,4 @@ class Noosfero::API::Entity < Grape::Entity
22	end	22	end
23	end	23	end
24		24
25	- def self.fields_condition(fields)
26	- lambda do \|object, options\|
27	- return true if options[:fields].blank?
28	- fields.map { \|field\| options[:fields].include?(field.to_s)}.grep(true).present?
29	- end
30	- end
31	-
32	- def self.expose(*args, &block)
33	- hash = args.last.is_a?(Hash) ? args.pop : {}
34	- hash.merge!({:if => fields_condition(args)}) if hash[:if].blank?
35	- args << hash
36	- super
37	- end
38	-
39	end	25	end
	@@ -58,7 +58,7 @@ module Noosfero		@@ -58,7 +58,7 @@ module Noosfero
58	article = environment.articles.find(params[:id])	58	article = environment.articles.find(params[:id])
59	return forbidden! unless article.allow_edit?(current_person)	59	return forbidden! unless article.allow_edit?(current_person)
60	article.update_attributes!(params[:article])	60	article.update_attributes!(params[:article])
61	- present article, :with => Entities::Article, :fields => params[:fields]	61	+ present_partial article, :with => Entities::Article
62	end	62	end
63		63
64	desc 'Report a abuse and/or violent content in a article by id' do	64	desc 'Report a abuse and/or violent content in a article by id' do
	@@ -190,7 +190,7 @@ module Noosfero		@@ -190,7 +190,7 @@ module Noosfero
190	article = find_article(environment.articles, params[:id])	190	article = find_article(environment.articles, params[:id])
191	child = find_article(article.children, params[:child_id])	191	child = find_article(article.children, params[:child_id])
192	child.hit	192	child.hit
193	- present child, :with => Entities::Article, :fields => params[:fields]	193	+ present_partial child, :with => Entities::Article
194	end	194	end
195		195
196	desc 'Suggest a article to another profile' do	196	desc 'Suggest a article to another profile' do
	@@ -213,7 +213,7 @@ module Noosfero		@@ -213,7 +213,7 @@ module Noosfero
213	unless suggest_article.save	213	unless suggest_article.save
214	render_api_errors!(suggest_article.article_object.errors.full_messages)	214	render_api_errors!(suggest_article.article_object.errors.full_messages)
215	end	215	end
216	- present suggest_article, :with => Entities::Task, :fields => params[:fields]	216	+ present_partial suggest_article, :with => Entities::Task
217	end	217	end
218		218
219	# Example Request:	219	# Example Request:
	@@ -244,7 +244,7 @@ module Noosfero		@@ -244,7 +244,7 @@ module Noosfero
244	if !article.save	244	if !article.save
245	render_api_errors!(article.errors.full_messages)	245	render_api_errors!(article.errors.full_messages)
246	end	246	end
247	- present article, :with => Entities::Article, :fields => params[:fields]	247	+ present_partial article, :with => Entities::Article
248	end	248	end
249		249
250	end	250	end
	@@ -271,7 +271,7 @@ module Noosfero		@@ -271,7 +271,7 @@ module Noosfero
271	article = forbidden!	271	article = forbidden!
272	end	272	end
273		273
274	- present article, :with => Entities::Article, :fields => params[:fields]	274	+ present_partial article, :with => Entities::Article
275	else	275	else
276		276
277	present_articles_for_asset(profile)	277	present_articles_for_asset(profile)
	@@ -33,12 +33,12 @@ module Noosfero		@@ -33,12 +33,12 @@ module Noosfero
33	get do	33	get do
34	people = select_filtered_collection_of(environment, 'people', params)	34	people = select_filtered_collection_of(environment, 'people', params)
35	people = people.visible_for_person(current_person)	35	people = people.visible_for_person(current_person)
36	- present people, :with => Entities::Person, :fields => params[:fields]	36	+ present_partial people, :with => Entities::Person
37	end	37	end
38		38
39	desc "Return the logged user information"	39	desc "Return the logged user information"
40	get "/me" do	40	get "/me" do
41	- present current_person, :with => Entities::Person, :fields => params[:fields]	41	+ present_partial current_person, :with => Entities::Person
42	end	42	end
43		43
44	desc "Return the person information"	44	desc "Return the person information"
	@@ -20,13 +20,13 @@ module Noosfero		@@ -20,13 +20,13 @@ module Noosfero
20	get do	20	get do
21	tasks = select_filtered_collection_of(environment, 'tasks', params)	21	tasks = select_filtered_collection_of(environment, 'tasks', params)
22	tasks = tasks.select {\|t\| current_person.has_permission?(t.permission, environment)}	22	tasks = tasks.select {\|t\| current_person.has_permission?(t.permission, environment)}
23	- present tasks, :with => Entities::Task, :fields => params[:fields]	23	+ present_partial tasks, :with => Entities::Task
24	end	24	end
25		25
26	desc "Return the task id"	26	desc "Return the task id"
27	get ':id' do	27	get ':id' do
28	task = find_task(environment, params[:id])	28	task = find_task(environment, params[:id])
29	- present task, :with => Entities::Task, :fields => params[:fields]	29	+ present_partial task, :with => Entities::Task
30	end	30	end
31	end	31	end
32		32
	@@ -214,6 +214,26 @@ class APIHelpersTest < ActiveSupport::TestCase		@@ -214,6 +214,26 @@ class APIHelpersTest < ActiveSupport::TestCase
214	#assert_equals [article1, article2], present_articles	214	#assert_equals [article1, article2], present_articles
215	end	215	end
216		216
		217	+ should 'not touch in options when no fields parameter is passed' do
		218	+ model = mock
		219	+ expects(:present).with(model, {})
		220	+ present_partial(model, {})
		221	+ end
		222	+
		223	+ should 'fallback to array when fields parameter is not a json when calling present partial' do
		224	+ model = mock
		225	+ params[:fields] = 'name'
		226	+ expects(:present).with(model, {:only => ['name']})
		227	+ present_partial(model, {})
		228	+ end
		229	+
		230	+ should 'accept json as fields parameter when calling present partial' do
		231	+ model = mock
		232	+ params[:fields] = {only: [:name, {user: [:login]}]}.to_json
		233	+ expects(:present).with(model, {:only => ['name', {'user' => ['login']}]})
		234	+ present_partial(model, {})
		235	+ end
		236	+
217	###### Captcha tests ######	237	###### Captcha tests ######
218		238
219	should 'do not test captcha when there are no settings' do	239	should 'do not test captcha when there are no settings' do