maestrano-connector-rails 0.2.20 → 0.3.0

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

@@ -1,70 +1,74 @@
 module Maestrano::Connector::Rails::Concerns::SubEntityBase
   extend ActiveSupport::Concern
 
-  def external?
-    raise "Not implemented"
-  end
+  module ClassMethods
+    def external?
+      raise "Not implemented"
+    end
 
-  def entity_name
-    raise "Not implemented"
-  end
+    def entity_name
+      raise "Not implemented"
+    end
 
-  def map_to(name, entity, organization)
-    raise "Not implemented"
-  end
+    def external_entity_name
+      if external?
+        entity_name
+      else
+        raise "Forbidden call: cannot call external_entity_name for a connec entity"
+      end
+    end
 
-  def external_entity_name
-    if external?
-      entity_name
-    else
-      raise "Forbidden call: cannot call external_entity_name for a connec entity"
+    def connec_entity_name
+      if external?
+        raise "Forbidden call: cannot call connec_entity_name for an external entity"
+      else
+        entity_name
+      end
     end
-  end
 
-  def connec_entity_name
-    if external?
-      raise "Forbidden call: cannot call connec_entity_name for an external entity"
-    else
-      entity_name
+    def names_hash
+      if external?
+        {external_entity: entity_name.downcase}
+      else
+        {connec_entity: entity_name.downcase}
+      end
     end
-  end
 
-  def names_hash
-    if external?
-      {external_entity: entity_name.downcase}
-    else
-      {connec_entity: entity_name.downcase}
+    def create_idmap_from_external_entity(entity, connec_entity_name, organization)
+      if external?
+        h = names_hash.merge({
+          external_id: id_from_external_entity_hash(entity),
+          name: object_name_from_external_entity_hash(entity),
+          connec_entity: connec_entity_name.downcase,
+          organization_id: organization.id
+        })
+        Maestrano::Connector::Rails::IdMap.create(h)
+      else
+        raise 'Forbidden call: cannot call create_idmap_from_external_entity for a connec entity'
+      end
     end
-  end
 
-  def create_idmap_from_external_entity(entity, connec_entity_name, organization)
-    if external?
-      h = names_hash.merge({
-        external_id: get_id_from_external_entity_hash(entity),
-        name: object_name_from_external_entity_hash(entity),
-        connec_entity: connec_entity_name.downcase,
-        organization_id: organization.id
-      })
-      Maestrano::Connector::Rails::IdMap.create(h)
-    else
-      raise 'Forbidden call: cannot call create_idmap_from_external_entity for a connec entity'
+    def create_idmap_from_connec_entity(entity, external_entity_name, organization)
+      if external?
+        raise 'Forbidden call: cannot call create_idmap_from_connec_entity for an external entity'
+      else
+        h = names_hash.merge({
+          connec_id: entity['id'],
+          name: object_name_from_connec_entity_hash(entity),
+          external_entity: external_entity_name.downcase,
+          organization_id: organization.id
+        })
+        Maestrano::Connector::Rails::IdMap.create(h)
+      end
     end
   end
 
-  def create_idmap_from_connec_entity(entity, external_entity_name, organization)
-    if external?
-      raise 'Forbidden call: cannot call create_idmap_from_connec_entity for an external entity'
-    else
-      h = names_hash.merge({
-        connec_id: entity['id'],
-        name: object_name_from_connec_entity_hash(entity),
-        external_entity: external_entity_name.downcase,
-        organization_id: organization.id
-      })
-      Maestrano::Connector::Rails::IdMap.create(h)
-    end
+
+  def map_to(name, entity, organization)
+    raise "Not implemented"
   end
 
+
   def map_external_entity_with_idmap(external_entity, connec_entity_name, idmap, organization)
     {entity: map_to(connec_entity_name, external_entity, organization), idmap: idmap}
   end

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

@@ -3,11 +3,11 @@
 # See README for explanation
 # class Entities::SubEntities::Contact < Maestrano::Connector::Rails::SubEntityBase
 
-#   def external?
+#   def self.external?
 #     true
 #   end
 
-#   def entity_name
+#   def self.entity_name
 #     'contact'
 #   end
 
@@ -20,11 +20,11 @@
 #     end
 #   end
 
-#   def object_name_from_connec_entity_hash(entity)
+#   def self.object_name_from_connec_entity_hash(entity)
 #     "#{entity['first_name']} #{entity['last_name']}"
 #   end
 
-#   def object_name_from_external_entity_hash(entity)
+#   def self.object_name_from_external_entity_hash(entity)
 #     "#{entity['FirstName']} #{entity['LastName']}"
 #   end
 # end

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

@@ -2,13 +2,13 @@
 # This file is provided as an example and should be removed
 # See README for explanation
 # class Entities::ContactAndLead < Maestrano::Connector::Rails::ComplexEntity
-#   def connec_entities_names
+#   def self.connec_entities_names
 #     %w(person)
 #   end
 
-#   def external_entities_names
+#   def self.external_entities_names
 #     %w(contact lead)
-#   end
+#   endCont
 
 #   # input :  {
 #   #             connec_entity_names[0]: [unmapped_connec_entitiy1, unmapped_connec_entitiy2],

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

@@ -3,11 +3,11 @@
 # See README for explanation
 # class Entities::SubEntities::Lead < Maestrano::Connector::Rails::SubEntityBase
 
-#   def external?
+#   def self.external?
 #     true
 #   end
 
-#   def entity_name
+#   def self.entity_name
 #     'lead'
 #   end
 
@@ -20,11 +20,11 @@
 #     end
 #   end
 
-#   def object_name_from_connec_entity_hash(entity)
+#   def self.object_name_from_connec_entity_hash(entity)
 #     "#{entity['first_name']} #{entity['last_name']}"
 #   end
 
-#   def object_name_from_external_entity_hash(entity)
+#   def self.object_name_from_external_entity_hash(entity)
 #     "#{entity['FirstName']} #{entity['LastName']}"
 #   end
 # end

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

@@ -2,11 +2,11 @@
 # This file is provided as an example and should be removed
 # See README for explanation
 # class Enities::SubEntities::Person < Maestrano::Connector::Rails::SubEntityBase
-#   def external?
+#   def self.external?
 #     false
 #   end
 
-#   def entity_name
+#   def self.entity_name
 #     'person'
 #   end
 
@@ -21,11 +21,11 @@
 #     end
 #   end
 
-#   def object_name_from_connec_entity_hash(entity)
+#   def self.object_name_from_connec_entity_hash(entity)
 #     "#{entity['first_name']} #{entity['last_name']}"
 #   end
 
-#   def object_name_from_external_entity_hash(entity)
+#   def self.object_name_from_external_entity_hash(entity)
 #     "#{entity['FirstName']} #{entity['LastName']}"
 #   end
 # end

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

@@ -33,13 +33,13 @@ class Maestrano::Connector::Rails::Entity
     # This method updates the entity with the given id in the external app
   end
 
-  def get_id_from_external_entity_hash(entity)
+  def self.id_from_external_entity_hash(entity)
     # TODO
     # This method return the id from an external_entity_hash
     # e.g entity['id']
   end
 
-  def get_last_update_date_from_external_entity_hash(entity)
+  def self.last_update_date_from_external_entity_hash(entity)
     # TODO
     # This method return the last update date from an external_entity_hash
     # e.g entity['last_update']

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

@@ -4,23 +4,23 @@
 # with its associated mapper
 
 # class Entities::ExampleEntity < Maestrano::Connector::Rails::Entity
-#   def connec_entity_name
+#   def self.connec_entity_name
 #     'ExampleEntity'
 #   end
 
-#   def external_entity_name
+#   def self.external_entity_name
 #     'Contact'
 #   end
 
-#   def mapper_class
+#   def self.mapper_class
 #     ExampleEntityMapper
 #   end
 
-#   def object_name_from_connec_entity_hash(entity)
+#   def self.object_name_from_connec_entity_hash(entity)
 #     "#{entity['first_name']} #{entity['last_name']}"
 #   end
 
-#   def object_name_from_external_entity_hash(entity)
+#   def self.object_name_from_external_entity_hash(entity)
 #     "#{entity['FirstName']} #{entity['LastName']}"
 #   end
 

data/maestrano-connector-rails.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: maestrano-connector-rails 0.2.20 ruby lib
+# stub: maestrano-connector-rails 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "maestrano-connector-rails"
-  s.version = "0.2.20"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Pierre Berard"]
-  s.date = "2016-03-11"
+  s.date = "2016-03-18"
   s.description = "Maestrano is the next generation marketplace for SME applications. See https://maestrano.com for details."
   s.email = "pierre.berard@maestrano.com"
   s.executables = ["rails"]
@@ -71,7 +71,6 @@ Gem::Specification.new do |s|
     "lib/generators/connector/templates/complex_entity_example/lead.rb",
     "lib/generators/connector/templates/complex_entity_example/lead_mapper.rb",
     "lib/generators/connector/templates/complex_entity_example/person.rb",
-    "lib/generators/connector/templates/contact_and_lead.rb",
     "lib/generators/connector/templates/entity.rb",
     "lib/generators/connector/templates/example_entity.rb",
     "lib/generators/connector/templates/external.rb",

data/spec/controllers/connec_controller_spec.rb

@@ -49,7 +49,7 @@ describe Maestrano::ConnecController, type: :controller do
         before {
           allow(Maestrano::Connector::Rails::Entity).to receive(:entities_list).and_return(%w(contact_and_lead))
           class Entities::ContactAndLead < Maestrano::Connector::Rails::ComplexEntity
-            def connec_entities_names
+            def self.connec_entities_names
               %w(Lead)
             end
           end
@@ -65,7 +65,7 @@ describe Maestrano::ConnecController, type: :controller do
 
         context 'when syncing' do
           before {
-            allow_any_instance_of(Entities::ContactAndLead).to receive(:external_entities_names).and_return(%w())
+            allow(Entities::ContactAndLead).to receive(:external_entities_names).and_return(%w())
           }
           let!(:organization) { create(:organization, uid: group_id, oauth_uid: 'lala', sync_enabled: true, synchronized_entities: {contact_and_lead: true}) }
 
@@ -83,7 +83,7 @@ describe Maestrano::ConnecController, type: :controller do
         before {
           allow(Maestrano::Connector::Rails::Entity).to receive(:entities_list).and_return(%w(person))
           class Entities::Person < Maestrano::Connector::Rails::Entity
-            def connec_entity_name
+            def self.connec_entity_name
               'People'
             end
           end

data/spec/jobs/push_to_connec_job_spec.rb

@@ -11,18 +11,18 @@ describe Maestrano::Connector::Rails::PushToConnecJob do
       end
     end
     allow_any_instance_of(Entities::Entity1).to receive(:push_entities_to_connec)
-    allow_any_instance_of(Entities::Entity1).to receive(:external_entity_name).and_return('ext_entity1')
+    allow(Entities::Entity1).to receive(:external_entity_name).and_return('ext_entity1')
     class Entities::Entity2 < Maestrano::Connector::Rails::ComplexEntity
     end
     allow_any_instance_of(Entities::Entity2).to receive(:consolidate_and_map_data).and_return({})
     allow_any_instance_of(Entities::Entity2).to receive(:push_entities_to_connec)
-    allow_any_instance_of(Entities::Entity2).to receive(:connec_entities_names).and_return(%w())
-    allow_any_instance_of(Entities::Entity2).to receive(:external_entities_names).and_return(%w(Subs ll))
+    allow(Entities::Entity2).to receive(:connec_entities_names).and_return(%w())
+    allow(Entities::Entity2).to receive(:external_entities_names).and_return(%w(Subs ll))
     module Entities::SubEntities end;
     class Entities::SubEntities::Sub < Maestrano::Connector::Rails::SubEntityBase
     end
     allow(Maestrano::Connector::Rails::Entity).to receive(:entities_list).and_return([entity_name1, entity_name2])
-    allow_any_instance_of(Maestrano::Connector::Rails::Entity).to receive(:get_id_from_external_entity_hash).and_return('11')
+    allow(Maestrano::Connector::Rails::Entity).to receive(:id_from_external_entity_hash).and_return('11')
   }
   let(:entity11) { {first_name: 'John'} }
   let(:entity12) { {first_name: 'Jane'} }

data/spec/jobs/syncrhonization_job_spec.rb

@@ -57,12 +57,14 @@ describe Maestrano::Connector::Rails::SynchronizationJob do
 
     subject { Maestrano::Connector::Rails::SynchronizationJob.new }
 
-    it 'calls the five methods' do
+    it 'calls the seven methods' do
+      expect_any_instance_of(Entities::Person).to receive(:before_sync)
       expect_any_instance_of(Entities::Person).to receive(:get_connec_entities)
       expect_any_instance_of(Entities::Person).to receive(:get_external_entities)
       expect_any_instance_of(Entities::Person).to receive(:consolidate_and_map_data).and_return({})
       expect_any_instance_of(Entities::Person).to receive(:push_entities_to_external)
       expect_any_instance_of(Entities::Person).to receive(:push_entities_to_connec)
+      expect_any_instance_of(Entities::Person).to receive(:after_sync)
       subject.sync_entity('person', organization, nil, nil, nil, {})
     end
   end

data/spec/models/complex_entity_spec.rb

@@ -2,13 +2,15 @@ require 'spec_helper'
 
 describe Maestrano::Connector::Rails::ComplexEntity do
 
-  #Connec specific methods
-  describe 'connec specific methods' do
+  subject { Maestrano::Connector::Rails::ComplexEntity.new }
+
+  #Complex specific methods
+  describe 'complex specific methods' do
     describe 'connec_entities_names' do
-      it { expect{ subject.connec_entities_names }.to raise_error('Not implemented') }
+      it { expect{ subject.class.connec_entities_names }.to raise_error('Not implemented') }
     end
     describe 'external_entities_names' do
-      it { expect{ subject.external_entities_names }.to raise_error('Not implemented') }
+      it { expect{ subject.class.external_entities_names }.to raise_error('Not implemented') }
     end
     describe 'connec_model_to_external_model' do
       it { expect{ subject.connec_model_to_external_model({}) }.to raise_error('Not implemented') }
@@ -19,7 +21,6 @@ describe Maestrano::Connector::Rails::ComplexEntity do
   end
 
   describe 'general methods' do
-    subject { Maestrano::Connector::Rails::ComplexEntity.new }
 
     describe 'map_to_external_with_idmap' do
       let(:organization) { create(:organization) }
@@ -31,10 +32,10 @@ describe Maestrano::Connector::Rails::ComplexEntity do
       let(:sub_instance) { Maestrano::Connector::Rails::SubEntityBase.new }
       let(:human_name) { 'ET' }
       before {
-        allow(sub_instance).to receive(:external?).and_return(false)
-        allow(sub_instance).to receive(:entity_name).and_return(connec_name)
+        allow(sub_instance.class).to receive(:external?).and_return(false)
+        allow(sub_instance.class).to receive(:entity_name).and_return(connec_name)
         allow(sub_instance).to receive(:map_to).and_return(mapped_entity)
-        allow(sub_instance).to receive(:object_name_from_connec_entity_hash).and_return(human_name)
+        allow(sub_instance.class).to receive(:object_name_from_connec_entity_hash).and_return(human_name)
       }
 
       context 'when entity has no idmap' do
@@ -188,20 +189,20 @@ describe Maestrano::Connector::Rails::ComplexEntity do
         before{
           allow(subject).to receive(:external_model_to_connec_model).and_return(external_hash)
           allow(subject).to receive(:connec_model_to_external_model).and_return(connec_hash)
-          allow_any_instance_of(Entities::SubEntities::ScE1).to receive(:external?).and_return(true)
-          allow_any_instance_of(Entities::SubEntities::ScE1).to receive(:entity_name).and_return('sc_e1')
-          allow_any_instance_of(Entities::SubEntities::ScE1).to receive(:get_id_from_external_entity_hash).with(entity1).and_return(id1)
-          allow_any_instance_of(Entities::SubEntities::ScE1).to receive(:get_last_update_date_from_external_entity_hash).and_return(1.minute.ago)
+          allow(Entities::SubEntities::ScE1).to receive(:external?).and_return(true)
+          allow(Entities::SubEntities::ScE1).to receive(:entity_name).and_return('sc_e1')
+          allow(Entities::SubEntities::ScE1).to receive(:id_from_external_entity_hash).with(entity1).and_return(id1)
+          allow(Entities::SubEntities::ScE1).to receive(:last_update_date_from_external_entity_hash).and_return(1.minute.ago)
           allow_any_instance_of(Entities::SubEntities::ScE1).to receive(:map_to).with('connec1', entity1, organization).and_return(mapped_entity1)
-          allow_any_instance_of(Entities::SubEntities::ScE2).to receive(:external?).and_return(true)
-          allow_any_instance_of(Entities::SubEntities::ScE2).to receive(:entity_name).and_return('Sce2')
-          allow_any_instance_of(Entities::SubEntities::ScE2).to receive(:get_id_from_external_entity_hash).with(entity1).and_return(id1)
-          allow_any_instance_of(Entities::SubEntities::ScE2).to receive(:get_id_from_external_entity_hash).with(entity2).and_return(id2)
-          allow_any_instance_of(Entities::SubEntities::ScE2).to receive(:get_last_update_date_from_external_entity_hash).and_return(1.minute.ago)
+          allow(Entities::SubEntities::ScE2).to receive(:external?).and_return(true)
+          allow(Entities::SubEntities::ScE2).to receive(:entity_name).and_return('Sce2')
+          allow(Entities::SubEntities::ScE2).to receive(:id_from_external_entity_hash).with(entity1).and_return(id1)
+          allow(Entities::SubEntities::ScE2).to receive(:id_from_external_entity_hash).with(entity2).and_return(id2)
+          allow(Entities::SubEntities::ScE2).to receive(:last_update_date_from_external_entity_hash).and_return(1.minute.ago)
           allow_any_instance_of(Entities::SubEntities::ScE2).to receive(:map_to).with('connec1', entity1, organization).and_return(mapped_entity1)
           allow_any_instance_of(Entities::SubEntities::ScE2).to receive(:map_to).with('connec2', entity2, organization).and_return(mapped_entity2)
-          allow_any_instance_of(Entities::SubEntities::ScE1).to receive(:object_name_from_external_entity_hash).and_return(human_name)
-          allow_any_instance_of(Entities::SubEntities::ScE2).to receive(:object_name_from_external_entity_hash).and_return(human_name)
+          allow(Entities::SubEntities::ScE1).to receive(:object_name_from_external_entity_hash).and_return(human_name)
+          allow(Entities::SubEntities::ScE2).to receive(:object_name_from_external_entity_hash).and_return(human_name)
         }
 
         context 'when entities have no idmaps' do
@@ -268,9 +269,9 @@ describe Maestrano::Connector::Rails::ComplexEntity do
             class Entities::SubEntities::Connec2 < Maestrano::Connector::Rails::SubEntityBase
             end
             allow_any_instance_of(Entities::SubEntities::Connec1).to receive(:map_to).and_return({'name' => 'Jacob'})
-            allow_any_instance_of(Entities::SubEntities::Connec1).to receive(:external?).and_return(false)
-            allow_any_instance_of(Entities::SubEntities::Connec1).to receive(:entity_name).and_return('connec1')
-            allow_any_instance_of(Entities::SubEntities::Connec1).to receive(:object_name_from_connec_entity_hash).and_return('human name')
+            allow(Entities::SubEntities::Connec1).to receive(:external?).and_return(false)
+            allow(Entities::SubEntities::Connec1).to receive(:entity_name).and_return('connec1')
+            allow(Entities::SubEntities::Connec1).to receive(:object_name_from_connec_entity_hash).and_return('human name')
           }
           let(:connec_id1) { '67ttf-5rr4d' }
           let!(:idmap1) { create(:idmap, organization: organization, external_id: id1, external_entity: 'sc_e1', connec_entity: 'connec1', last_push_to_connec: 1.year.ago, connec_id: connec_id1) }
@@ -384,8 +385,8 @@ describe Maestrano::Connector::Rails::ComplexEntity do
         let(:idmap) { create(:idmap, organization: organization) }
         before {
           [Entities::SubEntities::ScE1, Entities::SubEntities::ScE2].each do |klass|
-            allow_any_instance_of(klass).to receive(:external?).and_return(true)
-            allow_any_instance_of(klass).to receive(:entity_name).and_return('n')
+            allow(klass).to receive(:external?).and_return(true)
+            allow(klass).to receive(:entity_name).and_return('n')
           end
           allow(client).to receive(:put).and_return(ActionDispatch::Response.new(200, {}, {people: {}}.to_json, {}))
         }