maestrano-connector-rails 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc59b725143370fc5d008c5ac038245a3e35616a
-  data.tar.gz: 589185264707571da796f97d3672223109136a8f
+  metadata.gz: 01e80e8ec8f1cf42c1b4dc6e1c55939d010bc8e3
+  data.tar.gz: ad2dc078eb9f605c2bd0a236690801577f38a43b
 SHA512:
-  metadata.gz: dac38cc67856ecd00562faa4e09882af3b10c59a17a575b69724f375b0aedc4efa2cef0912b30d9423d67d9207824457b6883e38f3436d916401dde42e76dac3
-  data.tar.gz: a5a72a4b5a460d0401e0b060552451db1db5ef50c4871fee66a1bc9305e7e4352a0df8a83e08791bc639bf87fa57379d815ea5d37cd934a2059b9aa0e0a74c3e
+  metadata.gz: ef502e52b0d613ba02a37ec02db1c248142553c18178008a4cab46e472c86213eff01ba772db527b360b8f190a943df1e69b549a857a7480996db02b68bb7413
+  data.tar.gz: cc32cc071376de85c8e5269c1cbdd4dff33ca20049fedf8711bbd09c56f69b3f21a05d090206bb614a65b6e8a78fd067d6382ec46046a71e34e6727036cd20d9

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-07-05 12:03:48 +0100 using RuboCop version 0.41.1.
+# on 2016-07-26 04:25:37 +0100 using RuboCop version 0.41.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -19,7 +19,7 @@ Lint/UnusedBlockArgument:
   Exclude:
     - 'app/jobs/maestrano/connector/rails/synchronization_job.rb'
 
-# Offense count: 14
+# Offense count: 17
 # Cop supports --auto-correct.
 # Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
 Lint/UnusedMethodArgument:
@@ -29,29 +29,23 @@ Lint/UnusedMethodArgument:
     - 'app/models/maestrano/connector/rails/concerns/entity.rb'
     - 'app/models/maestrano/connector/rails/concerns/external.rb'
 
-# Offense count: 21
+# Offense count: 23
 Metrics/AbcSize:
   Max: 70
 
-# Offense count: 9
+# Offense count: 10
 Metrics/CyclomaticComplexity:
   Max: 14
 
-# Offense count: 40
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 311
-
-# Offense count: 16
+# Offense count: 20
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 42
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 249
+  Max: 263
 
 # Offense count: 2
 # Configuration parameters: CountKeywordArgs.
@@ -136,13 +130,6 @@ Style/PredicateName:
     - 'app/helpers/maestrano/connector/rails/session_helper.rb'
     - 'app/models/maestrano/connector/rails/concerns/entity.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowMultipleReturnValues.
-Style/RedundantReturn:
-  Exclude:
-    - 'app/jobs/maestrano/connector/rails/push_to_connec_worker.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 Style/RedundantSelf:

data/VERSION

@@ -1 +1 @@
-1.2.3
+1.3.0

data/app/controllers/maestrano/synchronizations_controller.rb

@@ -2,7 +2,7 @@ class Maestrano::SynchronizationsController < Maestrano::Rails::WebHookControlle
   def show
     uid = params[:id]
     organization = Maestrano::Connector::Rails::Organization.find_by_uid(uid)
-    return render json: {errors: {message: "Organization not found", code: 404}}, status: :not_found unless organization
+    return render json: {errors: [{message: "Organization not found", code: 404}]}, status: :not_found unless organization
 
     h = {
       group_id: organization.uid,
@@ -25,7 +25,7 @@ class Maestrano::SynchronizationsController < Maestrano::Rails::WebHookControlle
     uid = params[:group_id]
     opts = params[:opts] || {}
     organization = Maestrano::Connector::Rails::Organization.find_by_uid(uid)
-    return render json: {errors: {message: "Organization not found", code: 404}}, status: :not_found unless organization
+    return render json: {errors: [{message: "Organization not found", code: 404}]}, status: :not_found unless organization
 
     Maestrano::Connector::Rails::SynchronizationJob.perform_later(organization, opts.with_indifferent_access)
     head :created
@@ -34,7 +34,7 @@ class Maestrano::SynchronizationsController < Maestrano::Rails::WebHookControlle
   def toggle_sync
     uid = params[:group_id]
     organization = Maestrano::Connector::Rails::Organization.find_by_uid(uid)
-    return render json: {errors: {message: "Organization not found", code: 404}}, status: :not_found unless organization
+    return render json: {errors: [{message: "Organization not found", code: 404}]}, status: :not_found unless organization
 
     organization.toggle(:sync_enabled)
     organization.save

data/app/models/maestrano/connector/rails/concerns/complex_entity.rb

@@ -14,6 +14,19 @@ module Maestrano::Connector::Rails::Concerns::ComplexEntity
       raise 'Not implemented'
     end
 
+    def formatted_external_entities_names
+      formatted_entities_names(external_entities_names)
+    end
+
+    def formatted_connec_entities_names
+      formatted_entities_names(connec_entities_names)
+    end
+
+    def formatted_entities_names(names)
+      return names.with_indifferent_access if names.is_a?(Hash)
+      names.index_by { |name| name }.with_indifferent_access
+    end
+
     def count_entities(entities)
       entities.values.map(&:size).max
     end
@@ -59,54 +72,54 @@ module Maestrano::Connector::Rails::Concerns::ComplexEntity
   def get_connec_entities(last_synchronization_date = nil)
     entities = ActiveSupport::HashWithIndifferentAccess.new
 
-    self.class.connec_entities_names.each do |connec_entity_name|
-      sub_entity_instance = instantiate_sub_entity_instance(connec_entity_name)
+    self.class.formatted_connec_entities_names.each do |connec_entity_name, connec_class_name|
+      sub_entity_instance = instantiate_sub_entity_instance(connec_class_name)
       entities[connec_entity_name] = sub_entity_instance.get_connec_entities(last_synchronization_date)
     end
     entities
   end
 
-  def get_external_entities_wrapper(last_synchronization_date = nil)
+  def get_external_entities_wrapper(last_synchronization_date = nil, entity_name = '')
     entities = ActiveSupport::HashWithIndifferentAccess.new
 
-    self.class.external_entities_names.each do |external_entity_name|
-      sub_entity_instance = instantiate_sub_entity_instance(external_entity_name)
-      entities[external_entity_name] = sub_entity_instance.get_external_entities_wrapper(last_synchronization_date)
+    self.class.formatted_external_entities_names.each do |external_entity_name, external_class_name|
+      sub_entity_instance = instantiate_sub_entity_instance(external_class_name)
+      entities[external_entity_name] = sub_entity_instance.get_external_entities_wrapper(last_synchronization_date, external_entity_name)
     end
     entities
   end
 
   def consolidate_and_map_data(connec_entities, external_entities)
-    modeled_external_entities = external_model_to_connec_model(external_entities)
-    modeled_connec_entities = connec_model_to_external_model(connec_entities)
+    modelled_external_entities = external_model_to_connec_model(external_entities)
+    modelled_connec_entities = connec_model_to_external_model(connec_entities)
 
-    mapped_connec_entities = consolidate_and_map_connec_entities(modeled_connec_entities, modeled_external_entities)
-    mapped_external_entities = consolidate_and_map_external_entities(modeled_external_entities)
+    mapped_connec_entities = consolidate_and_map_connec_entities(modelled_connec_entities, modelled_external_entities)
+    mapped_external_entities = consolidate_and_map_external_entities(modelled_external_entities)
 
     {connec_entities: mapped_connec_entities, external_entities: mapped_external_entities}
   end
 
-  def consolidate_and_map_connec_entities(modeled_connec_entities, modeled_external_entities)
-    modeled_connec_entities.each do |connec_entity_name, entities_in_external_model|
+  def consolidate_and_map_connec_entities(modelled_connec_entities, modelled_external_entities)
+    modelled_connec_entities.each do |connec_entity_name, entities_in_external_model|
       entities_in_external_model.each do |external_entity_name, entities|
-        sub_entity_instance = instantiate_sub_entity_instance(connec_entity_name)
-        equivalent_external_entities = (modeled_external_entities[external_entity_name] && modeled_external_entities[external_entity_name][connec_entity_name]) || []
+        sub_entity_instance = instantiate_sub_entity_instance(self.class.formatted_connec_entities_names[connec_entity_name])
+        equivalent_external_entities = (modelled_external_entities[external_entity_name] && modelled_external_entities[external_entity_name][connec_entity_name]) || []
 
         entities_in_external_model[external_entity_name] = sub_entity_instance.consolidate_and_map_connec_entities(entities, equivalent_external_entities, sub_entity_instance.class.references[external_entity_name] || [], external_entity_name)
       end
     end
-    modeled_connec_entities
+    modelled_connec_entities
   end
 
-  def consolidate_and_map_external_entities(modeled_external_entities)
-    modeled_external_entities.each do |external_entity_name, entities_in_connec_model|
+  def consolidate_and_map_external_entities(modelled_external_entities)
+    modelled_external_entities.each do |external_entity_name, entities_in_connec_model|
       entities_in_connec_model.each do |connec_entity_name, entities|
-        sub_entity_instance = instantiate_sub_entity_instance(external_entity_name)
+        sub_entity_instance = instantiate_sub_entity_instance(self.class.formatted_external_entities_names[external_entity_name])
 
         entities_in_connec_model[connec_entity_name] = sub_entity_instance.consolidate_and_map_external_entities(entities, connec_entity_name)
       end
     end
-    modeled_external_entities
+    modelled_external_entities
   end
 
   # input : {
@@ -120,7 +133,7 @@ module Maestrano::Connector::Rails::Concerns::ComplexEntity
   #          }
   def push_entities_to_connec(mapped_external_entities_with_idmaps)
     mapped_external_entities_with_idmaps.each do |external_entity_name, entities_in_connec_model|
-      sub_entity_instance = instantiate_sub_entity_instance(external_entity_name)
+      sub_entity_instance = instantiate_sub_entity_instance(self.class.formatted_external_entities_names[external_entity_name])
       entities_in_connec_model.each do |connec_entity_name, mapped_entities_with_idmaps|
         sub_entity_instance.push_entities_to_connec_to(mapped_entities_with_idmaps, connec_entity_name)
       end
@@ -129,7 +142,7 @@ module Maestrano::Connector::Rails::Concerns::ComplexEntity
 
   def push_entities_to_external(mapped_connec_entities_with_idmaps)
     mapped_connec_entities_with_idmaps.each do |connec_entity_name, entities_in_external_model|
-      sub_entity_instance = instantiate_sub_entity_instance(connec_entity_name)
+      sub_entity_instance = instantiate_sub_entity_instance(self.class.formatted_connec_entities_names[connec_entity_name])
       entities_in_external_model.each do |external_entity_name, mapped_entities_with_idmaps|
         sub_entity_instance.push_entities_to_external_to(mapped_entities_with_idmaps, external_entity_name)
       end
@@ -137,7 +150,7 @@ module Maestrano::Connector::Rails::Concerns::ComplexEntity
   end
 
   def instantiate_sub_entity_instance(entity_name)
-    "Entities::SubEntities::#{entity_name.titleize.split.join}".constantize.new(@organization, @connec_client, @external_client, @opts)
+    self.class.instantiate_sub_entity_instance(entity_name, @organization, @connec_client, @external_client, @opts)
   end
 
   # -------------------------------------------------------------
@@ -154,5 +167,20 @@ module Maestrano::Connector::Rails::Concerns::ComplexEntity
     def build_hash_with_entities(entities_name, entity_name, proc, entities)
       Hash[*entities_name.collect { |name| proc.call(name) == entity_name ? [name, entities] : [name, []] }.flatten(1)]
     end
+
+    def instantiate_sub_entity_instance(entity_name, organization, connec_client, external_client, opts)
+      "Entities::SubEntities::#{entity_name.titleize.split.join}".constantize.new(organization, connec_client, external_client, opts)
+    end
+
+    def find_complex_entity_and_instantiate_external_sub_entity_instance(entity_name, organization, connec_client, external_client, opts)
+      Maestrano::Connector::Rails::External.entities_list.each do |entity_name_from_list|
+        clazz = "Entities::#{entity_name_from_list.singularize.titleize.split.join}".constantize
+        if clazz.methods.include?('external_entities_names'.to_sym)
+          formatted_names = clazz.formatted_external_entities_names
+          return instantiate_sub_entity_instance(formatted_names[entity_name], organization, connec_client, external_client, opts) if formatted_names[entity_name]
+        end
+      end
+      nil
+    end
   end
 end

data/app/models/maestrano/connector/rails/concerns/connec_helper.rb

@@ -17,6 +17,8 @@ module Maestrano::Connector::Rails::Concerns::ConnecHelper
       client
     end
 
+    # Returns a string of the tenant's current connec version.
+    # Can use Gem::Version for version comparison
     def connec_version(organization)
       @@connec_version = Rails.cache.fetch("connec_version_#{organization.tenant}", namespace: 'maestrano', expires_in: 1.day) do
         response = get_client(organization).class.get("#{Maestrano[organization.tenant].param('connec.host')}/version")
@@ -26,32 +28,52 @@ module Maestrano::Connector::Rails::Concerns::ConnecHelper
       @@connec_version
     end
 
-    # Replace the ids arrays by the external id
-    # If a reference has no id for this oauth_provider and oauth_uid but has one for connec, returns nil
+    # Replaces the arrays of id received from Connec! by the id of the external application
+    # Returns a hash {entity: {}, connec_id: '', id_refs_only_connec_entity: {}}
+    # If an array has no id for this oauth_provider and oauth_uid but has one for connec, it returns a nil entity (skip the record)
     def unfold_references(connec_entity, references, organization)
-      unfolded_connec_entity = connec_entity.with_indifferent_access
+      references = format_references(references)
+      unfolded_connec_entity = connec_entity.deep_dup.with_indifferent_access
       not_nil = true
 
       # Id
       id_hash = unfolded_connec_entity['id'].find { |id| id['provider'] == organization.oauth_provider && id['realm'] == organization.oauth_uid }
-      unfolded_connec_entity[:__connec_id] = unfolded_connec_entity['id'].find { |id| id['provider'] == 'connec' }['id']
+      connec_id = unfolded_connec_entity['id'].find { |id| id['provider'] == 'connec' }['id']
       unfolded_connec_entity['id'] = id_hash ? id_hash['id'] : nil
 
-      # Other refs
-      references.each do |reference|
-        not_nil &&= unfold_references_helper(unfolded_connec_entity, reference.split('/'), organization)
+      # Other references
+      # Record references are references to other records (organization_id, item_id, ...)
+      references[:record_references].each do |reference|
+        not_nil &= unfold_references_helper(unfolded_connec_entity, reference.split('/'), organization)
       end
-      not_nil ? unfolded_connec_entity : nil
+      # Id references are references to sub entities ids (invoice lines id, ...)
+      # We do not return nil if we're missing an id reference
+      references[:id_references].each do |reference|
+        unfold_references_helper(unfolded_connec_entity, reference.split('/'), organization)
+      end
+      unfolded_connec_entity = not_nil ? unfolded_connec_entity : nil
+
+      # Filter the connec entity to keep only the id_references fields (in order to save some memory)
+      # Give an empty hash if there's nothing left
+      id_refs_only_connec_entity = filter_connec_entity_for_id_refs(connec_entity, references[:id_references])
+
+      {entity: unfolded_connec_entity, connec_id: connec_id, id_refs_only_connec_entity: id_refs_only_connec_entity}
     end
 
+    # Replaces ids from the external application by arrays containing them
     def fold_references(mapped_external_entity, references, organization)
+      references = format_references(references)
       mapped_external_entity = mapped_external_entity.with_indifferent_access
-      (references + ['id']).each do |reference|
+
+      # Use both record_references and id_references + the id
+      (references.values.flatten + ['id']).each do |reference|
         fold_references_helper(mapped_external_entity, reference.split('/'), organization)
       end
+
       mapped_external_entity
     end
 
+    # Builds an id_hash from the id and organization
     def id_hash(id, organization)
       {
         id: id,
@@ -60,6 +82,7 @@ module Maestrano::Connector::Rails::Concerns::ConnecHelper
       }
     end
 
+    # Recursive method for folding references
     def fold_references_helper(entity, array_of_refs, organization)
       ref = array_of_refs.shift
       field = entity[ref]
@@ -71,7 +94,7 @@ module Maestrano::Connector::Rails::Concerns::ConnecHelper
         field.each do |f|
           fold_references_helper(f, array_of_refs.dup, organization)
         end
-      when HashWithIndifferentAccess
+      when Hash
         fold_references_helper(entity[ref], array_of_refs, organization)
       else
         id = field
@@ -79,6 +102,7 @@ module Maestrano::Connector::Rails::Concerns::ConnecHelper
       end
     end
 
+    # Recursive method for unfolding references
     def unfold_references_helper(entity, array_of_refs, organization)
       ref = array_of_refs.shift
       field = entity[ref]
@@ -93,23 +117,137 @@ module Maestrano::Connector::Rails::Concerns::ConnecHelper
           # We may enqueue a fetch on the endpoint of the missing association, followed by a re-fetch on this one.
           # However it's expected to be an edge case, so for now we rely on the fact that the webhooks should be relativly in order.
           # Worst case it'll be done on following sync
+          entity.delete(ref)
           return nil
         end
+        true
 
       # Follow embedment path
       else
-        unless field.blank?
-          case field
-          when Array
-            field.each do |f|
-              unfold_references_helper(f, array_of_refs.dup, organization)
-            end
-          when HashWithIndifferentAccess
-            unfold_references_helper(entity[ref], array_of_refs, organization)
+        return true if field.blank?
+        case field
+        when Array
+          bool = true
+          field.each do |f|
+            bool &= unfold_references_helper(f, array_of_refs.dup, organization)
+          end
+          bool
+        when Hash
+          unfold_references_helper(entity[ref], array_of_refs, organization)
+        end
+      end
+    end
+
+    # Transforms the references into an hash {record_references: [], id_references: []}
+    # References can either be an array (only record references), or a hash
+    def format_references(references)
+      return {record_references: references, id_references: []} if references.is_a?(Array)
+      references[:record_references] ||= []
+      references[:id_references] ||= []
+      references
+    end
+
+    # Returns the connec_entity without all the fields that are not id_references
+    def filter_connec_entity_for_id_refs(connec_entity, id_references)
+      return {} if id_references.empty?
+
+      entity = connec_entity.dup.with_indifferent_access
+      tree = build_id_references_tree(id_references)
+
+      filter_connec_entity_for_id_refs_helper(entity, tree)
+
+      # TODO, improve performance by returning an empty hash if all the id_references have their id in the connec hash
+      # We should still return all of them if at least one is missing as we are relying on the id
+      entity
+    end
+
+    # Recursive method for filtering connec entities
+    def filter_connec_entity_for_id_refs_helper(entity_hash, tree)
+      return if tree.empty?
+      entity_hash.slice!(*tree.keys)
+
+      tree.each do |key, children|
+        case entity_hash[key]
+        when Array
+          entity_hash[key].each do |hash|
+            filter_connec_entity_for_id_refs_helper(hash, children)
+          end
+        when Hash
+          filter_connec_entity_for_id_refs_helper(entity_hash[key], children)
+        end
+      end
+    end
+
+    # Builds a tree from an array of id_references
+    # input: %w(lines/id lines/linked/id linked/id)
+    # output: {"lines"=>{"id"=>{}, "linked"=>{"id"=>{}}}, "linked"=>{"id"=>{}}}
+    def build_id_references_tree(id_references)
+      tree = {}
+
+      id_references.each do |id_reference|
+        array_of_refs = id_reference.split('/')
+
+        t = tree
+        array_of_refs.each do |ref|
+          t[ref] ||= {}
+          t = t[ref]
+        end
+      end
+
+      tree
+    end
+
+    # Merges the id arrays from two hashes while keeping only the id_references fields
+    def merge_id_hashes(dist, src, id_references)
+      dist = dist.with_indifferent_access
+      src = src.with_indifferent_access
+
+      id_references.each do |id_reference|
+        array_of_refs = id_reference.split('/')
+
+        merge_id_hashes_helper(dist, array_of_refs, src)
+      end
+
+      dist
+    end
+
+    # Recursive helper for merging id hashes
+    def merge_id_hashes_helper(hash, array_of_refs, src, path = [])
+      ref = array_of_refs.shift
+      field = hash[ref]
+
+      if array_of_refs.empty? && field
+        value = value_from_hash(src, path + [ref])
+        if value.is_a?(Array)
+          hash[ref] = (field + value).uniq
+        else
+          hash.delete(ref)
+        end
+      else
+        case field
+        when Array
+          field.each_with_index do |f, index|
+            merge_id_hashes_helper(f, array_of_refs.dup, src, path + [ref, index])
           end
+        when Hash
+          merge_id_hashes_helper(field, array_of_refs, src, path + [ref])
+        end
+      end
+    end
+
+    # Returns the value from a hash following the given path
+    # Path sould be an array like [:lines, 0, :id]
+    def value_from_hash(hash, path)
+      value = hash
+
+      begin
+        path.each do |p|
+          value = value[p]
         end
+        value
+      rescue NoMethodError
+        nil
       end
-      true
     end
   end
 end