restrack 0.0.1

data/lib/restrack/support.rb

@@ -0,0 +1,56 @@
+module RESTRack
+
+  class << self
+    def log; @@log; end
+    def request_log; @@request_log; end
+  end # of class methods
+
+  def self.load_config(file)
+    config = YAML.load_file(file)
+    # Open the logs on spin up.
+    @@log                 ||= Logger.new( config[:LOG] )
+    @@log.level             = Logger.const_get( config[:LOG_LEVEL] )
+    @@request_log         ||= Logger.new( config[:REQUEST_LOG] )
+    @@request_log.level     = Logger.const_get( config[:LOG_LEVEL] )
+    # Do config validations
+    if config[:ROOT_RESOURCE_ACCEPT].is_a?(Array) and config[:ROOT_RESOURCE_ACCEPT].length == 1 and config[:ROOT_RESOURCE_ACCEPT][0].lstrip.rstrip == ''
+      config[:ROOT_RESOURCE_ACCEPT] = nil
+      @@log.warn 'Improper format for RESTRack::CONFIG[:ROOT_RESOURCE_ACCEPT], should be nil or empty array not array containing empty string.'
+    end
+    if not config[:ROOT_RESOURCE_ACCEPT].blank? and not config[:DEFAULT_RESOURCE].blank? and not config[:ROOT_RESOURCE_ACCEPT].include?( config[:DEFAULT_RESOURCE] )
+      @@log.warn 'RESTRack::CONFIG[:DEFAULT_RESOURCE] should be a member of RESTRack::CONFIG[:ROOT_RESOURCE_ACCEPT].'
+    end
+    config
+  end
+
+  def self.mime_type_for(format)
+    MIME::Types.type_for(format.to_s.downcase)[0]
+  end
+
+  def self.resource_exists?(resource_name)
+    klass = controller_class_for( resource_name )
+    return klass.is_a?(Class)
+  rescue NameError
+    return false
+  end
+
+  def self.controller_class_for(resource_name)
+    Kernel.const_get( RESTRack::CONFIG[:SERVICE_NAME].to_sym ).const_get( controller_name(resource_name).to_sym )
+  end
+
+  def self.controller_name(resource_name)
+    "#{resource_name.camelize}Controller".to_sym
+  end
+
+end
+
+# Courtesy of Rails' ActiveSupport, thank you DHH et al.
+class Object
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+end
+
+# We will support ".text" as an extension
+MIME::Types['text/plain'][0].extensions << 'text'
+MIME::Types.index_extensions( MIME::Types['text/plain'][0] )

data/lib/restrack/version.rb

@@ -0,0 +1,3 @@
+module RESTRack
+  VERSION = "0.0.1"
+end

data/lib/restrack/web_service.rb

@@ -0,0 +1,66 @@
+module RESTRack
+  class WebService
+
+    def initialize
+      # Establish the namespace pointer.
+      RESTRack::CONFIG[:SERVICE_NAME] = self.class.to_s.split('::')[0].to_sym
+    end
+
+    def call( env )
+      # Handle requests.
+      request = Rack::Request.new(env)
+      begin
+        resource_request = RESTRack::ResourceRequest.new( :request => request )
+        resource_request.locate
+        resource_request.call
+        response = resource_request.output
+        return valid resource_request, response
+      rescue Exception => exception
+        return caught resource_request, exception
+      end
+    end # method call
+
+    private
+
+    def valid( resource_request, response )
+      # Return HTTP200OK SUCCESS
+      RESTRack.request_log.debug "'#{resource_request.mime_type.to_s}' response data (Request ID: #{resource_request.request_id})\n" + response.to_s unless not response.respond_to?( :to_s )
+      RESTRack.request_log.info "HTTP200OK - (Request ID: #{resource_request.request_id})"
+      return [200, {'Content-Type' => resource_request.content_type}, response ]
+    end
+
+    def caught( resource_request, exception )
+      # Return appropriate response code and messages per raised exception type.
+      if resource_request && resource_request.request_id
+        RESTRack.request_log.info exception.message + "(Request ID: #{resource_request.request_id})"
+      else
+        RESTRack.request_log.info exception.message
+      end
+      case
+        when exception.is_a?( HTTP400BadRequest )
+          return [400, {'Content-Type' => 'text/plain'}, exception.message + "\nThe request cannot be fulfilled due to bad syntax." ]
+        when exception.is_a?( HTTP401Unauthorized )
+          return [401, {'Content-Type' => 'text/plain'}, exception.message + "\nYou have failed authentication for access to the resource." ]
+        when exception.is_a?( HTTP403Forbidden )
+          return [403, {'Content-Type' => 'text/plain'}, exception.message + "\nYou are forbidden to access that resource." ]
+        when exception.is_a?( HTTP404ResourceNotFound )
+          return [404, {'Content-Type' => 'text/plain'}, exception.message + "\nThe resource you requested could not be found." ]
+        when exception.is_a?( HTTP405MethodNotAllowed )
+          return [405, {'Content-Type' => 'text/plain'}, exception.message + "\nThe resource you requested does not support the request method provided." ]
+        when exception.is_a?( HTTP409Conflict )
+          return [409, {'Content-Type' => 'text/plain'}, exception.message + "\nThe resource you requested is in a conflicted state." ]
+        when exception.is_a?( HTTP410Gone )
+          return [410, {'Content-Type' => 'text/plain'}, exception.message + "\nThe resource you requested is no longer available." ]
+        else # HTTP500ServerError
+          msg = exception.message + "\n\n" + exception.backtrace.join("\n")
+          if resource_request && resource_request.request_id
+            RESTRack.log.error msg + " (Request ID: #{resource_request.request_id})\n\n"
+          else
+            RESTRack.log.error msg
+          end
+          return [500, {'Content-Type' => 'text/plain'}, msg ]
+      end # case Exception
+    end # method caught
+
+  end # class WebService
+end # module RESTRack

data/lib/restrack.rb

@@ -0,0 +1,24 @@
+%w[
+  rack
+  logger
+  find
+  yaml
+  rubygems
+  json
+  xmlsimple
+  builder
+  active_support/inflector
+  mime/types
+].each do |file|
+  require file
+end
+
+# Dynamically load all files in lib
+Find.find(  File.join(File.dirname(__FILE__)) ) do |file|
+  next if File.extname(file) != '.rb'
+  puts 'loading file ' + file
+  require file
+end
+
+include HTTPStatus
+include ActiveSupport::Inflector

data/restrack.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "restrack/version"
+
+Gem::Specification.new do |s|
+  s.name        = "restrack"
+  s.version     = RESTRack::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Chris St. John']
+  s.email       = ['chris@stjohnstudios.com']
+  s.homepage    = 'http://github.com/stjohncj'
+  s.summary     = %q{A lightweight MVC framework developed specifically for JSON and XML REST services.}
+  s.description = %q{RESTRack is an MVC framework that makes it extremely easy to develop RESTful data services. It is inspired by Rails, and follows some of its conventions, but aims at being lightweight and easy to use.}
+
+  s.rubyforge_project = "restrack"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency 'xml-simple', '>= 1.0.13'
+  s.add_runtime_dependency 'builder'
+  s.add_runtime_dependency 'activesupport'
+  s.add_runtime_dependency 'mime-types'
+
+end

data/test/sample_app_1/config/constants.yaml

@@ -0,0 +1,25 @@
+#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.
+# This setting ('bazu') won't work because of :ROOT_RESOURCE_ACCEPT VALUE (:DEFAULT_RESOURCE should be a member of :ROOT_RESOURCE_ACCEPT).
+: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:    [ 'foo_bar' ]
+# 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_1/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_1/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_1/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_1/controllers/bazu_controller.rb

@@ -0,0 +1,16 @@
+class SampleApp::BazuController < RESTRack::ResourceController
+
+  def show(id)
+    return 1 if id == 1
+    return 0
+  end
+
+  def index
+    return [
+      { :id => 1, :val => 111 },
+      { :id => 2, :val => 222 },
+      { :id => 3, :val => 333 }
+    ]
+  end
+
+end

data/test/sample_app_1/controllers/foo_bar_controller.rb

@@ -0,0 +1,62 @@
+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)
+    if id == '1234567890'
+      return { :foo => 'abc', :bar => '123', 'baz' => 456, :more => { :one => 1, :two => [1,2], :three => :deep_fu } }
+    end
+    { :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_1/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_1 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_1/test/test_controller_actions.rb

@@ -0,0 +1,122 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/test'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','loader'))
+require 'pp'
+
+class SampleApp::TestControllerActions < Test::Unit::TestCase
+
+  def setup
+    @ws = SampleApp::WebService.new
+  end
+
+  def test_show
+    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_update
+    env = Rack::MockRequest.env_for('/foo_bar/144', {
+      :method => 'PUT'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :success => true }.to_json
+    assert_equal test_val, output[2]
+  end
+
+  def test_add
+    env = Rack::MockRequest.env_for('/foo_bar/144', {
+      :method => 'POST'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :success => true }.to_json
+    assert_equal test_val, output[2]
+  end
+
+  def test_destroy
+    env = Rack::MockRequest.env_for('/foo_bar/144', {
+      :method => 'DELETE'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :success => true }.to_json
+    assert_equal test_val, output[2]
+  end
+
+
+  def test_index
+    env = Rack::MockRequest.env_for('/foo_bar/', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = [1,2,3,4,5,6,7].to_json
+    assert_equal test_val, output[2]
+  end
+
+  def test_replace
+    env = Rack::MockRequest.env_for('/foo_bar', {
+      :method => 'PUT'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :success => true }.to_json
+    assert_equal test_val, output[2]
+  end
+
+  def test_create
+    env = Rack::MockRequest.env_for('/foo_bar/', {
+      :method => 'POST'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :success => true }.to_json
+    assert_equal test_val, output[2]
+  end
+
+  def test_drop
+    env = Rack::MockRequest.env_for('/foo_bar', {
+      :method => 'DELETE'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :success => true }.to_json
+    assert_equal test_val, output[2]
+  end
+
+
+  def test_missing
+    env = Rack::MockRequest.env_for('/foo_bar/144/missing', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal 405, output[0]
+  end
+
+end

data/test/sample_app_1/test/test_controller_modifiers.rb

@@ -0,0 +1,153 @@
+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_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_second_has_relationship_to
+    env = Rack::MockRequest.env_for('/foo_bar/144/slugger', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :WOM => 'BAT!' }.to_json
+    assert_equal test_val, output[2]
+
+    env = Rack::MockRequest.env_for('/foo_bar/133/slugger', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :SUHWING => 'BATTER' }.to_json
+    assert_equal test_val, output[2]
+
+    env = Rack::MockRequest.env_for('/foo_bar/144/slugger/', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :WOM => 'BAT!' }.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