jsonapi-resources 0.0.16 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7b404cc6b45386898cdeda9754dae8c7cc993d0
-  data.tar.gz: db594be4a5815e815380940a43fde76d178daad1
+  metadata.gz: 9857d701e9136cba9b504cc0439b43e939722565
+  data.tar.gz: 5696329e4c5865e17b7b3bb0f6a40d4840a06f16
 SHA512:
-  metadata.gz: bcaffc65ba5ad2cbf7fd70fa444b2bc97c05f973bd3056b15089af830bbfa7c9c53804aa130ba6de78370a45fdb064c7af193e81716f82dbe8f8dc7bc2df2ebf
-  data.tar.gz: 34f9f78a40732753b294470c0b6cb1ae6548bb726d573fec05b25fe27b1df6436dd48dab7f41e8818c880ecd4204282e2fa0f01ea1dc77d4338c3258fca1e0ba
+  metadata.gz: 00981170f6a4d0743a298cc8478c9cf2e8d7cd07153a204fc878188a07aaeb79d3ed45529a2f3cc5a84dde326d2697b0faa880c619a9554e4689d0d60fb8f4c8
+  data.tar.gz: 8b42c9bdc12fc6b40aaec0e18b73d2871899047ce86ef77d8edf28e5775872337de9f83b4bc883d647fa4f563330a0987046c59ac4bf41f051d8f2f97a416e1e

data/README.md

@@ -124,7 +124,7 @@ class ContactResource < JSONAPI::Resource
     super - [:full_name]
   end
 
-  def self.createable_fields(keys, context)
+  def self.createable_fields(context)
     super - [:full_name]
   end
 end
@@ -330,6 +330,49 @@ class AuthorResource < JSONAPI::Resource
 end
 ```
 
+#### Callbacks
+
+`ActiveSupport::Callbacks` is used to provide callback functionality, so the behavior is very similar to what you may be used to from `ActiveRecord`.
+
+For example, you might use a callback to perform authorization on your resource before an action.
+
+```ruby
+class BaseResource < JSONAPI::Resource
+  before_create :authorize_create
+
+  def authorize_create
+    # ...
+  end
+end
+```
+
+The types of supported callbacks are:
+- `before`
+- `after`
+- `around`
+
+##### `JSONAPI::Resource` Callbacks
+
+Callbacks can be defined for the following `JSONAPI::Resource` events:
+
+- `:create`
+- `:update`
+- `:remove`
+- `:save`
+- `:create_has_many_link`
+- `:replace_has_many_links`
+- `:create_has_one_link`
+- `:replace_has_one_link`
+- `:remove_has_many_link`
+- `:remove_has_one_link`
+- `:replace_fields`
+
+##### `JSONAPI::OperationsProcessor` Callbacks
+
+Callbacks can also be defined for `JSONAPI::OperationsProcessor` events:
+- `:operations`: The set of operations.
+- `:operation`: The individual operations.
+
 ### Controllers
 
 `JSONAPI::Resources` provides a class, `ResourceController`, that can be used as the base class for your controllers. `ResourceController` supports `index`, `show`, `create`, `update`, and `destroy` methods. Just deriving your controller from `ResourceController` will give you a fully functional controller.

data/lib/jsonapi/callbacks.rb

@@ -0,0 +1,52 @@
+require 'active_support/callbacks'
+
+module JSONAPI
+  module Callbacks
+
+    def self.included(base)
+      base.class_eval do
+        include ActiveSupport::Callbacks
+        base.extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def define_jsonapi_resources_callbacks(*callbacks)
+        options = callbacks.extract_options!
+        options = {
+          only: [:before, :around, :after]
+        }.merge!(options)
+
+        types = Array(options.delete(:only))
+
+        callbacks.each do |callback|
+          define_callbacks(callback, options)
+
+          types.each do |type|
+            send("_define_#{type}_callback", self, callback)
+          end
+        end
+      end
+
+      private
+
+      def _define_before_callback(klass, callback) #:nodoc:
+        klass.define_singleton_method("before_#{callback}") do |*args, &block|
+          set_callback(:"#{callback}", :before, *args, &block)
+        end
+      end
+
+      def _define_around_callback(klass, callback) #:nodoc:
+        klass.define_singleton_method("around_#{callback}") do |*args, &block|
+          set_callback(:"#{callback}", :around, *args, &block)
+        end
+      end
+
+      def _define_after_callback(klass, callback) #:nodoc:
+        klass.define_singleton_method("after_#{callback}") do |*args, &block|
+          set_callback(:"#{callback}", :after, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/operation.rb

@@ -22,7 +22,6 @@ module JSONAPI
     def apply(context)
       resource = @resource_klass.create(context)
       resource.replace_fields(@values)
-      resource.save
 
       return JSONAPI::OperationResult.new(:created, resource)
 
@@ -64,7 +63,6 @@ module JSONAPI
     def apply(context)
       resource = @resource_klass.find_by_key(@resource_id, context: context)
       resource.replace_fields(values)
-      resource.save
 
       return JSONAPI::OperationResult.new(:ok, resource)
     end
@@ -83,7 +81,6 @@ module JSONAPI
     def apply(context)
       resource = @resource_klass.find_by_key(@resource_id, context: context)
       resource.create_has_one_link(@association_type, @key_value)
-      resource.save
 
       return JSONAPI::OperationResult.new(:no_content)
     end
@@ -102,7 +99,6 @@ module JSONAPI
     def apply(context)
       resource = @resource_klass.find_by_key(@resource_id, context: context)
       resource.replace_has_one_link(@association_type, @key_value)
-      resource.save
 
       return JSONAPI::OperationResult.new(:no_content)
     end
@@ -120,9 +116,7 @@ module JSONAPI
 
     def apply(context)
       resource = @resource_klass.find_by_key(@resource_id, context: context)
-      @key_values.each do |value|
-        resource.create_has_many_link(@association_type, value)
-      end
+      resource.create_has_many_links(@association_type, @key_values)
 
       return JSONAPI::OperationResult.new(:no_content)
     end
@@ -141,7 +135,6 @@ module JSONAPI
     def apply(context)
       resource = @resource_klass.find_by_key(@resource_id, context: context)
       resource.replace_has_many_links(@association_type, @key_values)
-      resource.save
 
       return JSONAPI::OperationResult.new(:no_content)
     end
@@ -180,7 +173,6 @@ module JSONAPI
     def apply(context)
       resource = @resource_klass.find_by_key(@resource_id, context: context)
       resource.remove_has_one_link(@association_type)
-      resource.save
 
       return JSONAPI::OperationResult.new(:no_content)
     end

data/lib/jsonapi/operations_processor.rb

@@ -1,37 +1,35 @@
 require 'jsonapi/operation_result'
+require 'jsonapi/callbacks'
 
 module JSONAPI
   class OperationsProcessor
+    include Callbacks
+    define_jsonapi_resources_callbacks :operation, :operations
 
     def process(request)
       @results = []
-      @resources = []
-
-      context = request.context
-
-      transaction {
-        request.operations.each do |operation|
-          before_operation(context, operation)
-
-          result = operation.apply(context)
-
-          after_operation(context, result)
-
-          @results.push(result)
-          if result.has_errors?
-            rollback
+      @request = request
+      @context = request.context
+      @operations = request.operations
+
+      run_callbacks :operations do
+        transaction do
+          @operations.each do |operation|
+            @operation = operation
+            @result = nil
+            run_callbacks :operation do
+              @result = @operation.apply(@context)
+              @results.push(@result)
+              if @result.has_errors?
+                rollback
+              end
+            end
           end
         end
-      }
+      end
       @results
     end
 
-    def before_operation(context, operation)
-    end
-
-    def after_operation(context, result)
-    end
-
     private
 
     # The base OperationsProcessor provides no transaction support

data/lib/jsonapi/resource.rb

@@ -1,49 +1,154 @@
 require 'jsonapi/configuration'
 require 'jsonapi/resource_for'
 require 'jsonapi/association'
+require 'jsonapi/callbacks'
 
 module JSONAPI
   class Resource
     include ResourceFor
+    include Callbacks
 
     @@resource_types = {}
 
     attr :context
     attr_reader :model
 
+    define_jsonapi_resources_callbacks :create,
+                                       :update,
+                                       :remove,
+                                       :save,
+                                       :create_has_many_link,
+                                       :replace_has_many_links,
+                                       :create_has_one_link,
+                                       :replace_has_one_link,
+                                       :remove_has_many_link,
+                                       :remove_has_one_link,
+                                       :replace_fields
+
     def initialize(model, context = nil)
       @model = model
       @context = context
     end
 
-    def remove
-      @model.destroy
-    end
-
     def id
       model.send(self.class._primary_key)
     end
 
-    def create_has_many_link(association_type, association_key_value)
-      association = self.class._associations[association_type]
-      related_resource = self.class.resource_for(association.type).find_by_key(association_key_value, context: @context)
+    def is_new?
+      id.nil?
+    end
 
-      # ToDo: Add option to skip relations that already exist instead of returning an error?
-      relation = @model.send(association.type).where(association.primary_key => association_key_value).first
-      if relation.nil?
-        @model.send(association.type) << related_resource.model
+    def change(callback)
+      if @changing
+        run_callbacks callback do
+          yield
+        end
       else
-        raise JSONAPI::Exceptions::HasManyRelationExists.new(association_key_value)
+        run_callbacks is_new? ? :create : :update do
+          @changing = true
+          run_callbacks callback do
+            yield
+            save if @save_needed
+          end
+        end
+      end
+    end
+
+    def remove
+      run_callbacks :remove do
+        _remove
+      end
+    end
+
+    def create_has_many_links(association_type, association_key_values)
+      change :create_has_many_link do
+        _create_has_many_links(association_type, association_key_values)
       end
     end
 
     def replace_has_many_links(association_type, association_key_values)
+      change :replace_has_many_links do
+        _replace_has_many_links(association_type, association_key_values)
+      end
+    end
+
+    def create_has_one_link(association_type, association_key_value)
+      change :create_has_one_link do
+        _create_has_one_link(association_type, association_key_value)
+      end
+    end
+
+    def replace_has_one_link(association_type, association_key_value)
+      change :replace_has_one_link do
+        _replace_has_one_link(association_type, association_key_value)
+      end
+    end
+
+    def remove_has_many_link(association_type, key)
+      change :remove_has_many_link do
+        _remove_has_many_link(association_type, key)
+      end
+    end
+
+    def remove_has_one_link(association_type)
+      change :remove_has_one_link do
+        _remove_has_one_link(association_type)
+      end
+    end
+
+    def replace_fields(field_data)
+      change :replace_fields do
+        _replace_fields(field_data)
+      end
+    end
+
+    # Override this on a resource instance to override the fetchable keys
+    def fetchable_fields
+      self.class.fields
+    end
+
+    private
+    def save
+      run_callbacks :save do
+        _save
+      end
+    end
+
+    def _save
+      @model.save!
+      @save_needed = false
+    rescue ActiveRecord::RecordInvalid => e
+      raise JSONAPI::Exceptions::ValidationErrors.new(e.record.errors.messages)
+    end
+
+    def _remove
+      @model.destroy
+    end
+
+    def _create_has_many_links(association_type, association_key_values)
+      association = self.class._associations[association_type]
+
+      association_key_values.each do |association_key_value|
+        related_resource = self.class.resource_for(association.type).find_by_key(association_key_value, context: @context)
+
+        # ToDo: Add option to skip relations that already exist instead of returning an error?
+        relation = @model.send(association.type).where(association.primary_key => association_key_value).first
+        if relation.nil?
+          @model.send(association.type) << related_resource.model
+        else
+          raise JSONAPI::Exceptions::HasManyRelationExists.new(association_key_value)
+        end
+      end
+    end
+
+    def _replace_has_many_links(association_type, association_key_values)
       association = self.class._associations[association_type]
 
       send("#{association.foreign_key}=", association_key_values)
+      @save_needed = true
     end
 
-    def create_has_one_link(association_type, association_key_value)
+    def _create_has_one_link(association_type, association_key_value)
       association = self.class._associations[association_type]
 
       # ToDo: Add option to skip relations that already exist instead of returning an error?
@@ -53,30 +158,34 @@ module JSONAPI
       else
         raise JSONAPI::Exceptions::HasOneRelationExists.new
       end
+      @save_needed = true
     end
 
-    def replace_has_one_link(association_type, association_key_value)
+    def _replace_has_one_link(association_type, association_key_value)
       association = self.class._associations[association_type]
 
       send("#{association.foreign_key}=", association_key_value)
+      @save_needed = true
     end
 
-    def remove_has_many_link(association_type, key)
+    def _remove_has_many_link(association_type, key)
       association = self.class._associations[association_type]
 
       @model.send(association.type).delete(key)
     end
 
-    def remove_has_one_link(association_type)
+    def _remove_has_one_link(association_type)
       association = self.class._associations[association_type]
 
       send("#{association.foreign_key}=", nil)
+      @save_needed = true
     end
 
-    def replace_fields(field_data)
+    def _replace_fields(field_data)
       field_data[:attributes].each do |attribute, value|
         begin
           send "#{attribute}=", value
+          @save_needed = true
         rescue ArgumentError
           # :nocov: Will be thrown if an enum value isn't allowed for an enum. Currently not tested as enums are a rails 4.1 and higher feature
           raise JSONAPI::Exceptions::InvalidFieldValue.new(attribute, value)
@@ -97,17 +206,6 @@ module JSONAPI
       end if field_data[:has_many]
     end
 
-    def save
-      @model.save!
-    rescue ActiveRecord::RecordInvalid => e
-      raise JSONAPI::Exceptions::ValidationErrors.new(e.record.errors.messages)
-    end
-
-    # Override this on a resource instance to override the fetchable keys
-    def fetchable_fields
-      self.class.fields
-    end
-
     class << self
       def inherited(base)
         base._attributes = (_attributes || {}).dup

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = "0.0.16"
+    VERSION = "0.1.0"
   end
 end

data/lib/jsonapi/routing_ext.rb

@@ -19,7 +19,7 @@ module ActionDispatch
 
         def jsonapi_resource(*resources, &block)
           resource_type = resources.first
-          res = JSONAPI::Resource.resource_for(resource_type)
+          res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix(resources.first))
 
           options = resources.extract_options!.dup
           options[:controller] ||= resource_type
@@ -45,11 +45,7 @@ module ActionDispatch
 
         def jsonapi_resources(*resources, &block)
           resource_type = resources.first
-          resource_type_with_module_prefix = [
-            @scope[:module],
-            resource_type
-          ].compact.collect(&:to_s).join("/")
-          res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix)
+          res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix(resources.first))
 
           options = resources.extract_options!.dup
           options[:controller] ||= resource_type
@@ -93,28 +89,28 @@ module ActionDispatch
           formatted_association_name = format_route(link_type)
           options = links.extract_options!.dup
 
-          res = JSONAPI::Resource.resource_for(@scope[:jsonapi_resource])
+          res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix)
 
           methods = links_methods(options)
 
           if methods.include?(:show)
             match "links/#{formatted_association_name}", controller: res._type.to_s,
-                  action: 'show_association', association: link_type.to_s, via: [:get]
+            action: 'show_association', association: link_type.to_s, via: [:get]
           end
 
           if methods.include?(:create)
             match "links/#{formatted_association_name}", controller: res._type.to_s,
-                  action: 'create_association', association: link_type.to_s, via: [:post]
+            action: 'create_association', association: link_type.to_s, via: [:post]
           end
 
           if methods.include?(:update)
             match "links/#{formatted_association_name}", controller: res._type.to_s,
-                  action: 'update_association', association: link_type.to_s, via: [:put]
+            action: 'update_association', association: link_type.to_s, via: [:put]
           end
 
           if methods.include?(:destroy)
             match "links/#{formatted_association_name}", controller: res._type.to_s,
-                  action: 'destroy_association', association: link_type.to_s, via: [:delete]
+            action: 'destroy_association', association: link_type.to_s, via: [:delete]
           end
         end
 
@@ -123,30 +119,35 @@ module ActionDispatch
           formatted_association_name = format_route(link_type)
           options = links.extract_options!.dup
 
-          res = JSONAPI::Resource.resource_for(@scope[:jsonapi_resource])
+          res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix)
 
           methods = links_methods(options)
 
           if methods.include?(:show)
             match "links/#{formatted_association_name}", controller: res._type.to_s,
-                  action: 'show_association', association: link_type.to_s, via: [:get]
+            action: 'show_association', association: link_type.to_s, via: [:get]
           end
 
           if methods.include?(:create)
             match "links/#{formatted_association_name}", controller: res._type.to_s,
-                  action: 'create_association', association: link_type.to_s, via: [:post]
+            action: 'create_association', association: link_type.to_s, via: [:post]
           end
 
           if methods.include?(:update) && res._association(link_type).acts_as_set
             match "links/#{formatted_association_name}", controller: res._type.to_s,
-                  action: 'update_association', association: link_type.to_s, via: [:put]
+            action: 'update_association', association: link_type.to_s, via: [:put]
           end
 
           if methods.include?(:destroy)
             match "links/#{formatted_association_name}/:keys", controller: res._type.to_s,
-                  action: 'destroy_association', association: link_type.to_s, via: [:delete]
+            action: 'destroy_association', association: link_type.to_s, via: [:delete]
           end
         end
+
+        def resource_type_with_module_prefix(resource = nil)
+          resource_name = resource || @scope[:jsonapi_resource]
+          [@scope[:module], resource_name].compact.collect(&:to_s).join("/")
+        end
       end
     end
   end

data/test/fixtures/active_record.rb

@@ -413,6 +413,39 @@ class PostResource < JSONAPI::Resource
   has_one :section
   has_many :tags, acts_as_set: true
   has_many :comments, acts_as_set: false
+
+  before_save do
+    msg = "Before save"
+  end
+
+  after_save do
+    msg = "After save"
+  end
+
+  before_update do
+    msg = "Before update"
+  end
+
+  after_update do
+    msg = "After update"
+  end
+
+  before_replace_fields do
+    msg = "Before replace_fields"
+  end
+
+  after_replace_fields do
+    msg = "After replace_fields"
+  end
+
+  around_update :around_update_check
+
+  def around_update_check
+    # do nothing
+    yield
+    # do nothing
+  end
+
   def subject
     @model.title
   end
@@ -606,6 +639,7 @@ end
 module Api
   module V3
     PostResource = PostResource.dup
+    PreferencesResource = PreferencesResource.dup
   end
 end
 

data/test/unit/operation/operations_processor_test.rb

@@ -5,6 +5,56 @@ require 'jsonapi/operation'
 require 'jsonapi/operation_result'
 require 'jsonapi/operations_processor'
 
+class TestOperationsProcessor < JSONAPI::OperationsProcessor
+  before_operation :log_before_operation
+
+  after_operation :log_after_operation
+
+  around_operation :log_around_operation
+
+  def log_before_operation
+    msg = "Before Operation"
+    # puts msg
+  end
+
+  def log_around_operation
+    msg = "Starting... #{@operation.class.name}"
+    # puts msg
+    yield
+    msg = "... Finishing #{@operation.class.name}"
+    # puts msg
+  end
+
+  def log_after_operation
+    msg = "After Operation"
+    # puts msg
+  end
+
+  before_operations :log_before_operations
+
+  after_operations :log_after_operations
+
+  around_operations :log_around_operations
+
+  def log_before_operations
+    msg = "Before #{@operations.count} Operation(s)"
+    # puts msg
+  end
+
+  def log_around_operations
+    msg = "Starting #{@operations.count} Operation(s)..."
+    # puts msg
+    yield
+    msg = "...Finishing Up Operations"
+    # puts msg
+  end
+
+  def log_after_operations
+    msg =  "After Operations"
+    # puts msg
+  end
+end
+
 class OperationsProcessorTest < MiniTest::Unit::TestCase
   def setup
     betax = Planet.find(5)
@@ -14,7 +64,7 @@ class OperationsProcessorTest < MiniTest::Unit::TestCase
   end
 
   def test_create_single_resource
-    op = JSONAPI::OperationsProcessor.new()
+    op = TestOperationsProcessor.new()
 
     count = Planet.count
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.1.0
 platform: ruby
 authors:
 - Dan Gebhardt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,6 +128,7 @@ files:
 - lib/jsonapi-resources.rb
 - lib/jsonapi/active_record_operations_processor.rb
 - lib/jsonapi/association.rb
+- lib/jsonapi/callbacks.rb
 - lib/jsonapi/configuration.rb
 - lib/jsonapi/error.rb
 - lib/jsonapi/error_codes.rb