maestrano-connector-rails 2.3.2 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: fe03ff785065c1f8cadca66eb2e2b82ed5fc84f5323c4869b48336d12972c85b
-  data.tar.gz: b498996b210d55d76a64ddee0e3172b98ec59a2414865c6cc78b29cecd926057
+SHA1:
+  metadata.gz: d68e736e0130292d4985536e944a42f6b373dad1
+  data.tar.gz: 47dc6757656ad1363103a289191ab8c3bb52e48a
 SHA512:
-  metadata.gz: e4bcd12d815b164b47bcea4882499ddecfacb4ed5eb86aa140ef89aa086f98df44dd250b5cc9f32f87ac05974038c026aef2917c1294178ff75141ede6c76d1b
-  data.tar.gz: 7118fddc3d02a5681232eeec359c16f2c500aac7456a621577d8443420d1785cd19a87c954bff5d011aa3a78ea864cd66af2b55d50a6851f830192ddf4c51ea7
+  metadata.gz: c267435b208139421e3022f830805875fa57bdd4017e836d5dde57c58c90d4813e34948d3382e3eb06d7d831359ab7e52b2e42223aabc4a5c882a330f2c7e38b
+  data.tar.gz: 24d85d8957e387213429130c571ee0f60d7697be355d6cbfba573ab9f449862ffa7ed88a57229f34b2b83368ee169729dbc3c180dded7056731fc6911b2e365c

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 2.3.3
+
+* [MARLIN-244] Decorate SynchronizationController [\#176](https://github.com/maestrano/maestrano-connector-rails/pull/176)
+* Rubofix [\#177](https://github.com/maestrano/maestrano-connector-rails/pull/177)
+* [MNO-816] Fix regex pattern [\#175](https://github.com/maestrano/maestrano-connector-rails/pull/175)
+* Spread out sync jobs [\#173](https://github.com/maestrano/maestrano-connector-rails/pull/173)
+
+## 2.3.2
+
+* Update framework generators and template [\#171](https://github.com/maestrano/maestrano-connector-rails/pull/171)
+
+## 2.3.1
+
+* Do not skip Connec! webhook on push_disabled (transac! compatibility) [\#170](https://github.com/maestrano/maestrano-connector-rails/pull/170)
+
 ## 2.3.0
 
 * Send data to Connec! even if the push/pull parameters are disabled (Transac! integration)

data/Gemfile

@@ -1,4 +1,6 @@
-source 'http://rubygems.org'
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 gemspec
 

data/app/controllers/maestrano/concerns/synchronizations_controller.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Maestrano
+  module Concerns
+    module SynchronizationsController
+      extend ActiveSupport::Concern
+
+      #==================================================================
+      # Included methods
+      #==================================================================
+      # 'included do' causes the included code to be evaluated in the
+      # context where it is included rather than being executed in the
+      # module's context
+      included do
+      end
+
+      #==================================================================
+      # Class methods
+      #==================================================================
+      module ClassMethods
+      end
+
+      #==================================================================
+      # Instance methods
+      #==================================================================
+      def show
+        tenant = params[:tenant]
+        uid = params[:id]
+        organization = Maestrano::Connector::Rails::Organization.find_by(uid: uid, tenant: tenant)
+        return render json: {errors: [{message: 'Organization not found', code: 404}]}, status: :not_found unless organization
+
+        status = organization_status organization
+
+        render_organization_sync(organization, status, 200)
+      end
+
+      def create
+        tenant = params[:tenant]
+        uid = params[:group_id]
+        opts = params[:opts] || {}
+        organization = Maestrano::Connector::Rails::Organization.find_by(uid: uid, tenant: tenant)
+        return render json: {errors: [{message: 'Organization not found', code: 404}]}, status: :not_found unless organization
+
+        organization.sync_enabled = organization.synchronized_entities.values.any? { |settings| settings.values.any? { |v| v } }
+        organization.save if organization.sync_enabled_changed?
+
+        status = organization_status(organization)
+
+        unless %w[RUNNING ENQUEUED].include?(status)
+          Maestrano::Connector::Rails::SynchronizationJob.perform_later(organization.id, opts.with_indifferent_access)
+          status = 'ENQUEUED'
+        end
+
+        render_organization_sync(organization, status, 201)
+      end
+
+      def update_metadata
+        tenant = params[:tenant]
+        uid = params[:group_id]
+        organization = Maestrano::Connector::Rails::Organization.find_by(uid: uid, tenant: tenant)
+        return render json: {errors: [{message: 'Organization not found', code: 404}]}, status: :not_found unless organization
+
+        organization.set_instance_metadata
+        organization.reset_synchronized_entities
+        render_organization_sync(organization, status, 200)
+      end
+
+      def toggle_sync
+        tenant = params[:tenant]
+        uid = params[:group_id]
+        organization = Maestrano::Connector::Rails::Organization.find_by(uid: uid, tenant: tenant)
+        return render json: {errors: [{message: 'Organization not found', code: 404}]}, status: :not_found unless organization
+
+        organization.toggle(:sync_enabled)
+        organization.save
+        status = organization_status organization
+        render_organization_sync(organization, status, 200)
+      end
+
+      private
+
+        def render_organization_sync(organization, status, code)
+          h = {
+            group_id: organization.uid,
+            sync_enabled: organization.sync_enabled,
+            status: status
+          }
+          last_sync = organization.synchronizations.last
+          if last_sync
+            h[:message] = last_sync.message
+            h[:updated_at] = last_sync.updated_at
+          end
+
+          render json: h, status: code
+        end
+
+        def organization_status(organization)
+          if Maestrano::Connector::Rails::SynchronizationJob.find_running_job(organization.id)
+            'RUNNING'
+          elsif Maestrano::Connector::Rails::SynchronizationJob.find_job(organization.id)
+            'ENQUEUED'
+          else
+            organization.synchronizations.last&.status || 'DISABLED'
+          end
+        end
+    end
+  end
+end

data/app/controllers/maestrano/connec_controller.rb

@@ -9,6 +9,7 @@ class Maestrano::ConnecController < Maestrano::Rails::WebHookController
           begin
             organization = find_valid_organization(entity[:group_id], params[:tenant], entity_class_hash)
             next if organization.blank?
+
             Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Processing entity from Connec! webhook, entity_name=\"#{entity_name}\", data=\"#{entity}\"")
 
             connec_client = Maestrano::Connector::Rails::ConnecHelper.get_client(organization)

data/app/controllers/maestrano/synchronizations_controller.rb

@@ -1,82 +1,7 @@
-class Maestrano::SynchronizationsController < Maestrano::Rails::WebHookController
-  def show
-    tenant = params[:tenant]
-    uid = params[:id]
-    organization = Maestrano::Connector::Rails::Organization.find_by(uid: uid, tenant: tenant)
-    return render json: {errors: [{message: 'Organization not found', code: 404}]}, status: :not_found unless organization
+# frozen_string_literal: true
 
-    status = organization_status organization
-
-    render_organization_sync(organization, status, 200)
+module Maestrano
+  class SynchronizationsController < Maestrano::Rails::WebHookController
+    include Maestrano::Concerns::SynchronizationsController
   end
-
-  def create
-    tenant = params[:tenant]
-    uid = params[:group_id]
-    opts = params[:opts] || {}
-    organization = Maestrano::Connector::Rails::Organization.find_by(uid: uid, tenant: tenant)
-    return render json: {errors: [{message: 'Organization not found', code: 404}]}, status: :not_found unless organization
-
-    organization.sync_enabled = organization.synchronized_entities.values.any? { |settings| settings.values.any? { |v| v } }
-    organization.save if organization.sync_enabled_changed?
-
-    status = organization_status(organization)
-
-    unless %w[RUNNING ENQUEUED].include?(status)
-      Maestrano::Connector::Rails::SynchronizationJob.perform_later(organization.id, opts.with_indifferent_access)
-      status = 'ENQUEUED'
-    end
-
-    render_organization_sync(organization, status, 201)
-  end
-
-  def update_metadata
-    tenant = params[:tenant]
-    uid = params[:group_id]
-    organization = Maestrano::Connector::Rails::Organization.find_by(uid: uid, tenant: tenant)
-    return render json: {errors: [{message: 'Organization not found', code: 404}]}, status: :not_found unless organization
-
-    organization.set_instance_metadata
-    organization.reset_synchronized_entities
-    render_organization_sync(organization, status, 200)
-  end
-
-  def toggle_sync
-    tenant = params[:tenant]
-    uid = params[:group_id]
-    organization = Maestrano::Connector::Rails::Organization.find_by(uid: uid, tenant: tenant)
-    return render json: {errors: [{message: 'Organization not found', code: 404}]}, status: :not_found unless organization
-
-    organization.toggle(:sync_enabled)
-    organization.save
-    status = organization_status organization
-    render_organization_sync(organization, status, 200)
-  end
-
-  private
-
-    def render_organization_sync(organization, status, code)
-      h = {
-        group_id: organization.uid,
-        sync_enabled: organization.sync_enabled,
-        status: status
-      }
-      last_sync = organization.synchronizations.last
-      if last_sync
-        h[:message] = last_sync.message
-        h[:updated_at] = last_sync.updated_at
-      end
-
-      render json: h, status: code
-    end
-
-    def organization_status(organization)
-      if Maestrano::Connector::Rails::SynchronizationJob.find_running_job(organization.id)
-        'RUNNING'
-      elsif Maestrano::Connector::Rails::SynchronizationJob.find_job(organization.id)
-        'ENQUEUED'
-      else
-        organization.synchronizations.last&.status || 'DISABLED'
-      end
-    end
 end

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

@@ -4,9 +4,15 @@ module Maestrano::Connector::Rails
 
     # Trigger synchronization of all active organizations
     def perform(name = nil, count = nil)
-      Maestrano::Connector::Rails::Organization.where.not(oauth_provider: nil, encrypted_oauth_token: nil).each do |o|
-        next unless [true, 1].include?(o.sync_enabled)
-        Maestrano::Connector::Rails::SynchronizationJob.perform_later(o.id, {})
+      active_organizations = Maestrano::Connector::Rails::Organization
+                             .where.not(oauth_provider: nil, encrypted_oauth_token: nil)
+                             .select { |o| [true, 1].include?(o.sync_enabled) }
+
+      return true if active_organizations.count.zero?
+
+      time_span_seconds = (3600 / active_organizations.count).to_i
+      active_organizations.each_with_index do |organization, i|
+        Maestrano::Connector::Rails::SynchronizationJob.set(wait: time_span_seconds * i).perform_later(organization.id, {})
       end
     end
   end

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

@@ -14,10 +14,10 @@ module Maestrano::Connector::Rails::Concerns::SynchronizationJob
       queue = Sidekiq::Queue.new(:default)
       queue.find do |job|
         job_organization_id = begin
-          job.item['args'][0]['arguments'].first
-        rescue
-          false
-        end
+                                job.item['args'][0]['arguments'].first
+                              rescue
+                                false
+                              end
         organization_id == job_organization_id
       end
     end
@@ -25,10 +25,10 @@ module Maestrano::Connector::Rails::Concerns::SynchronizationJob
     def find_running_job(organization_id)
       Sidekiq::Workers.new.find do |_, _, work|
         job_organization_id = begin
-          work['payload']['args'][0]['arguments'].first
-        rescue
-          false
-        end
+                                work['payload']['args'][0]['arguments'].first
+                              rescue
+                                false
+                              end
         work['queue'] == 'default' && organization_id == job_organization_id
       end
     rescue
@@ -75,6 +75,7 @@ module Maestrano::Connector::Rails::Concerns::SynchronizationJob
         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}.")
@@ -90,6 +91,7 @@ module Maestrano::Connector::Rails::Concerns::SynchronizationJob
       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
@@ -136,6 +138,7 @@ module Maestrano::Connector::Rails::Concerns::SynchronizationJob
       # 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

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

@@ -8,6 +8,7 @@ module Maestrano::Connector::Rails::Concerns::UpdateConfigurationJob
 
   def perform
     return if ENV['SKIP_CONFIGURATION']
+
     Maestrano.reset!
     Maestrano.auto_configure
   rescue StandardError => e

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

@@ -24,6 +24,7 @@ module Maestrano::Connector::Rails::Concerns::ComplexEntity
 
     def formatted_entities_names(names)
       return names.with_indifferent_access if names.is_a?(Hash)
+
       names.index_by { |name| name }.with_indifferent_access
     end
 
@@ -44,6 +45,7 @@ module Maestrano::Connector::Rails::Concerns::ComplexEntity
     def public_name(formatted_names)
       names = formatted_names.keys.map(&:pluralize)
       return names.first.humanize if names.size == 1
+
       (names[0..-2].join(', ') + " and #{names.last}").humanize
     end
   end

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

@@ -119,6 +119,7 @@ module Maestrano::Connector::Rails::Concerns::ConnecHelper
       # Unfold the id
       if array_of_refs.empty? && field
         return entity.delete(ref) if field.is_a?(String) # ~retro-compatibility to ease transition aroud Connec! idmaps rework. Should be removed eventually.
+
         id_hash = field.find { |id| id[:provider] == organization.oauth_provider && id[:realm] == organization.oauth_uid }
         if id_hash
           entity[ref] = id_hash['id']
@@ -134,6 +135,7 @@ module Maestrano::Connector::Rails::Concerns::ConnecHelper
       # Follow embedment path
       else
         return true if field.blank?
+
         case field
         when Array
           bool = true
@@ -151,6 +153,7 @@ module Maestrano::Connector::Rails::Concerns::ConnecHelper
     # References can either be an array (only record references), or a hash
     def format_references(references)
       return {record_references: references, id_references: []} if references.is_a?(Array)
+
       references[:record_references] ||= []
       references[:id_references] ||= []
       references
@@ -173,6 +176,7 @@ module Maestrano::Connector::Rails::Concerns::ConnecHelper
     # Recursive method for filtering connec entities
     def filter_connec_entity_for_id_refs_helper(entity_hash, tree)
       return if tree.empty?
+
       entity_hash.slice!(*tree.keys)
 
       tree.each do |key, children|

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

@@ -234,7 +234,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
       # Fetch subsequent pages
       while response_hash['pagination'] && response_hash['pagination']['next']
         # ugly way to convert https://api-connec/api/v2/group_id/organizations?next_page_params to /organizations?next_page_params
-        next_page = response_hash['pagination']['next'].gsub(/^(.*)\/#{self.class.normalized_connec_entity_name}/, self.class.normalized_connec_entity_name)
+        next_page = response_hash['pagination']['next'].gsub(/\A(.*)\/#{self.class.normalized_connec_entity_name}/, self.class.normalized_connec_entity_name)
 
         response_hash = fetch_connec(next_page)
         entities.concat response_hash[self.class.normalized_connec_entity_name]
@@ -273,6 +273,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
       mapped_external_entities_with_idmaps.each do |mapped_external_entity_with_idmap|
         id_map = mapped_external_entity_with_idmap[:idmap]
         next unless id_map&.metadata&.dig(:ignore_currency_update)
+
         self.class.currency_check_fields.each do |field|
           mapped_external_entity_with_idmap[:entity].delete(field)
         end
@@ -302,6 +303,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
   # Wrapper to process options and limitations
   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(entity_name, last_synchronization_date)
   end
 
@@ -367,6 +369,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
       # Update
       else
         return nil unless self.class.can_update_external?
+
         external_hash = update_external_entity(mapped_connec_entity, idmap.external_id, external_entity_name)
 
         completed_hash = map_and_complete_hash_with_connec_ids(external_hash, external_entity_name, id_refs_only_connec_entity)
@@ -479,6 +482,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
         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.present?
+
         response = JSON.parse(response.body)
 
         # Parse batch response

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

@@ -114,6 +114,7 @@ module Maestrano::Connector::Rails::Concerns::Organization
   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

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

@@ -12,11 +12,13 @@ module Maestrano::Connector::Rails::Concerns::SubEntityBase
 
     def external_entity_name
       return entity_name if external?
+
       raise 'Forbidden call: cannot call external_entity_name for a connec entity'
     end
 
     def connec_entity_name
       return entity_name unless external?
+
       raise 'Forbidden call: cannot call connec_entity_name for an external entity'
     end
 

data/app/policies/maestrano/connector/rails/application_policy.rb

@@ -16,6 +16,7 @@ class Maestrano::Connector::Rails::ApplicationPolicy
   def initialize(user, record)
     # Closed system: must be logged in to do anything
     raise Pundit::NotAuthorizedError, 'must be logged in' unless user
+
     @user = user
     @record = record
   end

data/app/resources/maestrano/api/base_resource.rb

@@ -16,6 +16,7 @@ module Maestrano
       def self.all_filters
         # Skipping if there is no tables as calling columns_hash in attribute_type is causing issue
         return unless tables_exists?
+
         _attributes.keys.each do |attribute|
           type = attribute_type(attribute)
           if type == :boolean
@@ -34,6 +35,7 @@ module Maestrano
           # iterating through all the api operator and adding them as custom filter
           # name.gt, name.like etc...
           next unless _model_class
+
           field = "#{_model_class.table_name}.#{key}"
 
           API_SQL_OPERATOR_MAPPING.each do |api_operator, sql_operator|

data/app/resources/maestrano/api/user_resource.rb

@@ -15,6 +15,7 @@ module Maestrano
         @model.tenant = context[:client]
         super
         return unless org_uid == context.dig(:params, :org_uid)
+
         org = Maestrano::Connector::Rails::Organization.find_by(org_uid: org_uid)
         org.add_member(@model) unless !org || org.member?(@model)
       end

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

@@ -1,7 +1,7 @@
 module Maestrano
   module Connector
     module Rails
-      VERSION = '2.3.2'.freeze
+      VERSION = '2.3.3'.freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maestrano-connector-rails
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.3.3
 platform: ruby
 authors:
 - Maestrano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2018-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -435,6 +435,7 @@ files:
 - app/controllers/maestrano/api/users_controller.rb
 - app/controllers/maestrano/application_controller.rb
 - app/controllers/maestrano/auth/saml_controller.rb
+- app/controllers/maestrano/concerns/synchronizations_controller.rb
 - app/controllers/maestrano/connec_controller.rb
 - app/controllers/maestrano/dependancies_controller.rb
 - app/controllers/maestrano/sessions_controller.rb
@@ -563,7 +564,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Rails framework to build connector with Maestrano