restrack 0.0.1

data/test/sample_app_1/test/test_formats.rb

@@ -0,0 +1,119 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/test'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','loader'))
+require 'pp'
+
+class SampleApp::TestFormats < Test::Unit::TestCase
+
+  def setup
+    @ws = SampleApp::WebService.new
+  end
+
+  def test_show_builder_xml
+    env = Rack::MockRequest.env_for('/foo_bar/144.xml', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><data><foo>bar</foo><baz>123</baz></data>"
+    assert_equal test_val, output[2]
+  end
+
+  def test_show_default_xml
+    env = Rack::MockRequest.env_for('/foo_bar/index.xml', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><data><foo>bar</foo><baz>123</baz></data>"
+    assert_equal test_val, output[2]
+
+    env = Rack::MockRequest.env_for('/foo_bar.xml', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = XmlSimple.xml_out([1,2,3,4,5,6,7])
+    assert_equal test_val, output[2]
+  end
+
+  def test_show_json
+    env = Rack::MockRequest.env_for('/foo_bar/144', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :foo => 'bar', :baz => 123 }.to_json
+    assert_equal test_val, output[2]
+  end
+  #
+  #def test_complex_data_structure
+  #  env = Rack::MockRequest.env_for('/foo_bar/1234567890', {
+  #    :method => 'GET'
+  #  })
+  #  output = ''
+  #  assert_nothing_raised do
+  #    output = @ws.call(env)
+  #  end
+  #  test_val = "{\"foo\":\"abc\",\"baz\":456,\"bar\":\"123\",\"more\":{\"two\":[1,2],\"three\":\"deep_fu\",\"one\":1}}"
+  #  assert_equal test_val, output[2]
+  #  
+  #  env = Rack::MockRequest.env_for('/foo_bar/1234567890.xml', {
+  #    :method => 'GET'
+  #  })
+  #  output = ''
+  #  assert_nothing_raised do
+  #    output = @ws.call(env)
+  #  end
+  #  test_val = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><data><foo>abc</foo><baz>456</baz><bar>123</bar><more><two></data>"
+  #  assert_equal test_val, output[2]
+  #  
+  #  #env = Rack::MockRequest.env_for('/foo_bar/42', {
+  #  #  :method => 'GET'
+  #  #})
+  #  #output = ''
+  #  #assert_nothing_raised do
+  #  #  output = @ws.call(env)
+  #  #end
+  #  ##test_val = {
+  #  ##  :foo => 'abc',
+  #  ##  :bar => 123,
+  #  ##  :baz => {
+  #  ##    'one' => [1],
+  #  ##    'two' => ['1','2'],
+  #  ##    'three' => ['1', 2, {:three => 3}],
+  #  ##    4 => :four
+  #  ##  }
+  #  ##}.to_json
+  #  #assert_equal test_val, output[2]
+  #  #
+  #  #env = Rack::MockRequest.env_for('/foo_bar/42.xml', {
+  #  #  :method => 'GET'
+  #  #})
+  #  #output = ''
+  #  #assert_nothing_raised do
+  #  #  output = @ws.call(env)
+  #  #end
+  #  ##test_val = {
+  #  ##  :foo => 'abc',
+  #  ##  :bar => 123,
+  #  ##  :baz => {
+  #  ##    'one' => [1],
+  #  ##    'two' => ['1','2'],
+  #  ##    'three' => ['1', 2, {:three => 3}],
+  #  ##    4 => :four
+  #  ##  }
+  #  ##}
+  #  #assert_equal test_val, output[2]
+  #end
+
+end

data/test/sample_app_1/test/test_resource_request.rb

@@ -0,0 +1,160 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/test'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','loader'))
+
+class SampleApp::TestResourceRequest < Test::Unit::TestCase
+
+  def setup
+    @ws = SampleApp::WebService.new # init logs
+  end
+
+  def test_locate
+    env = Rack::MockRequest.env_for('/foo_bar', {
+      :method => 'POST',
+      :params => %Q|[
+        {
+          "bar": ""
+        }
+      ]|
+    })
+    request = Rack::Request.new(env)
+    assert_nothing_raised do
+      resource_request = RESTRack::ResourceRequest.new(:request => request)
+      resource_request.locate
+    end
+  end
+
+  def test_initialize
+    env = Rack::MockRequest.env_for('/foo_bar', {
+      :method => 'POST',
+      :params => %Q|[
+        {
+          "bar": "baz"
+        }
+      ]|
+    })
+    request = Rack::Request.new(env)
+    assert_nothing_raised do
+      resource_request = RESTRack::ResourceRequest.new(:request => request)
+    end
+  end
+
+  def test_root_resource_accept
+    # These are the resources which can be accessed from the root of your web service. If left empty, all resources are available at the root.
+    #:ROOT_RESOURCE_ACCEPT:    [ 'foo_bar' ]
+
+    RESTRack::CONFIG[:ROOT_RESOURCE_ACCEPT] = [ 'foo_bar' ]
+    # This should not be allowed because it is not in ROOT_RESOURCE_ACCEPT
+    env = Rack::MockRequest.env_for('/bat/144', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    #test_val = [403, {"Content-Type"=>"text/plain"}, "HTTPStatus::HTTP403Forbidden\nYou are forbidden to access that resource."]
+    assert_equal 403, output[0]
+
+    # This should be allowed
+    env = Rack::MockRequest.env_for('/foo_bar/144', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal 200, output[0]
+
+    RESTRack::CONFIG[:ROOT_RESOURCE_ACCEPT] = []
+    env = Rack::MockRequest.env_for('/foo_bar/144', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal 200, output[0]
+
+    RESTRack::CONFIG[:ROOT_RESOURCE_ACCEPT] = nil
+    env = Rack::MockRequest.env_for('/foo_bar/144', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal 200, output[0]
+
+    RESTRack::CONFIG[:ROOT_RESOURCE_ACCEPT] = [ 'foo_bar' ]
+  end
+
+
+  def test_root_resource_denied
+    ## These are the resources which cannot be accessed from the root of your web service. Use either this or ROOT_RESOURCE_ACCEPT as a blacklist or whitelist to establish routing (relationships defined in resource controllers define further routing).
+    #:ROOT_RESOURCE_DENY:      [ 'baz' ]
+    env = Rack::MockRequest.env_for('/baz/144', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    #test_val = [403, {"Content-Type"=>"text/plain"}, "HTTPStatus::HTTP403Forbidden\nYou are forbidden to access that resource."]
+    assert_equal 403, output[0]
+
+    env = Rack::MockRequest.env_for('/bat/144', {
+      :method => 'GET'
+    })
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_not_equal 200, output[0]
+
+    RESTRack::CONFIG[:ROOT_RESOURCE_DENY] = []
+    env = Rack::MockRequest.env_for('/foo_bar/144', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal 200, output[0]
+
+    RESTRack::CONFIG[:ROOT_RESOURCE_DENY] = nil
+    env = Rack::MockRequest.env_for('/foo_bar/144', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal 200, output[0]
+
+    RESTRack::CONFIG[:ROOT_RESOURCE_DENY] = ['']
+    # it should handle this, although it is incorrect
+    env = Rack::MockRequest.env_for('/foo_bar/144', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal 200, output[0]
+
+    RESTRack::CONFIG[:ROOT_RESOURCE_DENY] = [ 'baz' ]
+  end
+
+  def test_default_resource
+    # This should be handled by bazu_controller
+    env = Rack::MockRequest.env_for('/', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal 403, output[0]
+  end
+
+end

data/test/sample_app_1/test/test_web_service.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/test'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','loader'))
+
+class SampleApp::TestWebService < Test::Unit::TestCase
+
+  def setup
+    @ws = SampleApp::WebService.new # init logs
+  end
+
+  def test_service_name
+    env = Rack::MockRequest.env_for('/foo_bar', {
+      :method => 'POST',
+      :params => %Q|[
+        {
+          "bar": "baz"
+        }
+      ]|
+    })
+    output = ''
+    output = @ws.call(env)
+    assert_nothing_raised do
+      RESTRack::CONFIG[:SERVICE_NAME].to_sym.to_s
+    end
+  end
+end

data/test/sample_app_1/views/foo_bar/show.xml.builder

@@ -0,0 +1,4 @@
+xml.data do
+  xml.foo data[:foo]
+  xml.baz data[:baz]
+end

data/test/sample_app_2/config/constants.yaml

@@ -0,0 +1,24 @@
+#GENERATOR-CONST# -DO NOT REMOVE OR CHANGE THIS LINE- Application-Namespace => SampleApp
+#
+# = constants.yaml
+# This is where RESTRack applications define the constants relevant to their particular
+# application that are used by the RESTRack base classes.
+
+# Application log path definition
+:LOG:                     '/var/log/restrack/sample_app.log'
+# Request log path definition
+:REQUEST_LOG:             '/var/log/restrack/sample_app.request.log'
+
+# Logger object levels
+:LOG_LEVEL:               :WARN     # Logger object level
+:REQUEST_LOG_LEVEL:       :WARN     # Logger object level
+
+# Supported formats are :JSON, :XML, :YAML, :BIN, :TEXT
+:DEFAULT_FORMAT:          :JSON
+# The resource which will handle root level requests where the name is not specified.  Best for users of this not to implement method_missing in their default controller, unless they are checking for bad URI.
+:DEFAULT_RESOURCE:        'bazu'
+
+# These are the resources which can be accessed from the root of your web service. If left empty, all resources are available at the root.
+#:ROOT_RESOURCE_ACCEPT:    []
+# These are the resources which cannot be accessed from the root of your web service. Use either this or ROOT_RESOURCE_ACCEPT as a blacklist or whitelist to establish routing (relationships defined in resource controllers define further routing).
+:ROOT_RESOURCE_DENY:      [ 'baz' ]

data/test/sample_app_2/controllers/bat_controller.rb

@@ -0,0 +1,9 @@
+class SampleApp::BatController < RESTRack::ResourceController
+
+  def show(id)
+    return { :WOM => 'BAT!' } if id == 777
+    return { :WOM => 'NOBAT!' } if id == '777'
+    return { :SUHWING => 'BATTER' }
+  end
+
+end

data/test/sample_app_2/controllers/baz_controller.rb

@@ -0,0 +1,9 @@
+class SampleApp::BazController < RESTRack::ResourceController
+
+  def show(id)
+    return { :BAZ => 'HOLA!' } if id == 777
+    return { :BAZ => 'ALOHA!' } if id == '777'
+    return { :OTHER => 'YUP' }
+  end
+
+end

data/test/sample_app_2/controllers/baza_controller.rb

@@ -0,0 +1,11 @@
+class SampleApp::BazaController < RESTRack::ResourceController
+
+  keyed_with_type Fixnum
+
+  def show(id)
+    return { :BAZA => 'YESSIR' } if id == 1
+    return { :NOWAY => 'JOSE' } if id == 8
+    return { :NOTTODAY => 'JOSEPH' }
+  end
+
+end

data/test/sample_app_2/controllers/bazu_controller.rb

@@ -0,0 +1,8 @@
+class SampleApp::BazuController < RESTRack::ResourceController
+
+  def show(id)
+    return 1 if id == 1
+    return 0
+  end
+
+end

data/test/sample_app_2/controllers/foo_bar_controller.rb

@@ -0,0 +1,59 @@
+class SampleApp::FooBarController < RESTRack::ResourceController
+
+  has_direct_relationship_to( :baz ) do |id|
+    if id =='144'
+      output = '777'
+    else
+      output = '666'
+    end
+    output # You can't "return" from a Proc!  It will do a "return" in the outer method.  Remember a "Proc" is not a Method.
+  end
+
+  has_direct_relationship_to( :bat, :as => :slugger ) do |id|
+    if id =='144'
+      output = '777'
+    else
+      output = '666'
+    end
+    output # You can't "return" from a Proc!  It will do a "return" in the outer method.  Remember a "Proc" is not a Method.
+  end
+
+  has_direct_relationships_to( :baza, :as => :children ) do |id|
+    [1,2,3,4,5,6,7,8,9]
+  end
+
+  has_mapped_relationships_to( :bazu, :as => :maps ) do |id|
+    {
+      :first => 1,
+      :second => 2,
+      :third => 3
+    }
+  end
+
+  def index
+    [1,2,3,4,5,6,7]
+  end
+  def create
+    { :success => true }
+  end
+  def replace
+    { :success => true }
+  end
+  def drop
+    { :success => true }
+  end
+
+  def show(id)
+    { :foo => 'bar', :baz => 123 }
+  end
+  def update(id)
+    { :success => true }
+  end
+  def destroy(id)
+    { :success => true }
+  end
+  def add(id)
+    { :success => true }
+  end
+
+end

data/test/sample_app_2/loader.rb

@@ -0,0 +1,31 @@
+# for development only
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__),'../../lib'))
+#####
+require 'restrack'
+
+module SampleApp; end
+class SampleApp::WebService < RESTRack::WebService; end
+
+RESTRack::CONFIG = RESTRack::load_config(File.join(File.dirname(__FILE__), 'config/constants.yaml'))
+RESTRack::CONFIG[:ROOT] = File.dirname(__FILE__)
+
+# Dynamically load all controllers
+Find.find(  File.join(File.dirname(__FILE__), 'controllers') ) do |file|
+  next if File.extname(file) != '.rb'
+  require file
+end
+
+if File.directory?( File.join(File.dirname(__FILE__), 'models') )
+  # Dynamically load all models
+  Find.find(  File.join(File.dirname(__FILE__), 'models') ) do |file|
+    next if File.extname(file) != '.rb'
+    require file
+  end
+end
+
+puts "sample_app_2 RESTRack::CONFIG:\n"
+config = RESTRack::CONFIG.keys.map {|c| c.to_s }.sort
+config.each do |key|
+  puts "\t" + key + ' => ' + RESTRack::CONFIG[key.to_sym].to_s
+end
+puts "\n"

data/test/sample_app_2/test/test_controller_modifiers.rb

@@ -0,0 +1,121 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/test'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','loader'))
+require 'pp'
+
+class SampleApp::TestControllerModifiers < Test::Unit::TestCase
+
+  def setup
+    @ws = SampleApp::WebService.new
+  end
+
+  def test_has_direct_relationship_to
+    env = Rack::MockRequest.env_for('/foo_bar/144/baz', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :BAZ => 'HOLA!' }.to_json
+    assert_equal test_val, output[2]
+
+    env = Rack::MockRequest.env_for('/foo_bar/133/baz', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :OTHER => 'YUP' }.to_json
+    assert_equal test_val, output[2]
+
+    env = Rack::MockRequest.env_for('/foo_bar/144/baz/', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :BAZ => 'HOLA!' }.to_json
+    assert_equal test_val, output[2]
+  end
+
+  def test_has_direct_relationships_to
+    env = Rack::MockRequest.env_for('/foo_bar/133/children/1', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :BAZA => 'YESSIR' }.to_json
+    assert_equal test_val, output[2]
+
+    env = Rack::MockRequest.env_for('/foo_bar/133/children/8', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :NOWAY => 'JOSE' }.to_json
+    assert_equal test_val, output[2]
+
+    env = Rack::MockRequest.env_for('/foo_bar/133/children/11', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal 404, output[0]
+  end
+
+  def test_has_mapped_relationships_to
+    env = Rack::MockRequest.env_for('/foo_bar/133/maps/first', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = '1'
+    assert_equal test_val, output[2]
+
+    env = Rack::MockRequest.env_for('/foo_bar/133/maps/second', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = '0'
+    assert_equal test_val, output[2]
+
+    env = Rack::MockRequest.env_for('/foo_bar/133/maps/third', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = '0'
+    assert_equal test_val, output[2]
+  end
+
+  def test_keyed_with_type
+    # baza controller exercises this option
+    env = Rack::MockRequest.env_for('/foo_bar/133/children/1', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :BAZA => 'YESSIR' }.to_json
+    assert_equal test_val, output[2]
+  end
+
+end

data/test/sample_app_2/test/test_resource_request.rb

@@ -0,0 +1,71 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/test'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','loader'))
+
+class SampleApp::TestResourceRequest < Test::Unit::TestCase
+
+  def setup
+    @ws = SampleApp::WebService.new # init logs
+  end
+
+## These are the resources which can be accessed from the root of your web service. If left empty, all resources are available at the root.
+##:ROOT_RESOURCE_ACCEPT:    []
+## These are the resources which cannot be accessed from the root of your web service. Use either this or ROOT_RESOURCE_ACCEPT as a blacklist or whitelist to establish routing (relationships defined in resource controllers define further routing).
+#:ROOT_RESOURCE_DENY:      [ 'baz' ]
+  def test_root_resource_denied
+    env = Rack::MockRequest.env_for('/baz/144', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    #test_val = [403, {"Content-Type"=>"text/plain"}, "HTTPStatus::HTTP403Forbidden\nYou are forbidden to access that resource."]
+    assert_equal 403, output[0]
+
+    env = Rack::MockRequest.env_for('/bat/144', {
+      :method => 'GET'
+    })
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    #test_val = [403, {"Content-Type"=>"text/plain"}, "HTTPStatus::HTTP403Forbidden\nYou are forbidden to access that resource."]
+    assert_not_equal 403, output[0]
+  end
+
+  def test_root_resource_accept
+    env = Rack::MockRequest.env_for('/foo_bar/144', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    #test_val = [403, {"Content-Type"=>"text/plain"}, "HTTPStatus::HTTP403Forbidden\nYou are forbidden to access that resource."]
+    assert_not_equal 403, output[0]
+  end
+
+  def test_default_resource
+    # This should be handled by bazu_controller
+    env = Rack::MockRequest.env_for('/', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    # no index method defined/allowed
+    assert_equal 405, output[0]
+
+    # This should be handled by bazu_controller
+    env = Rack::MockRequest.env_for('/123', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal 200, output[0]
+  end
+end

data/test/sample_app_2/views/foo_bar/show.xml.builder

@@ -0,0 +1,4 @@
+xml.data do
+  xml.foo data[:foo]
+  xml.baz data[:baz]
+end