restrack 1.6.4 → 1.6.5

data/Rakefile

@@ -37,3 +37,9 @@ desc 'Run sample_app_4 tests.'
 Rake::TestTask.new('test4') { |t|
   t.pattern = 'test/sample_app_4/**/test_*.rb'
 }
+
+
+desc 'Run sample_app_5 tests.'
+Rake::TestTask.new('test5') { |t|
+  t.pattern = 'test/sample_app_5/**/test_*.rb'
+}

data/lib/restrack/generator/hooks.rb.erb

@@ -0,0 +1,14 @@
+module RESTRack
+  class Hooks
+    # Use this to execute a code block prior to all requests handled by your service.
+    # For example, to do database connection per request you could establish db connections and transactions here.
+    def pre_processor(request)
+
+    end
+    # Use this to execute code after all requests handled by your service.
+    # For example, to do database connection per request you could commit transactions and/or teardown db connections here.
+    def post_processor(request)
+
+    end
+  end # class Hooks
+end # module RESTRack

data/lib/restrack/generator/loader.rb.erb

@@ -6,6 +6,8 @@ class <%= @service_name.camelize %>::WebService < RESTRack::WebService; end
 RESTRack::CONFIG = RESTRack::load_config(File.join(File.dirname(__FILE__), 'config/constants.yaml'))
 RESTRack::CONFIG[:ROOT] = File.dirname(__FILE__)
 
+require File.join(RESTRack::CONFIG[:ROOT], 'hooks') if File.exists?(File.join(RESTRack::CONFIG[:ROOT], 'hooks'))
+
 # Dynamically load all controllers
 Find.find(  File.join(File.dirname(__FILE__), 'controllers') ) do |file|
   next if File.extname(file) != '.rb'

data/lib/restrack/generator.rb

@@ -5,17 +5,18 @@ require 'active_support/inflector'
 
 module RESTRack
   class Generator
-    
+
     TEMPLATE = {
       :service                => 'loader.rb.erb',
       :rackup                 => 'config.ru.erb',
       :constants              => 'constants.yaml.erb',
       :controller             => 'controller.rb.erb',
-      :descendant_controller  => 'descendant_controller.rb.erb'
+      :descendant_controller  => 'descendant_controller.rb.erb',
+      :hooks                  => 'hooks.rb.erb'
     }
-    
+
     class << self
-      
+
       # Generate controller file
       def generate_controller(name)
         template = get_template_for( :controller )
@@ -24,7 +25,7 @@ module RESTRack
         # Generate view folder for controller
         FileUtils.makedirs("#{base_dir}/views/#{name}")
       end
-      
+
       # Generate controller file the descends from specified parent, to enable
       # grouping of controller types and/or overarching functionality.
       def generate_descendant_controller(name, parent)
@@ -34,7 +35,7 @@ module RESTRack
         # Generate view folder for controller
         FileUtils.makedirs("#{base_dir}/views/#{name}")
       end
-  
+
       # Generate a new RESTRack service
       def generate_service(name)
         FileUtils.makedirs("#{name}/config")
@@ -42,45 +43,49 @@ module RESTRack
         FileUtils.makedirs("#{name}/models")
         FileUtils.makedirs("#{name}/test")
         FileUtils.makedirs("#{name}/views")
-        
+
         template = get_template_for( :service )
         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 }
+
+        template = get_template_for( :hooks )
+        resultant_string = template.result( get_binding_for_service( name ) )
+        File.open("#{name}/hooks.rb", 'w') {|f| f.puts resultant_string }
       end
-  
+
       private
-  
+
       def get_template_for(type)
         template_file = File.new(File.join(File.dirname(__FILE__),"generator/#{TEMPLATE[type]}"))
         template = ERB.new( template_file.read, nil, "%" )
       end
-  
+
       def get_binding_for_controller(name)
         @name = name
         @service_name = get_service_name
         binding
       end
-      
+
       def get_binding_for_descendant_controller(name, parent)
         @name = name
         @parent = parent
         @service_name = get_service_name
         binding
       end
-  
+
       def get_binding_for_service(name)
         @service_name = name
         binding
       end
-  
+
       def get_service_name
         line = ''
         begin
@@ -96,7 +101,7 @@ module RESTRack
         end
         return service_name
       end
-  
+
       def base_dir
         base_dir = nil
         this_path = File.join( Dir.pwd, 'config/constants.yaml')
@@ -111,7 +116,7 @@ module RESTRack
         raise 'The config/constants.yaml file could not found when determining base_dir!' unless base_dir
         return base_dir
       end
-    
+
     end # class << self
 
   end # class

data/lib/restrack/version.rb

@@ -1,3 +1,3 @@
 module RESTRack
-  VERSION = "1.6.4"
+  VERSION = "1.6.5"
 end

data/lib/restrack/web_service.rb

@@ -4,12 +4,19 @@ module RESTRack
     # Establish the namespace pointer.
     def initialize
       RESTRack::CONFIG[:SERVICE_NAME] = self.class.to_s.split('::')[0].to_sym
+      @request_hook = RESTRack::Hooks.new if RESTRack.const_defined?(:Hooks)
     end
 
     # Handle requests in the Rack way.
     def call( env )
       resource_request = RESTRack::ResourceRequest.new( :request => Rack::Request.new(env) )
+      unless @request_hook.nil? or (RESTRack::CONFIG.has_key?(:PRE_PROCESSOR_DISABLED) and RESTRack::CONFIG[:PRE_PROCESSOR_DISABLED])
+        @request_hook.pre_processor(resource_request)
+      end
       response = RESTRack::Response.new(resource_request)
+      unless @request_hook.nil? or (RESTRack::CONFIG.has_key?(:POST_PROCESSOR_DISABLED) and RESTRack::CONFIG[:POST_PROCESSOR_DISABLED])
+        @request_hook.post_processor(resource_request)
+      end
       return response.output
     end # method call
 

data/test/sample_app_1/config/constants.yaml

@@ -27,11 +27,13 @@
 # The stack trace will not be added to 500 response body by default, set to true to enable.
 :SHOW_STACK:              true
 
+# :TRANSCODE: and :FORCE_ENCODING: are optional config settings
 # String#encode will be called when this value is set
 #:TRANSCODE:               ISO-8859-1  #or UTF-8 etc
 # String#force_encoding will be called when this value is set
 #:FORCE_ENCODING:          ISO-8859-1
 
+# :CORS: is an optional config setting
 # CORS Header configuration
 #   Supported:
 #    - Access-Control-Allow-Origin: http://localhost
@@ -48,3 +50,7 @@
 #:CORS:
 #  Access-Control-Allow-Origin: http://restrack.me
 #  Access-Control-Allow-Methods: POST, GET
+
+# :PRE_PROCESSOR_DISABLED: and :POST_PROCESSOR_DISABLED: are optional config settings and are false by default
+#:PRE_PROCESSOR_DISABLED:  true
+#:POST_PROCESSOR_DISABLED:  true

data/test/sample_app_5/config/constants.yaml

@@ -0,0 +1,24 @@
+#GENERATOR-CONST# -DO NOT REMOVE OR CHANGE THIS LINE- Application-Namespace => sample_app_5
+#
+# = 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_5.log'
+# Request log path definition
+:REQUEST_LOG:             '/var/log/restrack/sample_app_5.request.log'
+
+# Logger object levels
+:LOG_LEVEL:               :DEBUG
+:REQUEST_LOG_LEVEL:       :DEBUG
+
+# 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:        nil
+
+# 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_5/config.ru

@@ -0,0 +1,3 @@
+# rackup config.ru
+require File.join(File.dirname(__FILE__),'loader')
+run SampleApp5::WebService.new

data/test/sample_app_5/controllers/hook_controller.rb

@@ -0,0 +1,11 @@
+class SampleApp5::HookController < RESTRack::ResourceController
+
+  def show(id)
+    if id == 'pre_processor'
+      { 'pre_processor_flag' => @resource_request.instance_variable_get(:@pre_processor_executed).to_s }
+    else
+      { 'neither' => true }
+    end
+  end
+
+end

data/test/sample_app_5/hooks.rb

@@ -0,0 +1,14 @@
+module RESTRack
+  class Hooks
+    # Use this to execute a code block prior to all requests handled by your service.
+    # For example, to do database connection per request you could establish db connections and transactions here.
+    def pre_processor(request)
+      request.instance_variable_set(:@pre_processor_executed, true)
+    end
+    # Use this to execute code after all requests handled by your service.
+    # For example, to do database connection per request you could commit transactions and/or teardown db connections here.
+    def post_processor(request)
+      $post_processor_executed = true
+    end
+  end # class Hooks
+end # module RESTRack

data/test/sample_app_5/loader.rb

@@ -0,0 +1,26 @@
+# for development only
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__),'../../lib'))
+#####
+require 'restrack'
+
+module SampleApp5; end
+class SampleApp5::WebService < RESTRack::WebService; end
+
+RESTRack::CONFIG = RESTRack::load_config(File.join(File.dirname(__FILE__), 'config/constants.yaml'))
+RESTRack::CONFIG[:ROOT] = File.dirname(__FILE__)
+
+require File.join(RESTRack::CONFIG[:ROOT], 'hooks') if File.exists?(File.join(RESTRack::CONFIG[:ROOT], 'hooks'))
+
+# 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

data/test/sample_app_5/test/test_hooks.rb

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/test'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','loader'))
+require 'pp'
+
+class SampleApp5::TestHooks < Test::Unit::TestCase
+
+  def setup
+    @ws = SampleApp5::WebService.new
+  end
+
+  def test_pre_processor_enabled
+    env = Rack::MockRequest.env_for('/hook/pre_processor', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { 'pre_processor_flag' => true.to_s }.to_json
+    assert_equal test_val, output[2][0]
+  end
+
+  def test_pre_processor_disabled
+    RESTRack::CONFIG[:PRE_PROCESSOR_DISABLED] = true
+    env = Rack::MockRequest.env_for('/hook/pre_processor', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { 'pre_processor_flag' => nil.to_s }.to_json
+    assert_equal test_val, output[2][0]
+    RESTRack::CONFIG[:PRE_PROCESSOR_DISABLED] = false
+  end
+
+  def test_post_processor_enabled
+    env = Rack::MockRequest.env_for('/hook/post_processor', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert $post_processor_executed
+    $post_processor_executed = nil
+  end
+
+  def test_post_processor_disabled
+    RESTRack::CONFIG[:POST_PROCESSOR_DISABLED] = true
+    env = Rack::MockRequest.env_for('/hook/post_processor', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert !$post_processor_executed
+    RESTRack::CONFIG[:POST_PROCESSOR_DISABLED] = false
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restrack
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.6.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-30 00:00:00.000000000 Z
+date: 2012-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -169,6 +169,7 @@ files:
 - lib/restrack/generator/constants.yaml.erb
 - lib/restrack/generator/controller.rb.erb
 - lib/restrack/generator/descendant_controller.rb.erb
+- lib/restrack/generator/hooks.rb.erb
 - lib/restrack/generator/loader.rb.erb
 - lib/restrack/http_status.rb
 - lib/restrack/resource_controller.rb
@@ -226,6 +227,12 @@ files:
 - test/sample_app_4/test/test_controller_modifiers.rb
 - test/sample_app_4/test/test_formats.rb
 - test/sample_app_4/views/alphatest.png
+- test/sample_app_5/config.ru
+- test/sample_app_5/config/constants.yaml
+- test/sample_app_5/controllers/hook_controller.rb
+- test/sample_app_5/hooks.rb
+- test/sample_app_5/loader.rb
+- test/sample_app_5/test/test_hooks.rb
 - test/test_support.rb
 - test/test_web_service.rb
 homepage: http://github.com/stjohncj/RESTRack