maestrano-connector-rails 0.4.4 → 1.0.0

data/spec/integration/integration_complex_spec.rb

@@ -0,0 +1,281 @@
+require 'spec_helper'
+
+describe 'complex entities workflow' do
+  class Entities::CustomerAndSupplier < Maestrano::Connector::Rails::ComplexEntity
+    def self.connec_entities_names
+      %w(CompOrganization)
+    end
+    def self.external_entities_names
+      %w(CompCustomer CompSupplier)
+    end
+    def connec_model_to_external_model(connec_hash_of_entities)
+      organizations = connec_hash_of_entities['CompOrganization']
+      modeled_connec_entities = {'CompOrganization' => { 'CompSupplier' => [], 'CompCustomer' => [] }}
+
+      organizations.each do |organization|
+        if organization['is_supplier']
+          modeled_connec_entities['CompOrganization']['CompSupplier'] << organization
+        else
+          modeled_connec_entities['CompOrganization']['CompCustomer'] << organization
+        end
+      end
+      return modeled_connec_entities
+    end
+    def external_model_to_connec_model(external_hash_of_entities)
+      return {'CompCustomer' => {'CompOrganization' => external_hash_of_entities['CompCustomer']}, 'CompSupplier' => {'CompOrganization' => external_hash_of_entities['CompSupplier']}}
+    end
+  end
+
+  module Entities::SubEntities
+  end
+  class Entities::SubEntities::CompOrganization < Maestrano::Connector::Rails::SubEntityBase
+    def self.external?
+      false
+    end
+    def self.entity_name
+      'CompOrganization'
+    end
+    def self.mapper_classes
+      {
+        'CompCustomer' => ::CompMapper,
+        'CompSupplier' => ::CompMapper
+      }
+    end
+    def self.object_name_from_connec_entity_hash(entity)
+      entity['name']
+    end
+    def self.references
+      {'CompCustomer' => ['ref_id'], 'CompSupplier' => ['ref_id']}
+    end
+    def self.id_from_external_entity_hash(entity)
+      entity['id']
+    end
+  end
+
+  class Entities::SubEntities::CompCustomer < Maestrano::Connector::Rails::SubEntityBase
+    def self.external?
+      true
+    end
+    def self.entity_name
+      'CompCustomer'
+    end
+    def self.mapper_classes
+      {'CompOrganization' => ::CompMapper}
+    end
+    def self.id_from_external_entity_hash(entity)
+      entity['id']
+    end
+    def self.object_name_from_external_entity_hash(entity)
+      entity['name']
+    end
+    def self.references
+      {'CompOrganization' => ['ref_id']}
+    end
+    def map_to(name, entity)
+      super.merge(is_supplier: false)
+    end
+  end
+  class Entities::SubEntities::CompSupplier < Maestrano::Connector::Rails::SubEntityBase
+    def self.external?
+      true
+    end
+    def self.entity_name
+      'CompSupplier'
+    end
+    def self.mapper_classes
+      {'CompOrganization' => ::CompMapper}
+    end
+    def self.id_from_external_entity_hash(entity)
+      entity['id']
+    end
+    def self.object_name_from_external_entity_hash(entity)
+      entity['name']
+    end
+    def self.references
+      {'CompOrganization' => ['ref_id']}
+    end
+    def map_to(name, entity)
+      super.merge(is_supplier: true)
+    end
+  end
+
+  class CompMapper
+    extend HashMapper
+    map from('id'), to('id')
+    map from('ref_id'), to('ref_id')
+    map from('name'), to('name')
+  end
+
+  let(:provider) { 'provider' }
+  let(:oauth_uid) { 'oauth uid' }
+  let!(:organization) { create(:organization, oauth_provider: provider, oauth_uid: oauth_uid, uid: 'uid') }
+  let(:connec_client) { Maestrano::Connec::Client[organization.tenant].new(organization.uid) }
+  let(:external_client) { Object.new }
+
+
+  let(:connec_org1_id) { 'connec_org1_id' }
+  let(:connec_org2_id) { 'connec_org2_id' }
+  let(:connec_org1_ext_id) { 'connec_org1_ext_id' }
+  let(:connec_org2_ext_id) { 'connec_org2_ext_id' }
+  let(:connec_org1_name) { 'connec_org1_name' }
+  let(:connec_org2_name) { 'connec_org2_name' }
+  let(:connec_org1_ext_ref_id) { 'connec_org1_ext_ref_id' }
+  let(:connec_org2_ext_ref_id) { 'connec_org2_ext_ref_id' }
+  let(:connec_org1) {
+    {
+      'id' => [{'provider' => 'connec', 'id' => connec_org1_id, 'realm' => organization.uid}],
+      'name' => connec_org1_name,
+      'is_supplier' => true,
+      'ref_id' => [{'provider' => provider, 'id' => connec_org1_ext_ref_id, 'realm' => oauth_uid}]
+    }
+  }
+  let(:mapped_connec_org1) {
+    {
+      ref_id: connec_org1_ext_ref_id,
+      name: connec_org1_name,
+    }
+  }
+  let(:connec_org2) {
+    {
+      'id' => [{'provider' => provider, 'id' => connec_org2_ext_id, 'realm' => oauth_uid}, {'id' => connec_org2_id, 'provider' => 'connec', 'realm' => organization.uid}],
+      'name' => connec_org2_name,
+      'is_supplier' => false,
+      'ref_id' => [{'provider' => provider, 'id' => connec_org2_ext_ref_id, 'realm' => oauth_uid}]
+    }
+  }
+  let(:mapped_connec_org2) {
+    {
+      ref_id: connec_org2_ext_ref_id,
+      name: connec_org2_name,
+      id: connec_org2_ext_id
+    }
+  }
+  let(:connec_orgs) { [connec_org1, connec_org2] }
+
+  let(:ext_customer_id) { 'ext_customer_id' }
+  let(:ext_supplier_id) { 'ext_supplier_id' }
+  let(:ext_customer_name) { 'ext_customer_name' }
+  let(:ext_supplier_name) { 'ext_supplier_name' }
+  let(:ext_ref_id) { 'ext_ref_id' }
+  let(:ext_customer) {
+    {
+      'id' => ext_customer_id,
+      'name' => ext_customer_name,
+      'ref_id' => ext_ref_id
+    }
+  }
+  let(:mapped_ext_customer) {
+    {
+      :id => [
+        {
+          :id => ext_customer_id,
+          :provider => provider,
+          :realm => oauth_uid
+        }
+      ],
+      :ref_id => [
+        {
+          :id => ext_ref_id,
+          :provider => provider,
+          :realm => oauth_uid
+        }
+      ],
+      :name => ext_customer_name,
+      :is_supplier => false
+    }
+  }
+  let(:ext_supplier) {
+    {
+      'id' => ext_supplier_id,
+      'name' => ext_supplier_name,
+      'ref_id' => ext_ref_id
+    }
+  }
+  let(:mapped_ext_supplier) {
+    {
+      :id => [
+        {
+          :id => ext_supplier_id,
+          :provider => provider,
+          :realm => oauth_uid
+        }
+      ],
+      :ref_id => [
+        {
+          :id => ext_ref_id,
+          :provider => provider,
+          :realm => oauth_uid
+        }
+      ],
+      :name => ext_supplier_name,
+      :is_supplier => true
+    }
+  }
+  let!(:supplier_idmap) { Entities::SubEntities::CompSupplier.create_idmap(organization_id: organization.id, external_id: ext_supplier_id, connec_entity: 'comporganization') }
+
+  before {
+    allow(connec_client).to receive(:get).and_return(ActionDispatch::Response.new(200, {}, {comporganizations: connec_orgs}.to_json, {}))
+    allow_any_instance_of(Entities::SubEntities::CompCustomer).to receive(:get_external_entities).and_return([ext_customer])
+    allow_any_instance_of(Entities::SubEntities::CompSupplier).to receive(:get_external_entities).and_return([ext_supplier])
+  }
+
+  subject { Maestrano::Connector::Rails::SynchronizationJob.new.sync_entity('customer_and_supplier', organization, connec_client, external_client, nil, {}) }
+
+  it 'handles the fetching correctly' do
+    expect_any_instance_of(Entities::CustomerAndSupplier).to receive(:consolidate_and_map_data).with({'CompOrganization' => connec_orgs}, {'CompCustomer' => [ext_customer], 'CompSupplier' => [ext_supplier]}).and_return({connec_entities: [], external_entities: []})
+    subject
+  end
+
+  it 'handles the idmap correctly' do
+    allow(connec_client).to receive(:batch).and_return(ActionDispatch::Response.new(201, {}, {results: []}.to_json, {}))
+    allow_any_instance_of(Entities::SubEntities::CompOrganization).to receive(:create_external_entity).and_return(connec_org1_ext_id)
+    allow_any_instance_of(Entities::SubEntities::CompOrganization).to receive(:update_external_entity).and_return(nil)
+    expect{
+      subject
+    }.to change{ Maestrano::Connector::Rails::IdMap.count }.by(3)
+
+    expect(supplier_idmap.reload.name).to eql(ext_supplier_name)
+    expect(supplier_idmap.reload.connec_entity).to eql('comporganization')
+    expect(supplier_idmap.reload.external_entity).to eql('compsupplier')
+    expect(supplier_idmap.reload.message).to be_nil
+    expect(supplier_idmap.reload.external_id).to eql(ext_supplier_id)
+
+    customer_idmap = Entities::SubEntities::CompCustomer.find_idmap({external_id: ext_customer_id})
+    expect(customer_idmap).to_not be_nil
+    expect(customer_idmap.name).to eql(ext_customer_name)
+    expect(customer_idmap.connec_entity).to eql('comporganization')
+    expect(customer_idmap.external_entity).to eql('compcustomer')
+    expect(customer_idmap.message).to be_nil
+
+    org1_idmap = Entities::SubEntities::CompOrganization.find_idmap({external_id: connec_org1_ext_id})
+    expect(org1_idmap).to_not be_nil
+    expect(org1_idmap.name).to eql(connec_org1_name)
+    expect(org1_idmap.connec_entity).to eql('comporganization')
+    expect(org1_idmap.external_entity).to eql('compsupplier')
+    expect(org1_idmap.message).to be_nil
+
+    org2_idmap = Entities::SubEntities::CompOrganization.find_idmap({external_id: connec_org2_ext_id})
+    expect(org2_idmap).to_not be_nil
+    expect(org2_idmap.name).to eql(connec_org2_name)
+    expect(org2_idmap.connec_entity).to eql('comporganization')
+    expect(org2_idmap.external_entity).to eql('compcustomer')
+    expect(org2_idmap.message).to be_nil
+  end
+
+  it 'handles the mapping correctly' do
+    cust_idmap = Entities::SubEntities::CompCustomer.create_idmap(organization_id: organization.id, external_id: ext_customer_id, connec_entity: 'comporganization')
+    org1_idmap = Entities::SubEntities::CompOrganization.create_idmap(organization_id: organization.id, external_id: connec_org1_ext_id, external_entity: 'compsupplier')
+    org2_idmap = Entities::SubEntities::CompOrganization.create_idmap(organization_id: organization.id, external_id: connec_org2_ext_id, external_entity: 'compcustomer')
+    allow(Maestrano::Connector::Rails::IdMap).to receive(:create).and_return(org1_idmap, org2_idmap, cust_idmap)
+    expect_any_instance_of(Entities::CustomerAndSupplier).to receive(:push_entities_to_external).with({'CompOrganization' => {'CompSupplier' => [{entity: mapped_connec_org1, idmap: org1_idmap}], 'CompCustomer' => [{entity: mapped_connec_org2, idmap: org2_idmap}]}})
+    expect_any_instance_of(Entities::CustomerAndSupplier).to receive(:push_entities_to_connec).with({'CompCustomer' => {'CompOrganization' => [{entity: mapped_ext_customer, idmap: cust_idmap}]}, 'CompSupplier' => {'CompOrganization' => [{entity: mapped_ext_supplier, idmap: supplier_idmap}]}})
+    subject
+  end
+
+  it 'sends two objects to connec, two objects to external and send back one id to connec' do
+    expect_any_instance_of(Entities::SubEntities::CompOrganization).to receive(:create_external_entity).once
+    expect_any_instance_of(Entities::SubEntities::CompOrganization).to receive(:update_external_entity).once
+    expect(connec_client).to receive(:batch).exactly(3).times.and_return(ActionDispatch::Response.new(201, {}, {results: []}.to_json, {}), ActionDispatch::Response.new(200, {}, {results: []}.to_json, {}))
+    subject
+  end
+end

data/spec/integration/singleton_spec.rb

@@ -0,0 +1,288 @@
+require 'spec_helper'
+
+describe 'singleton workflow' do
+
+  class Entities::SingletonIntegration < Maestrano::Connector::Rails::Entity
+    def self.external_entity_name
+      'Company'
+    end
+
+    def self.connec_entity_name
+      'Company'
+    end
+
+    def self.mapper_class
+      CompanyMapper
+    end
+
+    def self.object_name_from_connec_entity_hash(entity)
+      entity['name']
+    end
+
+    def self.object_name_from_external_entity_hash(entity)
+      entity['name']
+    end
+
+    def self.id_from_external_entity_hash(entity)
+      entity['id']
+    end
+
+    def self.last_update_date_from_external_entity_hash(entity)
+      entity['updated_at']
+    end
+
+    def self.singleton?
+      true
+    end
+
+    class CompanyMapper
+      extend HashMapper
+      map from('id'), to('id')
+      map from('name'), to('name')
+    end
+  end
+
+  let(:provider) { 'provider' }
+  let(:oauth_uid) { 'oauth uid' }
+  let!(:organization) { create(:organization, oauth_provider: provider, oauth_uid: oauth_uid) }
+  let(:connec_client) { Maestrano::Connec::Client[organization.tenant].new(organization.uid) }
+  let(:external_client) { Object.new }
+  let(:ext_comp_id) { 'ext comp id' }
+  let(:connec_updated) { 1.hour.ago }
+  let(:ext_updated) { 1.hour.ago }
+  let(:company_base) {
+    {
+      "name" => "My awesome company",
+      "updated_at" => connec_updated
+    }
+  }
+
+  let(:ext_company_base) {
+    {
+      'id' => ext_comp_id,
+      'name' => 'My not so awesome store',
+      'updated_at' => ext_updated
+    }
+  }
+
+  let(:mapped_connec_entity) {
+    {
+      id: ext_comp_id,
+      name: "My awesome company"
+    }
+  }
+
+  let(:mapped_external_entity) {
+    {
+      id: [
+        {
+          :id=>ext_comp_id,
+          :provider=>provider,
+          :realm=>oauth_uid
+        }
+      ],
+      name: 'My not so awesome store'
+    }
+  }
+
+
+  before {
+    allow(connec_client).to receive(:get).and_return(ActionDispatch::Response.new(200, {}, {company: company}.to_json, {}))
+    allow_any_instance_of(Entities::SingletonIntegration).to receive(:get_external_entities).and_return(ext_company)
+    allow_any_instance_of(Entities::SingletonIntegration).to receive(:update_external_entity).and_return(nil)
+    allow(connec_client).to receive(:batch).and_return(ActionDispatch::Response.new(200, {}, {results: [{status: 200, body: {company: {id: [{provider: 'connec', id: 'some connec id'}]}}}]}.to_json, {}))
+  }
+
+  subject { Maestrano::Connector::Rails::SynchronizationJob.new.sync_entity('singleton_integration', organization, connec_client, external_client, nil, {}) }
+
+
+  describe 'when no idmap' do
+
+    describe 'when received both' do
+      let(:company) { [company_base.merge('id' => [{'id' => 'some connec id', 'provider' => 'connec', 'realm' => organization.uid}])] }
+      let(:ext_company) { [ext_company_base] }
+
+      context 'when connec most recent' do
+        let(:connec_updated) { 1.second.ago }
+        let(:batch_params) {
+          {
+            :sequential => true,
+            :ops => [
+              {
+                :method => "put",
+                :url => "/api/v2/#{organization.uid}/company/some connec id",
+                :params => {
+                  :company => {
+                    id: [
+                      {
+                        :id => "ext comp id",
+                        :provider => "provider",
+                        :realm => "oauth uid"
+                      }
+                    ]
+                  }
+                }
+              }
+            ]
+          }
+        }
+
+        it 'handles the idmap correctly' do
+          expect{
+            subject
+          }.to change{ Maestrano::Connector::Rails::IdMap.count }.by(1)
+          idmap = Maestrano::Connector::Rails::IdMap.last
+          expect(idmap.name).to eql('My awesome company')
+          expect(idmap.connec_entity).to eql('company')
+          expect(idmap.external_entity).to eql('company')
+          expect(idmap.message).to be_nil
+          expect(idmap.external_id).to eql(ext_comp_id)
+          expect(idmap.connec_id).to eql('some connec id')
+        end
+
+        it 'does the mapping correctly' do
+          idmap = Entities::SingletonIntegration.create_idmap(organization_id: organization.id, external_id: ext_comp_id, connec_id: 'some connec id')
+          allow(Entities::SingletonIntegration).to receive(:create_idmap).and_return(idmap)
+          expect_any_instance_of(Entities::SingletonIntegration).to receive(:push_entities_to_external).with([{entity: {name: 'My awesome company'}, idmap: idmap}])
+          subject
+        end
+
+        it 'send the external id to connec' do
+          expect(connec_client).to receive(:batch).with(batch_params)
+          subject
+        end
+      end
+
+      context 'when external most recent' do
+        let(:external_updated) { 1.second.ago }
+
+        it 'handles the idmap correctly' do
+          expect{
+            subject
+          }.to change{ Maestrano::Connector::Rails::IdMap.count }.by(1)
+          idmap = Maestrano::Connector::Rails::IdMap.last
+          expect(idmap.name).to eql('My not so awesome store')
+          expect(idmap.connec_entity).to eql('company')
+          expect(idmap.external_entity).to eql('company')
+          expect(idmap.message).to be_nil
+          expect(idmap.external_id).to eql(ext_comp_id)
+        end
+
+        it 'does the mapping correctly' do
+          idmap = Entities::SingletonIntegration.create_idmap(organization_id: organization.id, external_id: ext_comp_id)
+          allow(Entities::SingletonIntegration).to receive(:create_idmap).and_return(idmap)
+          expect_any_instance_of(Entities::SingletonIntegration).to receive(:push_entities_to_connec).with([{entity: mapped_external_entity, idmap: idmap}])
+          subject
+        end
+      end
+    end
+  end
+
+
+
+  describe 'when idmap exists' do
+    describe 'when received both' do
+      let(:company) { [company_base.merge('id' => [{'id' => ext_comp_id, 'provider' => provider, 'realm' => oauth_uid}, {'id' => 'connec-id', 'provider' => 'connec', 'realm' => 'some-realm'}])] }
+      let(:ext_company) { [ext_company_base] }
+      let!(:idmap) { Entities::SingletonIntegration.create_idmap(organization_id: organization.id, external_id: ext_comp_id) }
+
+      context 'when connec most recent' do
+        let(:connec_updated) { 1.second.ago }
+
+        it 'handles the idmap correctly' do
+          expect{
+            subject
+          }.to_not change{ Maestrano::Connector::Rails::IdMap.count }
+          idmap = Maestrano::Connector::Rails::IdMap.last
+          expect(idmap.name).to eql('My awesome company')
+          expect(idmap.connec_entity).to eql('company')
+          expect(idmap.external_entity).to eql('company')
+          expect(idmap.message).to be_nil
+          expect(idmap.external_id).to eql(ext_comp_id)
+        end
+
+        it 'does the mapping correctly' do
+          expect_any_instance_of(Entities::SingletonIntegration).to receive(:push_entities_to_external).with([{entity: mapped_connec_entity, idmap: idmap}])
+          subject
+        end
+
+        it 'does not map the external one' do
+          expect_any_instance_of(Entities::SingletonIntegration).to_not receive(:map_to_connec)
+          subject
+        end
+      end
+
+      context 'when external most recent' do
+        let(:external_updated) { 1.second.ago }
+
+        it 'handles the idmap correctly' do
+          expect{
+            subject
+          }.to_not change{ Maestrano::Connector::Rails::IdMap.count }
+          idmap = Maestrano::Connector::Rails::IdMap.last
+          expect(idmap.name).to eql('My not so awesome store')
+          expect(idmap.connec_entity).to eql('company')
+          expect(idmap.external_entity).to eql('company')
+          expect(idmap.message).to be_nil
+          expect(idmap.external_id).to eql(ext_comp_id)
+        end
+
+        it 'does the mapping correctly' do
+          expect_any_instance_of(Entities::SingletonIntegration).to receive(:push_entities_to_connec).with([{entity: mapped_external_entity, idmap: idmap}])
+          subject
+        end
+
+        it 'does not map the external one' do
+          expect_any_instance_of(Entities::SingletonIntegration).to_not receive(:map_to_external)
+          subject
+        end
+      end
+    end
+  end
+
+  describe 'when received only connec one' do
+    let(:company) { [company_base.merge('id' => [{'id' => ext_comp_id, 'provider' => provider, 'realm' => oauth_uid}, {'id' => 'connec-id', 'provider' => 'connec', 'realm' => 'some-realm'}])] }
+    let(:ext_company) { [] }
+    let!(:idmap) { Entities::SingletonIntegration.create_idmap(organization_id: organization.id, external_id: ext_comp_id) }
+
+    it 'handles the idmap correctly' do
+      expect{
+        subject
+      }.to_not change{ Maestrano::Connector::Rails::IdMap.count }
+      idmap = Maestrano::Connector::Rails::IdMap.last
+      expect(idmap.name).to eql('My awesome company')
+      expect(idmap.connec_entity).to eql('company')
+      expect(idmap.external_entity).to eql('company')
+      expect(idmap.message).to be_nil
+      expect(idmap.external_id).to eql(ext_comp_id)
+    end
+
+    it 'does the mapping correctly' do
+      expect_any_instance_of(Entities::SingletonIntegration).to receive(:push_entities_to_external).with([{entity: mapped_connec_entity, idmap: idmap}])
+      subject
+    end
+  end
+
+  describe 'when receive only external one' do
+    let(:company) { [] }
+    let(:ext_company) { [ext_company_base] }
+    let!(:idmap) { Entities::SingletonIntegration.create_idmap(organization_id: organization.id, external_id: ext_comp_id) }
+
+    it 'handles the idmap correctly' do
+      expect{
+        subject
+      }.to_not change{ Maestrano::Connector::Rails::IdMap.count }
+      idmap = Maestrano::Connector::Rails::IdMap.last
+      expect(idmap.name).to eql('My not so awesome store')
+      expect(idmap.connec_entity).to eql('company')
+      expect(idmap.external_entity).to eql('company')
+      expect(idmap.message).to be_nil
+      expect(idmap.external_id).to eql(ext_comp_id)
+    end
+
+    it 'does the mapping correctly' do
+      expect_any_instance_of(Entities::SingletonIntegration).to receive(:push_entities_to_connec).with([{entity: mapped_external_entity, idmap: idmap}])
+      subject
+    end
+  end
+end