Merge pull request #2485 from mmd-osm/patch/json2

JSON output nodes, ways, relations, map

app/controllers/api/map_controller.rb

@@ -5,6 +5,8 @@ module Api
     before_action :check_api_readable
     around_action :api_call_handle_error, :api_call_timeout
 
+    before_action :set_default_request_format
+
     # This is probably the most common call of all. It is used for getting the
     # OSM data for a specified bounding box, usually for editing. First the
     # bounding box (bbox) is checked to make sure that it is sane. All nodes
@@ -90,7 +92,10 @@ module Api
 
       response.headers["Content-Disposition"] = "attachment; filename=\"map.osm\""
       # Render the result
-      render :formats => [:xml]
+      respond_to do |format|
+        format.xml
+        format.json
+      end
     end
   end
 end

app/controllers/api/nodes_controller.rb

@@ -13,6 +13,8 @@ module Api
     before_action :check_api_readable, :except => [:create, :update, :delete]
     around_action :api_call_handle_error, :api_call_timeout
 
+    before_action :set_default_request_format, :except => [:create, :update, :delete]
+
     # Create a node from XML.
     def create
       assert_method :put
@@ -32,7 +34,10 @@ module Api
 
       if @node.visible
         # Render the result
-        render :formats => [:xml]
+        respond_to do |format|
+          format.xml
+          format.json
+        end
       else
         head :gone
       end
@@ -73,7 +78,10 @@ module Api
       @nodes = Node.find(ids)
 
       # Render the result
-      render :formats => [:xml]
+      respond_to do |format|
+        format.xml
+        format.json
+      end
     end
   end
 end

app/controllers/api/old_controller.rb

@@ -16,6 +16,8 @@ module Api
     before_action :lookup_old_element, :except => [:history]
     before_action :lookup_old_element_versions, :only => [:history]
 
+    before_action :set_default_request_format, :except => [:redact]
+
     def history
       # the .where() method used in the lookup_old_element_versions
       # call won't throw an error if no records are found, so we have
@@ -30,7 +32,10 @@ module Api
                end
 
       # Render the result
-      render :formats => [:xml]
+      respond_to do |format|
+        format.xml
+        format.json
+      end
     end
 
     def version
@@ -41,7 +46,10 @@ module Api
         response.last_modified = @old_element.timestamp
 
         # Render the result
-        render :formats => [:xml]
+        respond_to do |format|
+          format.xml
+          format.json
+        end
       end
     end
 

app/controllers/api/relations_controller.rb

@@ -11,6 +11,8 @@ module Api
     before_action :check_api_readable, :except => [:create, :update, :delete]
     around_action :api_call_handle_error, :api_call_timeout
 
+    before_action :set_default_request_format, :except => [:create, :update, :delete]
+
     def create
       assert_method :put
 
@@ -26,7 +28,10 @@ module Api
       response.last_modified = @relation.timestamp
       if @relation.visible
         # Render the result
-        render :formats => [:xml]
+        respond_to do |format|
+          format.xml
+          format.json
+        end
       else
         head :gone
       end
@@ -117,7 +122,10 @@ module Api
         @relations << relation
 
         # Render the result
-        render :formats => [:xml]
+        respond_to do |format|
+          format.xml
+          format.json
+        end
       else
         head :gone
       end
@@ -133,7 +141,10 @@ module Api
       @relations = Relation.find(ids)
 
       # Render the result
-      render :formats => [:xml]
+      respond_to do |format|
+        format.xml
+        format.json
+      end
     end
 
     def relations_for_way
@@ -160,7 +171,10 @@ module Api
       end
 
       # Render the result
-      render :formats => [:xml]
+      respond_to do |format|
+        format.xml
+        format.json
+      end
     end
   end
 end

app/controllers/api/ways_controller.rb

@@ -11,6 +11,8 @@ module Api
     before_action :check_api_readable, :except => [:create, :update, :delete]
     around_action :api_call_handle_error, :api_call_timeout
 
+    before_action :set_default_request_format, :except => [:create, :update, :delete]
+
     def create
       assert_method :put
 
@@ -28,7 +30,10 @@ module Api
 
       if @way.visible
         # Render the result
-        render :formats => [:xml]
+        respond_to do |format|
+          format.xml
+          format.json
+        end
       else
         head :gone
       end
@@ -75,7 +80,10 @@ module Api
         end
 
         # Render the result
-        render :formats => [:xml]
+        respond_to do |format|
+          format.xml
+          format.json
+        end
       else
         head :gone
       end
@@ -93,7 +101,10 @@ module Api
       @ways = Way.find(ids)
 
       # Render the result
-      render :formats => [:xml]
+      respond_to do |format|
+        format.xml
+        format.json
+      end
     end
 
     ##
@@ -106,7 +117,10 @@ module Api
       @ways = Way.where(:id => wayids, :visible => true)
 
       # Render the result
-      render :formats => [:xml]
+      respond_to do |format|
+        format.xml
+        format.json
+      end
     end
   end
 end

app/controllers/api_controller.rb

@@ -3,6 +3,56 @@ class ApiController < ApplicationController
 
   private
 
+  ##
+  # Set default request format to xml unless a client requests a specific format,
+  # which can be done via (a) URL suffix and/or (b) HTTP Accept header, where
+  # the URL suffix always takes precedence over the Accept header.
+  def set_default_request_format
+    unless params[:format]
+      accept_header = request.headers["HTTP_ACCEPT"]
+      if accept_header.nil?
+        # e.g. unit tests don't set an Accept: header by default, force XML in this case
+        request.format = "xml"
+        return
+      end
+
+      req_mimetypes = []
+
+      # Some clients (JOSM) send Accept headers which cannot be parsed by Rails, example: *; q=.2
+      # To be fair, JOSM's Accept header doesn't adhere to RFC 7231, section 5.3.1, et al. either
+      # As a workaround for backwards compatibility, we're assuming XML format
+      begin
+        req_mimetypes = Mime::Type.parse(accept_header)
+      rescue Mime::Type::InvalidMimeType
+        request.format = "xml"
+        return
+      end
+
+      # req_mimetypes contains all Accept header MIME types with descending priority
+      req_mimetypes.each do |mime|
+        if mime.symbol == :xml
+          request.format = "xml"
+          break
+        end
+
+        if mime.symbol == :json
+          request.format = "json"
+          break
+        end
+
+        # Any format, not explicitly requesting XML or JSON -> assume XML as default
+        if mime == "*/*"
+          request.format = "xml"
+          break
+        end
+
+        # In case the client requests some other format besides XML, JSON and */*,
+        # we deliberately don't set request.format. The framework will return an
+        # ActionController::UnknownFormat error to the client later on in this case.
+      end
+    end
+  end
+
   def authorize(realm = "Web Password", errormessage = "Couldn't authenticate you")
     # make the current_user object from any auth sources we have
     setup_user_auth

app/controllers/application_controller.rb

@@ -185,6 +185,8 @@ class ApplicationController < ActionController::Base
 
   def api_call_handle_error
     yield
+  rescue ActionController::UnknownFormat
+    head :not_acceptable
   rescue ActiveRecord::RecordNotFound => e
     head :not_found
   rescue LibXML::XML::Error, ArgumentError => e

app/models/concerns/geo_record.rb

@@ -12,6 +12,10 @@ module GeoRecord
     def to_s
       format("%.7f", self)
     end
+
+    def as_json(_)
+      format("%.7f", self).to_f
+    end
   end
 
   # This scaling factor is used to convert between the float lat/lon that is

app/views/api/_root_attributes.json.jbuilder

@@ -0,0 +1,5 @@
+json.version Settings.api_version
+json.generator Settings.generator
+json.copyright Settings.copyright_owner
+json.attribution Settings.attribution_url
+json.license Settings.license_url

app/views/api/map/_bounds.json.jbuilder

@@ -0,0 +1,6 @@
+json.bounds do
+  json.minlat GeoRecord::Coord.new(@bounds.min_lat)
+  json.minlon GeoRecord::Coord.new(@bounds.min_lon)
+  json.maxlat GeoRecord::Coord.new(@bounds.max_lat)
+  json.maxlon GeoRecord::Coord.new(@bounds.max_lon)
+end

app/views/api/map/index.json.jbuilder

@@ -0,0 +1,9 @@
+json.partial! "root_attributes"
+
+json.partial! "bounds"
+
+all = @nodes + @ways + @relations
+
+json.elements(all) do |obj|
+  json.partial! obj
+end

app/views/api/nodes/_node.json.jbuilder

@@ -0,0 +1,15 @@
+json.type "node"
+json.id node.id
+if node.visible
+  json.lat GeoRecord::Coord.new(node.lat)
+  json.lon GeoRecord::Coord.new(node.lon)
+end
+json.timestamp node.timestamp.xmlschema
+json.version node.version
+json.changeset node.changeset_id
+json.user node.changeset.user.display_name
+json.uid node.changeset.user_id
+
+json.visible node.visible unless node.visible
+
+json.tags node.tags unless node.tags.empty?

app/views/api/nodes/index.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements(@nodes) do |node|
+  json.partial! node
+end

app/views/api/nodes/show.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements([@node]) do |node|
+  json.partial! node
+end

app/views/api/old_nodes/_old_node.json.jbuilder

@@ -0,0 +1,15 @@
+json.type "node"
+json.id old_node.node_id
+if old_node.visible
+  json.lat GeoRecord::Coord.new(old_node.lat)
+  json.lon GeoRecord::Coord.new(old_node.lon)
+end
+json.timestamp old_node.timestamp.xmlschema
+json.version old_node.version
+json.changeset old_node.changeset_id
+json.user old_node.changeset.user.display_name
+json.uid old_node.changeset.user_id
+
+json.visible old_node.visible unless old_node.visible
+
+json.tags old_node.tags unless old_node.tags.empty?

app/views/api/old_nodes/history.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements(@elems) do |old_node|
+  json.partial! old_node
+end

app/views/api/old_nodes/version.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements([@old_element]) do |old_node|
+  json.partial! old_node
+end

app/views/api/old_relations/_old_relation.json.jbuilder

@@ -0,0 +1,19 @@
+json.type "relation"
+json.id old_relation.relation_id
+json.timestamp old_relation.timestamp.xmlschema
+json.version old_relation.version
+json.changeset old_relation.changeset_id
+json.user old_relation.changeset.user.display_name
+json.uid old_relation.changeset.user_id
+
+json.visible old_relation.visible unless old_relation.visible
+
+unless old_relation.relation_members.empty?
+  json.members(old_relation.relation_members) do |m|
+    json.type m.member_type.downcase
+    json.ref m.member_id
+    json.role m.member_role
+  end
+end
+
+json.tags old_relation.tags unless old_relation.tags.empty?

app/views/api/old_relations/history.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements(@elems) do |old_relation|
+  json.partial! old_relation
+end

app/views/api/old_relations/version.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements([@old_element]) do |old_relation|
+  json.partial! old_relation
+end

app/views/api/old_ways/_old_way.json.jbuilder

@@ -0,0 +1,13 @@
+json.type "way"
+json.id old_way.way_id
+json.timestamp old_way.timestamp.xmlschema
+json.version old_way.version
+json.changeset old_way.changeset_id
+json.user old_way.changeset.user.display_name
+json.uid old_way.changeset.user_id
+
+json.visible old_way.visible unless old_way.visible
+
+json.nodes old_way.nds unless old_way.nds.empty?
+
+json.tags old_way.tags unless old_way.tags.empty?

app/views/api/old_ways/history.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements(@elems) do |old_way|
+  json.partial! old_way
+end

app/views/api/old_ways/version.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements([@old_element]) do |old_way|
+  json.partial! old_way
+end

app/views/api/relations/_relation.json.jbuilder

@@ -0,0 +1,19 @@
+json.type "relation"
+json.id relation.id
+json.timestamp relation.timestamp.xmlschema
+json.version relation.version
+json.changeset relation.changeset_id
+json.user relation.changeset.user.display_name
+json.uid relation.changeset.user_id
+
+json.visible relation.visible unless relation.visible
+
+unless relation.relation_members.empty?
+  json.members(relation.relation_members) do |m|
+    json.type m.member_type.downcase
+    json.ref m.member_id
+    json.role m.member_role
+  end
+end
+
+json.tags relation.tags unless relation.tags.empty?

app/views/api/relations/full.json.jbuilder

@@ -0,0 +1,7 @@
+json.partial! "api/root_attributes"
+
+all = @nodes + @ways + @relations
+
+json.elements(all) do |obj|
+  json.partial! obj
+end

app/views/api/relations/index.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements(@relations) do |relation|
+  json.partial! relation
+end

app/views/api/relations/relations_for_node.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements(@relations) do |relation|
+  json.partial! relation
+end

app/views/api/relations/relations_for_relation.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements(@relations) do |relation|
+  json.partial! relation
+end

app/views/api/relations/relations_for_way.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements(@relations) do |relation|
+  json.partial! relation
+end

app/views/api/relations/show.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements([@relation]) do |relation|
+  json.partial! relation
+end

app/views/api/ways/_way.json.jbuilder

@@ -0,0 +1,13 @@
+json.type "way"
+json.id way.id
+json.timestamp way.timestamp.xmlschema
+json.version way.version
+json.changeset way.changeset_id
+json.user way.changeset.user.display_name
+json.uid way.changeset.user_id
+
+json.visible way.visible unless way.visible
+
+json.nodes way.nodes.ids unless way.nodes.ids.empty?
+
+json.tags way.tags unless way.tags.empty?

app/views/api/ways/full.json.jbuilder

@@ -0,0 +1,7 @@
+json.partial! "api/root_attributes"
+
+all = @nodes + [@way]
+
+json.elements(all) do |obj|
+  json.partial! obj
+end

app/views/api/ways/index.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements(@ways) do |way|
+  json.partial! way
+end

app/views/api/ways/show.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements([@way]) do |way|
+  json.partial! way
+end

app/views/api/ways/ways_for_node.json.jbuilder

@@ -0,0 +1,5 @@
+json.partial! "api/root_attributes"
+
+json.elements(@ways) do |way|
+  json.partial! way
+end