maestrano-connector-rails 1.2.3 → 1.3.0

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

@@ -15,7 +15,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
     # organization_and_id can be either:
     # * {connec_id: 'id', organization_id: 'id'}
     # * {external_id: 'id', organization_id: 'id'}
-    # Needs to include either connec_entity or external_entity for complex entities
+    # Needs to include either connec_entity or external_entity for sub entities
     def find_or_create_idmap(organization_and_id)
       Maestrano::Connector::Rails::IdMap.find_or_create_by(names_hash.merge(organization_and_id))
     end
@@ -36,11 +36,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
     end
 
     def normalize_connec_entity_name(name)
-      if singleton?
-        name.parameterize('_')
-      else
-        name.parameterize('_').pluralize
-      end
+      singleton? ? name.parameterize('_') : name.parameterize('_').pluralize
     end
 
     # ----------------------------------------------
@@ -116,6 +112,10 @@ module Maestrano::Connector::Rails::Concerns::Entity
       can_write_connec?
     end
 
+    def can_update_connec?
+      true
+    end
+
     def can_write_connec?
       true
     end
@@ -147,9 +147,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
   # ----------------------------------------------
   # Map a Connec! entity to the external model
   def map_to_external(entity)
-    connec_id = entity[:__connec_id]
-    mapped_entity = self.class.mapper_class.normalize(entity)
-    (connec_id ? mapped_entity.merge(__connec_id: connec_id) : mapped_entity).with_indifferent_access
+    self.class.mapper_class.normalize(entity).with_indifferent_access
   end
 
   # Map an external entity to Connec! model
@@ -223,6 +221,10 @@ module Maestrano::Connector::Rails::Concerns::Entity
 
     Maestrano::Connector::Rails::ConnectorLogger.log('info', @organization, "Sending #{Maestrano::Connector::Rails::External.external_name} #{self.class.external_entity_name.pluralize} to Connec! #{connec_entity_name.pluralize}")
 
+    unless self.class.can_update_connec?
+      mapped_external_entities_with_idmaps.select! { |mapped_external_entity_with_idmap| !mapped_external_entity_with_idmap[:idmap].connec_id }
+    end
+
     proc = ->(mapped_external_entity_with_idmap) { batch_op('post', mapped_external_entity_with_idmap[:entity], nil, self.class.normalize_connec_entity_name(connec_entity_name)) }
     batch_calls(mapped_external_entities_with_idmaps, proc, connec_entity_name)
   end
@@ -241,13 +243,13 @@ module Maestrano::Connector::Rails::Concerns::Entity
   # ----------------------------------------------
   #                 External methods
   # ----------------------------------------------
-  def get_external_entities_wrapper(last_synchronization_date = nil)
+  def get_external_entities_wrapper(last_synchronization_date = nil, entity_name = self.class.external_entity_name)
     return [] if @opts[:__skip_external] || !self.class.can_read_external?
-    get_external_entities(last_synchronization_date)
+    get_external_entities(entity_name, last_synchronization_date)
   end
 
-  def get_external_entities(last_synchronization_date = nil)
-    Maestrano::Connector::Rails::ConnectorLogger.log('info', @organization, "Fetching #{Maestrano::Connector::Rails::External.external_name} #{self.class.external_entity_name.pluralize}")
+  def get_external_entities(external_entity_name, last_synchronization_date = nil)
+    Maestrano::Connector::Rails::ConnectorLogger.log('info', @organization, "Fetching #{Maestrano::Connector::Rails::External.external_name} #{external_entity_name.pluralize}")
     raise 'Not implemented'
   end
 
@@ -259,42 +261,48 @@ module Maestrano::Connector::Rails::Concerns::Entity
     return unless self.class.can_write_external?
 
     Maestrano::Connector::Rails::ConnectorLogger.log('info', @organization, "Sending Connec! #{self.class.connec_entity_name.pluralize} to #{Maestrano::Connector::Rails::External.external_name} #{external_entity_name.pluralize}")
-    ids_to_send_to_connec = mapped_connec_entities_with_idmaps.map{ |mapped_connec_entity_with_idmap|
-      idmap = push_entity_to_external(mapped_connec_entity_with_idmap, external_entity_name)
-      idmap ? {idmap: idmap} : nil
+    entities_to_send_to_connec = mapped_connec_entities_with_idmaps.map{ |mapped_connec_entity_with_idmap|
+      push_entity_to_external(mapped_connec_entity_with_idmap, external_entity_name)
     }.compact
 
-    return if ids_to_send_to_connec.empty?
+    return if entities_to_send_to_connec.empty?
 
     # Send the external ids to connec if it was a creation
-    proc = ->(id) { batch_op('put', {id: [Maestrano::Connector::Rails::ConnecHelper.id_hash(id[:idmap].external_id, @organization)]}, id[:idmap].connec_id, self.class.normalize_connec_entity_name(self.class.connec_entity_name)) }
-    batch_calls(ids_to_send_to_connec, proc, self.class.connec_entity_name, true)
+    # or if there are some sub entities ids to send (completed_hash)
+    proc = lambda do |entity|
+      id = {id: [Maestrano::Connector::Rails::ConnecHelper.id_hash(entity[:idmap].external_id, @organization)]}
+      body = entity[:completed_hash] ? entity[:completed_hash].merge(id) : id
+      batch_op('put', body, entity[:idmap].connec_id, self.class.normalized_connec_entity_name)
+    end
+    batch_calls(entities_to_send_to_connec, proc, self.class.connec_entity_name, true)
   end
 
   def push_entity_to_external(mapped_connec_entity_with_idmap, external_entity_name)
     idmap = mapped_connec_entity_with_idmap[:idmap]
     mapped_connec_entity = mapped_connec_entity_with_idmap[:entity]
+    id_refs_only_connec_entity = mapped_connec_entity_with_idmap[:id_refs_only_connec_entity]
 
     begin
       # Create and return id to send to connec!
       if idmap.external_id.blank?
-        external_id = create_external_entity(mapped_connec_entity, external_entity_name)
-        idmap.update(external_id: external_id, last_push_to_external: Time.now, message: nil)
-        return idmap
+        external_hash = create_external_entity(mapped_connec_entity, external_entity_name)
+        idmap.update(external_id: self.class.id_from_external_entity_hash(external_hash), last_push_to_external: Time.now, message: nil)
 
+        return {idmap: idmap, completed_hash: map_and_complete_hash_with_connec_ids(external_hash, external_entity_name, id_refs_only_connec_entity)}
       # Update
       else
-        return unless self.class.can_update_external?
-        update_external_entity(mapped_connec_entity, idmap.external_id, external_entity_name)
+        return nil unless self.class.can_update_external?
+        external_hash = update_external_entity(mapped_connec_entity, idmap.external_id, external_entity_name)
 
-        # Return the id to send it to connec! if the first push of a singleton
-        if self.class.singleton? && idmap.last_push_to_external.nil?
-          idmap.update(last_push_to_external: Time.now, message: nil)
-          return idmap
-        else
+        completed_hash = map_and_complete_hash_with_connec_ids(external_hash, external_entity_name, id_refs_only_connec_entity)
+
+        # Return the idmap to send it to connec! only if it's the first push of a singleton
+        # or if there is a completed hash to send
+        if (self.class.singleton? && idmap.last_push_to_external.nil?) || completed_hash
           idmap.update(last_push_to_external: Time.now, message: nil)
+          return {idmap: idmap, completed_hash: completed_hash}
         end
-
+        idmap.update(last_push_to_external: Time.now, message: nil)
       end
     rescue => e
       # Store External error
@@ -314,6 +322,16 @@ module Maestrano::Connector::Rails::Concerns::Entity
     raise 'Not implemented'
   end
 
+  # Maps the entity received from external after a creation or an update and complete the received ids with the connec ones
+  def map_and_complete_hash_with_connec_ids(external_hash, external_entity_name, connec_hash)
+    return nil if connec_hash.empty?
+
+    mapped_external_hash = map_to_connec(external_hash)
+    id_references = Maestrano::Connector::Rails::ConnecHelper.format_references(self.class.references)
+
+    Maestrano::Connector::Rails::ConnecHelper.merge_id_hashes(connec_hash, mapped_external_hash, id_references[:id_references])
+  end
+
   # ----------------------------------------------
   #                 General methods
   # ----------------------------------------------
@@ -336,13 +354,15 @@ module Maestrano::Connector::Rails::Concerns::Entity
       # Entity has been created before date filtering limit
       next nil if before_date_filtering_limit?(entity, false) && !@opts[:full_sync]
 
-      entity = Maestrano::Connector::Rails::ConnecHelper.unfold_references(entity, references, @organization)
+      unfold_hash = Maestrano::Connector::Rails::ConnecHelper.unfold_references(entity, references, @organization)
+      entity = unfold_hash[:entity]
       next nil unless entity
-      connec_id = entity.delete(:__connec_id)
+      connec_id = unfold_hash[:connec_id]
+      id_refs_only_connec_entity = unfold_hash[:id_refs_only_connec_entity]
 
       if entity['id'].blank?
         idmap = self.class.find_or_create_idmap(organization_id: @organization.id, name: self.class.object_name_from_connec_entity_hash(entity), external_entity: external_entity_name.downcase, connec_id: connec_id)
-        next map_connec_entity_with_idmap(entity, external_entity_name, idmap)
+        next map_connec_entity_with_idmap(entity, external_entity_name, idmap, id_refs_only_connec_entity)
       end
 
       idmap = self.class.find_or_create_idmap(external_id: entity['id'], organization_id: @organization.id, external_entity: external_entity_name.downcase, connec_id: connec_id)
@@ -350,7 +370,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
 
       next nil if idmap.external_inactive || !idmap.to_external || (!@opts[:full_sync] && not_modified_since_last_push_to_external?(idmap, entity))
       # Check for conflict with entities from external
-      solve_conflict(entity, external_entities, external_entity_name, idmap)
+      solve_conflict(entity, external_entities, external_entity_name, idmap, id_refs_only_connec_entity)
     }.compact
   end
 
@@ -397,10 +417,11 @@ module Maestrano::Connector::Rails::Concerns::Entity
       idmap.update(external_id: self.class.id_from_external_entity_hash(external_entities.first), name: self.class.object_name_from_external_entity_hash(external_entities.first))
       return {connec_entities: [], external_entities: [{entity: map_to_connec(external_entities.first), idmap: idmap}]}
     else
-      entity = Maestrano::Connector::Rails::ConnecHelper.unfold_references(connec_entities.first, self.class.references, @organization)
-      idmap.update(name: self.class.object_name_from_connec_entity_hash(entity), connec_id: entity.delete(:__connec_id))
+      unfold_hash = Maestrano::Connector::Rails::ConnecHelper.unfold_references(connec_entities.first, self.class.references, @organization)
+      entity = unfold_hash[:entity]
+      idmap.update(name: self.class.object_name_from_connec_entity_hash(entity), connec_id: unfold_hash[:connec_id])
       idmap.update(external_id: self.class.id_from_external_entity_hash(external_entities.first)) unless external_entities.empty?
-      return {connec_entities: [{entity: map_to_external(entity), idmap: idmap}], external_entities: []}
+      return {connec_entities: [{entity: map_to_external(entity), idmap: idmap, id_refs_only_connec_entity: {}}], external_entities: []}
     end
   end
 
@@ -466,10 +487,10 @@ module Maestrano::Connector::Rails::Concerns::Entity
       connec_entity['updated_at'] > self.class.last_update_date_from_external_entity_hash(external_entity)
     end
 
-    def solve_conflict(connec_entity, external_entities, external_entity_name, idmap)
+    def solve_conflict(connec_entity, external_entities, external_entity_name, idmap, id_refs_only_connec_entity)
       external_entity = external_entities.find { |entity| connec_entity['id'] == self.class.id_from_external_entity_hash(entity) }
       # No conflict
-      return map_connec_entity_with_idmap(connec_entity, external_entity_name, idmap) unless external_entity
+      return map_connec_entity_with_idmap(connec_entity, external_entity_name, idmap, id_refs_only_connec_entity) unless external_entity
 
       # Conflict
       # We keep the most recently updated entity
@@ -478,15 +499,15 @@ module Maestrano::Connector::Rails::Concerns::Entity
       if keep_connec
         Maestrano::Connector::Rails::ConnectorLogger.log('info', @organization, "Conflict between #{Maestrano::Connector::Rails::External.external_name} #{external_entity_name} #{external_entity} and Connec! #{self.class.connec_entity_name} #{connec_entity}. Entity from Connec! kept")
         external_entities.delete(external_entity)
-        map_connec_entity_with_idmap(connec_entity, external_entity_name, idmap)
+        map_connec_entity_with_idmap(connec_entity, external_entity_name, idmap, id_refs_only_connec_entity)
       else
         Maestrano::Connector::Rails::ConnectorLogger.log('info', @organization, "Conflict between #{Maestrano::Connector::Rails::External.external_name} #{external_entity_name} #{external_entity} and Connec! #{self.class.connec_entity_name} #{connec_entity}. Entity from external kept")
         nil
       end
     end
 
-    def map_connec_entity_with_idmap(connec_entity, external_entity_name, idmap)
-      {entity: map_to_external(connec_entity), idmap: idmap}
+    def map_connec_entity_with_idmap(connec_entity, external_entity_name, idmap, id_refs_only_connec_entity)
+      {entity: map_to_external(connec_entity), idmap: idmap, id_refs_only_connec_entity: id_refs_only_connec_entity}
     end
 
     def map_external_entity_with_idmap(external_entity, connec_entity_name, idmap)

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

@@ -10,6 +10,10 @@ module Maestrano::Connector::Rails::Concerns::External
       raise 'Not implemented'
     end
 
+    def create_account_link(organization = nil)
+      raise 'Not implemented'
+    end
+
     # Return an array of all the entities that the connector can synchronize
     # If you add new entities, you need to generate
     # a migration to add them to existing organizations

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

@@ -58,17 +58,30 @@ module Maestrano::Connector::Rails::Concerns::SubEntityBase
 
       folded_entity
     else
-      connec_id = entity[:__connec_id]
-      mapped_entity = mapper.normalize(entity)
-      (connec_id ? mapped_entity.merge(__connec_id: connec_id) : mapped_entity).with_indifferent_access
+      mapper.normalize(entity).with_indifferent_access
     end
   end
 
-  def map_connec_entity_with_idmap(connec_entity, external_entity_name, idmap)
-    {entity: map_to(external_entity_name, connec_entity), idmap: idmap}
+  def map_connec_entity_with_idmap(connec_entity, external_entity_name, idmap, id_refs_only_connec_entity)
+    {entity: map_to(external_entity_name, connec_entity), idmap: idmap, id_refs_only_connec_entity: id_refs_only_connec_entity}
   end
 
   def map_external_entity_with_idmap(external_entity, connec_entity_name, idmap)
     {entity: map_to(connec_entity_name, external_entity), idmap: idmap}
   end
+
+  # Maps the entity received from external after a creation or an update and complete the received ids with the connec ones
+  def map_and_complete_hash_with_connec_ids(external_hash, external_entity_name, connec_hash)
+    return nil if connec_hash.empty?
+
+    # As we don't know to which complex entity this sub entity is related to, we have to do a full scan of the entities to find the right one
+    # Because we need the external_entities_names
+    external_entity_instance = Maestrano::Connector::Rails::ComplexEntity.find_complex_entity_and_instantiate_external_sub_entity_instance(external_entity_name, @organization, @connec_client, @external_client, @opts)
+    return nil unless external_entity_instance
+
+    mapped_external_hash = external_entity_instance.map_to(self.class.connec_entity_name, external_hash)
+    id_references = Maestrano::Connector::Rails::ConnecHelper.format_references(self.class.references[external_entity_name])
+
+    Maestrano::Connector::Rails::ConnecHelper.merge_id_hashes(connec_hash, mapped_external_hash, id_references[:id_references])
+  end
 end

data/app/models/maestrano/connector/rails/organization.rb

@@ -49,7 +49,7 @@ module Maestrano::Connector::Rails
     end
 
     def member?(user)
-      user_organization_rels.where(user_id: user.id).count > 0
+      user_organization_rels.where(user_id: user.id).count.positive?
     end
 
     def remove_member(user)

data/lib/generators/connector/templates/complex_entity_example/contact_and_lead.rb

@@ -1,6 +1,6 @@
 # TODO
 # This file is provided as an example and should be removed
-# See README for explanation
+# See documentation (https://maestrano.atlassian.net/wiki/display/DEV/Mapping+and+synchronization) for explanation
 # class Entities::ContactAndLead < Maestrano::Connector::Rails::ComplexEntity
 #   def self.connec_entities_names
 #     %w(person)
@@ -25,16 +25,16 @@
 #   #          }
 #   def connec_model_to_external_model(connec_hash_of_entities)
 #     people = connec_hash_of_entities['person']
-#     modeled_connec_entities = {'person' => { 'lead' => [], 'contact' => [] }}
+#     modelled_connec_entities = {'person' => { 'lead' => [], 'contact' => [] }}
 
 #     people.each do |person|
 #       if person['is_lead']
-#         modeled_connec_entities['person']['lead'] << person
+#         modelled_connec_entities['person']['lead'] << person
 #       else
-#         modeled_connec_entities['person']['contact'] << person
+#         modelled_connec_entities['person']['contact'] << person
 #       end
 #     end
-#     return modeled_connec_entities
+#     return modelled_connec_entities
 #   end
 
 #   # input :  {

data/lib/generators/connector/templates/entity.rb

@@ -8,7 +8,7 @@ class Maestrano::Connector::Rails::Entity < Maestrano::Connector::Rails::EntityB
   # * @opts
 
   # Return an array of entities from the external app
-  def get_external_entities(last_synchronization_date=nil)
+  def get_external_entities(external_entity_name, last_synchronization_date = nil)
     Maestrano::Connector::Rails::ConnectorLogger.log('info', @organization, "Fetching #{Maestrano::Connector::Rails::External.external_name} #{self.class.external_entity_name.pluralize}")
     # TODO
     # This method should return only entities that have been updated since the last_synchronization_date
@@ -20,13 +20,13 @@ class Maestrano::Connector::Rails::Entity < Maestrano::Connector::Rails::EntityB
   def create_external_entity(mapped_connec_entity, external_entity_name)
     Maestrano::Connector::Rails::ConnectorLogger.log('info', @organization, "Sending create #{external_entity_name}: #{mapped_connec_entity} to #{Maestrano::Connector::Rails::External.external_name}")
     # TODO
-    # This method creates the entity in the external app and returns the external id
+    # This method creates the entity in the external app and returns the created external entity
   end
 
   def update_external_entity(mapped_connec_entity, external_id, external_entity_name)
     Maestrano::Connector::Rails::ConnectorLogger.log('info', @organization, "Sending update #{external_entity_name} (id=#{external_id}): #{mapped_connec_entity} to #{Maestrano::Connector::Rails::External.external_name}")
     # TODO
-    # This method updates the entity with the given id in the external app
+    # This method updates the entity with the given id in the external app and returns the created external entity
   end
 
   def self.id_from_external_entity_hash(entity)
@@ -52,5 +52,4 @@ class Maestrano::Connector::Rails::Entity < Maestrano::Connector::Rails::EntityB
     # This method return true is entity is inactive in the external application
     # e.g entity['status'] == 'INACTIVE'
   end
-
-end
+end

data/lib/generators/connector/templates/external.rb

@@ -17,6 +17,12 @@ class Maestrano::Connector::Rails::External
     # client_secret: ENV['']
   end
 
+  def self.create_account_link(organization = nil)
+    # TODO
+    # Returns a link to the sign up page of the external application
+    '#'
+  end
+
   # Return an array of all the entities that the connector can synchronize
   # If you add new entities, you need to generate
   # a migration to add them to existing organizations

data/lib/generators/connector/templates/home_index.haml

@@ -32,7 +32,10 @@
           - if @organization.oauth_uid
             = link_to "Disconnect", signout_omniauth_path(organization_id: @organization.id), class: "btn btn-warning btn-lg #{is_admin ? '' : 'disabled'}"
           - else
-            = link_to "Link to ApplicationName", "/auth/ApplicationName/request?org_uid=#{@organization.uid}", class: "btn btn-warning btn-lg" if is_admin
+            - if is_admin
+              = link_to "Link to ApplicationName", "/auth/ApplicationName/request?org_uid=#{@organization.uid}", class: 'btn btn-warning btn-lg'
+              %br
+              %small If you don’t have an account #{link_to 'create yours here', Maestrano::Connector::Rails::External.create_account_link(current_organization || nil)}
 
       .spacer1
 
@@ -53,10 +56,10 @@
                       %input{type: "checkbox", id: "#{k}", name: "#{k}", checked: v}
                     .col-md-6{style: 'padding-top: 5px;'}
                       %label{:for => "#{k}"} #{k.to_s.humanize.pluralize}
-                    -if is_admin
+                    - if is_admin
                       .col-md-5.text-right
                         - if v && @organization.oauth_uid && @organization.sync_enabled
-                          = link_to "Force a synchronization for #{k.to_s.humanize.pluralize} only", home_synchronize_path(opts: {only_entities: [k.to_s]}), method: :post, class: "btn btn-warning btn-sm"
+                          = link_to "Force a synchronization for #{k.to_s.humanize.pluralize} only", home_synchronize_path(opts: {only_entities: [k.to_s]}), method: :post, class: 'btn btn-warning btn-sm'
             .spacer1
             .row
               .col-md-4
@@ -82,5 +85,5 @@
     - else
       .row
         .col-md-4.col-md-offset-4.center
-          = link_to "Link your Maestrano account", Maestrano::Connector::Rails::Engine.routes.url_helpers.default_maestrano_auth_saml_index_path(tenant: :default), class: 'btn btn-warning'
+          = link_to 'Link your Maestrano account', Maestrano::Connector::Rails::Engine.routes.url_helpers.default_maestrano_auth_saml_index_path(tenant: :default), class: 'btn btn-warning'
 

data/maestrano-connector-rails.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: maestrano-connector-rails 1.2.3 ruby lib
+# stub: maestrano-connector-rails 1.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "maestrano-connector-rails"
-  s.version = "1.2.3"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Pierre Berard"]
-  s.date = "2016-07-12"
+  s.date = "2016-07-26"
   s.description = "Maestrano is the next generation marketplace for SME applications. See https://maestrano.com for details."
   s.email = "pierre.berard@maestrano.com"
   s.executables = ["rails"]
@@ -172,9 +172,12 @@ Gem::Specification.new do |s|
     "spec/dummy/public/favicon.ico",
     "spec/dummy/tmp/cache/.keep",
     "spec/factories.rb",
+    "spec/integration/complex_id_references_spec.rb",
+    "spec/integration/complex_naming_spec.rb",
+    "spec/integration/complex_spec.rb",
     "spec/integration/connec_to_external_spec.rb",
     "spec/integration/external_to_connec_spec.rb",
-    "spec/integration/integration_complex_spec.rb",
+    "spec/integration/id_references_spec.rb",
     "spec/integration/singleton_spec.rb",
     "spec/jobs/all_synchronizations_job_spec.rb",
     "spec/jobs/push_to_connec_job_spec.rb",

data/release_notes.md

@@ -1,3 +1,8 @@
+## 1.2.3
+
+### Fixes
+* Fix Connec! version that was not cached scoped by tenant
+
 ## 1.2.2
 
 ### Fixes

data/spec/factories.rb

@@ -19,9 +19,9 @@ FactoryGirl.define do
   end
 
   factory :idmap, class: Maestrano::Connector::Rails::IdMap do
-    connec_id '6798-ada6-te43'
+    sequence(:connec_id) { |n| "#{n}6798-ada6-te43#{n}" }
     connec_entity 'person'
-    external_id '4567ada66'
+    sequence(:external_id) { |n| "#{n}4567ada66#{n}" } 
     external_entity 'contact'
     last_push_to_external 2.day.ago
     last_push_to_connec 1.day.ago