sinatra_resource 0.3.2 → 0.3.3

data/lib/builder/mongo_helpers.rb

@@ -17,14 +17,17 @@ module SinatraResource
       # @param [String] child_id
       #
       # @return [MongoMapper::Document]
-      def check_related?(parent, association, child_id)
-        unless parent.send(association).find { |x| x.id == child_id }
-          error 404, convert(body_for(:not_found))
-        end
+      def check_related?(parent, child_assoc, child_id)
+        children = parent.send(child_assoc)
+        find_child!(children, child_id)
+        true
       end
       
       # Create a document from params. If not valid, returns 400.
       #
+      # @param [Class] model
+      #   a class that includes MongoMapper::Document
+      #
       # @return [MongoMapper::Document]
       def create_document!(model)
         document = model.new(params)
@@ -36,9 +39,43 @@ module SinatraResource
         end
         document
       end
+
+      # Create a nested document from params. If not valid, returns 400.
+      #
+      # @param [Class] child_model
+      #   a class that includes either:
+      #     * MongoMapper::Document
+      #     * MongoMapper::EmbeddedDocument
+      #
+      # @param [String] child_id
+      #
+      # @return [MongoMapper::Document]
+      def create_nested_document!(parent, child_assoc, child_model)
+        child = child_model.new(params)
+        if child_model.embeddable?
+          parent.send(child_assoc) << child
+          unless parent.valid?
+            error 400, convert(body_for(:invalid_document, child))
+          end
+          unless parent.save
+            error 400, convert(body_for(:internal_server_error))
+          end
+        else
+          unless child.valid?
+            error 400, convert(body_for(:invalid_document, child))
+          end
+          unless child.save
+            error 400, convert(body_for(:internal_server_error))
+          end
+        end
+        child
+      end
       
       # Delete a document with +id+.
       #
+      # @param [Class] model
+      #   a class that includes MongoMapper::Document
+      #
       # @param [String] id
       #
       # @return [MongoMapper::Document]
@@ -48,8 +85,65 @@ module SinatraResource
         document
       end
 
+      # Delete a nested document.
+      #
+      # @param [MongoMapper::Document] parent
+      #
+      # @param [Symbol] child_assoc
+      #   association (a method) from parent to child
+      #
+      # @param [Class] child_model
+      #   a class that includes either:
+      #     * MongoMapper::Document
+      #     * MongoMapper::EmbeddedDocument
+      #
+      # @param [String] id
+      #
+      # @return [MongoMapper::Document]
+      def delete_nested_document!(parent, child_assoc, child_model, child_id)
+        if child_model.embeddable?
+          children = parent.send(child_assoc)
+          child = find_child!(children, child_id)
+          children.delete(child)
+          unless parent.save
+            error 400, convert(body_for(:internal_server_error))
+          end
+          child
+        else
+          delete_document!(child_model, child_id)
+        end
+      end
+
+      # Find document with +child_id+ in +children+.
+      #
+      # @params [<MongoMapper::EmbeddedDocument>] children
+      #
+      # @params [String] child_id
+      #
+      # @return [MongoMapper::EmbeddedDocument]
+      def find_child(children, child_id)
+        raise Error, "children not true" unless children
+        children.detect { |x| x.id == child_id }
+      end
+
+      # Find document with +child_id+ in +children+ or raise 404.
+      #
+      # @params [<MongoMapper::EmbeddedDocument>] children
+      #
+      # @params [String] child_id
+      #
+      # @return [MongoMapper::EmbeddedDocument]
+      def find_child!(children, child_id)
+        child = find_child(children, child_id)
+        error 404, convert(body_for(:not_found)) unless child
+        child
+      end
+
       # Find a document with +id+. If not found, returns 404.
       #
+      # @param [Class] model
+      #   a class that includes MongoMapper::Document
+      #
       # @param [String] id
       #
       # @return [MongoMapper::Document]
@@ -61,6 +155,51 @@ module SinatraResource
         document
       end
 
+      # Find a nested document. If not found, returns nil.
+      #
+      # @param [MongoMapper::Document] parent_document
+      #
+      # @param [Symbol] association
+      #
+      # @param [Class] child_model
+      #   a class that includes either:
+      #     * MongoMapper::Document
+      #     * MongoMapper::EmbeddedDocument
+      #
+      # @param [String] child_id
+      #
+      # @return [MongoMapper::Document]
+      def find_nested_document(parent, child_assoc, child_model, child_id)
+        if child_model.embeddable?
+          children = parent.send(child_assoc)
+          find_child(children, child_id)
+        else
+          child_model.find_by_id(child_id)
+        end
+      end
+      
+      # Find a nested document. If not found, returns 404.
+      #
+      # @param [MongoMapper::Document] parent_document
+      #
+      # @param [Symbol] association
+      #
+      # @param [Class] child_model
+      #   a class that includes either:
+      #     * MongoMapper::Document
+      #     * MongoMapper::EmbeddedDocument
+      #
+      # @param [String] child_id
+      #
+      # @return [MongoMapper::Document]
+      def find_nested_document!(parent, child_assoc, child_model, child_id)
+        document = find_nested_document(parent, child_assoc, child_model, child_id)
+        unless document
+          error 404, convert(body_for(:not_found))
+        end
+        document
+      end
+
       # Find +model+ documents: find all documents if no params, otherwise
       # find selected documents.
       #
@@ -72,11 +211,44 @@ module SinatraResource
         return(model.all) if params.empty?
         model.all(make_conditions(params, model))
       end
+
+      # Find nested +child_model+ documents: find all documents if no
+      # params, otherwise find selected documents.
+      #
+      # @param [MongoMapper::Document] parent
+      #
+      # @param [Symbol] child_assoc
+      #   association (a method) from parent to child
+      #
+      # @param [Class] child_model
+      #   a class that includes either:
+      #     * MongoMapper::Document
+      #     * MongoMapper::EmbeddedDocument
+      #
+      # @return [Array<MongoMapper::Document>]
+      def find_nested_documents!(parent, child_assoc, child_model)
+        documents = if child_model.embeddable?
+          children = parent.send(child_assoc)
+          if params.empty?
+            children
+          else
+            children.all(make_conditions(params, child_model))
+          end
+        else
+          children = if params.empty?
+            child_model.all
+          else
+            child_model.all(make_conditions(params, child_model))
+          end
+          select_related(parent, child_assoc, children)
+        end
+      end
       
       # Delegates to application, who should use custom logic to related
       # +parent+ and +child+.
       #
       # @param [MongoMapper::Document] parent
+      #   a class that includes MongoMapper::Document
       #
       # @param [MongoMapper::Document] child
       #
@@ -89,27 +261,10 @@ module SinatraResource
         child
       end
       
-      # Select only the +children+ that are related to the +parent+ by
-      # way of the +association+.
-      #
-      # @param [MongoMapper::Document] parent
-      #
-      # @param [Symbol] association
-      #
-      # @param [Array<MongoMapper::Document>] children
-      #
-      # @return [MongoMapper::Document]
-      def select_related(parent, association, children)
-        children.select do |child|
-          parent.send(association).find { |x| x.id == child.id }
-        end
-        # TODO: this has O^2 complexity because of the nesting.
-        # I think it is reducible to O.
-      end
-
       # Update a document with +id+ from params. If not valid, returns 400.
       #
-      # @param [Hash] model
+      # @param [Class] model
+      #   a class that includes MongoMapper::Document
       #
       # @param [String] id
       #
@@ -122,6 +277,37 @@ module SinatraResource
         document
       end
       
+      # Update a nested document with params. If not valid, returns 400.
+      #
+      # @param [MongoMapper::Document] parent
+      #
+      # @param [Symbol] child_assoc
+      #   association (a method) from parent to child
+      #
+      # @param [Class] child_model
+      #   a class that includes either:
+      #     * MongoMapper::Document
+      #     * MongoMapper::EmbeddedDocument
+      #
+      # @param [String] child_id
+      #
+      # @return [MongoMapper::Document]
+      def update_nested_document!(parent, child_assoc, child_model, child_id)
+        if child_model.embeddable?
+          children = parent.send(child_assoc)
+          child = find_child!(children, child_id)
+          child_index = children.index(child)
+          child.attributes = params
+          children[child_index] = child
+          unless parent.save
+            error 400, convert(body_for(:internal_server_error))
+          end
+          child
+        else
+          update_document!(child_model, child_id)
+        end
+      end
+      
       protected
 
       PATTERNS = [
@@ -144,7 +330,45 @@ module SinatraResource
       def make_conditions(params, model)
         filter_string = params["filter"]
         return {} unless filter_string
-        QS_FILTER.parse(filter_string)
+        unsafe = QS_FILTER.parse(filter_string)
+        sanitize(unsafe, model)
+      end
+      
+      # Filter out +conditions+ that do not have corresponding keys in
+      # +model+. This is part of the process that prevents a user from
+      # searching for parameters that they do not have access to.
+      #
+      # TODO: in order for this model to do the job stated above, it will
+      # need to get access to the current role as well.
+      #
+      # @param [Hash] conditions
+      #   A hash of unsanitized conditions
+      #
+      # @param [Class] model
+      #   a class that includes MongoMapper::Document
+      #
+      # @return [Hash]
+      def sanitize(conditions, model)
+        conditions # TODO: incomplete
+      end
+
+      # Select only the +children+ that are related to the +parent+ by
+      # way of the +association+.
+      #
+      # @param [MongoMapper::Document] parent
+      #   a class that includes MongoMapper::Document
+      #
+      # @param [Symbol] association
+      #
+      # @param [Array<MongoMapper::Document>] children
+      #
+      # @return [MongoMapper::Document]
+      def select_related(parent, child_assoc, children)
+        children.select do |child|
+          parent.send(child_assoc).find { |x| x.id == child.id }
+        end
+        # Note: This has O^2 complexity because of the nesting.
+        # Can it be done more quickly?
       end
 
       # Returns a typecasted +value+. (Uses +model+ and +key_string+ to

data/lib/builder.rb

@@ -5,11 +5,11 @@ module SinatraResource
     def initialize(klass)
       @klass  = klass
 
-      @resource_config   = @klass.resource_config
-      @child_association = @resource_config[:child_association]
-      @model             = @resource_config[:model]
-      @parent            = @resource_config[:parent]
-      @path              = @resource_config[:path]
+      @resource_config = @klass.resource_config
+      @child_assoc     = @resource_config[:child_assoc]
+      @model           = @resource_config[:model]
+      @parent          = @resource_config[:parent]
+      @path            = @resource_config[:path]
       if @parent
         @parent_resource_config = @parent.resource_config
         @parent_model           = @parent_resource_config[:model]
@@ -31,26 +31,26 @@ module SinatraResource
       if !@parent
         @klass.get '/:id/?' do
           id = params.delete("id")
-          role = get_role(model, id)
+          role = role_for(model, id)
           document = document_for_get_one(role, model, resource_config, true, id, nil, nil)
           resource = build_resource(role, document, resource_config)
           display(:read, resource, resource_config)
         end
       else
-        association            = @child_association
+        child_assoc            = @child_assoc
         parent_model           = @parent_model
         parent_resource_config = @parent_resource_config
         path                   = @path
         @parent.get "/:parent_id/#{path}/:id/?" do
           id = params.delete("id")
           parent_id = params.delete("parent_id")
-          parent_role = get_role(parent_model, parent_id)
+          parent_role = role_for(parent_model, parent_id)
           parent_document = document_for_get_one(parent_role, parent_model, parent_resource_config, false, parent_id, nil, nil)
           # ------
-          role = get_role(model, id)
-          document = document_for_get_one(role, model, resource_config, true, id, parent_document, association)
+          role = role_for_nested(parent_document, child_assoc, model, id)
+          document = document_for_get_one(role, model, resource_config, true, id, parent_document, child_assoc)
           resource = build_resource(role, document, resource_config)
-          display(:read, resource, resource_config)
+          display(:read, resource, resource_config, parent_id)
         end
       end
     end
@@ -60,25 +60,25 @@ module SinatraResource
       resource_config = @resource_config
       if !@parent
         @klass.get '/?' do
-          role = get_role(model)
+          role = lookup_role(nil)
           documents = documents_for_get_many(role, model, resource_config, true, nil, nil)
           resources = build_resources(documents, resource_config)
           display(:list, resources, resource_config)
         end
       else
-        association            = @child_association
+        child_assoc            = @child_assoc
         parent_model           = @parent_model
         parent_resource_config = @parent_resource_config
         path                   = @path
         @parent.get "/:parent_id/#{path}/?" do
           parent_id = params.delete("parent_id")
-          parent_role = get_role(parent_model, parent_id)
+          parent_role = role_for(parent_model, parent_id)
           parent_document = document_for_get_one(parent_role, parent_model, parent_resource_config, false, parent_id, nil, nil)
           # ------
-          role = get_role(model)
-          documents = documents_for_get_many(role, model, resource_config, true, parent_document, association)
+          role = lookup_role(nil)
+          documents = documents_for_get_many(role, model, resource_config, true, parent_document, child_assoc)
           resources = build_resources(documents, resource_config)
-          display(:list, resources, resource_config)
+          display(:list, resources, resource_config, parent_id)
         end
       end
     end
@@ -88,25 +88,25 @@ module SinatraResource
       resource_config = @resource_config
       if !@parent
         @klass.post '/?' do
-          role = get_role(model)
+          role = lookup_role(nil)
           document = document_for_post(role, model, resource_config, true, nil, nil)
           resource = build_resource(role, document, resource_config)
           display(:create, resource, resource_config)
         end
       else
-        association            = @child_association
+        child_assoc            = @child_assoc
         parent_model           = @parent_model
         parent_resource_config = @parent_resource_config
         path                   = @path
         @parent.post "/:parent_id/#{path}/?" do
           parent_id = params.delete("parent_id")
-          parent_role = get_role(parent_model, parent_id)
+          parent_role = role_for(parent_model, parent_id)
           parent_document = document_for_get_one(parent_role, parent_model, parent_resource_config, false, parent_id, nil, nil)
           # ------
-          role = get_role(model)
-          document = document_for_post(role, model, resource_config, true, parent_document, association)
+          role = lookup_role(nil)
+          document = document_for_post(role, model, resource_config, true, parent_document, child_assoc)
           resource = build_resource(role, document, resource_config)
-          display(:create, resource, resource_config)
+          display(:create, resource, resource_config, parent_id)
         end
       end
     end
@@ -117,26 +117,26 @@ module SinatraResource
       if !@parent
         @klass.put '/:id/?' do
           id = params.delete("id")
-          role = get_role(model, id)
+          role = role_for(model, id)
           document = document_for_put(role, model, resource_config, true, id, nil, nil)
           resource = build_resource(role, document, resource_config)
           display(:update, resource, resource_config)
         end
       else
-        association            = @child_association
+        child_assoc            = @child_assoc
         parent_model           = @parent_model
         parent_resource_config = @parent_resource_config
         path                   = @path
         @parent.put "/:parent_id/#{path}/:id/?" do
           id = params.delete("id")
           parent_id = params.delete("parent_id")
-          parent_role = get_role(parent_model, parent_id)
+          parent_role = role_for(parent_model, parent_id)
           parent_document = document_for_get_one(parent_role, parent_model, parent_resource_config, false, parent_id, id, id)
           # ------
-          role = get_role(model, id)
-          document = document_for_put(role, model, resource_config, true, id, parent_document, association)
+          role = role_for_nested(parent_document, child_assoc, model, id)
+          document = document_for_put(role, model, resource_config, true, id, parent_document, child_assoc)
           resource = build_resource(role, document, resource_config)
-          display(:update, resource, resource_config)
+          display(:update, resource, resource_config, parent_id)
         end
       end
     end
@@ -147,24 +147,24 @@ module SinatraResource
       if !@parent
         @klass.delete '/:id/?' do
           id = params.delete("id")
-          role = get_role(model, id)
+          role = role_for(model, id)
           document_for_delete(role, model, resource_config, true, id, nil, nil)
           display(:delete, "", resource_config)
         end
       else
-        association            = @child_association
+        child_assoc            = @child_assoc
         parent_model           = @parent_model
         parent_resource_config = @parent_resource_config
         path                   = @path
         @parent.delete "/:parent_id/#{path}/:id/?" do
           id = params.delete("id")
           parent_id = params.delete("parent_id")
-          parent_role = get_role(parent_model, parent_id)
+          parent_role = role_for(parent_model, parent_id)
           parent_document = document_for_get_one(parent_role, parent_model, parent_resource_config, false, parent_id, nil, nil)
           # ------
-          role = get_role(model, id)
-          document_for_delete(role, model, resource_config, true, id, parent_document, association)
-          display(:delete, "", resource_config)
+          role = role_for_nested(parent_document, child_assoc, model, id)
+          document_for_delete(role, model, resource_config, true, id, parent_document, child_assoc)
+          display(:delete, "", resource_config, parent_id)
         end
       end
     end

data/lib/resource.rb

@@ -17,7 +17,7 @@ module SinatraResource
       # Specify a callback.
       #
       # @param [Symbol] method
-      #   A symbol that refers to a method on the parent.
+      #   A symbol that refers to a method on the model.
       #
       # @return [undefined]
       def callback(name, &block)
@@ -30,18 +30,20 @@ module SinatraResource
         @resource_config[:callbacks][name] = block
       end
       
-      # Specify the association +method+ on +parent+ that points to the
-      # current (child) +model+.
+      # Specify the association +method+ of a parent model that points to
+      # its child model.
+      #
+      # Required for all nested resources.
       #
       # @param [Symbol] method
       #   A symbol that refers to a method on the parent.
       #
       # @return [undefined]
       def child_association(method)
-        if @resource_config[:child_association]
+        if @resource_config[:child_assoc]
           raise DefinitionError, "child_association already declared in #{self}"
         end
-        @resource_config[:child_association] = method
+        @resource_config[:child_assoc] = method
       end
       
       # Build the Sinatra actions based on the DSL statements in this class.
@@ -89,7 +91,7 @@ module SinatraResource
         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.)
       #
@@ -215,25 +217,25 @@ module SinatraResource
       # For internal use. Initializes internal data structure.
       def setup
         @resource_config = {
-          :callbacks         => {
-            :before_create   => nil,
-            :after_create    => nil,
-            :before_update   => nil,
-            :after_update    => nil,
-            :before_destroy  => nil,
-            :after_destroy   => nil,
+          :callbacks        => {
+            :before_create  => nil,
+            :after_create   => nil,
+            :before_update  => nil,
+            :after_update   => nil,
+            :before_destroy => nil,
+            :after_destroy  => nil,
           },
-          :child_association => nil,
-          :model             => nil,
-          :parent            => nil,
-          :path              => nil, # default_path,
-          :permission        => {},
-          :properties        => {},
-          :relation          => {
-            :create          => nil,
-            :delete          => nil,
+          :child_assoc      => nil,
+          :model            => nil,
+          :parent           => nil,
+          :path             => nil,
+          :permission       => {},
+          :properties       => {},
+          :relation         => {
+            :create         => nil,
+            :delete         => nil,
           },
-          :roles             => nil,
+          :roles            => nil,
         }
       end
       

data/sinatra_resource.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra_resource}
-  s.version = "0.3.2"
+  s.version = "0.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David James"]
-  s.date = %q{2009-10-28}
+  s.date = %q{2009-10-29}
   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 = [
@@ -35,11 +35,13 @@ Gem::Specification.new do |s|
      "examples/datacatalog/models/category.rb",
      "examples/datacatalog/models/note.rb",
      "examples/datacatalog/models/source.rb",
+     "examples/datacatalog/models/usage.rb",
      "examples/datacatalog/models/user.rb",
      "examples/datacatalog/resources/categories.rb",
      "examples/datacatalog/resources/categories_sources.rb",
      "examples/datacatalog/resources/notes.rb",
      "examples/datacatalog/resources/sources.rb",
+     "examples/datacatalog/resources/sources_usages.rb",
      "examples/datacatalog/resources/users.rb",
      "examples/datacatalog/tasks/db.rake",
      "examples/datacatalog/tasks/test.rake",
@@ -81,6 +83,11 @@ Gem::Specification.new do |s|
      "examples/datacatalog/test/resources/sources/sources_get_one_test.rb",
      "examples/datacatalog/test/resources/sources/sources_post_test.rb",
      "examples/datacatalog/test/resources/sources/sources_put_test.rb",
+     "examples/datacatalog/test/resources/sources_usages/sources_usages_delete_test.rb",
+     "examples/datacatalog/test/resources/sources_usages/sources_usages_get_many_test.rb",
+     "examples/datacatalog/test/resources/sources_usages/sources_usages_get_one_test.rb",
+     "examples/datacatalog/test/resources/sources_usages/sources_usages_post_test.rb",
+     "examples/datacatalog/test/resources/sources_usages/sources_usages_put_test.rb",
      "examples/datacatalog/test/resources/users/users_delete_test.rb",
      "examples/datacatalog/test/resources/users/users_get_many_test.rb",
      "examples/datacatalog/test/resources/users/users_get_one_test.rb",
@@ -124,11 +131,13 @@ Gem::Specification.new do |s|
      "examples/datacatalog/models/category.rb",
      "examples/datacatalog/models/note.rb",
      "examples/datacatalog/models/source.rb",
+     "examples/datacatalog/models/usage.rb",
      "examples/datacatalog/models/user.rb",
      "examples/datacatalog/resources/categories.rb",
      "examples/datacatalog/resources/categories_sources.rb",
      "examples/datacatalog/resources/notes.rb",
      "examples/datacatalog/resources/sources.rb",
+     "examples/datacatalog/resources/sources_usages.rb",
      "examples/datacatalog/resources/users.rb",
      "examples/datacatalog/test/helpers/assertions/assert_include.rb",
      "examples/datacatalog/test/helpers/assertions/assert_not_include.rb",
@@ -168,6 +177,11 @@ Gem::Specification.new do |s|
      "examples/datacatalog/test/resources/sources/sources_get_one_test.rb",
      "examples/datacatalog/test/resources/sources/sources_post_test.rb",
      "examples/datacatalog/test/resources/sources/sources_put_test.rb",
+     "examples/datacatalog/test/resources/sources_usages/sources_usages_delete_test.rb",
+     "examples/datacatalog/test/resources/sources_usages/sources_usages_get_many_test.rb",
+     "examples/datacatalog/test/resources/sources_usages/sources_usages_get_one_test.rb",
+     "examples/datacatalog/test/resources/sources_usages/sources_usages_post_test.rb",
+     "examples/datacatalog/test/resources/sources_usages/sources_usages_put_test.rb",
      "examples/datacatalog/test/resources/users/users_delete_test.rb",
      "examples/datacatalog/test/resources/users/users_get_many_test.rb",
      "examples/datacatalog/test/resources/users/users_get_one_test.rb",