openstreetmap-website/test/controllers/user_preferences_controller_test.rb

require "test_helper"

class UserPreferencesControllerTest < ActionController::TestCase
  ##
  # test all routes which lead to this controller
  def test_routes
    assert_routing(
      { :path => "/api/0.6/user/preferences", :method => :get },
      { :controller => "user_preferences", :action => "read" }
    )
    assert_routing(
      { :path => "/api/0.6/user/preferences", :method => :put },
      { :controller => "user_preferences", :action => "update" }
    )
    assert_routing(
      { :path => "/api/0.6/user/preferences/key", :method => :get },
      { :controller => "user_preferences", :action => "read_one", :preference_key => "key" }
    )
    assert_routing(
      { :path => "/api/0.6/user/preferences/key", :method => :put },
      { :controller => "user_preferences", :action => "update_one", :preference_key => "key" }
    )
    assert_routing(
      { :path => "/api/0.6/user/preferences/key", :method => :delete },
      { :controller => "user_preferences", :action => "delete_one", :preference_key => "key" }
    )
  end

  ##
  # test read action
  def test_read
    # first try without auth
    get :read
    assert_response :unauthorized, "should be authenticated"

    # authenticate as a user with no preferences
    basic_authorization create(:user).email, "test"

    # try the read again
    get :read
    assert_select "osm" do
      assert_select "preferences", :count => 1 do
        assert_select "preference", :count => 0
      end
    end

    # authenticate as a user with preferences
    user = create(:user)
    user_preference = create(:user_preference, :user => user)
    user_preference2 = create(:user_preference, :user => user)
    basic_authorization user.email, "test"

    # try the read again
    get :read
    assert_response :success
    assert_equal "application/xml", @response.content_type
    assert_select "osm" do
      assert_select "preferences", :count => 1 do
        assert_select "preference", :count => 2
        assert_select "preference[k=\"#{user_preference.k}\"][v=\"#{user_preference.v}\"]", :count => 1
        assert_select "preference[k=\"#{user_preference2.k}\"][v=\"#{user_preference2.v}\"]", :count => 1
      end
    end
  end

  ##
  # test read_one action
  def test_read_one
    user = create(:user)
    create(:user_preference, :user => user, :k => "key", :v => "value")

    # try a read without auth
    get :read_one, :params => { :preference_key => "key" }
    assert_response :unauthorized, "should be authenticated"

    # authenticate as a user with preferences
    basic_authorization user.email, "test"

    # try the read again
    get :read_one, :params => { :preference_key => "key" }
    assert_response :success
    assert_equal "text/plain", @response.content_type
    assert_equal "value", @response.body

    # try the read again for a non-existent key
    get :read_one, :params => { :preference_key => "unknown_key" }
    assert_response :not_found
  end

  ##
  # test update action
  def test_update
    user = create(:user)
    create(:user_preference, :user => user, :k => "key", :v => "value")
    create(:user_preference, :user => user, :k => "some_key", :v => "some_value")

    # try a put without auth
    assert_no_difference "UserPreference.count" do
      put :update, :body => "<osm><preferences><preference k='key' v='new_value'/><preference k='new_key' v='value'/></preferences></osm>"
    end
    assert_response :unauthorized, "should be authenticated"
    assert_equal "value", UserPreference.find([user.id, "key"]).v
    assert_equal "some_value", UserPreference.find([user.id, "some_key"]).v
    assert_raises ActiveRecord::RecordNotFound do
      UserPreference.find([user.id, "new_key"])
    end

    # authenticate as a user with preferences
    basic_authorization user.email, "test"

    # try the put again
    assert_no_difference "UserPreference.count" do
      put :update, :body => "<osm><preferences><preference k='key' v='new_value'/><preference k='new_key' v='value'/></preferences></osm>"
    end
    assert_response :success
    assert_equal "text/plain", @response.content_type
    assert_equal "", @response.body
    assert_equal "new_value", UserPreference.find([user.id, "key"]).v
    assert_equal "value", UserPreference.find([user.id, "new_key"]).v
    assert_raises ActiveRecord::RecordNotFound do
      UserPreference.find([user.id, "some_key"])
    end

    # try a put with duplicate keys
    assert_no_difference "UserPreference.count" do
      put :update, :body => "<osm><preferences><preference k='key' v='value'/><preference k='key' v='newer_value'/></preferences></osm>"
    end
    assert_response :bad_request
    assert_equal "text/plain", @response.content_type
    assert_equal "Duplicate preferences with key key", @response.body
    assert_equal "new_value", UserPreference.find([user.id, "key"]).v

    # try a put with invalid content
    assert_no_difference "UserPreference.count" do
      put :update, :body => "nonsense"
    end
    assert_response :bad_request
  end

  ##
  # test update_one action
  def test_update_one
    user = create(:user)
    create(:user_preference, :user => user)

    # try a put without auth
    assert_no_difference "UserPreference.count" do
      put :update_one, :params => { :preference_key => "new_key" }, :body => "new_value"
    end
    assert_response :unauthorized, "should be authenticated"
    assert_raises ActiveRecord::RecordNotFound do
      UserPreference.find([user.id, "new_key"])
    end

    # authenticate as a user with preferences
    basic_authorization user.email, "test"

    # try adding a new preference
    assert_difference "UserPreference.count", 1 do
      put :update_one, :params => { :preference_key => "new_key" }, :body => "new_value"
    end
    assert_response :success
    assert_equal "text/plain", @response.content_type
    assert_equal "", @response.body
    assert_equal "new_value", UserPreference.find([user.id, "new_key"]).v

    # try changing the value of a preference
    assert_no_difference "UserPreference.count" do
      put :update_one, :params => { :preference_key => "new_key" }, :body => "newer_value"
    end
    assert_response :success
    assert_equal "text/plain", @response.content_type
    assert_equal "", @response.body
    assert_equal "newer_value", UserPreference.find([user.id, "new_key"]).v
  end

  ##
  # test delete_one action
  def test_delete_one
    user = create(:user)
    create(:user_preference, :user => user, :k => "key", :v => "value")

    # try a delete without auth
    assert_no_difference "UserPreference.count" do
      delete :delete_one, :params => { :preference_key => "key" }
    end
    assert_response :unauthorized, "should be authenticated"
    assert_equal "value", UserPreference.find([user.id, "key"]).v

    # authenticate as a user with preferences
    basic_authorization user.email, "test"

    # try the delete again
    assert_difference "UserPreference.count", -1 do
      get :delete_one, :params => { :preference_key => "key" }
    end
    assert_response :success
    assert_equal "text/plain", @response.content_type
    assert_equal "", @response.body
    assert_raises ActiveRecord::RecordNotFound do
      UserPreference.find([user.id, "key"])
    end

    # try the delete again for the same key
    assert_no_difference "UserPreference.count" do
      get :delete_one, :params => { :preference_key => "key" }
    end
    assert_response :not_found
    assert_raises ActiveRecord::RecordNotFound do
      UserPreference.find([user.id, "key"])
    end
  end
end