maestrano-connector-rails 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a82734a77d8a8231e8a01d8c9c9e0f62e684cad
-  data.tar.gz: 73ce17a1cacbd9f5c0c988e4c132b1f7c8769b63
+  metadata.gz: c4122749ba27964c095c26a00e030bdbd3b2d7fa
+  data.tar.gz: a48edb359406db70378f8f361ae1285ec9f51cc7
 SHA512:
-  metadata.gz: a092e0cfcecc3f1f6745ad6ad49970a8cfdd5e0e1887f5a29f2e79fa5e23502b893e15d81e57f3d0d89e15b6392b9a5b9dee0d044177334c304913b69db4b023
-  data.tar.gz: 9b9232cd104ec556d91ddcda3af1eeb12e3db8be65371ccc98a81b6d67b38dd5f48fb52974999eb854562416a601293b3bd3e65f3f511509288f83295076ccd7
+  metadata.gz: 693be8a01d2ebe2eb99679cee99352398bad9b4a0a567a78d6dbade564d37d05702137397e5ac5871f8c3095fb14e062930c34b95bf33ed83707cfbd1d626c6a
+  data.tar.gz: 34cadd784f2410b2dfbb44e6a05e39ed17fb097729da1d04d4f5870494dd9dd372968ea882b6c1606a1a13ce61c0482653ccea01592c3dbee0c83bb2b87b1eda

data/.rubocop.yml

@@ -12,8 +12,6 @@ AllCops:
     - 'db/migrate/*'
     - 'bin/*'
     - 'spec/**/*'
-    - 'template/**/*'
-    - 'lib/generators/connector/**/*'
 
 # Enabled disabled Cops
 Style/CollectionMethods:
@@ -36,6 +34,14 @@ Style/ClassAndModuleChildren:
 Style/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
+# Checks for unused block arguments
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# Checks for unused method arguments.
+Lint/UnusedMethodArgument:
+  Enabled: false
+
 # RSpec/FilePath:
 #   Exclude:
-    # - 'spec/routing/**/*_routing_spec.rb'
+    # - 'spec/routing/**/*_routing_spec.rb'

data/.rubocop_todo.yml

@@ -12,23 +12,6 @@ Lint/AssignmentInCondition:
   Exclude:
     - 'app/jobs/maestrano/connector/rails/push_to_connec_job.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
-Lint/UnusedBlockArgument:
-  Exclude:
-    - 'app/jobs/maestrano/connector/rails/synchronization_job.rb'
-
-# Offense count: 17
-# Cop supports --auto-correct.
-# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
-Lint/UnusedMethodArgument:
-  Exclude:
-    - 'app/jobs/maestrano/connector/rails/all_synchronizations_job.rb'
-    - 'app/models/maestrano/connector/rails/concerns/complex_entity.rb'
-    - 'app/models/maestrano/connector/rails/concerns/entity.rb'
-    - 'app/models/maestrano/connector/rails/concerns/external.rb'
-
 # Offense count: 23
 Metrics/AbcSize:
   Max: 70
@@ -45,7 +28,7 @@ Metrics/MethodLength:
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 264
+  Max: 278
 
 # Offense count: 2
 # Configuration parameters: CountKeywordArgs.

data/VERSION

@@ -1 +1 @@
-1.3.4
+1.3.5

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

@@ -76,6 +76,7 @@ module Maestrano::Connector::Rails
       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
@@ -89,7 +90,17 @@ module Maestrano::Connector::Rails
       # No more entities to fetch
       while entities_count == limit
         entity_instance.opts_merge!(__skip: skip)
-        entities_count = perform_sync(entity_instance, last_synchronization_date, external)
+
+        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
@@ -110,7 +121,7 @@ module Maestrano::Connector::Rails
         entity_instance.push_entities_to_connec(mapped_entities[:external_entities])
         entity_instance.after_sync(last_synchronization_date)
         
-        external ? entity_instance.class.count_entities(external_entities) : entity_instance.class.count_entities(connec_entities)
+        entity_instance.class.count_and_first(external ? external_entities : connec_entities)
       end
   end
 end

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

@@ -27,8 +27,10 @@ module Maestrano::Connector::Rails::Concerns::ComplexEntity
       names.index_by { |name| name }.with_indifferent_access
     end
 
-    def count_entities(entities)
-      entities.values.map(&:size).max
+    # For complex entities, we take the size of the biggest array
+    # And the first record we can find (even if it's not in the first array)
+    def count_and_first(entities)
+      {count: entities.values.map(&:size).max, first: entities.values.flatten.first}
     end
 
     def public_connec_entity_name

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

@@ -131,8 +131,8 @@ module Maestrano::Connector::Rails::Concerns::Entity
     # ----------------------------------------------
     #                 Helper methods
     # ----------------------------------------------
-    def count_entities(entities)
-      entities.size
+    def count_and_first(entities)
+      {count: entities.size, first: entities.first}
     end
 
     def public_connec_entity_name
@@ -313,10 +313,16 @@ module Maestrano::Connector::Rails::Concerns::Entity
         idmap.update(last_push_to_external: Time.now, message: nil)
       end
     rescue => e
-      # Store External error
-      Maestrano::Connector::Rails::ConnectorLogger.log('error', @organization, "Error while pushing to #{Maestrano::Connector::Rails::External.external_name}: #{e}")
-      Maestrano::Connector::Rails::ConnectorLogger.log('debug', @organization, "Error while pushing backtrace: #{e.backtrace.join("\n\t")}")
-      idmap.update(message: e.message.truncate(255))
+      # TODO: improve the flexibility by adding the option for the developer to pass a custom/gem-dependent error
+      if e.class == Maestrano::Connector::Rails::Exceptions::EntityNotFoundError
+        idmap.update!(message: "The #{external_entity_name} record has been deleted in #{Maestrano::Connector::Rails::External.external_name}. Last attempt to sync on #{Time.now}", external_inactive: true)
+        Rails.logger.info "The #{idmap.external_entity} - #{idmap.external_id} record has been deleted. It is now set to inactive."
+      else
+        # Store External error
+        Maestrano::Connector::Rails::ConnectorLogger.log('error', @organization, "Error while pushing to #{Maestrano::Connector::Rails::External.external_name}: #{e}")
+        Maestrano::Connector::Rails::ConnectorLogger.log('debug', @organization, "Error while pushing backtrace: #{e.backtrace.join("\n\t")}")
+        idmap.update(message: e.message.truncate(255))
+      end
     end
     nil
   end
@@ -359,7 +365,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
   end
 
   def consolidate_and_map_connec_entities(connec_entities, external_entities, references, external_entity_name)
-    connec_entities.map{|entity|
+    connec_entities.map { |entity|
       # Entity has been created before date filtering limit
       next nil if before_date_filtering_limit?(entity, false) && !@opts[:full_sync]
 

data/app/models/maestrano/connector/rails/exceptions/entity_not_found_error.rb

@@ -0,0 +1,3 @@
+module Maestrano::Connector::Rails::Exceptions
+  class EntityNotFoundError < StandardError; end
+end

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

@@ -78,6 +78,26 @@ module Maestrano::Connector::Rails
       save!
     end
 
+    def clear_omniauth
+      self.oauth_uid = nil
+      self.oauth_token = nil
+      self.refresh_token = nil
+      self.sync_enabled = false
+      self.save
+    end
+
+    def check_historical_data(checkbox_ticked)
+      return if self.historical_data
+      # checkbox_ticked is a boolean
+      if checkbox_ticked
+        self.date_filtering_limit = nil
+        self.historical_data = true
+      else
+        self.date_filtering_limit ||= Time.now.getlocal
+      end
+      self.save
+    end
+
     def last_three_synchronizations_failed?
       arr = synchronizations.last(3).map(&:error?)
       arr.count == 3 && arr.uniq == [true]

data/lib/generators/connector/complex_entity_generator.rb

@@ -1,7 +1,7 @@
 module Connector
   module Generators
     class ComplexEntityGenerator < ::Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('../templates', __FILE__)
 
       def copy_example_files
         copy_file 'complex_entity_example/contact_and_lead.rb', 'app/models/entities/example_contact_and_lead.rb'
@@ -16,4 +16,4 @@ module Connector
       end
     end
   end
-end
+end

data/lib/generators/connector/install_generator.rb

@@ -1,7 +1,7 @@
 module Connector
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('../templates', __FILE__)
 
       def maestrano_generator
         generate 'maestrano:initializer'
@@ -10,7 +10,7 @@ module Connector
       def include_helpers
         sentinel = 'class ApplicationController < ActionController::Base'
         code_lines = [
-          "include Maestrano::Connector::Rails::SessionHelper"
+          'include Maestrano::Connector::Rails::SessionHelper'
         ]
 
         in_root do
@@ -63,4 +63,4 @@ module Connector
       end
     end
   end
-end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # TODO
 # This file is provided as an example and should be removed
 # See doc for explanation
@@ -24,4 +25,4 @@
 #   def self.object_name_from_external_entity_hash(entity)
 #     "#{entity['FirstName']} #{entity['LastName']}"
 #   end
-# end
+# end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # TODO
 # This file is provided as an example and should be removed
 # See documentation (https://maestrano.atlassian.net/wiki/display/DEV/Mapping+and+synchronization) for explanation
@@ -53,4 +54,4 @@
 #   def external_model_to_connec_model(external_hash_of_entities)
 #     return {'lead' => {'person' => external_hash_of_entities['lead']}, 'contact' => {'person' => external_hash_of_entities['contact']}}
 #   end
-# end
+# end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # TODO
 # This file is provided as an example and should be removed
 # See README for explanation
@@ -14,4 +15,4 @@
 #   map from('address_work/billing/region'), to('MailingState')
 #   map from('address_work/billing/postal_code'), to('MailingPostalCode')
 #   map from('address_work/billing/country'), to('MailingCountry')
-# end
+# end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # TODO
 # This file is provided as an example and should be removed
 # See README for explanation
@@ -24,4 +25,4 @@
 #   def self.object_name_from_external_entity_hash(entity)
 #     "#{entity['FirstName']} #{entity['LastName']}"
 #   end
-# end
+# end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # TODO
 # This file is provided as an example and should be removed
 # See README for explanation
@@ -17,4 +18,4 @@
 #   map from('lead_source'), to('LeadSource')
 #   map from('lead_status'), to('Status')
 #   map from('lead_conversion_date'), to('ConvertedDate')
-# end
+# end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # TODO
 # This file is provided as an example and should be removed
 # See README for explanation
@@ -24,4 +25,4 @@
 #   def self.object_name_from_external_entity_hash(entity)
 #     "#{entity['FirstName']} #{entity['LastName']}"
 #   end
-# end
+# end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Maestrano::Connector::Rails::Entity < Maestrano::Connector::Rails::EntityBase
   include Maestrano::Connector::Rails::Concerns::Entity
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # TODO
 # This file is provided as an example and should be removed
 # One such file needs to be created for each synchronizable entity,
@@ -32,4 +33,4 @@
 #   map from('title'), to('Salutation')
 #   map from('first_name'), to('FirstName')
 #   map from('address_work/billing2/city'), to('City')
-# end
+# end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # TODO
 # This file is provided as an example and should be removed
 # require 'spec_helper'

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Maestrano::Connector::Rails::External
   include Maestrano::Connector::Rails::Concerns::External
 
@@ -33,4 +34,4 @@ class Maestrano::Connector::Rails::External
     #  will synchronized Entities::Person and Entities::TasksList
     []
   end
-end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class HomeController < ApplicationController
   def index
     @organization = current_organization
@@ -7,41 +8,23 @@ class HomeController < ApplicationController
   def update
     organization = Maestrano::Connector::Rails::Organization.find_by_id(params[:id])
 
-    if organization && is_admin?(current_user, organization)
-      old_sync_state = organization.sync_enabled
-
-      organization.synchronized_entities.keys.each do |entity|
-        organization.synchronized_entities[entity] = !!params["#{entity}"]
-      end
-      organization.sync_enabled = organization.synchronized_entities.values.any?
-
-      unless organization.historical_data
-        historical_data = !!params['historical-data']
-        if historical_data
-          organization.date_filtering_limit = nil
-          organization.historical_data = true
-        else
-          organization.date_filtering_limit ||= Time.now
-        end
-      end
-      
-      organization.save
-
-      if !old_sync_state && organization.sync_enabled
-        Maestrano::Connector::Rails::SynchronizationJob.perform_later(organization, {})
-        flash[:info] = 'Congrats, you\'re all set up! Your data are now being synced'
-      end
+    return redirect_to(:back) unless organization && is_admin?(current_user, organization)
+    old_sync_state = organization.sync_enabled
+    organization.synchronized_entities.keys.each do |entity|
+      organization.synchronized_entities[entity] = params[entity.to_s].present?
     end
+    organization.sync_enabled = organization.synchronized_entities.values.any?
+    organization.check_historical_data(params['historical-data'].present?)
+
+    start_synchronization(old_sync_state, organization) unless !old_sync_state && organization.sync_enabled
 
     redirect_to(:back)
   end
 
   def synchronize
-    if is_admin
-      Maestrano::Connector::Rails::SynchronizationJob.perform_later(current_organization, (params['opts'] || {}).merge(forced: true))
-      flash[:info] = 'Synchronization requested'
-    end
-
+    return redirect_to(:back) unless is_admin
+    Maestrano::Connector::Rails::SynchronizationJob.perform_later(current_organization, (params['opts'] || {}).merge(forced: true))
+    flash[:info] = 'Synchronization requested'
     redirect_to(:back)
   end
 
@@ -49,4 +32,10 @@ class HomeController < ApplicationController
     redirect_to 'https://path/to/external/app'
   end
 
-end
+  private
+
+    def start_synchronization(old_sync_state, organization)
+      Maestrano::Connector::Rails::SynchronizationJob.perform_later(organization, {})
+      flash[:info] = 'Congrats, you\'re all set up! Your data are now being synced'
+    end
+end

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

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe HomeController, :type => :controller do
+describe HomeController, type: :controller do
   let(:back_path) { home_index_path }
   before(:each) do
-    request.env["HTTP_REFERER"] = back_path
+    request.env['HTTP_REFERER'] = back_path
   end
 
   describe 'index' do
@@ -16,26 +16,25 @@ describe HomeController, :type => :controller do
     let(:organization) { create(:organization, synchronized_entities: {'people' => false, 'item' => true}) }
     subject { put :update, id: organization.id, 'people' => true, 'item' => false, 'lala' => true }
 
-
     context 'when user is not admin' do
-      before {
+      before do
         allow_any_instance_of(Maestrano::Connector::Rails::SessionHelper).to receive(:is_admin?).and_return(false)
-      }
+      end
 
       it { expect(subject).to redirect_to back_path }
     end
 
     context 'when user is admin' do
-      before {
+      before do
         allow_any_instance_of(Maestrano::Connector::Rails::SessionHelper).to receive(:is_admin?).and_return(true)
-      }
+      end
 
       it { expect(subject).to redirect_to back_path }
 
       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' => true, 'item' => false)
       end
 
       it 'updates organization sync_enabled' do
@@ -60,14 +59,14 @@ describe HomeController, :type => :controller do
   describe 'synchronize' do
     subject { post :synchronize }
     let(:organization) { create(:organization) }
-    before {
+    before do
       allow_any_instance_of(Maestrano::Connector::Rails::SessionHelper).to receive(:current_organization).and_return(organization)
-    }
+    end
 
     context 'when user is not admin' do
-      before {
+      before do
         allow_any_instance_of(Maestrano::Connector::Rails::SessionHelper).to receive(:is_admin).and_return(false)
-      }
+      end
 
       it { expect(subject).to redirect_to back_path }
 
@@ -78,9 +77,9 @@ describe HomeController, :type => :controller do
     end
 
     context 'when user is admin' do
-      before {
+      before do
         allow_any_instance_of(Maestrano::Connector::Rails::SessionHelper).to receive(:is_admin).and_return(true)
-      }
+      end
 
       it { expect(subject).to redirect_to back_path }
 
@@ -88,16 +87,16 @@ describe HomeController, :type => :controller do
         subject { post :synchronize, opts: {'opts' => 'some_opts'} }
 
         it 'calls perform_later with opts' do
-          expect(Maestrano::Connector::Rails::SynchronizationJob).to receive(:perform_later).with(organization, {'opts' => 'some_opts', forced: true})
+          expect(Maestrano::Connector::Rails::SynchronizationJob).to receive(:perform_later).with(organization, 'opts' => 'some_opts', forced: true)
           subject
         end
       end
 
       context 'without opts' do
-        subject { post :synchronize}
+        subject { post :synchronize }
 
         it 'calls perform_later with empty opts hash' do
-          expect(Maestrano::Connector::Rails::SynchronizationJob).to receive(:perform_later).with(organization, {forced: true})
+          expect(Maestrano::Connector::Rails::SynchronizationJob).to receive(:perform_later).with(organization, forced: true)
           subject
         end
       end
@@ -108,7 +107,7 @@ describe HomeController, :type => :controller do
     subject { get :redirect_to_external }
 
     context 'otherwise' do
-      it {expect(subject).to redirect_to('somewhere')}
+      it { expect(subject).to redirect_to('somewhere') }
     end
   end
-end
+end