RubyGems - restrack - Versions diffs - 1.7.0 → 1.8.1 - Mend

restrack 1.7.0 → 1.8.1

Files changed (15) hide show

data/README.markdown +9 -8
data/README.markdown.html +25 -10
data/Rakefile +5 -1
data/bin/restrack +7 -4
data/lib/restrack.rb +0 -5
data/lib/restrack/async_web_service.rb +30 -0
data/lib/restrack/generator.rb +24 -2
data/lib/restrack/generator/Gemfile.erb +4 -0
data/lib/restrack/generator/constants.yaml.erb +31 -0
data/lib/restrack/generator/loader.rb.erb +1 -1
data/lib/restrack/resource_request.rb +10 -7
data/lib/restrack/version.rb +1 -1
data/test/sample_app_1/config/constants.yaml +3 -0
data/test/sample_app_1/test/test_controller_inputs.rb +17 -3
metadata +5 -3

data/README.markdown CHANGED Viewed

@@ -1,7 +1,7 @@
 # RESTRack
 - serving JSON and XML with REST and pleasure.
-## Description:
+## Description
 RESTRack is a [Rack](http://rack.rubyforge.org/)-based [MVC](http://en.wikipedia.org/wiki/Model%E2%80%93View%E2%80%93Controller)
 framework that makes it extremely easy to develop [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer)ful
 data services. It is inspired by [Rails](http://rubyonrails.org), and follows a few of its conventions.  But it has no routes
@@ -17,12 +17,8 @@ view directory grouped by controller name subdirectories \(`view/<controller>/<a
 requests will then render the view template with the builder gem, rather than generating XML with XmlSimple.
-## Installation:
-### Using [RubyGems](http://rubygems.org):
-    <sudo> gem install restrack
-## Why RESTRack when there is Rails?
+## Rationale
+### Why RESTRack when there is Rails?
 [Rails](http://rubyonrails.org/) 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 of the development of RESTRack was to add as little as possible to the framework to give
@@ -32,10 +28,15 @@ Rails 3 instantiates approximately 80K more objects than RESTRack to do a hello
 the default setup.  Trimming Rails down by eliminating ActiveRecord, ActionMailer, and ActiveResource, it still
 instantiates over 47K more objects than RESTRack.
-## OK, so why RESTRack when there is Sinatra?
+### OK, so why RESTRack when there is Sinatra?
 RESTRack provides a full, albeit small, framework for developing RESTful MVC applications.
+## Installation
+### Using [RubyGems](http://rubygems.org):
+    <sudo> gem install restrack
 ## CLI Usage:
 ### Generate a new service \(FooBar::WebService\)
   - restrack generate service foo\_bar

data/README.markdown.html CHANGED Viewed

@@ -1,10 +1,19 @@
-<h1>RESTRack</h1>
+    <!doctype html>
+    <html lang="fr">
+    <head>
+    <meta charset="utf-8">
+    <title>RESTRack</title>
+    <link rel="stylesheet" href="http://covertprestige.info/public/css/all.css" />
+    </head>
+    <body>
+    <h1>RESTRack</h1>
 <ul>
 <li>serving JSON and XML with REST and pleasure.</li>
 </ul>
-<h2>Description:</h2>
+<h2>Description</h2>
 <p>RESTRack is a <a href="http://rack.rubyforge.org/">Rack</a>-based <a href="http://en.wikipedia.org/wiki/Model%E2%80%93View%E2%80%93Controller">MVC</a>
 framework that makes it extremely easy to develop <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">REST</a>ful
@@ -20,14 +29,9 @@ file, routing relationships are done through supplying custom code blocks to cla
 view directory grouped by controller name subdirectories (<code>view/&lt;controller&gt;/&lt;action&gt;.xml.builder</code>).  XML format
 requests will then render the view template with the builder gem, rather than generating XML with XmlSimple.</p>
-<h2>Installation:</h2>
+<h2>Rationale</h2>
-<h3>Using <a href="http://rubygems.org">RubyGems</a>:</h3>
-<pre><code>&lt;sudo&gt; gem install restrack
-</code></pre>
-<h2>Why RESTRack when there is Rails?</h2>
+<h3>Why RESTRack when there is Rails?</h3>
 <p><a href="http://rubyonrails.org/">Rails</a> 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
@@ -38,10 +42,17 @@ the web developer a good application space for developing JSON and XML services.
 the default setup.  Trimming Rails down by eliminating ActiveRecord, ActionMailer, and ActiveResource, it still
 instantiates over 47K more objects than RESTRack.</p>
-<h2>OK, so why RESTRack when there is Sinatra?</h2>
+<h3>OK, so why RESTRack when there is Sinatra?</h3>
 <p>RESTRack provides a full, albeit small, framework for developing RESTful MVC applications.</p>
+<h2>Installation</h2>
+<h3>Using <a href="http://rubygems.org">RubyGems</a>:</h3>
+<pre><code>&lt;sudo&gt; gem install restrack
+</code></pre>
 <h2>CLI Usage:</h2>
 <h3>Generate a new service (FooBar::WebService)</h3>
@@ -345,3 +356,7 @@ Software.</p>
 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
+    </body>
+    </html>

data/Rakefile CHANGED Viewed

@@ -38,8 +38,12 @@ 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'
 }
+desc 'Run async app 1 tests.'
+Rake::TestTask.new('asynctest1') { |t|
+  t.pattern = 'test/sample_app_async_1/**/test_*.rb'
+}

data/bin/restrack CHANGED Viewed

@@ -12,7 +12,10 @@ when :generate, :gen, :g
   case noun.to_sym
   when :service, :serv, :s
     puts "Generating new RESTRack service #{name}..."
-    RESTRack::Generator.generate_service( name )
+    RESTRack::Generator.generate_synchronous_service( name )
+  when :asynchronous_service, :asynch_service, :async_serv, :async, :as
+    puts "Generating new RESTRack service #{name}..."
+    RESTRack::Generator.generate_asynchronous_service( name )
   when :controller, :cont, :c
     predicate  = ARGV[3] ? ARGV[3].to_sym : nil
     case predicate
@@ -30,6 +33,6 @@ when :server, :s
   options = { :Port => noun || 9292, :config => 'config.ru' }
   options.merge({ :environment => ARGV[2] }) unless ARGV[2].nil?
   Rack::Server.start( options )
-end
-# TODO: Print current version of RESTrack via command-line call
+when :version, :v
+  puts "Currently using RESTRack version " + RESTRack::VERSION.to_s + "."
+end

data/lib/restrack.rb CHANGED Viewed

@@ -22,8 +22,3 @@ end
 include HTTPStatus
 include ActiveSupport::Inflector
-# TODO: configurable list of params to strip before logging
-# TODO: update README
-# TODO: markdown to html generator
-# TODO: async plugin

data/lib/restrack/async_web_service.rb ADDED Viewed

@@ -0,0 +1,30 @@
+require 'eventmachine'
+module RESTRack
+  class AsyncWebService
+    AsyncResponse = [-1, {}, []].freeze
+    # 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 )
+      EventMachine::defer do
+        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(response)
+        end
+        env['async.callback'].call response.output
+      end
+      AsyncResponse
+    end # method call
+  end # class WebService
+end # module RESTRack

data/lib/restrack/generator.rb CHANGED Viewed

@@ -12,7 +12,8 @@ module RESTRack
       :constants              => 'constants.yaml.erb',
       :controller             => 'controller.rb.erb',
       :descendant_controller  => 'descendant_controller.rb.erb',
-      :hooks                  => 'hooks.rb.erb'
+      :hooks                  => 'hooks.rb.erb',
+      :gemfile                => 'Gemfile.erb'
     }
     class << self
@@ -36,7 +37,9 @@ module RESTRack
         FileUtils.makedirs("#{base_dir}/views/#{name}")
       end
-      # Generate a new RESTRack service
+      # The guts for generating a new RESTRack service. The loader.rb template
+      # will create a RESTRack::WebService or RESTRack::AsyncWebService based on
+      # the value of @async.
       def generate_service(name)
         FileUtils.makedirs("#{name}/config")
         FileUtils.makedirs("#{name}/controllers")
@@ -59,6 +62,25 @@ module RESTRack
         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 }
+        # Added following lines to generate 'Gemfile' automatically.
+        template = get_template_for( :gemfile )
+        resultant_string = template.result( get_binding_for_service( name ) )
+        File.open("#{name}/Gemfile", 'w') {|f| f.puts resultant_string }
+      end
+      # Generate a new RESTRack service.  This does not use EventMachine and can
+      # be used with any Rack supported web server.
+      def generate_synchronous_service(name)
+        @async = false
+        generate_service(name)
+        @async = nil
+      end
+      # Generate a new RESTRack service that uses EventMachine. This can only be
+      # used with web servers that use or support EventMachine (Thin, Rainbows).
+      def generate_asynchronous_service(name)
+        @async = true
+        generate_service(name)
+        @async = nil
       end
       private

data/lib/restrack/generator/Gemfile.erb ADDED Viewed

@@ -0,0 +1,4 @@
+source :rubygems
+gem "restrack","~><%= RESTRack::VERSION.to_s %>"
+<%= @async ? 'gem "eventmachine"' : '' %>

data/lib/restrack/generator/constants.yaml.erb CHANGED Viewed

@@ -22,3 +22,34 @@
 :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:      []
+# A list of input parameters which should not be output to logs:
+#:PARAMS_NOT_LOGGABLE:     [:password]
+# :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
+#    - Access-Control-Allow-Methods: POST, GET
+#   List of all:
+#    - Access-Control-Allow-Origin: <origin> | *
+#       e.g. Access-Control-Allow-Origin: http://mozilla.com
+#    - Access-Control-Expose-Headers: X-My-Custom-Header, X-Another-Custom-Header
+#    - Access-Control-Max-Age: <delta-seconds>
+#    - Access-Control-Allow-Credentials: true | false
+#    - Access-Control-Allow-Methods: <method>[, <method>]*
+#       e.g. Access-Control-Allow-Methods: POST, GET
+#    - Access-Control-Allow-Headers: <field-name>[, <field-name>]*
+#: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/lib/restrack/generator/loader.rb.erb CHANGED Viewed

@@ -1,7 +1,7 @@
 require 'restrack'
 module <%= @service_name.camelize %>; end
-class <%= @service_name.camelize %>::WebService < RESTRack::WebService; end
+class <%= @service_name.camelize %>::WebService < RESTRack::<%= @async ? 'Async' : '' %>WebService; end
 RESTRack::CONFIG = RESTRack::load_config(File.join(File.dirname(__FILE__), 'config/constants.yaml'))
 RESTRack::CONFIG[:ROOT] = File.dirname(__FILE__)

data/lib/restrack/resource_request.rb CHANGED Viewed

@@ -15,9 +15,6 @@ module RESTRack
       @request.env.select {|k,v| k.start_with? 'HTTP_'}.each do |k,v|
         @headers[k.sub(/^HTTP_/, '')] = v
       end
-    end
-    def prepare
       # MIME type should be determined before raising any exceptions for proper error reporting
         # Set up the initial routing.
       @url_chain = @request.path_info.split('/')
@@ -32,16 +29,17 @@ module RESTRack
       end
         # Determine MIME type from extension
       @mime_type = get_mime_type_from( extension )
+    end
+    def prepare
       # Now safe to raise exceptions
       raise HTTP400BadRequest, "Request path of #{@request.path_info} is invalid" if @request.path_info.include?('//')
       # For CORS support
       if RESTRack::CONFIG[:CORS]
         raise HTTP403Forbidden if @headers['Origin'].nil?
         raise HTTP403Forbidden unless RESTRack::CONFIG[:CORS]['Access-Control-Allow-Origin'] == '*' or RESTRack::CONFIG[:CORS]['Access-Control-Allow-Origin'].include?(@headers['Origin'])
         raise HTTP403Forbidden unless @request.env['REQUEST_METHOD'] == 'OPTIONS' or RESTRack::CONFIG[:CORS]['Access-Control-Allow-Methods'] == '*' or RESTRack::CONFIG[:CORS]['Access-Control-Allow-Methods'].include?(@request.env['REQUEST_METHOD'])
       end
       # Pull input data from POST body
       @post_params = parse_body( @request )
       @get_params = parse_query_string( @request )
@@ -53,7 +51,6 @@ module RESTRack
       end
       @params.symbolize!
       log_request_params(@params)
       # Pull first controller from URL
       @active_resource_name = @url_chain.shift
       unless @active_resource_name.nil? or RESTRack.controller_exists?(@active_resource_name)
@@ -69,7 +66,13 @@ module RESTRack
     end
     def log_request_params(params_hash)
-      RESTRack.request_log.debug 'Combined Request Params: ' + params_hash.inspect
+      params_to_log = params_hash.clone
+      if RESTRack::CONFIG[:PARAMS_NOT_LOGGABLE]
+        params_to_log.each_key do |param|
+          params_to_log[param] = '*****' if RESTRack::CONFIG[:PARAMS_NOT_LOGGABLE].include?(param.to_s)
+        end
+      end
+      RESTRack.request_log.debug 'Combined Request Params: ' + params_to_log.inspect
     end
     # Call the next entity in the path stack.

data/lib/restrack/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module RESTRack
-  VERSION = "1.7.0"
+  VERSION = "1.8.1"
 end

data/test/sample_app_1/config/constants.yaml CHANGED Viewed

@@ -27,6 +27,9 @@
 # The stack trace will not be added to 500 response body by default, set to true to enable.
 :SHOW_STACK:              true
+# A list of input parameters which should not be output to logs:
+:PARAMS_NOT_LOGGABLE:     [ password ]
 # :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

data/test/sample_app_1/test/test_controller_inputs.rb CHANGED Viewed

@@ -21,7 +21,7 @@ class SampleApp::TestControllerInputs < Test::Unit::TestCase
     test_val = { :test => '1', :hello => 'world', 'get?' => 'true' }.to_json
     assert_equal test_val, output[2][0]
   end
   def test_FUBAR_params
     env = Rack::MockRequest.env_for('/foo_bar/echo_get?test=1&hello=world', {
       :method => 'DELETE'
@@ -60,7 +60,7 @@ class SampleApp::TestControllerInputs < Test::Unit::TestCase
     end
     assert_equal test_val, output[2][0]
   end
   def test_post_xml
     test_val = XmlSimple.xml_out({ :echo => 'niner' }, 'AttrPrefix' => true, 'XmlDeclaration' => true, 'NoIndent' => true)
     env = Rack::MockRequest.env_for('/foo_bar/echo.xml', {
@@ -74,7 +74,7 @@ class SampleApp::TestControllerInputs < Test::Unit::TestCase
     end
     assert_equal test_val, output[2][0]
   end
   def test_post_text
     test_val = 'OPCODE=PEBKAC'
     env = Rack::MockRequest.env_for('/foo_bar/echo.txt', {
@@ -88,4 +88,18 @@ class SampleApp::TestControllerInputs < Test::Unit::TestCase
     end
     assert_equal test_val, output[2][0]
   end
+  def test_post_password_param_no_log
+    test_val = { :echo => 'niner', :password => 'my_password' }.to_json
+    env = Rack::MockRequest.env_for('/foo_bar/echo', {
+      :method => 'POST',
+      :input => test_val,
+      'CONTENT_TYPE' => 'application/json'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal test_val, output[2][0]
+  end
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restrack
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.1
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-01-03 00:00:00.000000000 Z
+date: 2013-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -164,7 +164,9 @@ files:
 - Rakefile
 - bin/restrack
 - lib/restrack.rb
+- lib/restrack/async_web_service.rb
 - lib/restrack/generator.rb
+- lib/restrack/generator/Gemfile.erb
 - lib/restrack/generator/config.ru.erb
 - lib/restrack/generator/constants.yaml.erb
 - lib/restrack/generator/controller.rb.erb
@@ -255,7 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: restrack
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key:
 specification_version: 3
 summary: A lightweight MVC framework developed specifically for JSON (and XML) REST