Merge branch 'update-docs' into 'master'

Update docs

See merge request portalmec/portalmec!465

config/routes.rb

@@ -123,7 +123,11 @@ Rails.application.routes.draw do
   end
 
   namespace :v1 do
-    resources :activities, only: [:index, :show]
+    resources :activities, only: [:index, :show] do
+        collection do
+            get 'me'
+        end
+    end
     resources :feed, only: [:index]
 
     resources :users, concerns: [:followable, :deletable, :publisher, :versionable] do
@@ -192,7 +196,6 @@ Rails.application.routes.draw do
     post '/package', to: 'packages#link'
     get '/subjects', to: 'subjects#index'
     get '/educational_stages', to: 'educational_stages#index'
-    get '/activities/me', to: 'activities#me'
     get 'learning_objects/magnetlink/:magnetlink', to: 'learning_objects#magnetlink', as: 'magnetlink_learning_objects'
   end
 end

spec/acceptance/activities_spec.rb

@@ -21,7 +21,7 @@ require 'acceptance_helpers'
 require 'shared/contexts'
 
 resource 'Activities' do
-  
+
   explanation "Users can see the activities of his followed collections and users."
 
   before { 12.times { create(:learning_object); create(:user) } }

spec/acceptance/users_spec.rb

@@ -49,7 +49,7 @@ resource 'Users' do
   get '/v1/users/:id' do
     let(:id) { users.first.id }
 
-    example 'Get a user' do
+    example 'Get an user' do
       do_request
       expect(path).to eq("/v1/users/#{id}") # `:id` is replaced with the value of `id`
       expect(response_body).to eq(Helper.serialize(User.find(id)))
@@ -136,6 +136,23 @@ resource 'Users' do
     end
   end
 
+  post '/v1/auth/sign_in' do
+    include_context "authenticate_user"
+
+    parameter :email, 'The email of user'
+    parameter :password, 'The password of user'
+
+    let(:email) { @user.email }
+    let(:password) { @user.password }
+
+    let(:raw_post) {params.to_json}
+
+    example 'Signing in' do
+      do_request
+      expect(status).to eq(200)
+    end
+  end
+
   get '/v1/users/:id/following/:type' do
     include_context "authenticate_user"
 
@@ -153,6 +170,22 @@ resource 'Users' do
     end
   end
 
+  get '/v1/users/:id/followers' do
+    include_context "authenticate_user"
+
+    before do
+      @user1 = create(:user)
+      @follow = create(:follow, user: @user1, followable: @user)
+    end
+
+    let(:id) { @user.id }
+
+    example 'Showing an user followers' do
+      do_request
+      expect(status).to eq(200)
+    end
+  end
+
   get '/v1/users/:id/reviews/received' do
     include_context "authenticate_user"
 
@@ -163,7 +196,7 @@ resource 'Users' do
 
     let(:id) { @user.id }
 
-    example 'Showing a user’s received reviews' do
+    example 'Showing an user’s received reviews' do
       do_request
       expect(status).to eq(200)
     end
@@ -193,7 +226,7 @@ resource 'Users' do
 
     let(:id) { @user.id }
 
-    example 'Showing a user’s liked collections' do
+    example 'Showing an user’s liked collections' do
       do_request
       expect(status).to eq(200)
     end
@@ -208,7 +241,7 @@ resource 'Users' do
 
     let(:id) { @user.id }
 
-    example 'Showing a user’s liked learning objects' do
+    example 'Showing an user’s liked learning objects' do
       do_request
       expect(status).to eq(200)
     end
@@ -223,7 +256,7 @@ resource 'Users' do
 
     let(:id) { @user.id }
 
-    example 'Showing a user’s learning objects' do
+    example 'Showing an user’s learning objects' do
       do_request
       expect(status).to eq(200)
     end
@@ -238,7 +271,7 @@ resource 'Users' do
 
     let(:id) { @user.id }
 
-    example 'Showing a user’s collections' do
+    example 'Showing an user’s collections' do
       do_request
       expect(status).to eq(200)
     end
@@ -253,7 +286,7 @@ resource 'Users' do
 
     let(:id) { @user.id }
 
-    example 'Showing a user’s drafts' do
+    example 'Showing an user’s drafts' do
       do_request
       expect(status).to eq(200)
     end