Chris@1295: # Redmine - project management software
Chris@1295: # Copyright (C) 2006-2013  Jean-Philippe Lang
Chris@1295: #
Chris@1295: # This program is free software; you can redistribute it and/or
Chris@1295: # modify it under the terms of the GNU General Public License
Chris@1295: # as published by the Free Software Foundation; either version 2
Chris@1295: # of the License, or (at your option) any later version.
Chris@1295: #
Chris@1295: # This program is distributed in the hope that it will be useful,
Chris@1295: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1295: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1295: # GNU General Public License for more details.
Chris@1295: #
Chris@1295: # You should have received a copy of the GNU General Public License
Chris@1295: # along with this program; if not, write to the Free Software
Chris@1295: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1295: 
Chris@1295: require File.expand_path('../../../test_helper', __FILE__)
Chris@1295: 
Chris@1295: class Redmine::ApiTest::UsersTest < Redmine::ApiTest::Base
Chris@1295:   fixtures :users, :members, :member_roles, :roles, :projects
Chris@1295: 
Chris@1295:   def setup
Chris@1295:     Setting.rest_api_enabled = '1'
Chris@1295:   end
Chris@1295: 
Chris@1295:   context "GET /users" do
Chris@1295:     should_allow_api_authentication(:get, "/users.xml")
Chris@1295:     should_allow_api_authentication(:get, "/users.json")
Chris@1295:   end
Chris@1295: 
Chris@1295:   context "GET /users/2" do
Chris@1295:     context ".xml" do
Chris@1295:       should "return requested user" do
Chris@1295:         get '/users/2.xml'
Chris@1295: 
Chris@1295:         assert_response :success
Chris@1295:         assert_tag :tag => 'user',
Chris@1295:           :child => {:tag => 'id', :content => '2'}
Chris@1295:       end
Chris@1295: 
Chris@1295:       context "with include=memberships" do
Chris@1295:         should "include memberships" do
Chris@1295:           get '/users/2.xml?include=memberships'
Chris@1295:   
Chris@1295:           assert_response :success
Chris@1295:           assert_tag :tag => 'memberships',
Chris@1295:             :parent => {:tag => 'user'},
Chris@1295:             :children => {:count => 1}
Chris@1295:         end
Chris@1295:       end
Chris@1295:     end
Chris@1295: 
Chris@1295:     context ".json" do
Chris@1295:       should "return requested user" do
Chris@1295:         get '/users/2.json'
Chris@1295: 
Chris@1295:         assert_response :success
Chris@1295:         json = ActiveSupport::JSON.decode(response.body)
Chris@1295:         assert_kind_of Hash, json
Chris@1295:         assert_kind_of Hash, json['user']
Chris@1295:         assert_equal 2, json['user']['id']
Chris@1295:       end
Chris@1295: 
Chris@1295:       context "with include=memberships" do
Chris@1295:         should "include memberships" do
Chris@1295:           get '/users/2.json?include=memberships'
Chris@1295:   
Chris@1295:           assert_response :success
Chris@1295:           json = ActiveSupport::JSON.decode(response.body)
Chris@1295:           assert_kind_of Array, json['user']['memberships']
Chris@1295:           assert_equal [{
Chris@1295:             "id"=>1,
Chris@1295:             "project"=>{"name"=>"eCookbook", "id"=>1},
Chris@1295:             "roles"=>[{"name"=>"Manager", "id"=>1}]
Chris@1295:           }], json['user']['memberships']
Chris@1295:         end
Chris@1295:       end
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   context "GET /users/current" do
Chris@1295:     context ".xml" do
Chris@1295:       should "require authentication" do
Chris@1295:         get '/users/current.xml'
Chris@1295: 
Chris@1295:         assert_response 401
Chris@1295:       end
Chris@1295: 
Chris@1295:       should "return current user" do
Chris@1295:         get '/users/current.xml', {}, credentials('jsmith')
Chris@1295: 
Chris@1295:         assert_tag :tag => 'user',
Chris@1295:           :child => {:tag => 'id', :content => '2'}
Chris@1295:       end
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   test "GET /users/:id should not return login for other user" do
Chris@1295:     get '/users/3.xml', {}, credentials('jsmith')
Chris@1295:     assert_response :success
Chris@1295:     assert_no_tag 'user', :child => {:tag => 'login'}
Chris@1295:   end
Chris@1295: 
Chris@1295:   test "GET /users/:id should return login for current user" do
Chris@1295:     get '/users/2.xml', {}, credentials('jsmith')
Chris@1295:     assert_response :success
Chris@1295:     assert_tag 'user', :child => {:tag => 'login', :content => 'jsmith'}
Chris@1295:   end
Chris@1295: 
Chris@1295:   test "GET /users/:id should not return api_key for other user" do
Chris@1295:     get '/users/3.xml', {}, credentials('jsmith')
Chris@1295:     assert_response :success
Chris@1295:     assert_no_tag 'user', :child => {:tag => 'api_key'}
Chris@1295:   end
Chris@1295: 
Chris@1295:   test "GET /users/:id should return api_key for current user" do
Chris@1295:     get '/users/2.xml', {}, credentials('jsmith')
Chris@1295:     assert_response :success
Chris@1295:     assert_tag 'user', :child => {:tag => 'api_key', :content => User.find(2).api_key}
Chris@1295:   end
Chris@1295: 
Chris@1295:   context "POST /users" do
Chris@1295:     context "with valid parameters" do
Chris@1295:       setup do
Chris@1295:         @parameters = {
Chris@1295:           :user => {
Chris@1295:              :login => 'foo', :firstname => 'Firstname', :lastname => 'Lastname',
Chris@1295:              :mail => 'foo@example.net', :password => 'secret123',
Chris@1295:              :mail_notification => 'only_assigned'
Chris@1295:           }
Chris@1295:         }
Chris@1295:       end
Chris@1295: 
Chris@1295:       context ".xml" do
Chris@1295:         should_allow_api_authentication(:post,
Chris@1295:           '/users.xml',
Chris@1295:            {:user => {
Chris@1295:               :login => 'foo', :firstname => 'Firstname', :lastname => 'Lastname',
Chris@1295:               :mail => 'foo@example.net', :password => 'secret123'
Chris@1295:             }},
Chris@1295:           {:success_code => :created})
Chris@1295: 
Chris@1295:         should "create a user with the attributes" do
Chris@1295:           assert_difference('User.count') do
Chris@1295:             post '/users.xml', @parameters, credentials('admin')
Chris@1295:           end
Chris@1295: 
Chris@1295:           user = User.first(:order => 'id DESC')
Chris@1295:           assert_equal 'foo', user.login
Chris@1295:           assert_equal 'Firstname', user.firstname
Chris@1295:           assert_equal 'Lastname', user.lastname
Chris@1295:           assert_equal 'foo@example.net', user.mail
Chris@1295:           assert_equal 'only_assigned', user.mail_notification
Chris@1295:           assert !user.admin?
Chris@1295:           assert user.check_password?('secret123')
Chris@1295: 
Chris@1295:           assert_response :created
Chris@1295:           assert_equal 'application/xml', @response.content_type
Chris@1295:           assert_tag 'user', :child => {:tag => 'id', :content => user.id.to_s}
Chris@1295:         end
Chris@1295:       end
Chris@1295: 
Chris@1295:       context ".json" do
Chris@1295:         should_allow_api_authentication(:post,
Chris@1295:           '/users.json',
Chris@1295:           {:user => {
Chris@1295:              :login => 'foo', :firstname => 'Firstname', :lastname => 'Lastname',
Chris@1295:              :mail => 'foo@example.net'
Chris@1295:           }},
Chris@1295:           {:success_code => :created})
Chris@1295: 
Chris@1295:         should "create a user with the attributes" do
Chris@1295:           assert_difference('User.count') do
Chris@1295:             post '/users.json', @parameters, credentials('admin')
Chris@1295:           end
Chris@1295: 
Chris@1295:           user = User.first(:order => 'id DESC')
Chris@1295:           assert_equal 'foo', user.login
Chris@1295:           assert_equal 'Firstname', user.firstname
Chris@1295:           assert_equal 'Lastname', user.lastname
Chris@1295:           assert_equal 'foo@example.net', user.mail
Chris@1295:           assert !user.admin?
Chris@1295: 
Chris@1295:           assert_response :created
Chris@1295:           assert_equal 'application/json', @response.content_type
Chris@1295:           json = ActiveSupport::JSON.decode(response.body)
Chris@1295:           assert_kind_of Hash, json
Chris@1295:           assert_kind_of Hash, json['user']
Chris@1295:           assert_equal user.id, json['user']['id']
Chris@1295:         end
Chris@1295:       end
Chris@1295:     end
Chris@1295: 
Chris@1295:     context "with invalid parameters" do
Chris@1295:       setup do
Chris@1295:         @parameters = {:user => {:login => 'foo', :lastname => 'Lastname', :mail => 'foo'}}
Chris@1295:       end
Chris@1295: 
Chris@1295:       context ".xml" do
Chris@1295:         should "return errors" do
Chris@1295:           assert_no_difference('User.count') do
Chris@1295:             post '/users.xml', @parameters, credentials('admin')
Chris@1295:           end
Chris@1295: 
Chris@1295:           assert_response :unprocessable_entity
Chris@1295:           assert_equal 'application/xml', @response.content_type
Chris@1295:           assert_tag 'errors', :child => {
Chris@1295:                                  :tag => 'error',
Chris@1295:                                  :content => "First name can't be blank"
Chris@1295:                                }
Chris@1295:         end
Chris@1295:       end
Chris@1295: 
Chris@1295:       context ".json" do
Chris@1295:         should "return errors" do
Chris@1295:           assert_no_difference('User.count') do
Chris@1295:             post '/users.json', @parameters, credentials('admin')
Chris@1295:           end
Chris@1295: 
Chris@1295:           assert_response :unprocessable_entity
Chris@1295:           assert_equal 'application/json', @response.content_type
Chris@1295:           json = ActiveSupport::JSON.decode(response.body)
Chris@1295:           assert_kind_of Hash, json
Chris@1295:           assert json.has_key?('errors')
Chris@1295:           assert_kind_of Array, json['errors']
Chris@1295:         end
Chris@1295:       end
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   context "PUT /users/2" do
Chris@1295:     context "with valid parameters" do
Chris@1295:       setup do
Chris@1295:         @parameters = {
Chris@1295:           :user => {
Chris@1295:             :login => 'jsmith', :firstname => 'John', :lastname => 'Renamed',
Chris@1295:             :mail => 'jsmith@somenet.foo'
Chris@1295:           }
Chris@1295:         }
Chris@1295:       end
Chris@1295: 
Chris@1295:       context ".xml" do
Chris@1295:         should_allow_api_authentication(:put,
Chris@1295:           '/users/2.xml',
Chris@1295:           {:user => {
Chris@1295:               :login => 'jsmith', :firstname => 'John', :lastname => 'Renamed',
Chris@1295:               :mail => 'jsmith@somenet.foo'
Chris@1295:           }},
Chris@1295:           {:success_code => :ok})
Chris@1295: 
Chris@1295:         should "update user with the attributes" do
Chris@1295:           assert_no_difference('User.count') do
Chris@1295:             put '/users/2.xml', @parameters, credentials('admin')
Chris@1295:           end
Chris@1295: 
Chris@1295:           user = User.find(2)
Chris@1295:           assert_equal 'jsmith', user.login
Chris@1295:           assert_equal 'John', user.firstname
Chris@1295:           assert_equal 'Renamed', user.lastname
Chris@1295:           assert_equal 'jsmith@somenet.foo', user.mail
Chris@1295:           assert !user.admin?
Chris@1295: 
Chris@1295:           assert_response :ok
Chris@1295:           assert_equal '', @response.body
Chris@1295:         end
Chris@1295:       end
Chris@1295: 
Chris@1295:       context ".json" do
Chris@1295:         should_allow_api_authentication(:put,
Chris@1295:           '/users/2.json',
Chris@1295:           {:user => {
Chris@1295:               :login => 'jsmith', :firstname => 'John', :lastname => 'Renamed',
Chris@1295:               :mail => 'jsmith@somenet.foo'
Chris@1295:           }},
Chris@1295:           {:success_code => :ok})
Chris@1295: 
Chris@1295:         should "update user with the attributes" do
Chris@1295:           assert_no_difference('User.count') do
Chris@1295:             put '/users/2.json', @parameters, credentials('admin')
Chris@1295:           end
Chris@1295: 
Chris@1295:           user = User.find(2)
Chris@1295:           assert_equal 'jsmith', user.login
Chris@1295:           assert_equal 'John', user.firstname
Chris@1295:           assert_equal 'Renamed', user.lastname
Chris@1295:           assert_equal 'jsmith@somenet.foo', user.mail
Chris@1295:           assert !user.admin?
Chris@1295: 
Chris@1295:           assert_response :ok
Chris@1295:           assert_equal '', @response.body
Chris@1295:         end
Chris@1295:       end
Chris@1295:     end
Chris@1295: 
Chris@1295:     context "with invalid parameters" do
Chris@1295:       setup do
Chris@1295:         @parameters = {
Chris@1295:           :user => {
Chris@1295:             :login => 'jsmith', :firstname => '', :lastname => 'Lastname',
Chris@1295:             :mail => 'foo'
Chris@1295:           }
Chris@1295:         }
Chris@1295:       end
Chris@1295: 
Chris@1295:       context ".xml" do
Chris@1295:         should "return errors" do
Chris@1295:           assert_no_difference('User.count') do
Chris@1295:             put '/users/2.xml', @parameters, credentials('admin')
Chris@1295:           end
Chris@1295: 
Chris@1295:           assert_response :unprocessable_entity
Chris@1295:           assert_equal 'application/xml', @response.content_type
Chris@1295:           assert_tag 'errors', :child => {
Chris@1295:                                  :tag => 'error',
Chris@1295:                                  :content => "First name can't be blank"
Chris@1295:                                 }
Chris@1295:         end
Chris@1295:       end
Chris@1295: 
Chris@1295:       context ".json" do
Chris@1295:         should "return errors" do
Chris@1295:           assert_no_difference('User.count') do
Chris@1295:             put '/users/2.json', @parameters, credentials('admin')
Chris@1295:           end
Chris@1295: 
Chris@1295:           assert_response :unprocessable_entity
Chris@1295:           assert_equal 'application/json', @response.content_type
Chris@1295:           json = ActiveSupport::JSON.decode(response.body)
Chris@1295:           assert_kind_of Hash, json
Chris@1295:           assert json.has_key?('errors')
Chris@1295:           assert_kind_of Array, json['errors']
Chris@1295:         end
Chris@1295:       end
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   context "DELETE /users/2" do
Chris@1295:     context ".xml" do
Chris@1295:       should_allow_api_authentication(:delete,
Chris@1295:         '/users/2.xml',
Chris@1295:         {},
Chris@1295:         {:success_code => :ok})
Chris@1295: 
Chris@1295:       should "delete user" do
Chris@1295:         assert_difference('User.count', -1) do
Chris@1295:           delete '/users/2.xml', {}, credentials('admin')
Chris@1295:         end
Chris@1295: 
Chris@1295:         assert_response :ok
Chris@1295:         assert_equal '', @response.body
Chris@1295:       end
Chris@1295:     end
Chris@1295: 
Chris@1295:     context ".json" do
Chris@1295:       should_allow_api_authentication(:delete,
Chris@1295:         '/users/2.xml',
Chris@1295:         {},
Chris@1295:         {:success_code => :ok})
Chris@1295: 
Chris@1295:       should "delete user" do
Chris@1295:         assert_difference('User.count', -1) do
Chris@1295:           delete '/users/2.json', {}, credentials('admin')
Chris@1295:         end
Chris@1295: 
Chris@1295:         assert_response :ok
Chris@1295:         assert_equal '', @response.body
Chris@1295:       end
Chris@1295:     end
Chris@1295:   end
Chris@1295: end