From: Kai Krueger Date: Sat, 13 Mar 2010 22:21:48 +0000 (+0000) Subject: try and make the OpenStreetBugs API a bit more consistent with the rest of the API X-Git-Tag: live~5068^2~228 X-Git-Url: https://git.openstreetmap.org/rails.git/commitdiff_plain/458402813cfc14d9e1cbca890b238ce78ee72357?hp=01aa27031526280d8b1d219902a7b4c97617d19f try and make the OpenStreetBugs API a bit more consistent with the rest of the API --- diff --git a/app/controllers/map_bugs_controller.rb b/app/controllers/map_bugs_controller.rb index 6224a8727..c0fc97a5f 100644 --- a/app/controllers/map_bugs_controller.rb +++ b/app/controllers/map_bugs_controller.rb @@ -1,8 +1,9 @@ class MapBugsController < ApplicationController before_filter :check_api_readable - before_filter :authorize_web, :only => [:add_bug, :close_bug, :edit_bug] - before_filter :check_api_writable, :only => [:add_bug, :close_bug, :edit_bug] + before_filter :authorize_web, :only => [:add_bug, :close_bug, :edit_bug, :delete] + before_filter :check_api_writable, :only => [:add_bug, :close_bug, :edit_bug, :delete] + before_filter :require_moderator, :only => [:delete] after_filter :compress_output around_filter :api_call_handle_error, :api_call_timeout @@ -11,19 +12,26 @@ class MapBugsController < ApplicationController def get_bugs - raise OSM::APIBadUserInput.new("No l was given") unless params['l'] - raise OSM::APIBadUserInput.new("No r was given") unless params['r'] - raise OSM::APIBadUserInput.new("No b was given") unless params['b'] - raise OSM::APIBadUserInput.new("No t was given") unless params['t'] - - min_lon = params['l'].to_f - max_lon = params['r'].to_f - min_lat = params['b'].to_f - max_lat = params['t'].to_f - - limit = 100; - limit = params['limit'] if ((params['limit']) && (params['limit'].to_i < 10000) && (params['limit'].to_i > 0)) + # Figure out the bbox + bbox = params['bbox'] + if bbox and bbox.count(',') == 3 + bbox = bbox.split(',') + min_lon, min_lat, max_lon, max_lat = sanitise_boundaries(bbox) + else + #Fallback to old style, this is deprecated and should not be used + raise OSM::APIBadUserInput.new("No l was given") unless params['l'] + raise OSM::APIBadUserInput.new("No r was given") unless params['r'] + raise OSM::APIBadUserInput.new("No b was given") unless params['b'] + raise OSM::APIBadUserInput.new("No t was given") unless params['t'] + + min_lon = params['l'].to_f + max_lon = params['r'].to_f + min_lat = params['b'].to_f + max_lat = params['t'].to_f + end + limit = getLimit + conditions = closedCondition # check boundary is sane and area within defined # see /config/application.yml @@ -34,7 +42,9 @@ class MapBugsController < ApplicationController return end - @bugs = MapBug.find_by_area(min_lat, min_lon, max_lat, max_lon, :order => "last_changed DESC", :limit => limit, :conditions => "status != 'hidden'") + + + @bugs = MapBug.find_by_area(min_lat, min_lon, max_lat, max_lon, :order => "last_changed DESC", :limit => limit, :conditions => conditions) respond_to do |format| format.html {render :template => 'map_bugs/get_bugs.js', :content_type => "text/javascript"} @@ -42,7 +52,7 @@ class MapBugsController < ApplicationController format.js format.xml {render :template => 'map_bugs/get_bugs.xml'} format.json { render :json => @bugs.to_json(:methods => [:lat, :lon], :only => [:id, :status, :date_created], :include => { :map_bug_comment => { :only => [:commenter_name, :date_created, :comment]}}) } - #format.gpx {render :text => "Rendering GPX"} + format.gpx {render :template => 'map_bugs/get_bugs.gpx'} end end @@ -58,9 +68,9 @@ class MapBugsController < ApplicationController name = "NoName"; name = params['name'] if params['name']; - bug = MapBug.create_bug(lat, lon) - bug.save; - add_comment(bug, comment, name); + @bug = MapBug.create_bug(lat, lon) + @bug.save; + add_comment(@bug, comment, name); render_ok end @@ -92,6 +102,55 @@ class MapBugsController < ApplicationController render_ok end + + def rss + request.format = :rss + get_bugs + end + + def gpx_bugs + request.format = :xml + get_bugs + end + + def read + @bug = MapBug.find(params['id']) + render :text => "", :status => :gone unless @bug.visible + respond_to do |format| + format.rss + format.xml + format.json { render :json => @bug.to_json(:methods => [:lat, :lon], :only => [:id, :status, :date_created], :include => { :map_bug_comment => { :only => [:commenter_name, :date_created, :comment]}}) } + end + end + + def delete + bug = MapBug.find(params['id']) + bug.status = "hidden" + bug.save + render :text => "ok\n", :content_type => "text/html" + end + + def search + raise OSM::APIBadUserInput.new("No query string was given") unless params['q'] + limit = getLimit + conditions = closedCondition + + #TODO: There should be a better way to do this. CloseConditions are ignored at the moment + + bugs2 = MapBug.find(:all, :limit => limit, :order => "last_changed DESC", :joins => :map_bug_comment, + :conditions => ['map_bug_comment.comment ~ ?', params['q']]) + @bugs = bugs2.uniq + respond_to do |format| + format.html {render :template => 'map_bugs/get_bugs.js', :content_type => "text/javascript"} + format.rss {render :template => 'map_bugs/get_bugs.rss'} + format.js + format.xml {render :template => 'map_bugs/get_bugs.xml'} + format.json { render :json => @bugs.to_json(:methods => [:lat, :lon], :only => [:id, :status, :date_created], :include => { :map_bug_comment => { :only => [:commenter_name, :date_created, :comment]}}) } + format.gpx {render :template => 'map_bugs/get_bugs.gpx'} + end + end + + def render_ok output_js = :false output_js = :true if params['format'] == "js" @@ -99,19 +158,30 @@ class MapBugsController < ApplicationController if output_js == :true render :text => "osbResponse();", :content_type => "text/javascript" else - render :text => "ok\n", :content_type => "text/html" + render :text => "ok " + @bug.id.to_s + "\n", :content_type => "text/html" if @bug + render :text => "ok\n", :content_type => "text/html" unless @bug end - end - def rss - request.format = :rss - get_bugs + def getLimit + limit = 100; + limit = params['limit'] if ((params['limit']) && (params['limit'].to_i < 10000) && (params['limit'].to_i > 0)) + return limit end - def gpx_bugs - request.format = :xml - get_bugs + def closedCondition + closed_since = 7 unless params['closed'] + closed_since = params['closed'].to_i if params['closed'] + + if closed_since < 0 + conditions = "status != 'hidden'" + elsif closed_since > 0 + conditions = "((status = 'open') OR ((status = 'closed' ) AND (date_closed > '" + (Time.now - 7.days).to_s + "')))" + else + conditions = "status = 'open'" + end + + return conditions end def add_comment(bug, comment, name) diff --git a/app/views/map_bugs/get_bugs.gpx.builder b/app/views/map_bugs/get_bugs.gpx.builder new file mode 100644 index 000000000..be7e9cf7a --- /dev/null +++ b/app/views/map_bugs/get_bugs.gpx.builder @@ -0,0 +1,23 @@ +xml.instruct! + + +xml.gpx("version" => "1.1", + "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance", + "xsi:schemaLocation" => "http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd") do + + for bug in @bugs + xml.wpt("lon" => bug.lon, "lat" => bug.lat) do + xml.desc do + xml.cdata! bug.flatten_comment("
") + end + xml.extension do + if bug.status = "open" + xml.closed "0" + else + xml.closed "1" + end + xml.id bug.id + end + end + end +end diff --git a/app/views/map_bugs/get_bugs.xml.builder b/app/views/map_bugs/get_bugs.xml.builder index be7e9cf7a..a594506cd 100644 --- a/app/views/map_bugs/get_bugs.xml.builder +++ b/app/views/map_bugs/get_bugs.xml.builder @@ -1,23 +1,29 @@ xml.instruct! - -xml.gpx("version" => "1.1", - "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance", - "xsi:schemaLocation" => "http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd") do - +xml.bugs do for bug in @bugs - xml.wpt("lon" => bug.lon, "lat" => bug.lat) do - xml.desc do - xml.cdata! bug.flatten_comment("
") - end - xml.extension do - if bug.status = "open" - xml.closed "0" - else - xml.closed "1" - end + xml.bug("lon" => bug.lon, "lat" => bug.lat) do xml.id bug.id + xml.date_created bug.date_created + xml.nearby bug.nearby_place + xml.status bug.status + if bug.status == "closed" + xml.date_closed bug.date_closed + end + xml.comments do + for comment in bug.map_bug_comment + xml.comment do + xml.date comment.date_created + if !comment.commenter_id.nil? + xml.uid comment.commenter_id + xml.user comment.user.display_name + else + xml.user comment.commenter_name + end + xml.text comment.comment + end + end + end end - end end end diff --git a/app/views/map_bugs/read.xml.builder b/app/views/map_bugs/read.xml.builder new file mode 100644 index 000000000..f9d7ddaa1 --- /dev/null +++ b/app/views/map_bugs/read.xml.builder @@ -0,0 +1,25 @@ +xml.instruct! + +xml.bug("lon" => @bug.lon, "lat" => @bug.lat) do + xml.id @bug.id + xml.date_created @bug.date_created + xml.nearby @bug.nearby_place + xml.status @bug.status + if @bug.status == "closed" + xml.date_closed @bug.date_closed + end + xml.comments do + for comment in @bug.map_bug_comment + xml.comment do + xml.date comment.date_created + if !comment.commenter_id.nil? + xml.uid comment.commenter_id + xml.user comment.user.display_name + else + xml.user comment.commenter_name + end + xml.text comment.comment + end + end + end +end diff --git a/config/environment.rb b/config/environment.rb index ba5241a21..1ad6aa202 100644 --- a/config/environment.rb +++ b/config/environment.rb @@ -99,4 +99,7 @@ Rails::Initializer.run do |config| # Make Active Record use UTC-base instead of local time config.active_record.default_timezone = :utc + + Mime::Type.register "text/xml", :gpx + end diff --git a/config/routes.rb b/config/routes.rb index cadf37625..2c57f11ca 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -79,6 +79,15 @@ ActionController::Routing::Routes.draw do |map| map.connect "api/#{API_VERSION}/bugs/getGPX", :controller =>'map_bugs', :action =>'gpx_bugs' map.connect "api/#{API_VERSION}/bugs/getRSSfeed", :controller =>'map_bugs', :action =>'rss' + map.connect "api/#{API_VERSION}/bugs", :controller => 'map_bugs', :action => 'get_bugs' + map.connect "api/#{API_VERSION}/bugs/search", :controller => 'map_bugs', :action => 'search' + map.connect "api/#{API_VERSION}/bug/create", :controller => 'map_bugs', :action => 'add_bug' + map.connect "api/#{API_VERSION}/bug/:id/comment", :controller => 'map_bugs', :action => 'edit_bug', :id => /\d+/ + map.connect "api/#{API_VERSION}/bug/:id/close", :controller => 'map_bugs', :action => 'close_bug', :id => /\d+/ + map.connect "api/#{API_VERSION}/bug/:id", :controller => 'map_bugs', :action => 'read', :id => /\d+/, :conditions => { :method => :get } + map.connect "api/#{API_VERSION}/bug/:id", :controller => 'map_bugs', :action => 'delete', :id => /\d+/, :conditions => { :method => :delete } + + # Data browsing map.connect '/browse', :controller => 'changeset', :action => 'list'