roda-rest_api 1.4.5 → 2.0.1

data/roda-rest_api.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: roda-rest_api 2.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "roda-rest_api"
+  s.version = "2.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Michel Benevento"]
+  s.date = "2015-06-29"
+  s.description = "Create restful API easily with the Roda framework"
+  s.email = "michelbenevento@yahoo.com"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/roda/plugins/rest_api.rb",
+    "lib/roda/rest_api.rb",
+    "roda-rest_api.gemspec",
+    "test/rest_api_api_test.rb",
+    "test/rest_api_form_input_test.rb",
+    "test/rest_api_id_pattern_test.rb",
+    "test/rest_api_nested_test.rb",
+    "test/rest_api_perf_benchmark.rb",
+    "test/rest_api_permit_test.rb",
+    "test/rest_api_resource_test.rb",
+    "test/rest_api_routes_test.rb",
+    "test/rest_api_serialize_test.rb",
+    "test/rest_api_singleton_test.rb",
+    "test/rest_api_split_route_test.rb",
+    "test/rest_api_upgrade_test.rb",
+    "test/rest_api_wrapper_test.rb",
+    "test/test_helpers.rb"
+  ]
+  s.homepage = "http://github.com/beno/roda-rest_api"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.5"
+  s.summary = "Restful resources for Roda"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<roda>, ["~> 2"])
+    else
+      s.add_dependency(%q<roda>, ["~> 2"])
+    end
+  else
+    s.add_dependency(%q<roda>, ["~> 2"])
+  end
+end
+

data/test/rest_api_api_test.rb

@@ -0,0 +1,76 @@
+require "test_helpers"
+
+class RestApiApiTest < Minitest::Test
+	include TestHelpers
+
+	def setup
+	end
+
+	def test_api_version
+		app :rest_api do |r|
+			r.api do
+				r.version 1 do
+					'api version 1'
+				end
+			end
+		end
+		assert_equal 'api version 1', request.get('/api/v1').body
+	end
+
+	def test_api_version_no_path
+		app :rest_api do |r|
+			r.api(path: '') do
+				r.version 1 do
+					'api version 1'
+				end
+			end
+		end
+		assert_equal 'api version 1', request.get('/v1').body
+	end
+
+	def test_api_version_subdomain
+		app :rest_api do |r|
+			r.api(subdomain: 'api') do
+				r.version 1 do
+					'api version 1'
+				end
+			end
+		end
+		assert_equal 'api version 1', request.get('/api/v1', "HTTP_HOST" => "api.example.com").body
+	end
+
+	def test_api_host_fail
+		app :rest_api do |r|
+			r.api(subdomain: 'api') do
+				r.version 1 do
+					'api version 1'
+				end
+			end
+		end
+		assert_equal 404, request.get('/api/v1', "HTTP_HOST" => "www.example.com").status
+	end
+
+	def test_api_path_fail
+		app :rest_api do |r|
+			r.api do
+				r.version 1 do
+					'api version 1'
+				end
+			end
+		end
+		assert_equal 404, request.get('/v1').status
+	end
+	
+	def test_api_path_fail2
+		app :rest_api do |r|
+			r.api do
+				r.resource :foo do |foo|
+					foo.list {[]}
+				end
+			end
+		end
+		assert_equal 404, request.get('/foo').status
+	end
+
+end
+

data/test/rest_api_form_input_test.rb

@@ -0,0 +1,31 @@
+require "test_helpers"
+
+class RestApiFormInputTest < Minitest::Test
+	include TestHelpers
+
+	def setup
+		app :rest_api do |r|
+			r.resource :albums do |rsc|
+				rsc.save   { |atts| Album.create_or_update(atts)  }
+				rsc.permit :name
+			end
+		end
+	end
+
+	def test_create
+		id, name = 1, 'bar'
+		album = Album.new(id, name)
+		response = request.post('/albums', params: {name: name})
+		assert_equal album.to_json, response.body
+		assert_equal 201, response.status
+	end
+
+	def test_update
+		id, name = 12, 'foo'
+		album = Album.new(id, name)
+		assert_equal album.to_json, request.patch('/albums/12', params: {id: id, name: name}).body
+		assert_equal album.to_json, request.put('/albums/12', params: {id: id, name: name}).body
+	end
+
+end
+

data/test/rest_api_id_pattern_test.rb

@@ -0,0 +1,56 @@
+require "test_helpers"
+
+class RestApiIdPatternTest < Minitest::Test
+  include TestHelpers
+  
+  def setup
+    app :rest_api do |r|
+      r.api id_pattern: /id([\d]+)/ do
+        r.resource :artists, id_pattern: /@([\d]+)/  do |rsc|
+          rsc.one { |atts| "ARTIST_#{atts[:id]}" }
+          r.resource :songs, id_pattern: /foo([\d]+)/  do |rsc|
+            rsc.one { |atts| "SONG_#{atts[:id]}" }
+          end
+          r.resource :concerts  do |rsc| # need to be explicit
+            rsc.one { |atts| "CONCERT_#{atts[:id]}" }
+          end
+        end
+        r.resource :venues do |rsc|
+          rsc.one { |atts| "VENUE_#{atts[:id]}" }
+        end
+        r.resource :albums do |rsc|
+          rsc.save { |atts| "SAVE_ALBUM_#{atts[:id]}" }
+          rsc.routes :create, :update
+        end
+
+      end
+    end
+  end
+
+  def test_complex_pattern
+    assert_equal "SAVE_ALBUM_12", request.put('api/albums/id12', params:{foo:'bar'}).body
+  end
+  
+  def test_failing_pattern
+    assert_equal 404, request.get('api/albums/12').status
+  end
+  
+  def test_pattern_override
+    assert_equal "ARTIST_12", request.get('api/artists/@12').body
+  end
+  
+  def test_nested
+    assert_equal "SONG_4", request.get('api/artists/@12/songs/foo4').body
+  end
+
+  def test_nested_fallback
+    assert_equal "CONCERT_3", request.get('api/artists/@12/concerts/@3').body
+  end
+  
+  def test_fallback
+    assert_equal "VENUE_5", request.get('api/venues/id5').body
+  end
+
+
+
+end

data/test/rest_api_nested_test.rb

@@ -0,0 +1,105 @@
+require "test_helpers"
+
+class RestApiNestedTest < Minitest::Test
+	include TestHelpers
+	
+	def setup
+		app :rest_api do |r|
+			r.resource :albums do |albums|
+					albums.list { |params| Album.find({} ) }
+					albums.one    { |params| Album[params[:id]] 	}
+					albums.routes :index, :show
+				r.resource :songs do |songs|
+					songs.list { |params| Song.find({ :album_id => params[:parent_id]} ) }
+					songs.one    { |params| Song[params[:id]] 	}
+					songs.routes :index, :show
+				end
+				r.resource :settings, singleton: true do |settings|
+					settings.one    { |params| Settings[3] 	}
+					settings.save    { |atts| Settings[3].save(atts) 	}
+					settings.routes :show, :update
+					settings.permit :name
+				end
+				r.resource :artwork, parent_key: :album_id do |artwork|
+					artwork.list { |params| Artwork.find(params) }
+					artwork.routes :index
+				end
+				r.resource :favorites, bare: true do |favorites|
+					favorites.list   { |params| Favorite.find(params)  }
+					favorites.one    { |params| Favorite[params[:id]] 	}
+					favorites.routes :index, :show
+					r.resource :things do |things|
+						things.list   { |params| Thing.find(params)  }
+						things.one    { |params| Thing[params[:id]] 	}
+						things.routes :index, :edit
+					end
+
+				end
+			end
+
+		end
+	end
+
+	def test_album_index
+		assert_equal Album.find({}).to_json, request.get('/albums').body
+	end
+	
+	def test_album_show
+		assert_equal Album[10].to_json, request.get('/albums/10').body
+	end
+
+	def test_album_fail
+		assert_equal 404, request.get('/albums/--').status
+	end
+	
+	def test_songs_index
+		assert_equal Song.find({:album_id => 12 }).to_json, request.get('/albums/12/songs').body
+	end
+	
+	def test_songs_show
+		assert_equal Song[10].to_json, request.get('/albums/12/songs/10').body
+	end
+
+	def test_songs_fail
+		assert_equal 404, request.get('/albums/12/songs/--').status
+	end
+	
+	def test_singleton_update
+		id, name = 3, 'bar'
+		settings = Settings.new(id, name)
+		assert_equal settings.to_json, request.patch('/albums/12/settings', input: {name: name}.to_json).body
+	end
+	#
+	def test_favorites_index
+		assert_equal Favorite.find({}).to_json, request.get('/albums/favorites').body
+	end
+	
+	def test_favorites_show
+		assert_equal Favorite[7].to_json, request.get('/albums/favorites/7').body
+	end
+	
+	def test_filtered_default
+		assert_equal Song.find({:album_id => 9 }).to_json, request.get('/albums/9/songs').body
+	end
+	
+	def test_filtered_custom
+		assert_equal Artwork.find({:album_id => 8 }).to_json, request.get('/albums/8/artwork').body
+	end
+
+	def test_deep_nest_fail
+		assert_equal 404, request.get('/albums/favorites/4/things/3').status
+	end
+
+	def test_deep_nest
+		assert_equal Thing[3].to_json, request.get('/albums/favorites/things/3/edit').body
+	end
+
+	
+	class Song < Mock ; end
+	class Settings < Mock ; end
+	class Favorite < Mock ; end
+	class Artwork < Mock ; end
+	class Thing < Mock ; end
+
+
+end

data/test/rest_api_perf_benchmark.rb

@@ -0,0 +1,35 @@
+require "test_helpers"
+require "minitest/benchmark"
+
+class RestApiPerformanceTest < Minitest::Benchmark
+	include TestHelpers
+
+	def setup
+		app :rest_api do |r|
+			r.resource :albums do |rsc|
+				rsc.list   { |params| Album.find(params)  }
+				rsc.one    { |params| Album[params[:id]] 	}
+				rsc.save    { |atts| Album.create_or_update(atts) 	}
+				rsc.routes :show, :create
+			end
+		end
+	end
+
+	def bench_show
+		assert_performance_linear 0.99 do |n|
+			n.times do
+				request.get('/albums/12').body
+			end
+		end
+	end
+	
+	def bench_create
+		assert_performance_linear 0.99 do |n|
+			n.times do
+				request.post('/albums',  'rack.input' => post_args({name: 'foo'})}).body
+			end
+		end
+	end
+	
+
+end

data/test/rest_api_permit_test.rb

@@ -0,0 +1,117 @@
+require "test_helpers"
+
+class RestApiPermitTest < Minitest::Test
+	include TestHelpers
+	
+
+	def test_index_permitted
+		app :rest_api do |r|
+			r.resource :albums do |albums|
+				albums.list  { |params| Album.find(params) 	}
+				albums.routes :index
+				albums.permit :page
+			end
+		end
+		params = {page: '2'}
+		assert_equal Album.find(params).to_json, request.get('/albums', {'QUERY_STRING' => 'page=2'}).body
+	end
+	
+	
+	def test_index_not_permitted
+		app :rest_api do |r|
+			r.resource :albums do |albums|
+				albums.list  { |params| Album.find(params) 	}
+				albums.routes :index
+				albums.permit :page
+			end
+		end
+		params = {page_ct: '2'}
+		assert_equal Album.find({}).to_json, request.get('/albums', {'QUERY_STRING' => 'page_ct=2'}).body
+	end
+
+	def test_create_permitted
+		app :rest_api do |r|
+			r.resource :albums do |albums|
+				albums.save  { |params| Album.create_or_update(params) 	}
+				albums.routes :create, :update
+				albums.permit :name, :price
+			end
+		end
+		atts = {name: 'name', price: 3}
+		album = Album.new(1, atts[:name], atts[:price])
+		assert_equal album.to_json, request.post('/albums', input: atts.to_json).body
+		assert_equal 201, request.post('/albums', input: atts.to_json).status
+	end
+	
+	def test_create_not_permitted
+		app :rest_api do |r|
+			r.resource :albums do |albums|
+				albums.save  { |params| Album.create_or_update(params) 	}
+				albums.routes :create, :update
+				albums.permit :name
+			end
+		end
+	
+		atts = {name: 'name', price: 3}
+		album = Album.new(1, atts[:name])
+		assert_equal album.to_json, request.post('/albums', input: atts.to_json).body
+	end
+
+	def test_create_nested_single
+		app :rest_api do |r|
+			r.resource :albums do |albums|
+				albums.save  { |params| Album.create_or_update(params) 	}
+				albums.routes :create, :update
+				albums.permit :name, {price: :amount}
+			end
+		end
+	
+		atts = {name: 'name', price: {amount: 4}}
+		album = Album.new(1, atts[:name], atts[:price])
+		assert_equal album.to_json, request.post('/albums', input: atts.to_json).body
+	end
+	
+	def test_create_nested_array
+		app :rest_api do |r|
+			r.resource :albums do |albums|
+				albums.save  { |params| Album.create_or_update(params) 	}
+				albums.routes :create, :update
+				albums.permit :name, {price: [:amount, :currency, :discount]}
+			end
+		end
+	
+		atts = {name: 'name', price: {amount: 4}}
+		album = Album.new(1, atts[:name], atts[:price])
+		assert_equal album.to_json, request.post('/albums', input: atts.to_json).body
+	end
+	
+	def test_create_nested_single_not_permitted
+		app :rest_api do |r|
+			r.resource :albums do |albums|
+				albums.save  { |params| Album.create_or_update(params) 	}
+				albums.routes :create, :update
+				albums.permit :name, {price: :total}
+			end
+		end
+	
+		atts = {name: 'name', price: {amount: 4}}
+		album = Album.new(1, atts[:name], {})
+		assert_equal album.to_json, request.post('/albums', input: atts.to_json).body
+	end
+	
+	def test_create_nested_array_not_permitted
+		app :rest_api do |r|
+			r.resource :albums do |albums|
+				albums.save  { |params| Album.create_or_update(params) 	}
+				albums.routes :create, :update
+				albums.permit :name, {price: [:total, :currency, :discount]}
+			end
+		end
+	
+		atts = {name: 'name', price: {amount: 4, currency:'foo'}}
+		album = Album.new(1, atts[:name], {currency:'foo'})
+		assert_equal album.to_json, request.post('/albums', input: atts.to_json).body
+	end
+
+
+end