restrack 0.0.6 → 0.1.0

data/README.rdoc

@@ -3,8 +3,7 @@
 == Description:
     RESTRack is a Rack based MVC framework that makes it extremely easy to develop RESTful data services. It is inspired
   by Rails, and follows a few of its conventions.  But it has no routes file, routing relationships are done through
-  supplying custom code blocks to class methods such as 'has_relationship_to', 'has_mapped_relationships_to',
-  'has_direct_relationship_to', and 'has_direct_relationships_to'.
+  supplying custom code blocks to class methods such as 'has_relationship_to' or 'has_mapped_relationships_to'.
     RESTRack aims at being lightweight and easy to use.  It will automatically render JSON and XML for the data
   structures you return in your actions (any structure parsable by the 'json' and 'xml-simple' gems, respectively).
     If you supply a view for a controller action, you do that using a builder file.  Builder files are stored in the
@@ -55,34 +54,39 @@
   
     An open, or pass-through, path can be defined via the 'pass_through_to' class method for resource controllers.  This
   exposes URL patterns like the following:
-  GET /foo/123/bar/234      <= simple pass-through from Foo 123 to show Bar 234
-  GET /foo/123/bar          <= simple pass-through from Foo 123 to Bar index
+  GET /foo/123/bar/234        <= simple pass-through from Foo 123 to show Bar 234
+  GET /foo/123/bar            <= simple pass-through from Foo 123 to Bar index
   
     A direct path to a single related resource's controller can be defined with the 'has_relationship_to' method.  This
   allows you to define a one-to-one relationship from this resource to a related resource, which means that the id of
-  the related resource is implied through the id of the caller.  The caller has one and only one relation through a
-  custom code block passed to 'has_relationship_to'.  The code block takes the caller resource's id and evaluates to the
-  relation resource's id, for example a PeopleController might define a one-to-one relationship like so:
+  the related resource is implied through the id of the caller.  The caller has one relation through a custom code block
+  passed to 'has_relationship_to'.  The code block takes the caller resource's id and evaluates to the relation
+  resource's id, for example a PeopleController might define a one-to-one relationship like so:
         has_relationship_to( :people, :as spouse ) do |id|
           People.find(id).spouse.id
         end
   This exposes URL patterns like
   the following:
-  GET     /people/Sally/spouse  <= direct route to show Sally's spouse
-  PUT     /people/Henry/spouse  <= direct route to update Henry's spouse
-  POST    /people/Jane/spouse   <= direct route to add Jane's spouse
+  GET /people/Sally/spouse    <= direct route to show Sally's spouse
+  PUT /people/Henry/spouse    <= direct route to update Henry's spouse
+  POST /people/Jane/spouse    <= direct route to add Jane's spouse
   
-  # TODO: need has_relationships_to and has_direct_relationships_to
-    A direct path to many related resources' controller can be defined with the 'has_relationships_to' method.  This
-  allows you to define one-to-many relationships.  It works similar to 'has_relationship_to', except that the code block
-  passed to it should evaluate to an array of the related child ids.  Each resource in the parent's relation list is
-  then accessed through its array index (zero-based) in the URL.  An example of exposing the list of a People resource's
-  children in this manner follows:
-        has_direct_relationships_to( :people, :as => children ) do |id|
+    A direct path to many related resources' controller can be defined with the 'has_relationships_to' and
+  'has_defined_relationships_to' methods.  These allows you to define one-to-many relationships.  They work similar to
+  'has_relationship_to', except that they accept code blocks which evaluate to arrays of related child ids.  Each
+  resource in the parent's relation list is then accessed through its array index (zero-based) in the URL.  An example
+  of exposing the list of a People resource's children in this manner follows:
+        has_relationships_to( :people, :as => children ) do |id|
           People.find(id).children.collect {|child| child.id}
         end
-  GET     /people/Nancy/children/0      <= direct route to show child 0
-  DELETE  /people/Robert/children/100   <= direct route to destroy child 100
+  GET /people/Nancy/children/0          <= direct route to show child 0
+  DELETE /people/Robert/children/100    <= direct route to destroy child 100
+  
+        has_defined_relationships_to( :people, :as => children ) do |id|
+          People.find(id).children.collect {|child| child.id}
+        end
+  GET /people/Nancy/children/George     <= direct route to show child 0
+  DELETE /people/Robert/children/John   <= direct route to destroy child 100
   
     Multiple named one-to-many relationships can be exposed with the 'has_mapped_relationships_to' method.  This allows
   you to define many named or keyword paths to related resources.  The method's code block should accepts the parent id
@@ -97,17 +101,17 @@
           }
         end
   This would expose the following URL patterns:
-  GET     /people/Fred/people/father     => show the father of Fred
-  PUT     /people/Fred/people/assistant  => update Fred's assistant
-  POST    /people/Fred/people/boss       => add Fred's boss
-  DELETE  /people/Luke/people/mother     => destroy Luke's father
+  GET /people/Fred/people/father      => show the father of Fred
+  PUT /people/Fred/people/assistant   => update Fred's assistant
+  POST /people/Fred/people/boss       => add Fred's boss
+  DELETE /people/Luke/people/mother   => destroy Luke's father
 
 
     Resource id data types can be defined with the keyed_with_type class method within resource controllers.  The
   default data type of String is used if a different type is not specified.
 
 
-== How-Tos
+== Miscellaneous Details
 
   === Logging/Logging Level
       RESTRack logs to two logs, the standard log (or error log) and the request log.  Paths and logging levels for these
@@ -125,16 +129,20 @@
       Custom XML serialization can be done by providing Builder gem templates in views/<controller>/<action>.xml.builder
     
   === Inputs
-    ==== GET params
+    ==== Query string parameters
+      Available to controllers in the @params instance variable.
     ==== POST data
-
-  === TODO: :DEFAULT_RESOURCE
-    ...yet to be done...
-  === TODO: :ROOT_RESOURCE_ACCEPT/:ROOT_RESOURCE_DENY
-    ...yet to be done...
-  === TODO: Authentication/Authorization Suggestions
-    ...yet to be done...
+      Available to controllers in the @input instance variable.
+  === :DEFAULT_RESOURCE
+    Set this option in config/constants.yaml to use an implied root resource controller.
+  :DEFAULT_RESOURCE: foo  # /foo/123 could be accessed with /123, /foo could be accessed with /
   
+  === :ROOT_RESOURCE_ACCEPT / :ROOT_RESOURCE_DENY
+    :ROOT_RESOURCE_ACCEPT: [ 'foo', 'bar' ]     # OPTIONAL
+        defines an array of resources that can be accessed (without being proxied through another relation).
+    :ROOT_RESOURCE_DENY: [ 'baz' ]              # OPTIONAL
+        defines an array of resources that cannot be accessed without proxying though another controller.
+
 
 == License:
 

data/bin/restrack

@@ -14,7 +14,7 @@ when :generate, :gen, :g
     puts "Generating new RESTRack service #{name}..."
     RESTRack::Generator.generate_service( name )
   when :controller, :cont, :c
-    predicate  = ARGV[3].to_sym
+    predicate  = ARGV[3] ? ARGV[3].to_sym : nil
     case predicate
     when :descendant_from, :parent
       parent = ARGV[4]

data/lib/restrack/resource_controller.rb

@@ -20,6 +20,9 @@ module RESTRack
     end
     def __init(resource_request)
       @resource_request = resource_request
+      @request = @resource_request.request
+      @params = @resource_request.params
+      @input = @resource_request.input
       self
     end
 
@@ -163,7 +166,6 @@ module RESTRack
     def self.format_string_id(id)
       return nil unless id
       # default key type of resources is String
-      # TODO: Should this be set by service in config/constants.yaml?
       self.key_type ||= String
       unless self.key_type.blank? or self.key_type.ancestors.include?(String)
         if self.key_type.ancestors.include?(Integer)

data/lib/restrack/resource_request.rb

@@ -1,7 +1,7 @@
 module RESTRack
   # The ResourceRequest class handles all incoming requests.
   class ResourceRequest
-    attr_reader :request, :request_id, :input
+    attr_reader :request, :request_id, :input, :params
     attr_accessor :mime_type, :url_chain
 
     # Initialize the ResourceRequest by assigning a request_id and determining the path, format, and controller of the resource.
@@ -13,7 +13,8 @@ module RESTRack
       RESTRack.request_log.info "{#{@request_id}} #{@request.path_info} requested from #{@request.ip}"
       RESTRack.log.debug "{#{@request_id}} Reading POST Input"
       # Pull input data from POST body
-      @input = read( @request )
+      @input = parse_body( @request )
+      @params = get_params( @request )
       # Setup up the initial routing.
       @url_chain = @request.path_info.split('/')
       @url_chain.shift if @url_chain[0] == ''
@@ -66,25 +67,25 @@ module RESTRack
     end
 
     # Pull input data from POST body
-    def read(request)
-      input = ''
-      if request.content_type.blank?
-        input = request.body.read
-      else
+    def parse_body(request)
+      input = request.body.read
+      unless request.content_type.blank?
         request_mime_type = MIME::Type.new( request.content_type )
         if request_mime_type.like?( RESTRack.mime_type_for( :JSON ) )
-          input = JSON.parse( request.body.read )
+          input = JSON.parse( input )
         elsif request_mime_type.like?( RESTRack.mime_type_for( :XML ) )
-          input = XmlSimple.xml_in( request.body.read )
+          input = XmlSimple.xml_in( input )
         elsif request_mime_type.like?( RESTRack.mime_type_for( :YAML ) )
-          input = YAML.parse( request.body.read )
-        else
-          input = request.body.read
+          input = YAML.parse( input )
         end
-        RESTRack.request_log.debug "{#{@request_id}} #{request_mime_type.to_s} data in\n" + input.to_json
       end
+      RESTRack.request_log.debug "{#{@request_id}} #{request_mime_type.to_s} data in\n" + input.pretty_inspect
       input
     end
+    
+    def get_params(request)
+      params = request.GET
+    end
 
     # Determine the MIME type of the request from the extension provided.
     def get_mime_type_from(extension)
@@ -119,7 +120,7 @@ module RESTRack
         if File.exists? builder_file
           @output = builder_up(data)
         else
-          @output = XmlSimple.xml_out(data, 'AttrPrefix' => true, 'XmlDeclaration' => true)
+          @output = XmlSimple.xml_out(data, 'AttrPrefix' => true, 'XmlDeclaration' => true, 'NoIndent' => true)
         end
       elsif @mime_type.like?(RESTRack.mime_type_for( :YAML ) )
         @output = YAML.dump(data)

data/lib/restrack/version.rb

@@ -1,3 +1,3 @@
 module RESTRack
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 end

data/test/sample_app_1/config/constants.yaml

@@ -17,9 +17,9 @@
 :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' 
+: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' ]
+: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' ]
+:ROOT_RESOURCE_DENY:      [ baz ]

data/test/sample_app_1/controllers/foo_bar_controller.rb

@@ -78,8 +78,30 @@ class SampleApp::FooBarController < RESTRack::ResourceController
     { :success => true }
   end
 
+  def complex_show_xml_no_builder(id)
+    if id == '1234567890'
+      return { :foo => 'abc', :bar => '123', 'baz' => 456, :more => { :one => 1, :two => [1,2], :three => :deep_fu } }
+    end
+    if id == '42'
+      return {
+        :foo => 'abc',
+        :bar => 123,
+        :baz => {
+          'one' => [1],
+          'two' => ['1','2'],
+          'three' => ['1', 2, {:three => 3}],
+          4 => :four
+        }
+      }
+    end
+  end
+
   def echo
-    return @resource_request.input
+    return @input
+  end
+  
+  def echo_get
+    return @params.merge({ 'get?' => @resource_request.request.get?.to_s })
   end
   
   def custom_entity(id)

data/test/sample_app_1/test/test_controller_inputs.rb

@@ -10,6 +10,30 @@ class SampleApp::TestControllerInputs < Test::Unit::TestCase
     @ws = SampleApp::WebService.new
   end
 
+  def test_get_params
+    env = Rack::MockRequest.env_for('/foo_bar/echo_get?test=1&hello=world', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :test => '1', :hello => 'world', 'get?' => 'true' }.to_json
+    assert_equal test_val, output[2]
+  end
+  
+  def test_FUBAR_params
+    env = Rack::MockRequest.env_for('/foo_bar/echo_get?test=1&hello=world', {
+      :method => 'DELETE'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    test_val = { :test => '1', :hello => 'world', 'get?' => 'false' }.to_json
+    assert_equal test_val, output[2]
+  end
+
   def test_post_no_content_type
     test_val = "random text" # will be converted to json because of default response type
     env = Rack::MockRequest.env_for('/foo_bar/echo', {
@@ -36,6 +60,32 @@ class SampleApp::TestControllerInputs < Test::Unit::TestCase
     end
     assert_equal test_val, output[2]
   end
-  # TODO: Test all input formats
-
+  
+  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', {
+      :method => 'POST',
+      :input => test_val,
+      'CONTENT_TYPE' => 'application/xml'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal test_val, output[2]
+  end
+  
+  def test_post_text
+    test_val = 'OPCODE=PEBKAC'
+    env = Rack::MockRequest.env_for('/foo_bar/echo.txt', {
+      :method => 'POST',
+      :input => test_val,
+      'CONTENT_TYPE' => 'text/plain'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal test_val, output[2]
+  end
 end

data/test/sample_app_1/test/test_formats.rb

@@ -30,7 +30,7 @@ class SampleApp::TestFormats < Test::Unit::TestCase
     assert_nothing_raised do
       output = @ws.call(env)
     end
-    test_val = XmlSimple.xml_out([1,2,3,4,5,6,7], 'AttrPrefix' => true, 'XmlDeclaration' => true)
+    test_val = XmlSimple.xml_out([1,2,3,4,5,6,7], 'AttrPrefix' => true, 'XmlDeclaration' => true, 'NoIndent' => true)
     assert_equal test_val, output[2]
 
     env = Rack::MockRequest.env_for('/foo_bar.xml', {
@@ -40,7 +40,7 @@ class SampleApp::TestFormats < Test::Unit::TestCase
     assert_nothing_raised do
       output = @ws.call(env)
     end
-    test_val = XmlSimple.xml_out([1,2,3,4,5,6,7], 'AttrPrefix' => true, 'XmlDeclaration' => true)
+    test_val = XmlSimple.xml_out([1,2,3,4,5,6,7], 'AttrPrefix' => true, 'XmlDeclaration' => true, 'NoIndent' => true)
     assert_equal test_val, output[2]
   end
 
@@ -88,25 +88,24 @@ class SampleApp::TestFormats < Test::Unit::TestCase
   end
     
   def test_complex_data_structure_xml
-    skip
-    env = Rack::MockRequest.env_for('/foo_bar/1234567890.xml', {
+    env = Rack::MockRequest.env_for('/foo_bar/1234567890/complex_show_xml_no_builder.xml', {
       :method => 'GET'
     })
     output = ''
     assert_nothing_raised do
       output = @ws.call(env)
     end
-    test_val = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><data><foo>abc</foo><baz>456</baz><bar>123</bar><more><two></data>"
+    test_val = "<?xml version='1.0' standalone='yes'?>\n<opt><foo>abc</foo><bar>123</bar><baz>456</baz><more><one>1</one><two>1</two><two>2</two><three>deep_fu</three></more></opt>"
     assert_equal test_val, output[2]
     
-    env = Rack::MockRequest.env_for('/foo_bar/42.xml', {
+    env = Rack::MockRequest.env_for('/foo_bar/42/complex_show_xml_no_builder.xml', {
       :method => 'GET'
     })
     output = ''
     assert_nothing_raised do
       output = @ws.call(env)
     end
-    test_val = {
+    test_val = XmlSimple.xml_out({
       :foo => 'abc',
       :bar => 123,
       :baz => {
@@ -115,7 +114,7 @@ class SampleApp::TestFormats < Test::Unit::TestCase
         'three' => ['1', 2, {:three => 3}],
         4 => :four
       }
-    }
+    }, 'AttrPrefix' => true, 'XmlDeclaration' => true, 'NoIndent' => true)
     assert_equal test_val, output[2]
   end
 

data/test/sample_app_3/config/constants.yaml

@@ -16,9 +16,9 @@
 # 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'
+: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' ]
+: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:      []

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 6
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors: 
 - Chris St. John