fix entities api conflit

Caio Almeida
2 parents 94d1fa50 b34e0fa0
Showing 20 changed files with 425 additions and 15 deletions Show diff stats
Gemfile
Gemfile.lock
app/controllers/api_docs_controller.rb
app/controllers/public/account_controller.rb
app/views/account/forgot_password.html.erb
app/views/api_docs/index.html.erb
app/views/layouts/api_docs.html.erb
config/routes.rb
lib/noosfero/api/api.rb
lib/noosfero/api/entities.rb
lib/noosfero/api/helpers.rb
lib/noosfero/api/v1/articles.rb
lib/noosfero/api/v1/search.rb
plugins/oauth_client/controllers/public/oauth_client_plugin_public_controller.rb
plugins/oauth_client/db/migrate/20150815173209_add_authorization_data_to_oauth_client_user_provider.rb
plugins/oauth_client/test/functional/oauth_client_plugin_public_controller_test.rb
test/functional/account_controller_test.rb
test/unit/api/articles_test.rb
test/unit/api/search_test.rb
test/unit/api/test_helper.rb
@@ -23,6 +23,10 @@ gem &#39;eita-jrails&#39;, &#39;~&gt; 0.9.5&#39;, require: &#39;jrails&#39;
 # API dependencies
 gem 'grape',                    '~> 0.12'
 gem 'grape-entity'
+gem 'grape-swagger'
+gem 'swagger-ui_rails'
+gem 'kramdown'
+
 #FIXME Get the Grape Loggin from master yo solve this issue https://github.com/intridea/grape/issues/1059
 #We have to remove this commit referenve code when update the next release of grape_logging. Actualy we are using (1.1.2)
 gem 'grape_logging', :git => 'https://github.com/aceunreal/grape_logging.git', :ref => 'f1755ae'
@@ -103,12 +103,16 @@ GEM
     grape-entity (0.4.5)
       activesupport
       multi_json (>= 1.3.2)
+    grape-swagger (0.10.2)
+      grape (>= 0.8.0)
+      grape-entity
     hashie (2.1.2)
     hike (1.2.3)
     i18n (0.7.0)
     ice_nine (0.11.1)
     journey (1.0.4)
     json (1.8.3)
+    kramdown (1.8.0)
     libv8 (3.16.14.11)
     liquid (3.0.6)
     locale (2.0.9)
@@ -202,6 +206,7 @@ GEM
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
+    swagger-ui_rails (0.1.7)
     term-ansicolor (1.3.2)
       tins (~> 1.0)
     therubyracer (0.12.2)
@@ -254,7 +259,9 @@ DEPENDENCIES
   gettext (~> 2.2.1)
   grape (~> 0.12)
   grape-entity
+  grape-swagger
   grape_logging!
+  kramdown
   liquid (~> 3.0.3)
   locale (~> 2.0.5)
   minitest (~> 3.2.0)
@@ -274,6 +281,7 @@ DEPENDENCIES
   rubyzip
   sass-rails
   selenium-webdriver (~> 2.39.0)
+  swagger-ui_rails
   therubyracer
   thin (~> 1.3.1)
   uglifier (>= 1.0.3)
@@ -0,0 +1,8 @@
+class ApiDocsController < ApplicationController
+  layout :api_layout
+
+  private
+    def api_layout
+      params[:controller]
+    end
+end
@@ -196,6 +196,11 @@ class AccountController &lt; ApplicationController
     if request.post?
       begin
+        unless verify_recaptcha
+          @change_password.errors.add(:base, _('Please type the words correctly'))
+          return false
+        end
+
         requestors = fetch_requestors(params[:value])
         raise ActiveRecord::RecordNotFound if requestors.blank? || params[:value].blank?
@@ -5,6 +5,9 @@
 <%= form_tag({:action => 'forgot_password'}, :method => 'post', :id => 'forgot-password-form') do %>
   <%= labelled_form_field fields_label, text_field_tag(:value) %>
+  <h3><%= _('Please type the two words below') %></h3>
+  <%= recaptcha_tags(:display => { :theme => 'clean' }, :ajax => true) %>
+
   <div>
     <% button_bar do %>
       <%= submit_button('send', _('Send instructions')) %>
@@ -0,0 +1 @@
+<%= render 'swagger_ui/swagger_ui', discovery_url: '/api/v1/api_docs' %>
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title></title>
+    <%= stylesheet_link_tag 'swagger-ui' %>
+    <%= javascript_include_tag 'swagger-ui' %>
+  </head>
+  <body>
+    <div id="content">
+      <%= yield %>
+    </div>
+  </body>
+</html>
@@ -23,6 +23,7 @@ Noosfero::Application.routes.draw do
   match 'site(/:action)', :controller => 'home'
   match 'api(/:action)', :controller => 'api'
+  match 'api_docs(/:action)', :controller => 'api_docs'
   match 'images(/*stuff)' => 'not_found#nothing'
   match 'stylesheets(/*stuff)' => 'not_found#nothing'
@@ -51,9 +51,12 @@ module Noosfero
       mount V1::Tasks
       mount V1::Tags
       mount V1::Environments
+      mount V1::Search
       mount Session
+      add_swagger_documentation api_version: 'v1', mount_path: '/api_docs', markdown: GrapeSwagger::Markdown::KramdownAdapter unless Rails.env.production?
+
       # hook point which allow plugins to add Grape::API extensions to API::API
       #finds for plugins which has api mount points classes defined (the class should extends Grape::API)
       @plugins = Noosfero::Plugin.all.map { |p| p.constantize }
@@ -67,7 +67,7 @@ module Noosfero
       class Person < Profile
         root 'people', 'person'
-        expose :user, :using => UserBasic
+        expose :user, :using => UserBasic, documentation: {type: 'User', desc: 'The user data of a person' }
         expose :orientacao_sexual, :identidade_genero, :transgenero, :etnia
       end
@@ -84,11 +84,11 @@ module Noosfero
         root 'articles', 'article'
         expose :id
         expose :body
-        expose :abstract
+        expose :abstract, documentation: {type: 'String', desc: 'Teaser of the body'}
         expose :created_at, :format_with => :timestamp
         expose :title, :documentation => {:type => "String", :desc => "Title of the article"}
-        expose :created_by, :as => :author, :using => Profile
-        expose :profile, :using => Profile
+        expose :created_by, :as => :author, :using => Profile, :documentation => {type: 'Profile', desc: 'The profile author that create the article'}
+        expose :profile, :using => Profile, :documentation => {type: 'Profile', desc: 'The profile associated with the article'}
         expose :categories, :using => Category
         expose :image, :using => Image
         #TODO Apply vote stuff in core and make this test
@@ -98,7 +98,7 @@ module Noosfero
         expose :position
         expose :hits
         expose :start_date
-        expose :end_date
+        expose :end_date, :documentation => {type: 'DateTime', desc: 'The date of finish of the article'}
         expose :tag_list
         expose :children_count
       end
@@ -109,6 +109,7 @@ module Noosfero
         expose :children, using: ArticleBase do |article, options|
           article.children.limit(Noosfero::API::V1::Articles::MAX_PER_PAGE)
         end
+        expose :slug, :documentation => {:type => "String", :desc => "Trimmed and parsed name of a article"}
       end
       class Comment < Entity
@@ -138,7 +139,7 @@ module Noosfero
       end
       class UserLogin < User
-        expose :private_token
+        expose :private_token, documentation: {type: 'String', desc: 'A valid authentication code for post/delete api actions'}
       end
       class Task < Entity
@@ -10,6 +10,7 @@ require &#39;grape&#39;
       include SanitizeParams
       include Noosfero::Plugin::HotSpot
       include ForgotPasswordHelper
+      include SearchTermHelper
       def set_locale
         I18n.locale = (params[:lang] || request.env['HTTP_ACCEPT_LANGUAGE'] || 'en')
@@ -39,6 +40,24 @@ require &#39;grape&#39;
         @environment
       end
+      ####################################################################
+      #### SEARCH
+      ####################################################################
+      def find_by_contents(asset, context, scope, query, paginate_options={:page => 1}, options={})
+        scope = scope.with_templates(options[:template_id]) unless options[:template_id].blank?
+        search = plugins.dispatch_first(:find_by_contents, asset, scope, query, paginate_options, options)
+        register_search_term(query, scope.count, search[:results].count, context, asset)
+        search
+      end
+      def paginate_options(page = params[:page])
+        page = 1 if multiple_search?(@searches) || params[:display] == 'map'
+        { :per_page => limit, :page => page }
+      end
+      def multiple_search?(searches=nil)
+        ['index', 'category_index'].include?(params[:action]) || (searches && searches.size > 1)
+      end      
+      ####################################################################
+
       def logger
         logger = Logger.new(File.join(Rails.root, 'log', "#{ENV['RAILS_ENV'] || 'production'}_api.log"))
         logger.formatter = GrapeLogging::Formatters::Default.new
@@ -99,7 +118,11 @@ require &#39;grape&#39;
       def present_articles(asset, method = 'articles')
         articles = find_articles(asset, method)
-        articles = paginate articles
+        present_articles_paginated(articles)
+      end
+
+      def present_articles_paginated(articles, per_page=nil)
+        articles = paginate(articles)
         present articles, :with => Entities::Article, :fields => params[:fields]
       end
@@ -21,6 +21,19 @@ module Noosfero
           # Example Request:
           #  GET host/api/v1/articles?from=2013-04-04-14:41:43&until=2015-04-04-14:41:43&limit=10&private_token=e96fff37c2238fdab074d1dcea8e6317
+          desc 'Return all articles of all kinds' do
+            detail 'Get all articles filtered by fields in query params'
+            params Noosfero::API::Entities::Article.documentation
+            success Noosfero::API::Entities::Article
+            failure [[403, 'Forbidden']]
+            named 'ArticlesList'
+            headers [
+              'Per-Page' => {
+                    description: 'Total number of records',
+                    required: false
+                }
+              ]
+          end
           get do
             present_articles(environment)
           end
@@ -30,8 +43,14 @@ module Noosfero
             present_articles(current_person, 'following_articles')
           end
-          desc "Return the article id"
-          get ':id' do
+          desc "Return one article by id" do
+            detail 'Get only one article by id. If not found the "forbidden" http error is showed'
+            params Noosfero::API::Entities::Article.documentation
+            success Noosfero::API::Entities::Article
+            failure [[403, 'Forbidden']]
+            named 'ArticleById'
+          end
+          get ':id', requirements: {id: /[0-9]+/} do
             present_article(environment)
           end
@@ -42,6 +61,12 @@ module Noosfero
             present article, :with => Entities::Article, :fields => params[:fields]
           end
+          desc 'Report a abuse and/or violent content in a article by id' do
+            detail 'Submit a abuse (in general, a content violation) report about a specific article'
+            params Noosfero::API::Entities::Article.documentation
+            failure [[400, 'Bad Request']]
+            named 'ArticleReportAbuse'
+          end
           post ':id/report_abuse' do
             article = find_article(environment.articles, params[:id])
             profile = article.profile
@@ -70,14 +95,23 @@ module Noosfero
           end
-          desc "Returns the total followers for the article"
+          desc "Returns the total followers for the article" do
+            detail 'Get the followers of a specific article by id'
+            failure [[403, 'Forbidden']]
+            named 'ArticleFollowers'
+          end
           get ':id/followers' do
             article = find_article(environment.articles, params[:id])
             total = article.person_followers.count
             {:total_followers => total}
           end
-          desc "Add a follower for the article"
+          desc "Add a follower for the article" do
+            detail 'Add the current user identified by private token, like a follower of a article'
+            params Noosfero::API::Entities::UserLogin.documentation
+            failure [[401, 'Unauthorized']]
+            named 'ArticleFollow'
+          end
           post ':id/follow' do
             authenticate!
             article = find_article(environment.articles, params[:id])
@@ -92,6 +126,12 @@ module Noosfero
             end
           end
+          desc 'Perform a vote on a article by id' do
+            detail 'Vote on a specific article with values: 1 (if you like) or -1 (if not)'
+            params Noosfero::API::Entities::UserLogin.documentation
+            failure [[401,'Unauthorized']]
+            named 'ArticleVote'
+          end
           post ':id/vote' do
             authenticate!
             value = (params[:value] || 1).to_i
@@ -102,13 +142,20 @@ module Noosfero
             {:vote => vote.save}
           end
+          desc 'Return the children of a article identified by id' do
+            detail 'Get all children articles of a specific article'
+            params Noosfero::API::Entities::Article.documentation
+            failure [[403, 'Forbidden']]
+            named 'ArticleChildren'
+          end
           get ':id/children' do
             article = find_article(environment.articles, params[:id])
             #TODO make tests for this situation
             votes_order = params.delete(:order) if params[:order]=='votes_score'
+            articles = select_filtered_collection_of(article, 'children', params)
+            articles = articles.display_filter(current_person, article.profile)
-            articles = find_articles(article, 'children')
             #TODO make tests for this situation
             if votes_order
@@ -119,6 +166,13 @@ module Noosfero
             present articles, :with => Entities::Article, :fields => params[:fields]
           end
+          desc 'Return one child of a article identified by id' do
+            detail 'Get a child of a specific article'
+            params Noosfero::API::Entities::Article.documentation
+            success Noosfero::API::Entities::Article
+            failure [[403, 'Forbidden']]
+            named 'ArticleChild'
+          end
           get ':id/children/:child_id' do
             article = find_article(environment.articles, params[:id])
             child = find_article(article.children, params[:child_id])
@@ -126,6 +180,13 @@ module Noosfero
             present child, :with => Entities::Article, :fields => params[:fields]
           end
+          desc 'Suggest a article to another profile' do
+            detail 'Suggest a article to another profile (person, community...)'
+            params Noosfero::API::Entities::Article.documentation
+            success Noosfero::API::Entities::Task
+            failure [[401,'Unauthorized']]
+            named 'ArticleSuggest'
+          end
           post ':id/children/suggest' do
             authenticate!
             parent_article = environment.articles.find(params[:id])
@@ -144,6 +205,13 @@ module Noosfero
           # Example Request:
           #  POST api/v1/articles/:id/children?private_token=234298743290432&article[name]=title&article[body]=body
+          desc 'Add a child article to a parent identified by id' do
+            detail 'Create a new article and associate to a parent'
+            params Noosfero::API::Entities::Article.documentation
+            success Noosfero::API::Entities::Article
+            failure [[401,'Unauthorized']]
+            named 'ArticleAddChild'
+          end
           post ':id/children' do
             authenticate!
             parent_article = environment.articles.find(params[:id])
@@ -173,11 +241,37 @@ module Noosfero
           resource kind.pluralize.to_sym do
             segment "/:#{kind}_id" do
               resource :articles do
+
+                desc "Return all articles associate with a profile of type #{kind}" do
+                  detail 'Get a list of articles of a profile'
+                  params Noosfero::API::Entities::Article.documentation
+                  success Noosfero::API::Entities::Article
+                  failure [[403, 'Forbidden']]
+                  named 'ArticlesOfProfile'
+                end
                 get do
                   profile = environment.send(kind.pluralize).find(params["#{kind}_id"])
-                  present_articles(profile)
+
+                  if params[:path].present?
+                    article = profile.articles.find_by_path(params[:path])
+                    if !article || !article.display_to?(current_person)
+                      article = forbidden!
+                    end
+
+                    present article, :with => Entities::Article, :fields => params[:fields]
+                  else
+
+                    present_articles(profile)
+                  end
                 end
+                desc "Return a article associate with a profile of type #{kind}" do
+                  detail 'Get only one article of a profile'
+                  params Noosfero::API::Entities::Article.documentation
+                  success Noosfero::API::Entities::Article
+                  failure [[403, 'Forbidden']]
+                  named 'ArticleOfProfile'
+                end
                 get ':id' do
                   profile = environment.send(kind.pluralize).find(params["#{kind}_id"])
                   present_article(profile)
@@ -185,6 +279,13 @@ module Noosfero
                 # Example Request:
                 #  POST api/v1/{people,communities,enterprises}/:asset_id/articles?private_token=234298743290432&article[name]=title&article[body]=body
+                desc "Add a new article associated with a profile of type #{kind}" do
+                  detail 'Create a new article and associate with a profile'
+                  params Noosfero::API::Entities::Article.documentation
+                  success Noosfero::API::Entities::Article
+                  failure [[403, 'Forbidden']]
+                  named 'ArticleCreateToProfile'
+                end
                 post do
                   profile = environment.send(kind.pluralize).find(params["#{kind}_id"])
                   post_article(profile, params)
@@ -0,0 +1,43 @@
+module Noosfero
+  module API
+    module V1
+      class Search < Grape::API  
+
+        resource :search do
+          resource :article do
+            paginate per_page: 20, max_per_page: 200
+            get do
+              # Security checks
+              sanitize_params_hash(params) 
+              # APIHelpers
+              asset = :articles
+              context = environment
+
+              profile = environment.profiles.find(params[:profile_id]) if params[:profile_id]
+
+              scope = profile.nil? ? environment.articles.public : profile.articles.public
+
+              scope = scope.where(:type => params[:type]) if params[:type] && !(params[:type] == 'Article')
+              
+              category = params[:category] || ""
+
+              query = params[:query] || ""             
+              order = "more_recent"
+
+              options = {:filter => order, :template_id => params[:template_id], :category => category}            
+
+              search_result = find_by_contents(asset, context, scope, query, paginate_options, options)
+
+              articles = search_result[:results]
+
+              result = present_articles_paginated(articles)
+              
+              result
+            end            
+          end
+        end
+
+      end
+    end
+  end
+end
@@ -36,6 +36,7 @@ class OauthClientPluginPublicController &lt; PublicController
     auth ||= person.oauth_auths.create! profile: person, provider: provider, enabled: true
     if auth.enabled? && provider.enabled?
       self.current_user = person.user
+      self.current_user.generate_private_token!
     else
       session[:notice] = _("Can't login with %s") % provider.name
     end
@@ -12,8 +12,11 @@ class AddAuthorizationDataToOauthClientUserProvider &lt; ActiveRecord::Migration
     add_column :oauth_client_plugin_auths, :profile_id, :integer
     OauthClientPlugin::Auth.find_each batch_size: 50 do |auth|
-      auth.profile = User.find(auth.user_id).person
-      auth.save!
+      user = User.find_by_id(auth.user_id)
+      if user.present?
+        auth.profile = user.person
+        auth.save!
+      end
     end
     remove_column :oauth_client_plugin_auths, :user_id
@@ -31,6 +31,17 @@ class OauthClientPluginPublicControllerTest &lt; ActionController::TestCase
     assert_equal user.id, session[:user]
   end
+  should 'generate private token when login' do
+    user = create_user
+    auth.info.stubs(:email).returns(user.email)
+    auth.info.stubs(:name).returns(user.name)
+    session[:provider_id] = provider.id
+
+    assert user.reload.private_token.nil?
+    get :callback
+    assert user.reload.private_token.present?
+  end
+
   should 'do not login when the provider is disabled' do
     user = create_user
     auth.info.stubs(:email).returns(user.email)
@@ -232,6 +232,16 @@ class AccountControllerTest &lt; ActionController::TestCase
     assert_template 'password_recovery_sent'
   end
+  should 'not respond to forgotten password change if captcha verification fails' do
+    create_user('test')
+    @controller.stubs(:verify_recaptcha).returns(false)
+    post :forgot_password, :value => 'test'
+    change = assigns(:change_password)
+    assert change.errors.has_key?(:base)
+    assert_response :success
+    assert_tag :tag => 'div', :attributes => { :id => 'errorExplanation', :class => 'errorExplanation' }
+  end
+
   should 'respond to forgotten password change request with email' do
     change = ChangePassword.new
     create_user('test', :email => 'test@localhost.localdomain')
@@ -91,6 +91,41 @@ class ArticlesTest &lt; ActiveSupport::TestCase
     assert_not_includes json['articles'].map {|a| a['id']}, child.id
   end
+  should 'follow a article identified by id' do
+    article = fast_create(Article, :profile_id => @person.id, :name => "Some thing")
+    post "/api/v1/articles/#{article.id}/follow?#{params.to_query}"
+    json = JSON.parse(last_response.body)
+
+    assert_not_equal 401, last_response.status
+    assert_equal true, json['success']
+  end
+
+  should 'return the followers of a article identified by id' do
+    article = fast_create(Article, :profile_id => @person.id, :name => "Some thing")
+
+    article_follower = ArticleFollower.new
+    article_follower.article = article
+    article_follower.person = @person
+    article_follower.save!
+
+    get "/api/v1/articles/#{article.id}/followers?"
+    json = JSON.parse(last_response.body)
+
+    assert_equal 200, last_response.status
+    assert_equal 1, json['total_followers']
+  end
+
+  should 'perform a vote in a article identified by id' do
+    article = fast_create(Article, :profile_id => @person.id, :name => "Some thing")
+    @params[:value] = 1
+
+    post "/api/v1/articles/#{article.id}/vote?#{params.to_query}"
+    json = JSON.parse(last_response.body)
+
+    assert_not_equal 401, last_response.status
+    assert_equal true, json['vote']
+  end
+
   expose_attributes = %w(id body abstract created_at title author profile categories image votes_for votes_against setting position hits start_date end_date tag_list parent children children_count)
   expose_attributes.each do |attr|
@@ -180,6 +215,29 @@ class ArticlesTest &lt; ActiveSupport::TestCase
       json = JSON.parse(last_response.body)
       assert_not_includes json['articles'].map {|a| a['id']}, article.id
     end
+
+    should "return article by #{kind} and path" do
+      profile = fast_create(kind.camelcase.constantize, :environment_id => environment.id)
+      parent_article = Folder.create!(:profile => profile, :name => "Parent Folder")
+      article = Article.create!(:profile => profile, :name => "Some thing", :parent => parent_article)
+
+      params[:path] = parent_article.slug+'/'+article.slug
+      get "/api/v1/#{kind.pluralize}/#{profile.id}/articles?#{params.to_query}"
+      json = JSON.parse(last_response.body)
+      assert_equal article.id, json["article"]["id"]
+    end
+
+    should "not return article by #{kind} and path if user has no permission to view it" do
+      profile = fast_create(kind.camelcase.constantize, :environment_id => environment.id)
+      parent_article = Folder.create!(:profile => profile, :name => "Parent Folder")
+      article = Article.create!(:profile => profile, :name => "Some thing", :parent => parent_article, :published => false)
+
+      assert !article.published?
+
+      params[:path] = parent_article.slug+'/'+article.slug
+      get "/api/v1/#{kind.pluralize}/#{profile.id}/articles?#{params.to_query}"
+      assert_equal 403, last_response.status
+    end
   end
   #############################
@@ -0,0 +1,107 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class SearchTest < ActiveSupport::TestCase
+
+  def create_article_with_optional_category(name, profile, category = nil)
+    fast_create(Article, {:name => name, :profile_id => profile.id }, :search => true, :category => category, :title => name)
+  end
+
+  should 'not list unpublished articles' do
+    person = fast_create(Person)
+    article = fast_create(Article, :profile_id => person.id, :name => "Some thing", :published => false)
+    assert !article.published?  	
+    get "/api/v1/search/article"
+    json = JSON.parse(last_response.body)    
+    assert_empty json['articles']
+  end
+
+  should 'list articles' do
+  	person = fast_create(Person)
+  	art = create_article_with_optional_category('an article to be found', person)
+    get "/api/v1/search/article"
+    json = JSON.parse(last_response.body)
+    assert_not_empty json['articles']
+  end
+
+  should 'invalid search string articles' do
+  	person = fast_create(Person)
+  	art = create_article_with_optional_category('an article to be found', person)
+    get "/api/v1/search/article?query=test"
+    json = JSON.parse(last_response.body)    
+    assert_empty json['articles']
+  end
+
+  should 'do not list articles of wrong type' do
+  	person = fast_create(Person)
+  	art = create_article_with_optional_category('an article to be found', person)
+    get "/api/v1/search/article?type=TinyMceArticle"
+    json = JSON.parse(last_response.body)
+    assert_empty json['articles']
+  end
+
+  should 'list articles of one type' do
+  	person = fast_create(Person)
+  	art = create_article_with_optional_category('an article to be found', person)
+  	article = fast_create(TinyMceArticle, :profile_id => person.id, :name => "Some thing", :published => true)
+    get "/api/v1/search/article?type=TinyMceArticle"
+    json = JSON.parse(last_response.body)
+    assert_equal 1, json['articles'].count
+  end
+
+  should 'list articles of one type and query string' do
+  	person = fast_create(Person)
+  	art = create_article_with_optional_category('an article to be found', person)
+  	art1 = create_article_with_optional_category('article for query', person)
+  	article = fast_create(TinyMceArticle, :profile_id => person.id, :name => "Some thing", :published => true)
+    get "/api/v1/search/article?type=TinyMceArticle&query=thing"
+    json = JSON.parse(last_response.body)
+    assert_equal 1, json['articles'].count
+  end
+
+  should 'not return more entries than page limit' do
+  	person = fast_create(Person)
+    ('1'..'5').each do |n|
+      art = create_article_with_optional_category("Article #{n}", person)
+    end
+
+    get "/api/v1/search/article?query=Article&per_page=3"
+    json = JSON.parse(last_response.body)
+
+    assert_equal 3, json['articles'].count
+  end
+
+  should 'return entries second page' do
+  	person = fast_create(Person)
+    ('1'..'5').each do |n|
+      art = create_article_with_optional_category("Article #{n}", person)
+    end
+
+    get "/api/v1/search/article?query=Article&per_page=3&page=2"
+    json = JSON.parse(last_response.body)
+
+    assert_equal 2, json['articles'].count
+  end
+
+  should 'search articles in profile' do
+  	person1 = fast_create(Person)
+  	person2 = fast_create(Person)
+
+  	art1 = create_article_with_optional_category("Article 1 for profile #{person1.id}", person1)
+  	art2 = create_article_with_optional_category("Article for profile #{person2.id}", person2)
+  	art3 = create_article_with_optional_category("Article 2 for profile #{person1.id}", person1)
+
+    get "/api/v1/search/article?query=Article&profile_id=#{person1.id}"
+    json = JSON.parse(last_response.body)
+    # Only for person1
+    assert_equal 2, json['articles'].count
+  end
+
+  should 'search with fields' do
+	person = fast_create(Person)
+  	art = create_article_with_optional_category('an article to be found', person)
+    get "/api/v1/search/article?fields=title"
+    json = JSON.parse(last_response.body)
+    assert_not_empty json['articles']
+	assert_equal ['title'], json['articles'].first.keys
+  end
+end
 \ No newline at end of file
@@ -17,6 +17,11 @@ class ActiveSupport::TestCase
     post "/api/v1/login?login=testapi&password=testapi"
     json = JSON.parse(last_response.body)
     @private_token = json["private_token"]
+    unless @private_token
+      @user.generate_private_token!
+      @private_token = @user.private_token
+    end
+
     @params = {:private_token => @private_token}
   end
   attr_accessor :private_token, :user, :person, :params, :environment
	@@ -103,12 +103,16 @@ GEM		@@ -103,12 +103,16 @@ GEM
103	grape-entity (0.4.5)	103	grape-entity (0.4.5)
104	activesupport	104	activesupport
105	multi_json (>= 1.3.2)	105	multi_json (>= 1.3.2)
		106	+ grape-swagger (0.10.2)
		107	+ grape (>= 0.8.0)
		108	+ grape-entity
106	hashie (2.1.2)	109	hashie (2.1.2)
107	hike (1.2.3)	110	hike (1.2.3)
108	i18n (0.7.0)	111	i18n (0.7.0)
109	ice_nine (0.11.1)	112	ice_nine (0.11.1)
110	journey (1.0.4)	113	journey (1.0.4)
111	json (1.8.3)	114	json (1.8.3)
		115	+ kramdown (1.8.0)
112	libv8 (3.16.14.11)	116	libv8 (3.16.14.11)
113	liquid (3.0.6)	117	liquid (3.0.6)
114	locale (2.0.9)	118	locale (2.0.9)
	@@ -202,6 +206,7 @@ GEM		@@ -202,6 +206,7 @@ GEM
202	multi_json (~> 1.0)	206	multi_json (~> 1.0)
203	rack (~> 1.0)	207	rack (~> 1.0)
204	tilt (~> 1.1, != 1.3.0)	208	tilt (~> 1.1, != 1.3.0)
		209	+ swagger-ui_rails (0.1.7)
205	term-ansicolor (1.3.2)	210	term-ansicolor (1.3.2)
206	tins (~> 1.0)	211	tins (~> 1.0)
207	therubyracer (0.12.2)	212	therubyracer (0.12.2)
	@@ -254,7 +259,9 @@ DEPENDENCIES		@@ -254,7 +259,9 @@ DEPENDENCIES
254	gettext (~> 2.2.1)	259	gettext (~> 2.2.1)
255	grape (~> 0.12)	260	grape (~> 0.12)
256	grape-entity	261	grape-entity
		262	+ grape-swagger
257	grape_logging!	263	grape_logging!
		264	+ kramdown
258	liquid (~> 3.0.3)	265	liquid (~> 3.0.3)
259	locale (~> 2.0.5)	266	locale (~> 2.0.5)
260	minitest (~> 3.2.0)	267	minitest (~> 3.2.0)
	@@ -274,6 +281,7 @@ DEPENDENCIES		@@ -274,6 +281,7 @@ DEPENDENCIES
274	rubyzip	281	rubyzip
275	sass-rails	282	sass-rails
276	selenium-webdriver (~> 2.39.0)	283	selenium-webdriver (~> 2.39.0)
		284	+ swagger-ui_rails
277	therubyracer	285	therubyracer
278	thin (~> 1.3.1)	286	thin (~> 1.3.1)
279	uglifier (>= 1.0.3)	287	uglifier (>= 1.0.3)
@@ -0,0 +1,8 @@		@@ -0,0 +1,8 @@
	1	+class ApiDocsController < ApplicationController
	2	+ layout :api_layout
	3	+
	4	+ private
	5	+ def api_layout
	6	+ params[:controller]
	7	+ end
	8	+end
	@@ -0,0 +1 @@		@@ -0,0 +1 @@
		1	+<%= render 'swagger_ui/swagger_ui', discovery_url: '/api/v1/api_docs' %>
@@ -0,0 +1,14 @@		@@ -0,0 +1,14 @@
	1	+<!DOCTYPE html>
	2	+<html>
	3	+ <head>
	4	+ <meta charset="utf-8">
	5	+ <title></title>
	6	+ <%= stylesheet_link_tag 'swagger-ui' %>
	7	+ <%= javascript_include_tag 'swagger-ui' %>
	8	+ </head>
	9	+ <body>
	10	+ <div id="content">
	11	+ <%= yield %>
	12	+ </div>
	13	+ </body>
	14	+</html>
	@@ -23,6 +23,7 @@ Noosfero::Application.routes.draw do		@@ -23,6 +23,7 @@ Noosfero::Application.routes.draw do
23		23
24	match 'site(/:action)', :controller => 'home'	24	match 'site(/:action)', :controller => 'home'
25	match 'api(/:action)', :controller => 'api'	25	match 'api(/:action)', :controller => 'api'
		26	+ match 'api_docs(/:action)', :controller => 'api_docs'
26		27
27	match 'images(/*stuff)' => 'not_found#nothing'	28	match 'images(/*stuff)' => 'not_found#nothing'
28	match 'stylesheets(/*stuff)' => 'not_found#nothing'	29	match 'stylesheets(/*stuff)' => 'not_found#nothing'
	@@ -10,6 +10,7 @@ require 'grape'		@@ -10,6 +10,7 @@ require 'grape'
10	include SanitizeParams	10	include SanitizeParams
11	include Noosfero::Plugin::HotSpot	11	include Noosfero::Plugin::HotSpot
12	include ForgotPasswordHelper	12	include ForgotPasswordHelper
		13	+ include SearchTermHelper
13		14
14	def set_locale	15	def set_locale
15	I18n.locale = (params[:lang] \|\| request.env['HTTP_ACCEPT_LANGUAGE'] \|\| 'en')	16	I18n.locale = (params[:lang] \|\| request.env['HTTP_ACCEPT_LANGUAGE'] \|\| 'en')
	@@ -39,6 +40,24 @@ require 'grape'		@@ -39,6 +40,24 @@ require 'grape'
39	@environment	40	@environment
40	end	41	end
41		42
		43	+ ####################################################################
		44	+ #### SEARCH
		45	+ ####################################################################
		46	+ def find_by_contents(asset, context, scope, query, paginate_options={:page => 1}, options={})
		47	+ scope = scope.with_templates(options[:template_id]) unless options[:template_id].blank?
		48	+ search = plugins.dispatch_first(:find_by_contents, asset, scope, query, paginate_options, options)
		49	+ register_search_term(query, scope.count, search[:results].count, context, asset)
		50	+ search
		51	+ end
		52	+ def paginate_options(page = params[:page])
		53	+ page = 1 if multiple_search?(@searches) \|\| params[:display] == 'map'
		54	+ { :per_page => limit, :page => page }
		55	+ end
		56	+ def multiple_search?(searches=nil)
		57	+ ['index', 'category_index'].include?(params[:action]) \|\| (searches && searches.size > 1)
		58	+ end
		59	+ ####################################################################
		60	+
42	def logger	61	def logger
43	logger = Logger.new(File.join(Rails.root, 'log', "#{ENV['RAILS_ENV'] \|\| 'production'}_api.log"))	62	logger = Logger.new(File.join(Rails.root, 'log', "#{ENV['RAILS_ENV'] \|\| 'production'}_api.log"))
44	logger.formatter = GrapeLogging::Formatters::Default.new	63	logger.formatter = GrapeLogging::Formatters::Default.new
	@@ -99,7 +118,11 @@ require 'grape'		@@ -99,7 +118,11 @@ require 'grape'
99		118
100	def present_articles(asset, method = 'articles')	119	def present_articles(asset, method = 'articles')
101	articles = find_articles(asset, method)	120	articles = find_articles(asset, method)
102	- articles = paginate articles	121	+ present_articles_paginated(articles)
		122	+ end
		123	+
		124	+ def present_articles_paginated(articles, per_page=nil)
		125	+ articles = paginate(articles)
103	present articles, :with => Entities::Article, :fields => params[:fields]	126	present articles, :with => Entities::Article, :fields => params[:fields]
104	end	127	end
105		128
	@@ -21,6 +21,19 @@ module Noosfero		@@ -21,6 +21,19 @@ module Noosfero
21	# Example Request:	21	# Example Request:
22	# GET host/api/v1/articles?from=2013-04-04-14:41:43&until=2015-04-04-14:41:43&limit=10&private_token=e96fff37c2238fdab074d1dcea8e6317	22	# GET host/api/v1/articles?from=2013-04-04-14:41:43&until=2015-04-04-14:41:43&limit=10&private_token=e96fff37c2238fdab074d1dcea8e6317
23		23
		24	+ desc 'Return all articles of all kinds' do
		25	+ detail 'Get all articles filtered by fields in query params'
		26	+ params Noosfero::API::Entities::Article.documentation
		27	+ success Noosfero::API::Entities::Article
		28	+ failure [[403, 'Forbidden']]
		29	+ named 'ArticlesList'
		30	+ headers [
		31	+ 'Per-Page' => {
		32	+ description: 'Total number of records',
		33	+ required: false
		34	+ }
		35	+ ]
		36	+ end
24	get do	37	get do
25	present_articles(environment)	38	present_articles(environment)
26	end	39	end
	@@ -30,8 +43,14 @@ module Noosfero		@@ -30,8 +43,14 @@ module Noosfero
30	present_articles(current_person, 'following_articles')	43	present_articles(current_person, 'following_articles')
31	end	44	end
32		45
33	- desc "Return the article id"
34	- get ':id' do	46	+ desc "Return one article by id" do
		47	+ detail 'Get only one article by id. If not found the "forbidden" http error is showed'
		48	+ params Noosfero::API::Entities::Article.documentation
		49	+ success Noosfero::API::Entities::Article
		50	+ failure [[403, 'Forbidden']]
		51	+ named 'ArticleById'
		52	+ end
		53	+ get ':id', requirements: {id: /[0-9]+/} do
35	present_article(environment)	54	present_article(environment)
36	end	55	end
37		56
	@@ -42,6 +61,12 @@ module Noosfero		@@ -42,6 +61,12 @@ module Noosfero
42	present article, :with => Entities::Article, :fields => params[:fields]	61	present article, :with => Entities::Article, :fields => params[:fields]
43	end	62	end
44		63
		64	+ desc 'Report a abuse and/or violent content in a article by id' do
		65	+ detail 'Submit a abuse (in general, a content violation) report about a specific article'
		66	+ params Noosfero::API::Entities::Article.documentation
		67	+ failure [[400, 'Bad Request']]
		68	+ named 'ArticleReportAbuse'
		69	+ end
45	post ':id/report_abuse' do	70	post ':id/report_abuse' do
46	article = find_article(environment.articles, params[:id])	71	article = find_article(environment.articles, params[:id])
47	profile = article.profile	72	profile = article.profile
	@@ -70,14 +95,23 @@ module Noosfero		@@ -70,14 +95,23 @@ module Noosfero
70		95
71	end	96	end
72		97
73	- desc "Returns the total followers for the article"	98	+ desc "Returns the total followers for the article" do
		99	+ detail 'Get the followers of a specific article by id'
		100	+ failure [[403, 'Forbidden']]
		101	+ named 'ArticleFollowers'
		102	+ end
74	get ':id/followers' do	103	get ':id/followers' do
75	article = find_article(environment.articles, params[:id])	104	article = find_article(environment.articles, params[:id])
76	total = article.person_followers.count	105	total = article.person_followers.count
77	{:total_followers => total}	106	{:total_followers => total}
78	end	107	end
79		108
80	- desc "Add a follower for the article"	109	+ desc "Add a follower for the article" do
		110	+ detail 'Add the current user identified by private token, like a follower of a article'
		111	+ params Noosfero::API::Entities::UserLogin.documentation
		112	+ failure [[401, 'Unauthorized']]
		113	+ named 'ArticleFollow'
		114	+ end
81	post ':id/follow' do	115	post ':id/follow' do
82	authenticate!	116	authenticate!
83	article = find_article(environment.articles, params[:id])	117	article = find_article(environment.articles, params[:id])
	@@ -92,6 +126,12 @@ module Noosfero		@@ -92,6 +126,12 @@ module Noosfero
92	end	126	end
93	end	127	end
94		128
		129	+ desc 'Perform a vote on a article by id' do
		130	+ detail 'Vote on a specific article with values: 1 (if you like) or -1 (if not)'
		131	+ params Noosfero::API::Entities::UserLogin.documentation
		132	+ failure [[401,'Unauthorized']]
		133	+ named 'ArticleVote'
		134	+ end
95	post ':id/vote' do	135	post ':id/vote' do
96	authenticate!	136	authenticate!
97	value = (params[:value] \|\| 1).to_i	137	value = (params[:value] \|\| 1).to_i
	@@ -102,13 +142,20 @@ module Noosfero		@@ -102,13 +142,20 @@ module Noosfero
102	{:vote => vote.save}	142	{:vote => vote.save}
103	end	143	end
104		144
		145	+ desc 'Return the children of a article identified by id' do
		146	+ detail 'Get all children articles of a specific article'
		147	+ params Noosfero::API::Entities::Article.documentation
		148	+ failure [[403, 'Forbidden']]
		149	+ named 'ArticleChildren'
		150	+ end
105	get ':id/children' do	151	get ':id/children' do
106	article = find_article(environment.articles, params[:id])	152	article = find_article(environment.articles, params[:id])
107		153
108	#TODO make tests for this situation	154	#TODO make tests for this situation
109	votes_order = params.delete(:order) if params[:order]=='votes_score'	155	votes_order = params.delete(:order) if params[:order]=='votes_score'
		156	+ articles = select_filtered_collection_of(article, 'children', params)
		157	+ articles = articles.display_filter(current_person, article.profile)
110		158
111	- articles = find_articles(article, 'children')
112		159
113	#TODO make tests for this situation	160	#TODO make tests for this situation
114	if votes_order	161	if votes_order
	@@ -119,6 +166,13 @@ module Noosfero		@@ -119,6 +166,13 @@ module Noosfero
119	present articles, :with => Entities::Article, :fields => params[:fields]	166	present articles, :with => Entities::Article, :fields => params[:fields]
120	end	167	end
121		168
		169	+ desc 'Return one child of a article identified by id' do
		170	+ detail 'Get a child of a specific article'
		171	+ params Noosfero::API::Entities::Article.documentation
		172	+ success Noosfero::API::Entities::Article
		173	+ failure [[403, 'Forbidden']]
		174	+ named 'ArticleChild'
		175	+ end
122	get ':id/children/:child_id' do	176	get ':id/children/:child_id' do
123	article = find_article(environment.articles, params[:id])	177	article = find_article(environment.articles, params[:id])
124	child = find_article(article.children, params[:child_id])	178	child = find_article(article.children, params[:child_id])
	@@ -126,6 +180,13 @@ module Noosfero		@@ -126,6 +180,13 @@ module Noosfero
126	present child, :with => Entities::Article, :fields => params[:fields]	180	present child, :with => Entities::Article, :fields => params[:fields]
127	end	181	end
128		182
		183	+ desc 'Suggest a article to another profile' do
		184	+ detail 'Suggest a article to another profile (person, community...)'
		185	+ params Noosfero::API::Entities::Article.documentation
		186	+ success Noosfero::API::Entities::Task
		187	+ failure [[401,'Unauthorized']]
		188	+ named 'ArticleSuggest'
		189	+ end
129	post ':id/children/suggest' do	190	post ':id/children/suggest' do
130	authenticate!	191	authenticate!
131	parent_article = environment.articles.find(params[:id])	192	parent_article = environment.articles.find(params[:id])
	@@ -144,6 +205,13 @@ module Noosfero		@@ -144,6 +205,13 @@ module Noosfero
144		205
145	# Example Request:	206	# Example Request:
146	# POST api/v1/articles/:id/children?private_token=234298743290432&article[name]=title&article[body]=body	207	# POST api/v1/articles/:id/children?private_token=234298743290432&article[name]=title&article[body]=body
		208	+ desc 'Add a child article to a parent identified by id' do
		209	+ detail 'Create a new article and associate to a parent'
		210	+ params Noosfero::API::Entities::Article.documentation
		211	+ success Noosfero::API::Entities::Article
		212	+ failure [[401,'Unauthorized']]
		213	+ named 'ArticleAddChild'
		214	+ end
147	post ':id/children' do	215	post ':id/children' do
148	authenticate!	216	authenticate!
149	parent_article = environment.articles.find(params[:id])	217	parent_article = environment.articles.find(params[:id])
	@@ -173,11 +241,37 @@ module Noosfero		@@ -173,11 +241,37 @@ module Noosfero
173	resource kind.pluralize.to_sym do	241	resource kind.pluralize.to_sym do
174	segment "/:#{kind}_id" do	242	segment "/:#{kind}_id" do
175	resource :articles do	243	resource :articles do
		244	+
		245	+ desc "Return all articles associate with a profile of type #{kind}" do
		246	+ detail 'Get a list of articles of a profile'
		247	+ params Noosfero::API::Entities::Article.documentation
		248	+ success Noosfero::API::Entities::Article
		249	+ failure [[403, 'Forbidden']]
		250	+ named 'ArticlesOfProfile'
		251	+ end
176	get do	252	get do
177	profile = environment.send(kind.pluralize).find(params["#{kind}_id"])	253	profile = environment.send(kind.pluralize).find(params["#{kind}_id"])
178	- present_articles(profile)	254	+
		255	+ if params[:path].present?
		256	+ article = profile.articles.find_by_path(params[:path])
		257	+ if !article \|\| !article.display_to?(current_person)
		258	+ article = forbidden!
		259	+ end
		260	+
		261	+ present article, :with => Entities::Article, :fields => params[:fields]
		262	+ else
		263	+
		264	+ present_articles(profile)
		265	+ end
179	end	266	end
180		267
		268	+ desc "Return a article associate with a profile of type #{kind}" do
		269	+ detail 'Get only one article of a profile'
		270	+ params Noosfero::API::Entities::Article.documentation
		271	+ success Noosfero::API::Entities::Article
		272	+ failure [[403, 'Forbidden']]
		273	+ named 'ArticleOfProfile'
		274	+ end
181	get ':id' do	275	get ':id' do
182	profile = environment.send(kind.pluralize).find(params["#{kind}_id"])	276	profile = environment.send(kind.pluralize).find(params["#{kind}_id"])
183	present_article(profile)	277	present_article(profile)
	@@ -185,6 +279,13 @@ module Noosfero		@@ -185,6 +279,13 @@ module Noosfero
185		279
186	# Example Request:	280	# Example Request:
187	# POST api/v1/{people,communities,enterprises}/:asset_id/articles?private_token=234298743290432&article[name]=title&article[body]=body	281	# POST api/v1/{people,communities,enterprises}/:asset_id/articles?private_token=234298743290432&article[name]=title&article[body]=body
		282	+ desc "Add a new article associated with a profile of type #{kind}" do
		283	+ detail 'Create a new article and associate with a profile'
		284	+ params Noosfero::API::Entities::Article.documentation
		285	+ success Noosfero::API::Entities::Article
		286	+ failure [[403, 'Forbidden']]
		287	+ named 'ArticleCreateToProfile'
		288	+ end
188	post do	289	post do
189	profile = environment.send(kind.pluralize).find(params["#{kind}_id"])	290	profile = environment.send(kind.pluralize).find(params["#{kind}_id"])
190	post_article(profile, params)	291	post_article(profile, params)
@@ -0,0 +1,43 @@		@@ -0,0 +1,43 @@
	1	+module Noosfero
	2	+ module API
	3	+ module V1
	4	+ class Search < Grape::API
	5	+
	6	+ resource :search do
	7	+ resource :article do
	8	+ paginate per_page: 20, max_per_page: 200
	9	+ get do
	10	+ # Security checks
	11	+ sanitize_params_hash(params)
	12	+ # APIHelpers
	13	+ asset = :articles
	14	+ context = environment
	15	+
	16	+ profile = environment.profiles.find(params[:profile_id]) if params[:profile_id]
	17	+
	18	+ scope = profile.nil? ? environment.articles.public : profile.articles.public
	19	+
	20	+ scope = scope.where(:type => params[:type]) if params[:type] && !(params[:type] == 'Article')
	21	+
	22	+ category = params[:category] \|\| ""
	23	+
	24	+ query = params[:query] \|\| ""
	25	+ order = "more_recent"
	26	+
	27	+ options = {:filter => order, :template_id => params[:template_id], :category => category}
	28	+
	29	+ search_result = find_by_contents(asset, context, scope, query, paginate_options, options)
	30	+
	31	+ articles = search_result[:results]
	32	+
	33	+ result = present_articles_paginated(articles)
	34	+
	35	+ result
	36	+ end
	37	+ end
	38	+ end
	39	+
	40	+ end
	41	+ end
	42	+ end
	43	+end
	@@ -31,6 +31,17 @@ class OauthClientPluginPublicControllerTest < ActionController::TestCase		@@ -31,6 +31,17 @@ class OauthClientPluginPublicControllerTest < ActionController::TestCase
31	assert_equal user.id, session[:user]	31	assert_equal user.id, session[:user]
32	end	32	end
33		33
		34	+ should 'generate private token when login' do
		35	+ user = create_user
		36	+ auth.info.stubs(:email).returns(user.email)
		37	+ auth.info.stubs(:name).returns(user.name)
		38	+ session[:provider_id] = provider.id
		39	+
		40	+ assert user.reload.private_token.nil?
		41	+ get :callback
		42	+ assert user.reload.private_token.present?
		43	+ end
		44	+
34	should 'do not login when the provider is disabled' do	45	should 'do not login when the provider is disabled' do
35	user = create_user	46	user = create_user
36	auth.info.stubs(:email).returns(user.email)	47	auth.info.stubs(:email).returns(user.email)
	@@ -232,6 +232,16 @@ class AccountControllerTest < ActionController::TestCase		@@ -232,6 +232,16 @@ class AccountControllerTest < ActionController::TestCase
232	assert_template 'password_recovery_sent'	232	assert_template 'password_recovery_sent'
233	end	233	end
234		234
		235	+ should 'not respond to forgotten password change if captcha verification fails' do
		236	+ create_user('test')
		237	+ @controller.stubs(:verify_recaptcha).returns(false)
		238	+ post :forgot_password, :value => 'test'
		239	+ change = assigns(:change_password)
		240	+ assert change.errors.has_key?(:base)
		241	+ assert_response :success
		242	+ assert_tag :tag => 'div', :attributes => { :id => 'errorExplanation', :class => 'errorExplanation' }
		243	+ end
		244	+
235	should 'respond to forgotten password change request with email' do	245	should 'respond to forgotten password change request with email' do
236	change = ChangePassword.new	246	change = ChangePassword.new
237	create_user('test', :email => 'test@localhost.localdomain')	247	create_user('test', :email => 'test@localhost.localdomain')