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