app/controllers/api/nodes_controller.rb

   1 # The NodeController is the RESTful interface to Node objects
   2
   3 module Api
   4   class NodesController < ApiController
   5     before_action :check_api_writable, :only => [:create, :update, :delete]
   6     before_action :check_api_readable, :except => [:create, :update, :delete]
   7     before_action :authorize, :only => [:create, :update, :delete]
   8
   9     authorize_resource
  10
  11     before_action :require_public_data, :only => [:create, :update, :delete]
  12     around_action :api_call_handle_error, :api_call_timeout
  13
  14     before_action :set_request_formats, :except => [:create, :update, :delete]
  15     before_action :check_rate_limit, :only => [:create, :update, :delete]
  16
  17     # Dump the details on many nodes whose ids are given in the "nodes" parameter.
  18     def index
  19       raise OSM::APIBadUserInput, "The parameter nodes is required, and must be of the form nodes=id[,id[,id...]]" unless params["nodes"]
  20
  21       ids = params["nodes"].split(",").collect(&:to_i)
  22
  23       raise OSM::APIBadUserInput, "No nodes were given to search for" if ids.empty?
  24
  25       @nodes = Node.find(ids)
  26
  27       # Render the result
  28       respond_to do |format|
  29         format.xml
  30         format.json
  31       end
  32     end
  33
  34     # Dump the details on a node given in params[:id]
  35     def show
  36       @node = Node.find(params[:id])
  37
  38       response.last_modified = @node.timestamp
  39
  40       if @node.visible
  41         # Render the result
  42         respond_to do |format|
  43           format.xml
  44           format.json
  45         end
  46       else
  47         head :gone
  48       end
  49     end
  50
  51     # Create a node from XML.
  52     def create
  53       node = Node.from_xml(request.raw_post, :create => true)
  54
  55       # Assume that Node.from_xml has thrown an exception if there is an error parsing the xml
  56       node.create_with_history current_user
  57       render :plain => node.id.to_s
  58     end
  59
  60     # Update a node from given XML
  61     def update
  62       node = Node.find(params[:id])
  63       new_node = Node.from_xml(request.raw_post)
  64
  65       raise OSM::APIBadUserInput, "The id in the url (#{node.id}) is not the same as provided in the xml (#{new_node.id})" unless new_node && new_node.id == node.id
  66
  67       node.update_from(new_node, current_user)
  68       render :plain => node.version.to_s
  69     end
  70
  71     # Delete a node. Doesn't actually delete it, but retains its history
  72     # in a wiki-like way. We therefore treat it like an update, so the delete
  73     # method returns the new version number.
  74     def delete
  75       node = Node.find(params[:id])
  76       new_node = Node.from_xml(request.raw_post)
  77
  78       raise OSM::APIBadUserInput, "The id in the url (#{node.id}) is not the same as provided in the xml (#{new_node.id})" unless new_node && new_node.id == node.id
  79
  80       node.delete_with_history!(new_node, current_user)
  81       render :plain => node.version.to_s
  82     end
  83   end
  84 end