test/controllers/api/traces_controller_test.rb

   1 require "test_helper"
   2
   3 module Api
   4   class TracesControllerTest < ActionDispatch::IntegrationTest
   5     ##
   6     # test all routes which lead to this controller
   7     def test_routes
   8       assert_routing(
   9         { :path => "/api/0.6/gpx", :method => :post },
  10         { :controller => "api/traces", :action => "create" }
  11       )
  12       assert_recognizes(
  13         { :controller => "api/traces", :action => "create" },
  14         { :path => "/api/0.6/gpx/create", :method => :post }
  15       )
  16       assert_routing(
  17         { :path => "/api/0.6/gpx/1", :method => :get },
  18         { :controller => "api/traces", :action => "show", :id => "1" }
  19       )
  20       assert_routing(
  21         { :path => "/api/0.6/gpx/1", :method => :put },
  22         { :controller => "api/traces", :action => "update", :id => "1" }
  23       )
  24       assert_routing(
  25         { :path => "/api/0.6/gpx/1", :method => :delete },
  26         { :controller => "api/traces", :action => "destroy", :id => "1" }
  27       )
  28       assert_recognizes(
  29         { :controller => "api/traces", :action => "show", :id => "1" },
  30         { :path => "/api/0.6/gpx/1/details", :method => :get }
  31       )
  32       assert_routing(
  33         { :path => "/api/0.6/gpx/1/data", :method => :get },
  34         { :controller => "api/traces", :action => "data", :id => "1" }
  35       )
  36       assert_routing(
  37         { :path => "/api/0.6/gpx/1/data.xml", :method => :get },
  38         { :controller => "api/traces", :action => "data", :id => "1", :format => "xml" }
  39       )
  40     end
  41
  42     # Check getting a specific trace through the api
  43     def test_show
  44       public_trace_file = create(:trace, :visibility => "public")
  45
  46       # First with no auth
  47       get api_trace_path(public_trace_file)
  48       assert_response :unauthorized
  49
  50       # Now with some other user, which should work since the trace is public
  51       auth_header = bearer_authorization_header
  52       get api_trace_path(public_trace_file), :headers => auth_header
  53       assert_response :success
  54
  55       # And finally we should be able to do it with the owner of the trace
  56       auth_header = bearer_authorization_header public_trace_file.user
  57       get api_trace_path(public_trace_file), :headers => auth_header
  58       assert_response :success
  59       assert_select "gpx_file[id='#{public_trace_file.id}'][uid='#{public_trace_file.user.id}']", 1
  60     end
  61
  62     # Check an anonymous trace can't be specifically fetched by another user
  63     def test_show_anon
  64       anon_trace_file = create(:trace, :visibility => "private")
  65
  66       # First with no auth
  67       get api_trace_path(anon_trace_file)
  68       assert_response :unauthorized
  69
  70       # Now try with another user, which shouldn't work since the trace is anon
  71       auth_header = bearer_authorization_header
  72       get api_trace_path(anon_trace_file), :headers => auth_header
  73       assert_response :forbidden
  74
  75       # And finally we should be able to get the trace details with the trace owner
  76       auth_header = bearer_authorization_header anon_trace_file.user
  77       get api_trace_path(anon_trace_file), :headers => auth_header
  78       assert_response :success
  79     end
  80
  81     # Check the api details for a trace that doesn't exist
  82     def test_show_not_found
  83       deleted_trace_file = create(:trace, :deleted)
  84
  85       # Try first with no auth, as it should require it
  86       get api_trace_path(:id => 0)
  87       assert_response :unauthorized
  88
  89       # Login, and try again
  90       auth_header = bearer_authorization_header deleted_trace_file.user
  91       get api_trace_path(:id => 0), :headers => auth_header
  92       assert_response :not_found
  93
  94       # Now try a trace which did exist but has been deleted
  95       auth_header = bearer_authorization_header deleted_trace_file.user
  96       get api_trace_path(deleted_trace_file), :headers => auth_header
  97       assert_response :not_found
  98     end
  99
 100     # Test downloading a trace through the api
 101     def test_data
 102       public_trace_file = create(:trace, :visibility => "public", :fixture => "a")
 103
 104       # First with no auth
 105       get api_trace_data_path(public_trace_file)
 106       assert_response :unauthorized
 107
 108       # Now with some other user, which should work since the trace is public
 109       auth_header = bearer_authorization_header
 110       get api_trace_data_path(public_trace_file), :headers => auth_header
 111       follow_redirect!
 112       follow_redirect!
 113       check_trace_data public_trace_file, "848caa72f2f456d1bd6a0fdf228aa1b9"
 114
 115       # And finally we should be able to do it with the owner of the trace
 116       auth_header = bearer_authorization_header public_trace_file.user
 117       get api_trace_data_path(public_trace_file), :headers => auth_header
 118       follow_redirect!
 119       follow_redirect!
 120       check_trace_data public_trace_file, "848caa72f2f456d1bd6a0fdf228aa1b9"
 121     end
 122
 123     # Test downloading a compressed trace through the api
 124     def test_data_compressed
 125       identifiable_trace_file = create(:trace, :visibility => "identifiable", :fixture => "d")
 126
 127       # Authenticate as the owner of the trace we will be using
 128       auth_header = bearer_authorization_header identifiable_trace_file.user
 129
 130       # First get the data as is
 131       get api_trace_data_path(identifiable_trace_file), :headers => auth_header
 132       follow_redirect!
 133       follow_redirect!
 134       check_trace_data identifiable_trace_file, "c6422a3d8750faae49ed70e7e8a51b93", "application/gzip", "gpx.gz"
 135
 136       # Now ask explicitly for XML format
 137       get api_trace_data_path(identifiable_trace_file, :format => "xml"), :headers => auth_header
 138       check_trace_data identifiable_trace_file, "abd6675fdf3024a84fc0a1deac147c0d", "application/xml", "xml"
 139
 140       # Now ask explicitly for GPX format
 141       get api_trace_data_path(identifiable_trace_file, :format => "gpx"), :headers => auth_header
 142       check_trace_data identifiable_trace_file, "abd6675fdf3024a84fc0a1deac147c0d"
 143     end
 144
 145     # Check an anonymous trace can't be downloaded by another user through the api
 146     def test_data_anon
 147       anon_trace_file = create(:trace, :visibility => "private", :fixture => "b")
 148
 149       # First with no auth
 150       get api_trace_data_path(anon_trace_file)
 151       assert_response :unauthorized
 152
 153       # Now with some other user, which shouldn't work since the trace is anon
 154       auth_header = bearer_authorization_header
 155       get api_trace_data_path(anon_trace_file), :headers => auth_header
 156       assert_response :forbidden
 157
 158       # And finally we should be able to do it with the owner of the trace
 159       auth_header = bearer_authorization_header anon_trace_file.user
 160       get api_trace_data_path(anon_trace_file), :headers => auth_header
 161       follow_redirect!
 162       follow_redirect!
 163       check_trace_data anon_trace_file, "db4cb5ed2d7d2b627b3b504296c4f701"
 164     end
 165
 166     # Test downloading a trace that doesn't exist through the api
 167     def test_data_not_found
 168       deleted_trace_file = create(:trace, :deleted)
 169
 170       # Try first with no auth, as it should require it
 171       get api_trace_data_path(:id => 0)
 172       assert_response :unauthorized
 173
 174       # Login, and try again
 175       auth_header = bearer_authorization_header
 176       get api_trace_data_path(:id => 0), :headers => auth_header
 177       assert_response :not_found
 178
 179       # Now try a trace which did exist but has been deleted
 180       auth_header = bearer_authorization_header deleted_trace_file.user
 181       get api_trace_data_path(deleted_trace_file), :headers => auth_header
 182       assert_response :not_found
 183     end
 184
 185     # Test creating a trace through the api
 186     def test_create
 187       # Get file to use
 188       fixture = Rails.root.join("test/gpx/fixtures/a.gpx")
 189       file = Rack::Test::UploadedFile.new(fixture, "application/gpx+xml")
 190       user = create(:user)
 191
 192       # First with no auth
 193       post api_traces_path, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :visibility => "trackable" }
 194       assert_response :unauthorized
 195
 196       # Rewind the file
 197       file.rewind
 198
 199       # Now authenticated
 200       create(:user_preference, :user => user, :k => "gps.trace.visibility", :v => "identifiable")
 201       assert_not_equal "trackable", user.preferences.find_by(:k => "gps.trace.visibility").v
 202
 203       auth_header = bearer_authorization_header user
 204
 205       # Create trace and import tracepoints in background job
 206       perform_enqueued_jobs do
 207         post api_traces_path, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :visibility => "trackable" }, :headers => auth_header
 208       end
 209
 210       assert_response :success
 211
 212       trace = Trace.find(response.body.to_i)
 213       assert_equal "a.gpx", trace.name
 214       assert_equal "New Trace", trace.description
 215       assert_equal %w[new trace], trace.tags.order(:tag).collect(&:tag)
 216       assert_equal "trackable", trace.visibility
 217       assert trace.inserted
 218       assert_equal File.new(fixture).read, trace.file.blob.download
 219
 220       # Validate tracepoints
 221       assert_equal 1, trace.points.size
 222       tp = trace.points.first
 223       assert_equal 10000000, tp.latitude
 224       assert_equal 10000000, tp.longitude
 225       assert_equal 3221331576, tp.tile
 226       assert_equal 0, tp.trackid
 227       assert_in_delta(134.0, tp.altitude)
 228       assert_equal DateTime.parse("2008-10-01T10:10:10.000Z"), tp.timestamp
 229
 230       trace.destroy
 231       assert_equal "trackable", user.preferences.find_by(:k => "gps.trace.visibility").v
 232
 233       # Rewind the file
 234       file.rewind
 235
 236       # Now authenticated, with the legacy public flag
 237       assert_not_equal "public", user.preferences.find_by(:k => "gps.trace.visibility").v
 238       auth_header = bearer_authorization_header user
 239       post api_traces_path, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :public => 1 }, :headers => auth_header
 240       assert_response :success
 241       trace = Trace.find(response.body.to_i)
 242       assert_equal "a.gpx", trace.name
 243       assert_equal "New Trace", trace.description
 244       assert_equal %w[new trace], trace.tags.order(:tag).collect(&:tag)
 245       assert_equal "public", trace.visibility
 246       assert_not trace.inserted
 247       assert_equal File.new(fixture).read, trace.file.blob.download
 248       trace.destroy
 249       assert_equal "public", user.preferences.find_by(:k => "gps.trace.visibility").v
 250
 251       # Rewind the file
 252       file.rewind
 253
 254       # Now authenticated, with the legacy private flag
 255       second_user = create(:user)
 256       assert_nil second_user.preferences.find_by(:k => "gps.trace.visibility")
 257       auth_header = bearer_authorization_header second_user
 258       post api_traces_path, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :public => 0 }, :headers => auth_header
 259       assert_response :success
 260       trace = Trace.find(response.body.to_i)
 261       assert_equal "a.gpx", trace.name
 262       assert_equal "New Trace", trace.description
 263       assert_equal %w[new trace], trace.tags.order(:tag).collect(&:tag)
 264       assert_equal "private", trace.visibility
 265       assert_not trace.inserted
 266       assert_equal File.new(fixture).read, trace.file.blob.download
 267       trace.destroy
 268       assert_equal "private", second_user.preferences.find_by(:k => "gps.trace.visibility").v
 269     end
 270
 271     # Check updating a trace through the api
 272     def test_update
 273       public_trace_file = create(:trace, :visibility => "public", :fixture => "a")
 274       deleted_trace_file = create(:trace, :deleted)
 275       anon_trace_file = create(:trace, :visibility => "private")
 276
 277       # First with no auth
 278       put api_trace_path(public_trace_file), :params => create_trace_xml(public_trace_file)
 279       assert_response :unauthorized
 280
 281       # Now with some other user, which should fail
 282       auth_header = bearer_authorization_header
 283       put api_trace_path(public_trace_file), :params => create_trace_xml(public_trace_file), :headers => auth_header
 284       assert_response :forbidden
 285
 286       # Now with a trace which doesn't exist
 287       auth_header = bearer_authorization_header
 288       put api_trace_path(:id => 0), :params => create_trace_xml(public_trace_file), :headers => auth_header
 289       assert_response :not_found
 290
 291       # Now with a trace which did exist but has been deleted
 292       auth_header = bearer_authorization_header deleted_trace_file.user
 293       put api_trace_path(deleted_trace_file), :params => create_trace_xml(deleted_trace_file), :headers => auth_header
 294       assert_response :not_found
 295
 296       # Now try an update with the wrong ID
 297       auth_header = bearer_authorization_header public_trace_file.user
 298       put api_trace_path(public_trace_file), :params => create_trace_xml(anon_trace_file), :headers => auth_header
 299       assert_response :bad_request,
 300                       "should not be able to update a trace with a different ID from the XML"
 301
 302       # And finally try an update that should work
 303       auth_header = bearer_authorization_header public_trace_file.user
 304       t = public_trace_file
 305       t.description = "Changed description"
 306       t.visibility = "private"
 307       put api_trace_path(t), :params => create_trace_xml(t), :headers => auth_header
 308       assert_response :success
 309       nt = Trace.find(t.id)
 310       assert_equal nt.description, t.description
 311       assert_equal nt.visibility, t.visibility
 312     end
 313
 314     # Test that updating a trace doesn't duplicate the tags
 315     def test_update_tags
 316       tracetag = create(:tracetag)
 317       trace = tracetag.trace
 318       auth_header = bearer_authorization_header trace.user
 319
 320       put api_trace_path(trace), :params => create_trace_xml(trace), :headers => auth_header
 321       assert_response :success
 322
 323       updated = Trace.find(trace.id)
 324       # Ensure there's only one tag in the database after updating
 325       assert_equal(1, Tracetag.count)
 326       # The new tag object might have a different id, so check the string representation
 327       assert_equal trace.tagstring, updated.tagstring
 328     end
 329
 330     # Check deleting a trace through the api
 331     def test_destroy
 332       public_trace_file = create(:trace, :visibility => "public")
 333
 334       # First with no auth
 335       delete api_trace_path(public_trace_file)
 336       assert_response :unauthorized
 337
 338       # Now with some other user, which should fail
 339       auth_header = bearer_authorization_header
 340       delete api_trace_path(public_trace_file), :headers => auth_header
 341       assert_response :forbidden
 342
 343       # Now with a trace which doesn't exist
 344       auth_header = bearer_authorization_header
 345       delete api_trace_path(:id => 0), :headers => auth_header
 346       assert_response :not_found
 347
 348       # And finally we should be able to do it with the owner of the trace
 349       auth_header = bearer_authorization_header public_trace_file.user
 350       delete api_trace_path(public_trace_file), :headers => auth_header
 351       assert_response :success
 352
 353       # Try it a second time, which should fail
 354       auth_header = bearer_authorization_header public_trace_file.user
 355       delete api_trace_path(public_trace_file), :headers => auth_header
 356       assert_response :not_found
 357     end
 358
 359     private
 360
 361     def check_trace_data(trace, digest, content_type = "application/gpx+xml", extension = "gpx")
 362       assert_response :success
 363       assert_equal digest, Digest::MD5.hexdigest(response.body)
 364       assert_equal content_type, response.media_type
 365       assert_equal "attachment; filename=\"#{trace.id}.#{extension}\"; filename*=UTF-8''#{trace.id}.#{extension}", @response.header["Content-Disposition"]
 366     end
 367
 368     ##
 369     # build XML for traces
 370     # this builds a minimum viable XML for the tests in this suite
 371     def create_trace_xml(trace)
 372       root = XML::Document.new
 373       root.root = XML::Node.new "osm"
 374       trc = XML::Node.new "gpx_file"
 375       trc["id"] = trace.id.to_s
 376       trc["visibility"] = trace.visibility
 377       trc["visible"] = trace.visible.to_s
 378       desc = XML::Node.new "description"
 379       desc << trace.description
 380       trc << desc
 381       trace.tags.each do |tag|
 382         t = XML::Node.new "tag"
 383         t << tag.tag
 384         trc << t
 385       end
 386       root.root << trc
 387       root.to_s
 388     end
 389   end
 390 end