Implement API endpoint to query permissions.
authorEnno Brehm <enno.brehm@gmail.com>
Thu, 26 Apr 2012 15:26:26 +0000 (17:26 +0200)
committerTom Hughes <tom@compton.nu>
Sat, 5 May 2012 14:28:45 +0000 (15:28 +0100)
app/controllers/api_controller.rb
app/views/api/permissions.builder [new file with mode: 0644]
config/routes.rb
test/functional/api_controller_test.rb

index 002bd73b881fef24dfe07acbd40581a161665ff9..602b79d69c5462e6f9a0cdae3d2e1c55b343c306 100644 (file)
@@ -2,6 +2,7 @@ class ApiController < ApplicationController
 
   skip_before_filter :verify_authenticity_token
   before_filter :check_api_readable, :except => [:capabilities]
+  before_filter :setup_user_auth, :only => [:permissions]
   after_filter :compress_output
   around_filter :api_call_handle_error, :api_call_timeout
 
@@ -289,4 +290,20 @@ class ApiController < ApplicationController
 
     render :text => doc.to_s, :content_type => "text/xml"
   end
+
+  # External apps that use the api are able to query which permissions
+  # they have. This currently returns a list of permissions granted to the current user:
+  # * if authenticated via OAuth, this list will contain all permissions granted by the user to the access_token.
+  # * if authenticated via basic auth all permissions are granted, so the list will contain all permissions.
+  # * unauthenticated users have no permissions, so the list will be empty.
+  def permissions
+    @permissions = case
+                   when current_token.present?
+                     ClientApplication.all_permissions.select { |p| current_token.read_attribute(p) }
+                   when @user
+                     ClientApplication.all_permissions
+                   else
+                     []
+                   end
+  end
 end
diff --git a/app/views/api/permissions.builder b/app/views/api/permissions.builder
new file mode 100644 (file)
index 0000000..066f567
--- /dev/null
@@ -0,0 +1,9 @@
+# create list of permissions
+xml.instruct! :xml, :version=>"1.0"
+xml.osm("version" => "#{API_VERSION}", "generator" => "OpenStreetMap Server") do
+  xml.permissions do
+    @permissions.each do |permission|
+      xml.permission :name => permission
+    end
+  end
+end
index bc4c12c972c44d04545c89954815897069d4da5b..c24ba05e310338f3c91f3ce6fd3a1a88392761dc 100644 (file)
@@ -2,6 +2,7 @@ OpenStreetMap::Application.routes.draw do
   # API
   match 'api/capabilities' => 'api#capabilities', :via => :get
   match 'api/0.6/capabilities' => 'api#capabilities', :via => :get
+  match 'api/0.6/permissions' => 'api#permissions', :via => :get
 
   match 'api/0.6/changeset/create' => 'changeset#create', :via => :put
   match 'api/0.6/changeset/:id/upload' => 'changeset#upload', :via => :post, :id => /\d+/
index adc433fe07b44c7663b44ab4cc4bde07ab7d930b..d3e1d5485af6e3e1ece8fa9d5a9f639e090f099a 100644 (file)
@@ -298,4 +298,41 @@ class ApiControllerTest < ActionController::TestCase
       end
     end
   end
+
+  def test_permissions_anonymous
+    get :permissions
+    assert_response :success
+    assert_select "osm > permissions", :count => 1 do
+      assert_select "permission", :count => 0
+    end
+  end
+
+  def test_permissions_basic_auth
+    basic_authorization(users(:normal_user).email, "test")
+    get :permissions
+    assert_response :success
+    assert_select "osm > permissions", :count => 1 do
+      assert_select "permission", :count => ClientApplication.all_permissions.size
+      ClientApplication.all_permissions.each do |p|
+        assert_select "permission[name=#{p}]", :count => 1
+      end
+    end
+  end
+
+  def test_permissions_oauth
+    @request.env["oauth.token"] =  AccessToken.new do |token|
+      # Just to test a few
+      token.allow_read_prefs = true
+      token.allow_write_api = true
+      token.allow_read_gpx = false
+    end
+    get :permissions
+    assert_response :success
+    assert_select "osm > permissions", :count => 1 do
+      assert_select "permission", :count => 2
+      assert_select "permission[name=allow_read_prefs]", :count => 1
+      assert_select "permission[name=allow_write_api]", :count => 1
+      assert_select "permission[name=allow_read_gpx]", :count => 0
+    end
+  end
 end