blindgaenger-sinatra-rest 0.2 → 0.3.0

data/test/crud_spec.rb

@@ -0,0 +1,99 @@
+require File.dirname(__FILE__) + '/helper'
+
+describe 'some use cases' do
+
+  def total_models
+    Person.all.size
+  end
+
+  require "rexml/document"
+  def doc(xml)
+    REXML::Document.new(xml.gsub(/>\s+</, '><').strip)
+  end
+
+  before(:each) do
+    Person.reset!
+    mock_rest Person
+  end
+
+  it 'should list all persons' do
+    get '/people'
+    normalized_response.should == [200, '<people><person><id>1</id></person><person><id>2</id></person><person><id>3</id></person></people>']
+    total_models.should == 3
+  end
+
+  it 'should create a new person' do
+    get '/people'
+    normalized_response.should == [200, '<people><person><id>1</id></person><person><id>2</id></person><person><id>3</id></person></people>']
+    total_models.should == 3
+
+    get '/people/new'
+    normalized_response.should == [200, '<person><id></id><name></name></person>']
+    total_models.should == 3
+
+    post '/people', {:name => 'four'}
+    normalized_response.should == [302, 'person created']
+    total_models.should == 4
+
+    get '/people'
+    normalized_response.should == [200, '<people><person><id>1</id></person><person><id>2</id></person><person><id>3</id></person><person><id>4</id></person></people>']
+    total_models.should == 4
+  end
+
+  it 'should read all persons' do
+    get '/people'
+
+    el_people = doc(body).elements.to_a("*/person/id")
+    el_people.size.should == 3
+    total_models.should == 3
+
+    get "/people/#{el_people[0].text}"
+    normalized_response.should == [200, '<person><id>1</id><name>one</name></person>']
+    total_models.should == 3
+
+    get "/people/#{el_people[1].text}"
+    normalized_response.should == [200, '<person><id>2</id><name>two</name></person>']
+    total_models.should == 3
+
+    get "/people/#{el_people[2].text}"
+    normalized_response.should == [200, '<person><id>3</id><name>three</name></person>']
+    total_models.should == 3
+    
+    get "/people/99"
+    normalized_response.should == [404, 'route not found']
+    total_models.should == 3
+  end
+
+  it 'should update a person' do
+    get '/people/2'
+    normalized_response.should == [200, '<person><id>2</id><name>two</name></person>']
+    total_models.should == 3
+
+    put '/people/2', {:name => 'tomorrow'}
+    normalized_response.should == [302, 'person updated']
+    total_models.should == 3
+
+    get '/people/2'
+    normalized_response.should == [200, '<person><id>2</id><name>tomorrow</name></person>']
+    total_models.should == 3
+  end
+
+  it 'should destroy a person' do
+    get '/people'
+    normalized_response.should == [200, '<people><person><id>1</id></person><person><id>2</id></person><person><id>3</id></person></people>']
+    total_models.should == 3
+
+    delete '/people/2'
+    normalized_response.should == [302, 'person destroyed']
+    total_models.should == 2
+
+    get '/people'
+    normalized_response.should == [200, '<people><person><id>1</id></person><person><id>3</id></person></people>']
+    total_models.should == 2
+
+    get '/people/2'
+    normalized_response.should == [404, 'route not found']
+    total_models.should == 2
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,151 @@
+require 'spec'
+require 'spec/interop/test'
+require 'sinatra/test'
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'sinatra/base'
+require 'sinatra/rest'
+
+Sinatra::Default.set(:environment, :test)
+Test::Unit::TestCase.send :include, Sinatra::Test
+
+#
+# Sets up a Sinatra::Base subclass defined with the block
+# given. Used in setup or individual spec methods to establish
+# the application.
+def mock_app(&block)
+  base = Sinatra::Application
+  @app = Sinatra.new(base) do
+    set :views, File.dirname(__FILE__) + '/views'
+          
+    not_found do
+      'route not found'
+    end
+  end
+  @app.instance_eval(&block) if block_given?
+end
+
+#
+# sets rest in a sinatra instance
+# and returns the block's result, if a block is given
+def mock_rest(model, options={}, &block)
+  mock_app {
+    rest model, options
+  }
+  instance = @app.new
+  instance.instance_eval(&block) if block_given?
+end
+
+
+#
+# normalize for easier testing
+def normalized_response
+  return status, body.gsub(/>\s+</, '><').strip
+end
+
+# index GET /models
+def index(url)
+  get url
+  normalized_response
+end
+
+# new GET /models/new
+def new(url)
+  get url
+  normalized_response
+end
+
+# create POST /models
+def create(url, params={})
+  post url, params
+  normalized_response
+end
+
+# show GET /models/1
+def show(url)
+  get url
+  normalized_response
+end
+
+# edit GET /models/1/edit
+def edit(url)
+  get url
+  normalized_response
+end
+
+# update PUT /models/1
+def update(url, params={})
+  put url, params
+  normalized_response
+end
+
+# destroy DELETE /models/1
+def destroy(url)
+  delete url
+  normalized_response
+end
+
+
+##
+## kind of a 'minimal model'
+class Person
+  attr_accessor :id
+  attr_accessor :name
+
+  def initialize(*args)
+    #puts "new #{args.inspect}"
+    if args.size == 0
+      @id = nil
+      @name = nil
+    elsif args.size == 2
+      @id = args[0].to_i
+      @name = args[1]
+    else args.size == 1
+      update_attributes(args[0])
+    end
+  end
+
+  def save
+    #puts "save #{@id}"
+    @@people << self
+    self.id = @@people.size
+  end
+
+  def update_attributes(hash)
+    #puts "update_attributes #{hash.inspect}"
+    unless hash.empty?
+      @id = hash['id'].to_i if hash.include?('id')
+      @name = hash['name'] if hash.include?('name')
+    end
+  end
+
+  def self.delete(id)
+    #puts "delete #{id}"
+    @@people.delete_if {|person| person.id == id.to_i}
+  end
+
+  @@people = []
+
+  def self.all(criteria={})
+    #puts 'all'
+    return @@people
+  end
+
+  def self.find_by_id(id)
+    #puts "find_by_id #{id}"
+    all.find {|f| f.id == id.to_i}
+  end
+
+  def self.clear!
+    @@people = []
+  end
+
+  def self.reset!
+    clear!
+    Person.new(1, 'one').save
+    Person.new(2, 'two').save
+    Person.new(3, 'three').save
+  end
+end
+
+

data/test/helpers_spec.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/helper'
+
+describe 'url helpers' do
+
+  it 'should generate the correct urls for the model' do
+    mock_rest Person do
+      person = Person.new(99, 'foo')
+      url_for_people_create.should == '/people'
+      url_for_people_destroy(person).should == '/people/99'
+      url_for_people_edit(person).should == '/people/99/edit'
+      url_for_people_index.should == '/people'
+      url_for_people_new.should == '/people/new'
+      url_for_people_show(person).should == '/people/99'
+      url_for_people_update(person).should == '/people/99'
+    end
+  end
+
+  it 'should add :all helpers' do
+    mock_rest(Person) { methods.grep(/^url_for_people_/).sort }.should == [
+          "url_for_people_create",
+          "url_for_people_destroy",
+          "url_for_people_edit",
+          "url_for_people_index",
+          "url_for_people_new",
+          "url_for_people_show",
+          "url_for_people_update",
+    ]
+  end
+
+  it 'should add :readable helpers' do
+      mock_rest(Person, :routes => :readable) { methods.grep(/^url_for_people_/).sort }.should == [
+          "url_for_people_index",
+          "url_for_people_show",
+      ]
+  end
+
+  it 'should add :writeable helpers' do
+      mock_rest(Person, :routes => :writeable) { methods.grep(/^url_for_people_/).sort }.should == [
+          "url_for_people_create",
+          "url_for_people_destroy",
+          "url_for_people_index",
+          "url_for_people_show",
+          "url_for_people_update",
+      ]
+  end
+
+  it 'should add :editable helpers' do
+      mock_rest(Person, :routes => :editable) { methods.grep(/^url_for_people_/).sort }.should == [
+          "url_for_people_create",
+          "url_for_people_destroy",
+          "url_for_people_edit",
+          "url_for_people_index",
+          "url_for_people_new",
+          "url_for_people_show",
+          "url_for_people_update",
+      ]
+  end
+
+  it 'should add helpers by name' do
+      mock_rest(Person, :routes => [:new, :create, :destroy]) { methods.grep(/^url_for_people_/).sort }.should == [
+          "url_for_people_create",
+          "url_for_people_destroy",
+          "url_for_people_new",
+      ]
+  end
+  
+  it 'should add helpers by mixing aliases and names' do
+      mock_rest(Person, :routes => [:readable, :create, :destroy]) { methods.grep(/^url_for_people_/).sort }.should == [
+          "url_for_people_create",
+          "url_for_people_destroy",
+          "url_for_people_index",
+          "url_for_people_show",          
+      ]
+  end
+
+end

data/test/inflection_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/helper'
+
+describe 'model inflection' do
+
+  def conjugate(model)
+    mock_app {
+      include Sinatra::REST
+      conjugate(model)
+    }
+  end
+
+  it "should conjugate a simple model name" do
+    conjugate(Person).should == %w(Person person people)
+  end
+
+  it "should conjugate a String as model name" do
+    conjugate('Person').should == %w(Person person people)  
+  end
+
+  it "should conjugate a model name in camel cases" do
+    conjugate('SomePerson').should == %w(SomePerson some_person some_people)
+  end
+
+  it "should conjugate a model name without module" do
+    conjugate('MyModule::ModulePerson').should == %w(ModulePerson module_person module_people)
+  end
+
+end
+

data/test/routes_spec.rb

@@ -0,0 +1,112 @@
+require File.dirname(__FILE__) + '/helper'
+
+describe 'routes' do
+
+  before(:each) do
+    Person.reset!
+  end
+
+  describe 'one by one' do
+
+    before(:each) do
+      mock_rest Person    
+    end
+
+    it 'should list all people on index by their id' do
+      index('/people').should == [200, '<people><person><id>1</id></person><person><id>2</id></person><person><id>3</id></person></people>']
+    end
+
+    it 'should prepare an empty item on new' do
+      new('/people/new').should == [200, '<person><id></id><name></name></person>']
+    end
+
+    it 'should create an item on post' do
+      create('/people', :name => 'new resource').should == [302, 'person created']
+    end
+
+    it 'should show an item on get' do
+      show('/people/1').should == [200, '<person><id>1</id><name>one</name></person>']
+    end
+
+    it 'should get the item for editing' do
+      edit('/people/1/edit').should == [200, '<person><id>1</id><name>one</name></person>']
+    end
+
+    it 'should update an item on put' do
+      update('/people/1', :name => 'another name').should == [302, 'person updated']
+    end
+
+    it 'should destroy an item on delete' do
+      destroy('/people/1').should == [302, 'person destroyed']
+    end
+
+  end
+
+  describe 'options' do
+
+    it 'should add :all routes' do
+      mock_rest Person
+
+      index('/people').should                         == [200, '<people><person><id>1</id></person><person><id>2</id></person><person><id>3</id></person></people>']
+      new('/people/new').should                       == [200, '<person><id></id><name></name></person>']
+      create('/people', :name => 'new person').should == [302, "person created"]
+      show('/people/1').should                        == [200, '<person><id>1</id><name>one</name></person>']
+      edit('/people/1/edit').should                   == [200, "<person><id>1</id><name>one</name></person>"]
+      update('/people/1', :name => 'new name').should == [302, "person updated"]
+      destroy('/people/1').should                     == [302, "person destroyed"]
+    end
+
+    it 'should add :readable routes' do
+      mock_rest Person, :routes => :readable
+
+      index('/people').should                         == [200, '<people><person><id>1</id></person><person><id>2</id></person><person><id>3</id></person></people>']
+      show('/people/1').should                        == [200, '<person><id>1</id><name>one</name></person>']
+      
+      new('/people/new').should                       == [404, "route not found"]
+      create('/people', :name => 'new person').should == [404, "route not found"]
+      edit('/people/1/edit').should                   == [404, "route not found"]
+      update('/people/1', :name => 'new name').should == [404, "route not found"]
+      destroy('/people/1').should                     == [404, "route not found"]
+    end
+
+    it 'should add :writeable routes' do
+      mock_rest Person, :routes => :writeable
+
+      index('/people').should                         == [200, '<people><person><id>1</id></person><person><id>2</id></person><person><id>3</id></person></people>']
+      show('/people/1').should                        == [200, '<person><id>1</id><name>one</name></person>']
+      create('/people', :name => 'new person').should == [302, "person created"]
+      update('/people/1', :name => 'new name').should == [302, "person updated"]
+      destroy('/people/1').should                     == [302, "person destroyed"]
+
+      new('/people/new').should                       == [404, "route not found"]
+      edit('/people/1/edit').should                   == [404, "route not found"]
+    end
+
+    it 'should add :editable routes' do
+      mock_rest Person, :routes => :editable
+
+      index('/people').should                         == [200, '<people><person><id>1</id></person><person><id>2</id></person><person><id>3</id></person></people>']
+      new('/people/new').should                       == [200, '<person><id></id><name></name></person>']
+      create('/people', :name => 'new person').should == [302, "person created"]
+      show('/people/1').should                        == [200, '<person><id>1</id><name>one</name></person>']
+      edit('/people/1/edit').should                   == [200, "<person><id>1</id><name>one</name></person>"]
+      update('/people/1', :name => 'new name').should == [302, "person updated"]
+      destroy('/people/1').should                     == [302, "person destroyed"]
+    end
+
+    it 'should add routes by name' do
+      mock_rest Person, :routes => [:readable, :new, :create]
+
+      index('/people').should                         == [200, '<people><person><id>1</id></person><person><id>2</id></person><person><id>3</id></person></people>']
+      show('/people/1').should                        == [200, '<person><id>1</id><name>one</name></person>']
+      new('/people/new').should                       == [200, '<person><id></id><name></name></person>']
+      create('/people', :name => 'new person').should == [302, "person created"]
+      
+      edit('/people/1/edit').should                   == [404, "route not found"]
+      update('/people/1', :name => 'new name').should == [404, "route not found"]
+      destroy('/people/1').should                     == [404, "route not found"]
+    end
+
+  end
+
+end