]> git.openstreetmap.org Git - rails.git/blobdiff - test/controllers/api/user_preferences_controller_test.rb
Simplify creation of bearer authorization headers
[rails.git] / test / controllers / api / user_preferences_controller_test.rb
index 3223eb5ddf29fa3b725195af64930d02ae481d81..816be9b6e104d5c67aba52b23912079890e00983 100644 (file)
@@ -1,7 +1,7 @@
 require "test_helper"
 
 module Api
 require "test_helper"
 
 module Api
-  class UserPreferencesControllerTest < ActionController::TestCase
+  class UserPreferencesControllerTest < ActionDispatch::IntegrationTest
     ##
     # test all routes which lead to this controller
     def test_routes
     ##
     # test all routes which lead to this controller
     def test_routes
@@ -9,6 +9,10 @@ module Api
         { :path => "/api/0.6/user/preferences", :method => :get },
         { :controller => "api/user_preferences", :action => "index" }
       )
         { :path => "/api/0.6/user/preferences", :method => :get },
         { :controller => "api/user_preferences", :action => "index" }
       )
+      assert_routing(
+        { :path => "/api/0.6/user/preferences.json", :method => :get },
+        { :controller => "api/user_preferences", :action => "index", :format => "json" }
+      )
       assert_routing(
         { :path => "/api/0.6/user/preferences", :method => :put },
         { :controller => "api/user_preferences", :action => "update_all" }
       assert_routing(
         { :path => "/api/0.6/user/preferences", :method => :put },
         { :controller => "api/user_preferences", :action => "update_all" }
@@ -31,14 +35,14 @@ module Api
     # test showing all preferences
     def test_index
       # first try without auth
     # test showing all preferences
     def test_index
       # first try without auth
-      get :index
+      get user_preferences_path
       assert_response :unauthorized, "should be authenticated"
 
       # authenticate as a user with no preferences
       assert_response :unauthorized, "should be authenticated"
 
       # authenticate as a user with no preferences
-      basic_authorization create(:user).email, "test"
+      auth_header = bearer_authorization_header
 
       # try the read again
 
       # try the read again
-      get :index
+      get user_preferences_path, :headers => auth_header
       assert_select "osm" do
         assert_select "preferences", :count => 1 do
           assert_select "preference", :count => 0
       assert_select "osm" do
         assert_select "preferences", :count => 1 do
           assert_select "preference", :count => 0
@@ -49,10 +53,10 @@ module Api
       user = create(:user)
       user_preference = create(:user_preference, :user => user)
       user_preference2 = create(:user_preference, :user => user)
       user = create(:user)
       user_preference = create(:user_preference, :user => user)
       user_preference2 = create(:user_preference, :user => user)
-      basic_authorization user.email, "test"
+      auth_header = bearer_authorization_header(user)
 
       # try the read again
 
       # try the read again
-      get :index
+      get user_preferences_path, :headers => auth_header
       assert_response :success
       assert_equal "application/xml", @response.media_type
       assert_select "osm" do
       assert_response :success
       assert_equal "application/xml", @response.media_type
       assert_select "osm" do
@@ -62,6 +66,16 @@ module Api
           assert_select "preference[k=\"#{user_preference2.k}\"][v=\"#{user_preference2.v}\"]", :count => 1
         end
       end
           assert_select "preference[k=\"#{user_preference2.k}\"][v=\"#{user_preference2.v}\"]", :count => 1
         end
       end
+
+      # Test json
+      get user_preferences_path(:format => "json"), :headers => auth_header
+      assert_response :success
+      assert_equal "application/json", @response.media_type
+
+      js = ActiveSupport::JSON.decode(@response.body)
+      assert_not_nil js
+      assert_equal 2, js["preferences"].count
+      assert_equal user_preference.v, js["preferences"][user_preference.k]
     end
 
     ##
     end
 
     ##
@@ -71,20 +85,20 @@ module Api
       create(:user_preference, :user => user, :k => "key", :v => "value")
 
       # try a read without auth
       create(:user_preference, :user => user, :k => "key", :v => "value")
 
       # try a read without auth
-      get :show, :params => { :preference_key => "key" }
+      get user_preference_path(:preference_key => "key")
       assert_response :unauthorized, "should be authenticated"
 
       # authenticate as a user with preferences
       assert_response :unauthorized, "should be authenticated"
 
       # authenticate as a user with preferences
-      basic_authorization user.email, "test"
+      auth_header = bearer_authorization_header(user)
 
       # try the read again
 
       # try the read again
-      get :show, :params => { :preference_key => "key" }
+      get user_preference_path(:preference_key => "key"), :headers => auth_header
       assert_response :success
       assert_equal "text/plain", @response.media_type
       assert_equal "value", @response.body
 
       # try the read again for a non-existent key
       assert_response :success
       assert_equal "text/plain", @response.media_type
       assert_equal "value", @response.body
 
       # try the read again for a non-existent key
-      get :show, :params => { :preference_key => "unknown_key" }
+      get user_preference_path(:preference_key => "unknown_key"), :headers => auth_header
       assert_response :not_found
     end
 
       assert_response :not_found
     end
 
@@ -97,7 +111,7 @@ module Api
 
       # try a put without auth
       assert_no_difference "UserPreference.count" do
 
       # try a put without auth
       assert_no_difference "UserPreference.count" do
-        put :update_all, :body => "<osm><preferences><preference k='key' v='new_value'/><preference k='new_key' v='value'/></preferences></osm>"
+        put user_preferences_path, :params => "<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
       end
       assert_response :unauthorized, "should be authenticated"
       assert_equal "value", UserPreference.find([user.id, "key"]).v
@@ -107,11 +121,11 @@ module Api
       end
 
       # authenticate as a user with preferences
       end
 
       # authenticate as a user with preferences
-      basic_authorization user.email, "test"
+      auth_header = bearer_authorization_header(user)
 
       # try the put again
       assert_no_difference "UserPreference.count" do
 
       # try the put again
       assert_no_difference "UserPreference.count" do
-        put :update_all, :body => "<osm><preferences><preference k='key' v='new_value'/><preference k='new_key' v='value'/></preferences></osm>"
+        put user_preferences_path, :params => "<osm><preferences><preference k='key' v='new_value'/><preference k='new_key' v='value'/></preferences></osm>", :headers => auth_header
       end
       assert_response :success
       assert_equal "text/plain", @response.media_type
       end
       assert_response :success
       assert_equal "text/plain", @response.media_type
@@ -124,7 +138,7 @@ module Api
 
       # try a put with duplicate keys
       assert_no_difference "UserPreference.count" do
 
       # try a put with duplicate keys
       assert_no_difference "UserPreference.count" do
-        put :update_all, :body => "<osm><preferences><preference k='key' v='value'/><preference k='key' v='newer_value'/></preferences></osm>"
+        put user_preferences_path, :params => "<osm><preferences><preference k='key' v='value'/><preference k='key' v='newer_value'/></preferences></osm>", :headers => auth_header
       end
       assert_response :bad_request
       assert_equal "text/plain", @response.media_type
       end
       assert_response :bad_request
       assert_equal "text/plain", @response.media_type
@@ -133,9 +147,22 @@ module Api
 
       # try a put with invalid content
       assert_no_difference "UserPreference.count" do
 
       # try a put with invalid content
       assert_no_difference "UserPreference.count" do
-        put :update_all, :body => "nonsense"
+        put user_preferences_path, :params => "nonsense", :headers => auth_header
       end
       assert_response :bad_request
       end
       assert_response :bad_request
+
+      # try a put with unicode characters
+      assert_no_difference "UserPreference.count" do
+        put user_preferences_path, :params => "<osm><preferences><preference k='kêy' v='néw_vâlué'/><preference k='nêw_kêy' v='vâlué'/></preferences></osm>", :headers => auth_header
+      end
+      assert_response :success
+      assert_equal "text/plain", @response.media_type
+      assert_equal "", @response.body
+      assert_equal "néw_vâlué", UserPreference.find([user.id, "kêy"]).v
+      assert_equal "vâlué", UserPreference.find([user.id, "nêw_kêy"]).v
+      assert_raises ActiveRecord::RecordNotFound do
+        UserPreference.find([user.id, "some_key"])
+      end
     end
 
     ##
     end
 
     ##
@@ -146,7 +173,7 @@ module Api
 
       # try a put without auth
       assert_no_difference "UserPreference.count" do
 
       # try a put without auth
       assert_no_difference "UserPreference.count" do
-        put :update, :params => { :preference_key => "new_key" }, :body => "new_value"
+        put user_preference_path(:preference_key => "new_key"), :params => "new_value"
       end
       assert_response :unauthorized, "should be authenticated"
       assert_raises ActiveRecord::RecordNotFound do
       end
       assert_response :unauthorized, "should be authenticated"
       assert_raises ActiveRecord::RecordNotFound do
@@ -154,11 +181,11 @@ module Api
       end
 
       # authenticate as a user with preferences
       end
 
       # authenticate as a user with preferences
-      basic_authorization user.email, "test"
+      auth_header = bearer_authorization_header(user)
 
       # try adding a new preference
       assert_difference "UserPreference.count", 1 do
 
       # try adding a new preference
       assert_difference "UserPreference.count", 1 do
-        put :update, :params => { :preference_key => "new_key" }, :body => "new_value"
+        put user_preference_path(:preference_key => "new_key"), :params => "new_value", :headers => auth_header
       end
       assert_response :success
       assert_equal "text/plain", @response.media_type
       end
       assert_response :success
       assert_equal "text/plain", @response.media_type
@@ -167,12 +194,21 @@ module Api
 
       # try changing the value of a preference
       assert_no_difference "UserPreference.count" do
 
       # try changing the value of a preference
       assert_no_difference "UserPreference.count" do
-        put :update, :params => { :preference_key => "new_key" }, :body => "newer_value"
+        put user_preference_path(:preference_key => "new_key"), :params => "newer_value", :headers => auth_header
       end
       assert_response :success
       assert_equal "text/plain", @response.media_type
       assert_equal "", @response.body
       assert_equal "newer_value", UserPreference.find([user.id, "new_key"]).v
       end
       assert_response :success
       assert_equal "text/plain", @response.media_type
       assert_equal "", @response.body
       assert_equal "newer_value", UserPreference.find([user.id, "new_key"]).v
+
+      # try changing the value of a preference to include unicode characters
+      assert_difference "UserPreference.count", 1 do
+        put user_preference_path(:preference_key => "nêw_kêy"), :params => "néwèr_vâlué", :headers => auth_header
+      end
+      assert_response :success
+      assert_equal "text/plain", @response.media_type
+      assert_equal "", @response.body
+      assert_equal "néwèr_vâlué", UserPreference.find([user.id, "nêw_kêy"]).v
     end
 
     ##
     end
 
     ##
@@ -183,17 +219,17 @@ module Api
 
       # try a delete without auth
       assert_no_difference "UserPreference.count" do
 
       # try a delete without auth
       assert_no_difference "UserPreference.count" do
-        delete :destroy, :params => { :preference_key => "key" }
+        delete user_preference_path(: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
       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"
+      auth_header = bearer_authorization_header(user)
 
       # try the delete again
       assert_difference "UserPreference.count", -1 do
 
       # try the delete again
       assert_difference "UserPreference.count", -1 do
-        get :destroy, :params => { :preference_key => "key" }
+        delete user_preference_path(:preference_key => "key"), :headers => auth_header
       end
       assert_response :success
       assert_equal "text/plain", @response.media_type
       end
       assert_response :success
       assert_equal "text/plain", @response.media_type
@@ -204,7 +240,7 @@ module Api
 
       # try the delete again for the same key
       assert_no_difference "UserPreference.count" do
 
       # try the delete again for the same key
       assert_no_difference "UserPreference.count" do
-        get :destroy, :params => { :preference_key => "key" }
+        delete user_preference_path(:preference_key => "key"), :headers => auth_header
       end
       assert_response :not_found
       assert_raises ActiveRecord::RecordNotFound do
       end
       assert_response :not_found
       assert_raises ActiveRecord::RecordNotFound do
@@ -216,15 +252,10 @@ module Api
     # read preferences
     def test_show_using_token
       user = create(:user)
     # read preferences
     def test_show_using_token
       user = create(:user)
-      token = create(:access_token, :user => user, :allow_read_prefs => true)
+      auth_header = bearer_authorization_header(user, :scopes => %w[read_prefs])
       create(:user_preference, :user => user, :k => "key", :v => "value")
 
       create(:user_preference, :user => user, :k => "key", :v => "value")
 
-      # Hack together an oauth request - an alternative would be to sign the request properly
-      @request.env["oauth.version"] = 1
-      @request.env["oauth.strategies"] = [:token]
-      @request.env["oauth.token"] = token
-
-      get :show, :params => { :preference_key => "key" }
+      get user_preference_path(:preference_key => "key"), :headers => auth_header
       assert_response :success
     end
 
       assert_response :success
     end
 
@@ -233,13 +264,10 @@ module Api
     # by other methods.
     def test_show_using_token_fail
       user = create(:user)
     # by other methods.
     def test_show_using_token_fail
       user = create(:user)
-      token = create(:access_token, :user => user, :allow_read_prefs => false)
+      auth_header = bearer_authorization_header(user, :scopes => %w[])
       create(:user_preference, :user => user, :k => "key", :v => "value")
       create(:user_preference, :user => user, :k => "key", :v => "value")
-      @request.env["oauth.version"] = 1
-      @request.env["oauth.strategies"] = [:token]
-      @request.env["oauth.token"] = token
 
 
-      get :show, :params => { :preference_key => "key" }
+      get user_preference_path(:preference_key => "key"), :headers => auth_header
       assert_response :forbidden
     end
   end
       assert_response :forbidden
     end
   end