sinatra_resource 0.2.0 → 0.2.1

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/examples/datacatalog/models/category.rb

@@ -6,7 +6,8 @@ module DataCatalog
 
     # == Attributes
 
-    key :name,        String
+    key :name, String
+    key :log,  String
     timestamps!
 
     # == Indices

data/examples/datacatalog/resources/categories.rb

@@ -14,6 +14,7 @@ module DataCatalog
     # == Properties
     
     property :name
+    property :log
 
     property :sources do |category|
       category.sources.map do |source|
@@ -25,6 +26,34 @@ module DataCatalog
         }
       end
     end
+    
+    # == Callbacks
+    
+    callback :before_create do |action|
+      action.params["log"] = "before_create"
+    end
+    
+    callback :after_create do |action, category|
+      category.log += " after_create"
+    end
+
+    callback :before_update do |action|
+      action.params["log"] = "before_update"
+    end
+    
+    callback :after_update do |action, category|
+      category.log += " after_update"
+    end
+
+    callback :before_destroy do |action|
+      action.headers 'X-Test-Callbacks' => 'before_destroy'
+    end
+    
+    callback :after_destroy do |action, category|
+      x = action.response['X-Test-Callbacks']
+      action.headers 'X-Test-Callbacks' => "#{x} after_destroy"
+    end
+
   end
   
   Categories.build

data/examples/datacatalog/test/resources/categories/categories_delete_test.rb

@@ -94,6 +94,11 @@ class CategoriesDeleteResourceTest < ResourceTestCase
       
       use "return 204 No Content"
       use "one less category"
+      
+      test "callbacks should work" do
+        actual = last_response.headers['X-Test-Callbacks']
+        assert_equal "before_destroy after_destroy", actual
+      end
     end
   end
   

data/examples/datacatalog/test/resources/categories/categories_get_many_test.rb

@@ -54,7 +54,7 @@ class CategoriesGetManyResourceTest < ResourceTestCase
         assert_equal CATEGORIES, actual.sort
       end
       
-      docs_properties %w(name sources id created_at updated_at)
+      docs_properties %w(name log sources id created_at updated_at)
     end
   end
 

data/examples/datacatalog/test/resources/categories/categories_get_one_test.rb

@@ -57,7 +57,7 @@ class CategoriesGetOneResourceTest < ResourceTestCase
       end
 
       use "return 200 Ok"
-      doc_properties %w(name id created_at updated_at sources)
+      doc_properties %w(name log id created_at updated_at sources)
       
       test "body should have correct sources" do
         expected = [

data/examples/datacatalog/test/resources/categories/categories_post_test.rb

@@ -66,8 +66,7 @@ class CategoriesPostResourceTest < ResourceTestCase
     end
   end
 
-  %w(curator).each do |role|
-  # %w(curator admin).each do |role|
+  %w(curator admin).each do |role|
     [:name].each do |missing|
       context "#{role} : post / but missing #{missing}" do
         before do
@@ -104,7 +103,7 @@ class CategoriesPostResourceTest < ResourceTestCase
       use "return 201 Created"
       location_header "categories"
       use "one new category"
-      doc_properties %w(name id created_at updated_at sources)
+      doc_properties %w(name log id created_at updated_at sources)
       
       test "should set all fields in database" do
         category = Category.find_by_id(parsed_response_body["id"])
@@ -113,6 +112,10 @@ class CategoriesPostResourceTest < ResourceTestCase
           assert_equal value, category[key]
         end
       end
+      
+      test "callbacks should work" do
+        assert_equal "before_create after_create", parsed_response_body["log"]
+      end
     end
   end
 

data/examples/datacatalog/test/resources/categories/categories_put_test.rb

@@ -120,7 +120,7 @@ class CategoriesPutResourceTest < ResourceTestCase
       end
       
       use "return 200 Ok"
-      doc_properties %w(name id created_at updated_at sources)
+      doc_properties %w(name log id created_at updated_at sources)
     
       test "should change all fields in database" do
         category = Category.find_by_id(@category.id)
@@ -128,6 +128,10 @@ class CategoriesPutResourceTest < ResourceTestCase
           assert_equal value, category[key]
         end
       end
+      
+      test "callbacks should work" do
+        assert_equal "before_update after_update", parsed_response_body["log"]
+      end
     end
   end
 

data/lib/builder/action_definitions.rb

@@ -28,10 +28,12 @@ module SinatraResource
       def document_for_post(role, model, resource_config, leaf, parent_document, association)
         check_permission(:create, role, resource_config)
         check_params(:create, role, resource_config, leaf)
+        do_callback(:before_create, resource_config, nil)
         document = create_document!(model)
         if resource_config[:parent]
           make_related(parent_document, document, resource_config)
         end
+        do_callback(:after_create, resource_config, document)
         document
       end
       
@@ -41,7 +43,10 @@ module SinatraResource
           check_related?(parent_document, association, id)
         end
         check_params(:update, role, resource_config, leaf)
-        update_document!(model, id)
+        do_callback(:before_update, resource_config, nil)
+        document = update_document!(model, id)
+        do_callback(:after_update, resource_config, document)
+        document
       end
       
       def document_for_delete(role, model, resource_config, leaf, id, parent_document, association)
@@ -50,7 +55,10 @@ module SinatraResource
           check_related?(parent_document, association, id)
         end
         check_params(:delete, role, resource_config, leaf)
-        delete_document!(model, id)
+        do_callback(:before_destroy, resource_config, nil)
+        document = delete_document!(model, id)
+        do_callback(:after_destroy, resource_config, document)
+        document
       end
 
     end

data/lib/builder/helpers.rb

@@ -111,6 +111,16 @@ module SinatraResource
         end
         convert(object)
       end
+      
+      def do_callback(name, resource_config, document)
+        proc = resource_config[:callbacks][name]
+        return unless proc
+        if document
+          proc.call(self, document)
+        else
+          proc.call(self)
+        end
+      end
 
       # Convert a path to a full URI.
       #

data/lib/resource.rb

@@ -14,6 +14,22 @@ module SinatraResource
       
       attr_reader :resource_config
       
+      # Specify a callback.
+      #
+      # @param [Symbol] method
+      #   A symbol that refers to a method on the parent.
+      #
+      # @return [undefined]
+      def callback(name, &block)
+        unless @resource_config[:callbacks].include?(name)
+          raise DefinitionError, "callback #{name.inspect} is not supported #{self}"
+        end
+        if @resource_config[:callbacks][name]
+          raise DefinitionError, "callback #{name.inspect} already declared in #{self}"
+        end
+        @resource_config[:callbacks][name] = block
+      end
+      
       # Specify the association +method+ on +parent+ that points to the
       # current (child) +model+.
       #
@@ -188,13 +204,24 @@ 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,
+          },
           :child_association => nil,
           :model             => nil,
           :parent            => nil,
           :path              => nil, # default_path,
           :permission        => {},
           :properties        => {},
-          :relation          => { :create => nil, :delete => nil },
+          :relation          => {
+            :create          => nil,
+            :delete          => nil,
+          },
           :roles             => nil,
         }
       end

data/sinatra_resource.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra_resource}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David James"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra_resource
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - David James