restrack 0.0.3 → 0.0.5

data/README.rdoc

@@ -22,7 +22,7 @@
 
 
 == Why RESTRack when there is Rails?
-  Rails is a powerful tool for full web applications.  RESTRack is targetted at
+  Rails is a powerful tool for full web applications.  RESTRack is targeted at
   making development of lightweight data services as easy as possible, while
   still giving you a performant and extensible framework.  The primary goal of
   the framework was to add as little as possible to the framework to give the
@@ -47,6 +47,7 @@
 == How-Tos
 
   ...yet to be done...
+  === Authentication Suggestions
 
   === Logging/Logging Level
   

data/Rakefile

@@ -7,8 +7,15 @@ Bundler::GemHelper.install_tasks
 task :default => [:test_all]
 
 desc 'Run all tests.'
-Rake::TestTask.new('test_all') { |t|
-  t.pattern = 'test/**/test_*.rb'
+task :test_all do
+  for n in 0..4
+    Rake::Task['test'+n.to_s].invoke
+  end
+end
+
+desc 'Run base tests.'
+Rake::TestTask.new('test0') { |t|
+  t.pattern = 'test/test_*.rb'
 }
 
 desc 'Run sample_app_1 tests.'

data/lib/restrack/generator/config.ru.erb

@@ -0,0 +1,3 @@
+# Rails.root/config.ru
+require 'loader'
+run <%= @service_name.camelize %>::WebService.new

data/lib/restrack/generator.rb

@@ -7,14 +7,15 @@ module RESTRack
   class Generator
     TEMPLATE = {
       :service    => 'loader.rb.erb',
+      :rackup     => 'config.ru.erb',
       :constants  => 'constants.yaml.erb',
       :controller => 'controller.rb.erb'
     }
     
     class << self
       
+      # Generate controller file
       def generate_controller(name)
-        # Generate controller file
         template = get_template_for( :controller )
         resultant_string = template.result( get_binding_for_controller( name ) )
         File.open("#{base_dir}/controllers/#{name}_controller.rb", 'w') {|f| f.puts resultant_string }
@@ -22,6 +23,7 @@ module RESTRack
         FileUtils.makedirs("#{name}/views")
       end
   
+      # Generate a new RESTRack service
       def generate_service(name)
         FileUtils.makedirs("#{name}/config")
         FileUtils.makedirs("#{name}/controllers")
@@ -33,6 +35,10 @@ module RESTRack
         resultant_string = template.result( get_binding_for_service( name ) )
         File.open("#{name}/loader.rb", 'w') {|f| f.puts resultant_string }
         
+        template = get_template_for( :rackup )
+        resultant_string = template.result( get_binding_for_service( name ) )
+        File.open("#{name}/config.ru", 'w') {|f| f.puts resultant_string }
+        
         template = get_template_for( :constants )
         resultant_string = template.result( get_binding_for_service( name ) )
         File.open("#{name}/config/constants.yaml", 'w') {|f| f.puts resultant_string }

data/lib/restrack/resource_controller.rb

@@ -1,10 +1,25 @@
 module RESTRack
+  # All RESTRack controllers descend from ResourceController.
+  
+  #                    HTTP Verb: |    GET    |   PUT     |   POST    |   DELETE
+  # Collection URI (/widgets/):   |   index   |   replace |   create  |   drop
+  # Element URI   (/widgets/42):  |   show    |   update  |   add     |   destroy
+
+  #def index;       end
+  #def replace;     end
+  #def create;      end
+  #def drop;        end
+  #def show(id);    end
+  #def update(id);  end
+  #def add(id);     end
+  #def destroy(id); end
+  
   class ResourceController
     attr_reader :input, :output
 
+    # Base initialization method for resources and storage of request input
+    # This method should not be overriden in decendent classes.
     def self.__init(resource_request)
-      # Base initialization method for resources and storage of request input
-      # This method should not be overriden in decendent classes.
       __self = self.new
       return __self.__init(resource_request)
     end
@@ -14,33 +29,20 @@ module RESTRack
       self
     end
 
+    # Call the controller's action and return it in the proper format.
     def call
-      # Call the controller's action and return it in the proper format.
       args = []
       args << @resource_request.id unless @resource_request.id.blank?
       package( self.send(@resource_request.action.to_sym, *args) )
     end
 
-    #                    HTTP Verb: |    GET    |   PUT     |   POST    |   DELETE
-    # Collection URI (/widgets/):   |   index   |   replace |   create  |   drop
-    # Element URI   (/widgets/42):  |   show    |   update  |   add     |   destroy
-
-    #def index;       end
-    #def replace;     end
-    #def create;      end
-    #def drop;        end
-    #def show(id);    end
-    #def update(id);  end
-    #def add(id);     end
-    #def destroy(id); end
-
     def method_missing(method_sym, *arguments, &block)
       raise HTTP405MethodNotAllowed, 'Method not provided on controller.'
     end
 
     protected # all internal methods are protected rather than private so that calling methods *could* be overriden if necessary.
+    # This method allows one to access a related resource, without providing a direct link to specific relation(s).
     def self.has_relationship_to(entity, opts = {})
-      # This method allows one to access a related resource, without providing a direct link to specific relation(s).
       entity_name = opts[:as] || entity
       define_method( entity_name.to_sym,
         Proc.new do
@@ -56,11 +58,11 @@ module RESTRack
       )
     end
 
+    # This method defines that there is a single link to a member from an entity collection.
+    # The second parameter is an options hash to support setting the local name of the relation via ':as => :foo'.
+    # The third parameter to the method is a Proc which accepts the calling entity's id and returns the id of the relation to which we're establishing the link.
+    # This adds an accessor instance method whose name is the entity's class.
     def self.has_direct_relationship_to(entity, opts = {}, &get_entity_id_from_relation_id)
-      # This method defines that there is a single link to a member from an entity collection.
-      # The second parameter is an options hash to support setting the local name of the relation via ':as => :foo'.
-      # The third parameter to the method is a Proc which accepts the calling entity's id and returns the id of the relation to which we're establishing the link.
-      # This adds an accessor instance method whose name is the entity's class.
       entity_name = opts[:as] || entity
       define_method( entity_name.to_sym,
         Proc.new do
@@ -73,9 +75,9 @@ module RESTRack
       )
     end
 
+    # This method defines that there are multiple links to members from an entity collection (an array of entity identifiers).
+    # This adds an accessor instance method whose name is the entity's class.
     def self.has_direct_relationships_to(entity, opts = {}, &get_entity_id_from_relation_id)
-      # This method defines that there are multiple links to members from an entity collection (an array of entity identifiers).
-      # This adds an accessor instance method whose name is the entity's class.
       entity_name = opts[:as] || entity
       define_method( entity_name.to_sym,
         Proc.new do
@@ -91,9 +93,9 @@ module RESTRack
       )
     end
 
+    # This method defines that there are mapped links to members from an entity collection (a hash of entity identifiers).
+    # This adds an accessor instance method whose name is the entity's class.
     def self.has_mapped_relationships_to(entity, opts = {}, &get_entity_id_from_relation_id)
-      # This method defines that there are mapped links to members from an entity collection (a hash of entity identifiers).
-      # This adds an accessor instance method whose name is the entity's class.
       entity_name = opts[:as] || entity
       define_method( entity_name.to_sym,
         Proc.new do
@@ -109,17 +111,17 @@ module RESTRack
       )
     end
 
+    # Call the child relation (next entity in the path stack)
+    # common logic to all relationship methods
     def call_relation(entity)
-      # Call the child relation (next entity in the path stack)
-      # common logic to all relationship methods
       @resource_request.resource_name = entity.to_s.camelize
       setup_action
       @resource_request.locate
       @resource_request.call
     end
 
+    # If the action is not set with the request URI, determine the action from HTTP Verb.
     def setup_action
-      # If the action is not set with the request URI, determine the action from HTTP Verb.
       if @resource_request.action.blank?
         if @resource_request.request.get?
           @resource_request.action = @resource_request.id.blank? ? :index   : :show
@@ -135,13 +137,13 @@ module RESTRack
       end
     end
 
+    # Allows decendent controllers to set a data type for the id other than the default.
     def self.keyed_with_type(klass)
-      # Allows decendent controllers to set a data type for the id other than the default.
       @@key_type = klass
     end
 
+    # This method is used to convert the id coming off of the path stack, which is in string form, into another data type if one has been set.
     def format_id
-      # This method is used to convert the id coming off of the path stack, which is in string form, into another data type if one has been set.
       @@key_type ||= nil
       unless @@key_type.blank?
         if @@key_type == Fixnum
@@ -156,8 +158,8 @@ module RESTRack
       end
     end
 
+    # This handles outputing properly formatted content based on the file extension in the URL.
     def package(data)
-      # This handles outputing properly formatted content based on the file extension in the URL.
       if @resource_request.mime_type.like?( RESTRack.mime_type_for( :JSON ) )
         @output = data.to_json
       elsif @resource_request.mime_type.like?( RESTRack.mime_type_for( :XML ) )
@@ -175,8 +177,8 @@ module RESTRack
       end
     end
 
+    # Use Builder to generate the XML.
     def builder_up(data)
-      # Use Builder to generate the XML
       buffer = ''
       xml = Builder::XmlMarkup.new(:target => buffer)
       xml.instruct!
@@ -184,6 +186,7 @@ module RESTRack
       return buffer
     end
 
+    # Builds the path to the builder file for the current controller action.
     def builder_file
       "#{RESTRack::CONFIG[:ROOT]}/views/#{@resource_request.resource_name.underscore}/#{@resource_request.action}.xml.builder"
     end

data/lib/restrack/resource_request.rb

@@ -1,11 +1,12 @@
 module RESTRack
+  # The ResourceRequest class handles all incoming requests.
   class ResourceRequest
     attr_reader :request, :request_id, :input
     attr_accessor :mime_type, :path_stack, :resource_name, :action, :id
 
+    # Initialize the ResourceRequest by assigning a request_id and determining the path, format, and controller of the resource.
+    # Accepting options to allow us to override request_id for testing.
     def initialize(opts)
-      # Initialize the ResourceRequest by assigning a request_id and determining the path, format, and controller of the resource.
-      # Accepting options just to allow us to override request_id for testing.
       @request = opts[:request]
       @request_id = opts[:request_id] || get_request_id
 
@@ -28,21 +29,21 @@ module RESTRack
       raise HTTP403Forbidden if not RESTRack::CONFIG[:ROOT_RESOURCE_DENY].blank? and RESTRack::CONFIG[:ROOT_RESOURCE_DENY].include?(@resource_name)
     end
 
+    # Locate the correct controller of resource based on the request.
+    # The resource requested must be a member of RESTRack application or a 404 error will be thrown by RESTRack::WebService.
     def locate
-      # Locate the correct controller of resource based on the request.
-      # The resource requested must be a member of RESTRack application or a 404 error will be thrown by RESTRack::WebService.
       RESTRack.log.debug "{#{@request_id}} Locating Resource"
       @resource = instantiate_controller
     end
 
+    # Pass along the `call` method to the typed resource object, this must occur after a call to locate.
     def call
-      # Pass along the `call` method to the typed resource object, this must occur after a call to locate.
       RESTRack.log.debug "{#{@request_id}} Processing Request"
       @resource.call
     end
 
+    # Send out the typed resource's output, this must occur after a call to run.
     def output
-      # Send out the typed resource's output, this must occur after a call to run.
       RESTRack.log.debug "{#{@request_id}} Retrieving Output"
       @resource.output
     end
@@ -77,8 +78,8 @@ module RESTRack
       input
     end
 
+    # Remove the extension from the URL if present, that will be used to determine content-type.
     def split_extension_from(path_stack)
-      # Remove the extension from the URL if present, that will be used to determine content-type.
       extension = ''
       unless path_stack.nil?
         path_stack = path_stack.sub(/\.([^.]*)$/) do |s|
@@ -122,8 +123,8 @@ module RESTRack
       [id, action, path_stack]
     end
 
+    # Called from the locate method, this method dynamically finds the class based on the URI and instantiates an object of that class via the __init method on RESTRack::ResourceController.
     def instantiate_controller
-      # Called from the locate method, this method dynamically finds the class based on the URI and instantiates an object of that class via the __init method on RESTRack::ResourceController.
       begin
         return RESTRack.controller_class_for( @resource_name ).__init(self)
       rescue

data/lib/restrack/support.rb

@@ -1,4 +1,7 @@
 module RESTRack
+  require 'mime/types'
+  require 'yaml'
+  require 'logger'
 
   class << self
     def log; @@log; end
@@ -44,8 +47,8 @@ module RESTRack
 
 end
 
-# Courtesy of Rails' ActiveSupport, thank you DHH et al.
 class Object
+  # Courtesy of Rails' ActiveSupport, thank you DHH et al.
   def blank?
     respond_to?(:empty?) ? empty? : !self
   end

data/lib/restrack/version.rb

@@ -1,3 +1,3 @@
 module RESTRack
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/lib/restrack/web_service.rb

@@ -1,13 +1,13 @@
 module RESTRack
   class WebService
 
+    # Establish the namespace pointer.
     def initialize
-      # Establish the namespace pointer.
       RESTRack::CONFIG[:SERVICE_NAME] = self.class.to_s.split('::')[0].to_sym
     end
 
+    # Handle requests in the Rack way.
     def call( env )
-      # Handle requests.
       request = Rack::Request.new(env)
       begin
         resource_request = RESTRack::ResourceRequest.new( :request => request )
@@ -22,15 +22,15 @@ module RESTRack
 
     private
 
+    # Return HTTP200OK SUCCESS
     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
 
+    # Return appropriate response code and messages per raised exception type.
     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

data/lib/restrack.rb

@@ -16,7 +16,6 @@ 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
 

data/test/test_support.rb

@@ -1,14 +1,18 @@
 require 'rubygems'
 require 'test/unit'
-require File.expand_path(File.join(File.dirname(__FILE__),'../lib/restrack'))
+require File.expand_path(File.join(File.dirname(__FILE__),'../lib/restrack/support'))
 
 module RESTRack
   class TestSupport < Test::Unit::TestCase
 
+    RESTRack::CONFIG = RESTRack.load_config(File.expand_path(File.join(File.dirname(__FILE__),'../test/sample_app_1/config/constants.yaml')))
+
     def test_constants
       assert_nothing_raised do
         RESTRack::CONFIG[:LOG].to_sym.to_s
+        RESTRack::CONFIG[:LOG_LEVEL].to_sym.to_s
         RESTRack::CONFIG[:REQUEST_LOG].to_sym.to_s
+        RESTRack::CONFIG[:REQUEST_LOG_LEVEL].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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: restrack
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Chris St. John
@@ -118,9 +118,9 @@ files:
 - README.rdoc
 - Rakefile
 - bin/restrack
-- config/constants.yaml
 - lib/restrack.rb
 - lib/restrack/generator.rb
+- lib/restrack/generator/config.ru.erb
 - lib/restrack/generator/constants.yaml.erb
 - lib/restrack/generator/controller.rb.erb
 - lib/restrack/generator/loader.rb.erb

data/config/constants.yaml

@@ -1,8 +0,0 @@
-:LOG:                     '/var/log/restrack/restrack.log'
-:REQUEST_LOG:             '/var/log/restrack/restrack.request.log'
-:LOG_LEVEL:               DEBUG     # Logger object level
-:REQUEST_LOG_LEVEL:       DEBUG     # Logger object level
-:DEFAULT_FORMAT:          :JSON                     # Supported formats are :JSON, :XML, :YAML, :BIN, :TEXT
-:DEFAULT_RESOURCE:        ''                        # 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 should be a member of :ROOT_RESOURCE_ACCEPT.
-: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_DENY:      []                        # 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).