naranya_ecm-sdk 0.0.59 → 0.0.61

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6e047f2e11b3f979a614497fab55f5509a91f82
-  data.tar.gz: 1c0e0b24fe627d4e6950c0ad08ccdf1aa51e270a
+  metadata.gz: 1181f4986de39fadb4461af21904a7e6a7909e0f
+  data.tar.gz: a0b0b0ecafeb47e0d5107c477f3c937ae7274998
 SHA512:
-  metadata.gz: 4d1beca3428f756addca77e0d3e8e1911e8f35526a3447937826e658f54c093432c6c656a74f31d365065494362b2994db1dcf4bb3593249d10eb8e654df5589
-  data.tar.gz: 67af8129323fd6c47becb28842f49c25f1a3fb6765fb688cc7709d48219e08271b8f3b3ded397949cd669c221b2b330cd1a3cc59a4aac407292e9e8c387be926
+  metadata.gz: 2479a6d36d005d8e95861c794da10b8ac50c1be35b14e48362bad62a833daf5736c33cf140bb9f86d24b1ba9e8ff2e6c4549ff5601478210b05bc68b3253a51a
+  data.tar.gz: de993f6677215f8fdc0b75631723892fb33c1db89f24adaa8b730bafc3a3a85c1c660fe98304eb17d56f400cb4bd659e56f77faec81f04f6ac6f7e4676fe0a74

data/lib/aasm/persistence/{rest_persistence.rb → ncontent_rest_persistence.rb}

@@ -1,6 +1,6 @@
 module AASM
   module Persistence
-    module RestPersistence
+    module NContentRestPersistence
       # This method:
       #
       # * extends the model with ClassMethods
@@ -28,8 +28,8 @@ module AASM
       #
       def self.included(base)
         base.send(:include, AASM::Persistence::Base)
-        base.extend AASM::Persistence::RestPersistence::ClassMethods
-        base.send(:include, AASM::Persistence::RestPersistence::InstanceMethods)
+        base.extend AASM::Persistence::NContentRestPersistence::ClassMethods
+        base.send(:include, AASM::Persistence::NContentRestPersistence::InstanceMethods)
 
         base.before_validation(:aasm_ensure_initial_state, :on => :create)
 
@@ -70,55 +70,23 @@ module AASM
 
       module InstanceMethods
 
-        # # Writes <tt>state</tt> to the state column and persists it to the database
-        # #
-        # # foo = Foo.find(1)
-        # # foo.aasm.current_state # => :opened
-        # # foo.close!
-        # # foo.aasm.current_state # => :closed
-        # # Foo.find(1).aasm.current_state # => :closed
-        # #
-        # # NOTE: intended to be called from an event
-        # def aasm_write_state(state)
-        #   old_value = self.send self.class.aasm.attribute_name.to_sym
-        #   write_attribute(self.class.aasm.attribute_name, state.to_s)
-
-        #   unless self.save(:validate => false)
-        #     write_attribute(self.class.aasm.attribute_name, old_value)
-        #     return false
-        #   end
-
-        #   true
-        # end
-
-        # # Writes <tt>state</tt> to the state column, but does not persist it to the database
-        # #
-        # # foo = Foo.find(1)
-        # # foo.aasm.current_state # => :opened
-        # # foo.close
-        # # foo.aasm.current_state # => :closed
-        # # Foo.find(1).aasm.current_state # => :opened
-        # # foo.save
-        # # foo.aasm.current_state # => :closed
-        # # Foo.find(1).aasm.current_state # => :closed
-        # #
-        # # NOTE: intended to be called from an event
-        # def aasm_write_state_without_persistence(state)
-        #   self.off_band_changes["#{self.class.aasm.attribute_name}_event"] = transition.event
-        # end
-
-      private
-
-        def aasm_ensure_initial_state
-          send("#{self.class.aasm.attribute_name}=", aasm.enter_initial_state.to_s) \
-            if send(self.class.aasm.attribute_name).blank?
-        end
-
-        def aasm_fire_event(name, options, *args, &block)
-          local_success  = super
-          remote_success = if local_success
+        # Writes <tt>state</tt> to the state column and persists it to the server
+        #
+        # foo = Foo.find(1)
+        # foo.aasm.current_state # => :opened
+        # foo.close!
+        # foo.aasm.current_state # => :closed
+        # Foo.find(1).aasm.current_state # => :closed
+        #
+        # NOTE: intended to be called from an event
+        def aasm_write_state(new_state)
+
+          previous_state = self.public_send self.class.aasm.attribute_name
+          self.public_send "#{self.class.aasm.attribute_name}=", new_state
+
+          success = begin
             data = {
-              name: name,
+              name: aasm.current_event.to_s.tr('!',''),
               target_type: self.class.name.demodulize,
               target_id: self.id
             }
@@ -134,25 +102,49 @@ module AASM
               req.body = ActiveSupport::JSON.encode(state_event: data)
             end
 
-            state_attribute = self.class.aasm.attribute_name
-            state_before_reload = self.send(state_attribute)
-
             reload
-            state_after_reload = self.send(state_attribute)
 
-            msg = "Event: #{name} - #{state_attribute} #{state_before_reload}"
-            NContent::SDK.logger.debug "#{msg} -> #{state_after_reload}"
+            # Return true if the actual state is the same as the expected state:
+            self.public_send(self.class.aasm.attribute_name) == new_state.to_s
+          end
+
+          unless success
+            self.public_send "#{self.class.aasm.attribute_name}=", previous_state
+            return false
+          end
+
+          true
+        end
+
+        def aasm_write_state_without_persistence(new_state)
+          self.public_send(self.class.aasm.attribute_name) == new_state.to_s
+          true
+        end
+
+      private
 
-            # Check that the state changed (and return the result of that check)
-            state_before_reload != state_after_reload
-          else
-            false
+        def aasm_fire_event(name, options, *args, &block)
+          success = super
+
+          if success
+            if options[:persist]
+              event = self.class.aasm.state_machine.events[name]
+              event.fire_callbacks(:after_commit, self, *args)
+            else
+              # TODO: Implement a "state change queue" to make .save send the state changes
+              # to the server when no bang (options[:persist] == false) was given...
+            end
           end
 
-          local_success && remote_success
+          success
+        end
+
+        def aasm_ensure_initial_state
+          send("#{self.class.aasm.attribute_name}=", aasm.enter_initial_state.to_s) \
+            if send(self.class.aasm.attribute_name).blank?
         end
 
-      end # InstanceMethods
+      end
 
     end
   end

data/lib/naranya_ecm-sdk/version.rb

@@ -1,3 +1,3 @@
 module NaranyaEcm
-  VERSION = "0.0.59"
+  VERSION = "0.0.61"
 end

data/lib/naranya_ecm/models/content.rb

@@ -1,3 +1,7 @@
+require 'aasm'
+require 'aasm/persistence/base'
+require 'aasm/persistence/ncontent_rest_persistence'
+
 module NaranyaEcm
 
   ##
@@ -164,7 +168,7 @@ module NaranyaEcm
     ###############################################################
     # StateMachine:
     include AASM
-    include AASM::Persistence::RestPersistence
+    include AASM::Persistence::NContentRestPersistence
 
     ##
     # :method: request_an_acceptance_review
@@ -248,29 +252,29 @@ module NaranyaEcm
       #########################################
       # Eventos:
 
-      event :request_an_acceptance_review do
+      event :request_an_acceptance_review, before: :start_notify_state_change!, after_commit: :finish_notify_state_change! do
         # Iniciar la transición de :draft a :awaiting_acceptance,
         transitions from: :draft, to: :awaiting_acceptance, guard: :validatable_lifecycle?
       end
 
-      event :accept do
+      event :accept, before: :start_notify_state_change!, after_commit: :finish_notify_state_change! do
         # Iniciar la transición de :awaiting_acceptance a :accepted:
         transitions from: :awaiting_acceptance, to: :accepted
       end
 
-      event :reject do
+      event :reject, before: :start_notify_state_change!, after_commit: :finish_notify_state_change! do
         # Iniciar la transición de :awaiting_acceptance a :rejected:
         transitions from: :awaiting_acceptance, to: :rejected
       end
 
-      event :publish do
+      event :publish, before: :start_notify_state_change!, after_commit: :finish_notify_state_change! do
         # Iniciar la transición de :draft a :published,
         # si el lifecycle es sencillo:
         transitions from: :draft, to: :published,     guard: :simple_lifecycle?
         transitions from: :validated, to: :published, guard: :validatable_lifecycle?
       end
 
-      event :deactivate do
+      event :deactivate, before: :start_notify_state_change!, after_commit: :finish_notify_state_change! do
         # Iniciar la transición de :published a :deactivated:
         transitions from: :published, to: :deactivated
       end

data/lib/naranya_ecm/models/content_version.rb

@@ -1,6 +1,6 @@
 require 'aasm'
 require 'aasm/persistence/base'
-require 'aasm/persistence/rest_persistence'
+require 'aasm/persistence/ncontent_rest_persistence'
 
 module NaranyaEcm
   class ContentVersion
@@ -57,7 +57,7 @@ module NaranyaEcm
     ###############################################################
     # StateMachine:
     include AASM
-    include AASM::Persistence::RestPersistence
+    include AASM::Persistence::NContentRestPersistence
 
     aasm column: :lifecycle_state do
 
@@ -72,22 +72,22 @@ module NaranyaEcm
       #########################################
       # Eventos:
 
-      event :request_an_acceptance_review do
+      event :request_an_acceptance_review, before: :start_notify_state_change!, after_commit: :finish_notify_state_change! do
         # Iniciar la transición de :draft a :awaiting_acceptance,
         transitions from: :draft, to: :awaiting_acceptance, guard: :validatable_lifecycle?
       end
 
-      event :accept do
+      event :accept, before: :start_notify_state_change!, after_commit: :finish_notify_state_change! do
         # Iniciar la transición de :awaiting_acceptance a :accepted:
         transitions from: :awaiting_acceptance, to: :accepted
       end
 
-      event :reject do
+      event :reject, before: :start_notify_state_change!, after_commit: :finish_notify_state_change! do
         # Iniciar la transición de :awaiting_acceptance a :rejected:
         transitions from: :awaiting_acceptance, to: :rejected
       end
 
-      event :publish do
+      event :publish, before: :start_notify_state_change!, after_commit: :finish_notify_state_change! do
         # Iniciar la transición de :draft a :published,
         # si el lifecycle es sencillo:
         transitions from: :draft,       to: :published, guard: :simple_lifecycle?
@@ -95,12 +95,12 @@ module NaranyaEcm
         transitions from: :deactivated, to: :published
       end
 
-      event :supersede do
+      event :supersede, before: :start_notify_state_change!, after_commit: :finish_notify_state_change! do
         # Iniciar la transición de :published a :superseded:
         transitions from: :published, to: :superseded
       end
 
-      event :deactivate do
+      event :deactivate, before: :start_notify_state_change!, after_commit: :finish_notify_state_change! do
         # Iniciar la transición de :published a :deactivated:
         transitions from: :published, to: :deactivated
       end

data/lib/naranya_ecm/models/media_resource.rb

@@ -33,6 +33,18 @@ module NaranyaEcm
     has_many :media_resources, class_name: :MediaResource, inverse_of: :media_resource
 
     #belongs_to :parent_document
+    field :parent_document_id,   type: String
+    field :parent_document_type, type: String
+    def as_notification_payload
+      instance_payload = super.merge(roles: self.roles)
+
+      if self.parent_document_id.present? && self.parent_document_type.present?
+        instance_payload[:parent_id]    = self.parent_document_id
+        instance_payload[:parent_class] = "NaranyaEcm::#{self.parent_document_type}"
+      end
+
+      instance_payload
+    end
 
     # Returns true if the Media Resource is private
     def private?

data/lib/naranya_ecm/rest/model.rb

@@ -1,5 +1,7 @@
 require 'active_model'
 
+require 'naranya_ecm/rest/notifications'
+
 module NaranyaEcm::Rest
   module Model
 
@@ -62,6 +64,8 @@ module NaranyaEcm::Rest
       # Ignore the server resource's url attribute:
       attr_accessor :url
 
+      include NaranyaEcm::Rest::Notifications
+
       include NaranyaEcm::Rest::Associations
       include NaranyaEcm::Rest::Persistence
 

data/lib/naranya_ecm/rest/notifications.rb

@@ -0,0 +1,38 @@
+require 'active_support/notifications'
+
+module NaranyaEcm
+  module Rest
+    module Notifications
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def as_notification_payload
+          { class: self.name }
+        end
+      end
+
+      def as_notification_payload
+        instance_payload = self.class.as_notification_payload.merge({ id: self.id })
+
+        # Include belongs_to references:
+        self.class.reflect_on_all_associations.values.select do |association|
+          association.class.name.demodulize == 'BelongsTo'
+        end.map(&:foreign_key).each do |reference_name|
+          instance_payload[reference_name] = self.public_send reference_name
+        end
+
+        instance_payload
+      end
+
+      def start_notify_state_change!
+        ActiveSupport::Notifications.instrumenter
+        .start("ncontent_sdk.#{aasm.current_event.to_s.tr('!', '').underscore}", self.as_notification_payload)
+      end
+
+      def finish_notify_state_change!
+        ActiveSupport::Notifications.instrumenter
+        .finish("ncontent_sdk.#{aasm.current_event.to_s.tr('!', '').underscore}", self.as_notification_payload)
+      end
+    end
+  end
+end

data/lib/naranya_ecm/rest/persistence.rb

@@ -56,7 +56,10 @@ module NaranyaEcm::Rest
       end
 
       def delete(id, options={})
-        response = NContent::SDK::RESTClient.delete("#{self.path}/#{id}.json")
+        ActiveSupport::Notifications.instrument('ncontent_sdk.destroy') do |notification_payload|
+          response = NContent::SDK::RESTClient.delete("#{self.path}/#{id}.json")
+          notification_payload.merge!({ id: id }.merge(self.as_notification_payload))
+        end
         true
       end
 
@@ -272,25 +275,29 @@ module NaranyaEcm::Rest
           create_path = "#{self.class.path}.json"
 
           begin
+            ActiveSupport::Notifications.instrument('ncontent_sdk.create') do |notification_payload|
+              response = NContent::SDK::RESTClient.post create_path do |req|
+                req.headers[:content_type] = 'application/json'
+
+                # Obtener solo los cambios con respecto al objeto recién
+                # inicializado:
+                attributes_to_post = changes.inject({}) do |attr_hash, attribute_change|
+                  attribute_name, attribute_change_values = attribute_change
+                  previous_attribute_value, new_attribute_value = attribute_change_values
+                  attr_hash[attribute_name] = new_attribute_value
+                  attr_hash
+                end
+
+                req.body = ActiveSupport::JSON.encode(
+                  self.class.name.demodulize.underscore => attributes_to_post
+                )
+              end
 
-            response = NContent::SDK::RESTClient.post create_path do |req|
-              req.headers[:content_type] = 'application/json'
+              send :_load_from_fetched_attributes!, response.body
 
-              # Obtener solo los cambios con respecto al objeto recién
-              # inicializado:
-              attributes_to_post = changes.inject({}) do |attr_hash, attribute_change|
-                attribute_name, attribute_change_values = attribute_change
-                previous_attribute_value, new_attribute_value = attribute_change_values
-                attr_hash[attribute_name] = new_attribute_value
-                attr_hash
-              end
+              notification_payload.merge! self.as_notification_payload
 
-              req.body = ActiveSupport::JSON.encode(
-                self.class.name.demodulize.underscore => attributes_to_post
-              )
             end
-
-            send :_load_from_fetched_attributes!, response.body
             true
           rescue UnprocessableEntity => e
             self.load_server_errors(e.response.body)
@@ -320,15 +327,18 @@ module NaranyaEcm::Rest
           update_path = "#{self.path}.json"
 
           begin
-            response = NContent::SDK::RESTClient.put update_path do |req|
-              req.headers[:content_type] = 'application/json'
-              req.body = ActiveSupport::JSON.encode(
-                self.class.name.demodulize.underscore => attributes_to_save
-              )
-            end
+            ActiveSupport::Notifications.instrument('ncontent_sdk.update') do |notification_payload|
+              response = NContent::SDK::RESTClient.put update_path do |req|
+                req.headers[:content_type] = 'application/json'
+                req.body = ActiveSupport::JSON.encode(
+                  self.class.name.demodulize.underscore => attributes_to_save
+                )
+              end
 
-            self.reload!
-            off_band_changes.clear if off_band_changes.present?
+              self.reload!
+              off_band_changes.clear if off_band_changes.present?
+              notification_payload.merge!(self.as_notification_payload)
+            end
             true
           rescue UnprocessableEntity
             self.load_server_errors(response.body)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: naranya_ecm-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.59
+  version: 0.0.61
 platform: ruby
 authors:
 - Roberto Quintanilla
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-26 00:00:00.000000000 Z
+date: 2015-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -209,7 +209,7 @@ files:
 - dev/search.rb
 - dev/thread-safety-tests.rb
 - doc/media_processing.md
-- lib/aasm/persistence/rest_persistence.rb
+- lib/aasm/persistence/ncontent_rest_persistence.rb
 - lib/naranya_ecm-sdk.rb
 - lib/naranya_ecm-sdk/version.rb
 - lib/naranya_ecm/behaviors/localizable.rb
@@ -228,6 +228,7 @@ files:
 - lib/naranya_ecm/rest/errors.rb
 - lib/naranya_ecm/rest/finder_methods.rb
 - lib/naranya_ecm/rest/model.rb
+- lib/naranya_ecm/rest/notifications.rb
 - lib/naranya_ecm/rest/persistence.rb
 - lib/naranya_ecm/rest/relation.rb
 - lib/naranya_ecm/search/hit.rb