maestrano-connector-rails 2.0.2.pre.RC9 → 2.0.2.pre.RC10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3664893bd3a248abdb2607dd361f36fa3b8a2a4
-  data.tar.gz: 4ee24001e70b0181b894e7f769f454a2bfc6a1fd
+  metadata.gz: 65e017e72e894da3e1fadf4eda7d24580fe90176
+  data.tar.gz: 09168f2321092da1b57490468516225190cd9e64
 SHA512:
-  metadata.gz: f9471077316bf074b73bf7ec3e375355d07c0324d78fd52f80a09b4a8b86d78bef4fd624ef17a64f64cafc06da3ca4865d8caed932d212c4c72e0470316b6d6e
-  data.tar.gz: d268f0fbd74269c830e0d708886abc00e11ed48dea71394ad6d8b223d16fefb838f7a504c93471dbc28ab7650d29800930aeb8c106a0b0455c804b94f6c2667d
+  metadata.gz: cb5e4891f48db210ddf0a2881fe3cffaabe1850b42eebfb0988f02f1ef49a13f93984ba4f59b7bed1c6a26a740bc08023e173c25dfa3f4f3661aa01514cc50db
+  data.tar.gz: baea5af0aca2aac129786700ea1abf1df7a2d1969821cd54f97185c22d3ad338ead03a75d6d13e57915bc11ab2f2d63a9115949decbce5b57b4d21a3c4364630

data/.gitignore

@@ -3,4 +3,5 @@ spec/dummy/db
 spec/dummy/tmp
 /coverage
 /pkg
-Gemfile.lock
+Gemfile.lock
+**/.DS_STORE

data/Rakefile

@@ -14,4 +14,4 @@ load 'rails/tasks/engine.rake'
 RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
 
-task default: [:spec, :rubocop]
+task default: %i[spec rubocop]

data/app/jobs/maestrano/connector/rails/concerns/synchronization_job.rb

@@ -0,0 +1,153 @@
+module Maestrano::Connector::Rails::Concerns::SynchronizationJob
+  extend ActiveSupport::Concern
+
+  included do
+    queue_as :default
+  end
+
+  module ClassMethods
+    def enqueued?(organization_id)
+      Maestrano::Connector::Rails::SynchronizationJob.find_job(organization_id).present? || Maestrano::Connector::Rails::SynchronizationJob.find_running_job(organization_id).present?
+    end
+
+    def find_job(organization_id)
+      queue = Sidekiq::Queue.new(:default)
+      queue.find do |job|
+        organization_id == job.item['args'][0]['arguments'].first
+      end
+    end
+
+    def find_running_job(organization_id)
+      Sidekiq::Workers.new.find do |_, _, work|
+        work['queue'] == 'default' && work['payload']['args'][0]['arguments'].first == organization_id
+      end
+    rescue
+      nil
+    end
+  end
+
+  # Supported options:
+  #  * :forced => true  synchronization has been triggered manually
+  #  * :only_entities => [person, tasks_list]
+  #  * :full_sync => true  synchronization is performed without date filtering
+  #  * :connec_preemption => true|false : preemption is always|never given to connec in case of conflict (if not set, the most recently updated entity is kept)
+  def perform(organization_id, opts = {})
+    organization = Maestrano::Connector::Rails::Organization.find(organization_id)
+    return unless organization&.sync_enabled
+
+    # Check if previous synchronization is still running
+    if Maestrano::Connector::Rails::Synchronization.where(organization_id: organization.id, status: 'RUNNING').where(created_at: (30.minutes.ago..Time.now.utc)).exists?
+      Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, 'Synchronization skipped: Previous synchronization is still running')
+      return
+    end
+
+    # Check if recovery mode: last 3 synchronizations have failed
+    if !opts[:forced] && organization.last_three_synchronizations_failed? \
+        && organization.synchronizations.order(created_at: :desc).limit(1).first.updated_at > 1.day.ago
+      Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, 'Synchronization skipped: Recovery mode (three previous synchronizations have failed)')
+      return
+    end
+
+    # Trigger synchronization
+    Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Start synchronization, opts=#{opts}")
+    current_synchronization = Maestrano::Connector::Rails::Synchronization.create_running(organization)
+
+    begin
+      last_synchronization = organization.last_successful_synchronization
+      last_synchronization_date = organization.last_synchronization_date
+      connec_client = Maestrano::Connector::Rails::ConnecHelper.get_client(organization)
+      external_client = Maestrano::Connector::Rails::External.get_client(organization)
+
+      # First synchronization should be from external to Connec! only to let the smart merging works
+      # We do a doube sync: only from external, then only from connec!
+      # We also do batched sync as the first one can be quite huge
+      if last_synchronization.nil?
+        Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, 'First synchronization ever. Doing two half syncs to allow smart merging to work its magic.')
+        organization.synchronized_entities.each do |entity, settings|
+          next unless settings[:can_push_to_connec] || settings[:can_push_to_external]
+          Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "First synchronization ever. Doing half sync from external for #{entity}.")
+          first_sync_entity(entity.to_s, organization, connec_client, external_client, last_synchronization_date, opts, true)
+          Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "First synchronization ever. Doing half sync from Connec! for #{entity}.")
+          first_sync_entity(entity.to_s, organization, connec_client, external_client, last_synchronization_date, opts, false)
+        end
+      elsif opts[:only_entities]
+        Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Synchronization is partial and will synchronize only #{opts[:only_entities].join(' ')}")
+        # The synchronization is marked as partial and will not be considered as the last-synchronization for the next sync
+        current_synchronization.mark_as_partial
+        opts[:only_entities].each do |entity|
+          sync_entity(entity, organization, connec_client, external_client, last_synchronization_date, opts)
+        end
+      else
+        organization.synchronized_entities.each do |entity, settings|
+          next unless settings[:can_push_to_connec] || settings[:can_push_to_external]
+          sync_entity(entity.to_s, organization, connec_client, external_client, last_synchronization_date, opts)
+        end
+      end
+
+      Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Finished synchronization, organization=#{organization.uid}, status=success")
+      current_synchronization.mark_as_success
+    rescue => e
+      Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Finished synchronization, organization=#{organization.uid}, status=error, message=#{e.message} backtrace=#{e.backtrace.join("\n\t")}")
+      current_synchronization.mark_as_error(e.message)
+    end
+  end
+
+  def sync_entity(entity_name, organization, connec_client, external_client, last_synchronization_date, opts)
+    entity_instance = instanciate_entity(entity_name, organization, connec_client, external_client, opts)
+
+    perform_sync(entity_instance, last_synchronization_date)
+  end
+
+  # Does a batched sync on either external or connec!
+  def first_sync_entity(entity_name, organization, connec_client, external_client, last_synchronization_date, opts, external = true)
+    limit = Settings.first_sync_batch_size || 50
+    skip = 0
+    entities_count = limit
+    last_first_record = nil
+
+    h = {__limit: limit}
+    external ? h[:__skip_connec] = true : h[:__skip_external] = true
+    entity_instance = instanciate_entity(entity_name, organization, connec_client, external_client, opts.merge(h))
+
+    # IF entities_count > limit
+    # This first sync feature is probably not implemented in the connector
+    # because it fetched more than the expected number of entities
+    # No need to fetch it a second Time
+    # ELSIF entities_count < limit
+    # No more entities to fetch
+    while entities_count == limit
+      entity_instance.opts_merge!(__skip: skip)
+
+      perform_hash = perform_sync(entity_instance, last_synchronization_date, external)
+      entities_count = perform_hash[:count]
+
+      # Safety: if the connector does not implement batched calls but has exactly limit entities
+      # There is a risk of infinite loop
+      # We're comparing the first record to check that it is different
+      first_record = Digest::MD5.hexdigest(perform_hash[:first].to_s)
+      break if last_first_record && first_record == last_first_record
+      last_first_record = first_record
+
+      skip += limit
+    end
+  end
+
+  private
+
+    def instanciate_entity(entity_name, organization, connec_client, external_client, opts)
+      "Entities::#{entity_name.titleize.split.join}".constantize.new(organization, connec_client, external_client, opts.dup)
+    end
+
+    # Perform the sync and return the entities_count for either external or connec
+    def perform_sync(entity_instance, last_synchronization_date, external = true)
+      entity_instance.before_sync(last_synchronization_date)
+      external_entities = entity_instance.get_external_entities_wrapper(last_synchronization_date)
+      connec_entities = entity_instance.get_connec_entities(last_synchronization_date)
+      mapped_entities = entity_instance.consolidate_and_map_data(connec_entities, external_entities)
+      entity_instance.push_entities_to_external(mapped_entities[:connec_entities])
+      entity_instance.push_entities_to_connec(mapped_entities[:external_entities])
+      entity_instance.after_sync(last_synchronization_date)
+
+      entity_instance.class.count_and_first(external ? external_entities : connec_entities)
+    end
+end

data/app/jobs/maestrano/connector/rails/synchronization_job.rb

@@ -1,148 +1,5 @@
 module Maestrano::Connector::Rails
   class SynchronizationJob < ::ActiveJob::Base
-    queue_as :default
-
-    # Supported options:
-    #  * :forced => true  synchronization has been triggered manually
-    #  * :only_entities => [person, tasks_list]
-    #  * :full_sync => true  synchronization is performed without date filtering
-    #  * :connec_preemption => true|false : preemption is always|never given to connec in case of conflict (if not set, the most recently updated entity is kept)
-    def perform(organization_id, opts = {})
-      organization = Maestrano::Connector::Rails::Organization.find(organization_id)
-      return unless organization&.sync_enabled
-      # Check if previous synchronization is still running
-      if Synchronization.where(organization_id: organization.id, status: 'RUNNING').where(created_at: (30.minutes.ago..Time.now)).exists?
-        ConnectorLogger.log('info', organization, 'Synchronization skipped: Previous synchronization is still running')
-        return
-      end
-
-      # Check if recovery mode: last 3 synchronizations have failed
-      if !opts[:forced] && organization.last_three_synchronizations_failed? \
-          && organization.synchronizations.order(created_at: :desc).limit(1).first.updated_at > 1.day.ago
-        ConnectorLogger.log('info', organization, 'Synchronization skipped: Recovery mode (three previous synchronizations have failed)')
-        return
-      end
-
-      # Trigger synchronization
-      ConnectorLogger.log('info', organization, "Start synchronization, opts=#{opts}")
-      current_synchronization = Synchronization.create_running(organization)
-
-      begin
-        last_synchronization = organization.last_successful_synchronization
-        last_synchronization_date = organization.last_synchronization_date
-        connec_client = ConnecHelper.get_client(organization)
-        external_client = External.get_client(organization)
-
-        # First synchronization should be from external to Connec! only to let the smart merging works
-        # We do a doube sync: only from external, then only from connec!
-        # We also do batched sync as the first one can be quite huge
-        if last_synchronization.nil?
-          ConnectorLogger.log('info', organization, 'First synchronization ever. Doing two half syncs to allow smart merging to work its magic.')
-          organization.synchronized_entities.each do |entity, settings|
-            next unless settings[:can_push_to_connec] || settings[:can_push_to_external]
-            ConnectorLogger.log('info', organization, "First synchronization ever. Doing half sync from external for #{entity}.")
-            first_sync_entity(entity.to_s, organization, connec_client, external_client, last_synchronization_date, opts, true)
-            ConnectorLogger.log('info', organization, "First synchronization ever. Doing half sync from Connec! for #{entity}.")
-            first_sync_entity(entity.to_s, organization, connec_client, external_client, last_synchronization_date, opts, false)
-          end
-        elsif opts[:only_entities]
-          ConnectorLogger.log('info', organization, "Synchronization is partial and will synchronize only #{opts[:only_entities].join(' ')}")
-          # The synchronization is marked as partial and will not be considered as the last-synchronization for the next sync
-          current_synchronization.set_partial
-          opts[:only_entities].each do |entity|
-            sync_entity(entity, organization, connec_client, external_client, last_synchronization_date, opts)
-          end
-        else
-          organization.synchronized_entities.each do |entity, settings|
-            next unless settings[:can_push_to_connec] || settings[:can_push_to_external]
-            sync_entity(entity.to_s, organization, connec_client, external_client, last_synchronization_date, opts)
-          end
-        end
-
-        ConnectorLogger.log('info', organization, "Finished synchronization, organization=#{organization.uid}, status=success")
-        current_synchronization.set_success
-      rescue => e
-        ConnectorLogger.log('info', organization, "Finished synchronization, organization=#{organization.uid}, status=error, message=#{e.message} backtrace=#{e.backtrace.join("\n\t")}")
-        current_synchronization.set_error(e.message)
-      end
-    end
-
-    def sync_entity(entity_name, organization, connec_client, external_client, last_synchronization_date, opts)
-      entity_instance = instanciate_entity(entity_name, organization, connec_client, external_client, opts)
-
-      perform_sync(entity_instance, last_synchronization_date)
-    end
-
-    # Does a batched sync on either external or connec!
-    def first_sync_entity(entity_name, organization, connec_client, external_client, last_synchronization_date, opts, external = true)
-      limit = Settings.first_sync_batch_size || 50
-      skip = 0
-      entities_count = limit
-      last_first_record = nil
-
-      h = {__limit: limit}
-      external ? h[:__skip_connec] = true : h[:__skip_external] = true
-      entity_instance = instanciate_entity(entity_name, organization, connec_client, external_client, opts.merge(h))
-
-      # IF entities_count > limit
-      # This first sync feature is probably not implemented in the connector
-      # because it fetched more than the expected number of entities
-      # No need to fetch it a second Time
-      # ELSIF entities_count < limit
-      # No more entities to fetch
-      while entities_count == limit
-        entity_instance.opts_merge!(__skip: skip)
-
-        perform_hash = perform_sync(entity_instance, last_synchronization_date, external)
-        entities_count = perform_hash[:count]
-
-        # Safety: if the connector does not implement batched calls but has exactly limit entities
-        # There is a risk of infinite loop
-        # We're comparing the first record to check that it is different
-        first_record = Digest::MD5.hexdigest(perform_hash[:first].to_s)
-        break if last_first_record && first_record == last_first_record
-        last_first_record = first_record
-
-        skip += limit
-      end
-    end
-
-    def self.enqueued?(organization_id)
-      SynchronizationJob.find_job(organization_id).present? || SynchronizationJob.find_running_job(organization_id).present?
-    end
-
-    def self.find_job(organization_id)
-      queue = Sidekiq::Queue.new(:default)
-      queue.find do |job|
-        organization_id == job.item['args'][0]['arguments'].first
-      end
-    end
-
-    def self.find_running_job(organization_id)
-      Sidekiq::Workers.new.find do |_, _, work|
-        work['queue'] == 'default' && work['payload']['args'][0]['arguments'].first == organization_id
-      end
-    rescue
-      nil
-    end
-
-    private
-
-      def instanciate_entity(entity_name, organization, connec_client, external_client, opts)
-        "Entities::#{entity_name.titleize.split.join}".constantize.new(organization, connec_client, external_client, opts.dup)
-      end
-
-      # Perform the sync and return the entities_count for either external or connec
-      def perform_sync(entity_instance, last_synchronization_date, external = true)
-        entity_instance.before_sync(last_synchronization_date)
-        external_entities = entity_instance.get_external_entities_wrapper(last_synchronization_date)
-        connec_entities = entity_instance.get_connec_entities(last_synchronization_date)
-        mapped_entities = entity_instance.consolidate_and_map_data(connec_entities, external_entities)
-        entity_instance.push_entities_to_external(mapped_entities[:connec_entities])
-        entity_instance.push_entities_to_connec(mapped_entities[:external_entities])
-        entity_instance.after_sync(last_synchronization_date)
-
-        entity_instance.class.count_and_first(external ? external_entities : connec_entities)
-      end
+    include Maestrano::Connector::Rails::Concerns::SynchronizationJob
   end
 end

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

@@ -4,7 +4,7 @@ module Maestrano::Connector::Rails::Concerns::ConnectorLogger
   module ClassMethods
     def log(level, organization, msg, params = {})
       line = "uid=\"#{organization&.uid}\", org_uid=\"#{organization&.org_uid}\", tenant=\"#{organization&.tenant}\""
-      line = "#{line}, #{params.map { |k, v| "#{k}=\"#{v}\"" }.join(', ')}" unless params.blank?
+      line = "#{line}, #{params.map { |k, v| "#{k}=\"#{v}\"" }.join(', ')}" if params.present?
       Rails.logger.method(level).call("#{line}, message=\"#{msg}\"")
     end
   end

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

@@ -263,7 +263,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
 
     # As we're doing only POST, we use the idmaps to filter out updates
     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 }
+      mapped_external_entities_with_idmaps.reject! { |mapped_external_entity_with_idmap| mapped_external_entity_with_idmap[:idmap].connec_id }
     end
 
     if self.class.currency_check_fields
@@ -472,7 +472,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
         Maestrano::Connector::Rails::ConnectorLogger.log('info', @organization, "Sending batch request to Connec! #{log_info} for #{self.class.normalize_connec_entity_name(connec_entity_name)}. Batch_request_size: #{batch_request[:ops].size}. Call_number: #{(start / request_per_call) + 1}")
         response = @connec_client.batch(batch_request)
         Maestrano::Connector::Rails::ConnectorLogger.log('debug', @organization, "Received batch response from Connec! for #{self.class.normalize_connec_entity_name(connec_entity_name)}: #{response}")
-        raise "No data received from Connec! when trying to send batch request #{log_info} for #{self.class.connec_entity_name.pluralize}" unless response && !response.body.blank?
+        raise "No data received from Connec! when trying to send batch request #{log_info} for #{self.class.connec_entity_name.pluralize}" unless response && response.body.present?
         response = JSON.parse(response.body)
 
         # Parse batch response
@@ -497,7 +497,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
       Maestrano::Connector::Rails::ConnectorLogger.log('debug', @organization, "Fetching data from connec entity=#{self.class.connec_entity_name}, url=#{uri}")
       response = @connec_client.get(uri)
 
-      raise "No data received from Connec! when trying to fetch #{self.class.normalized_connec_entity_name}" unless response && !response.body.blank?
+      raise "No data received from Connec! when trying to fetch #{self.class.normalized_connec_entity_name}" unless response && response.body.present?
 
       response_hash = JSON.parse(response.body)
       Maestrano::Connector::Rails::ConnectorLogger.log('debug', @organization, "Received response for entity=#{self.class.connec_entity_name}, response=#{response_hash}")

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

@@ -0,0 +1,8 @@
+module Maestrano::Connector::Rails::Concerns::IdMap
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :organization
+    serialize :metadata, Hash
+  end
+end

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

@@ -0,0 +1,161 @@
+module Maestrano::Connector::Rails::Concerns::Organization
+  extend ActiveSupport::Concern
+
+  included do
+    # Enable Maestrano for this group
+    maestrano_group_via :provider, :uid, :tenant do |group, maestrano|
+      group.name = (maestrano.name.blank? ? 'Default Group name' : maestrano.name)
+      group.tenant = 'default' # To be set from SSO parameter
+      group.org_uid = maestrano.org_uid # Maestrano organization UID
+
+      # group.country_alpha2 = maestrano.country
+      # group.free_trial_end_at = maestrano.free_trial_end_at
+      # group.some_required_field = 'some-appropriate-default-value'
+    end
+
+    # Callbacks
+    before_save :update_metadata
+
+    #===================================
+    # Encryptions
+    #===================================
+    attr_encrypted_options[:mode] = :per_attribute_iv_and_salt
+    attr_encrypted :oauth_token, key: ::Settings.encryption_key1
+    attr_encrypted :refresh_token, key: ::Settings.encryption_key2
+
+    #===================================
+    # Associations
+    #===================================
+    has_many :user_organization_rels
+    has_many :users, through: :user_organization_rels
+    has_many :id_maps, dependent: :destroy
+    has_many :synchronizations, dependent: :destroy
+
+    #===================================
+    # Validation
+    #===================================
+    validates :name, presence: true
+    validates :tenant, presence: true
+    validates :uid, uniqueness: {scope: :tenant}
+    validates :oauth_uid, uniqueness: {allow_blank: true, message: 'This account has already been linked'}
+
+    #===================================
+    # Serialized field
+    #===================================
+    serialize :synchronized_entities
+  end
+
+  module ClassMethods
+  end
+
+  def initialize
+    super
+    self.synchronized_entities = {}
+    Maestrano::Connector::Rails::External.entities_list.each do |entity|
+      synchronized_entities[entity.to_sym] = {can_push_to_connec: !pull_disabled, can_push_to_external: !push_disabled}
+    end
+  end
+
+  def displayable_synchronized_entities
+    result = {}
+    synchronized_entities.each do |entity, hash|
+      begin
+        clazz = "Entities::#{entity.to_s.titleize.split.join}".constantize
+      rescue
+        next
+      end
+      result[entity] = {connec_name: clazz.public_connec_entity_name, external_name: clazz.public_external_entity_name}.merge(hash)
+    end
+    result
+  end
+
+  def add_member(user)
+    user_organization_rels.create(user: user) if tenant == user.tenant && !member?(user)
+  end
+
+  def member?(user)
+    user_organization_rels.where(user_id: user.id).count.positive?
+  end
+
+  def remove_member(user)
+    user_organization_rels.where(user_id: user.id).delete_all
+  end
+
+  def from_omniauth(auth)
+    self.oauth_provider = auth.provider
+    self.oauth_uid = auth.uid
+    self.oauth_token = auth.credentials.token
+    self.refresh_token = auth.credentials.refresh_token
+    self.instance_url = auth.credentials.instance_url
+    save
+  end
+
+  def clear_omniauth
+    self.oauth_uid = nil
+    self.oauth_token = nil
+    self.refresh_token = nil
+    self.sync_enabled = false
+    save
+  end
+
+  # Enable historical data sharing (prior to account linking)
+  def enable_historical_data(enabled)
+    # Historical data sharing cannot be unset
+    return if historical_data
+    if enabled
+      self.date_filtering_limit = nil
+      self.historical_data = true
+    else
+      self.date_filtering_limit ||= Time.now.getlocal
+    end
+  end
+
+  def last_three_synchronizations_failed?
+    arr = synchronizations.last(3).map(&:error?)
+    arr.count == 3 && arr.uniq == [true]
+  end
+
+  def last_successful_synchronization
+    synchronizations.where(status: 'SUCCESS', partial: false).order(updated_at: :desc).first
+  end
+
+  def last_synchronization_date
+    last_successful_synchronization&.updated_at || date_filtering_limit
+  end
+
+  def reset_synchronized_entities(default = false)
+    synchronized_entities.slice!(*Maestrano::Connector::Rails::External.entities_list.map(&:to_sym))
+    Maestrano::Connector::Rails::External.entities_list.each do |entity|
+      if synchronized_entities[entity.to_sym].is_a?(Hash)
+        can_push_to_external = synchronized_entities[entity.to_sym][:can_push_to_external]
+        can_push_to_connec = synchronized_entities[entity.to_sym][:can_push_to_connec]
+      else
+        can_push_to_external = synchronized_entities[entity.to_sym]
+        can_push_to_connec = synchronized_entities[entity.to_sym]
+      end
+      synchronized_entities[entity.to_sym] = {can_push_to_connec: (can_push_to_connec || default) && !pull_disabled, can_push_to_external: (can_push_to_external || default) && !push_disabled}
+    end
+    save
+  end
+
+  def push_to_connec_enabled?(entity)
+    synchronized_entities.dig(Maestrano::Connector::Rails::EntityHelper.snake_name(entity), :can_push_to_connec) && entity&.class&.can_write_connec?
+  end
+
+  def push_to_external_enabled?(entity)
+    synchronized_entities.dig(Maestrano::Connector::Rails::EntityHelper.snake_name(entity), :can_push_to_external) && entity&.class&.can_write_external?
+  end
+
+  def set_instance_metadata
+    auth = {username: Maestrano[tenant].param('api.id'), password: Maestrano[tenant].param('api.key')}
+    res = HTTParty.get("#{Maestrano[tenant].param('api.host')}/api/v1/account/groups/#{uid}", basic_auth: auth)
+    response = JSON.parse(res.body)
+    self.push_disabled = response.dig('data', 'metadata', 'push_disabled')
+    self.pull_disabled = response.dig('data', 'metadata', 'pull_disabled')
+  end
+
+  def update_metadata
+    set_instance_metadata
+    enable_historical_data(true) if push_disabled
+  end
+end

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

@@ -0,0 +1,54 @@
+module Maestrano::Connector::Rails::Concerns::Synchronization
+  extend ActiveSupport::Concern
+
+  included do
+    # Keeping only 100 synchronizations per organization
+    after_create :clean_synchronizations
+
+    RUNNING_STATUS = 'RUNNING'.freeze
+    ERROR_STATUS = 'ERROR'.freeze
+    SUCCESS_STATUS = 'SUCCESS'.freeze
+
+    #===================================
+    # Associations
+    #===================================
+    belongs_to :organization
+
+    validates :status, presence: true
+  end
+
+  module ClassMethods
+    def create_running(organization)
+      Maestrano::Connector::Rails::Synchronization.create(organization_id: organization.id, status: RUNNING_STATUS)
+    end
+  end
+
+  def running?
+    status == RUNNING_STATUS
+  end
+
+  def error?
+    status == ERROR_STATUS
+  end
+
+  def success?
+    status == SUCCESS_STATUS
+  end
+
+  def mark_as_success
+    update_attributes(status: SUCCESS_STATUS)
+  end
+
+  def mark_as_error(msg)
+    update_attributes(status: ERROR_STATUS, message: msg)
+  end
+
+  def mark_as_partial
+    update_attributes(partial: true)
+  end
+
+  def clean_synchronizations
+    count = organization.synchronizations.count
+    organization.synchronizations.order('id ASC').limit(count - 100).destroy_all if count > 100
+  end
+end

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

@@ -0,0 +1,27 @@
+module Maestrano::Connector::Rails::Concerns::User
+  extend ActiveSupport::Concern
+
+  included do
+    # Enable Maestrano for this user
+    maestrano_user_via :provider, :uid, :tenant do |user, maestrano|
+      user.uid = maestrano.uid
+      user.provider = maestrano.provider
+      user.first_name = maestrano.first_name
+      user.last_name = maestrano.last_name
+      user.email = maestrano.email
+      user.tenant = 'default' # To be set from SSO parameter
+    end
+
+    #===================================
+    # Associations
+    #===================================
+    has_many :user_organization_rels, class_name: 'Maestrano::Connector::Rails::UserOrganizationRel'
+    has_many :organizations, through: :user_organization_rels, class_name: 'Maestrano::Connector::Rails::Organization'
+
+    #===================================
+    # Validation
+    #===================================
+    validates :email, presence: true
+    validates :tenant, presence: true
+  end
+end

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

@@ -1,6 +1,5 @@
 module Maestrano::Connector::Rails
   class IdMap < ActiveRecord::Base
-    belongs_to :organization
-    serialize :metadata, Hash
+    include Maestrano::Connector::Rails::Concerns::IdMap
   end
 end

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

@@ -1,158 +1,5 @@
 module Maestrano::Connector::Rails
   class Organization < ActiveRecord::Base
-    # Enable Maestrano for this group
-    maestrano_group_via :provider, :uid, :tenant do |group, maestrano|
-      group.name = (maestrano.name.blank? ? 'Default Group name' : maestrano.name)
-      group.tenant = 'default' # To be set from SSO parameter
-      group.org_uid = maestrano.org_uid # Maestrano organization UID
-
-      # group.country_alpha2 = maestrano.country
-      # group.free_trial_end_at = maestrano.free_trial_end_at
-      # group.some_required_field = 'some-appropriate-default-value'
-    end
-
-    def initialize
-      super
-      self.synchronized_entities = {}
-      External.entities_list.each do |entity|
-        self.synchronized_entities[entity.to_sym] = {can_push_to_connec: !self.pull_disabled, can_push_to_external: !self.push_disabled}
-      end
-    end
-
-    # Callbacks
-    before_save :update_metadata
-
-    #===================================
-    # Encryptions
-    #===================================
-    attr_encrypted_options[:mode] = :per_attribute_iv_and_salt
-    attr_encrypted :oauth_token, key: ::Settings.encryption_key1
-    attr_encrypted :refresh_token, key: ::Settings.encryption_key2
-
-    #===================================
-    # Associations
-    #===================================
-    has_many :user_organization_rels
-    has_many :users, through: :user_organization_rels
-    has_many :id_maps, dependent: :destroy
-    has_many :synchronizations, dependent: :destroy
-
-    #===================================
-    # Validation
-    #===================================
-    validates :name, presence: true
-    validates :tenant, presence: true
-    validates :uid, uniqueness: {scope: :tenant}
-    validates :oauth_uid, uniqueness: {allow_blank: true, message: 'This account has already been linked'}
-
-    #===================================
-    # Serialized field
-    #===================================
-    serialize :synchronized_entities
-
-    def displayable_synchronized_entities
-      result = {}
-      synchronized_entities.each do |entity, hash|
-        begin
-          clazz = "Entities::#{entity.to_s.titleize.split.join}".constantize
-        rescue
-          next
-        end
-        result[entity] = {connec_name: clazz.public_connec_entity_name, external_name: clazz.public_external_entity_name}.merge(hash)
-      end
-      result
-    end
-
-    def add_member(user)
-      user_organization_rels.create(user: user) if tenant == user.tenant && !member?(user)
-    end
-
-    def member?(user)
-      user_organization_rels.where(user_id: user.id).count.positive?
-    end
-
-    def remove_member(user)
-      user_organization_rels.where(user_id: user.id).delete_all
-    end
-
-    def from_omniauth(auth)
-      self.oauth_provider = auth.provider
-      self.oauth_uid = auth.uid
-      self.oauth_token = auth.credentials.token
-      self.refresh_token = auth.credentials.refresh_token
-      self.instance_url = auth.credentials.instance_url
-      self.save
-    end
-
-    def clear_omniauth
-      self.oauth_uid = nil
-      self.oauth_token = nil
-      self.refresh_token = nil
-      self.sync_enabled = false
-      self.save
-    end
-
-    # Enable historical data sharing (prior to account linking)
-    def enable_historical_data(enabled)
-      # Historical data sharing cannot be unset
-      return if self.historical_data
-
-      if enabled
-        self.date_filtering_limit = nil
-        self.historical_data = true
-      else
-        self.date_filtering_limit ||= Time.now.getlocal
-      end
-    end
-
-    def last_three_synchronizations_failed?
-      arr = synchronizations.last(3).map(&:error?)
-      arr.count == 3 && arr.uniq == [true]
-    end
-
-    def last_successful_synchronization
-      synchronizations.where(status: 'SUCCESS', partial: false).order(updated_at: :desc).first
-    end
-
-    def last_synchronization_date
-      last_successful_synchronization&.updated_at || date_filtering_limit
-    end
-
-    def reset_synchronized_entities(default = false)
-      synchronized_entities.slice!(*External.entities_list.map(&:to_sym))
-      External.entities_list.each do |entity|
-        if synchronized_entities[entity.to_sym].is_a?(Hash)
-          can_push_to_external = synchronized_entities[entity.to_sym][:can_push_to_external]
-          can_push_to_connec = synchronized_entities[entity.to_sym][:can_push_to_connec]
-        else
-          can_push_to_external = synchronized_entities[entity.to_sym]
-          can_push_to_connec = synchronized_entities[entity.to_sym]
-        end
-        synchronized_entities[entity.to_sym] = {can_push_to_connec: (can_push_to_connec || default) && !pull_disabled, can_push_to_external: (can_push_to_external || default) && !push_disabled}
-      end
-      save
-    end
-
-    def push_to_connec_enabled?(entity)
-      synchronized_entities.dig(EntityHelper.snake_name(entity), :can_push_to_connec) && entity&.class&.can_write_connec?
-    end
-
-    def push_to_external_enabled?(entity)
-      synchronized_entities.dig(EntityHelper.snake_name(entity), :can_push_to_external) && entity&.class&.can_write_external?
-    end
-
-    def set_instance_metadata
-      auth = {username: Maestrano[tenant].param('api.id'), password: Maestrano[tenant].param('api.key')}
-      res = HTTParty.get("#{Maestrano[tenant].param('api.host')}/api/v1/account/groups/#{uid}", basic_auth: auth)
-      response = JSON.parse(res.body)
-
-      self.push_disabled = response.dig('data', 'metadata', 'push_disabled')
-      self.pull_disabled = response.dig('data', 'metadata', 'pull_disabled')
-    end
-
-    def update_metadata
-      self.set_instance_metadata
-      self.enable_historical_data(true) if self.push_disabled
-    end
+    include Maestrano::Connector::Rails::Concerns::Organization
   end
 end

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

@@ -1,50 +1,5 @@
 module Maestrano::Connector::Rails
   class Synchronization < ActiveRecord::Base
-    # Keeping only 100 synchronizations per organization
-    after_create :clean_synchronizations
-
-    RUNNING_STATUS = 'RUNNING'.freeze
-    ERROR_STATUS = 'ERROR'.freeze
-    SUCCESS_STATUS = 'SUCCESS'.freeze
-
-    #===================================
-    # Associations
-    #===================================
-    belongs_to :organization
-
-    validates :status, presence: true
-
-    def running?
-      status == RUNNING_STATUS
-    end
-
-    def error?
-      status == ERROR_STATUS
-    end
-
-    def success?
-      status == SUCCESS_STATUS
-    end
-
-    def self.create_running(organization)
-      Synchronization.create(organization_id: organization.id, status: RUNNING_STATUS)
-    end
-
-    def set_success
-      update_attributes(status: SUCCESS_STATUS)
-    end
-
-    def set_error(msg)
-      update_attributes(status: ERROR_STATUS, message: msg)
-    end
-
-    def set_partial
-      update_attributes(partial: true)
-    end
-
-    def clean_synchronizations
-      count = organization.synchronizations.count
-      organization.synchronizations.order('id ASC').limit(count - 100).destroy_all if count > 100
-    end
+    include Maestrano::Connector::Rails::Concerns::Synchronization
   end
 end

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

@@ -1,25 +1,5 @@
 module Maestrano::Connector::Rails
   class User < ActiveRecord::Base
-    # Enable Maestrano for this user
-    maestrano_user_via :provider, :uid, :tenant do |user, maestrano|
-      user.uid = maestrano.uid
-      user.provider = maestrano.provider
-      user.first_name = maestrano.first_name
-      user.last_name = maestrano.last_name
-      user.email = maestrano.email
-      user.tenant = 'default' # To be set from SSO parameter
-    end
-
-    #===================================
-    # Associations
-    #===================================
-    has_many :user_organization_rels
-    has_many :organizations, through: :user_organization_rels
-
-    #===================================
-    # Validation
-    #===================================
-    validates :email, presence: true
-    validates :tenant, presence: true
+    include Maestrano::Connector::Rails::Concerns::User
   end
 end

data/config/routes.rb

@@ -4,13 +4,13 @@ Maestrano::Connector::Rails::Engine.routes.draw do
   get 'version', to: 'version#index'
 
   namespace :maestrano do
-    match 'signout', to: 'sessions#destroy', as: 'signout', via: [:get, :post]
+    match 'signout', to: 'sessions#destroy', as: 'signout', via: %i[get post]
     post 'connec/notifications/:tenant' => 'connec#notifications'
 
     resources :dependancies, only: [:index]
 
     scope ':tenant' do
-      resources :synchronizations, only: [:show, :create] do
+      resources :synchronizations, only: %i[show create] do
         collection do
           put :toggle_sync
           put :update_metadata

data/lib/generators/connector/install_generator.rb

@@ -33,6 +33,11 @@ module Connector
       copy_file 'example_entity_spec.rb', 'spec/models/entities/example_entitiy.rb'
     end
 
+    def copy_icons_and_logos
+      copy_file 'logos/to_connec.png', 'app/assets/images/logos/to_connec.png'
+      copy_file 'logos/to_external.png', 'spec/assets/images/logos/to_external.png'
+    end
+
     def copy_controllers_and_views
       copy_file 'home_controller.rb', 'app/controllers/home_controller.rb'
       copy_file 'home_controller_spec.rb', 'spec/controllers/home_controller_spec.rb'

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

@@ -10,7 +10,7 @@ class HomeController < ApplicationController
     end
     full_sync = params['historical-data'].present? && !current_organization.historical_data
     opts = {full_sync: full_sync}
-    current_organization.sync_enabled = current_organization.synchronized_entities.values.any?
+    current_organization.sync_enabled = current_organization.synchronized_entities.values.any? { |settings| settings.values.any? { |v| v } }
     current_organization.enable_historical_data(params['historical-data'].present?)
     trigger_sync = current_organization.sync_enabled
     current_organization.save

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

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe HomeController, type: :controller do
   let(:back_path) { home_index_path }
 
-  before(:each) { request.env['HTTP_REFERER'] = back_path }
+  before(:each) { request.env['HTTP_REFERER'] = back_path}
 
   describe 'index' do
     subject { get :index }
@@ -13,12 +13,14 @@ describe HomeController, type: :controller do
 
   describe 'update' do
     let(:user) { create(:user) }
-    let(:organization) { create(:organization, synchronized_entities: {'people' => false, 'item' => true}) }
+    let(:organization) { create(:organization, synchronized_entities: {'people' => {can_push_to_connec: false, can_push_to_external: false}, 'item' => {can_push_to_connec: true, can_push_to_external: true}}) }
 
-    before { allow_any_instance_of(Maestrano::Connector::Rails::SessionHelper).to receive(:current_user).and_return(user) }
-    before { allow_any_instance_of(Maestrano::Connector::Rails::SessionHelper).to receive(:current_organization).and_return(organization) }
+    before do
+      allow_any_instance_of(Maestrano::Connector::Rails::SessionHelper).to receive(:current_user).and_return(user)
+      allow_any_instance_of(Maestrano::Connector::Rails::SessionHelper).to receive(:current_organization).and_return(organization)
+    end
 
-    subject { put :update, id: organization.id, 'people' => true, 'item' => false, 'lala' => true }
+    subject { put :update, id: organization.id, 'people' => {to_connec: '1', to_external: '1'}, 'item' => {}, 'lala' => {} }
 
     context 'when user is not admin' do
       before { allow_any_instance_of(Maestrano::Connector::Rails::SessionHelper).to receive(:is_admin).and_return(false) }
@@ -34,7 +36,7 @@ describe HomeController, type: :controller do
       it 'updates organization synchronized_entities' do
         subject
         organization.reload
-        expect(organization.synchronized_entities).to eq('people' => true, 'item' => false)
+        expect(organization.synchronized_entities).to eq('people' => {can_push_to_connec: true, can_push_to_external: true}, 'item' => {can_push_to_connec: false, can_push_to_external: false})
       end
 
       it 'updates organization sync_enabled' do
@@ -44,7 +46,7 @@ describe HomeController, type: :controller do
       end
 
       context 'when removing all entities' do
-        subject { put :update, id: organization.id, 'people' => false, 'item' => false }
+        subject { put :update, id: organization.id, 'people' => {}, 'item' => {} }
         before { organization.update(sync_enabled: true) }
 
         it 'set sync_enabled to false' do
@@ -58,10 +60,12 @@ describe HomeController, type: :controller do
 
   describe 'synchronize' do
     let(:user) { create(:user) }
-    let(:organization) { create(:organization, synchronized_entities: {'people' => false, 'item' => true}) }
+    let(:organization) { create(:organization, synchronized_entities: {'people' => {can_push_to_connec: false, can_push_to_external: false}, 'item' => {can_push_to_connec: true, can_push_to_external: true}}) }
 
-    before { allow_any_instance_of(Maestrano::Connector::Rails::SessionHelper).to receive(:current_user).and_return(user) }
-    before { allow_any_instance_of(Maestrano::Connector::Rails::SessionHelper).to receive(:current_organization).and_return(organization) }
+    before do
+      allow_any_instance_of(Maestrano::Connector::Rails::SessionHelper).to receive(:current_user).and_return(user)
+      allow_any_instance_of(Maestrano::Connector::Rails::SessionHelper).to receive(:current_organization).and_return(organization)
+    end
 
     subject { post :synchronize }
 
@@ -102,10 +106,14 @@ describe HomeController, type: :controller do
   end
 
   describe 'redirect_to_external' do
+    let(:user) { create(:user) }
+    let(:organization) { create(:organization) }
     subject { get :redirect_to_external }
 
-    context 'otherwise' do
-      it { expect(subject).to redirect_to('somewhere') }
+    before do
+      allow_any_instance_of(Maestrano::Connector::Rails::SessionHelper).to receive(:current_organization).and_return(organization)
     end
+
+    it {expect(subject).to redirect_to('https://somewhere.com')}
   end
 end

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

@@ -9,7 +9,7 @@
           -if current_organization
             Link your company <strong>#{current_organization.name} (#{current_organization.uid})</strong> to ApplicationName to get your business in synch. Check the status of your connection on this screen.
           -else
-            Link your account to ApplicationName to get your business in synch. Check the status of your connection on this screen.
+            ApplicationName add-on is a microservice providing data synchronization between your platform and ApplicationName
 
   .container
     - if current_user
@@ -127,9 +127,3 @@
         .row
           .col-md-4.col-md-offset-4.text-center
             = link_to 'Go to ApplicationName', home_redirect_to_external_path, class: 'btn btn-lg btn-primary'
-
-    - 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'
-

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

@@ -4,8 +4,8 @@
 %html
   %head
     %title ApplicationName Connector
-    = stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true
-    = javascript_include_tag 'application', 'data-turbolinks-track' => true
+    = stylesheet_link_tag    'application', media: 'all'
+    = javascript_include_tag 'application'
     %script{src: 'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js', integrity: 'sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa', crossorigin: 'anonymous'}
     = csrf_meta_tags
   %body

data/lib/maestrano/connector/rails/version.rb

@@ -1,7 +1,7 @@
 module Maestrano
   module Connector
     module Rails
-      VERSION = '2.0.2.pre.RC9'.freeze
+      VERSION = '2.0.2.pre.RC10'.freeze
     end
   end
 end

data/maestrano-connector-rails.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('bootstrap-sass')
   s.add_runtime_dependency('config')
   s.add_runtime_dependency('figaro')
+  s.add_runtime_dependency('jquery-rails')
   s.add_runtime_dependency('haml-rails')
   s.add_runtime_dependency('hash_mapper', '>= 0.2.2')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maestrano-connector-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.2.pre.RC9
+  version: 2.0.2.pre.RC10
 platform: ruby
 authors:
 - Maestrano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: haml-rails
   requirement: !ruby/object:Gem::Requirement
@@ -393,6 +407,7 @@ files:
 - app/helpers/maestrano/connector/rails/entity_helper.rb
 - app/helpers/maestrano/connector/rails/session_helper.rb
 - app/jobs/maestrano/connector/rails/all_synchronizations_job.rb
+- app/jobs/maestrano/connector/rails/concerns/synchronization_job.rb
 - app/jobs/maestrano/connector/rails/push_to_connec_job.rb
 - app/jobs/maestrano/connector/rails/push_to_connec_worker.rb
 - app/jobs/maestrano/connector/rails/synchronization_job.rb
@@ -403,7 +418,11 @@ files:
 - app/models/maestrano/connector/rails/concerns/entity.rb
 - app/models/maestrano/connector/rails/concerns/entity_base.rb
 - app/models/maestrano/connector/rails/concerns/external.rb
+- app/models/maestrano/connector/rails/concerns/id_map.rb
+- app/models/maestrano/connector/rails/concerns/organization.rb
 - app/models/maestrano/connector/rails/concerns/sub_entity_base.rb
+- app/models/maestrano/connector/rails/concerns/synchronization.rb
+- app/models/maestrano/connector/rails/concerns/user.rb
 - app/models/maestrano/connector/rails/connec_helper.rb
 - app/models/maestrano/connector/rails/connector_logger.rb
 - app/models/maestrano/connector/rails/entity.rb
@@ -451,6 +470,8 @@ files:
 - lib/generators/connector/templates/home_controller_spec.rb
 - lib/generators/connector/templates/home_index.haml
 - lib/generators/connector/templates/layouts.haml
+- lib/generators/connector/templates/logos/to_connec.png
+- lib/generators/connector/templates/logos/to_external.png
 - lib/generators/connector/templates/oauth_controller.rb
 - lib/generators/connector/templates/shared_entities_controller.rb
 - lib/generators/connector/templates/shared_entities_controller_spec.rb
@@ -490,7 +511,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rails framework to build connector with Maestrano