maestrano-connector-rails 0.0.1

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

@@ -0,0 +1,48 @@
+# TODO
+# This controller is given as an example of a possible admin implementation
+# The admin functions should be restricted to admin users
+# Admin funcitons :
+#  * Link account to external application
+#  * Disconnect account from external application
+#  * Launch a manual syncrhonization for all entities or a sub-part of them
+#  * Chose which entities are synchronized by the connector
+#  * Access a list of the organization's idmaps
+class AdminController < ApplicationController
+
+  def index
+    if is_admin
+      @organization = current_organization
+      @idmaps = Maestrano::Connector::Rails::IdMap.where(organization_id: @organization.id).order(:connec_entity)
+    end
+  end
+
+  def update
+    organization = Maestrano::Connector::Rails::Organization.find_by_id(params[:id])
+
+    if organization && is_admin?(current_user, organization)
+      organization.synchronized_entities.keys.each do |entity|
+        if !!params["#{entity}"]
+          organization.synchronized_entities[entity] = true
+        else
+          organization.synchronized_entities[entity] = false
+        end
+      end
+      organization.save
+    end
+
+    redirect_to admin_index_path
+  end
+
+  def synchronize
+    if is_admin
+      Delayed::Job.enqueue Maestrano::Connector::Rails::SynchronizationJob.new(current_organization, params['opts'] || {})
+    end
+
+    redirect_to root_path
+  end
+
+  private
+    def is_admin
+      current_user && current_organization && is_admin?(current_user, current_organization)
+    end
+end

data/lib/generators/connector/templates/admin_index.html.erb

@@ -0,0 +1,51 @@
+<!-- TODO -->
+<!-- This template is given as an example of the informations
+and functions available on the admin panel -->
+<!-- This view is designed according to the admin controller supplied -->
+<div class='admin'>
+  <% unless @organization %>
+    <p> You need to be Admin or Super Admin in your company to access this panel.</p>
+  <% else %>
+    <ul>
+      <li>
+        Maestrano account
+        <%= link_to "Disconnect your Maestrano account", maestrano_connector_rails.signout_path %>
+      </li>
+
+      <li>
+        External account
+        <% if @organization.oauth_uid %>
+          <%= link_to "Disconnect #{@organization.name} (#{@organization.uid})", 'some_path' %>
+        <% else %>
+          <%= link_to "Connect #{@organization.name} (#{@organization.uid})", 'some_other_path' %>
+        <% end %>
+      </li>
+
+      <li>
+        <%= link_to "Force a synchronization", admin_synchronize_path, method: :post %>
+      </li>
+    </ul>
+
+    <h3>Synchronized entities</h3>
+    <p>You can customize which entities are synchronized by the connector.</p>
+    <%= form_tag admin_update_path(id: @organization.id), method: :put do %>
+      <% @organization.synchronized_entities.each do |k, v| %>
+          <label for="<%= k %>">#{k.to_s.humanize}</label>
+          <input checked="<%= v %>" id="<%= k %>" name="<%= k %>" type="checkbox"></input>
+          <% if v  && @organization.oauth_uid %>
+            <%= link_to "Force a synchronization for #{k.to_s.pluralize} only", admin_synchronize_path(opts: {only_entities: [k.to_s]}), method: :post %>
+          <% end %>
+      <% end %>
+      <%= submit_tag :Update%>
+    <% end %>
+
+    <h3>IdMap</h3>
+    <% @idmaps.each do |idmap| %>
+      <%= idmap.connec_entity ? idmap.connec_entity.humanize : nil %>
+      <%= idmap.connec_id %>
+      <%= idmap.external_entity ? idmap.external_entity.humanize : nil %>
+      <%= idmap.external_id %>
+    <% end %>
+
+  <% end %>
+</div>

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

@@ -0,0 +1,22 @@
+# TODO
+# This file is provided as an example and should be removed
+# See README for explanation
+# class Entities::SubEntities::Contact < Maestrano::Connector::Rails::SubEntityBase
+
+#   def external?
+#     true
+#   end
+
+#   def entity_name
+#     'contact'
+#   end
+
+#   def map_to(name, entity, organization)
+#     case name
+#     when 'person'
+#       Entities::SubEntities::ContactMapper.denormalize(entity)
+#     else
+#       raise "Impossible mapping from #{self.entity_name} to #{name}"
+#     end
+#   end
+# end

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

@@ -0,0 +1,56 @@
+# TODO
+# 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
+#     %w(person)
+#   end
+
+#   def external_entities_names
+#     %w(contact lead)
+#   end
+
+#   # input :  {
+#   #             connec_entity_names[0]: [unmapped_connec_entitiy1, unmapped_connec_entitiy2],
+#   #             connec_entity_names[1]: [unmapped_connec_entitiy3, unmapped_connec_entitiy4]
+#   #          }
+#   # output : {
+#   #             connec_entity_names[0]: {
+#   #               external_entities_names[0]: [unmapped_connec_entitiy1, unmapped_connec_entitiy2]
+#   #             },
+#   #             connec_entity_names[1]: {
+#   #               external_entities_names[0]: [unmapped_connec_entitiy3],
+#   #               external_entities_names[1]: [unmapped_connec_entitiy4]
+#   #             }
+#   #          }
+#   def connec_model_to_external_model!(connec_hash_of_entities)
+#     people = connec_hash_of_entities['person']
+#     connec_hash_of_entities['person'] = { 'lead' => [], 'contact' => [] }
+
+#     people.each do |person|
+#       if person['is_lead']
+#         connec_hash_of_entities['person']['lead'] << person
+#       else
+#         connec_hash_of_entities['person']['contact'] << person
+#       end
+#     end
+#   end
+
+#   # input :  {
+#   #             external_entities_names[0]: [unmapped_external_entity1, unmapped_external_entity2],
+#   #             external_entities_names[1]: [unmapped_external_entity3, unmapped_external_entity4]
+#   #          }
+#   # output : {
+#   #             external_entities_names[0]: {
+#   #               connec_entity_names[0]: [unmapped_external_entity1],
+#   #               connec_entity_names[1]: [unmapped_external_entity2]
+#   #             },
+#   #             external_entities_names[1]: {
+#   #               connec_entity_names[0]: [unmapped_external_entity3, unmapped_external_entity4]
+#   #             }
+#   #           }
+#   def external_model_to_connec_model!(external_hash_of_entities)
+#     external_hash_of_entities['lead'] = { 'person' => external_hash_of_entities['lead'] }
+#     external_hash_of_entities['contact'] = { 'person' => external_hash_of_entities['contact'] }
+#   end
+# end

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

@@ -0,0 +1,17 @@
+# TODO
+# This file is provided as an example and should be removed
+# See README for explanation
+# class Entities::SubEntities::ContactMapper
+#   extend HashMapper
+
+#   map from('title'), to('Salutation')
+#   map from('first_name'), to('FirstName')
+#   map from('last_name'), to('LastName'), default: 'Undefined'
+#   map from('job_title'), to('Title')
+
+#   map from('address_work/billing/line1'), to('MailingStreet')
+#   map from('address_work/billing/city'), to('MailingCity')
+#   map from('address_work/billing/region'), to('MailingState')
+#   map from('address_work/billing/postal_code'), to('MailingPostalCode')
+#   map from('address_work/billing/country'), to('MailingCountry')
+# end

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

@@ -0,0 +1,22 @@
+# TODO
+# This file is provided as an example and should be removed
+# See README for explanation
+# class Entities::SubEntities::Lead < Maestrano::Connector::Rails::SubEntityBase
+
+#   def external?
+#     true
+#   end
+
+#   def entity_name
+#     'lead'
+#   end
+
+#   def map_to(name, entity, organization)
+#     case name
+#     when 'person'
+#       Entities::SubEntities::LeadMapper.denormalize(entity).merge(is_lead: true)
+#     else
+#       raise "Impossible mapping from #{self.entity_name} to #{name}"
+#     end
+#   end
+# end

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

@@ -0,0 +1,15 @@
+# TODO
+# This file is provided as an example and should be removed
+# See README for explanation
+# class Entities::SubEntities::LeadMapper
+#   extend HashMapper
+
+#   map from('title'), to('Salutation')
+#   map from('first_name'), to('FirstName')
+#   map from('last_name'), to('LastName'), default: 'Undefined'
+#   map from('job_title'), to('Title')
+
+#   map from('lead_source'), to('LeadSource')
+#   map from('lead_status'), to('Status')
+#   map from('lead_conversion_date'), to('ConvertedDate')
+# end

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

@@ -0,0 +1,23 @@
+# TODO
+# 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?
+#     false
+#   end
+
+#   def entity_name
+#     'person'
+#   end
+
+#   def map_to(name, entity, organization)
+#     case name
+#     when 'lead'
+#       Enities::SubEntities::LeadMapper.normalize(entity)
+#     when 'contact'
+#       Enities::SubEntities::ContactMapper.normalize(entity)
+#     else
+#       raise "Impossible mapping from #{self.entity_name} to #{name}"
+#     end
+#   end
+# end

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

@@ -0,0 +1,55 @@
+# TODO
+# This file is provided as an example and should be removed
+# class Entities::ContactAndLead < Maestrano::Connector::Rails::ComplexEntity
+#   def connec_entities_names
+#     %w(person)
+#   end
+
+#   def external_entities_names
+#     %w(contact lead)
+#   end
+
+#   # input :  {
+#   #             connec_entity_names[0]: [unmapped_connec_entitiy1, unmapped_connec_entitiy2],
+#   #             connec_entity_names[1]: [unmapped_connec_entitiy3, unmapped_connec_entitiy4]
+#   #          }
+#   # output : {
+#   #             connec_entity_names[0]: {
+#   #               external_entities_names[0]: [unmapped_connec_entitiy1, unmapped_connec_entitiy2]
+#   #             },
+#   #             connec_entity_names[1]: {
+#   #               external_entities_names[0]: [unmapped_connec_entitiy3],
+#   #               external_entities_names[1]: [unmapped_connec_entitiy4]
+#   #             }
+#   #          }
+#   def connec_model_to_external_model!(connec_hash_of_entities)
+#     people = connec_hash_of_entities['person']
+#     connec_hash_of_entities['person'] = { 'lead' => [], 'contact' => [] }
+
+#     people.each do |person|
+#       if person['is_lead']
+#         connec_hash_of_entities['person']['lead'] << person
+#       else
+#         connec_hash_of_entities['person']['contact'] << person
+#       end
+#     end
+#   end
+
+#   # input :  {
+#   #             external_entities_names[0]: [unmapped_external_entity1, unmapped_external_entity2],
+#   #             external_entities_names[1]: [unmapped_external_entity3, unmapped_external_entity4]
+#   #          }
+#   # output : {
+#   #             external_entities_names[0]: {
+#   #               connec_entity_names[0]: [unmapped_external_entity1],
+#   #               connec_entity_names[1]: [unmapped_external_entity2]
+#   #             },
+#   #             external_entities_names[1]: {
+#   #               connec_entity_names[0]: [unmapped_external_entity3, unmapped_external_entity4]
+#   #             }
+#   #           }
+#   def external_model_to_connec_model!(external_hash_of_entities)
+#     external_hash_of_entities['lead'] = { 'person' => external_hash_of_entities['lead'] }
+#     external_hash_of_entities['contact'] = { 'person' => external_hash_of_entities['contact'] }
+#   end
+# end

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

@@ -0,0 +1,48 @@
+class Maestrano::Connector::Rails::Entity
+  include Maestrano::Connector::Rails::Concerns::Entity
+
+  # Return an array of all the entities that the connector can synchronize
+  # If you add new entities, you need to generate
+  # a migration to add them to existing organizations
+  def self.entities_list
+    # TODO
+    # The names in this list should match the names of your entities class
+    # e.g %w(person, tasks_list)
+    #  will synchronized Entities::Person and Entities::TasksList
+    []
+  end
+
+  # 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}")
+    # 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}")
+  end
+
+  def create_entity_to_external(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}")
+    # TODO
+    # This method creates the entity in the external app and returns the external id
+  end
+
+  def update_entity_to_external(client, mapped_connec_entity, external_id, external_entity_name)
+    Maestrano::Connector::Rails::ConnectorLogger.log('info', organization, "Sending update #{external_entity_name} (id=#{external_id}): #{mapped_connec_entity} to #{@@external_name}")
+    # TODO
+    # This method updates the entity with the given id in the external app
+  end
+
+  def get_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)
+    # TODO
+    # This method return the last update date from an external_entity_hash
+    # e.g entity['last_update']
+  end
+
+end

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

@@ -0,0 +1,26 @@
+# TODO
+# This file is provided as an example and should be removed
+# One such file needs to be created for each synchronizable entity,
+# with its associated mapper
+
+# class Entities::ExampleEntity < Maestrano::Connector::Rails::Entity
+#   def connec_entity_name
+#     'ExampleEntity'
+#   end
+
+#   def external_entity_name
+#     'Contact'
+#   end
+
+#   def mapper_class
+#     ExampleEntityMapper
+#   end
+# end
+
+# class ExampleEntityMapper
+#   extend HashMapper
+
+#   map from('/title'), to('/Salutation')
+#   map from('/first_name'), to('/FirstName')
+#   map from('address_work/billing2/city'), to('City')
+# end

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

@@ -0,0 +1,19 @@
+class Maestrano::Connector::Rails::External
+  include Maestrano::Connector::Rails::Concerns::External
+
+  def self.external_name
+    # TODO
+    # Returns the name of the external app
+  end
+
+  def self.get_client(organization)
+    # TODO
+    # Returns a client for the external application for the given organization
+    # e.g
+    # SomeName.new :oauth_token => organization.oauth_token,
+    # refresh_token: organization.refresh_token,
+    # instance_url: organization.instance_url,
+    # client_id: ENV[''],
+    # client_secret: ENV['']
+  end
+end

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

@@ -0,0 +1,17 @@
+# TODO
+# This controller is given as an example of a possible home
+# Home funcitons :
+# * Display generic information about the connector (mostly for not connected users)
+# * Link the connector to a Maestrano organization
+# * Acces the last synchronization and a synchronization history (with their status)
+class HomeController < ApplicationController
+  def index
+    if current_user
+      @organization = current_organization
+
+      if @organization
+        @synchronizations = Maestrano::Connector::Rails::Synchronization.where(organization_id: @organization.id).order(updated_at: :desc).limit(40)
+      end
+    end
+  end
+end

data/lib/generators/connector/templates/home_index.html.erb

@@ -0,0 +1,42 @@
+<!-- TODO -->
+<!-- This template is given as an example of the informations that
+can be displayed on the home page -->
+<!-- This view is designed according to the home controller supplied -->
+<div class='home'>
+  <%= link_to 'Admin panel', admin_index_path %>
+  <% unless current_user %>
+    <%= link_to "Link your Maestrano account", maestrano_connector_rails.init_maestrano_auth_saml_index_path(tenant: :default) %>
+    <p>Some generic information about the connector</p>
+
+  <% else %>
+    <% unless @organization.oauth_uid %>
+      Not linked to external app
+      <% if is_admin?(current_user, @organization) %>
+        <%= link_to "Link this company to ...", 'some_path' %>
+      <% end %>
+    <% else %>
+      Linked to external app
+    <% end %>
+
+    <h2>Last synchronization</h2>
+    <% if @synchronizations.first %>
+      <%= "#{@synchronizations.first.updated_at} #{@synchronizations.first.status}" %>
+      <% if @synchronizations.first.is_error? %>
+        <%= @synchronizations.first.message %>
+      <% elsif @synchronizations.first.is_success? && @synchronizations.first.partial? %>
+        Partial synchronization
+      <% end %>
+    <% end %>
+
+    <h2>Synchronizations history</h2>
+    <% @synchronizations.each do |sync| %>
+      <%= sync.updated_at %>
+      <%= sync.status %>
+      <% if sync.is_error %>
+        <%= sync.message %>
+      <% elsif sync.is_success? && sync.partial? %>
+        Partial synchronization
+      <% end %>
+    <% end %>
+  <% end %>
+</div>