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