sinatra_resource 0.1.0 → 0.2.0

data/lib/resource.rb

@@ -6,12 +6,28 @@ module SinatraResource
       includee.setup
     end
     
-    def config
-      self.class.instance_variable_get("@resource_config")
+    def resource_config
+      self.class.resource_config
     end
-    
+
     module ClassMethods
       
+      attr_reader :resource_config
+      
+      # Specify the association +method+ on +parent+ that points to the
+      # current (child) +model+.
+      #
+      # @param [Symbol] method
+      #   A symbol that refers to a method on the parent.
+      #
+      # @return [undefined]
+      def child_association(method)
+        if @resource_config[:child_association]
+          raise DefinitionError, "child_association already declared in #{self}"
+        end
+        @resource_config[:child_association] = method
+      end
+      
       # Build the Sinatra actions based on the DSL statements in this class.
       # You will want to do this last.
       #
@@ -20,10 +36,11 @@ module SinatraResource
       #
       # @return [undefined]
       def build
+        deferred_defaults
         validate
         Builder.new(self).build
       end
-
+      
       # Specify the underlying +model+
       #
       # @example
@@ -43,7 +60,33 @@ module SinatraResource
           raise DefinitionError, "model already declared in #{self}"
         end
         @resource_config[:model] = model
-        default_properties
+      end
+      
+      # Specify the parent +resource+. Only used for nested resources.
+      #
+      # @param [Class] resource
+      #
+      # @return [undefined]
+      def parent(resource)
+        if @resource_config[:parent]
+          raise DefinitionError, "parent already declared in #{self}"
+        end
+        @resource_config[:parent] = resource
+      end
+      
+      # Specify the path. If not specified, SinatraResource will infer the path
+      # from the resource class (see the +default_path+ method.)
+      #
+      # This method is also useful for nested resources.
+      #
+      # @param [String] name
+      #
+      # @return [undefined]
+      def path(name)
+        if @resource_config[:path]
+          raise DefinitionError, "path already declared in #{self}"
+        end
+        @resource_config[:path] = name
       end
       
       # Specify the minimal role needed to access this resource for reading
@@ -78,7 +121,7 @@ module SinatraResource
       # @return [undefined]
       def property(name, access_rules={}, &block)
         if @resource_config[:properties][name]
-          raise DefinitionError, "property #{name} already declared in #{self}"
+          raise DefinitionError, "property #{name.inspect} already declared in #{self}"
         end
         @resource_config[:properties][name] = {}
         if block
@@ -91,6 +134,33 @@ module SinatraResource
         end
       end
       
+      # Declare a relation with a block of code.
+      #
+      # Only needed with nested resources. 
+      #
+      # For example:
+      #   relation :create do |parent, child|
+      #     Categorization.create(
+      #       :category_id => parent.id,
+      #       :source_id   => child.id
+      #     )
+      #   end
+      #
+      # This runs after a POST to automatically connect parent with child.
+      #
+      # Is useful to create a document that joins a category (the parent)
+      # to the source (the child).
+      #
+      # @param [Symbol] name
+      #
+      # @return [undefined]
+      def relation(name, &block)
+        if @resource_config[:relation][name]
+          raise DefinitionError, "relation #{name.inspect} already declared in #{self}"
+        end
+        @resource_config[:relation][name] = block
+      end
+      
       # Specify the role definitions for this resource.
       #
       # @example
@@ -118,28 +188,41 @@ module SinatraResource
       # For internal use. Initializes internal data structure.
       def setup
         @resource_config = {
-          :model      => nil,
-          :permission => {},
-          :properties => {},
-          :roles      => nil,
-          :path       => default_path,
+          :child_association => nil,
+          :model             => nil,
+          :parent            => nil,
+          :path              => nil, # default_path,
+          :permission        => {},
+          :properties        => {},
+          :relation          => { :create => nil, :delete => nil },
+          :roles             => nil,
         }
       end
       
       protected
       
-      # Return the default relative path for a resource.
+      # Set some defaults, only if they haven't been set already.
+      #
+      # @return [undefined]
+      def deferred_defaults
+        set_default_path
+        set_default_properties
+      end
+      
+      # Set the default relative path for a resource.
       #
-      # @return [String]
-      def default_path
-        self.to_s.split('::').last.downcase
+      # @return [undefined]
+      def set_default_path
+        unless @resource_config[:path]
+          @resource_config[:path] = self.to_s.split('::').last.downcase
+        end
       end
 
       # Define some default properties to mirror common keys in the
       # model
       #
       # @return [undefined]
-      def default_properties
+      def set_default_properties
         keys = @resource_config[:model].keys
         if keys.include?("_id")
           property :id, :w => :nobody

data/lib/sinatra_resource.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/exceptions'
-require File.dirname(__FILE__) + '/builder/helpers'
-require File.dirname(__FILE__) + '/builder/mongo_helpers'
-require File.dirname(__FILE__) + '/builder'
-require File.dirname(__FILE__) + '/resource'
-require File.dirname(__FILE__) + '/roles'
+base = File.dirname(__FILE__)
+require base + '/exceptions'
+Dir.glob(base + '/builder/*.rb').each { |f| require f }
+require base + '/builder'
+require base + '/resource'
+require base + '/roles'

data/notes/permissions.mdown

@@ -68,11 +68,11 @@ In other words, if you know the user type, action, and resource, you
 know whether to allow or disallow.
 
     def allow?(user_type, action, resource)
-      # logic depends solely on parameters
+      # logic depends solely on params
     end
     
     def disallow?(user_type, action, resource)
-      # logic depends solely on parameters
+      # logic depends solely on params
     end
 
 ## Document-level use cases:
@@ -145,21 +145,21 @@ The nice thing about the {can | can't} style is that it allows for one or both
 Which brings us back to the 'allow?' and 'disallow?' methods:
 
     def allow?(user_type, user, action, resource, instance, relation)
-      # logic depends solely on parameters
+      # logic depends solely on params
     end
     
     def disallow?(user_type, user, action, resource, instance, relation)
-      # logic depends solely on parameters
+      # logic depends solely on params
     end
 
 I would expect that user_type can be derived from user, so we can simplify:
 
     def allow?(user, action, resource, instance, relation)
-      # logic depends solely on parameters
+      # logic depends solely on params
     end
     
     def disallow?(user, action, resource, instance, relation)
-      # logic depends solely on parameters
+      # logic depends solely on params
     end
 
 It is tempting to try to simplify further. For example, why not assume that resource can be inferred from instance? That may be so, but I'm not so convinced that there is only one resource for each instance. For example,

data/sinatra_resource.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra_resource}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David James"]
-  s.date = %q{2009-10-20}
+  s.date = %q{2009-10-22}
   s.description = %q{A DSL for creating RESTful actions with Sinatra and MongoMapper. It embraces the Resource Oriented Architecture as explained by Leonard Richardson and Sam Ruby.}
   s.email = %q{djames@sunlightfoundation.com}
   s.extra_rdoc_files = [
@@ -36,6 +36,7 @@ Gem::Specification.new do |s|
      "examples/datacatalog/models/source.rb",
      "examples/datacatalog/models/user.rb",
      "examples/datacatalog/resources/categories.rb",
+     "examples/datacatalog/resources/categories_sources.rb",
      "examples/datacatalog/resources/sources.rb",
      "examples/datacatalog/resources/users.rb",
      "examples/datacatalog/tasks/db.rake",
@@ -49,6 +50,7 @@ Gem::Specification.new do |s|
      "examples/datacatalog/test/helpers/resource_test_helper.rb",
      "examples/datacatalog/test/helpers/shared/api_keys.rb",
      "examples/datacatalog/test/helpers/shared/common_body_responses.rb",
+     "examples/datacatalog/test/helpers/shared/model_counts.rb",
      "examples/datacatalog/test/helpers/shared/status_codes.rb",
      "examples/datacatalog/test/helpers/test_cases/model_test_case.rb",
      "examples/datacatalog/test/helpers/test_cases/resource_test_case.rb",
@@ -62,6 +64,11 @@ Gem::Specification.new do |s|
      "examples/datacatalog/test/resources/categories/categories_get_one_test.rb",
      "examples/datacatalog/test/resources/categories/categories_post_test.rb",
      "examples/datacatalog/test/resources/categories/categories_put_test.rb",
+     "examples/datacatalog/test/resources/categories_sources/categories_sources_delete_test.rb",
+     "examples/datacatalog/test/resources/categories_sources/categories_sources_get_many_test.rb",
+     "examples/datacatalog/test/resources/categories_sources/categories_sources_get_one_test.rb",
+     "examples/datacatalog/test/resources/categories_sources/categories_sources_post_test.rb",
+     "examples/datacatalog/test/resources/categories_sources/categories_sources_put_test.rb",
      "examples/datacatalog/test/resources/sources/sources_delete_test.rb",
      "examples/datacatalog/test/resources/sources/sources_get_many_test.rb",
      "examples/datacatalog/test/resources/sources/sources_get_one_test.rb",
@@ -73,6 +80,7 @@ Gem::Specification.new do |s|
      "examples/datacatalog/test/resources/users/users_post_test.rb",
      "examples/datacatalog/test/resources/users/users_put_test.rb",
      "lib/builder.rb",
+     "lib/builder/action_definitions.rb",
      "lib/builder/helpers.rb",
      "lib/builder/mongo_helpers.rb",
      "lib/exceptions.rb",
@@ -110,6 +118,7 @@ Gem::Specification.new do |s|
      "examples/datacatalog/models/source.rb",
      "examples/datacatalog/models/user.rb",
      "examples/datacatalog/resources/categories.rb",
+     "examples/datacatalog/resources/categories_sources.rb",
      "examples/datacatalog/resources/sources.rb",
      "examples/datacatalog/resources/users.rb",
      "examples/datacatalog/test/helpers/assertions/assert_include.rb",
@@ -121,6 +130,7 @@ Gem::Specification.new do |s|
      "examples/datacatalog/test/helpers/resource_test_helper.rb",
      "examples/datacatalog/test/helpers/shared/api_keys.rb",
      "examples/datacatalog/test/helpers/shared/common_body_responses.rb",
+     "examples/datacatalog/test/helpers/shared/model_counts.rb",
      "examples/datacatalog/test/helpers/shared/status_codes.rb",
      "examples/datacatalog/test/helpers/test_cases/model_test_case.rb",
      "examples/datacatalog/test/helpers/test_cases/resource_test_case.rb",
@@ -134,6 +144,11 @@ Gem::Specification.new do |s|
      "examples/datacatalog/test/resources/categories/categories_get_one_test.rb",
      "examples/datacatalog/test/resources/categories/categories_post_test.rb",
      "examples/datacatalog/test/resources/categories/categories_put_test.rb",
+     "examples/datacatalog/test/resources/categories_sources/categories_sources_delete_test.rb",
+     "examples/datacatalog/test/resources/categories_sources/categories_sources_get_many_test.rb",
+     "examples/datacatalog/test/resources/categories_sources/categories_sources_get_one_test.rb",
+     "examples/datacatalog/test/resources/categories_sources/categories_sources_post_test.rb",
+     "examples/datacatalog/test/resources/categories_sources/categories_sources_put_test.rb",
      "examples/datacatalog/test/resources/sources/sources_delete_test.rb",
      "examples/datacatalog/test/resources/sources/sources_get_many_test.rb",
      "examples/datacatalog/test/resources/sources/sources_get_one_test.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra_resource
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - David James
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-20 00:00:00 -04:00
+date: 2009-10-22 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -121,6 +121,7 @@ files:
 - examples/datacatalog/models/source.rb
 - examples/datacatalog/models/user.rb
 - examples/datacatalog/resources/categories.rb
+- examples/datacatalog/resources/categories_sources.rb
 - examples/datacatalog/resources/sources.rb
 - examples/datacatalog/resources/users.rb
 - examples/datacatalog/tasks/db.rake
@@ -134,6 +135,7 @@ files:
 - examples/datacatalog/test/helpers/resource_test_helper.rb
 - examples/datacatalog/test/helpers/shared/api_keys.rb
 - examples/datacatalog/test/helpers/shared/common_body_responses.rb
+- examples/datacatalog/test/helpers/shared/model_counts.rb
 - examples/datacatalog/test/helpers/shared/status_codes.rb
 - examples/datacatalog/test/helpers/test_cases/model_test_case.rb
 - examples/datacatalog/test/helpers/test_cases/resource_test_case.rb
@@ -147,6 +149,11 @@ files:
 - examples/datacatalog/test/resources/categories/categories_get_one_test.rb
 - examples/datacatalog/test/resources/categories/categories_post_test.rb
 - examples/datacatalog/test/resources/categories/categories_put_test.rb
+- examples/datacatalog/test/resources/categories_sources/categories_sources_delete_test.rb
+- examples/datacatalog/test/resources/categories_sources/categories_sources_get_many_test.rb
+- examples/datacatalog/test/resources/categories_sources/categories_sources_get_one_test.rb
+- examples/datacatalog/test/resources/categories_sources/categories_sources_post_test.rb
+- examples/datacatalog/test/resources/categories_sources/categories_sources_put_test.rb
 - examples/datacatalog/test/resources/sources/sources_delete_test.rb
 - examples/datacatalog/test/resources/sources/sources_get_many_test.rb
 - examples/datacatalog/test/resources/sources/sources_get_one_test.rb
@@ -158,6 +165,7 @@ files:
 - examples/datacatalog/test/resources/users/users_post_test.rb
 - examples/datacatalog/test/resources/users/users_put_test.rb
 - lib/builder.rb
+- lib/builder/action_definitions.rb
 - lib/builder/helpers.rb
 - lib/builder/mongo_helpers.rb
 - lib/exceptions.rb
@@ -217,6 +225,7 @@ test_files:
 - examples/datacatalog/models/source.rb
 - examples/datacatalog/models/user.rb
 - examples/datacatalog/resources/categories.rb
+- examples/datacatalog/resources/categories_sources.rb
 - examples/datacatalog/resources/sources.rb
 - examples/datacatalog/resources/users.rb
 - examples/datacatalog/test/helpers/assertions/assert_include.rb
@@ -228,6 +237,7 @@ test_files:
 - examples/datacatalog/test/helpers/resource_test_helper.rb
 - examples/datacatalog/test/helpers/shared/api_keys.rb
 - examples/datacatalog/test/helpers/shared/common_body_responses.rb
+- examples/datacatalog/test/helpers/shared/model_counts.rb
 - examples/datacatalog/test/helpers/shared/status_codes.rb
 - examples/datacatalog/test/helpers/test_cases/model_test_case.rb
 - examples/datacatalog/test/helpers/test_cases/resource_test_case.rb
@@ -241,6 +251,11 @@ test_files:
 - examples/datacatalog/test/resources/categories/categories_get_one_test.rb
 - examples/datacatalog/test/resources/categories/categories_post_test.rb
 - examples/datacatalog/test/resources/categories/categories_put_test.rb
+- examples/datacatalog/test/resources/categories_sources/categories_sources_delete_test.rb
+- examples/datacatalog/test/resources/categories_sources/categories_sources_get_many_test.rb
+- examples/datacatalog/test/resources/categories_sources/categories_sources_get_one_test.rb
+- examples/datacatalog/test/resources/categories_sources/categories_sources_post_test.rb
+- examples/datacatalog/test/resources/categories_sources/categories_sources_put_test.rb
 - examples/datacatalog/test/resources/sources/sources_delete_test.rb
 - examples/datacatalog/test/resources/sources/sources_get_many_test.rb
 - examples/datacatalog/test/resources/sources/sources_get_one_test.rb