maestrano-connector-rails 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f35f9299a109e93d0c7028759a390d44dd7bff6c
-  data.tar.gz: 0e4695072a4fa120a03195bd405f459ff37025f4
+  metadata.gz: 5f9df8b9e24a3d6b1616c9bb26b59aa2a09d4de3
+  data.tar.gz: 4f3c29cd00285f933969bf2fe808bf88ba908004
 SHA512:
-  metadata.gz: fd0dff595ef6a407c615d2aa25f3ceb63a74416fece30e9f7332c00c964f991989ffb184b69537f910a662f941b7919750d4c2f75b8fcfcc47f2f80c0bbf47d9
-  data.tar.gz: d656df9663e232ec8f6c805353cffe338961d79c200e31ed2526ce8d3c0e6298fb4f9698543c7d8ebd91c2412645410ece0e4560ca57d235e38ca3700679bb6e
+  metadata.gz: ce9beb1f11f820f1804b2b35f77cc402ff02e1976d70e5dc4ff49b1bbf25786efb5b0090e16ad59c93d90dfa6d0e0dac80800cfa2375887775b35a9ecd5489c5
+  data.tar.gz: 401b8a68a25e374ba92b4b099c00e183f304af587c8952d7dca0bbb61be79586b9bb41a101afc02614dc4751986bec529d323df7df008fe8cb75487e4813afd8

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

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

@@ -161,4 +161,12 @@ module Maestrano::Connector::Rails::Concerns::ComplexEntity
       end
     end
   end
+
+  def before_sync(connec_client, external_client, last_synchronization, organization, opts)
+    # Does nothing by default
+  end
+
+  def after_sync(connec_client, external_client, last_synchronization, organization, opts)
+    # Does nothing by default
+  end
 end

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

@@ -115,6 +115,30 @@ module Maestrano::Connector::Rails::Concerns::Entity
     def references
       []
     end
+
+    def can_read_connec?
+      true
+    end
+
+    def can_read_external?
+      true
+    end
+
+    def can_write_connec?
+      true
+    end
+
+    def can_write_external?
+      true
+    end
+
+    def can_update_connec?
+      true
+    end
+
+    def can_update_external?
+      true
+    end
   end
 
   # ----------------------------------------------
@@ -144,6 +168,8 @@ module Maestrano::Connector::Rails::Concerns::Entity
   #                 Connec! methods
   # ----------------------------------------------
   def get_connec_entities(client, last_synchronization, organization, opts={})
+    return [] unless self.class.can_read_connec?
+
     Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Fetching Connec! #{self.class.connec_entity_name}")
 
     entities = []
@@ -194,6 +220,8 @@ module Maestrano::Connector::Rails::Concerns::Entity
   end
 
   def push_entities_to_connec_to(connec_client, mapped_external_entities_with_idmaps, connec_entity_name, organization)
+    return unless self.class.can_write_connec?
+
     Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Sending #{Maestrano::Connector::Rails::External.external_name} #{self.class.external_entity_name.pluralize} to Connec! #{connec_entity_name.pluralize}")
     mapped_external_entities_with_idmaps.each do |mapped_external_entity_with_idmap|
       external_entity = mapped_external_entity_with_idmap[:entity]
@@ -204,6 +232,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
           connec_entity = create_connec_entity(connec_client, external_entity, self.class.normalize_connec_entity_name(connec_entity_name), organization)
           idmap.update_attributes(connec_id: connec_entity['id'], last_push_to_connec: Time.now, message: nil)
         else
+          next unless self.class.can_update_connec?
           connec_entity = update_connec_entity(connec_client, external_entity, idmap.connec_id, self.class.normalize_connec_entity_name(connec_entity_name), organization)
           idmap.update_attributes(last_push_to_connec: Time.now, message: nil)
         end
@@ -224,6 +253,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
   end
 
   def update_connec_entity(connec_client, mapped_external_entity, connec_id, connec_entity_name, organization)
+
     Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Sending update #{connec_entity_name}: #{mapped_external_entity} to Connec!")
     response = connec_client.put("/#{connec_entity_name}/#{connec_id}", { "#{connec_entity_name}".to_sym => mapped_external_entity })
     response = JSON.parse(response.body)
@@ -251,6 +281,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
   #                 External methods
   # ----------------------------------------------
   def get_external_entities(client, last_synchronization, organization, opts={})
+    return [] unless self.class.can_read_external?
     Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Fetching #{Maestrano::Connector::Rails::External.external_name} #{self.class.external_entity_name.pluralize}")
     raise "Not implemented"
   end
@@ -260,6 +291,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
   end
 
   def push_entities_to_external_to(external_client, mapped_connec_entities_with_idmaps, external_entity_name, organization)
+    return unless self.class.can_write_external?
     Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Sending Connec! #{self.class.connec_entity_name.pluralize} to #{Maestrano::Connector::Rails::External.external_name} #{external_entity_name.pluralize}")
     mapped_connec_entities_with_idmaps.each do |mapped_connec_entity_with_idmap|
       push_entity_to_external(external_client, mapped_connec_entity_with_idmap, external_entity_name, organization)
@@ -275,6 +307,7 @@ module Maestrano::Connector::Rails::Concerns::Entity
         external_id = create_external_entity(external_client, connec_entity, external_entity_name, organization)
         idmap.update_attributes(external_id: external_id, last_push_to_external: Time.now, message: nil)
       else
+        return unless self.class.can_update_external?
         update_external_entity(external_client, connec_entity, idmap.external_id, external_entity_name, organization)
         idmap.update_attributes(last_push_to_external: Time.now, message: nil)
       end

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

@@ -14,21 +14,22 @@ class Maestrano::Connector::Rails::Entity
 
   # Return an array of entities from the external app
   def get_external_entities(client, last_synchronization, organization, opts={})
-    Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Fetching #{@@external_name} #{self.external_entity_name.pluralize}")
+    return [] unless self.class.can_read_external?
+    Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Fetching #{Maestrano::Connector::Rails::External.external_name} #{self.external_entity_name.pluralize}")
     # TODO
     # This method should return only entities that have been updated since the last_synchronization
     # It should also implements an option to do a full synchronization when opts[:full_sync] == true or when there is no last_synchronization
-    # Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Received data: Source=#{@@external_name}, Entity=#{self.external_entity_name}, Response=#{entities}")
+    # Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Received data: Source=#{Maestrano::Connector::Rails::External.external_name}, Entity=#{self.external_entity_name}, Response=#{entities}")
   end
 
   def create_external_entity(client, mapped_connec_entity, external_entity_name, organization)
-    Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Sending create #{external_entity_name}: #{mapped_connec_entity} to #{@@external_name}")
+    Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Sending create #{external_entity_name}: #{mapped_connec_entity} to #{Maestrano::Connector::Rails::External.external_name}")
     # TODO
     # This method creates the entity in the external app and returns the external id
   end
 
   def update_external_entity(client, mapped_connec_entity, external_id, external_entity_name, organization)
-    Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Sending update #{external_entity_name} (id=#{external_id}): #{mapped_connec_entity} to #{@@external_name}")
+    Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Sending update #{external_entity_name} (id=#{external_id}): #{mapped_connec_entity} to #{Maestrano::Connector::Rails::External.external_name}")
     # TODO
     # This method updates the entity with the given id in the external app
   end

data/maestrano-connector-rails.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: maestrano-connector-rails 0.3.3 ruby lib
+# stub: maestrano-connector-rails 0.3.4 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "maestrano-connector-rails"
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
@@ -153,9 +153,9 @@ Gem::Specification.new do |s|
     "spec/dummy/public/500.html",
     "spec/dummy/public/favicon.ico",
     "spec/factories.rb",
-    "spec/jobs/all_syncrhonizations_job_spec.rb",
+    "spec/jobs/all_synchronizations_job_spec.rb",
     "spec/jobs/push_to_connec_job_spec.rb",
-    "spec/jobs/syncrhonization_job_spec.rb",
+    "spec/jobs/synchronization_job_spec.rb",
     "spec/models/complex_entity_spec.rb",
     "spec/models/connector_logger_spec.rb",
     "spec/models/entity_spec.rb",

data/spec/jobs/{syncrhonization_job_spec.rb → synchronization_job_spec.rb}

@@ -50,22 +50,42 @@ describe Maestrano::Connector::Rails::SynchronizationJob do
   end
 
   describe 'sync_entity' do
-    before {
-      class Entities::Person < Maestrano::Connector::Rails::Entity
+    subject { Maestrano::Connector::Rails::SynchronizationJob.new }
+
+    context 'non complex entity' do
+      before {
+        class Entities::Person < Maestrano::Connector::Rails::Entity
+        end
+      }
+
+      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
 
-    subject { Maestrano::Connector::Rails::SynchronizationJob.new }
+    context 'complex entity' do
+      before {
+        class Entities::SomeStuff < Maestrano::Connector::Rails::ComplexEntity
+        end
+      }
 
-    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, {})
+      it 'calls the seven methods' do
+        expect_any_instance_of(Entities::SomeStuff).to receive(:before_sync)
+        expect_any_instance_of(Entities::SomeStuff).to receive(:get_connec_entities)
+        expect_any_instance_of(Entities::SomeStuff).to receive(:get_external_entities)
+        expect_any_instance_of(Entities::SomeStuff).to receive(:consolidate_and_map_data).and_return({})
+        expect_any_instance_of(Entities::SomeStuff).to receive(:push_entities_to_external)
+        expect_any_instance_of(Entities::SomeStuff).to receive(:push_entities_to_connec)
+        expect_any_instance_of(Entities::SomeStuff).to receive(:after_sync)
+        subject.sync_entity('some stuff', organization, nil, nil, nil, {})
+      end
     end
   end
 end

data/spec/models/entity_spec.rb

@@ -186,6 +186,14 @@ describe Maestrano::Connector::Rails::Entity do
       }
 
       describe 'get_connec_entities' do
+        describe 'when write only' do
+          before {
+            allow(subject.class).to receive(:can_read_connec?).and_return(false)
+            allow(client).to receive(:get).and_return(ActionDispatch::Response.new(200, {}, {people: [{first_name: 'Lea'}]}.to_json, {}))
+          }
+
+          it { expect(subject.get_connec_entities(client, nil, organization)).to eql([]) }
+        end
 
         describe 'with response' do
           context 'for a singleton resource' do
@@ -276,6 +284,29 @@ describe Maestrano::Connector::Rails::Entity do
         let(:entities_with_idmaps) { [entity_with_idmap1, entity_with_idmap2] }
         let(:id) { 'ab12-34re' }
 
+        context 'when read only' do
+          before {
+            allow(subject.class).to receive(:can_write_connec?).and_return(false)
+          }
+
+          it 'does nothing' do
+            expect(subject).to_not receive(:create_connec_entity)
+            expect(subject).to_not receive(:update_connec_entity)
+            subject.push_entities_to_connec_to(client, entities_with_idmaps, connec_name, organization)
+          end
+        end
+
+        context 'when create_only' do
+          before {
+            allow(subject.class).to receive(:can_update_connec?).and_return(false)
+          }
+          it 'calls create only' do
+            expect(subject).to receive(:create_connec_entity).with(client, entity2, connec_name.downcase.pluralize, organization)
+            expect(subject).to_not receive(:update_connec_entity)
+            subject.push_entities_to_connec_to(client, entities_with_idmaps, connec_name, organization)
+          end
+        end
+
         it 'create or update the entities and idmaps according to their idmap state' do
           allow(subject).to receive(:create_connec_entity).and_return({'id' => id})
           allow(subject).to receive(:external_entity_name).and_return(external_name)
@@ -421,6 +452,14 @@ describe Maestrano::Connector::Rails::Entity do
       end
 
       describe 'push_entities_to_external_to' do
+        context 'when read only' do
+          it 'does nothing' do
+            allow(subject.class).to receive(:can_write_external?).and_return(false)
+            expect(subject).to_not receive(:push_entity_to_external)
+            subject.push_entities_to_external_to(nil, entities_with_idmaps, external_name, organization)
+          end
+        end
+
         it 'calls push_entity_to_external for each entity' do
           allow(subject.class).to receive(:connec_entity_name).and_return(connec_name)
           expect(subject).to receive(:push_entity_to_external).twice
@@ -430,6 +469,12 @@ describe Maestrano::Connector::Rails::Entity do
 
       describe 'push_entity_to_external' do
         context 'when the entity idmap has an external id' do
+          it 'does not calls update if create_only' do
+            allow(subject.class).to receive(:can_update_external?).and_return(false)
+            expect(subject).to_not receive(:update_external_entity)
+            subject.push_entity_to_external(nil, entity_with_idmap1, external_name, organization)
+          end
+
           it 'calls update_external_entity' do
             expect(subject).to receive(:update_external_entity).with(nil, entity1, idmap1.external_id, external_name, organization)
             subject.push_entity_to_external(nil, entity_with_idmap1, external_name, organization)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maestrano-connector-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Pierre Berard
@@ -363,9 +363,9 @@ files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/factories.rb
-- spec/jobs/all_syncrhonizations_job_spec.rb
+- spec/jobs/all_synchronizations_job_spec.rb
 - spec/jobs/push_to_connec_job_spec.rb
-- spec/jobs/syncrhonization_job_spec.rb
+- spec/jobs/synchronization_job_spec.rb
 - spec/models/complex_entity_spec.rb
 - spec/models/connector_logger_spec.rb
 - spec/models/entity_spec.rb