nexo 0.1.5 → 0.1.7

data/app/lib/nexo/folder_service.rb

@@ -3,60 +3,87 @@ module Nexo
   #
   # Responsabilities:
   # - Creation of Element's
-  # - Flagging Element's for deletion
-  # - Triggering the SyncElementJob
+  # - Creation of ElementVersion on local changes
+  # - Flagging Element's for removal
+  # - Enqueues UpdateRemoteResourceJob, DeleteRemoteResourceJob
   class FolderService
+    # @raise [ActiveRecord::RecordNotUnique] on ElementVersion creation
     def find_element_and_sync(folder, synchronizable)
-      # TODO: handle conflicted synchronizable
-      element = find_element(folder, synchronizable)
+      validate_synchronizable!(synchronizable)
+
+      element = folder.find_element(synchronizable:)
 
       if element.present?
+        Nexo.logger.debug { "Element found" }
+        validate_element_state!(element)
         sync_element(element)
       else
+        Nexo.logger.debug { "Element not found" }
         create_and_sync_element(folder, synchronizable)
       end
     end
 
-    def destroy_elements(synchronizable, reason)
-      synchronizable.nexo_elements.each do |element|
-        element.flag_for_deletion!(reason)
+    def destroy_elements(synchronizable, reason, exclude_elements: [])
+      Nexo.logger.debug("Destroying elements for synchronizable")
+
+      scope = synchronizable.nexo_elements
+
+      if exclude_elements.any?
+        Nexo.logger.debug("Excluding elements: #{exclude_elements}")
 
-        SyncElementJob.perform_later(element)
+        scope = scope.where.not(id: exclude_elements)
       end
-    end
 
-    private
+      scope.each do |element|
+        unless element.folder.sync_internal_changes?
+          Nexo.logger.debug("Folder dont syncs internal changes, skipping")
+          next
+        end
 
-    def find_element(folder, synchronizable)
-      folder.find_element(synchronizable:)
+        ElementService.new(element:).flag_for_removal!(reason)
+
+        DeleteRemoteResourceJob.perform_later(element)
+      end
     end
 
-    def create_and_sync_element(folder, synchronizable)
-      must_be_included = folder.policy_match?(synchronizable)
+    private
 
-      if must_be_included
-        element = Element.create!(
-          synchronizable:,
-          folder:
-        )
+    def validate_synchronizable!(synchronizable)
+      synchronizable.validate_synchronizable!
 
-        SyncElementJob.perform_later(element)
+      if synchronizable.sequence.nil?
+        raise Errors::SynchronizableSequenceIsNull
       end
     end
 
+    def validate_element_state!(element)
+      # unless element.synced?
+      #   raise Errors::Error, <<~STR
+      #     element ne_status is invalid: #{element.ne_status} \
+      #     (should be synced)
+      #   STR
+      # end
+    end
+
     def sync_element(element)
-      synchronizable = element.synchronizable
+      if element.policy_still_applies?
+        ElementService.new(element:).create_internal_version_if_none!
+      else
+        Nexo.logger.debug("Flagging for removal and enqueuing DeleteRemoteResourceJob")
+        ElementService.new(element:).flag_for_removal!(:no_longer_included_in_folder)
 
-      if synchronizable.conflicted?
-        raise Nexo::Errors::ElementConflicted, element
+        DeleteRemoteResourceJob.perform_later(element)
       end
+    end
 
-      # Check if Synchronizable still must be included in folder
-      if !element.policy_still_match?
-        element.flag_for_deletion!(:no_longer_included_in_folder)
-      end
+    def create_and_sync_element(folder, synchronizable)
+      must_be_included = folder.policy_applies?(synchronizable)
 
-      SyncElementJob.perform_later(element)
+      if must_be_included
+        ElementService.new.create_element_for!(folder, synchronizable)
+      else
+        Nexo.logger.debug { "Policy not applies, skipping creation" }
+      end
     end
   end
 end

data/app/lib/nexo/import_remote_element_version.rb

@@ -0,0 +1,75 @@
+module Nexo
+  class ImportRemoteElementVersion
+    class VersionSuperseded < Errors::Error; end
+    class ImportRemoteVersionFailed < Errors::Error; end
+
+    def perform(element_version)
+      validate_element_state!(element_version)
+
+      ElementService.new(element_version:).update_synchronizable!
+    rescue ImportRemoteVersionFailed => e
+      Nexo.logger.warn(e.inspect)
+    rescue VersionSuperseded
+      Nexo.logger.info("ImportRemoteElementVersion: version superseded")
+    end
+
+    private
+
+    def validate_element_state!(element_version)
+      element = element_version.element
+
+      raise Nexo::Errors::Error, "element version must be external" if element_version.internal?
+      raise Nexo::Errors::Error, "etag must be present" if element_version.etag.blank?
+
+      unless element_version.nev_status == "pending_sync"
+        raise Nexo::Errors::Error, "nev_status invalid, should be pending_sync"
+      end
+
+      # NOTE: this is actually very coupled to the way Google manages etag as a
+      # sequential number, if a new protocol or service is added in the future
+      # and it doesnt manage it that way, it would have to be delegated to the
+      # protocol service
+      if element.element_versions.where(nev_status: :synced)
+                .where("etag > ?", element_version.etag).any?
+
+        ElementService.new(element_version:).update_element_version!(nev_status: :superseded)
+
+        raise VersionSuperseded
+      end
+
+      if element.conflicted?
+        raise ImportRemoteVersionFailed, "element conflicted"
+      end
+
+      # if element.synchronizable.blank?
+      #   # TODO!: this could be that an external element was restored. i.e.:
+      #   # google calendar event cancelled and restored.
+      #   # this should be handled in some way, maybe configurable per folder
+      #   # options are:
+      #   #   - ignore the element
+      #   #   - create synchronizable as if it were new
+      #   #   - discard/undiscard, for this the synchronizable should have been
+      #   #     deleted
+      #   raise ImportRemoteVersionFailed, "synchronizable not found"
+      # end
+
+      # :nocov: borderline
+      if element.discarded?
+        # TODO!: this could be that an external element was restored. i.e.:
+        #   Event excluded from folder and then restored from Google Calendar
+        raise ImportRemoteVersionFailed, "element discarded"
+      end
+
+      if element.synchronizable.present?
+        if element.synchronizable.conflicted?
+          raise ImportRemoteVersionFailed, "synchronizable conflicted"
+        end
+
+        if element.synchronizable.sequence.nil?
+          raise ImportRemoteVersionFailed, "synchronizable sequence is null"
+        end
+      end
+      # :nocov:
+    end
+  end
+end

data/app/lib/nexo/policy_service.rb

@@ -1,9 +1,13 @@
 module Nexo
   class PolicyService
-    def initialize
+    def clear_finders!
       @finders = []
     end
 
+    def initialize
+      clear_finders!
+    end
+
     @instance = new
 
     private_class_method :new
@@ -12,29 +16,44 @@ module Nexo
       @instance
     end
 
-    def register_folder_policy_finder(&block)
+    def register_folder_rule_finder(&block)
       @finders << block
     end
 
     attr_reader :finders
 
-    def match?(folder, synchronizable)
+    def applies?(folder, synchronizable)
       policies = policies_for(folder)
-      matching_policies = policies.select { |policy| policy.match?(synchronizable) }
-      if matching_policies.any?
-        aplicable_policy = matching_policies.sort_by { |policy| policy.priority }.last
-        aplicable_policy.sync_policy == :include
+      applied_policies = policies.select { |policy| policy.applies?(synchronizable) }
+      # :nocov: TODO
+      if applied_policies.any?
+        aplicable_policy = applied_policies.sort_by { |policy| policy.priority }.last
+        logger.debug { "Aplicable policy: #{aplicable_policy.inspect}" }
+        logger.debug { "sync_policy: #{aplicable_policy.sync_policy}" }
+        aplicable_policy.sync_policy.to_s == "include"
       else
+        logger.debug { "No applicable policies" }
         false
       end
+      # :nocov:
     end
 
     def policies_for(folder)
+      logger.debug { "Found #{@finders.length} finders" }
+
       aux = @finders.map do |finder|
         finder.call(folder)
       end
 
-      aux.flatten.compact
+      aux.flatten.compact.tap do |ret|
+        logger.debug { "Found #{ret.length} policies" }
+      end
+    end
+
+    private
+
+    def logger
+      logger = Nexo.logger
     end
   end
 end

data/app/models/concerns/nexo/calendar_event.rb

@@ -4,6 +4,11 @@ module Nexo
 
     extend ActiveSupport::Concern
 
+    # nce_status (Nexo Calendar Event Status)
+    #
+    # - confirmed
+    # - tentative (unused)
+    # - cancelled (deleted)
     define_protocol(:nexo_calendar_event, %i[
       date_from
       date_to
@@ -11,6 +16,7 @@ module Nexo
       time_to
       summary
       description
+      nce_status
     ])
 
     def change_is_significative_to_sequence?
@@ -33,6 +39,38 @@ module Nexo
       build_date_time(date_to, time_to)
     end
 
+    def all_day?
+      time_from.blank? && time_to.blank?
+    end
+
+    # transparent: non blocking
+    # opaque: blocking
+    def transparency
+      if all_day?
+        "transparent"
+      else
+        "opaque"
+      end
+    end
+
+    def validate_synchronizable!
+      unless datetime_from.present?
+        raise Errors::SynchronizableInvalid, "datetime_from is nil"
+      end
+
+      unless datetime_to.present?
+        raise Errors::SynchronizableInvalid, "datetime_to is nil"
+      end
+
+      unless datetime_from != datetime_to
+        raise Errors::SynchronizableInvalid, "datetime_from and datetime_to are equal"
+      end
+
+      unless summary.present?
+        raise Errors::SynchronizableInvalid, "summary is nil"
+      end
+    end
+
     private
 
     # @param [Date] date
@@ -40,7 +78,7 @@ module Nexo
     #
     # @return [Date, DateTime]
     def build_date_time(date, time = nil)
-      if time.present?
+      if time.present? && date.present?
         DateTime.new(
           date.year,
           date.month,
@@ -55,7 +93,6 @@ module Nexo
       end
     end
 
-
     # TODO: refactor https://api.rubyonrails.org/classes/ActiveSupport/Concern.html
     included do
       include Nexo::Synchronizable::Associations

data/app/models/concerns/nexo/synchronizable.rb

@@ -8,6 +8,10 @@ module Nexo
       #   inserta en un google calendar y luego se elimina, luego ya no se
       #   puede volver a insertar con el mismo uuid, sería mejor que el id se
       #   genere automáticamente por google y guardarlo en Element
+      #
+      # sequence
+      #   autoincremental integer, starting at 0. its recommended that
+      #   the attribute is always initialized with 0 value on creation
       %i[
         sequence
       ]
@@ -35,6 +39,19 @@ module Nexo
           end
         end
       end
+
+      def create_from_payload!(folder, payload)
+        Nexo.logger.debug("Synchronizable#create_from_payload!")
+        service = Nexo::ServiceBuilder.instance.build_protocol_service(folder)
+        fields = service.fields_from_payload(payload)
+
+        synchronizable = new
+        attributes = synchronizable.translate_fields(fields, for_create: true, folder:)
+        synchronizable.assign_attributes(attributes)
+        synchronizable.save!
+
+        synchronizable
+      end
     end
 
     def method_missing(method_name, *, &)
@@ -58,21 +75,23 @@ module Nexo
       nexo_elements.conflicted.any?
     end
 
-    # :nocov: TODO, not yet implemented
-    def update_from!(element_version)
-      transaction do
-        # TODO: parse the element_version.payload
-        # and set the Synchronizable fields according to the Folder#nexo_protocol
+    # :nocov: borderline
+    def validate_synchronizable!
+      raise "must be implemented in subclass"
+    end
 
-        new_sequence = increment_sequence!
-        element_version.update_sequence!(new_sequence)
-      end
+    def update_from_fields!(fields)
+      raise "must be implemented in subclass"
+    end
+
+    def translate_fields(fields, for_create: false, folder: nil)
+      raise "must be implemented in subclass"
     end
     # :nocov:
 
     def increment_sequence!
       if sequence.nil?
-        Rails.logger.warn("Synchronizable sequence is nil on increment_sequence!: #{self.to_gid}")
+        Nexo.logger.warn("Synchronizable sequence is nil on increment_sequence!: #{self.to_gid}")
       end
 
       # This operation is performed directly in the database without the need

data/app/models/nexo/element.rb

@@ -4,20 +4,24 @@
 #
 #  id                  :bigint           not null, primary key
 #  folder_id           :bigint           not null
-#  synchronizable_id   :integer          not null
-#  synchronizable_type :string           not null
+#  synchronizable_id   :integer
+#  synchronizable_type :string
 #  uuid                :string
 #  flagged_for_removal :boolean          not null
 #  removal_reason      :integer
-#  conflicted          :boolean          default(FALSE), not null
 #  discarded_at        :datetime
 #  created_at          :datetime         not null
 #  updated_at          :datetime         not null
+#  ne_status           :integer          not null
 #
 module Nexo
   class Element < ApplicationRecord
     belongs_to :folder, class_name: "Nexo::Folder"
-    belongs_to :synchronizable, polymorphic: true
+
+    # when blank it's a brand new remote element that needs a synchronizable to
+    # be created
+    belongs_to :synchronizable, polymorphic: true, optional: true
+
     has_many :element_versions, dependent: :destroy, class_name: "Nexo::ElementVersion"
 
     after_initialize do
@@ -29,46 +33,31 @@ module Nexo
 
     enum :removal_reason, no_longer_included_in_folder: 0, synchronizable_destroyed: 1
 
-    scope :conflicted, -> { where(conflicted: true) }
-
-    def policy_still_match?
-      folder.policy_match?(synchronizable)
-    end
-
-    def last_synced_sequence
-      element_versions.pluck(:sequence).max || -1
-    end
-
-    def external_unsynced_change?
-      last_external_unsynced_version.present?
-    end
+    enum :ne_status,
+      synced: 0,
+      pending_external_sync: 1,
+      pending_local_sync: 2,
+      conflicted: 3,
+      pending_remote_delete: 4
 
-    def last_external_unsynced_version
-      element_versions.where(sequence: nil).order(created_at: :desc).first
-    end
+    scope :conflicted, -> { where(ne_status: :conflicted) }
 
-    def flag_for_deletion!(removal_reason)
-      update!(flagged_for_removal: true, removal_reason:)
+    def policy_still_applies?
+      # :nocov: TODO
+      folder.policy_applies?(synchronizable)
+      # :nocov:
     end
 
-    def flagged_for_deletion?
-      flagged_for_removal?
+    def etag
+      last_remote_version&.etag
     end
 
-    # :nocov: TODO, not yet being called
-    def flag_as_conflicted!
-      update!(conflicted: true)
-
-      # TODO: log "Conflicted Element: #{element.to_gid}"
+    def last_remote_version
+      element_versions.where.not(etag: nil).order(:etag).last
     end
-    # :nocov:
 
     def discarded?
       discarded_at.present?
     end
-
-    def discard!
-      update!(discarded_at: Time.current)
-    end
   end
 end

data/app/models/nexo/element_version.rb

@@ -10,12 +10,16 @@
 #  origin     :integer          not null
 #  created_at :datetime         not null
 #  updated_at :datetime         not null
+#  nev_status :integer          not null
 #
 module Nexo
   # sequence
   #
   #   cuando es null significa que el origin es external que debe ser
-  #   sincronizado. si está presente, significa que fue sinzronizado
+  #   sincronizado. si está presente, significa que fue sincronizado
+  #   incremental correlativa. puede ser discontinua si se generan updates
+  #   a una frecuencia alta
+  #   TODO!: rename to "version"
   #
   # etag
   #
@@ -30,9 +34,20 @@ module Nexo
     belongs_to :element, class_name: "Nexo::Element"
 
     enum :origin, internal: 0, external: 1
+    enum :nev_status,
+      pending_sync: 0,
+      synced: 1,
+      ignored_in_conflict: 2,
+      superseded: 3,
+      ignored_by_sync_direction: 4,
+      ignored_by_deletion: 5
 
     serialize :payload, coder: JSON
 
-    validates :payload, :etag, :origin, presence: true
+    validates :origin, presence: true
+
+    def remote_status
+      payload["status"] if payload.is_a?(Hash)
+    end
   end
 end

data/app/models/nexo/folder.rb

@@ -2,37 +2,45 @@
 #
 # Table name: nexo_folders
 #
-#  id                  :bigint           not null, primary key
-#  integration_id      :bigint           not null
-#  nexo_protocol       :integer          not null
-#  external_identifier :string
-#  name                :string
-#  description         :string
-#  discarded_at        :datetime
-#  created_at          :datetime         not null
-#  updated_at          :datetime         not null
+#  id                     :bigint           not null, primary key
+#  integration_id         :bigint           not null
+#  nexo_protocol          :integer          not null
+#  external_identifier    :string
+#  name                   :string
+#  description            :string
+#  discarded_at           :datetime
+#  created_at             :datetime         not null
+#  updated_at             :datetime         not null
+#  google_next_sync_token :string
+#  sync_direction         :integer          not null
+#  nf_status              :integer          default("initial"), not null
 #
 module Nexo
   class Folder < ApplicationRecord
     belongs_to :integration, class_name: "Nexo::Integration"
     has_many :elements, class_name: "Nexo::Element"
 
-    if respond_to?(:enumerize)
-      enumerize :nexo_protocol, in: { calendar: 0, dummy_calendar: 1 }
-    else
-      enum :nexo_protocol, calendar: 0, dummy_calendar: 1
+    enum :nexo_protocol, calendar: 0, dummy_calendar: 1
+    enum :sync_direction, sync_in_out: 0, sync_out_in: 1, sync_bidirectional: 2
+    enum :nf_status, initial: 0, ok: 1, not_found: 2
+
+    def sync_external_changes?
+      sync_out_in? || sync_bidirectional?
+    end
+
+    def sync_internal_changes?
+      sync_in_out? || sync_bidirectional?
     end
 
     scope :kept, -> { where(discarded_at: nil) }
 
     validates :nexo_protocol, :name, presence: true
 
-    # TODO!: find better name
-    # maybe policy_applies?
-    def policy_match?(synchronizable)
-      PolicyService.instance.match?(self, synchronizable)
+    def policy_applies?(synchronizable)
+      PolicyService.instance.applies?(self, synchronizable)
     end
 
+    # TODO: use find_sole_by
     def find_element(synchronizable:)
       ary = elements.where(synchronizable:, discarded_at: nil).to_a
 
@@ -54,5 +62,9 @@ module Nexo
     def discard!
       update!(discarded_at: Time.current)
     end
+
+    def to_s
+      name.presence || super
+    end
   end
 end

data/app/models/nexo/integration.rb

@@ -14,9 +14,6 @@
 #
 module Nexo
   class Integration < ApplicationRecord
-    include Discard::Model if defined? Discard::Model
-    include Hashid::Rails if defined? Hashid::Rails
-
     serialize :scope, coder: JSON
     belongs_to :user
     belongs_to :client, class_name: "Nexo::Client"

data/app/models/nexo/token.rb

@@ -14,6 +14,8 @@ module Nexo
   class Token < ApplicationRecord
     belongs_to :integration, class_name: "Nexo::Integration"
 
+    scope :active, -> { where(nt_status: :active) }
+
     after_initialize do
       # TODO: https://api.rubyonrails.org/classes/ActiveRecord/Attributes/ClassMethods.html#method-i-attribute
       self.nt_status = :active if nt_status.nil?

data/app/views/layouts/error.html.erb

@@ -0,0 +1,8 @@
+<h1>ERROR</h1>
+
+<% if @exception.present? %>
+  <h4><%= @exception.message %></h4>
+   <pre>
+  <%= JSON.pretty_generate @exception.backtrace %>
+   </pre>
+<% end %>

data/app/views/layouts/nexo.html.erb

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= content_for(:title) || "Nexo" %></title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <meta name="apple-mobile-web-app-capable" content="yes">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <style>
+      table th {
+        font-weight: bold;
+      }
+      table th, table td {
+        border: 1px solid lightgrey;
+        padding: 0.4em;
+      }
+    </style>
+  </head>
+
+  <body>
+    <h1><%= link_to "NEXO", root_path %></h1>
+    <% flash.each do |flash_type, message| %>
+      <% if flash_type == "alert" %>
+        <div style="color: red">
+      <% else %>
+        <div style="color: blue">
+      <% end %>
+        <%= flash_type %>:
+        <%= message %>
+      </div>
+    <% end %>
+    <%= link_to "Folders", folders_path %>
+    <%= link_to "Elements", elements_path %>
+    |
+    <%= link_to "Home", main_app.root_path %>
+    <hr>
+    <%= yield %>
+  </body>
+</html>