restrack 0.0.1

data/test/sample_app_3/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:               :DEBUG     # Logger object level
+:REQUEST_LOG_LEVEL:       :DEBUG     # 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:    [ 'baz' ]
+# 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:      []

data/test/sample_app_3/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_3/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_3/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_3/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_3/controllers/foo_bar_controller.rb

@@ -0,0 +1,59 @@
+class SampleApp::FooBarController < RESTRack::ResourceController
+
+  has_direct_relationship_to( :baz, :as => :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_3/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_3 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_3/test/test_resource_request.rb

@@ -0,0 +1,42 @@
+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:    [ 'baz' ]
+## 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:      []
+  def test_root_resource_denied
+    # ROOT_RESOURCE_DENY is not supplied, baz is an allowed resource
+    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_not_equal 403, output[0]
+  end
+
+  def test_root_resource_accept
+    # this resource is not in ROOT_RESOURCE_ACCEPT, which is set to ['baz']
+    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_equal 403, output[0]
+  end
+
+end

data/test/sample_app_3/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_4/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:               :DEBUG     # Logger object level
+:REQUEST_LOG_LEVEL:       :DEBUG     # 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:        ''
+
+# 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:      [ '' ]

data/test/sample_app_4/controllers/bar_controller.rb

@@ -0,0 +1,11 @@
+class SampleApp::BarController < RESTRack::ResourceController
+
+  def index
+    [0,1,2,3]
+  end
+
+  def show(id)
+    data = "Hello from Bar with id of #{id}."
+  end
+
+end

data/test/sample_app_4/controllers/baz_controller.rb

@@ -0,0 +1,15 @@
+class SampleApp::BazController < RESTRack::ResourceController
+
+  def initialize
+    @resource_request.mime_type = RESTRack.mime_type_for(:JSON)
+  end
+
+  def index
+    ['cat', 'dog', 'rat', 'emu']
+  end
+
+  def show(id)
+    data = { id => "Hello from Bazzz." }
+  end
+
+end

data/test/sample_app_4/controllers/foo_controller.rb

@@ -0,0 +1,21 @@
+class SampleApp::FooController < RESTRack::ResourceController
+
+  has_relationship_to( :bar )
+  has_relationship_to( :baz, :as => :bazzz )
+
+  def show_yaml(id)
+    @resource_request.mime_type = RESTRack.mime_type_for('yaml')
+    data = { :foo => id, :baz => 'bat' }
+  end
+
+  def show_text(id)
+    @resource_request.mime_type = RESTRack.mime_type_for('text')
+    data = "Hello #{id}!"
+  end
+
+  def show_image(id)
+    @resource_request.mime_type = RESTRack.mime_type_for('png')
+    data = File.read(File.join(File.dirname(__FILE__),'../views/alphatest.png'))
+  end
+
+end

data/test/sample_app_4/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_4 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_4/test/test_controller_modifiers.rb

@@ -0,0 +1,28 @@
+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_relationship_to
+    env = Rack::MockRequest.env_for('/foo/123/bar', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = [0,1,2,3].to_json
+    assert_equal test_val, output[2]
+
+
+    #"Hello from Bar with id of
+  end
+
+end

data/test/sample_app_4/test/test_formats.rb

@@ -0,0 +1,49 @@
+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
+
+  # Test YAML, text, and an image format
+  def test_yaml
+    env = Rack::MockRequest.env_for('/foo/123/show_yaml', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = YAML.dump( { :foo => '123', :baz => 'bat' } )
+    assert_equal test_val, output[2]
+  end
+
+  def test_text
+    env = Rack::MockRequest.env_for('/foo/123/show_text', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = 'Hello 123!'
+    assert_equal test_val, output[2]
+  end
+
+  def test_image
+    env = Rack::MockRequest.env_for('/foo/123/show_image', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal output[2].length, 26529
+  end
+
+end

data/test/test_support.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'test/unit'
+require File.expand_path(File.join(File.dirname(__FILE__),'../lib/restrack'))
+
+module RESTRack
+  class TestSupport < Test::Unit::TestCase
+
+    def test_constants
+      assert_nothing_raised do
+        RESTRack::CONFIG[:LOG].to_sym.to_s
+        RESTRack::CONFIG[:REQUEST_LOG].to_sym.to_s
+        RESTRack::CONFIG[:DEFAULT_FORMAT].to_sym.to_s
+        RESTRack::CONFIG[:DEFAULT_RESOURCE].to_sym.to_s
+        assert RESTRack::CONFIG[:ROOT_RESOURCE_ACCEPT].blank? || RESTRack::CONFIG[:ROOT_RESOURCE_ACCEPT].class == Array
+        assert RESTRack::CONFIG[:ROOT_RESOURCE_DENY].blank? || RESTRack::CONFIG[:ROOT_RESOURCE_DENY].class == Array
+      end
+    end
+
+  end
+end

data/test/test_web_service.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/test'
+require File.expand_path(File.join(File.dirname(__FILE__),'../lib/restrack'))
+
+module RESTRack
+  class TestWebService < Test::Unit::TestCase
+
+    def test_call
+      env = Rack::MockRequest.env_for('/foo', {
+        :method => 'POST',
+        :params => %Q|[
+          {
+            "bar": "baz"
+          }
+        ]|
+      })
+      assert_nothing_raised do
+        ws = RESTRack::WebService.new # init logs
+        ws.call(env)
+      end
+    end
+
+    def test_initialize
+      assert_nothing_raised do
+        ws = RESTRack::WebService.new
+      end
+    end
+
+  end # class TestWebService
+end # module RESTRack