Declare api relation relations as nested resources

This commit is contained in:
Anton Khorev 2025-02-02 14:27:20 +03:00
parent 2a38dca0b7
commit f696b5439e
10 changed files with 108 additions and 45 deletions

View file

@ -15,8 +15,7 @@ class ApiAbility
can [:read, :download], Changeset
can :read, Tracepoint
can :read, User
can :read, [Node, Way]
can [:read, :relations_for_relation], Relation
can :read, [Node, Way, Relation]
can [:history, :read], [OldNode, OldWay, OldRelation]
can :read, UserBlock

View file

@ -0,0 +1,25 @@
module Api
module Relations
class RelationsController < ApiController
authorize_resource
before_action :set_request_formats
def index
relation_ids = RelationMember.where(:member_type => "Relation", :member_id => params[:relation_id]).collect(&:relation_id).uniq
@relations = []
Relation.find(relation_ids).each do |relation|
@relations << relation if relation.visible
end
# Render the result
respond_to do |format|
format.xml
format.json
end
end
end
end
end

View file

@ -123,10 +123,6 @@ module Api
end
end
def relations_for_relation
relations_for_object("Relation")
end
private
def relations_for_object(objtype)

View file

@ -0,0 +1,5 @@
json.partial! "api/root_attributes"
json.elements do
json.array! @relations, :partial => "api/relations/relation", :as => :relation
end

View file

@ -0,0 +1,5 @@
xml.instruct!
xml.osm(OSM::API.new.xml_root_attributes) do |osm|
osm << (render(:partial => "api/relations/relation", :collection => @relations) || "")
end

View file

@ -1,5 +0,0 @@
json.partial! "api/root_attributes"
json.elements do
json.array! @relations, :partial => "relation", :as => :relation
end

View file

@ -1,5 +0,0 @@
xml.instruct!
xml.osm(OSM::API.new.xml_root_attributes) do |osm|
osm << (render(@relations) || "")
end

View file

@ -38,7 +38,6 @@ OpenStreetMap::Application.routes.draw do
post "way/:id/:version/redact" => "old_ways#redact", :as => :way_version_redact, :version => /\d+/, :id => /\d+/
get "way/:id/:version" => "old_ways#show", :as => :api_old_way, :id => /\d+/, :version => /\d+/
get "relation/:id/relations" => "relations#relations_for_relation", :as => :relation_relations, :id => /\d+/
get "relation/:id/history" => "old_relations#history", :as => :api_relation_history, :id => /\d+/
post "relation/:id/:version/redact" => "old_relations#redact", :as => :relation_version_redact, :version => /\d+/, :id => /\d+/
get "relation/:id/:version" => "old_relations#show", :as => :api_old_relation, :id => /\d+/, :version => /\d+/
@ -70,6 +69,9 @@ OpenStreetMap::Application.routes.draw do
member do
get :full, :action => :show, :full => true, :as => nil
end
scope :module => :relations do
resources :relations, :only => :index
end
end
put "relation/create" => "relations#create", :as => nil

View file

@ -0,0 +1,69 @@
require "test_helper"
module Api
module Relations
class RelationsControllerTest < ActionDispatch::IntegrationTest
##
# test all routes which lead to this controller
def test_routes
assert_routing(
{ :path => "/api/0.6/relation/1/relations", :method => :get },
{ :controller => "api/relations/relations", :action => "index", :relation_id => "1" }
)
assert_routing(
{ :path => "/api/0.6/relation/1/relations.json", :method => :get },
{ :controller => "api/relations/relations", :action => "index", :relation_id => "1", :format => "json" }
)
end
def test_index
relation = create(:relation)
# should include relations with that relation as a member
relation_with_relation = create(:relation_member, :member => relation).relation
# should ignore any relation without that relation as a member
_relation_without_relation = create(:relation_member).relation
# should ignore relations with the relation involved indirectly, via a relation
second_relation = create(:relation_member, :member => relation).relation
_super_relation = create(:relation_member, :member => second_relation).relation
# should combine multiple relation_member references into just one relation entry
create(:relation_member, :member => relation, :relation => relation_with_relation)
# should not include deleted relations
deleted_relation = create(:relation, :deleted)
create(:relation_member, :member => relation, :relation => deleted_relation)
get api_relation_relations_path(relation)
assert_response :success
# count one osm element
assert_select "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
# we should have only the expected number of relations
expected_relations = [relation_with_relation, second_relation]
assert_select "osm>relation", expected_relations.size
# and each of them should contain the element we originally searched for
expected_relations.each do |containing_relation|
# The relation should appear once, but the element could appear multiple times
assert_select "osm>relation[id='#{containing_relation.id}']", 1
assert_select "osm>relation[id='#{containing_relation.id}']>member[type='relation'][ref='#{relation.id}']"
end
end
def test_index_json
relation = create(:relation)
containing_relation = create(:relation_member, :member => relation).relation
get api_relation_relations_path(relation, :format => "json")
assert_response :success
js = ActiveSupport::JSON.decode(@response.body)
assert_not_nil js
assert_equal 1, js["elements"].count
js_relations = js["elements"].filter { |e| e["type"] == "relation" }
assert_equal 1, js_relations.count
assert_equal containing_relation.id, js_relations[0]["id"]
end
end
end
end

View file

@ -42,15 +42,6 @@ module Api
{ :controller => "api/relations", :action => "destroy", :id => "1" }
)
assert_routing(
{ :path => "/api/0.6/relation/1/relations", :method => :get },
{ :controller => "api/relations", :action => "relations_for_relation", :id => "1" }
)
assert_routing(
{ :path => "/api/0.6/relation/1/relations.json", :method => :get },
{ :controller => "api/relations", :action => "relations_for_relation", :id => "1", :format => "json" }
)
assert_recognizes(
{ :controller => "api/relations", :action => "create" },
{ :path => "/api/0.6/relation/create", :method => :put }
@ -212,25 +203,6 @@ module Api
assert_equal node.id, js_nodes[0]["id"]
end
def test_relations_for_relation
relation = create(:relation)
# should include relations with that relation as a member
relation_with_relation = create(:relation_member, :member => relation).relation
# should ignore any relation without that relation as a member
_relation_without_relation = create(:relation_member).relation
# should ignore relations with the relation involved indirectly, via a relation
second_relation = create(:relation_member, :member => relation).relation
_super_relation = create(:relation_member, :member => second_relation).relation
# should combine multiple relation_member references into just one relation entry
create(:relation_member, :member => relation, :relation => relation_with_relation)
# should not include deleted relations
deleted_relation = create(:relation, :deleted)
create(:relation_member, :member => relation, :relation => deleted_relation)
check_relations_for_element(relation_relations_path(relation), "relation",
relation.id,
[relation_with_relation, second_relation])
end
# -------------------------------------
# Test simple relation creation.
# -------------------------------------