maestrano-connector-rails 0.2.11 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2d4cfd04cfc13622f677ff20ca6eaa3aa011dfc
-  data.tar.gz: 42e8fad3fb600b38bb6d2fc30cd8bac000e84c43
+  metadata.gz: 0ede31586bf582ced3d9a9024968edc3ac1d1732
+  data.tar.gz: da7c491c555373c153650012442613b9edb8f6fb
 SHA512:
-  metadata.gz: 53dd9b10209d003954f54030b683a564a678e12eb1cf7231ee4a2638e3125d6dcde8747ae04524cd89cfcbcf0d8cd2d705d61807b21cf7601508054004310cd0
-  data.tar.gz: e53814be3deb00bca584920142f3887d4e1276c5a97ad8282d628cb7acf84265735f3331ddd90a34201a05b8641ce12013c6ecd10690d98ccf55c3f700a6837d
+  metadata.gz: 00e346e7cc00061e7c3c5377f51afb23f78fc59904cdad730016e9b3b11d8c72eb9d40e0e7929fc4a5d81103d09a98b253894a1e714ed8467213b5ca1798aa63
+  data.tar.gz: 9078bb564275af62c3646b496e771c78777824f8d60b23c35b9ffc990a18ff9be881e7057fea0a1220890623352432ee61aea1cf4bfba70dfa166e14231cce7c

data/Gemfile.lock

@@ -224,6 +224,3 @@ DEPENDENCIES
   sidekiq
   simplecov
   sqlite3
-
-BUNDLED WITH
-   1.10.6

data/README.md

@@ -1,4 +1,5 @@
 [ ![Codeship Status for maestrano/maestrano-connector-rails](https://codeship.com/projects/e7990b70-b04d-0133-c4e7-5e399acd7f73/status?branch=master)](https://codeship.com/projects/132645)
+[![Code Climate](https://codeclimate.com/github/maestrano/maestrano-connector-rails/badges/gpa.svg)](https://codeclimate.com/github/maestrano/maestrano-connector-rails)
 
 <p align="center">
   <img src="https://raw.github.com/maestrano/maestrano-connector-rails/master/maestrano.png" alt="Maestrano Logo">
@@ -6,7 +7,7 @@
   <br/>
 </p>
 
-Maestrano Connector Engine to implements data syncrhonization between an external application API and Connec!.
+Maestrano Connector is a Rails Engine that bootstraps the implementation of data syncrhonization between an external application API and the Maestrano ecosystem.
 
 Maestrano Connector Integration is currently in closed beta. Want to know more? Send us an email to <contact@maestrano.com>.
 
@@ -22,23 +23,23 @@ Maestrano Connector Integration is currently in closed beta. Want to know more?
   * [Mapping entities](#mapping-entities)
 4. [Pages controllers and views](#pages-controllers-and-views)
 5. [Complex entities](#complex-entities)
+6. [Webhooks](#Webhooks)
 
 - - -
 
 ## Getting Setup
-Before integrating with us you will need an Connec!™ API ID and Connec!™ API Key. You'll also need to have the connector application created on Maestrano in order to realize the authentication with Maestrano.
+Before integrating with us you will need to have your application registered on the Maestrano platform. Please refer to the online documentation we provide: https://maestrano.atlassian.net/wiki/display/CONNECAPIV2/Maestrano+Developers
 
 ## Getting Started
-Create a new rails application using the connector template
+Create a new rails application using the connector template. The template works with both Ruby 2.2 and jRuby 9.0.4.0, you will be asked which one you want to use.
 ```console
-rails new <project_name> -m https://raw.githubusercontent.com/Berardpi/maestrano-connector-rails/master/template/maestrano-connector-template.rb
+rails new <project_name> -m https://raw.githubusercontent.com/Maestrano/maestrano-connector-rails/master/template/maestrano-connector-template.rb
 ```
 
 If and only if you have an error in the template's rails generate step, you'll need to re-run the following command in your project folder:
 ```console
 bundle
 rails g connector:install
-rails g delayed_job:active_record
 rake db:migrate
 ```
 
@@ -50,17 +51,18 @@ connec_api_id: 'API_ID'
 connec_api_key: 'API_KEY'
 ```
 
-The only other thing you need to do is to set your configuration in config/initializers/maestrano.rb. The one line you need to look for and change is:
+The next thing you need to do is to set your configuration in config/initializers/maestrano.rb. You will need to define where your application will be publicly hosted:
 ```ruby
 config.app.host = 'http://path_to_app'
 ```
 The rest of the config has default values, so you can take a look but you don't really need to change anything else.
+For a more detailed configuration, please refer to https://github.com/maestrano/maestrano-ruby#configuration
 
-Please note that the connectors support multi-tenancy, so you may have to set up configuration for tenant other than Maestrano (the default one).
+Please note that the connectors support multi-tenancy, so you may have to set up configuration for tenants other than the Maestrano platform (the default one).
 
-Those configuration are automatically retrieve by Maestrano via a metadata endpoint that is provided by the gem, so you're all setup as it is.
+These configuration are automatically retrieved by Maestrano via a metadata endpoint that is provided by the gem, so you're all setup as it is.
 
-Time to test! If your launch your application (please make sure that you launch the application on the same path as the one in the config file). If you click on the 'Link your Maestrano account' link on your connector home page, you should be able to do a full sso process with Maestrano.
+Time to test! If your launch your application (please make sure that you launch the application on the same path as the one in the config file). If you click on the 'Link your Maestrano account' link on your connector home page, you should be able to do a full SSO process with Maestrano.
 
 ### Integration with the external application
 
@@ -74,13 +76,13 @@ If all went well, you should now be able to use the 'Link this company to...' li
 
 ## Preparing synchronizations
 
-The aim of the connector is to perform synchronizations between Connec!™ and the external application, meaning fetching data on both ends, process them, and push the result to the relevant end. The Connec!™ part and the synchronization process itself is handle by the engine, so all you have to do is to implements some methods to work with the external application.
+The aim of the connector is to perform synchronizations between Connec!™ and the external application, meaning fetching data on both ends, process them, and push the result to the relevant parties. The Connec!™ part and the synchronization process itself is handled by the engine, so all you have to do is to implements some methods to bridge the calls to the external application.
 
-### External.rb
+### external.rb
 
-First file to look for is the external.rb class (in models/maestrano/connector/rails/). It contains two methods that you need to implements:
+First file to look for is `models/maestrano/connector/rails/external.rb`. It contains two methods that you need to implement:
 
-* external_name, which is used fr logging purpose only, and should only return the name of the external application, e.g.
+* external_name, which is used for logging purpose only, and should only return the name of the external application, e.g.
 ```ruby
 def self.external_name
   'This awesome CRM'
@@ -89,23 +91,23 @@ end
 * get_client, which should return either the external application gem api client, or, in the worst case, a custom HTTParty client.
 
 
-### Entity.rb
+### entity.rb
 
-The second important file is the entity.rb class (in the same folder). It contains a method to declare the entity synchronizable by your connector (more on that later), some methods to get and push data to the external application api, and lastly two methods to extract id and update date from the entity format sent by the external application.
+The second important file is `models/maestrano/connector/rails/entity.rb`. It contains a method to declare the entities synchronizable by your connector (more on that later), some methods to retrieve and send data to the external application API, and lastly two methods to extract `id` and `timestamps` from the entity format sent by the external application.
 
 The details of each methods are explained in the entity.rb file provided.
 
 ### Mapping entities
 
-Now that you're all setup with both Connec!™ and the external application, it's time to decide which entities (contacts, accounts, events, ...) you want to synchronize. For each type of entity your connector will synchronize, you will need to create a class that inherits from Maestrano::Connector::Rails::Entity.
+Now that you're all setup with both Connec!™ and the external application, it's time to decide which entities (contacts, accounts, events, ...) you want to synchronize. For each type of entity your connector will synchronize, you will need to create a class that inherits from `Maestrano::Connector::Rails::Entity`.
 
 An example of such a class in provided in the models/entities/ folder, and demonstrates which methods you'll need to implements for each entity. The main thing to do is the mapping between the external entity and the Connec!™ entity. For the mapping, we use the hash_mapper gem (<https://github.com/ismasan/hash_mapper>).
 
-This type of entity class enable 1 to 1 model correspondance. For more complex needs, please refer to the complex entity section below.
+This type of entity class enable one-to-one model correspondance. For more complex needs, please refer to the complex entity section below.
 
 You'll find the connec API documentation here: <http://maestrano.github.io/connec/>, and should also refer to the external application API documentation.
 
-Also don"t forget that each entity your connector synchronize should be declare in the entity.rb class, and, because the synchronizable entities are stored in th db for each organization, you'll need to create a migration for exisiting organization if you add an entity.
+Also don't forget that each entity your connector synchronize should be declared in the entity.rb class, and, because the synchronizable entities are stored in the local database for each organization, you'll need to create a migration for exisiting organization if you add an new entity.
 
 #### Overriding methods
 
@@ -141,11 +143,27 @@ The home and admin pages views and controllers are provided as example, but you
 
 ## Complex entities
 
-For more complex correspondances, like 1 to many or many to many ones, you can use the complex entity workflow. To see how it works, you can run
+For more complex correspondances, like one-to-many or many-to-many ones, you can use the complex entity workflow. To see how it works, you can run
 ```console
 rails g connector:complex_entity
 ```
 
-This will generate some example files demonstrating a 1 to 2 correspondance between Connec!™ person and external contact and lead data models.
+This will generate some example files demonstrating a one-to-many correspondance between Connec!™ person and external contact and lead data models.
 
 The complex entities workflow uses two methods to pre-process data which you have to implements for each complex entity (see contact_and_lead.rb). They are called before the mapping step, and you can use them to perform any data model specific operations.
+
+## Webhooks
+
+Connec!™ issues webhooks each time an entity is created or updated. This allows real time integration from Connec!™ to the application you're integrating with. All you have to do is subscribe to the webhooks on the entities your interested in (in your Maestrano.rb file), everything else is magically handled by the gem.
+
+If the application you're integrating with support webhooks, you can and should use them to allow a full real time integration. The gem provide a job to help you do that. It will perform the necessary checks, mappings and then push the entities to Connec!™. All you have to do is build a controller and config the necessary routes to catch the webhook, and call this job. For example:
+```ruby
+class ExternalWebhooksController < ApplicationController
+  def notification
+    organization = # find organization from webhook params
+    Maestrano::Connector::Rails::PushToConnecJob.perform_later(organization, params[:notif][:name], parmas[:notif][:objects])
+  end
+end
+```
+
+If you have questions, please contact the technical team <developers@maestrano.com>.

data/VERSION

@@ -1 +1 @@
-0.2.11
+0.2.12

data/app/controllers/maestrano/connec_controller.rb

@@ -45,16 +45,12 @@ class Maestrano::ConnecController < Maestrano::Rails::WebHookController
 
   private
     def find_entity_instance(entity_name)
-      if Maestrano::Connector::Rails::Entity.entities_list.include?(entity_name.singularize)
-        return {instance: "Entities::#{entity_name.singularize.titleize.split.join}".constantize.new, is_complex: false, name: entity_name.singularize}
-      else
-        Maestrano::Connector::Rails::Entity.entities_list.each do |entity_name_from_list|
-          instance = "Entities::#{entity_name_from_list.singularize.titleize.split.join}".constantize.new
-          if instance.methods.include?('connec_entities_names'.to_sym)
-            return {instance: instance, is_complex: true, name: entity_name_from_list} if instance.connec_entities_names.include?(entity_name.singularize)
-          elsif instance.methods.include?('connec_entity_name'.to_sym)
-            return {instance: instance, is_complex: false, name: entity_name_from_list} if instance.connec_entity_name == entity_name.singularize
-          end
+      Maestrano::Connector::Rails::Entity.entities_list.each do |entity_name_from_list|
+        instance = "Entities::#{entity_name_from_list.singularize.titleize.split.join}".constantize.new
+        if instance.methods.include?('connec_entities_names'.to_sym)
+          return {instance: instance, is_complex: true, name: entity_name_from_list} if instance.connec_entities_names.include?(entity_name.singularize)
+        elsif instance.methods.include?('connec_entity_name'.to_sym)
+          return {instance: instance, is_complex: false, name: entity_name_from_list} if instance.connec_entity_name == entity_name.singularize
         end
       end
       nil

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

@@ -0,0 +1,43 @@
+module Maestrano::Connector::Rails
+  class PushToConnecJob < ::ActiveJob::Base
+    queue_as :default
+
+    # expected hash: {"external_entity_name1" => [entity1, entity2], "external_entity_name2" => []}
+    def perform(organization, entities_hash)
+      return unless organization.sync_enabled && organization.oauth_uid
+
+      connec_client = Maestrano::Connec::Client.new(organization.uid)
+
+      entities_hash.each do |external_entity_name, entities|
+        if entity_instance_hash = find_entity_instance(external_entity_name)
+          entity_instance = entity_instance_hash[:instance]
+          next unless organization.synchronized_entities[entity_instance_hash[:name].to_sym]
+
+          if entity_instance_hash[:is_complex]
+            entities = Hash[ *entity_instance.external_entities_names.collect{|name| name == external_entity_name.singularize ? [name, entities] : [ name, []]}.flatten(1) ]
+            entity_instance.consolidate_and_map_data(Hash[ *entity_instance.connec_entities_names.collect{|name| [ name, []]}.flatten(1) ], entities, organization, {})
+          else
+            entity_instance.consolidate_and_map_data([], entities, organization, {})
+          end
+
+          entity_instance.push_entities_to_connec(connec_client, entities, organization)
+        else
+          Rails.logger.warn "Called push to connec job with unknow entity: #{external_entity_name}"
+        end
+      end
+    end
+
+    private
+      def find_entity_instance(entity_name)
+        Maestrano::Connector::Rails::Entity.entities_list.each do |entity_name_from_list|
+          instance = "Entities::#{entity_name_from_list.singularize.titleize.split.join}".constantize.new
+          if instance.methods.include?('external_entities_names'.to_sym)
+            return {instance: instance, is_complex: true, name: entity_name_from_list} if instance.external_entities_names.include?(entity_name.singularize)
+          elsif instance.methods.include?('external_entity_name'.to_sym)
+            return {instance: instance, is_complex: false, name: entity_name_from_list} if instance.external_entity_name == entity_name.singularize
+          end
+        end
+        nil
+      end
+  end
+end

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

@@ -59,7 +59,7 @@ module Maestrano::Connector::Rails
         ConnectorLogger.log('info', organization, "Discard Connec! #{connec_entity_name} : #{entity}")
         nil
       else
-        {entity: sub_entity_instance.map_to(external_entity_name, entity, organization), idmap: idmap || IdMap.create(connec_id: entity['id'], connec_entity: connec_entity_name.downcase, external_entity: external_entity_name.downcase, organization_id: organization.id)}
+        {entity: sub_entity_instance.map_to(external_entity_name, entity, organization), idmap: idmap || IdMap.create(connec_id: entity['id'], connec_entity: connec_entity_name.downcase, external_entity: external_entity_name.downcase, organization_id: organization.id, name: sub_entity_instance.object_name_from_connec_entity_hash(entity))}
       end
     end
 
@@ -99,7 +99,7 @@ module Maestrano::Connector::Rails
 
             # No idmap: creating one, nothing else to do
             unless idmap
-              next {entity: sub_entity_instance.map_to(connec_entity_name, entity, organization), idmap: IdMap.create(external_id: sub_entity_instance.get_id_from_external_entity_hash(entity), external_entity: external_entity_name.downcase, connec_entity: connec_entity_name.downcase, organization_id: organization.id)}
+              next {entity: sub_entity_instance.map_to(connec_entity_name, entity, organization), idmap: IdMap.create(external_id: sub_entity_instance.get_id_from_external_entity_hash(entity), external_entity: external_entity_name.downcase, connec_entity: connec_entity_name.downcase, organization_id: organization.id, name: sub_entity_instance.object_name_from_external_entity_hash(entity))}
             end
 
             # Entity has not been modified since its last push to connec!

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

@@ -118,7 +118,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
       Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Discard Connec! #{self.connec_entity_name} : #{entity}")
       nil
     else
-      {entity: self.map_to_external(entity, organization), idmap: idmap || Maestrano::Connector::Rails::IdMap.create(connec_id: entity['id'], connec_entity: self.connec_entity_name.downcase, organization_id: organization.id)}
+      {entity: self.map_to_external(entity, organization), idmap: idmap || Maestrano::Connector::Rails::IdMap.create(connec_id: entity['id'], connec_entity: self.connec_entity_name.downcase, organization_id: organization.id, name: object_name_from_connec_entity_hash(entity))}
     end
   end
 
@@ -189,7 +189,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
 
       # No idmap: creating one, nothing else to do
       unless idmap
-        next {entity: self.map_to_connec(entity, organization), idmap: Maestrano::Connector::Rails::IdMap.create(external_id: self.get_id_from_external_entity_hash(entity), external_entity: self.external_entity_name.downcase, organization_id: organization.id)}
+        next {entity: self.map_to_connec(entity, organization), idmap: Maestrano::Connector::Rails::IdMap.create(external_id: self.get_id_from_external_entity_hash(entity), external_entity: self.external_entity_name.downcase, organization_id: organization.id, name: self.object_name_from_external_entity_hash(entity))}
       end
 
       # Not pushing entity to Connec!
@@ -234,7 +234,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
   #             Entity specific methods
   # Those methods need to be define in each entity
   # ----------------------------------------------
-  
+
   # Entity name in Connec!
   def connec_entity_name
     raise "Not implemented"
@@ -249,4 +249,14 @@ module Maestrano::Connector::Rails::Concerns::Entity
   def mapper_class
     raise "Not implemented"
   end
+
+  # Return a string representing the object from a connec! entity hash
+  def object_name_from_connec_entity_hash(entity)
+    raise "Not implemented"
+  end
+
+  # Return a string representing the object from an external entity hash
+  def object_name_from_external_entity_hash(entity)
+    raise "Not implemented"
+  end
 end

data/lib/generators/connector/install_generator.rb

@@ -4,8 +4,7 @@ module Connector
       source_root File.expand_path("../templates", __FILE__)
 
       def maestrano_generator
-        #Temporary
-        # generate 'maestrano:initializer'
+        generate 'maestrano:initializer'
       end
 
       def include_helpers

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

@@ -19,4 +19,12 @@
 #       raise "Impossible mapping from #{self.entity_name} to #{name}"
 #     end
 #   end
+
+#   def object_name_from_connec_entity_hash(entity)
+#     "#{entity['first_name']} #{entity['last_name']}"
+#   end
+
+#   def object_name_from_external_entity_hash(entity)
+#     "#{entity['FirstName']} #{entity['LastName']}"
+#   end
 # end

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

@@ -19,4 +19,12 @@
 #       raise "Impossible mapping from #{self.entity_name} to #{name}"
 #     end
 #   end
+
+#   def object_name_from_connec_entity_hash(entity)
+#     "#{entity['first_name']} #{entity['last_name']}"
+#   end
+
+#   def object_name_from_external_entity_hash(entity)
+#     "#{entity['FirstName']} #{entity['LastName']}"
+#   end
 # end

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

@@ -20,4 +20,12 @@
 #       raise "Impossible mapping from #{self.entity_name} to #{name}"
 #     end
 #   end
+
+#   def object_name_from_connec_entity_hash(entity)
+#     "#{entity['first_name']} #{entity['last_name']}"
+#   end
+
+#   def object_name_from_external_entity_hash(entity)
+#     "#{entity['FirstName']} #{entity['LastName']}"
+#   end
 # end

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

@@ -15,6 +15,15 @@
 #   def mapper_class
 #     ExampleEntityMapper
 #   end
+
+#   def object_name_from_connec_entity_hash(entity)
+#     "#{entity['first_name']} #{entity['last_name']}"
+#   end
+
+#   def object_name_from_external_entity_hash(entity)
+#     "#{entity['FirstName']} #{entity['LastName']}"
+#   end
+
 # end
 
 # class ExampleEntityMapper

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.11 ruby lib
+# stub: maestrano-connector-rails 0.2.12 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "maestrano-connector-rails"
-  s.version = "0.2.11"
+  s.version = "0.2.12"
 
   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-02-15"
+  s.date = "2016-03-02"
   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"]
@@ -36,6 +36,7 @@ Gem::Specification.new do |s|
     "app/controllers/maestrano/sessions_controller.rb",
     "app/helpers/maestrano/connector/rails/session_helper.rb",
     "app/jobs/maestrano/connector/rails/all_synchronizations_job.rb",
+    "app/jobs/maestrano/connector/rails/push_to_connec_job.rb",
     "app/jobs/maestrano/connector/rails/synchronization_job.rb",
     "app/models/maestrano/connector/rails/complex_entity.rb",
     "app/models/maestrano/connector/rails/concerns/entity.rb",
@@ -138,6 +139,7 @@ Gem::Specification.new do |s|
     "spec/dummy/public/favicon.ico",
     "spec/factories.rb",
     "spec/jobs/all_syncrhonizations_job_spec.rb",
+    "spec/jobs/push_to_connec_job_spec.rb",
     "spec/jobs/syncrhonization_job_spec.rb",
     "spec/models/complex_entity_spec.rb",
     "spec/models/connector_logger_spec.rb",

data/spec/controllers/connec_controller_spec.rb

@@ -83,6 +83,9 @@ 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
+              'person'
+            end
           end
         }
 

data/spec/jobs/push_to_connec_job_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe Maestrano::Connector::Rails::PushToConnecJob do
+  let(:organization) { create(:organization) }
+  let(:entity_name1) { 'entity1' }
+  let(:entity_name2) { 'entity2' }
+  before {
+    class Entities::Entity1 < Maestrano::Connector::Rails::Entity
+      def map_to_connec(entity, organization)
+        entity
+      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')
+    class Entities::Entity2 < Maestrano::Connector::Rails::ComplexEntity
+    end
+    allow_any_instance_of(Entities::Entity2).to receive(:consolidate_and_map_data)
+    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(sub 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')
+  }
+  let(:entity11) { {first_name: 'John'} }
+  let(:entity12) { {first_name: 'Jane'} }
+  let(:entity21) { {job: 'Pizza guy'} }
+  let(:hash) { {'ext_entity1' => [entity11, entity12], 'sub' => [entity21]} }
+  subject { Maestrano::Connector::Rails::PushToConnecJob.perform_now(organization, hash) }
+
+  describe 'with organization sync enabled set to false' do
+    before { organization.update(sync_enabled: false, oauth_uid: 'lala') }
+
+    it 'does nothing' do
+      expect(Maestrano::Connec::Client).to_not receive(:new)
+      subject
+    end
+  end
+
+  describe 'with no oauth uid' do
+    before { organization.update(sync_enabled: true, oauth_uid: nil) }
+
+    it 'does nothing' do
+      expect(Maestrano::Connec::Client).to_not receive(:new)
+      subject
+    end
+  end
+
+  describe 'with sync enabled and an oauth uid' do
+    before { organization.update(sync_enabled: true, oauth_uid: 'lala') }
+
+    describe 'with a non existing entity' do
+      let(:hash) { {'lala' => []} }
+
+      it 'logs a warning' do
+        expect(Rails.logger).to receive(:warn)
+        subject
+      end
+    end
+
+    describe 'with entities in syncrhonized entities' do
+
+      describe 'complex entity' do
+        before { organization.update(synchronized_entities: {:"#{entity_name1}" => false, :"#{entity_name2}" => true})}
+
+        it 'calls consolidate and map data on the complex entity with the right arguments' do
+          expect_any_instance_of(Entities::Entity2).to receive(:consolidate_and_map_data).with({}, {"sub"=>[entity21], "ll"=>[]}, organization, {})
+          expect_any_instance_of(Entities::Entity2).to receive(:push_entities_to_connec)
+          subject
+        end
+
+        it 'does not calls methods on the non complex entity' do
+          expect_any_instance_of(Entities::Entity1).to_not receive(:consolidate_and_map_data)
+          subject
+        end
+      end
+
+      describe 'non complex entity' do
+        before { organization.update(synchronized_entities: {:"#{entity_name1}" => true, :"#{entity_name2}" => false})}
+
+        it 'calls consolidate_and_map_data on the non complex entity with the right arguments' do
+          expect_any_instance_of(Entities::Entity1).to receive(:consolidate_and_map_data).with([], [entity11, entity12], organization, {})
+          expect_any_instance_of(Entities::Entity1).to receive(:push_entities_to_connec)
+          subject
+        end
+
+        it 'does not calls methods on the complex entity' do
+          allow_any_instance_of(Entities::Entity1).to receive(:consolidate_and_map_data)
+          expect_any_instance_of(Entities::Entity2).to_not receive(:consolidate_and_map_data)
+          subject
+        end
+      end
+    end
+  end
+end

data/spec/models/complex_entity_spec.rb

@@ -29,8 +29,10 @@ describe Maestrano::Connector::Rails::ComplexEntity do
       let(:connec_name) { 'connec_name' }
       let(:external_name) { 'external_name' }
       let(:sub_instance) { Maestrano::Connector::Rails::SubEntityBase.new }
+      let(:human_name) { 'ET' }
       before {
         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)
       }
 
       context 'when entity has no idmap' do
@@ -185,6 +187,12 @@ describe Maestrano::Connector::Rails::ComplexEntity do
         }
 
         context 'when entities have no idmaps' do
+          let(:human_name) { 'Jabba' }
+          before {
+            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)
+          }
+
           it 'creates an idmap for each entity' do
             expect{
               subject.consolidate_and_map_data({}, external_hash, organization, opt)

data/spec/models/entity_spec.rb

@@ -227,12 +227,20 @@ describe Maestrano::Connector::Rails::Entity do
 
         context 'when entity has no idmap' do
           let(:entity) { {'id' => id, 'name' => 'John', 'updated_at' => 5.hour.ago } }
+          before {
+            allow(subject).to receive(:object_name_from_connec_entity_hash).and_return('human readable stuff')
+          }
 
           it { expect{ subject.map_to_external_with_idmap(entity, organization) }.to change{Maestrano::Connector::Rails::IdMap.count}.by(1) }
 
           it 'returns the entity with its new idmap' do
             expect(subject.map_to_external_with_idmap(entity, organization)).to eql({entity: mapped_entity, idmap: Maestrano::Connector::Rails::IdMap.last})
           end
+
+          it 'save the entity name in the idmap' do
+            subject.map_to_external_with_idmap(entity, organization)
+            expect(Maestrano::Connector::Rails::IdMap.last.name).to eql('human readable stuff')
+          end
         end
       end
     end
@@ -360,10 +368,20 @@ describe Maestrano::Connector::Rails::Entity do
         }
 
         context 'when entity has no idmap' do
+          let(:human_name) { 'alien' }
+          before {
+            allow(subject).to receive(:object_name_from_external_entity_hash).and_return(human_name)
+          }
+
           it 'creates an idmap and returns the mapped entity with its new idmap' do
             subject.consolidate_and_map_data([], entities, organization)
             expect(entities).to eql([{entity: mapped_entity, idmap: Maestrano::Connector::Rails::IdMap.last}])
           end
+
+          it 'save the name in the idmap' do
+            subject.consolidate_and_map_data([], entities, organization)
+            expect(Maestrano::Connector::Rails::IdMap.last.name).to eql(human_name)
+          end
         end
 
         context 'when entity has an idmap with a last_push_to_connec more recent than date' do
@@ -452,6 +470,14 @@ describe Maestrano::Connector::Rails::Entity do
     describe 'mapper_class' do
       it { expect{ subject.mapper_class }.to raise_error('Not implemented') }
     end
+
+    describe 'object_name_from_connec_entity_hash' do
+      it { expect{ subject.object_name_from_connec_entity_hash({}) }.to raise_error('Not implemented') }
+    end
+
+    describe 'object_name_from_external_entity_hash' do
+      it { expect{ subject.object_name_from_external_entity_hash({}) }.to raise_error('Not implemented') }
+    end
   end
 
 end

data/template/maestrano-connector-template.rb

@@ -29,6 +29,18 @@ run 'touch Gemfile'
 
 add_source 'https://rubygems.org'
 
+if yes?("Use JRuby? [y/n]")
+  run 'echo "ruby \'2.2.2\', :engine => \'jruby\', :engine_version => \'9.0.4.0\'" | cat - Gemfile > temp && mv temp Gemfile'
+  gem_group :production do
+    gem 'activerecord-jdbcpostgresql-adapter'
+  end
+  gem_group :test, :develpment do
+    gem 'activerecord-jdbcsqlite3-adapter'
+  end
+else
+  gem 'sqlite3'
+end
+
 gem 'rails', '4.2.4'
 gem 'turbolinks'
 gem 'jquery-rails'
@@ -39,7 +51,6 @@ gem 'tzinfo-data', platforms: [:mingw, :mswin, :jruby]
 gem 'maestrano-connector-rails'
 gem 'delayed_job_active_record'
 
-gem 'sqlite3'
 
 gem_group :test do
   gem 'simplecov'
@@ -71,7 +82,6 @@ after_bundle do
   RUBY
   end
 
-  run 'rails g maestrano:initializer'
   run 'rails g connector:install'
   run 'bundle exec figaro install'
   run 'rake railties:install:migrations'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maestrano-connector-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.12
 platform: ruby
 authors:
 - Pierre Berard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-15 00:00:00.000000000 Z
+date: 2016-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: maestrano-rails
@@ -204,6 +204,7 @@ files:
 - app/controllers/maestrano/sessions_controller.rb
 - app/helpers/maestrano/connector/rails/session_helper.rb
 - app/jobs/maestrano/connector/rails/all_synchronizations_job.rb
+- app/jobs/maestrano/connector/rails/push_to_connec_job.rb
 - app/jobs/maestrano/connector/rails/synchronization_job.rb
 - app/models/maestrano/connector/rails/complex_entity.rb
 - app/models/maestrano/connector/rails/concerns/entity.rb
@@ -306,6 +307,7 @@ files:
 - spec/dummy/public/favicon.ico
 - spec/factories.rb
 - spec/jobs/all_syncrhonizations_job_spec.rb
+- spec/jobs/push_to_connec_job_spec.rb
 - spec/jobs/syncrhonization_job_spec.rb
 - spec/models/complex_entity_spec.rb
 - spec/models/connector_logger_spec.rb